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

Jump to bottom

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

Merged
merged 11 commits into from Jul 11, 2022
Merged

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

Changes from 2 commits
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 21 additions & 4 deletions packages/apollo-server-plugin-response-cache/src/ApolloServerPluginResponseCache.ts
View file
Open in desktop
Expand Up @@ -86,6 +86,13 @@ interface Options<TContext = Record<string, any>> {
shouldWriteToCache?(
requestContext: GraphQLRequestContext<TContext>,
): ValueOrPromise<boolean>;

// This hook allows one to replace the function that is used to create a cache
// key. If not it will fall back to what happens today.
kschrade marked this conversation as resolved.
Show resolved Hide resolved
generateCacheKey?(
requestContext: GraphQLRequestContext<TContext>,
keyData: unknown,
): string;
}

enum SessionMode {
Expand Down Expand Up @@ -165,10 +172,15 @@ export default function plugin(
async function cacheGet(
contextualCacheKeyFields: ContextualCacheKey,
): Promise<GraphQLResponse | null> {
const key = cacheKeyString({
const cacheKeyData = {
...baseCacheKey!,
...contextualCacheKeyFields,
});
};

const key = options.generateCacheKey
trevor-scheer marked this conversation as resolved.
Show resolved Hide resolved
? options.generateCacheKey(requestContext, cacheKeyData)
: cacheKeyString(cacheKeyData);

const serializedValue = await cache.get(key);
if (serializedValue === undefined) {
return null;
Expand Down Expand Up @@ -278,10 +290,15 @@ export default function plugin(
const cacheSetInBackground = (
contextualCacheKeyFields: ContextualCacheKey,
): void => {
const key = cacheKeyString({
const cacheKeyData = {
...baseCacheKey!,
...contextualCacheKeyFields,
});
};

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

const value: CacheValue = {
data,
cachePolicy: policyIfCacheable,
Expand Down