chore: improve typing of endpoint asserts in tests

Author: barjin

src/utils.ts

@@ -21,6 +21,7 @@ const MIN_GZIP_BYTES = 1024;
  * @template R - The type of the data property
  */
 export interface MaybeData<R> {
+    [key: string]: any;
     data?: R;
 }
 

test/_helper.ts

@@ -78,7 +78,7 @@ export const validateRequest = ({
     additionalHeaders = {},
     path,
 }: {
-    query?: Request['query'];
+    query?: Dictionary<string | number | boolean | undefined | string[]>;
     params?: Request['params'];
     body?: Request['body'];
     additionalHeaders?: Request['headers'];
@@ -90,7 +90,7 @@ export const validateRequest = ({
     };
     const request = mockServer.getLastRequest();
     if (path) {
-        expect(request?.path).toEqual(path);
+        expect(`${request?.baseUrl}${request?.path}`).toEqual(path);
     }
 
     const expectedQuery = getExpectedQuery(query);

test/actors.test.ts

@@ -45,12 +45,11 @@ describe('Build methods', () => {
             };
 
             const res = await client.builds().list(query);
-            expect(res.id).toEqual('list-builds');
-            validateRequest(query);
+            validateRequest({ query: query, path: '/v2/actor-builds/' });
 
             const browserRes = await page.evaluate((opts) => client.builds().list(opts), query);
             expect(browserRes).toEqual(res);
-            validateRequest(query);
+            validateRequest({ query: query });
         });
     });
 
@@ -60,47 +59,46 @@ describe('Build methods', () => {
 
             const res = await client.build(buildId).get();
             expect(res?.id).toEqual('get-build');
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
 
             const browserRes = await page.evaluate((bId) => client.build(bId).get(), buildId);
             expect(browserRes).toEqual(res);
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
         });
 
         test('get() returns undefined on 404 status code (RECORD_NOT_FOUND)', async () => {
             const buildId = '404';
 
             const res = await client.build(buildId).get();
             expect(res).toBeUndefined();
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
 
             const browserRes = await page.evaluate((bId) => client.build(bId).get(), buildId);
             expect(browserRes).toEqual(res);
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
         });
 
         test('abort() works', async () => {
             const buildId = 'some-build-id';
 
             const res = await client.build(buildId).abort();
             expect(res.id).toEqual('abort-build');
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
 
             const browserRes = await page.evaluate((bId) => client.build(bId).abort(), buildId);
             expect(browserRes).toEqual(res);
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
         });
 
         test('getOpenApiDefinition() works', async () => {
             const buildId = 'some-build-id';
 
             const res = await client.build(buildId).getOpenApiDefinition();
-            expect(res.data.id).toEqual('build-openapi');
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId }, path: `/v2/actor-builds/${encodeURIComponent(buildId)}/openapi.json` });
 
             const browserRes = await page.evaluate((bId) => client.build(bId).getOpenApiDefinition(), buildId);
             expect(browserRes).toEqual(res);
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
         });
 
         test('waitForFinish() works', async () => {
@@ -112,27 +110,27 @@ describe('Build methods', () => {
             setTimeout(() => mockServer.setResponse({ body }), (waitSecs * 1000) / 2);
             const res = await client.build(buildId).waitForFinish({ waitSecs });
             expect(res).toEqual(data);
-            validateRequest({ waitForFinish: 0 }, { buildId });
+            validateRequest({ query: { waitForFinish: 0 }, params: { buildId } });
 
             const browserRes = await page.evaluate(
                 (bId, ws) => client.build(bId).waitForFinish({ waitSecs: ws }),
                 buildId,
                 waitSecs,
             );
             expect(browserRes).toEqual(res);
-            validateRequest({ waitForFinish: 0 }, { buildId });
+            validateRequest({ query: { waitForFinish: 0 }, params: { buildId } });
         });
 
         test('log().get() works', async () => {
             const buildId = 'some-build-id';
 
             const resource = await client.build(buildId).log().get();
             expect(resource).toEqual('build-log');
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
 
             const browserRes = await page.evaluate((id) => client.build(id).log().get(), buildId);
             expect(browserRes).toEqual('build-log');
-            validateRequest({}, { buildId });
+            validateRequest({ query: {}, params: { buildId } });
         });
     });
 });