Skip to content

Rework report_id generation and fix generate_audit_indexes#4896

Merged
rnovak338 merged 8 commits into
mainfrom
rnovak/sot-fixes-before-prod
Apr 16, 2025
Merged

Rework report_id generation and fix generate_audit_indexes#4896
rnovak338 merged 8 commits into
mainfrom
rnovak/sot-fixes-before-prod

Conversation

@rnovak338
Copy link
Copy Markdown
Contributor

@rnovak338 rnovak338 commented Apr 15, 2025

Addresses part of #4859.

We realized a problem with the current report_id generation. We originally have been using .count(). However, now that we have the ability to delete flagged_for_removal records, this will affect the report_id generation in a negative way.

This PR makes a change so that the report_id relies on the latest integer provided by the ID sequence. Because we are getting the sequence ID, we must pass this ID manually on SAC creation. Otherwise, Django will automatically add another +1 to the ID, meaning every new record we add to the DB will add +2 to the sequence counter.

get_next_sequence_id

This is a new method in audit/models.utils.py which grabs the sequence ID from whatever table is passed to it. This fetch will result in incrementing the counter by 1. So, we have to use the ID returned and pass it to both generate_sac_report_id() AND the id of the record on creation.

This change has been reflected in the submission logic as well as our unit tests.

generate_audit_indexes

On a very small note, we are referencing an undefined value in generate_audit_indexes. This was causing our tests on staging to fail last week. I made an adjustment in this PR to correct this.

How to test

  • Create 2 manual submissions. Validate that each submission is increasing the ID tally by +1.
  • E2E test should pass successfully.
  • Unit testing should pass successfully. There are a lot of changes to these to account for the sequencing on SAC creation.

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.

- Now using SQL to get the next ID.
- We are now getting this ID in every instance where we generate a SAC, and pass it as the `id` for the new SAC object.
- Audits currently pull the ID directly from the SAC. Once we deprecate the SAC, we will make the same adjustments for the Audit.
@github-actions
Copy link
Copy Markdown
Contributor

This pull request is not up to date with main. Please merge main into this brach or rebase this branch onto main. This PR should not be approved until all status checks pass. If you see this message, please rerun all status checks before merging.

@rnovak338 rnovak338 requested a review from a team April 15, 2025 19:06
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 15, 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 #988

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 15, 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-04-15T22:20:51Z" -> (known after apply)
        }
    }

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

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

@github-actions
Copy link
Copy Markdown
Contributor

This pull request is not up to date with main. Please merge main into this brach or rebase this branch onto main. This PR should not be approved until all status checks pass. If you see this message, please rerun all status checks before merging.

@rnovak338 rnovak338 changed the title Rework report_id generation Rework report_id generation and fix generate_audit_indexes Apr 15, 2025
@github-actions
Copy link
Copy Markdown
Contributor

This pull request is not up to date with main. Please merge main into this brach or rebase this branch onto main. This PR should not be approved until all status checks pass. If you see this message, please rerun all status checks before merging.

@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage

Package Line Rate Branch Rate Health
. 100% 100%
api 99% 87%
api.serializers 97% 88%
api.views 91% 100%
audit 95% 80%
audit.cross_validation 97% 85%
audit.fixtures 84% 50%
audit.intakelib 89% 83%
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 91% 59%
audit.templatetags 100% 100%
audit.views 74% 55%
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 80% 37%
curation 100% 100%
curation.curationlib 93% 100%
curation.migrations 100% 100%
dissemination 91% 69%
dissemination.migrations 97% 25%
dissemination.report_generation 29% 0%
dissemination.report_generation.excel 32% 0%
dissemination.searchlib 59% 41%
dissemination.templatetags 100% 100%
dissemination.views 76% 55%
djangooidc 53% 38%
djangooidc.tests 100% 94%
report_submission 100% 95%
report_submission.migrations 100% 100%
report_submission.templatetags 74% 100%
report_submission.views 77% 63%
support 93% 74%
support.migrations 100% 100%
support.models 90% 50%
tools 98% 50%
users 95% 86%
users.fixtures 100% 83%
users.management 100% 100%
users.management.commands 100% 100%
users.migrations 100% 100%
Summary 89% (20021 / 22458) 70% (2427 / 3444)

Copy link
Copy Markdown
Contributor

@jadudm jadudm left a comment

Choose a reason for hiding this comment

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

LGTM. Sets us up to transition to new sequences as part of the transition.

@rnovak338 rnovak338 added this pull request to the merge queue Apr 16, 2025
Merged via the queue into main with commit e2d6820 Apr 16, 2025
17 checks passed
@rnovak338 rnovak338 deleted the rnovak/sot-fixes-before-prod branch April 16, 2025 11:26
@rnovak338 rnovak338 restored the rnovak/sot-fixes-before-prod branch April 16, 2025 14:50
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