Add option to downgrade DB as part of /admin/db endpoint

[adamsachs]

Closes PROD-2087

Description Of Changes

Adds a downgrade option to our /admin/db endpoint. Allows specifying a migration revision as a revision query param. revision query param can also be used for upgrade command now, if desired - though in practice, that probably won't be needed much.

Also adds the current revision number/name as a field in the /health/database endpoint response, e.g.

{
  "database": "healthy",
  "database_revision": "fc2b2c06e595"
}

See issue description for more context.

Code Changes

• add downgrade action to path param enum. executes an alembic downgrade against the db
• add revision optional query param to allow for migration revision name/number to be specified on the endpoint
• add the current revision number/name as a field in the /health/database endpoint.
• fix a downgrade migration that was invalid and would break/stop the downgrade if executed

Steps to Confirm

• run fides server: nox -s dev
• hit the /api/v1/admin/db/downgrade endpoint (e.g. thru swagger UI) and specify a revision that's lower than the head on main, e.g. 9e83545ed9b6
• confirm DB is altered as expected and its alembic_version.version_num value is the revision that was specified in the step above

Pre-Merge Checklist

• All CI Pipelines Succeeded
• Documentation:
  • documentation complete, PR opened in fidesdocs
  • documentation issue created in fidesdocs
• Issue Requirements are Met
• Relevant Follow-Up Issues Created
• Update CHANGELOG.md
• For API changes, the Postman collection has been updated

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
fides-plus-nightly	⬜️ Ignored (Inspect)	Visit Preview		May 22, 2024 1:46pm

[cypress]

Passing run #7853 ↗︎

0	4	0	0	0
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.

Details:

Merge e775209 into 1373ba0...
Project: fides	Commit: 5efa3dabea ℹ️
Status: Passed	Duration: 00:34 💡
Started: May 22, 2024 1:56 PM	Ended: May 22, 2024 1:56 PM

Review all test suite changes for PR #4893 ↗︎

[adamsachs]

some notes on misc. cleanup changes i made along the way.

[codecov]

Codecov Report

Attention: Patch coverage is 60.00000% with 18 lines in your changes are missing coverage. Please review.

Project coverage is 86.72%. Comparing base (1373ba0) to head (e775209).

Files	Patch %	Lines
src/fides/api/db/database.py	54.54%	8 Missing and 2 partials ⚠️
src/fides/api/api/v1/endpoints/admin.py	60.00%	6 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4893      +/-   ##
==========================================
- Coverage   86.78%   86.72%   -0.06%     
==========================================
  Files         347      347              
  Lines       21102    21121      +19     
  Branches     2762     2765       +3     
==========================================
+ Hits        18313    18317       +4     
- Misses       2303     2315      +12     
- Partials      486      489       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pattisdr]

i really like exposing the current revision here.

Further comments: https://ethyca.atlassian.net/browse/PROD-2087?focusedCommentId=41060

[pattisdr]

Reviewing -

[pattisdr]

nice changelog additions 👍

[pattisdr]

Looks good to me, I especially like the re-org.

There's an outstanding existing issue if we upgrade and it fails, the API returns that it succeeded, but the logs show the failure. I think we should reticket -

[adamsachs]

Looks good to me, I especially like the re-org.

There's an outstanding existing issue if we upgrade and it fails, the API returns that it succeeded, but the logs show the failure. I think we should reticket -

ah yes sorry i ignored that because it was already there and i was the slightest bit unsure about how to best handle/got a bit worried about breaking things. i'll create a follow up ticket - thanks for the speedy and helpful review on this!

[adamsachs]

ticketed https://ethyca.atlassian.net/browse/PROD-2118 as a follow up for the upgrade issue you uncovered 👍