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

[DBEX] create UpdateDocumentsStatus and Polling services #17460

Closed

Conversation

freeheeling
Copy link
Contributor

@freeheeling freeheeling commented Jul 9, 2024

Summary

Objective: Implements a system for periodically polling the Lighthouse uploads/status endpoint to confirm the status of supplemental documents submitted to Lighthouse as part of a Form 526 Submission. The purpose of this system is to surface successes and failures that happen in the Form 526 process after being forwarded to Lighthouse for processing.

  • Create DocumentsStatusPolling and UpdateDocumentsStatus service classes
    • Configure connection and data transmission to Benefits Documents '/uploads/status' endpoint
    • Add processing timeout window and failure step logic to UploadStatusUpdater
  • Subsequent PRs will further implement the interaction with the Lighthouse Benefits Document API client
  • This work is behind a feature toggle (flipper): YES/NO
  • Responsible team: Disability Benefits Experience Team 2 (dBeX Carbs 🥖)

Related issue(s)

Testing done

  • New code is covered by unit tests

What areas of the site does it impact?

  • non-user facing, asynchronous job tracking the status of uploaded documents submitted in conjunction with Form 526EZ

Acceptance criteria

  • I fixed|updated|added unit tests and integration tests for each feature (if applicable).
  • No error nor warning in the console.
  • Events are being sent to the appropriate logging solution
  • Documentation has been updated (link to documentation)
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
  • Feature/bug has a monitor built into Datadog (if applicable)
  • If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
  • I added a screenshot of the developed feature

@freeheeling freeheeling added disability-experience To manage benefits disability claims experience. disability-compensation Label used for Pull Requests that impact Disability Compensation claims (526EZ) labels Jul 9, 2024
Copy link

github-actions bot commented Jul 9, 2024

1 Error
🚫 This PR changes 642 LoC (not counting whitespace/newlines).

In order to ensure each PR receives the proper attention it deserves, those exceeding
500 will not be reviewed, nor will they be allowed to merge. Please break this PR up into
smaller ones.

If you have reason to believe that this PR should be granted an exception, please see the
Submitting pull requests for approval - FAQ.

File Summary

Files

  • lib/lighthouse/benefits_documents/configuration.rb (+29/-2)

  • lib/lighthouse/benefits_documents/form526/documents_status_polling_service.rb (+31/-0)

  • lib/lighthouse/benefits_documents/form526/update_documents_status_service.rb (+87/-0)

  • lib/lighthouse/benefits_documents/form526/upload_status_updater.rb (+132/-0)

  • spec/lib/lighthouse/benefits_documents/form526/update_documents_status_service_spec.rb (+148/-0)

  • spec/lib/lighthouse/benefits_documents/form526/upload_status_updater_spec.rb (+213/-0)

    Note: We exclude files matching the following when considering PR size:

    *.csv, *.json, *.tsv, *.txt, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, *.bru
    

Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
disability-compensation Label used for Pull Requests that impact Disability Compensation claims (526EZ) disability-experience To manage benefits disability claims experience.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants