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

Summary Updates #2605

Merged
merged 49 commits into from
Oct 30, 2023
Merged

Summary Updates #2605

merged 49 commits into from
Oct 30, 2023

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Oct 24, 2023

Summary Updates

Base branch PR: #2419

Changes:

  1. Summary HTML -
    • New design. Table-based and pulls from the generals table, with download links (only the PDF one points anywhere).
    • Data that doesn't exist (additional UEIs/EINs, zero findings submissions) will show in "disabled" boxes. As in they exist, but just show lighter text with no link.
  2. Add django.contrib.humanize to the installed apps. This gives access to some useful templatetags, like intcomma.
  3. Main scss:
    • Add a weight for semibold (600). This isn't set to anything by default.
    • Override theme-color-base-lighter to be... even lighter. Used for a single background.
  4. getkey.py - a template tag to allow accessing dictionary members with spaces, as though one used data.'Notes to Sefa'. Which doesn't exist in Django, hence the template tag.
  5. Minor cleanup. A return here, a comment type there.

How to Test:

  1. Switch to this branch and run normally.
  2. Ensure there is data in your dissemination tables. If not, submit an audit or have Cypress submit an audit (or three or six).
  3. Search for an audit. Visit its summary page.
  4. Verify that information is showing correctly. In particular, eyeball:
    • The PDF download link
    • The funky-fresh separated table
    • The download links that were a pain to line up properly.
  5. Mess around with the screen size to see if things break significantly. I doubt we will have many mobile users, but it's nice to be inclusive.

Screenshot:

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

Matt Henry and others added 28 commits October 5, 2023 14:33
…S/FAC into mh/implement-mvp-search-form-2369
* Search Summary

* Some title info, make tables take up the full width of the page
* fleshing out search view

* rm leftover list comprehension

* cog-over search fix, only search public

* more tests

* quick pass at displaying search results
* URLS - Add a backslash to the search url

* Search - Link to summary, icon size, formatting

* Summary - remove "back" button, formatting.

* Search - prepopulate form after making a search

* Remove usused import

* Don't run methods on empty data, kids

* Search - Move UEI and ALN above the name field

* Djlint reformatting
* URLS - Add a backslash to the search url

* Search - Link to summary, icon size, formatting

* Summary - remove "back" button, formatting.

* Search - prepopulate form after making a search

* Remove usused import

* Don't run methods on empty data, kids

* Search - Move UEI and ALN above the name field

* Djlint reformatting

* Search - Add audit year

* search_general params default to none

* Tests - test_audit_year, search_general cleanups

* Revert "Merge branch 'mh/implement-mvp-search-form-2369' into jp/search-audit-year"

This reverts commit 7c99f95, reversing
changes made to 30b2743.

* Remove unused Y/N choices
* first pass at pdf downloads via search

* re-add AWS_S3_ENDPOINT_URL

* re-add download link
@jperson1

This comment was marked as outdated.

@jperson1 jperson1 self-assigned this Oct 25, 2023
@jperson1 jperson1 temporarily deployed to meta October 27, 2023 15:43 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 27, 2023 15:43 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 27, 2023 15:43 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 27, 2023 15:43 — with GitHub Actions Inactive
@jperson1 jperson1 marked this pull request as ready for review October 27, 2023 15:43
@jperson1 jperson1 temporarily deployed to dev October 27, 2023 16:10 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 27, 2023 16:10 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 27, 2023 16:11 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 27, 2023 16:11 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 30, 2023 17:29 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 30, 2023 17:29 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 30, 2023 17:31 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 30, 2023 17:31 — with GitHub Actions Inactive
@tadhg-ohiggins tadhg-ohiggins self-requested a review October 30, 2023 17:37
@jadudm jadudm mentioned this pull request Oct 30, 2023
30 tasks
@danswick danswick added this pull request to the merge queue Oct 30, 2023
Merged via the queue into main with commit e75b450 Oct 30, 2023
13 checks passed
@danswick danswick deleted the jp/summary-updates branch October 30, 2023 23:02
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