As a user, I want to clear the cache after a deploy

[jzbahrai]

Description

Once we do a deploy, I want to clear the cache of Templates, TemplateCategories, Services, User, EmailBranding, Organisation

Acceptance Criteria

• Check that the above entities that are in the cache pre deploy, are removed post deploy

QA Steps

• Tested in staging

[yaelberger-commits]

Please add your planning poker estimate with Zenhub @jzbahrai

[yaelberger-commits]

Hey team! Please add your planning poker estimate with Zenhub @andrewleith @whabanks

[yaelberger-commits]

@andrewleith is working on this one today

[andrewleith]

TODO:

• Misc: generate new CACHE_CLEAR_CLIENT_SECRET
• MANIFESTS / #2904 - Add CACHE_CLEAR_CLIENT_SECRET to .env so that API can use it to authenticate calls to the new endpoint
• UTILS / #315 - Move the list of cache keys here so they can be used by both admin and API
• TF / #1508 - Update the WAF rules to allow the new api endpoint to be called
• API / #2278 - Add a new protected endpoint that will clear all redis caches from the list in utils (in review)
• Add CACHECLEAR_SECRET_KEY to github secrets (one for staging + one for prod) (you can find these values in manifests!)
• MANIFESTS - Update one of the deployment workflows to call the cache clearing endpoint after deploy using new secret key injected from github secrets
  • Usage for the cache-clear.js script:
    • ❯ node clear_cache.js "CACHE_CLEAR_USER" "SECRET_HERE" "API_ENDPOINT_HERE"

For later:

• ADMIN - (Optional, can come later) Update the admin cache clearing logic to use the list from utils, instead of the list currently hardcoded in admin

[yaelberger-commits]

2 PRs up, Jumana may pick this up today or when Callback work is done

[yaelberger-commits]

Mostly done, working in Staging. Next step is to merge in Staging

[yaelberger-commits]

Second PR needs to be merged

[yaelberger-commits]

Got it working in Staging, but failed in Prod. Jumana will take a look today.

[jzbahrai]

this is done! https://github.com/cds-snc/notification-manifests/actions/runs/10814319807/job/30000671945