-
Notifications
You must be signed in to change notification settings - Fork 675
Add cacheInterceptor() and autoPersistedQueriesInterceptor() #6455
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ddfc744
Add cacheInterceptor() and autoPersistedQueriesInterceptor()
martinbonnin 56e3b77
make cacheInterceptor public
martinbonnin 32f8bd7
add mention in the changelog
martinbonnin 800300b
remove obsolete tests
martinbonnin a53a44e
update the test to include patching based on the response
martinbonnin 65a97e3
update README
martinbonnin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -113,26 +113,54 @@ fun ApolloClient.Builder.normalizedCache( | |
fun ApolloClient.Builder.logCacheMisses( | ||
log: (String) -> Unit = { println(it) }, | ||
): ApolloClient.Builder { | ||
check(interceptors.none { it is ApolloCacheInterceptor }) { | ||
"Apollo: logCacheMisses() must be called before setting up your normalized cache" | ||
} | ||
return addInterceptor(CacheMissLoggingInterceptor(log)) | ||
} | ||
|
||
fun ApolloClient.Builder.store(store: ApolloStore, writeToCacheAsynchronously: Boolean = false): ApolloClient.Builder { | ||
check(interceptors.none { it is AutoPersistedQueryInterceptor }) { | ||
"Apollo: the normalized cache must be configured before the auto persisted queries" | ||
private class DefaultInterceptorChain( | ||
private val interceptors: List<ApolloInterceptor>, | ||
private val index: Int, | ||
) : ApolloInterceptorChain { | ||
|
||
override fun <D : Operation.Data> proceed(request: ApolloRequest<D>): Flow<ApolloResponse<D>> { | ||
check(index < interceptors.size) | ||
return interceptors[index].intercept( | ||
request, | ||
DefaultInterceptorChain( | ||
interceptors = interceptors, | ||
index = index + 1, | ||
) | ||
) | ||
} | ||
} | ||
|
||
private fun ApolloInterceptorChain.asInterceptor(): ApolloInterceptor { | ||
return object : ApolloInterceptor { | ||
override fun <D : Operation.Data> intercept( | ||
request: ApolloRequest<D>, | ||
chain: ApolloInterceptorChain, | ||
): Flow<ApolloResponse<D>> { | ||
return this@asInterceptor.proceed(request) | ||
} | ||
} | ||
// Removing existing interceptors added for configuring an [ApolloStore]. | ||
// If a builder is reused from an existing client using `newBuilder()` and we try to configure a new `store()` on it, we first need to | ||
// remove the old interceptors. | ||
val storeInterceptors = interceptors.filterIsInstance<ApolloStoreInterceptor>() | ||
storeInterceptors.forEach { | ||
removeInterceptor(it) | ||
} | ||
internal class CacheInterceptor(val store: ApolloStore): ApolloInterceptor { | ||
private val delegates = listOf( | ||
WatcherInterceptor(store), | ||
FetchPolicyRouterInterceptor, | ||
ApolloCacheInterceptor(store) | ||
) | ||
|
||
override fun <D : Operation.Data> intercept( | ||
request: ApolloRequest<D>, | ||
chain: ApolloInterceptorChain, | ||
): Flow<ApolloResponse<D>> { | ||
return DefaultInterceptorChain(delegates + chain.asInterceptor(), 0).proceed(request) | ||
} | ||
return addInterceptor(WatcherInterceptor(store)) | ||
.addInterceptor(FetchPolicyRouterInterceptor) | ||
.addInterceptor(ApolloCacheInterceptor(store)) | ||
} | ||
|
||
|
||
fun ApolloClient.Builder.store(store: ApolloStore, writeToCacheAsynchronously: Boolean = false): ApolloClient.Builder { | ||
return cacheInterceptor(CacheInterceptor(store)) | ||
.writeToCacheAsynchronously(writeToCacheAsynchronously) | ||
.addExecutionContext(CacheDumpProviderContext(store.cacheDumpProvider())) | ||
} | ||
|
@@ -228,9 +256,7 @@ internal fun <D : Query.Data> ApolloCall<D>.watchInternal(data: D?): Flow<Apollo | |
|
||
val ApolloClient.apolloStore: ApolloStore | ||
get() { | ||
return interceptors.firstOrNull { it is ApolloCacheInterceptor }?.let { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this no longer works, and should be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I have made it public |
||
(it as ApolloCacheInterceptor).store | ||
} ?: error("no cache configured") | ||
return (cacheInterceptor as? CacheInterceptor ?: error("no cache configured")).store | ||
} | ||
|
||
/** | ||
|
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
This is not an issue anymore!
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.
Maybe the
ApolloStoreInterceptor
interface can also be deleted, then?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.
Good call! → #6612