Search - Pagination

[jperson1]

Search - Pagination

Issue, best fit: #2236 or #2600

Changes:

Pagination:

1. A limit (default 30) and page value in the form. Defines how many results show on the page, and what the offset of results are.
2. Results are passed into a pagination object. This object then:
   • Splices the results for the nth page [(n-1) * lim : (n-1) * lim + lim]. For example: page 3, limit 30 gives results 61-90.
   • Defines the pagination sub elements (1, 2, ..., 7, 8, 9, ..., 19, 20), including ellipsis.
3. HTML displays the pagination sub elements nicely
4. JS overrides the pagination links:
   • Clicking "Next page" or "Previous page" add/subtracts one from the form page element, the submits the form for a reload
   • Clicking any number sets the form page element to that number, then submits the form for a reload

Small things:

1. Center the PDF view icon
2. Match the Audit Year checkbox background color to the filters color (color-base-lighter, #efefef)
3. By default, sort results by FAC accepted date. It needs some sort of strict sort field, or pages will be wonky between each other

How to test:

Switch to this branch and run normally. Make sure a good amount of items are available in the dissemination tables. I do this by running something like:

python manage.py end_to_end_test_data_generator --email <some_exisiting_email_here> --dbkeys "101078,101101,101352,101382,101546,101579,101590,101590,101893,10213,102138,102184" --years "22,22,22,22,22,22,22,22,22,22,22,22"

This puts twelve submissions all the way through to dissemination. It takes a little while.

To avoid having to put literally hundreds of submissions through e2e for testing, you can & should edit the default page limit of 30 to something smaller, like two, for demonstration. Do this at backend/dissemination/views.py, line ~48.

Now, check out search at http://localhost:8000/dissemination/search/. Run any search that gets results, like the blank one. Verify that pages:

1. Exist.
2. Are navigable by the "Next" and "Previous" buttons.
3. Are navigable by the page numbers.
4. Display correct information (different results on each page, no copies).
5. Display the correct pagination links at the bottom (ellipses when there are lots of pages).

Screenshots:

One total page:

Two pages, on the first page:

Two pages, on the second page:

Many pages, on the first one:

Many pages, in the middle:

Many pages, at the end:

PR checklist: submitters

• Link to an issue if possible. If there’s no issue, describe what your branch does. Even if there is an issue, a brief description in the PR is still useful.
• List any special steps reviewers have to follow to test the PR. For example, adding a local environment variable, creating a local test file, etc.
• For extra credit, submit a screen recording like this one.
• Make sure you’ve merged main into your branch shortly before creating the PR. (You should also be merging main into your branch regularly during development.)
• Make sure you’ve accounted for any migrations. When you’re about to create the PR, bring up the application locally and then run git status | grep migrations. If there are any results, you probably need to add them to the branch for the PR. Your PR should have only one new migration file for each of the component apps, except in rare circumstances; you may need to delete some and re-run python manage.py makemigrations to reduce the number to one. (Also, unless in exceptional circumstances, your PR should not delete any migration files.)
• Make sure that whatever feature you’re adding has tests that cover the feature. This includes test coverage to make sure that the previous workflow still works, if applicable.
• Make sure the full-submission.cy.js Cypress test passes, if applicable.
• Do manual testing locally. Our tests are not good enough yet to allow us to skip this step. If that’s not applicable for some reason, check this box.
• Verify that no Git surgery was necessary, or, if it was necessary at any point, repeat the testing after it’s finished.
• Once a PR is merged, keep an eye on it until it’s deployed to dev, and do enough testing on dev to verify that it deployed successfully, the feature works as expected, and the happy path for the broad feature area (such as submission) still works.

PR checklist: reviewers

• Pull the branch to your local environment and run make docker-clean; make docker-first-run && docker compose up; then run docker compose exec web /bin/bash -c "python manage.py test"
• Manually test out the changes locally, or check this box to verify that it wasn’t applicable in this case.
• Check that the PR has appropriate tests. Look out for changes in HTML/JS/JSON Schema logic that may need to be captured in Python tests even though the logic isn’t in Python.
• Verify that no Git surgery is necessary at any point (such as during a merge party), or, if it was, repeat the testing after it’s finished.

The larger the PR, the stricter we should be about these points.

[github-actions]

Terraform plan for dev

No changes. Your infrastructure matches the configuration.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.

Warning: Argument is deprecated

  with module.dev.module.database.cloudfoundry_service_instance.rds,
  on /tmp/terraform-data-dir/modules/dev.database/database/main.tf line 14, in resource "cloudfoundry_service_instance" "rds":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

(and 2 more similar warnings elsewhere)

✅ Plan applied in Deploy to Development and Management Environment #331

[github-actions]

Terraform plan for meta

No changes. Your infrastructure matches the configuration.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.

Warning: Argument is deprecated

  with module.s3-backups.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/s3-backups/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

✅ Plan applied in Deploy to Development and Management Environment #331

[github-actions]

File	Coverage		Missing
All files	87%	✅
api/serializers.py	88%	✅	177-178 183 188
api/test_views.py	95%	✅	103
api/uei.py	88%	✅	87 118-119 163 167-168
api/views.py	98%	✅	195-196 334-335
audit/file_downloads.py	73%	❌	35-53 81-83
audit/forms.py	47%	❌	22-29 142-149
audit/intake_to_dissemination.py	92%	✅	67-68 201-207 257
audit/models.py	86%	✅	58 60 65 67 214 247 420 438-439 447 469 558-559 563 571 580 586
audit/test_commands.py	87%	✅
audit/test_mixins.py	90%	✅	112-113 117-119 184-185 189-191
audit/test_validators.py	95%	✅	436 440 608-609 848 855 862 869
audit/test_views.py	95%	✅	386-418 427-458 467-495
audit/test_workbooks_should_fail.py	88%	✅	56 83-84 88
audit/test_workbooks_should_pass.py	90%	✅	56 81
audit/utils.py	70%	❌	13 21 33-35 38
audit/validators.py	92%	✅	137 189 283-292 299-308 486-490 495-499 515-524
audit/views.py	31%	❌	88-109 132-133 207-208 253-254 265-266 268-272 319-332 335-349 354-367 384-390 395-415 418-446 451-480 483-527 532-552 555-583 588-617 620-664 669-681 684-694 699-711 738-739 744-793 796-836 839-856
audit/cross_validation/additional_ueis.py	93%	✅	33
audit/cross_validation/check_award_ref_declaration.py	90%	✅
audit/cross_validation/check_award_reference_uniqueness.py	93%	✅
audit/cross_validation/check_certifying_contacts.py	87%	✅
audit/cross_validation/check_findings_count_consistency.py	91%	✅
audit/cross_validation/check_ref_number_in_cap.py	90%	✅
audit/cross_validation/check_ref_number_in_findings_text.py	90%	✅
audit/cross_validation/errors.py	78%	❌	30 69
audit/cross_validation/naming.py	93%	✅	182
audit/cross_validation/submission_progress_check.py	95%	✅	79
audit/cross_validation/tribal_data_sharing_consent.py	81%	❌	33 36 40
audit/cross_validation/validate_general_information.py	93%	✅	28-29
audit/fixtures/single_audit_checklist.py	55%	❌	146-183 229-238
audit/intakelib/exceptions.py	71%	❌	7-9 12
audit/intakelib/intermediate_representation.py	92%	✅	27-28 73 91 129 162 200-203
audit/intakelib/mapping_audit_findings.py	97%	✅	51
audit/intakelib/mapping_audit_findings_text.py	97%	✅	51
audit/intakelib/mapping_federal_awards.py	93%	✅	95
audit/intakelib/mapping_util.py	81%	❌	21 25 29 99 104-105 114-120 130 145 150
audit/intakelib/checks/check_all_unique_award_numbers.py	79%	❌	24
audit/intakelib/checks/check_cardinality_of_passthrough_names_and_ids.py	91%	✅
audit/intakelib/checks/check_cluster_name_always_present.py	82%	❌	21
audit/intakelib/checks/check_cluster_total.py	85%	✅	49 65
audit/intakelib/checks/check_federal_award_passed_always_present.py	82%	❌	18
audit/intakelib/checks/check_findings_grid_validation.py	84%	❌	57
audit/intakelib/checks/check_has_all_the_named_ranges.py	84%	❌	52
audit/intakelib/checks/check_is_a_workbook.py	68%	❌	16
audit/intakelib/checks/check_loan_guarantee.py	90%	✅	51
audit/intakelib/checks/check_look_for_empty_rows.py	91%	✅	18
audit/intakelib/checks/check_missing_award_numbers.py	72%	❌	16 22-23
audit/intakelib/checks/check_no_major_program_no_type.py	72%	❌	22 31 40
audit/intakelib/checks/check_no_repeat_findings.py	76%	❌	17 26
audit/intakelib/checks/check_other_cluster_names.py	81%	❌	24 34
audit/intakelib/checks/check_passthrough_name_when_no_direct.py	88%	✅	9 47
audit/intakelib/checks/check_sequential_award_numbers.py	76%	❌	14 22
audit/intakelib/checks/check_show_ir.py	70%	❌	8-14
audit/intakelib/checks/check_start_and_end_rows_of_all_columns_are_same.py	89%	✅	14
audit/intakelib/checks/check_state_cluster_names.py	65%	❌	23-24 34
audit/intakelib/checks/runners.py	95%	✅	132
audit/intakelib/checks/util.py	85%	✅	16 33
audit/management/commands/load_fixtures.py	46%	❌	39-45
audit/viewlib/submission_progress_view.py	96%	✅	171-172
audit/viewlib/tribal_data_consent.py	34%	❌	23-41 44-79
audit/viewlib/unlock_after_certification.py	57%	❌	28-47 69-83
audit/viewlib/upload_report_view.py	26%	❌	32-35 44 91-117 120-170 178-209
cms/views.py	57%	❌	11-16 29-30
config/urls.py	71%	❌	81
dissemination/models.py	99%	✅	460
dissemination/search.py	97%	✅
dissemination/views.py	64%	❌	27-29 32-86 153 155 157
dissemination/migrations/0002_general_fac_accepted_date.py	47%	❌	10-12
djangooidc/backends.py	78%	❌	32 57-63
djangooidc/exceptions.py	66%	❌	19 21 23 28
djangooidc/oidc.py	16%	❌	32-35 45-51 64-70 92-149 153-199 203-226 230-275 280-281 286
djangooidc/views.py	80%	❌	22 43 114
djangooidc/tests/common.py	96%	✅
report_submission/forms.py	92%	✅	35
report_submission/views.py	76%	❌	83 215-216 218 240-241 260-261 287-396 399-409
report_submission/templatetags/get_attr.py	76%	❌	8 11-14 18
support/admin.py	88%	✅	76 79 84 91-97 100-102
support/cog_over.py	90%	✅	30-33 86 93 145
support/signals.py	66%	❌	23-24 33-34
support/test_cog_over.py	98%	✅	134-135 224
support/management/commands/seed_cog_baseline.py	98%	✅	20-21
tools/update_program_data.py	89%	✅	96
users/auth.py	95%	✅	40-41
users/models.py	97%	✅	51-52
users/fixtures/user_fixtures.py	91%	✅

Minimum allowed coverage is 85%

Generated by 🐒 cobertura-action against 7fa16b6