✨ Adding generateCacheKey to ApolloServerPluginResponseCache to allow for custom cache keys#6655
Merged
Merged
Conversation
|
✅ Deploy Preview for apollo-server-docs canceled.Built without sensitive environment variables
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 1c84a40:
|
glasser
requested changes
Jul 8, 2022
glasser
left a comment
glasser
left a comment
Member
There was a problem hiding this comment.
Please also provide at least a brief mention of this parameter in the docs (docs/source/performance/caching.md). The table in the bottom section seems reasonable. Thanks1
…luginResponseCache.ts Co-authored-by: David Glasser <glasser@apollographql.com>
glasser
requested changes
Jul 8, 2022
Co-authored-by: David Glasser <glasser@apollographql.com>
…luginResponseCache.ts Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com>
trevor-scheer
approved these changes
Jul 11, 2022
trevor-scheer
left a comment
trevor-scheer
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Would you please make an addition to CHANGELOG.md?
kschrade
changed the title
generateCacheKey to ApolloServerPluginResponseCache to allow for custom cache keys
glasser
added a commit
that referenced
this pull request
Jul 11, 2022
- Rename BaseCacheKey and ContextualCacheKey with "Data" on end, since the cache key is a string. - Reintroduce CacheKey(Data) removed in #6655; make the GenerateCacheKeyFunction type be defined in terms of it. Now calls to the `const generateCacheKey` function are type-safe (ie, the second arg is a CacheKeyData rather than unknown). - Describe generateCacheKey hook as a method rather than a field, like the other hooks in Options.
Merged
trevor-scheer
pushed a commit
that referenced
this pull request
Jul 11, 2022
- Rename BaseCacheKey and ContextualCacheKey with "Data" on end, since the cache key is a string. - Reintroduce CacheKey(Data) removed in #6655; make the GenerateCacheKeyFunction type be defined in terms of it. Now calls to the `const generateCacheKey` function are type-safe (ie, the second arg is a CacheKeyData rather than unknown). - Describe generateCacheKey hook as a method rather than a field, like the other hooks in Options.
trevor-scheer
pushed a commit
that referenced
this pull request
Jul 11, 2022
…for custom cache keys (#6655) Create a new hook (`generateCacheKey`) on the `ApolloServerPluginResponseCache` constructor options which allows users to customize the cache key used by returning their own `string`. The hook receives two arguments: the `requestContext` and an object (`cacheKeyData`) which contains the following properties: `source` `operationName` `variables` `extra` (computed by `options.extraCacheKeyData`) `sessionId` `sessionMode`
trevor-scheer
pushed a commit
that referenced
this pull request
Jul 11, 2022
- Rename BaseCacheKey and ContextualCacheKey with "Data" on end, since the cache key is a string. - Reintroduce CacheKey(Data) removed in #6655; make the GenerateCacheKeyFunction type be defined in terms of it. Now calls to the `const generateCacheKey` function are type-safe (ie, the second arg is a CacheKeyData rather than unknown). - Describe generateCacheKey hook as a method rather than a field, like the other hooks in Options.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Create a new hook (
generateCacheKey) on theApolloServerPluginResponseCacheconstructor options which allows users to customize the cache key used by returning
their own
string.The hook receives two arguments: the
requestContextand an object (cacheKeyData)which contains the following properties:
sourceoperationNamevariablesextra(computed byoptions.extraCacheKeyData)sessionIdsessionModeLanding in favor of:
#6649
#6428