Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Adding generateCacheKey to ApolloServerPluginResponseCache to allow for custom cache keys #6655

Merged
merged 11 commits into from
Jul 11, 2022
+30 −10
Merged

✨ Adding generateCacheKey to ApolloServerPluginResponseCache to allow for custom cache keys #6655

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2f9d9b4
✨ Adding new hook for changing the cachekey for the response cache
kschrade Jul 7, 2022
d34fdfb
little clean up
kschrade Jul 8, 2022
5318f98
Update packages/apollo-server-plugin-response-cache/src/ApolloServerP…
kschrade Jul 8, 2022
980e46b
PR updates
kschrade Jul 8, 2022
ed4c54a
Merge branch 'main' of https://github.com/kschrade/apollo-server
kschrade Jul 8, 2022
f321d3d
Remove unused code, fix build
trevor-scheer Jul 11, 2022
90f0322
Update docs/source/performance/caching.md
kschrade Jul 11, 2022
5bd53a6
removing any from function
kschrade Jul 11, 2022
d5f90aa
empty commit to trigger builds (sorry)
trevor-scheer Jul 11, 2022
b0bcf9b
Update packages/apollo-server-plugin-response-cache/src/ApolloServerP…
kschrade Jul 11, 2022
1c84a40
📝 addition to change log
kschrade Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/performance/caching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,3 +472,4 @@ In addition to [the `sessionId` function](#identifying-users-for-private-respons
| `extraCacheKeyData` | This function's return value (any JSON-stringifiable object) is added to the key for the cached response. For example, if your API includes translatable text, this function can return a string derived from `requestContext.request.http.headers.get('Accept-Language')`. |
| `shouldReadFromCache` | If this function returns `false`, Apollo Server _skips_ the cache for the incoming operation, even if a valid response is available. |
| `shouldWriteToCache` | If this function returns `false`, Apollo Server doesn't cache its response for the incoming operation, even if the response's `maxAge` is greater than `0`. |
| `generateCacheKey` | This function's return is used as the key for the cache. If it is not overrode a sha256 hash is used |
kschrade marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 6 additions & 6 deletions packages/apollo-server-plugin-response-cache/src/ApolloServerPluginResponseCache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ export default function plugin(
'fqc:',
);

const generateCacheKey = options.generateCacheKey
? options.generateCacheKey
: (_: any, key: any) => sha(JSON.stringify(key));
trevor-scheer marked this conversation as resolved.
Show resolved Hide resolved

let sessionId: string | null = null;
let baseCacheKey: BaseCacheKey | null = null;
let age: number | null = null;
Expand All @@ -177,9 +181,7 @@ export default function plugin(
...contextualCacheKeyFields,
};

const key = options.generateCacheKey
? options.generateCacheKey(requestContext, cacheKeyData)
: cacheKeyString(cacheKeyData);
const key = generateCacheKey(requestContext, cacheKeyData);

const serializedValue = await cache.get(key);
if (serializedValue === undefined) {
Expand Down Expand Up @@ -295,9 +297,7 @@ export default function plugin(
...contextualCacheKeyFields,
};

const key = options.generateCacheKey
? options.generateCacheKey(requestContext, cacheKeyData)
: cacheKeyString(cacheKeyData);
const key = generateCacheKey(requestContext, cacheKeyData);

const value: CacheValue = {
data,
Expand Down