feat: support more than one digit of pagination metadata in listUsers()
#793
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
makeusabrew
commented
Oct 11, 2023
| links.forEach((link: string) => { | ||
| const page = parseInt(link.split(';')[0].split('=')[1].substring(0, 1)) |
There was a problem hiding this comment.
The .substring(0, 1) here is the cause of the truncation
hf
changed the title
listUsers()listUsers()
hf
previously approved these changes
Oct 25, 2023
hf
reviewed
Oct 25, 2023
| @@ -194,10 +194,14 @@ export default class GoTrueAdminApi { | |||
| const total = response.headers.get('x-total-count') ?? 0 | |||
| const links = response.headers.get('link')?.split(',') ?? [] | |||
| if (links.length > 0) { | |||
| const regex = /page=(\d+)(?=&)[^>]*>; rel="(\w+)"/ | |||
There was a problem hiding this comment.
Actually would you mind pulling this regex up to the top scope, so that a new object is not being created every time the function is called?
Also, is it possible to not use a regex here at all? Maybe use URLSearchParams instead?
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.
What kind of change does this PR introduce?
Fixes an issue where the pagination metadata returned from
listUsers()was inaccurate for page values>= 10.What is the current behavior?
The current behaviour assumes the
pagevalue contained in the link string (each element of which looks a bit like this:</admin/users?page=7&per_page=10>; rel="last") is always a single digit, leading to truncated values fornextPageandlastPagebeing returned if either are 10 or more. For example, ifnextPageis10, the current behaviour truncates this to1. If the client is relying on the value ofnextPage, this could cause it to paginate up to page 9 correctly but then reset to page 1 rather than move on to page 10.What is the new behavior?
The new behaviour correctly parses multi-digit values for
nextPageandlastPage.Additional context
I couldn't get the test suite running but didn't see any tests relating to this so I don't think any tests will break. I patched the proposed changes into the project I have which was being tripped up by this behaviour and they appear to work as expected. Feel free to refactor - wasn't sure if changing the various
split()calls to a regex was a no-no.Thanks!