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

Search MVP #2419

Merged
merged 26 commits into from
Oct 25, 2023
Merged

Search MVP #2419

merged 26 commits into from
Oct 25, 2023

Conversation

heymatthenry
Copy link
Contributor

@heymatthenry heymatthenry commented Oct 5, 2023

Addresses #2369

Navigate to search page at /dissemination/search

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

@heymatthenry heymatthenry temporarily deployed to dev October 5, 2023 19:10 — with GitHub Actions Inactive
@heymatthenry heymatthenry temporarily deployed to meta October 5, 2023 19:10 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

Terraform plan for dev

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.

Warning: Argument is deprecated

  with module.dev.module.database.cloudfoundry_service_instance.rds,
  on /tmp/terraform-data-dir/modules/dev.database/database/main.tf line 14, in resource "cloudfoundry_service_instance" "rds":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

(and 2 more similar warnings elsewhere)

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

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.

Warning: Argument is deprecated

  with module.s3-backups.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/s3-backups/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

File Coverage Missing
All files 87%
api/serializers.py 88% 177-178 183 188
api/test_views.py 96% 105
api/uei.py 88% 87 118-119 163 167-168
api/views.py 97% 196-197 204-205 226 362-363
audit/file_downloads.py 35% 16-21 26-44 48-74
audit/forms.py 47% 22-29 142-149
audit/intake_to_dissemination.py 92% 67-68 201-207 257
audit/models.py 86% 58 60 65 67 214 247 420 438-439 447 469 558-559 563 571 580 586
audit/test_commands.py 87%
audit/test_mixins.py 90% 112-113 117-119 184-185 189-191
audit/test_validators.py 95% 436 440 608-609 848 855 862 869
audit/test_views.py 95% 386-418 427-458 467-495
audit/test_workbooks_should_fail.py 88% 56 83-84 88
audit/test_workbooks_should_pass.py 90% 56 81
audit/utils.py 70% 13 21 33-35 38
audit/validators.py 92% 137 189 283-292 299-308 486-490 495-499 515-524
audit/views.py 31% 88-109 132-133 207-208 253-254 265-266 268-272 319-332 335-349 354-367 384-390 395-415 418-446 451-480 483-527 532-552 555-583 588-617 620-664 669-681 684-694 699-711 738-739 744-793 796-836 839-856
audit/cross_validation/additional_ueis.py 93% 33
audit/cross_validation/check_award_ref_declaration.py 90%
audit/cross_validation/check_award_reference_uniqueness.py 93%
audit/cross_validation/check_certifying_contacts.py 87%
audit/cross_validation/check_findings_count_consistency.py 91%
audit/cross_validation/check_ref_number_in_cap.py 90%
audit/cross_validation/check_ref_number_in_findings_text.py 90%
audit/cross_validation/errors.py 78% 30 69
audit/cross_validation/naming.py 93% 182
audit/cross_validation/submission_progress_check.py 95% 79
audit/cross_validation/tribal_data_sharing_consent.py 81% 33 36 40
audit/cross_validation/validate_general_information.py 93% 28-29
audit/fixtures/single_audit_checklist.py 55% 146-183 229-238
audit/intakelib/exceptions.py 71% 7-9 12
audit/intakelib/intermediate_representation.py 92% 27-28 73 91 129 162 200-203
audit/intakelib/mapping_audit_findings.py 97% 51
audit/intakelib/mapping_audit_findings_text.py 97% 51
audit/intakelib/mapping_federal_awards.py 93% 95
audit/intakelib/mapping_util.py 81% 21 25 29 99 104-105 114-120 130 145 150
audit/intakelib/checks/check_all_unique_award_numbers.py 79% 24
audit/intakelib/checks/check_cardinality_of_passthrough_names_and_ids.py 91%
audit/intakelib/checks/check_cluster_name_always_present.py 82% 21
audit/intakelib/checks/check_cluster_total.py 85% 49 65
audit/intakelib/checks/check_federal_award_passed_always_present.py 82% 18
audit/intakelib/checks/check_findings_grid_validation.py 84% 57
audit/intakelib/checks/check_has_all_the_named_ranges.py 84% 52
audit/intakelib/checks/check_is_a_workbook.py 68% 16
audit/intakelib/checks/check_loan_guarantee.py 90% 51
audit/intakelib/checks/check_look_for_empty_rows.py 91% 18
audit/intakelib/checks/check_missing_award_numbers.py 72% 16 22-23
audit/intakelib/checks/check_no_major_program_no_type.py 72% 22 31 40
audit/intakelib/checks/check_no_repeat_findings.py 76% 17 26
audit/intakelib/checks/check_other_cluster_names.py 81% 24 34
audit/intakelib/checks/check_passthrough_name_when_no_direct.py 88% 9 47
audit/intakelib/checks/check_sequential_award_numbers.py 76% 14 22
audit/intakelib/checks/check_show_ir.py 70% 8-14
audit/intakelib/checks/check_start_and_end_rows_of_all_columns_are_same.py 89% 14
audit/intakelib/checks/check_state_cluster_names.py 65% 23-24 34
audit/intakelib/checks/runners.py 95% 132
audit/intakelib/checks/util.py 85% 16 33
audit/management/commands/load_fixtures.py 46% 39-45
audit/viewlib/submission_progress_view.py 90% 171-172
audit/viewlib/tribal_data_consent.py 34% 23-41 44-79
audit/viewlib/unlock_after_certification.py 57% 28-47 69-83
audit/viewlib/upload_report_view.py 26% 32-35 44 91-117 120-170 178-209
cms/views.py 57% 11-16 29-30
config/urls.py 71% 88
dissemination/models.py 99% 460
dissemination/search.py 85% 41-43
dissemination/views.py 70% 24-26 29-58 136-145
dissemination/migrations/0002_general_fac_accepted_date.py 47% 10-12
djangooidc/backends.py 78% 32 57-63
djangooidc/exceptions.py 66% 19 21 23 28
djangooidc/oidc.py 16% 32-35 45-51 64-70 92-149 153-199 203-226 230-275 280-281 286
djangooidc/views.py 80% 22 43 114
djangooidc/tests/common.py 96%
report_submission/forms.py 92% 35
report_submission/views.py 76% 83 215-216 218 240-241 260-261 287-396 399-409
report_submission/templatetags/get_attr.py 76% 8 11-14 18
support/admin.py 88% 76 79 84 91-97 100-102
support/cog_over.py 90% 30-33 86 93 145
support/signals.py 66% 23-24 33-34
support/test_cog_over.py 98% 134-135 224
support/management/commands/seed_cog_baseline.py 98% 20-21
tools/update_program_data.py 89% 96
users/auth.py 95% 40-41
users/models.py 97% 51-52
users/fixtures/user_fixtures.py 91%

Minimum allowed coverage is 85%

Generated by 🐒 cobertura-action against 70a34f3

@timoballard timoballard temporarily deployed to dev October 12, 2023 14:30 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 12, 2023 14:30 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to dev October 12, 2023 16:38 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 12, 2023 16:38 — with GitHub Actions Inactive
@heymatthenry heymatthenry temporarily deployed to dev October 12, 2023 17:53 — with GitHub Actions Inactive
@heymatthenry heymatthenry temporarily deployed to meta October 12, 2023 17:53 — with GitHub Actions Inactive
* Search Summary

* Some title info, make tables take up the full width of the page
@timoballard timoballard temporarily deployed to dev October 16, 2023 16:15 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 16, 2023 16:15 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev October 16, 2023 16:55 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta October 16, 2023 16:55 — with GitHub Actions Inactive
@jperson1 jperson1 mentioned this pull request Oct 16, 2023
12 tasks
@timoballard timoballard temporarily deployed to dev October 16, 2023 19:12 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 16, 2023 19:12 — with GitHub Actions Inactive
* fleshing out search view

* rm leftover list comprehension

* cog-over search fix, only search public

* more tests

* quick pass at displaying search results
@timoballard timoballard temporarily deployed to dev October 16, 2023 20:21 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to dev October 23, 2023 17:31 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 23, 2023 17:31 — with GitHub Actions Inactive
Copy link
Contributor

@danswick danswick left a comment

Choose a reason for hiding this comment

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

Tested locally:

  1. Created and submitted a few complete audits.
  2. Ran cypress E2E.
  3. Tested blank query, UEI query, and cog/over query (which was not successful, noted below).
  4. Spot-checked results view.

Left a few comments inline for east-coast-morning, but didn't review the Django models/views as closely as I would've liked for today.

{% endfor %}
</tbody>
</table>
<nav aria-label="Pagination" class="usa-pagination">
Copy link
Contributor

Choose a reason for hiding this comment

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

The pagination looks like a placeholder right now, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I believe @jperson1 is looking into enabling pagination

file_obj = get_object_or_404(SingleAuditReportFile, sac=sac)
return f"singleauditreport/{file_obj.filename}"
else:
file_obj = get_object_or_404(ExcelFile, sac=sac, form_section=file_type)
Copy link
Contributor

Choose a reason for hiding this comment

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

Search doesn't support excel downloads, does it?

Copy link
Contributor

Choose a reason for hiding this comment

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

It is supposed to. For the first version, we're passing back the Excel docs so that auditors can review what they submitted. In the case of large audits, they often use tools to do this. So, we're passing the submitted objects back.

Copy link
Contributor

Choose a reason for hiding this comment

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

The plumbing is in place for excel downloads, but it's effectively unreachable code - we currently only have PdfDownloadView which hardcodes "report" for file_type.

I missed the XLSX Workbook download link on the summary page - I see that in figma now. Should we update this PR to include XLSX downloads or push that to 1.5?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, figma shows a single XLSX download link -- is that intended to return a zip of all workbooks?

backend/dissemination/search.py Outdated Show resolved Hide resolved

return response
except ClientError:
raise Http404("File not found")
Copy link
Contributor

Choose a reason for hiding this comment

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

Does a 404 percolate (somewhat) nicely up to the user, so if something goes wrong we're able to debug/figure it out?

Copy link
Contributor

Choose a reason for hiding this comment

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

app_name = "dissemination"

urlpatterns = [
path("pdf/<str:report_id>", views.PdfDownloadView.as_view(), name="PdfDownload"),
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we put XLSX docs under the pdf path/pattern? Or, are XLSX not part of this ticket?

Copy link
Contributor

Choose a reason for hiding this comment

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

Not part of this PR, will be a separate path/pattern. Download plumbing for XLSX is in place, would just need to stand up a View similar to PdfDownloadView

from dissemination.forms import SearchForm
from dissemination.search import search_general
from dissemination.models import (
General,
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we allow search of multiple UEIs, multiple EINs, and secondary auditors? It looks like "no," so I'll add it to the 1.5 increment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, 1.5

Copy link
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.

Code looks good. I cannot run this while traveling.

I created an epic to track next steps:

#2600

we can refine that later as needed. Feel free to add other work to it.

Because I can't run it, I'm going to only leave this as a comment. I can't do a full review from where I'm at. Looks good as a read.

@timoballard timoballard temporarily deployed to dev October 24, 2023 15:05 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 24, 2023 15:05 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to dev October 24, 2023 15:27 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 24, 2023 15:27 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to dev October 24, 2023 16:17 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 24, 2023 16:17 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to dev October 24, 2023 16:20 — with GitHub Actions Inactive
@timoballard timoballard temporarily deployed to meta October 24, 2023 16:20 — with GitHub Actions Inactive
@jperson1 jperson1 mentioned this pull request Oct 24, 2023
14 tasks
@timoballard timoballard added this pull request to the merge queue Oct 25, 2023
Merged via the queue into main with commit d480d30 Oct 25, 2023
@timoballard timoballard deleted the mh/implement-mvp-search-form-2369 branch October 25, 2023 17:46
JeanMarie-PM pushed a commit that referenced this pull request Oct 31, 2023
* Add management command and workflow for generating live test data from historical exports (#2569)

* First commit of E2E improvements

For running in production-like environments.

* add e2e generator workflow and profile changes

* lint

* double os

* more linting somehow

* don't do generation via profile

* Linting.

Runs defaults

* invoke via workflow instead of profile

* Apply suggestions from code review

* lint

---------

Co-authored-by: Matt Jadud <[email protected]>

* add workflow call to e2e data generator (#2571)

* This makes sure all of the named ranges exist (#2586)

* This makes sure all of the named ranges exist

Updates the ALN code slightly, and adds a new check that looks at the
workbook templates, and makes sure that all of the named ranges in the
template are in the file being submitted by the user

* Removed unused code and implemented logic to retrieve named range names

* Fix for string parsing issue

---------

Co-authored-by: Hassan D. M. Sambo <[email protected]>

* Add barebones feature allowing users to send submissions back to in progress from ready for certification (#2572)

* Add barebones feature allowing users to send submissions back to in progress from ready for certification.

* Coverage appeasement offering.

* More coverage appeasement.

* More coverage appeasement; this does fix an actual minor bug, though.

* Reduce test coverage pass threshold.

* Improve lock icon.

* Improve lock icon.

* Certification Unlock Copy & Styling Updates (#2595)

* Ready for certification - remove bolded & reformat

* Submissions homepage - icon on own line & format

* Certification unlock - format, copy, links.

* upload-cancel -> form-cancel

* "Straight quotation marks boo"

Co-authored-by: Tadhg O'Higgins <[email protected]>

---------

Co-authored-by: Tadhg O'Higgins <[email protected]>

* Search MVP (#2419)

* Add basic search form

* Add dummy results table

* move search to dissem app, impl basic form (#2431)

* Basic styles for search sidebar

* Style up results column

* [DRAFT] Search Summary (#2480)

* Search Summary

* Some title info, make tables take up the full width of the page

* Linting - py whitespace & imports, html closed tag

* Summary view tests (#2512)

* Flesh out Search view (#2494)

* fleshing out search view

* rm leftover list comprehension

* cog-over search fix, only search public

* more tests

* quick pass at displaying search results

* Add explainer text

* Remove filter chicklets (for now)

* Add pagination component

* Rm download all results button

* Add alt text

* Search - Pre-populate Form, Summary Link, Link Icons, Formatting (#2538)

* 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 - Audit Year (#2547)

* 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

* PDF downloads via Search (#2520)

* first pass at pdf downloads via search

* re-add AWS_S3_ENDPOINT_URL

* re-add download link

* linter

* fix cog_or_over field name mismatch

* fix search tests

* check if file exists in s3, else 404

* log warning if file not found in S3

---------

Co-authored-by: Matt Henry <[email protected]>
Co-authored-by: Tim Ballard <[email protected]>
Co-authored-by: Tim Ballard <[email protected]>
Co-authored-by: James Person <[email protected]>
Co-authored-by: James Person <[email protected]>

* fix cg internal endpoint setting (#2613)

* Add mgiration file that should have been in 2572. (#2615)

* API app cleanup (#2596)

* rm IndexView

* rm SACViewSet

* Bump Actions (#2624)

* Bump to v0.13.0

* Bump setup-node to v4

* Media Backups! (#2610)

* pseudo code for s3 tar implementation

* add awscli to allow list

* File Rename

* All commands

Just need to sort creds now

* update command file

* Update proxy allow list for s3tar

* Script for backing up the media

* chmod +x

* Remove mediabackup

* add media backups

* Bind service with additional instances

* Removing allowlist modifications

* Using this workflow to test/debug

* Update

* Update

* File Rename

* Reformat Media Backups Workflow

* remove media backups from prod (for now)

* Remove mediabackups folder as well

* Remove from apply

This will be handled in its own workflow

* Database and Media Backups

Commented out prod for future iteration

* rename file

* full path of aws (#2636)

* Removing old workbook_generator tool (#2635)

Co-authored-by: Phil Dominguez <“[email protected]”>

---------

Co-authored-by: Dan Swick <[email protected]>
Co-authored-by: Matt Jadud <[email protected]>
Co-authored-by: Hassan D. M. Sambo <[email protected]>
Co-authored-by: Tadhg O'Higgins <[email protected]>
Co-authored-by: James Person <[email protected]>
Co-authored-by: Matt Henry <[email protected]>
Co-authored-by: Matt Henry <[email protected]>
Co-authored-by: Tim Ballard <[email protected]>
Co-authored-by: Tim Ballard <[email protected]>
Co-authored-by: James Person <[email protected]>
Co-authored-by: Alex Steel <[email protected]>
Co-authored-by: Phil Dominguez <“[email protected]”>
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.

6 participants