fix(backend): Request paginated responses from BAPI (#3276)

ref: #3271

Co-authored-by: panteliselef <[email protected]>

.changeset/clever-buckets-exist.md

@@ -0,0 +1,11 @@
+---
+'@clerk/backend': patch
+---
+
+Fix the following `@clerk/backend` methods to populate their paginated responses:
+- `clerkClient.allowListIndentifiers.getAllowlistIdentifierList()`
+- `clerkClient.clients.getClientList()`
+- `clerkClient.invitations.getInvitationList`
+- `clerkClient.redirectUrls.getRedirectUrlList()`
+- `clerkClient.sessions.getSessionList()`
+- `clerkClient.users.getUserOauthAccessToken()`

packages/backend/src/api/__tests__/factory.test.ts

@@ -214,37 +214,43 @@ export default (QUnit: QUnit) => {
  });
 
  test('successfully retrieves user access tokens from backend API for a specific provider', async assert => {
- const fakeResponse = [
- {
- external_account_id: 'eac_2dYS7stz9bgxQsSRvNqEAHhuxvW',
- object: 'oauth_access_token',
- token: '<token>',
- provider: 'oauth_google',
- public_metadata: {},
- label: null,
- scopes: ['email', 'profile'],
- },
- ];
+ const fakeResponse = {
+ data: [
+ {
+ external_account_id: 'eac_2dYS7stz9bgxQsSRvNqEAHhuxvW',
+ object: 'oauth_access_token',
+ token: '<token>',
+ provider: 'oauth_google',
+ public_metadata: {},
+ label: null,
+ scopes: ['email', 'profile'],
+ },
+ ],
+ total_count: 1,
+ };
 
  fakeFetch = sinon.stub(runtime, 'fetch');
  fakeFetch.onCall(0).returns(jsonOk(fakeResponse));
 
  const response = await apiClient.users.getUserOauthAccessToken('user_deadbeef', 'oauth_google');
 
- assert.equal(response[0].externalAccountId, 'eac_2dYS7stz9bgxQsSRvNqEAHhuxvW');
- assert.equal(response[0].provider, 'oauth_google');
- assert.equal(response[0].token, '<token>');
- assert.deepEqual(response[0].scopes, ['email', 'profile']);
+ assert.equal(response.data[0].externalAccountId, 'eac_2dYS7stz9bgxQsSRvNqEAHhuxvW');
+ assert.equal(response.data[0].provider, 'oauth_google');
+ assert.equal(response.data[0].token, '<token>');
+ assert.deepEqual(response.data[0].scopes, ['email', 'profile']);
 
  assert.ok(
- fakeFetch.calledOnceWith('https://api.clerk.test/v1/users/user_deadbeef/oauth_access_tokens/oauth_google', {
- method: 'GET',
- headers: {
- Authorization: 'Bearer deadbeef',
- 'Content-Type': 'application/json',
- 'User-Agent': '@clerk/[email protected]',
+ fakeFetch.calledOnceWith(
+ 'https://api.clerk.test/v1/users/user_deadbeef/oauth_access_tokens/oauth_google?paginated=true',
+ {
+ method: 'GET',
+ headers: {
+ Authorization: 'Bearer deadbeef',
+ 'Content-Type': 'application/json',
+ 'User-Agent': '@clerk/[email protected]',
+ },
  },
- }),
+ ),
  );
  });
  });

packages/backend/src/api/endpoints/AllowlistIdentifierApi.ts

@@ -15,6 +15,7 @@ export class AllowlistIdentifierAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<AllowlistIdentifier[]>>({
  method: 'GET',
  path: basePath,
+ queryParams: { paginated: true },
  });
  }
 

packages/backend/src/api/endpoints/ClientApi.ts

@@ -12,7 +12,7 @@ export class ClientAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<Client[]>>({
  method: 'GET',
  path: basePath,
- queryParams: params,
+ queryParams: { ...params, paginated: true },
  });
  }
 

packages/backend/src/api/endpoints/InvitationApi.ts

@@ -35,7 +35,7 @@ export class InvitationAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<Invitation[]>>({
  method: 'GET',
  path: basePath,
- queryParams: params,
+ queryParams: { ...params, paginated: true },
  });
  }
 

packages/backend/src/api/endpoints/RedirectUrlApi.ts

@@ -14,6 +14,7 @@ export class RedirectUrlAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<RedirectUrl[]>>({
  method: 'GET',
  path: basePath,
+ queryParams: { paginated: true },
  });
  }
 

packages/backend/src/api/endpoints/SessionApi.ts

@@ -19,7 +19,7 @@ export class SessionAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<Session[]>>({
  method: 'GET',
  path: basePath,
- queryParams: params,
+ queryParams: { ...params, paginated: true },
  });
  }
 

packages/backend/src/api/endpoints/UserApi.ts

@@ -197,6 +197,7 @@ export class UserAPI extends AbstractAPI {
  return this.request<PaginatedResourceResponse<OauthAccessToken[]>>({
  method: 'GET',
  path: joinPaths(basePath, userId, 'oauth_access_tokens', provider),
+ queryParams: { paginated: true },
  });
  }