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.
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
Depend on existence of enclosing entity object when reading from cache. #8147
Merged
benjamn
merged 4 commits into
release-3.4
from
invalidate-result-cache-on-entity-eviction
May 11, 2021
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f94c914
Depend on existence of enclosing entity object when reading from cache.
benjamn da14971
Add tests of result cache invalidation and LRU eviction (#8169)
sofianhn 3aa29f0
Comment about CacheGroup#dirty __exists logic.
benjamn 457dc65
Mention PR #8147 in CHANGELOG.md.
benjamn File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| import { makeExecutableSchema } from "graphql-tools"; | ||
|
|
||
| import { ApolloClient, Resolvers, gql } from "../core"; | ||
| import { InMemoryCache, NormalizedCacheObject } from "../cache"; | ||
| import { SchemaLink } from "../link/schema"; | ||
|
|
||
| describe("resultCache cleaning", () => { | ||
| const fragments = gql` | ||
| fragment user on User { | ||
| id | ||
| name | ||
| } | ||
|
|
||
| fragment reaction on Reaction { | ||
| id | ||
| type | ||
| author { | ||
| ...user | ||
| } | ||
| } | ||
|
|
||
| fragment message on Message { | ||
| id | ||
| author { | ||
| ...user | ||
| } | ||
| reactions { | ||
| ...reaction | ||
| } | ||
| viewedBy { | ||
| ...user | ||
| } | ||
| } | ||
| `; | ||
|
|
||
| const query = gql` | ||
| query getChat($id: ID!) { | ||
| chat(id: $id) { | ||
| id | ||
| name | ||
| members { | ||
| ...user | ||
| } | ||
| messages { | ||
| ...message | ||
| } | ||
| } | ||
| } | ||
| ${{ ...fragments }} | ||
| `; | ||
|
|
||
| function uuid(label: string) { | ||
| return () => | ||
| `${label}-${Math.random() | ||
| .toString(16) | ||
| .substr(2)}`; | ||
| } | ||
|
|
||
| function emptyList(len: number) { | ||
| return new Array(len).fill(true); | ||
| } | ||
|
|
||
| const typeDefs = gql` | ||
| type Query { | ||
| chat(id: ID!): Chat! | ||
| } | ||
|
|
||
| type Chat { | ||
| id: ID! | ||
| name: String! | ||
| messages: [Message!]! | ||
| members: [User!]! | ||
| } | ||
|
|
||
| type Message { | ||
| id: ID! | ||
| author: User! | ||
| reactions: [Reaction!]! | ||
| viewedBy: [User!]! | ||
| content: String! | ||
| } | ||
|
|
||
| type User { | ||
| id: ID! | ||
| name: String! | ||
| } | ||
|
|
||
| type Reaction { | ||
| id: ID! | ||
| type: String! | ||
| author: User! | ||
| } | ||
| `; | ||
|
|
||
| const resolvers: Resolvers = { | ||
| Query: { | ||
| chat(_, { id }) { | ||
| return id; | ||
| }, | ||
| }, | ||
| Chat: { | ||
| id(id) { | ||
| return id; | ||
| }, | ||
| name(id) { | ||
| return id; | ||
| }, | ||
| messages() { | ||
| return emptyList(10); | ||
| }, | ||
| members() { | ||
| return emptyList(10); | ||
| }, | ||
| }, | ||
| Message: { | ||
| id: uuid("Message"), | ||
| author() { | ||
| return { foo: true }; | ||
| }, | ||
| reactions() { | ||
| return emptyList(10); | ||
| }, | ||
| viewedBy() { | ||
| return emptyList(10); | ||
| }, | ||
| content: uuid("Message-Content"), | ||
| }, | ||
| User: { | ||
| id: uuid("User"), | ||
| name: uuid("User.name"), | ||
| }, | ||
| Reaction: { | ||
| id: uuid("Reaction"), | ||
| type: uuid("Reaction.type"), | ||
| author() { | ||
| return { foo: true }; | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| let client: ApolloClient<NormalizedCacheObject>; | ||
|
|
||
| beforeEach(() => { | ||
| client = new ApolloClient({ | ||
| cache: new InMemoryCache, | ||
| link: new SchemaLink({ | ||
| schema: makeExecutableSchema({ | ||
| typeDefs, | ||
| resolvers, | ||
| }), | ||
| }), | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| const storeReader = (client.cache as InMemoryCache)["storeReader"]; | ||
| expect(storeReader["executeSubSelectedArray"].size).toBeGreaterThan(0); | ||
| expect(storeReader["executeSelectionSet"].size).toBeGreaterThan(0); | ||
| client.cache.evict({ | ||
| id: "ROOT_QUERY", | ||
| }); | ||
| client.cache.gc(); | ||
| expect(storeReader["executeSubSelectedArray"].size).toEqual(0); | ||
| expect(storeReader["executeSelectionSet"].size).toEqual(0); | ||
| }); | ||
|
|
||
| it(`empties all result caches after eviction - query`, async () => { | ||
| await client.query({ | ||
| query, | ||
| variables: { id: 1 }, | ||
| }); | ||
| }); | ||
|
|
||
| it(`empties all result caches after eviction - watchQuery`, async () => { | ||
| return new Promise<void>((r) => { | ||
| const observable = client.watchQuery({ | ||
| query, | ||
| variables: { id: 1 }, | ||
| }); | ||
| const unsubscribe = observable.subscribe(() => { | ||
| unsubscribe.unsubscribe(); | ||
| r(); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, the
EntityStoretries to track dependencies at the field level, so cached result objects don't have to be invalidated if none of their fields have been invalidated, but when the entire object is removed (or added for the first time), that's a more significant event than the removal/addition/modification of individual fields, somaybeDependOnExistenceOfEntityenables consumers to listen specifically for__existsinvalidations.