fix(httpcache): allow custom http method on SouinPurger and SurrogateKeysPurger#8259
Open
soyuka wants to merge 1 commit into
Open
fix(httpcache): allow custom http method on SouinPurger and SurrogateKeysPurger#8259soyuka wants to merge 1 commit into
soyuka wants to merge 1 commit into
Conversation
…KeysPurger The hardcoded PURGE verb prevents using purgers with backends that only accept DELETE for cache invalidation (e.g. the Caddy cache-handler souin-api endpoint, which documents DELETE + Surrogate-Key only). Adds a new optional $method constructor parameter on SurrogateKeysPurger and SouinPurger (default Request::METHOD_PURGE, so existing setups are unchanged). Users on Caddy/Souin can now configure the purger with Request::METHOD_DELETE instead of subclassing. Fixes api-platform#8258
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SouinPurger(and its parentSurrogateKeysPurger) hardcodesPURGEwhen calling the invalidation endpoint. Backends like the Caddy cache-handlersouin-apiendpoint only acceptDELETEwith aSurrogate-Keyheader, so every mutation currently fails with a 500 even though the write succeeded. This PR adds an optional$methodconstructor parameter (defaultRequest::METHOD_PURGE, fully BC) so users can configureDELETEwithout writing a custom purger.Reproduction
Configure
SouinPurgeragainst a Caddy cache-handlerapi { basepath /souin-api; souin }endpoint; anyPOST/PATCH/DELETEreturns 500 with"Empty reply from server"because Caddy's endpoint only handlesDELETE, notPURGE.Test plan
SouinPurgerTest::testPurgeWithCustomHttpMethod) covering the new constructor argument.Fixes #8258