Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Character Limits - General Info & Submission Access #4026

Merged
merged 16 commits into from
Jul 1, 2024
Merged

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Jun 26, 2024

Character Limits - General Info & Submission Access

Issue: #1999

Character limits for the general information and submission access fields.

See this drive for a quick report on average/median/min/max value lengths in dissemination.

I pulled the min/max values from the above report into JSON, and gave them their own folder and README in backend/schemas/character_limits. From the initial values, I changed the values up/down to reasonable values. The README contains explanations for these decisions. Most fields in this folder remain unchanged from the report, and can be used in a later PR for setting limits on the workbooks.

Changes:

In this PR, I set character limits for the General information and Submission access pages.

  1. backend/schemas/character_limits exists. general.json has values edited from the baseline report.
  2. The values from general.json are used to set min/maxLength values:
    • In GeneralInformation.schema.json and Baselibsonnet
    • In backend/report_submission/forms.py for the General Information form
    • In backend/api/serializers for the Submission access form
  3. HTML changes in gen-form.html ensure that errors display correctly
  4. JS changes in validate.js allow multiple length validations, and include greater/less than comparators
  5. HTML changes in step-3.html fix a little wonkyness (not all), but also display character limits during the form entry process (as opposed to post-form submission, like in gen info).
  6. Auto-formatting changes for schema files. This comes from make all --> format_jsonnet -> jsonnetfmt -i {files}

I've also changed the regex for audit_period_other_months to allow for single character responses. This resolves #3969, which has been an issue difficult to discern for users for a little while.

^0?[1-9]$|^1[0-8]$
^0?[1-9]$ - One word, either 1-9 or 01-09 OR ^1[0-8]$ - One word, 10-18.

Other validation errors now provide a generic "unexpected error" response, so these should be caught much faster in the future. This resolves #3970.

How to test:

  1. Switch to this branch and run normally.
    • Ensure that this step rebuilds JS, so the validate.js changes are brought in
  2. Navigate to the submission access page (step three, right before the report is created and general information starts)
  3. Verify that character limits apply:
    • Try to enter weird-length names (less than 2 characters, or more than 100)
    • Try to enter weird-length emails (less than 6 characters [email protected], or more than 340)
  4. Navigate to the general information page
  5. Verify that character limits apply, and that you get nicer error messaging:
    • If a field has too many or too few characters, a nice error should come back.
    • If a field has NO characters, the form should still pass.
    • audit_period_other_months should allow a single digit response, and provide a nice error if it is outside the allowed range (1-18 months).

Screenshots:

Character limits:

image

image

audit_period_other_months

Regex issue:
image

Length and regex issue:
image

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.

Copy link
Contributor

github-actions bot commented Jun 26, 2024

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 #729

Copy link
Contributor

github-actions bot commented Jun 26, 2024

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-backups-bucket.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/dev-backups-bucket/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

(and 6 more similar warnings elsewhere)

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

Copy link
Contributor

github-actions bot commented Jun 26, 2024

File Coverage Missing
All files 87%
api/serializers.py 88% 178-179 184 189
api/test_views.py 95% 103
api/uei.py 88% 87 118-119 163 167-168
api/views.py 98% 198-199 337-338
audit/forms.py 60% 31-38 109-116
audit/intake_to_dissemination.py 88% 57-62 264 308-316
audit/mixins.py 96% 28
audit/test_commands.py 91%
audit/test_intakelib.py 88% 154-158
audit/test_manage_submission_access_view.py 98% 15 19
audit/test_mixins.py 90% 159-160 164-166 254-255 259-261
audit/test_validators.py 96% 439 443 611-612 851 858 865 872 1176-1177 1220-1221 1246-1251
audit/test_views.py 98% 132
audit/test_workbooks_should_fail.py 88% 58 87-88 92
audit/test_workbooks_should_pass.py 87% 59 74-76
audit/utils.py 86% 9 19 60-62 65
audit/validators.py 93% 138 190 279 419-420 435-436 519-520 622-626 631-635 651-660
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 87% 35
audit/cross_validation/check_ref_number_in_cap.py 91%
audit/cross_validation/check_ref_number_in_findings_text.py 91%
audit/cross_validation/errors.py 78% 30 77
audit/cross_validation/naming.py 93% 229
audit/cross_validation/submission_progress_check.py 91% 83 126 174 182-183
audit/cross_validation/tribal_data_sharing_consent.py 81% 33 36 40
audit/cross_validation/validate_general_information.py 65% 77 81-84 96 99
audit/fixtures/dissemination.py 71% 38
audit/fixtures/single_audit_checklist.py 55% 160-197 245-254
audit/intakelib/exceptions.py 71% 7-9 12
audit/intakelib/intermediate_representation.py 91% 27-28 73 91 129 200-203 212-213 283-284
audit/intakelib/mapping_audit_findings.py 97% 55
audit/intakelib/mapping_audit_findings_text.py 97% 54
audit/intakelib/mapping_federal_awards.py 93% 92
audit/intakelib/mapping_util.py 79% 21 25 29 63 99 104-105 114-120 130 145 150
audit/intakelib/checks/check_all_unique_award_numbers.py 79% 24
audit/intakelib/checks/check_cluster_names.py 75% 20-25
audit/intakelib/checks/check_cluster_total.py 95% 99
audit/intakelib/checks/check_finding_reference_pattern.py 74% 34 44-45
audit/intakelib/checks/check_findings_grid_validation.py 89% 59
audit/intakelib/checks/check_has_all_the_named_ranges.py 95% 66
audit/intakelib/checks/check_is_a_workbook.py 69% 20
audit/intakelib/checks/check_loan_balance_entries.py 83% 28
audit/intakelib/checks/check_look_for_empty_rows.py 91% 18
audit/intakelib/checks/check_no_major_program_no_type.py 76% 18 27
audit/intakelib/checks/check_no_repeat_findings.py 88% 21
audit/intakelib/checks/check_other_cluster_names.py 81% 23 33
audit/intakelib/checks/check_passthrough_name_when_no_direct.py 83% 11 49 58
audit/intakelib/checks/check_sequential_award_numbers.py 82% 25 35
audit/intakelib/checks/check_start_and_end_rows_of_all_columns_are_same.py 89% 14
audit/intakelib/checks/check_state_cluster_names.py 81% 23 33
audit/intakelib/checks/check_version_number.py 73% 30 40-41
audit/intakelib/checks/runners.py 95% 187 217
audit/intakelib/common/util.py 90% 22 39
audit/intakelib/transforms/xform_rename_additional_notes_sheet.py 81% 14
audit/management/commands/load_fixtures.py 47% 40-46
audit/models/models.py 85% 58 60 65 67 209 215 227 239-242 260 437 455-456 464 486 584-585 589 597 606 612
audit/views/audit_info_form_view.py 27% 25-74 77-117 120-137
audit/views/manage_submission.py 86% 73-80
audit/views/manage_submission_access.py 98% 113-114
audit/views/pre_dissemination_download_view.py 78% 15-16 21-22 29-39
audit/views/submission_progress_view.py 96% 182-183
audit/views/tribal_data_consent.py 34% 23-41 44-79
audit/views/unlock_after_certification.py 57% 28-51 73-87
audit/views/upload_report_view.py 26% 32-35 44 91-117 120-170 178-209
audit/views/views.py 53% 74 81-100 123-124 198-199 220-230 257 268-269 280-281 283-287 329-342 345-359 364-377 394-400 405-425 452-456 461-490 533-537 542-562 589-593 598-627 670-674 679-691 694-704 709-721 754-768
census_historical_migration/change_record.py 98% 30
census_historical_migration/end_to_end_core.py 26% 57-89 93-111 116-155 161-187 246-258 263 273-307
census_historical_migration/invalid_record.py 94% 50 54 58 62 66
census_historical_migration/migration_result.py 75% 17 21 25 29 33-42 46
census_historical_migration/report_type_flag.py 96% 19
census_historical_migration/test_federal_awards_xforms.py 99% 219-220
census_historical_migration/sac_general_lib/audit_information.py 91% 28 82-87 336
census_historical_migration/sac_general_lib/cognizant_oversight.py 68% 11
census_historical_migration/sac_general_lib/general_information.py 86% 166-167 177-178 186-187 195-200 233-255 354-355
census_historical_migration/sac_general_lib/sac_creator.py 90% 34
census_historical_migration/sac_general_lib/utils.py 84% 35 62-71
census_historical_migration/transforms/xform_remove_hyphen_and_pad_zip.py 92% 18
census_historical_migration/transforms/xform_retrieve_uei.py 67% 10
census_historical_migration/transforms/xform_string_to_bool.py 87% 17
census_historical_migration/workbooklib/additional_eins.py 84% 58-60 67-77
census_historical_migration/workbooklib/additional_ueis.py 77% 27-29 36-46
census_historical_migration/workbooklib/corrective_action_plan.py 46% 49-51 65 93-125 134-153
census_historical_migration/workbooklib/excel_creation_utils.py 69% 110 119-124 129-136 140-158 171-175 189-192
census_historical_migration/workbooklib/federal_awards.py 77% 181-184 262-301 487 554-562 572-597 621-622 918-1022
census_historical_migration/workbooklib/findings.py 69% 81-86 154-174 179-199 216-218 330-354
census_historical_migration/workbooklib/findings_text.py 46% 50-51 67 97-129 138-160
census_historical_migration/workbooklib/notes_to_sefa.py 66% 34-38 101-102 104-105 107-108 136-143 152-160 168-170 279-326
census_historical_migration/workbooklib/post_upload_utils.py 21% 22-35 66-83 89-111
census_historical_migration/workbooklib/secondary_auditors.py 88% 128-130 186-205
census_historical_migration/workbooklib/workbook_builder.py 38% 14-17 26-41
census_historical_migration/workbooklib/workbook_builder_loader.py 41% 18-30
config/error_handlers.py 94% 22
config/test_settings.py 92% 33-34 49-50
config/urls.py 72% 88
dissemination/file_downloads.py 81% 43-61 91-93
dissemination/forms.py 87% 135 144 255
dissemination/search.py 88% 113 115 119 127-128
dissemination/summary_reports.py 78% 274 300-302 306-310 421 438 459 511-575 603 638-640 664-672
dissemination/test_search.py 93% 51-66 473-474 579-596 608-632 644-669 677-693
dissemination/test_summary_reports.py 98%
dissemination/views.py 75% 134 140-142 159-225 268 298 300 336 387 389 391 469-474
dissemination/migrations/0002_general_fac_accepted_date.py 47% 10-12
dissemination/searchlib/search_alns.py 37% 44-58 78-110 115-177 184-187
dissemination/searchlib/search_direct_funding.py 86% 21-22
dissemination/searchlib/search_findings.py 76% 18-24 34 36 38
dissemination/searchlib/search_general.py 96% 138
dissemination/searchlib/search_passthrough_name.py 35% 21-31
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 81% 22 43 109-110 117
djangooidc/tests/common.py 97%
report_submission/forms.py 92% 39
report_submission/test_views.py 98% 835
report_submission/views.py 79% 97 252 276-277 282-283 323-493 496-506 565 601-603 611-612 615-617
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 91% 29-32 92 116-120 156
support/test_admin_api.py 81% 23 147-148 237-238 317-318
support/test_cog_over.py 98% 174-175 264
support/management/commands/seed_cog_baseline.py 98% 20-21
support/models/cog_over.py 89% 103-104
tools/update_program_data.py 89% 96
users/admin.py 99% 27
users/auth.py 96% 58-59
users/models.py 96% 18 74-75
users/fixtures/user_fixtures.py 91%

Minimum allowed coverage is 85%

Generated by 🐒 cobertura-action against b016f2f

@jperson1 jperson1 added this pull request to the merge queue Jul 1, 2024
Merged via the queue into main with commit 67a8a67 Jul 1, 2024
13 checks passed
@jperson1 jperson1 deleted the jp/character-limits branch July 1, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants