feat: move restartOnError from Actor to Run options (#760)

Author: DaveHanns

src/resource_clients/actor.ts

@@ -70,11 +70,21 @@ export class ActorClient extends ResourceClient {
                 webhooks: ow.optional.array.ofType(ow.object),
                 maxItems: ow.optional.number.not.negative,
                 maxTotalChargeUsd: ow.optional.number.not.negative,
+                restartOnError: ow.optional.boolean,
                 forcePermissionLevel: ow.optional.string.oneOf(Object.values(ACTOR_PERMISSION_LEVEL)),
             }),
         );
 
-        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, forcePermissionLevel } = options;
+        const {
+            waitForFinish,
+            timeout,
+            memory,
+            build,
+            maxItems,
+            maxTotalChargeUsd,
+            restartOnError,
+            forcePermissionLevel,
+        } = options;
 
         const params = {
             waitForFinish,
@@ -84,6 +94,7 @@ export class ActorClient extends ResourceClient {
             webhooks: stringifyWebhooksToBase64(options.webhooks),
             maxItems,
             maxTotalChargeUsd,
+            restartOnError,
             forcePermissionLevel,
         };
 
@@ -128,6 +139,7 @@ export class ActorClient extends ResourceClient {
                 webhooks: ow.optional.array.ofType(ow.object),
                 maxItems: ow.optional.number.not.negative,
                 maxTotalChargeUsd: ow.optional.number.not.negative,
+                restartOnError: ow.optional.boolean,
                 forcePermissionLevel: ow.optional.string.oneOf(Object.values(ACTOR_PERMISSION_LEVEL)),
             }),
         );
@@ -268,6 +280,7 @@ export interface Actor {
     name: string;
     username: string;
     description?: string;
+    /** @deprecated Use defaultRunOptions.restartOnError instead */
     restartOnError?: boolean;
     isPublic: boolean;
     isAnonymouslyRunnable?: boolean;
@@ -305,6 +318,7 @@ export interface ActorDefaultRunOptions {
     build: string;
     timeoutSecs: number;
     memoryMbytes: number;
+    restartOnError?: boolean;
 }
 
 export interface ActorExampleRunInput {
@@ -396,6 +410,11 @@ export interface ActorStartOptions {
      */
     maxItems?: number;
 
+    /**
+     * Determines whether the run will be restarted if it fails.
+     */
+    restartOnError?: boolean;
+
     // TODO(PPE): add maxTotalChargeUsd after finished
 
     /**
@@ -486,6 +505,7 @@ export interface ActorRunOptions {
     memoryMbytes: number;
     diskMbytes: number;
     maxTotalChargeUsd?: number;
+    restartOnError?: boolean;
 }
 
 export interface ActorBuildOptions {

src/resource_clients/actor_collection.ts

@@ -76,6 +76,7 @@ export interface ActorCollectionCreateOptions {
     isDeprecated?: boolean;
     isPublic?: boolean;
     name?: string;
+    /** @deprecated Use defaultRunOptions.restartOnError instead */
     restartOnError?: boolean;
     seoTitle?: string;
     seoDescription?: string;

src/resource_clients/run.ts

@@ -141,6 +141,7 @@ export class RunClient extends ResourceClient {
                 timeout: ow.optional.number,
                 maxItems: ow.optional.number,
                 maxTotalChargeUsd: ow.optional.number,
+                restartOnError: ow.optional.boolean,
             }),
         );
 
@@ -291,6 +292,7 @@ export interface RunResurrectOptions {
     timeout?: number;
     maxItems?: number;
     maxTotalChargeUsd?: number;
+    restartOnError?: boolean;
 }
 
 export interface RunChargeOptions {

src/resource_clients/schedule.ts

@@ -117,6 +117,7 @@ export interface ScheduledActorRunOptions {
     build: string;
     timeoutSecs: number;
     memoryMbytes: number;
+    restartOnError?: boolean;
 }
 
 export interface ScheduleActionRunActorTask extends BaseScheduleAction<ScheduleActions.RunActorTask> {

src/resource_clients/task.ts

@@ -63,10 +63,11 @@ export class TaskClient extends ResourceClient {
                 webhooks: ow.optional.array.ofType(ow.object),
                 maxItems: ow.optional.number.not.negative,
                 maxTotalChargeUsd: ow.optional.number.not.negative,
+                restartOnError: ow.optional.boolean,
             }),
         );
 
-        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd } = options;
+        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError } = options;
 
         const params = {
             waitForFinish,
@@ -76,6 +77,7 @@ export class TaskClient extends ResourceClient {
             webhooks: stringifyWebhooksToBase64(options.webhooks),
             maxItems,
             maxTotalChargeUsd,
+            restartOnError,
         };
 
         const request: ApifyRequestConfig = {
@@ -112,6 +114,7 @@ export class TaskClient extends ResourceClient {
                 webhooks: ow.optional.array.ofType(ow.object),
                 maxItems: ow.optional.number.not.negative,
                 maxTotalChargeUsd: ow.optional.number.not.negative,
+                restartOnError: ow.optional.boolean,
             }),
         );
 
@@ -222,6 +225,7 @@ export interface TaskOptions {
     build?: string;
     timeoutSecs?: number;
     memoryMbytes?: number;
+    restartOnError?: boolean;
 }
 
 export type TaskUpdateData = Partial<