-
Notifications
You must be signed in to change notification settings - Fork 730
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
Paginated Watchers for GraphQL Queries #3007
Closed
Closed
Changes from 12 commits
Commits
Show all changes
72 commits
Select commit
Hold shift + click to select a range
8b76cc7
Simple paginated watcher implementation
Iron-Ham 369f760
include tests
Iron-Ham 0ab2630
Get rid of an unnecessary completion block
Iron-Ham 5ec8f5d
Remove debugging code
Iron-Ham b530005
Manage pages
Iron-Ham 4cb2869
Rename fetchNext to fetchMore for consistency with React
Iron-Ham 933e086
Failing test
Iron-Ham 512a4c2
Succeeding test
Iron-Ham 9ae40df
Account for source for merging server vs cache update
Iron-Ham 79f7aac
Cleanup test file
Iron-Ham f15d774
Simplify transform
Iron-Ham 9e39373
Wrap with a model
Iron-Ham d793b56
Test for deletion of cache data
Iron-Ham d270a62
Cleanup Pagination + Tests
Iron-Ham d8921ac
Add support for fetching individual pages
Iron-Ham 2d0ca4f
Start transition towards merge strategies
Iron-Ham 74f21ff
Transition to strategies
Iron-Ham 9bdaab4
Make sure we only notify observers once
Iron-Ham a149d51
Spacing cleanup
Iron-Ham c15366d
More tests
Iron-Ham 9ba3544
Cleanup docs
Iron-Ham 26e9de8
Explicit self
Iron-Ham fbe5baa
Typo fix
Iron-Ham 506e444
Add initializer to PaginationDataResponse
Iron-Ham 5357668
Update comments
Iron-Ham 593fe8c
Update comments, again
Iron-Ham 5a5640e
Public values
Iron-Ham 0576f30
Add completion block to fetchMore
Iron-Ham e7f7675
Source should be included as part of the result handler
Iron-Ham d5515d2
Add a type erased GraphQLPaginatedQueryWatcher
Iron-Ham a47ce7d
AnyPaginationStrategy
Iron-Ham a525e59
Add protocol for paginated query watchers
Iron-Ham ba3bb4d
Check for cocoapods
Iron-Ham f8bf35c
Add comments
Iron-Ham 5f219d4
More docs
Iron-Ham aa8c94d
Deleted AnyGraphQLPaginatedQueryWatcher
Iron-Ham bfeee53
RelayPaginationStrategy
Iron-Ham 7f6575f
Pagination Merge strategies
Iron-Ham ee01b24
Start fixing tests
Iron-Ham 586e999
Refetch
Iron-Ham 067eebf
With keypaths
Iron-Ham b7cf1f6
Refetch
Iron-Ham d9921f2
Fetch + Local Cache Update
Iron-Ham d5a73c8
Custom Strategy tests
Iron-Ham b0baeb9
Simple multipage
Iron-Ham 0d08a4e
Targeted
Iron-Ham 850b109
All Green
Iron-Ham 4372bb3
Some docs
Iron-Ham cc61d00
More docs
Iron-Ham fdacf41
Merge branch 'main' into hs/paginated-watcher
Iron-Ham d7659d4
Update with main
Iron-Ham 82cb86c
More docs
Iron-Ham 975bce8
Spacing
Iron-Ham 587664c
Prefer private extension
Iron-Ham f3c7c91
Green again
Iron-Ham 92b17b6
Union of fragments
Iron-Ham c76914d
public _resultHandler
Iron-Ham 1492973
Make KeyPaths optional
Iron-Ham f773878
Allow the relay pagination strategy to use the protocol
Iron-Ham 284126b
Update resultHandler
Iron-Ham 7fa6f54
Rough draft of docs for pagination
Iron-Ham ff84911
Merge branch 'main' of github.com:Iron-Ham/apollo-ios into hs/paginat…
Iron-Ham badeddb
Update schema
Iron-Ham 014f1d5
Tests
Iron-Ham c8206ce
Cleanup
Iron-Ham c881000
Xcodeproj
Iron-Ham bf51e47
Docs
Iron-Ham 3554f38
Update website docs
Iron-Ham f97ba72
Fix test
Iron-Ham 4440a5c
empty commit
Iron-Ham 015b02d
empty commit2
Iron-Ham 8c13b61
Import Dispatch
Iron-Ham 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 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,157 @@ | ||
| #if !COCOAPODS | ||
| import ApolloAPI | ||
| #endif | ||
| import Foundation | ||
|
|
||
| public typealias Cursor = String | ||
|
|
||
| /// Handles pagination in the queue by managing multiple query watchers. | ||
| final class GraphQLPaginatedQueryWatcher<Query: GraphQLQuery, T>: Cancellable { | ||
|
|
||
| public struct Page { | ||
| let hasNextPage: Bool | ||
| let endCursor: Cursor? | ||
| } | ||
|
|
||
| public struct DataResponse { | ||
| let allResponses: [T] | ||
| let mostRecent: T | ||
| let source: GraphQLResult<Query.Data>.Source | ||
| } | ||
|
|
||
| /// Given a page, create a query of the type this watcher is responsible for | ||
| public typealias CreatePageQuery = (Page) -> Query? | ||
|
|
||
| private typealias ResultHandler = (Result<GraphQLResult<Query.Data>, Error>) -> Void | ||
|
|
||
| private let client: any ApolloClientProtocol | ||
|
|
||
| var initialWatcher: GraphQLQueryWatcher<Query>? | ||
| private var subsequentWatchers: [GraphQLQueryWatcher<Query>] = [] | ||
|
|
||
| private let createPageQuery: CreatePageQuery | ||
| private let nextPageTransform: (DataResponse) -> T | ||
|
|
||
| private var modelMap: [Cursor?: T] = [:] | ||
| private var cursorOrder: [Cursor?] = [] | ||
| private var resultHandler: ResultHandler? | ||
| private var callbackQueue: DispatchQueue | ||
| private var page: Page? | ||
|
|
||
| /// Designated initializer | ||
| /// | ||
| /// - Parameters: | ||
| /// - client: The client protocol to pass in | ||
| /// - inititalCachePolicy: The preferred cache policy for the initlal page. Defaults to `returnCacheDataAndFetch`. | ||
| /// - callbackQueue: The queue for response callbacks. | ||
| /// - query: The query to watch | ||
| /// - createPageQuery: A function which creates a new `Query` given some pagination information. | ||
| /// - transform: Transforms the `Query.Data` to the intended model and extracts the `Page` from the `Data`. | ||
| /// - nextPageTransform: A function which combines extant data with the new data from the next page | ||
| /// - onReceiveResults: The callback function which returns changes or an error. | ||
| public init( | ||
| client: ApolloClientProtocol, | ||
| inititalCachePolicy: CachePolicy = .returnCacheDataAndFetch, | ||
| callbackQueue: DispatchQueue = .main, | ||
| query: Query, | ||
| createPageQuery: @escaping CreatePageQuery, | ||
| transform: @escaping (Query.Data) -> (T?, Page?)?, | ||
Iron-Ham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| nextPageTransform: @escaping (DataResponse) -> T, | ||
| onReceiveResults: @escaping (Result<T, Error>) -> Void | ||
| ) { | ||
| self.callbackQueue = callbackQueue | ||
| self.client = client | ||
| self.createPageQuery = createPageQuery | ||
| self.nextPageTransform = nextPageTransform | ||
|
|
||
| let resultHandler: ResultHandler = { [weak self] result in | ||
| guard let self else { return } | ||
| switch result { | ||
| case .failure(let error): | ||
| guard !error.wasCancelled else { return } | ||
| // Forward all errors aside from network cancellation errors | ||
| onReceiveResults(.failure(error)) | ||
| case .success(let graphQLResult): | ||
| guard let data = graphQLResult.data, | ||
AnthonyMDev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let (transformedModel, page) = transform(data), | ||
| let transformedModel | ||
| else { return } | ||
| modelMap[page?.endCursor] = transformedModel | ||
| if !cursorOrder.contains(page?.endCursor) { | ||
| cursorOrder.append(page?.endCursor) | ||
| } | ||
| let model = nextPageTransform( | ||
| DataResponse( | ||
| allResponses: cursorOrder.compactMap { [weak self] cursor in | ||
| self?.modelMap[cursor] | ||
| }, | ||
| mostRecent: transformedModel, | ||
| source: graphQLResult.source | ||
| ) | ||
| ) | ||
| self.page = page | ||
| onReceiveResults(.success(model)) | ||
| } | ||
| } | ||
|
|
||
| self.resultHandler = resultHandler | ||
| initialWatcher = client.watch( | ||
| query: query, | ||
| cachePolicy: .returnCacheDataAndFetch, | ||
| callbackQueue: callbackQueue, | ||
| resultHandler: resultHandler | ||
| ) | ||
| } | ||
|
|
||
| public func fetch() { | ||
| modelMap.removeAll() | ||
| cursorOrder.removeAll() | ||
| initialWatcher?.refetch() | ||
| cancelSubsequentWatchers() | ||
| } | ||
|
|
||
| @discardableResult | ||
| public func fetchMore() -> Bool { | ||
| guard let page, | ||
| page.hasNextPage, | ||
| let nextPageQuery = createPageQuery(page), | ||
| let resultHandler | ||
| else { return false } | ||
|
|
||
| let nextPageWatcher = client.watch( | ||
| query: nextPageQuery, | ||
| cachePolicy: .fetchIgnoringCacheData, | ||
Iron-Ham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| resultHandler(result) | ||
| } | ||
| subsequentWatchers.append(nextPageWatcher) | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| public func cancel() { | ||
| initialWatcher?.cancel() | ||
| cancelSubsequentWatchers() | ||
| } | ||
|
|
||
| private func cancelSubsequentWatchers() { | ||
| subsequentWatchers.forEach { $0.cancel() } | ||
| subsequentWatchers.removeAll() | ||
| } | ||
|
|
||
| deinit { | ||
| cancel() | ||
| } | ||
| } | ||
|
|
||
| private extension Error { | ||
| var wasCancelled: Bool { | ||
| if let apolloError = self as? URLSessionClient.URLSessionClientError, | ||
| case let .networkError(data: _, response: _, underlying: underlying) = apolloError { | ||
| return underlying.wasCancelled | ||
| } | ||
|
|
||
| return (self as NSError).code == NSURLErrorCancelled | ||
| } | ||
| } | ||
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.
GraphQLQueryWatcherhas always held aweakreference to the client. I'm wondering if this should do the same. I don't imagine that this would create a retain cycle, as the retain cycle would be broken as soon as you callcancel().Any thoughts on this? @Iron-Ham @calvincestari @BobaFetters
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.
I think this sounds reasonable