Strapi v5 Upgrade Checklist

[derrickmehaffy]

Tests/checks we need to complete to release a Stable/Beta V5

Core Rest-Cache Features

Provider

• Check all providers function and can be loaded
• Confirm default provider (memory) loads correctly on boot
• Check getTimeout for providers function

Strategy Options

• Ensure debug works
• Ensure enableEtag works and etags are generated
• Ensure enableXCacheHeaders works and headers are send on response
• Ensure enableAdminCTBMiddleware works (possibly rename since it's wrong?) and changes in admin bust cache properly
• Ensure resetOnStartup works and is properly reset with all providers
  • Bug with Redis where the provider isn't initialized when it tries to reset
• Ensure clearRelatedCache functions even with deeply nested relations (test up to 10 levels)
• Ensure keysPrefix works and prefix is set properly (really only matters with Redis provider)
• Ensure hitpass works -> we may skip this for now as it's complex
  • Skipped
• Ensure maxAge works and cache is auto-busted / set by default

Cache Keys Global

• Ensure useQueryParams functions
• Ensure useHeaders functions
  • Not working but we can ignore, not sure if this was ever working

Content-types

• Ensure generic arrays functions [ "api::test.test" ]
• Ensure complex arrays functions `[ { "contentType": "api::test.test", ... } ]
• Ensure injectDefaultRoutes functions
• Ensure non-global options work (see Strategy Options)

Custom Routes

• Check if limit to single-types is still in place or if we can add support for collection-types -> NICE TO HAVE NOT REQUIRED
  • Looks like caching and busting of single types is working as it does with collection-types :)

Admin Panel

• Bust on update (including related)
• Bust via edit view
• Bust via list view

Memory Provider

• Check maxSize functions
• Document breaking change of max -> maxSize
• Check maxAge functions

Redis Provider

• Ensure connection parameter load the default connection from @strapi-community/plugin-redis
• Document breaking changes from @strapi-community/plugin-redis
• Ensure all ioredis options function (ttl, various server types, ect)
• Possibly add a check/warning to ensure redis plugin config comes before rest-cache?

[derrickmehaffy]

Alright found a bug in alpha.3 on both memory and redis. The TTL isn't being set so auto-busting won't function

[derrickmehaffy]

^ Fixed, was related to the cache-manager upgrade. KeyV handles TTL setting a bit different