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

Audit Deletion Finalized Designs #4640

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Jan 16, 2025

Audit Deletion Finalized Designs

A better title is "I fought icons for a while and we called it a draw."

Issue: #4592

Changes:

  1. Audit deletion workflow
    • "Delete" on the Audit submissions page brings up a confirmation modal
    • The checklist also has a delete button and a confirmation modal
  2. "New Audit Submission" is now contained in a button & modal at the top of the "Audit submissions" page
  3. New icons
    • Compound icons for the My submissions page and Submission checklist have been added
    • sprite.svg has been regenerated to include all FAC and USWDS icons
    • I left out the material icons because it multiplies the filesize of sprite.svg by eight
  4. Minor HTML and JS cleanup
    • Some JS was removed from the audit submissions page because the Terms and Conditions are included always in the confirmation modal
    • The homepage was reformatted to use four space tabs instead of two, matching with the rest of the app

How to test:

  1. Switch to this branch and run normally.
  2. At the Audit submissions page, attempt to delete a submission. Verify that:
    • The modal works and looks correct
    • The record still gets removed
    • You are redirected to the Audit submissions page afterward
  3. At a submission checklist, attempt to delete a submission. Verify the same behavior.
  4. Attempt to start a new submission. Verify that:
    • The New Audit Submission modal works and looks right
    • Accepting the terms redirects you to audit creation (step 1, the eligibility bits)

If you've deleted a submission and you want it back, for easier testing, youy can switch it back to "in_progress" at the DB level.

If icons appear broken, make sure your staticfiles folder has been regenerated recently.

python manage.py collectstatic --> 'yes'

If they are still broken, make sure you are hard refreshing the page. Also try visiting a new page and coming back, as that fixed some things for me. Chrome likes to hold onto (potentially old) images to save on download time.

Recording:

Screen.Recording.2025-01-17.at.11.36.14.AM.mov

Screenshots:

When one has zero audit submissions, the helper alert still appears
image

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.

Rework "Audit submissions" page. Start button to top. Icons and copy.

"Submission checklist" page includes delete button and modal.

Circular icon component.
New folder for FAC-specific icons.

Regenerate sprite.svg to include all usa, uswds, and fac icons.
Compound icons can be their own icon!
Copy link
Contributor

github-actions bot commented Jan 16, 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 generated in Pull Request Checks #4186

Copy link
Contributor

github-actions bot commented Jan 16, 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-01-15T20:24:56Z" -> (known after apply)
        }
    }

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

📝 Plan generated in Pull Request Checks #4186

Break modals into their own component files, update references
Practically, it will always exist. But we don't want to have to set the value for every possible test.
Always display helper text

Initialize audit with new workflow

Minor fixes
@jperson1 jperson1 requested a review from a team January 17, 2025 17:14
@jperson1 jperson1 marked this pull request as ready for review January 17, 2025 17:14
Copy link
Contributor

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 91% 81%
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% 76%
audit.templatetags 100% 100%
audit.views 70% 53%
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 76% 31%
curation 100% 100%
curation.curationlib 93% 100%
curation.migrations 100% 100%
dissemination 91% 70%
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% (18061 / 19845) 77% (2240 / 2924)

Minimum allowed line rate is 85%

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.

1 participant