feat: Use .reboot() instead of .metamorph() for reboot (#227)

Author: jirimoravcik

package-lock.json

@@ -62,10 +62,10 @@
         "@crawlee/core": "^3.5.3",
         "@crawlee/types": "^3.5.3",
         "@crawlee/utils": "^3.5.3",
-        "apify-client": "^2.7.1",
+        "apify-client": "^2.8.0",
         "ow": "^0.28.2",
         "semver": "^7.5.4",
         "tslib": "^2.6.0",
         "ws": "^7.5.9"
     }
-}
+}

packages/apify/package.json

@@ -441,22 +441,26 @@ export class Actor<Data extends Dictionary = Dictionary> {
      *
      * @ignore
      */
-    async reboot(): Promise<void> {
+    async reboot(options: RebootOptions = {}): Promise<void> {
         if (!this.isAtHome()) {
             log.warning('Actor.reboot() is only supported when running on the Apify platform.');
             return;
         }
 
-        // Waiting for all the listeners to finish, as `.metamorph()` kills the container.
+        // Waiting for all the listeners to finish, as `.reboot()` kills the container.
         await Promise.all([
             // `persistState` for individual RequestLists, RequestQueue... instances to be persisted
             ...this.config.getEventManager().listeners(EventType.PERSIST_STATE).map((x) => x()),
             // `migrating` to pause Apify crawlers
             ...this.config.getEventManager().listeners(EventType.MIGRATING).map((x) => x()),
         ]);
 
-        const actorId = this.config.get('actorId')!;
-        await this.metamorph(actorId);
+        const runId = this.config.get('actorRunId')!;
+        await this.apifyClient.run(runId).reboot();
+
+        // Wait some time for container to be stopped.
+        const { customAfterSleepMillis = this.config.get('metamorphAfterSleepMillis') } = options;
+        await sleep(customAfterSleepMillis);
     }
 
     /**
@@ -1177,8 +1181,8 @@ export class Actor<Data extends Dictionary = Dictionary> {
      * Internally reboots this actor run. The system stops the current container and starts
      * a new container with the same run id.
      */
-    static async reboot(): Promise<void> {
-        return Actor.getDefaultInstance().reboot();
+    static async reboot(options: RebootOptions = {}): Promise<void> {
+        return Actor.getDefaultInstance().reboot(options);
     }
 
     /**
@@ -1652,6 +1656,11 @@ export interface MetamorphOptions {
     customAfterSleepMillis?: number;
 }
 
+export interface RebootOptions {
+    /** @internal */
+    customAfterSleepMillis?: number;
+}
+
 export interface ExitOptions {
     /** Exit with given status message */
     statusMessage?: string;

packages/apify/src/actor.ts

@@ -830,6 +830,7 @@ describe('Actor', () => {
 
     describe('Actor.reboot()', () => {
         const { actId, runId } = globalOptions;
+        const { run } = runConfigs;
 
         beforeEach(() => {
             process.env[APIFY_ENV_VARS.IS_AT_HOME] = '1';
@@ -844,19 +845,11 @@ describe('Actor', () => {
             jest.restoreAllMocks();
         });
 
-        test('metamorphs to the same actor', async () => {
-            const metamorphSpy = jest.spyOn(Actor.prototype, 'metamorph');
-            metamorphSpy.mockResolvedValueOnce();
-
-            await Actor.reboot();
-
-            expect(metamorphSpy).toBeCalledTimes(1);
-            expect(metamorphSpy).toBeCalledWith(actId);
-        });
-
-        test('reboot waits for persistState/migrating listeners before morphing', async () => {
-            const metamorphSpy = jest.spyOn(Actor.prototype, 'metamorph');
-            metamorphSpy.mockResolvedValueOnce();
+        test('reboot waits for persistState/migrating listeners before rebooting', async () => {
+            const rebootMock = jest.fn();
+            rebootMock.mockResolvedValueOnce(run);
+            const rebootSpy = jest.spyOn(ApifyClient.prototype, 'run');
+            rebootSpy.mockReturnValueOnce({ reboot: rebootMock } as any);
 
             const persistenceStore = [];
 
@@ -872,7 +865,7 @@ describe('Actor', () => {
             events.on(EventType.PERSIST_STATE, persistStateSpy);
             events.on(EventType.MIGRATING, migratingSpy);
 
-            await Actor.reboot();
+            await Actor.reboot({ customAfterSleepMillis: 1 });
 
             events.off(EventType.PERSIST_STATE, persistStateSpy);
             events.off(EventType.MIGRATING, migratingSpy);
@@ -883,6 +876,9 @@ describe('Actor', () => {
 
             // Do the listeners finish?
             expect(persistenceStore.length).toBe(2);
+
+            // Did the client's reboot method get called?
+            expect(rebootMock).toBeCalledTimes(1);
         });
     });