Skip to content

Removes all spaces from prior reference numbers#4846

Merged
sambodeme merged 6 commits into
mainfrom
jadudm/remove-spaces-from-prior-references
Apr 2, 2025
Merged

Removes all spaces from prior reference numbers#4846
sambodeme merged 6 commits into
mainfrom
jadudm/remove-spaces-from-prior-references

Conversation

@jadudm
Copy link
Copy Markdown
Contributor

@jadudm jadudm commented Apr 1, 2025

We found a bug with the handling of prior reference numbers that this change should address.

Specifically, we found that the validation for prior references breaks when there is a space in the references; users were writing things like

2022-001, 2021-005

and the space after the comma was a problem. We filter spaces in a transform (xform_...) before the comma currently, but not after.

This fix removes all spaces from the prior references string: beginning, end, and any spaces internal to the string. This should not impact the semantics of the field negatively (and should eliminate a class of error for the user).

That is, regardless of whether we have

2023-001 ,2022-004

or

2023-001, 2022-004

or

2023-001 , 2022-004

they should all become

2023-001,2022-004

We already trim() the strings; this makes sure there are no internal spaces whatsoever.

PR Checklist: Submitter

  • 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.
  • Ensure that prior to merging, the working branch is up to date with main and the terraform plan is what you expect.

PR Checklist: Reviewer

  • 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.

Pre Merge Checklist: Merger

  • Ensure that prior to approving, the terraform plan is what we expect it to be. -/+ resource "null_resource" "cors_header" should be destroying and recreating its self and ~ resource "cloudfoundry_app" "clamav_api" might be updating its sha256 for the fac-file-scanner and fac-av-${ENV} by default.
  • Ensure that the branch is up to date with main.
  • Ensure that a terraform plan has been recently generated for the pull request.

The code previously removed spaces before the comma; we want to remove
spaces entirely.

That is, regardless of whether we have

2023-001 ,2022-004

or

2023-001, 2022-004

or

2023-001 , 2022-004

they should all become

2023-001,2022-004

We already trim() the strings; this makes sure there are no internal
spaces whatsoever.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 1, 2025

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.

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 1, 2025

Terraform plan for dev

Plan: 1 to add, 0 to change, 1 to destroy.
Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # module.dev.module.cors.null_resource.cors_header must be replaced
-/+ resource "null_resource" "cors_header" {
!~      id       = "*******************" -> (known after apply)
!~      triggers = { # forces replacement
!~          "always_run" = "2025-03-31T17:19:49Z" -> (known after apply)
        }
    }

Plan: 1 to add, 0 to change, 1 to destroy.

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

Copy link
Copy Markdown
Contributor

@sambodeme sambodeme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we do it here instead. That way curation won't be needed

No spaces should remain in the `prior_references` field after this
transform is complete.
@jadudm jadudm marked this pull request as ready for review April 1, 2025 21:32
We're trying to test the space at the end of a line...
I really want the whitespace...
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2025

Code Coverage

Package Line Rate Branch Rate Health
. 100% 100%
api 98% 90%
audit 97% 87%
audit.cross_validation 98% 88%
audit.fixtures 84% 50%
audit.intakelib 88% 82%
audit.intakelib.checks 92% 85%
audit.intakelib.common 98% 82%
audit.intakelib.transforms 100% 95%
audit.management.commands 78% 17%
audit.migrations 100% 100%
audit.models 94% 73%
audit.templatetags 100% 100%
audit.views 72% 54%
census_historical_migration 96% 65%
census_historical_migration.migrations 100% 100%
census_historical_migration.sac_general_lib 92% 84%
census_historical_migration.transforms 95% 90%
census_historical_migration.workbooklib 68% 69%
config 77% 37%
curation 100% 100%
curation.curationlib 93% 100%
curation.migrations 100% 100%
dissemination 92% 72%
dissemination.migrations 97% 25%
dissemination.searchlib 76% 66%
dissemination.templatetags 100% 100%
djangooidc 53% 38%
djangooidc.tests 100% 94%
report_submission 93% 88%
report_submission.migrations 100% 100%
report_submission.templatetags 74% 100%
support 91% 66%
support.migrations 100% 100%
support.models 96% 50%
tools 98% 50%
users 95% 92%
users.fixtures 100% 83%
users.management 100% 100%
users.management.commands 100% 100%
users.migrations 100% 100%
Summary 91% (18519 / 20286) 77% (2281 / 2966)

@sambodeme sambodeme added this pull request to the merge queue Apr 2, 2025
Merged via the queue into main with commit 9997ece Apr 2, 2025
17 checks passed
@sambodeme sambodeme deleted the jadudm/remove-spaces-from-prior-references branch April 2, 2025 13:02
@jadudm
Copy link
Copy Markdown
Contributor Author

jadudm commented Apr 2, 2025

What if we do it here instead. That way curation won't be needed

Ooh. I suspect we should make the change here, too... or, we might need to. I'll take a look. It might become another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants