Auto pagination #596
Merged
Auto pagination #596
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #596 +/- ##
==========================================
+ Coverage 86.83% 88.26% +1.43%
==========================================
Files 6 7 +1
Lines 281 409 +128
Branches 44 70 +26
==========================================
+ Hits 244 361 +117
- Misses 26 31 +5
- Partials 11 17 +6
Continue to review full report at Codecov.
|
9 tasks
shaydewael
approved these changes
Aug 3, 2018
| "url-join": "^4.0.0", | ||
| "ws": "^5.2.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@aoberoi/capture-console": "^1.0.0", |
src/logger.ts
Outdated
| @@ -79,7 +81,13 @@ log.methodFactory = function ( | |||
| * INTERNAL interface for getting or creating a named Logger | |||
| */ | |||
| // TODO: implement logger name prefixing (example plugins available on the loglevel package's site) | |||
| export const getLogger = log.getLogger as (name: string) => Logger; | |||
| // export const getLogger = log.getLogger as (name: string) => Logger; | |||
| export async function awaitAndReduce<T, U>(iterable: AsyncIterable<T>, | ||
| callbackfn: (previousValue: U, currentValue: T) => U, | ||
| initialValue: U): Promise<U> { | ||
| // TODO: make initialValue optional (overloads or conditional types?) |
There was a problem hiding this comment.
meh, i think i'll leave that comment in there.
right now we don't need a version of this function that doesn't take an initialValue because i'm manually passing {} as WebAPICallResult into it. but, since this lives in util.ts, it would be more reusable if it didn't need an initial value, the way that Array.prototype.reduce also doesn't require an initial value.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The platform is expanding the set of methods which support the shiniest of our pagination specifications, cursor-based pagination!
This change allows apps who previously made API calls to methods (that support cursor pagination) without any explicit pagination arguments to transparently traverse pages. This solves two major problems:
limitvalues) in situations where the client didn't provide pagination arguments. This would create a subtle bug, but now these apps should get the entire list.This change also helps apps prepare for a future where pagination becomes mandatory in certain situations.
Fixes #343
Please review and provide feedback
At this point, my biggest concern is that this is a lot of new code, for what amounts to functionality we still strongly recommend developers do not use. More specifically, we still want developers to paginate requests themselves, and not to depend on the automatic pagination. Our reason is that this will result in more performant and optimized code. So, planting all this code is very intentionally a band-aid. My proposal for how we'd address this concern is to merge this now, and in the next major version to remove automatic pagination; moving that code into an add-on that can be used in conjunction with the baseline package. That add-on would be a shim that's only for backwards compatibility, but not encouraged.
Another concern is now the
cursorPaginationEnabledMethodsinmethods.tsvalue is starting to store metadata about API responses, but outside of the holistic design we're hoping to arrive in #496 and #509.TODO
Add configuration for rate-limit retires (simple boolean) make webclient rate-limit retries configurable #451This can be done in a separate, follow-up PR, which will make it easier to review.Requirements (place an
xin each[ ])