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

Resolve 500 error with dissemination search/advanced #4497

Merged
merged 8 commits into from
Dec 11, 2024

Conversation

rnovak338
Copy link
Contributor

Addresses #4437.

  • Add form error labels for start and end dates in search.
  • Re-render search template instead of raising validation errors.

How to test

  1. Boot up the application.
  2. Attempt to search with invalid date formats under "FAC Accepted Date" from the search and advanced search pages.
  3. Each of the pages should reload with an error message over the date field.

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.

Handled search AND advanced search.
- Add form error labels for start and end dates in search.
- Re-render search template instead of raising validation errors.
Copy link
Contributor

github-actions bot commented Dec 2, 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.

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

Copy link
Contributor

github-actions bot commented Dec 2, 2024

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" = "2024-12-10T17:35:56Z" -> (known after apply)
        }
    }

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

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

@rnovak338 rnovak338 marked this pull request as ready for review December 2, 2024 19:47
@phildominguez-gsa
Copy link
Contributor

phildominguez-gsa commented Dec 3, 2024

This does work well, just a couple questions/suggestions!

No luck getting this to show up, like in the step 2 form?
image

If it's not doable, I think we'd need to better indicate that the search failed due to an error. Right now you can't really tell until you expand the date section again. Maybe put a message where the search results show up, something like "Search submission failed" with a list of all the errors?

Ideally the form should retain all the info the user submitted as well, if possible. I could see it being pretty frustrating if everything got wiped because you entered a bad date 😬

- Removed "duplicate" logic for rendering form when it is not valid.
- Instead, re-uses the logic for success and only applies a search on the tables when `form.is_valid()`.
@rnovak338
Copy link
Contributor Author

This does work well, just a couple questions/suggestions!

No luck getting this to show up, like in the step 2 form? image

If it's not doable, I think we'd need to better indicate that the search failed due to an error. Right now you can't really tell until you expand the date section again. Maybe put a message where the search results show up, something like "Search submission failed" with a list of all the errors?

Ideally the form should retain all the info the user submitted as well, if possible. I could see it being pretty frustrating if everything got wiped because you entered a bad date 😬

Hey Phil,

Thanks for your feedback. That tooltip for the form field is generated by the browser, and it does not seem like we can easily guarantee a way to get it to generate without changing up some of the front-end logic quite a bit. I updated the PR with the following changes for both search AND advanced search. Please double check this on your end when you are ready!

New USWDS error component renders on invalid form field. It looks like this:
image

Your inputted fields will keep the values they had before submission (and the appropriate expanders are open/closed). The error will appear like this:
image

Give it a test on both basic and advanced search.

@jperson1
Copy link
Contributor

jperson1 commented Dec 5, 2024

^ Relatedly, my browser won't give me an error the first time I put in a bad date. But if I get the bad date error from submitting and then go in with a bad date, my browser will let me know. Not the first time, when I would have needed it. Weird. Oh well.

image

<div class="usa-alert usa-alert--error">
<div class="usa-alert__body">
<h2 class="usa-alert__heading">Error</h2>
<p>Oops! It looks like some of the information you entered is invalid. Please double-check your information for errors.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure about "Oops." Might be too friendly for the FAC's voice? @James-Paul-Mason, how do you feel?

We have a similar sort of message here:

{% if errors %}
<span class="usa-error-message" role="alert">There were errors when attempting to submit the form. Scroll down for more details.</span>
{% endif %}

Copy link
Contributor

Choose a reason for hiding this comment

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

Once we get guidance from James on this I'm good with approving. Works great!

@James-Paul-Mason
Copy link

In terms of the error message, I would agree with @jperson1 that we should drop the "Oops!" for tonal consistency. Also, based on our voice/tone guide, we want our messaging to be authoritative, so I would delete "looks like"

Oops! It looks like some of the information you entered is invalid. Please double-check your information for errors.

From my reading of the ticket, it sounds like this error pops up when a user inputs an invalid End date. If that is the case, can we get more specific about "the information" in the error message, and replace it with something like this: "The date you entered is invalid. Please double-check the End date field for errors."

Open to any suggestions if that sounds too specific!

Now displaying list of erroneous fields in error message when the form is invalid.
@rnovak338
Copy link
Contributor Author

rnovak338 commented Dec 11, 2024

In terms of the error message, I would agree with @jperson1 that we should drop the "Oops!" for tonal consistency. Also, based on our voice/tone guide, we want our messaging to be authoritative, so I would delete "looks like"

Oops! It looks like some of the information you entered is invalid. Please double-check your information for errors.

From my reading of the ticket, it sounds like this error pops up when a user inputs an invalid End date. If that is the case, can we get more specific about "the information" in the error message, and replace it with something like this: "The date you entered is invalid. Please double-check the End date field for errors."

Open to any suggestions if that sounds too specific!

Thanks @James-Paul-Mason, I updated the language to be authoritative. Regarding your other point, the changes in this PR will detect form errors beyond just the start/end dates in this form. Because the errors provided by Django are not always clear to the end user, I added some custom context to handle when the start/end dates are invalid. Like so:

image

I do not think it is possible for the other fields to have invalid input. Either way, moving forward we can provide custom information for them if needed.

@phildominguez-gsa I think we may be good to go now.

Fixes padding issue if there are no errors.
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 90% 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 93% 75%
audit.templatetags 100% 100%
audit.views 62% 41%
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 57% 100%
curation.migrations 100% 100%
dissemination 91% 70%
dissemination.migrations 97% 25%
dissemination.searchlib 74% 64%
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 92% 62%
support.management.commands 96% 100%
support.migrations 100% 100%
support.models 97% 83%
tools 98% 50%
users 95% 92%
users.fixtures 100% 83%
users.management 100% 100%
users.management.commands 100% 100%
users.migrations 100% 100%
Summary 90% (17481 / 19319) 76% (2180 / 2870)

@rnovak338 rnovak338 added this pull request to the merge queue Dec 11, 2024
Merged via the queue into main with commit d0733d5 Dec 11, 2024
15 checks passed
@rnovak338 rnovak338 deleted the rnovak/4437-dissemination-search-500-error branch December 11, 2024 15:22
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.

4 participants