feat: add startedBefore and startedAfter to run list (#763)

This PR adds new options to RunCollectionClient.list(): `startedBefore`
and `startedAfter`.

Note: this is the first time we use dates in query in the API (correct
me if I am wrong), so in case we'll add any dates to query params in
future they should use the same logic. Based on agreement with @barjin
we decided to allow users to pass dates in 2 formats: as Date object or
as a string.

Author: danpoletaev

src/http_client.ts

@@ -69,9 +69,12 @@ export class HttpClient {
             httpAgent: this.httpAgent,
             httpsAgent: this.httpsAgent,
             paramsSerializer: (params) => {
-                const formattedParams: [string, string][] = Object.entries<string>(params)
+                const formattedParams: [string, string][] = Object.entries<string | Date>(params)
                     .filter(([, value]) => value !== undefined)
                     .map(([key, value]) => {
+                        if (value instanceof Date) {
+                            return [key, value.toISOString()];
+                        }
                         const updatedValue = typeof value === 'boolean' ? Number(value) : value;
                         return [key, String(updatedValue)];
                     });

src/resource_clients/run_collection.ts

@@ -32,6 +32,8 @@ export class RunCollectionClient extends ResourceCollectionClient {
                     ow.string.oneOf(Object.values(ACTOR_JOB_STATUSES)),
                     ow.array.ofType(ow.string.oneOf(Object.values(ACTOR_JOB_STATUSES))),
                 ),
+                startedBefore: ow.optional.any(ow.optional.date, ow.optional.string),
+                startedAfter: ow.optional.any(ow.optional.date, ow.optional.string),
             }),
         );
 
@@ -46,4 +48,6 @@ export interface RunCollectionListOptions {
     status?:
         | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES]
         | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][];
+    startedBefore?: string;
+    startedAfter?: string;
 }

test/runs.test.js

@@ -70,6 +70,47 @@ describe('Run methods', () => {
             expect(browserRes).toEqual(res);
             validateRequest(expectedQuery);
         });
+
+        test('list() allows startedBefore and startedAfter to be passed as Date object', async () => {
+            const now = new Date();
+            const query = {
+                startedBefore: now,
+                startedAfter: now,
+            };
+
+            const expectedQuery = {
+                startedBefore: now.toISOString(),
+                startedAfter: now.toISOString(),
+            };
+
+            const res = await client.runs().list(query);
+            expect(res.id).toEqual('list-runs');
+            validateRequest(expectedQuery);
+
+            const browserRes = await page.evaluate((opts) => client.runs().list(opts), query);
+            expect(browserRes).toEqual(res);
+            validateRequest(expectedQuery);
+        });
+
+        test('list() allows startedBefore and startedAfter to be passed as string', async () => {
+            const now = new Date();
+            const query = {
+                startedBefore: now.toISOString(),
+                startedAfter: now.toISOString(),
+            };
+
+            const expectedQuery = {
+                ...query,
+            };
+
+            const res = await client.runs().list(query);
+            expect(res.id).toEqual('list-runs');
+            validateRequest(expectedQuery);
+
+            const browserRes = await page.evaluate((opts) => client.runs().list(opts), query);
+            expect(browserRes).toEqual(res);
+            validateRequest(expectedQuery);
+        });
     });
 
     describe('run()', () => {