Make it possible to set response sequence per each test if needed

Pijukatel · Pijukatel · commit 51dd246f4aca · 2025-10-29T16:18:39.000+01:00
diff --git a/src/resource_clients/actor.ts b/src/resource_clients/actor.ts
@@ -156,10 +156,13 @@ export class ActorClient extends ResourceClient {
 
         const streamedLog = await newRunClient.getStreamedLog({ toLog: options?.log });
         let streamingPromise: Promise<void> | undefined;
+        let actorRun: Promise<ActorRun> | undefined;
         try {
             streamingPromise = streamedLog?.start();
-            return this.apifyClient.run(id).waitForFinish({ waitSecs });
+            actorRun = this.apifyClient.run(id).waitForFinish({ waitSecs });
+            return actorRun;
         } finally {
+            await actorRun;
             await streamedLog?.stop();
             await streamingPromise;
         }
diff --git a/test/_helper.js b/test/_helper.js
@@ -1,6 +1,6 @@
 const { launchPuppeteer, puppeteerUtils } = require('@crawlee/puppeteer');
 
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 class Browser {
     async start() {
diff --git a/test/actors.test.js b/test/actors.test.js
@@ -1,10 +1,11 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ActorListSortBy, ApifyClient, LoggerActorRedirect } = require('apify-client');
 const { stringifyWebhooksToBase64 } = require('../src/utils');
-const mockServer = require('./mock_server/server');
+const { mockServer, createDefaultApp } = require('./mock_server/server');
 const c = require('ansi-colors');
-const { MOCKED_ACTOR_LOGS_PROCESSED, statusGenerator } = require('./mock_server/consts');
+const { MOCKED_ACTOR_LOGS_PROCESSED, StatusGenerator } = require('./mock_server/consts');
 const { Log, LEVELS } = require('@apify/log');
+const express = require('express');
 
 describe('Actor methods', () => {
     let baseUrl;
@@ -676,24 +677,40 @@ describe('Actor methods', () => {
 
 describe('Run actor with redirected logs', () => {
     let baseUrl;
+    let client;
+    const statusGenerator = new StatusGenerator();
 
     beforeAll(async () => {
-        // Ensure that the tests that use characters like á are correctly decoded in console.
-        process.stdout.setDefaultEncoding('utf8');
-        const server = await mockServer.start();
+        // Use custom router for the tests
+        const router = express.Router();
+        // Set up a status generator to simulate run status changes. It will be reset for each test.
+        router.get('/actor-runs/redirect-run-id', async (req, res) => {
+            // Delay the response to give the actor time to run and produce expected logs
+            await new Promise((resolve) => {
+                setTimeout(resolve, 10);
+            });
+            const [status, statusMessage] = statusGenerator.next().value;
+            res.json({ data: { id: 'redirect-run-id', actId: 'redirect-actor-id', status, statusMessage } });
+        });
+        const app = createDefaultApp(router);
+        const server = await mockServer.start(undefined, app);
         baseUrl = `http://localhost:${server.address().port}`;
     });
 
-    let client;
+    afterAll(async () => {
+        await Promise.all([mockServer.close()]);
+    });
+
     beforeEach(async () => {
-        statusGenerator.reset();
         client = new ApifyClient({
             baseUrl,
             maxRetries: 0,
             ...DEFAULT_OPTIONS,
         });
     });
     afterEach(async () => {
+        // Reset the generator to so that the next test starts fresh
+        statusGenerator.reset();
         client = null;
     });
 
diff --git a/test/apify_api_error.test.js b/test/apify_api_error.test.js
@@ -1,5 +1,5 @@
 const { Browser, DEFAULT_OPTIONS } = require('./_helper');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 const { ApifyClient } = require('apify-client');
 
 describe('ApifyApiError', () => {
diff --git a/test/builds.test.js b/test/builds.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Build methods', () => {
     let baseUrl;
diff --git a/test/datasets.test.js b/test/datasets.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Dataset methods', () => {
     let baseUrl;
diff --git a/test/http_client.test.js b/test/http_client.test.js
@@ -1,5 +1,5 @@
 const { Browser } = require('./_helper');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 const { ApifyClient } = require('apify-client');
 
 describe('HttpClient', () => {
diff --git a/test/key_value_stores.test.js b/test/key_value_stores.test.js
@@ -2,7 +2,7 @@ const { Readable } = require('node:stream');
 
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Key-Value Store methods', () => {
     let baseUrl;
diff --git a/test/logs.test.js b/test/logs.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Log methods', () => {
     let baseUrl;
diff --git a/test/mock_server/consts.js b/test/mock_server/consts.js
@@ -55,24 +55,21 @@ class StatusGenerator {
     }
 
     reset() {
-        this.generator = (() => {
-            // Iterate over MOCKED_ACTOR_STATUSES and keep returning the last status when exhausted
-            let i = 0;
-            return () => {
-                if (i >= MOCKED_ACTOR_STATUSES.length) {
-                    return MOCKED_ACTOR_STATUSES[MOCKED_ACTOR_STATUSES.length - 1];
-                }
-                return MOCKED_ACTOR_STATUSES[i++];
-            };
-        })();
+        function* getStatusGenerator() {
+            for (const status of MOCKED_ACTOR_STATUSES) {
+                yield status;
+            }
+            // After exhausting, keep yielding the last status
+            while (true) {
+                yield MOCKED_ACTOR_STATUSES[MOCKED_ACTOR_STATUSES.length - 1];
+            }
+        }
+        this.generator = getStatusGenerator();
     }
 
     next() {
-        return this.generator();
+        return this.generator.next();
     }
 }
 
-// Test can call statusGenerator.reset() to receive the statuses from the start
-const statusGenerator = new StatusGenerator();
-
-module.exports = { MOCKED_ACTOR_LOGS, MOCKED_ACTOR_LOGS_PROCESSED, MOCKED_ACTOR_STATUSES, statusGenerator };
+module.exports = { MOCKED_ACTOR_LOGS, MOCKED_ACTOR_LOGS_PROCESSED, MOCKED_ACTOR_STATUSES, StatusGenerator };
diff --git a/test/mock_server/server.js b/test/mock_server/server.js
@@ -22,14 +22,15 @@ const webhookDispatches = require('./routes/webhook_dispatches');
 const webhooks = require('./routes/webhooks');
 
 // Consts
-const { MOCKED_ACTOR_LOGS, statusGenerator } = require('./consts');
+const { MOCKED_ACTOR_LOGS } = require('./consts');
+
+const defaultApp = createDefaultApp();
 
-const app = express();
-const v2Router = express.Router();
 const mockServer = {
     requests: [],
     response: null,
-    async start(port = 0) {
+    async start(port = 0, app = defaultApp) {
+        app.set('mockServer', this);
         this.server = http.createServer(app);
         return new Promise((resolve, reject) => {
             this.server.on('error', reject);
@@ -58,76 +59,77 @@ const mockServer = {
     },
 };
 
-async function streamLogChunks(req, res) {
-    // Asynchronously write each chunk to the response stream
-    for (const chunk of MOCKED_ACTOR_LOGS) {
-        res.write(chunk);
-        res.flush(); // Flush the buffer and send the chunk immediately
-        // Wait for a short period to simulate work being done on the server
-        await new Promise((resolve) => {
-            setTimeout(resolve, 10);
-        });
-    }
+function createDefaultApp(v2Router = express.Router()) {
+    async function streamLogChunks(req, res) {
+        // Asynchronously write each chunk to the response stream
+        for (const chunk of MOCKED_ACTOR_LOGS) {
+            res.write(chunk);
+            res.flush(); // Flush the buffer and send the chunk immediately
+            // Wait for a short period to simulate work being done on the server
+            await new Promise((resolve) => {
+                setTimeout(resolve, 1);
+            });
+        }
 
-    // End the response stream once all chunks have been sent
-    res.end();
-}
-
-// Debugging middleware
-app.use((req, res, next) => {
-    next();
-});
-app.use(express.text());
-app.use(express.json({ limit: '9mb' }));
-app.use(express.urlencoded({ extended: false }));
-app.use(bodyParser.raw());
-app.use(express.static(path.join(__dirname, 'public')));
-app.use(compression());
+        // End the response stream once all chunks have been sent
+        res.end();
+    }
+    const app = express();
+    // Debugging middleware
+    app.use((req, res, next) => {
+        next();
+    });
+    app.use(express.text());
+    app.use(express.json({ limit: '9mb' }));
+    app.use(express.urlencoded({ extended: false }));
+    app.use(bodyParser.raw());
+    app.use(express.static(path.join(__dirname, 'public')));
+    app.use(compression());
+    app.use('/', (req, res, next) => {
+        mockServer.requests.push(req);
+        next();
+    });
+    app.use('/v2', v2Router);
+    app.use('/external', external);
 
-app.use('/', (req, res, next) => {
-    mockServer.requests.push(req);
-    next();
-});
-app.set('mockServer', mockServer);
-app.use('/v2', v2Router);
-app.use('/external', external);
+    // Attaching V2 routers
+    v2Router.use('/acts/redirect-actor-id', async (req, res) => {
+        res.json({ data: { name: 'redirect-actor-name', id: 'redirect-run-id' } });
+    });
+    v2Router.use('/acts', actorRouter);
+    v2Router.use('/actor-builds', buildRouter);
+    v2Router.use('/actor-runs/redirect-run-id/log', streamLogChunks);
+    v2Router.use('/actor-runs/redirect-run-id', async (req, res) => {
+        res.json({ data: { id: 'redirect-run-id', actId: 'redirect-actor-id', status: 'SUCCEEDED' } });
+    });
 
-// Attaching V2 routers
-v2Router.use('/acts/redirect-actor-id', async (req, res) => {
-    res.json({ data: { name: 'redirect-actor-name', id: 'redirect-run-id' } });
-});
-v2Router.use('/acts', actorRouter);
-v2Router.use('/actor-builds', buildRouter);
-v2Router.use('/actor-runs/redirect-run-id/log', streamLogChunks);
-v2Router.use('/actor-runs/redirect-run-id', async (req, res) => {
-    const [status, statusMessage] = statusGenerator.next();
-    res.json({ data: { id: 'redirect-run-id', actId: 'redirect-actor-id', status, statusMessage } });
-});
-v2Router.use('/actor-runs', runRouter);
-v2Router.use('/actor-tasks', taskRouter);
-v2Router.use('/users', userRouter);
-v2Router.use('/logs/redirect-log-id', streamLogChunks);
-v2Router.use('/logs', logRouter);
-v2Router.use('/datasets', datasetRouter);
-v2Router.use('/key-value-stores', keyValueStores);
-v2Router.use('/request-queues', requestQueues);
-v2Router.use('/webhooks', webhooks);
-v2Router.use('/schedules', schedules);
-v2Router.use('/webhook-dispatches', webhookDispatches);
-v2Router.use('/store', store);
+    v2Router.use('/actor-runs', runRouter);
+    v2Router.use('/actor-tasks', taskRouter);
+    v2Router.use('/users', userRouter);
+    v2Router.use('/logs/redirect-log-id', streamLogChunks);
+    v2Router.use('/logs', logRouter);
+    v2Router.use('/datasets', datasetRouter);
+    v2Router.use('/key-value-stores', keyValueStores);
+    v2Router.use('/request-queues', requestQueues);
+    v2Router.use('/webhooks', webhooks);
+    v2Router.use('/schedules', schedules);
+    v2Router.use('/webhook-dispatches', webhookDispatches);
+    v2Router.use('/store', store);
 
-// Debugging middleware
-app.use((err, req, res, _next) => {
-    res.status(500).json({ error: { message: err.message } });
-});
+    // Debugging middleware
+    app.use((err, req, res, _next) => {
+        res.status(500).json({ error: { message: err.message } });
+    });
 
-app.use((req, res) => {
-    res.status(404).json({
-        error: {
-            type: 'page-not-found',
-            message: 'Nothing to do here.',
-        },
+    app.use((req, res) => {
+        res.status(404).json({
+            error: {
+                type: 'page-not-found',
+                message: 'Nothing to do here.',
+            },
+        });
     });
-});
+    return app;
+}
 
-module.exports = mockServer;
+module.exports = { mockServer, createDefaultApp };
diff --git a/test/request_queues.test.js b/test/request_queues.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Request Queue methods', () => {
     let baseUrl;
diff --git a/test/runs.test.js b/test/runs.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient, LoggerActorRedirect } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 const c = require('ansi-colors');
 const { MOCKED_ACTOR_LOGS_PROCESSED } = require('./mock_server/consts');
 
@@ -419,7 +419,7 @@ describe('Redirect run logs', () => {
             streamedLog.start();
             // Wait some time to accumulate logs
             await new Promise((resolve) => {
-                setTimeout(resolve, 10);
+                setTimeout(resolve, 1000);
             });
             await streamedLog.stop();
 
@@ -440,7 +440,7 @@ describe('Redirect run logs', () => {
             streamedLog.start();
             // Wait some time to accumulate logs
             await new Promise((resolve) => {
-                setTimeout(resolve, 10);
+                setTimeout(resolve, 1000);
             });
             await streamedLog.stop();
 
diff --git a/test/schedules.test.js b/test/schedules.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('Schedule methods', () => {
     let baseUrl;
diff --git a/test/store.test.ts b/test/store.test.ts
@@ -2,7 +2,7 @@ import type { StoreCollectionListOptions } from 'apify-client';
 import { ApifyClient } from 'apify-client';
 
 import { Browser, DEFAULT_OPTIONS, validateRequest } from './_helper';
-import mockServer from './mock_server/server';
+import { mockServer } from './mock_server/server';
 
 describe('Store', () => {
     let baseUrl: string | undefined;
diff --git a/test/tasks.test.js b/test/tasks.test.js
@@ -1,6 +1,6 @@
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 const { stringifyWebhooksToBase64 } = require('../src/utils');
 
 describe('Task methods', () => {
diff --git a/test/users.test.js b/test/users.test.js
@@ -2,7 +2,7 @@ const { ME_USER_NAME_PLACEHOLDER } = require('@apify/consts');
 
 const { Browser, validateRequest, DEFAULT_OPTIONS } = require('./_helper');
 const { ApifyClient } = require('apify-client');
-const mockServer = require('./mock_server/server');
+const { mockServer } = require('./mock_server/server');
 
 describe('User methods', () => {
     let baseUrl;
diff --git a/test/webhook_dispatches.test.js b/test/webhook_dispatches.test.js
diff --git a/test/webhooks.test.js b/test/webhooks.test.js
