FYST-1675 Send filer rejection notice if efile errors have handling #5445

arinchoi03 · 2025-01-25T00:03:29Z

Link to pivotal/JIRA issue

https://codeforamerica.atlassian.net/browse/FYST-1675

Is PM acceptance required? (delete one)

Yes - don't merge until JIRA issue is accepted!

Reminder: merge main into this branch and get green tests before merging to main

What was done?

handling: means an admin set auto_wait, expose, auto_cancel flags on an efile error. When the next time this error is seen (on a different submission), it will apply that same handling for the new submission (efile_submission_transition_error that points to the shared EfileError -- see Efile::SubmissionErrorParser for more information)

Part 1: When efile error already exists with handling, make sure that auto_wait: true efiling error triggers a notification for the user to correct their submission (AfterTransitionTasksForRejectedReturnJob)
Part 2: When efile error is updated with handling and the admin presses "Reprocess", make sure the rejected submission also notifies the client if all efile errors are "auto-wait". (EfileErrorsController #reprocess method)
Miscellaneous:
- Noticed that the ability file was missing permissions for efile errors with service_type set to state_file_#{state_code} so added those
- Updated efile_submissions factory for_state attribute to utilize state_file_az_intake as the data_source instead of state_file_ny_intake to utilize what's live

How to test?

Describe the testing approach taken to verify the changes, including:
- Unit/integration/manual tests
  - added back hub efile errors controller specs: deleted in Delete CTC deprecated actions #4613 -- I had to refactor to make this work & add new expectations now that the code is changing as well. Feel free to just read as if I wrote the entire doc from scratch.
  - I'm not sure how we want to acceptance test this -- for the reprocess button, I can create an efile error and associate a transition on a submisson in "rejected" status with the same error code & service_type, then press the button to reprocess the error
  - for the AfterTransitionTasksForRejectedReturnJob, create an efile error for a state, create a submission and transition the submission to "failed" state and watch it get notified?
Specify any relevant testing environments used (e.g., development, staging, demo, Heroku).
Risk Assessment
- This is a change to the existing status of things, so we want to be extra sure that the status changes that are going in are tested thoroughly.

Screenshots (for visual changes)

Before
After

… are auto_wait

arinchoi03 · 2025-01-25T00:05:33Z

app/jobs/state_file/after_transition_tasks_for_rejected_return_job.rb

@@ -9,9 +9,10 @@ def perform(submission, transition)
        if transition.efile_errors.any?(&:auto_cancel)
          submission.transition_to!(:notified_of_rejection)
          submission.transition_to!(:cancelled)
+        elsif transition.efile_errors.all?(&:auto_wait)
+          submission.transition_to!(:notified_of_rejection)


in the else scenario, they remain in rejected state & see pending html on return-status and do not receive any notification (unless they travel further down & have any retry-able error codes).

Technically same pathway for the else submissions, just different syntax. The main change is the change from :notified_of_rejection instead of :waiting

arinchoi03 · 2025-01-25T00:07:21Z

spec/controllers/hub/state_file/efile_errors_controller_spec.rb

+      pending 'Not implemented'
+    end
+  end
+end


need to fill this file out before I add my code :(

resuscitating an old file deleted: #4613

github-actions · 2025-01-25T00:08:42Z

Heroku app: https://gyr-review-app-5445-d5c2adb8e07e.herokuapp.com/
View logs: heroku logs --app gyr-review-app-5445 (optionally add --tail)

…tweaks)

arinchoi03 · 2025-01-27T22:43:01Z

spec/factories/efile_submissions.rb

@@ -48,7 +48,7 @@

    trait :for_state do
      tax_return {}
-      data_source { create :state_file_ny_intake }
+      data_source { create :state_file_az_intake }


hoping this doesnt catastrophically mess things up

it didnt! had to do a small follow up commit to fix 42ced40

arinchoi03 · 2025-01-27T22:43:47Z

app/controllers/hub/state_file/efile_errors_controller.rb

+                                                         efile_error: @efile_error,
+                                                         efile_submission_transitions: { most_recent: true, to_state: ["rejected", "failed"] }
+                                                       )
+                                                       .pluck(:efile_submission_id)


the above block is just me reformatting code to be more readable (in ruby mine)

…te/index efile errors

embarnard

Nice work! 🎉

embarnard · 2025-01-28T01:41:25Z

spec/controllers/hub/state_file/efile_errors_controller_spec.rb

+      let(:failed_submission) { create :efile_submission, :for_state, :failed }
+      let(:wait_efile_error) { create :efile_error, code: "WAIT-ME-123", auto_wait: true, service_type: :state_file_az }
+      let(:cancel_efile_error) { create :efile_error, code: "CANCEL-ME-123", auto_cancel: true, service_type: :state_file_az }
+      let(:not_handled_error) { create :efile_error, code: "NOTHING-ME-123", auto_cancel: false, auto_wait: false, service_type: :state_file_az }


what is a not handled error? is that just the default error?

embarnard · 2025-01-28T01:42:01Z

spec/controllers/hub/state_file/efile_errors_controller_spec.rb

+      end
+    end
+  end
+end


nice spec! 🎉

embarnard · 2025-01-28T01:47:14Z

spec/lib/ability_spec.rb

+      context "with nj state efile error" do
+        let!(:state_efile_error) { create :efile_error, service_type: "state_file_nj" }
+        it "cannot manage the state efile error" do
+          expect(subject.can?(:manage, state_efile_error)).to eq false


maybe out of the scope of this ticket but should there be a test for a user role "StateFileNjStaffRole::TYPE" that can manage nj state efile erorr?

embarnard · 2025-01-28T01:58:31Z

app/controllers/hub/state_file/efile_errors_controller.rb

+    private
+
+    def auto_transition_to_state(efile_error, submission)
+      return :cancelled if efile_error.auto_cancel


is there a way we can just transition all the efile submissions to cancelled if the efile_error is auto_cancel up on line 52 instead of looping through all of them each time?

I guess it doesn't matter that much though since we probably won't have that many submissions to reprocess each time, so more of just an idea [DUST]

Transition rejected submission to notified_of_rejection if all errors…

e0d2663

… are auto_wait

arinchoi03 commented Jan 25, 2025

View reviewed changes

Remove unnecessary variable setting

9c4e4b7

arinchoi03 commented Jan 25, 2025

View reviewed changes

arinchoi03 added 6 commits January 27, 2025 11:07

Re-add deleted controller spec

c440edc

Add a efile_errors_controller (bring it back from the dead with some …

dc18a3e

…tweaks)

Add in new expectations for reprecess

fe11cf9

Mimic after_transition_tasks_for_rejected_return_job in reprocess

82c4cfd

Clarify after_transition_tasks spec

8463172

Reduce references to state_file_ny_intake in efile_submission factory

8475c11

arinchoi03 commented Jan 27, 2025

View reviewed changes

arinchoi03 added 2 commits January 27, 2025 15:20

Fix references now that efile submission defaults to az

42ced40

Make sure only state file admins are properly authorized to edit/upda…

c34ba61

…te/index efile errors

embarnard approved these changes Jan 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FYST-1675 Send filer rejection notice if efile errors have handling #5445

FYST-1675 Send filer rejection notice if efile errors have handling #5445

arinchoi03 commented Jan 25, 2025 •

edited

Loading

arinchoi03 Jan 25, 2025 •

edited

Loading

arinchoi03 Jan 25, 2025

arinchoi03 Jan 27, 2025

github-actions bot commented Jan 25, 2025

arinchoi03 Jan 27, 2025

arinchoi03 Jan 27, 2025

arinchoi03 Jan 27, 2025

embarnard left a comment

embarnard Jan 28, 2025

embarnard Jan 28, 2025

embarnard Jan 28, 2025

embarnard Jan 28, 2025

embarnard Jan 28, 2025

FYST-1675 Send filer rejection notice if efile errors have handling #5445

Are you sure you want to change the base?

FYST-1675 Send filer rejection notice if efile errors have handling #5445

Conversation

arinchoi03 commented Jan 25, 2025 • edited Loading

Link to pivotal/JIRA issue

Is PM acceptance required? (delete one)

What was done?

How to test?

Screenshots (for visual changes)

arinchoi03 Jan 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 25, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

embarnard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arinchoi03 commented Jan 25, 2025 •

edited

Loading

arinchoi03 Jan 25, 2025 •

edited

Loading