feat(bitbucket): add support for pagelen

lib/util/http/bitbucket.spec.ts

@@ -56,27 +56,90 @@ describe('util/http/bitbucket', () => {
     });
   });
 
-  it('paginates', async () => {
+  it('paginates: adds default pagelen if non is present', async () => {
     httpMock
       .scope(baseUrl)
-      .get('/some-url')
+      .get('/some-url?foo=bar&pagelen=100')
       .reply(200, {
         values: ['a'],
         page: '1',
-        next: `${baseUrl}/some-url?page=2`,
+        next: `${baseUrl}/some-url?foo=bar&pagelen=100&page=2`,
       })
-      .get('/some-url?page=2')
+      .get('/some-url?foo=bar&pagelen=100&page=2')
       .reply(200, {
         values: ['b', 'c'],
         page: '2',
-        next: `${baseUrl}/some-url?page=3`,
+        next: `${baseUrl}/some-url?foo=bar&pagelen=100&page=3`,
       })
-      .get('/some-url?page=3')
+      .get('/some-url?foo=bar&pagelen=100&page=3')
       .reply(200, {
         values: ['d'],
         page: '3',
       });
-    const res = await api.getJson('some-url', { paginate: true });
+    const res = await api.getJson('/some-url?foo=bar', { paginate: true });
+    expect(res.body).toEqual({
+      page: '1',
+      pagelen: 4,
+      size: 4,
+      values: ['a', 'b', 'c', 'd'],
+      next: undefined,
+    });
+  });
+
+  it('paginates: respects pagelen if already set in path', async () => {
+    httpMock
+      .scope(baseUrl)
+      .get('/some-url?pagelen=10')
+      .reply(200, {
+        values: ['a'],
+        page: '1',
+        next: `${baseUrl}/some-url?pagelen=10&page=2`,
+      })
+      .get('/some-url?pagelen=10&page=2')
+      .reply(200, {
+        values: ['b', 'c'],
+        page: '2',
+        next: `${baseUrl}/some-url?pagelen=10&page=3`,
+      })
+      .get('/some-url?pagelen=10&page=3')
+      .reply(200, {
+        values: ['d'],
+        page: '3',
+      });
+    const res = await api.getJson('some-url?pagelen=10', { paginate: true });
+    expect(res.body).toEqual({
+      page: '1',
+      pagelen: 4,
+      size: 4,
+      values: ['a', 'b', 'c', 'd'],
+      next: undefined,
+    });
+  });
+
+  it('paginates: respects pagelen if set in options', async () => {
+    httpMock
+      .scope(baseUrl)
+      .get('/some-url?pagelen=20')
+      .reply(200, {
+        values: ['a'],
+        page: '1',
+        next: `${baseUrl}/some-url?pagelen=20&page=2`,
+      })
+      .get('/some-url?pagelen=20&page=2')
+      .reply(200, {
+        values: ['b', 'c'],
+        page: '2',
+        next: `${baseUrl}/some-url?pagelen=20&page=3`,
+      })
+      .get('/some-url?pagelen=20&page=3')
+      .reply(200, {
+        values: ['d'],
+        page: '3',
+      });
+    const res = await api.getJson('some-url', {
+      paginate: true,
+      pagelen: 20,
+    });
     expect(res.body).toEqual({
       page: '1',
       pagelen: 4,

lib/util/http/bitbucket.ts

@@ -4,6 +4,8 @@
 import type { HttpOptions, HttpResponse } from './types';
 import { Http } from '.';
 
+const MAX_PAGELEN = 100;
+
 let baseUrl = 'https://api.bitbucket.org/';
 
 export const setBaseUrl = (url: string): void => {
@@ -12,6 +14,7 @@
 
 export interface BitbucketHttpOptions extends HttpOptions {
   paginate?: boolean;
+  pagelen?: number;
 }
 
 export class BitbucketHttp extends Http<BitbucketHttpOptions> {
@@ -25,29 +28,29 @@
   ): Promise<HttpResponse<T>> {
     const opts = { baseUrl, ...options };
 
-    const result = await super.request<T>(path, opts);
+    let pathWithPagelen = path;
 
-    if (opts.paginate && isPagedResult(result.body)) {
-      const resultBody = result.body as PagedResult<T>;
+    if (opts.paginate && !hasPagelen(pathWithPagelen)) {
+      const pagelen = opts.pagelen ?? MAX_PAGELEN;
+      pathWithPagelen = addPagelenToPath(pathWithPagelen, pagelen);
+    }
 
-      let nextPage = getPageFromURL(resultBody.next);
+    const result = await super.request<T>(pathWithPagelen, opts);
 
-      while (is.nonEmptyString(nextPage)) {
-        const nextPath = getNextPagePath(path, nextPage);
+    if (opts.paginate && isPagedResult(result.body)) {
+      const resultBody = result.body as PagedResult<T>;
 
-        // istanbul ignore if
-        if (is.nullOrUndefined(nextPath)) {
-          break;
-        }
+      let nextURL = resultBody.next;
 
+      while (is.nonEmptyString(nextURL)) {
         const nextResult = await super.request<PagedResult<T>>(
-          nextPath,
+          nextURL,
           options
         );
 
         resultBody.values.push(...nextResult.body.values);
 
-        nextPage = getPageFromURL(nextResult.body?.next);
+        nextURL = nextResult.body?.next;
       }
 
       // Override other page-related attributes
@@ -60,25 +63,25 @@
   }
 }
 
-function getPageFromURL(url: string | undefined): string | null {
-  const resolvedURL = parseUrl(url);
+function hasPagelen(path: string): boolean {
+  const resolvedURL = parseUrl(resolveBaseUrl(baseUrl, path));
 
   if (is.nullOrUndefined(resolvedURL)) {
-    return null;
+    return false;
   }
 
-  return resolvedURL.searchParams.get('page');
+  return !is.nullOrUndefined(resolvedURL.searchParams.get('pagelen'));
 }
 
-function getNextPagePath(path: string, nextPage: string): string | null {
+function addPagelenToPath(path: string, pagenlen: number): string {
   const resolvedURL = parseUrl(resolveBaseUrl(baseUrl, path));
 
   // istanbul ignore if
   if (is.nullOrUndefined(resolvedURL)) {
-    return null;
+    return path;
   }
 
-  resolvedURL.searchParams.set('page', nextPage);
+  resolvedURL.searchParams.set('pagelen', pagenlen.toString());
 
   return resolvedURL.toString();
 }