fix: call/callTask accept waitSecs instead of waitForFinish (#176)

Author: vladfrangu

packages/apify/src/actor.ts

@@ -5,10 +5,10 @@ import { ENV_VARS, INTEGER_ENV_VARS } from '@apify/consts';
 import { addTimeoutToPromise } from '@apify/timeout';
 import log, { LogLevel } from '@apify/log';
 import type {
-    ActorStartOptions,
+    ActorCallOptions,
     ApifyClientOptions,
     RunAbortOptions,
-    TaskStartOptions,
+    TaskCallOptions,
     Webhook,
     WebhookEventType,
 } from 'apify-client';
@@ -1529,14 +1529,14 @@ export interface ApifyEnv {
 
 export type UserFunc<T = unknown> = () => Awaitable<T>;
 
-export interface CallOptions extends ActorStartOptions {
+export interface CallOptions extends ActorCallOptions {
     /**
      * User API token that is used to run the actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
      */
     token?: string;
 }
 
-export interface CallTaskOptions extends TaskStartOptions {
+export interface CallTaskOptions extends TaskCallOptions {
     /**
      * User API token that is used to run the actor. By default, it is taken from the `APIFY_TOKEN` environment variable.
      */

test/apify/actor.test.ts

@@ -242,31 +242,31 @@ describe('Actor', () => {
             });
 
             test('works as expected with unfinished run', async () => {
-                const waitForFinish = 1;
+                const waitSecs = 1;
 
                 const callMock = jest.fn();
                 callMock.mockResolvedValueOnce(runningRun);
                 const actorSpy = jest.spyOn(ApifyClient.prototype, 'actor');
                 actorSpy.mockReturnValueOnce({ call: callMock } as any);
                 const keyValueStoreSpy = jest.spyOn(ApifyClient.prototype, 'keyValueStore');
 
-                const callOutput = await new Actor().call(actId, undefined, { waitForFinish });
+                const callOutput = await new Actor().call(actId, undefined, { waitSecs });
 
                 expect(callOutput).toEqual(runningRun);
                 expect(actorSpy).toBeCalledWith('some-act-id');
                 expect(keyValueStoreSpy).not.toBeCalled();
             });
 
             test('returns immediately with zero ', async () => {
-                const waitForFinish = 0;
+                const waitSecs = 0;
 
                 const callMock = jest.fn();
                 callMock.mockResolvedValueOnce(readyRun);
                 const actorSpy = jest.spyOn(ApifyClient.prototype, 'actor');
                 actorSpy.mockReturnValueOnce({ call: callMock } as any);
                 const keyValueStoreSpy = jest.spyOn(ApifyClient.prototype, 'keyValueStore');
 
-                const callOutput = await new Actor().call(actId, undefined, { waitForFinish });
+                const callOutput = await new Actor().call(actId, undefined, { waitSecs });
 
                 expect(callOutput).toEqual(readyRun);
                 expect(actorSpy).toBeCalledWith('some-act-id');
@@ -368,31 +368,31 @@ describe('Actor', () => {
             });
 
             test('works as expected with unfinished run', async () => {
-                const waitForFinish = 1;
+                const waitSecs = 1;
 
                 const callMock = jest.fn();
                 callMock.mockResolvedValueOnce(runningRun);
                 const taskSpy = jest.spyOn(ApifyClient.prototype, 'task');
                 taskSpy.mockReturnValueOnce({ call: callMock } as any);
                 const keyValueStoreSpy = jest.spyOn(ApifyClient.prototype, 'keyValueStore');
 
-                const callOutput = await new Actor().callTask(taskId, undefined, { waitForFinish });
+                const callOutput = await new Actor().callTask(taskId, undefined, { waitSecs });
 
                 expect(callOutput).toEqual(runningRun);
                 expect(keyValueStoreSpy).not.toBeCalled();
                 expect(taskSpy).toBeCalledWith('some-task-id');
             });
 
             test('returns immediately with zero ', async () => {
-                const waitForFinish = 0;
+                const waitSecs = 0;
 
                 const callMock = jest.fn();
                 callMock.mockResolvedValueOnce(readyRun);
                 const taskSpy = jest.spyOn(ApifyClient.prototype, 'task');
                 taskSpy.mockReturnValueOnce({ call: callMock } as any);
                 const keyValueStoreSpy = jest.spyOn(ApifyClient.prototype, 'keyValueStore');
 
-                const callOutput = await new Actor().callTask(taskId, undefined, { waitForFinish });
+                const callOutput = await new Actor().callTask(taskId, undefined, { waitSecs });
 
                 expect(callOutput).toEqual(readyRun);
                 expect(keyValueStoreSpy).not.toBeCalled();