chore: add friendly message mapping

[shon-button]

Addresses: 634

🚀 Impact:

• Transforms back-end errors such a emission; fuelName;s gasType into user friendly message.

🔬 Local Testing:

Tests Set-Up:

1. Start the API server:

   cd bc_obps
   make reset_db
   make run

2. Start the app development server:

   cd bciers && yarn dev-all

3. Navigate to http://localhost:3000

4. Click the "Log in with Business BCeID" button

5. Log in using bc-cas-dev

Test: User friendly error messages

Steps

1. Navigate to http://localhost:3000/reporting/reports/
2. Select operation Bugle SFO - Registered
3. Click Continue
4. Navigate to activities, ex: http://localhost:3000/reporting/reports/1/facilities/f486f2fb-62ed-438d-bb3e-0819b51e3aff/activities
5. Select General stationary combustion excluding line tracing\General stationary combustion of fuel or waste with production of useful energy
6. Click Save and Continue

Expected Result

✅
Error displays: "Fuel is expecting 'Fuel Name' data." (transformed back-end error message)

7. Complete Fuel Name
8. Click Save and Continue

Expected Result

✅
Error displays: "Emission is expecting 'Gas Type' data." (transformed back-end error message)

9. Complete Gas Type
10. Click Save and Continue

Expected Result

✅
Error displays: "Emission is expecting 'Emission' data." (transformed back-end error message)

11. Complete Emission
12. Click Save and Continue

Expected Result

✅
Error displays: "Emission is expecting methodology data" (direct back-end error message)

13. Navigate to sign-off, ex: http://localhost:3000/reporting/reports/1/sign-off
14. Complete the form and click Submit report

Expected Result

✅
Error displays: Verification information must be completed with this report. Please complete the Verification page.

15. Navigate to verification, ex: http://localhost:3000/reporting/reports/1/verification
16. Complete the form and click Save and Continue
17. Navigate to sign-off, ex: http://localhost:3000/reporting/reports/1/sign-off
18. Complete the form and click Submit report

Expected Result

✅
Error displays: A verification statement must be uploaded with this report. Please upload a verification statement on the Attachments page.

[pbastia]

This will just introduce some potential weirdness, if we don't explicitely define where the keys we're trying to catch come from. I think we should at the very least make sure that our ReportActivityService throws errors with the right key, that we can then match here. A lot of error messages might contain "emission"!

ReportSubmissionService raises specific exception messages to be caught on the frontend, and we'd want to do the same, as an example

[shon-button]

@pbastia

Thank-you and in agreement that your ReportSubmissionService errors are a good pattern to follow...

In this particular case my choice was specifically not to make any changes to the ReportActivitySaveService (to avoid possible regression bugs etc.) but, still provide a nicer message to the user than the service generated errors: fuelName; gasType; emission.

I have refined the utils function for your re-consideration - thanks!

[zoeyli-46]

Hey @shon-button as part of the new error messages, is it doable for the Activities pages back end error messages be renamed to "< field name > is required" so it is uses plain language? i.e., "Emission 1's Fuel name is required" "Emission 1's methodology is required"

[shon-button]

Hey @shon-button as part of the new error messages, is it doable for the Activities pages back end error messages be renamed to "< field name > is required" so it is uses plain language? i.e., "Emission 1's Fuel name is required" "Emission 1's methodology is required"

@zoeyli-46
cc: @pbastia

Hi Zoey,
I don't think this "quick and easy" solution will satisfy the requirement your looking for...if we want location specific error messaging we might have to consider implementing front-end validations rather than/or as well as more robust back-end error returns.

I will put the related issue card back in the backlog with Backlog Refinement tag.

[shon-button]

Note: re-opening for further consideration of merging based on...
ZL:

Hey Shon! i saw your response on the PR. if we cant be specific with a "fuel 1" etc. then could we just reword your suggestion of ""Fuel is expecting 'Fuel Name' data."" to "Fuel is missing Fuel name"? 
""Emission is expecting 'Gas Type' data."" > Emission is missing Gas Type
"Emission is expecting 'Emission' data" > Emission is missing Emission