feat: extend status parameter to an array of possible statuses (#723)

The `status` parameter in the Apify Core API has been extended on the
following endpoints:

- `/v2/acts/:actorId/runs`
- `/v2/actor-runs`
- `/v2/actor-tasks/:actorTaskId/runs`

It is now a comma-separated string of possible statuses.

This PR updates the js client accordingly by modifying the
`RunCollectionClient.list()` method to reflect the API change.
Corresponding tests have also been extended.

Author: JanHranicky

src/resource_clients/run_collection.ts

@@ -1,6 +1,6 @@
 import ow from 'ow';
 
-import { ACT_JOB_STATUSES } from '@apify/consts';
+import { ACTOR_JOB_STATUSES } from '@apify/consts';
 
 import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
@@ -28,7 +28,10 @@ export class RunCollectionClient extends ResourceCollectionClient {
                 limit: ow.optional.number,
                 offset: ow.optional.number,
                 desc: ow.optional.boolean,
-                status: ow.optional.string.oneOf(Object.values(ACT_JOB_STATUSES)),
+                status: ow.optional.any(
+                    ow.string.oneOf(Object.values(ACTOR_JOB_STATUSES)),
+                    ow.array.ofType(ow.string.oneOf(Object.values(ACTOR_JOB_STATUSES))),
+                ),
             }),
         );
 
@@ -40,5 +43,7 @@ export interface RunCollectionListOptions {
     limit?: number;
     offset?: number;
     desc?: boolean;
-    status?: (typeof ACT_JOB_STATUSES)[keyof typeof ACT_JOB_STATUSES];
+    status?:
+        | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES]
+        | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][];
 }

test/runs.test.js

@@ -32,11 +32,12 @@ describe('Run methods', () => {
     });
 
     describe('runs()', () => {
-        test('list() works', async () => {
+        test('list() works single status', async () => {
             const query = {
                 limit: 5,
                 offset: 3,
                 desc: true,
+                status: 'SUCCEEDED',
             };
 
             const res = await client.runs().list(query);
@@ -47,6 +48,28 @@ describe('Run methods', () => {
             expect(browserRes).toEqual(res);
             validateRequest(query);
         });
+
+        test('list() works multiple statuses', async () => {
+            const query = {
+                limit: 5,
+                offset: 3,
+                desc: true,
+                status: ['SUCCEEDED', 'FAILED'],
+            };
+
+            const expectedQuery = {
+                ...query,
+                status: 'SUCCEEDED,FAILED', // This is what should be sent to the API
+            };
+
+            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()', () => {