Error handling for about/careers (USAJobs API)

[johnnyporkchops]

Summary (required)

• Resolves #6260
• Expand the error handling for ConnectionErrors not caught by the current check for 200 http response,
• Expand the error handling to catch errors that have a 200 http response, but can still break the page.
  • When the request returns html or json data that is not expected jobs dict which which previously caused a 500 Internal server error
• Catch connection errors if USAJobs API is not responding or down for maintenance
• Write the error class name to the page to give devs an indication of what type of error is happening

Required reviewers

One python developer

Impacted areas of the application

/about/careers/ open_jobs.py - get_jobs() templatetag

How to test

• Checkout and run branch

• Export the following env vars from CF in your shell :

  • USAJOBS_API_KEY
  • USAJOBS_WHOMAYAPPLY
  • USAJOBS_AGENCY_CODE (since we currently have no open jobs, you can use PU00 for Peace Corps if you want to confirm job data renders to the page)
  • view the page at /about/careers/
  • run pytest from /fec-cms and /fec-cms/fec directories

  Below are a few ways to trigger various error scenarios if you are interested in testing them:

  • Try changing the JOB_URL in open_jobs.py to a non existent website. Should get (ConnectionError) at the end of the error message in the page.
  • Try adding querystring["page"] = 2 to the querystring parameters, should see: "There are currently no open positions..." message (since it shows a max of 25 jobs per page, it will return no jobs)
  • Comment out "host": "data.usajobs.gov" (@ line 36) and then change the JOB_URL to "https://dummyjson.com/products", should get a (KeyError)

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 72.72727% with 6 lines in your changes missing coverage. Please review.

Project coverage is 77.99%. Comparing base (e20a3e4) to head (3388d23). Report is 47 commits behind head on develop.

Files	Patch %	Lines
fec/home/templatetags/open_jobs.py	70.00%	3 Missing :warning:
fec/home/tests/test_usajobs.py	75.00%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #6276 +/- ## =========================================== - Coverage 78.01% 77.99% -0.02% =========================================== Files 291 291 Lines 9447 9467 +20 Branches 687 687 =========================================== + Hits 7370 7384 +14 - Misses 2077 2083 +6 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[johnnyporkchops]

@JonellaCulmer . Do you think we could come up with different wording for the first sentence in the usajobs error message "USAJobs is unavailable". After digging into this more for this ticket, I realized that there could be a scenario where it is indeed unavailable or "down", but it could also be that just the API is down or not returning the data we need to post jobs. So rather than saying "USAJobs is unavailable", could we say something more generic in the first sentence like "Something went wrong."? That way we are not essentially saying "USAJobs is unavailable....Please visit usajobs.gov..." Here is the current error message: "USAJOBS is unavailable. We are temporarily unable to post open FEC positions. Please visit usajobs.gov for more information."

UPDATE: After pairing with UX/Content team, we agreed we can leave this comment as is.