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

Int b 21669 doc viewer file upload status per s3 events #14757

Open
wants to merge 12 commits into
base: integrationTesting
Choose a base branch
from

Conversation

samaysofo
Copy link
Contributor

@samaysofo samaysofo commented Feb 6, 2025

B-21669

Summary

This story adds UI changes that calls the server-sent event api calls for receiving real-time updates from AWS. As a user uploads a file, they will see real-time progress of the file "Uploading", "Scanning" , "Establishing document for viewing".

Is there anything you would like reviewers to give additional scrutiny?

this article explains more about the approach used.

Verification Steps for the Author

These are to be checked by the author.

  • Tested in the Experimental environment (for changes to containers, app startup, or connection to data stores)
  • Have the Agility acceptance criteria been met for this change?

Verification Steps for Reviewers

These are to be checked by a reviewer.

  • Has the branch been pulled in and checked out?
  • Have the BL acceptance criteria been met for this change?
  • Was the CircleCI build successful?
  • Has the code been reviewed from a standards and best practices point of view?

Setup to Run the Code

  1. Add this to your ~/.zshrc (remember to run source ~/.zshrc) to run your server
    alias aws-s3="STORAGE_BACKEND=s3 AWS_S3_BUCKET_NAME=transcom-gov-dev-app-devlocal-us-gov-west-1 AWS_S3_REGION=us-gov-west-1 AWS_DEFAULT_REGION=us-gov-west-1 AWS_PROFILE=transcom-gov-dev aws-vault exec transcom-gov-dev -- make server_run"
    NOTE: Uncomment export RECEIVER_BACKEND=sns_sqs in your .envrc to use the AWS sns_sqs .

How to test

  1. Access the app
  2. Login as an office user
  3. Navigate to the respective queues
  4. Select a move and click "View and edit orders"
  5. Delete all uploaded files(both Manage Orders and Manage Amended Orders) if there are existing ones.
  6. Should see "File Not Found"
  7. Upload a new file
  8. Should see "Uploading" when the file is in the upload status
  9. Once upload is complete, should see "Scanning" (note: current the scan takes ~20 secs +/-)
  10. When the scan is complete, then should see "Establishing document for viewing" and document displays.
  11. In order to test out the already uploaded/scanned file, navigate back to the "Move details page" and click "View and edit orders"
  12. Should see "Establishing document for viewing" and document displays.
  13. Repeat step 5-9, and navigate back to the "Move details page" while "Scanning" is still in progress.
  14. Then click "View and edit orders" to go back to the file being uploaded, should see "Scanning" if the anti-virus scan is not yet complete.

Frontend

  • There are no aXe warnings for UI.
  • This works in Supported Browsers and their phone views (Chrome, Firefox, Edge).
  • There are no new console errors in the browser devtools.
  • There are no new console errors in the test output.
  • If this PR adds a new component to Storybook, it ensures the component is fully responsive, OR if it is intentionally not, a wrapping div using the officeApp class or custom min-width styling is used to hide any states the would not be visible to the user.
  • This change meets the standards for Section 508 compliance.

Backend

Database

Any new migrations/schema changes:

  • Follows our guidelines for Zero-Downtime Deploys.
  • Have been communicated to #g-database.
  • Secure migrations have been tested following the instructions in our docs.

Screenshots

B-21669-File-Upload-Progress.mov

@samaysofo samaysofo self-assigned this Feb 6, 2025
@samaysofo samaysofo changed the base branch from main to integrationTesting February 6, 2025 14:27
@samaysofo samaysofo added Go-Rillaz Go-Rillaz frontend INTEGRATION Slated for Integration Testing labels Feb 6, 2025
src/shared/constants.js Show resolved Hide resolved
@danieljordan-caci danieljordan-caci self-requested a review February 7, 2025 16:50
@danieljordan-caci danieljordan-caci dismissed their stale review February 7, 2025 16:51

dismissing review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend Go-Rillaz Go-Rillaz INTEGRATION Slated for Integration Testing
Development

Successfully merging this pull request may close these issues.

2 participants