feat: made executionTimeout optional for exported respect-core run (#2233)

Author: DmitryAnansky

.changeset/eight-buckets-end.md

@@ -0,0 +1,6 @@
+---
+"@redocly/respect-core": patch
+"@redocly/cli": patch
+---
+
+Made `executionTimeout` parameter optional in the `run` function exported from `respect-core`.

packages/respect-core/src/modules/__tests__/flow-runner/run-step.test.ts

@@ -608,6 +608,7 @@ const basicCTX = {
     workflow: undefined,
     skip: undefined,
     verbose: true,
+    executionTimeout: 3_600_000,
     metadata: {
       _: [],
       files: ['runStepTest.yml'],

packages/respect-core/src/modules/flow-runner/run-step.ts

@@ -164,7 +164,10 @@ export async function runStep({
     return { shouldEnd: true };
   }
 
-  if (Timer.getInstance(ctx.options.executionTimeout).isTimedOut()) {
+  if (
+    ctx.options.executionTimeout &&
+    Timer.getInstance(ctx.options.executionTimeout).isTimedOut()
+  ) {
     step.checks.push({
       name: CHECKS.GLOBAL_TIMEOUT_ERROR,
       message: `Global Respect timer reached`,

packages/respect-core/src/run.ts

@@ -20,7 +20,7 @@ export type RespectOptions = {
   config: Config;
   maxSteps: number;
   maxFetchTimeout: number;
-  executionTimeout: number;
+  executionTimeout?: number;
   collectSpecData?: CollectFn;
   requestFileLoader: { getFileBody: (filePath: string) => Promise<Blob> };
   envVariables?: Record<string, string>;
@@ -34,7 +34,8 @@ export type RespectOptions = {
 export async function run(options: RespectOptions): Promise<RunFileResult[]> {
   const { files, executionTimeout, collectSpecData } = options;
 
-  Timer.getInstance(executionTimeout);
+  // Don't create a timer if executionTimeout is not set
+  executionTimeout && Timer.getInstance(executionTimeout);
 
   const testsRunProblemsStatus: boolean[] = [];
   const runAllFilesResult = [];

packages/respect-core/src/types.ts

@@ -124,7 +124,7 @@ export type AppOptions = {
   severity?: string | string[];
   maxSteps: number;
   maxFetchTimeout: number;
-  executionTimeout: number;
+  executionTimeout?: number;
   config: Config;
   requestFileLoader: { getFileBody: (filePath: string) => Promise<Blob> };
   fetch: typeof fetch;