chore: renames after review

DmitryAnansky · DmitryAnansky · commit 470fd296ea8d · 2025-07-23T15:40:41.000+03:00
diff --git a/packages/respect-core/src/modules/__tests__/config-parser/parse-request-body.test.ts b/packages/respect-core/src/modules/__tests__/config-parser/parse-request-body.test.ts
@@ -10,7 +10,7 @@ vi.mock('node:fs');
 describe('parseRequestBody', () => {
   const ctx = {
     options: {
-      workflowPath: 'test.yaml',
+      filePath: 'test.yaml',
       requestFileLoader: {
         getFileBody: async (filePath: string) => {
           await new Promise((resolve, reject) => {
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/call-api-and-analyze-results.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/call-api-and-analyze-results.test.ts
@@ -312,7 +312,7 @@ describe('callAPIAndAnalyzeResults', () => {
       },
     },
     options: {
-      workflowPath: 'simple.yaml',
+      filePath: 'simple.yaml',
       metadata: {
         _: [],
         files: ['simple.yaml'],
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/context/create-runtime-expression-ctx.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/context/create-runtime-expression-ctx.test.ts
@@ -44,7 +44,7 @@ const testDescription = {
 } as unknown as TestDescription;
 
 const options: AppOptions = {
-  workflowPath: 'modules/description-parser/test.test.yaml',
+  filePath: 'modules/description-parser/test.test.yaml',
   workflow: undefined,
   metadata: {},
   verbose: false,
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/context/create-test-context.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/context/create-test-context.test.ts
@@ -48,7 +48,7 @@ describe('createTestContext', () => {
     } as unknown as TestDescription;
 
     const options = {
-      workflowPath: 'modules/description-parser/test.test.yaml',
+      filePath: 'modules/description-parser/test.test.yaml',
       workflow: undefined,
       metadata: {},
       verbose: false,
@@ -517,7 +517,7 @@ describe('createTestContext', () => {
         env: {},
       },
       options: {
-        workflowPath: 'modules/description-parser/test.test.yaml',
+        filePath: 'modules/description-parser/test.test.yaml',
         workflow: undefined,
         metadata: {},
         verbose: false,
@@ -552,7 +552,7 @@ describe('createTestContext', () => {
     };
 
     const options: AppOptions = {
-      workflowPath: 'test.test.yaml',
+      filePath: 'test.test.yaml',
       workflow: undefined,
       metadata: {},
       verbose: false,
@@ -603,7 +603,7 @@ describe('createTestContext', () => {
     };
 
     const options: AppOptions = {
-      workflowPath: 'test.test.yaml',
+      filePath: 'test.test.yaml',
       input: JSON.stringify({ testInput: 'testValue' }),
       workflow: undefined,
       skip: undefined,
@@ -674,7 +674,7 @@ describe('createTestContext', () => {
     } as unknown as TestDescription;
 
     const options = {
-      workflowPath: 'test.test.yaml',
+      filePath: 'test.test.yaml',
       input: JSON.stringify({ input1: 'value1' }),
     } as unknown as AppOptions;
 
@@ -716,7 +716,7 @@ describe('createTestContext', () => {
     } as unknown as TestDescription;
 
     const options = {
-      workflowPath: 'test.test.yaml',
+      filePath: 'test.test.yaml',
     } as unknown as AppOptions;
 
     const apiClient = new ApiFetcher({});
@@ -749,7 +749,7 @@ describe('createTestContext', () => {
     } as unknown as TestDescription;
 
     const options = {
-      workflowPath: 'test.test.yaml',
+      filePath: 'test.test.yaml',
       envVariables: {
         ENV_VAR: 'value',
       },
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/prepare-request.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/prepare-request.test.ts
@@ -301,7 +301,7 @@ describe('prepareRequest', () => {
       },
     },
     options: {
-      workflowPath: 'simple.yaml',
+      filePath: 'simple.yaml',
       metadata: {
         _: [],
         files: ['simple.yaml'],
@@ -544,7 +544,7 @@ describe('prepareRequest', () => {
         },
       },
       options: {
-        workflowPath: 'simple.yaml',
+        filePath: 'simple.yaml',
         metadata: {
           _: [],
           files: ['simple.yaml'],
@@ -670,7 +670,7 @@ describe('prepareRequest', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'simple.yaml',
+        filePath: 'simple.yaml',
         metadata: {
           _: [],
           files: ['simple.yaml'],
@@ -871,7 +871,7 @@ describe('prepareRequest', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'simple.yaml',
+        filePath: 'simple.yaml',
         metadata: {
           _: [],
           files: ['simple.yaml'],
@@ -1074,7 +1074,7 @@ describe('prepareRequest', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'simple.yaml',
+        filePath: 'simple.yaml',
         metadata: {
           _: [],
           files: ['simple.yaml'],
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/run-step.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/run-step.test.ts
@@ -604,7 +604,7 @@ const basicCTX = {
   },
   $steps: {},
   options: {
-    workflowPath: 'runStepTest.yml',
+    filePath: 'runStepTest.yml',
     workflow: undefined,
     skip: undefined,
     verbose: true,
@@ -2468,7 +2468,7 @@ describe('runStep', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'runStepTest.yml',
+        filePath: 'runStepTest.yml',
         workflow: undefined,
         skip: undefined,
         verbose: undefined,
@@ -2879,7 +2879,7 @@ describe('runStep', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'runStepTest.yml',
+        filePath: 'runStepTest.yml',
         workflow: undefined,
         skip: undefined,
         verbose: undefined,
@@ -3314,7 +3314,7 @@ describe('runStep', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'runStepTest.yml',
+        filePath: 'runStepTest.yml',
         workflow: undefined,
         skip: undefined,
         verbose: undefined,
@@ -3780,7 +3780,7 @@ describe('runStep', () => {
       },
       $steps: {},
       options: {
-        workflowPath: 'runStepTest.yml',
+        filePath: 'runStepTest.yml',
         workflow: undefined,
         skip: undefined,
         verbose: undefined,
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/runner/create-workflow-runner.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/runner/create-workflow-runner.test.ts
@@ -91,7 +91,7 @@ describe('runWorkflow', () => {
       ],
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
     } as unknown as TestContext;
@@ -116,7 +116,7 @@ describe('runWorkflow', () => {
       workflows: [workflow],
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
     } as unknown as TestContext;
@@ -136,7 +136,7 @@ describe('runWorkflow', () => {
       workflows: [],
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
     } as unknown as TestContext;
@@ -220,7 +220,7 @@ describe('runWorkflow', () => {
       severity: DEFAULT_SEVERITY_CONFIGURATION,
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
       $outputs: {},
@@ -292,7 +292,7 @@ describe('runWorkflow', () => {
       ],
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
       $outputs: {},
@@ -346,7 +346,7 @@ describe('runWorkflow', () => {
       ],
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
       $outputs: {},
@@ -446,7 +446,7 @@ describe('runWorkflow', () => {
       severity: DEFAULT_SEVERITY_CONFIGURATION,
       options: {
         verbose: false,
-        workflowPath: fileName,
+        filePath: fileName,
         logger,
       },
       $outputs: {},
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/runner/resolve-workflow-context.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/runner/resolve-workflow-context.test.ts
@@ -317,7 +317,7 @@ describe('resolveWorkflowContext', async () => {
       },
     },
     options: {
-      workflowPath: 'examples/museum-api/museum-api-test.yaml',
+      filePath: 'examples/museum-api/museum-api-test.yaml',
       workflow: undefined,
       skip: undefined,
       verbose: undefined,
@@ -362,7 +362,7 @@ describe('resolveWorkflowContext', async () => {
         input: undefined,
         skip: undefined,
         workflow: ['get-museum-tickets'],
-        workflowPath: expect.stringContaining('examples/museum-api/museum-tickets.yaml'),
+        filePath: expect.stringContaining('examples/museum-api/museum-tickets.yaml'),
         config,
         executionTimeout: 3_600_000,
         maxSteps: 2000,
@@ -375,7 +375,7 @@ describe('resolveWorkflowContext', async () => {
     );
   });
 
-  it('should call createTestContext with empty workflowPath when there are no ctx.sourceDescriptions', async () => {
+  it('should call createTestContext with empty filePath when there are no ctx.sourceDescriptions', async () => {
     const ctx = {
       ...commonCtx,
       ...{ sourceDescriptions: [] },
@@ -389,7 +389,7 @@ describe('resolveWorkflowContext', async () => {
         input: undefined,
         skip: undefined,
         workflow: ['get-museum-tickets'],
-        workflowPath: '',
+        filePath: '',
         config,
         executionTimeout: 3_600_000,
         maxSteps: 2000,
@@ -412,7 +412,7 @@ describe('resolveWorkflowContext', async () => {
         input: undefined,
         skip: undefined,
         workflow: ['get-museum-tickets'],
-        workflowPath: 'museum-api.yaml',
+        filePath: 'museum-api.yaml',
         config,
         executionTimeout: 3_600_000,
         maxSteps: 2000,
diff --git a/packages/respect-core/src/modules/__tests__/flow-runner/runner/run-test-file.test.ts b/packages/respect-core/src/modules/__tests__/flow-runner/runner/run-test-file.test.ts
@@ -579,7 +579,7 @@ describe('runTestFile', () => {
     } as any);
     vi.mocked(bundle).mockResolvedValueOnce(undefined as any);
     await expect(
-      runTestFile({ file: 'test.yaml', ...{ ...defaultRespectOptions, workflowPath: 'test.yaml' } })
+      runTestFile({ file: 'test.yaml', ...{ ...defaultRespectOptions, filePath: 'test.yaml' } })
     ).rejects.toThrowError(
       `Could not find source description file 'api-samples/not-existing.yaml'.`
     );
diff --git a/packages/respect-core/src/modules/context-parser/parse-request-body.ts b/packages/respect-core/src/modules/context-parser/parse-request-body.ts
@@ -67,10 +67,7 @@ const getRequestBodyMultipartFormData = async (
 
 const getRequestBodyOctetStream = async (payload: RequestBody['payload'], ctx: TestContext) => {
   if (typeof payload === 'string' && payload.startsWith('$file(') && payload.endsWith(')')) {
-    const filePath = path.resolve(
-      path.dirname(ctx.options.workflowPath),
-      stripFileDecorator(payload)
-    );
+    const filePath = path.resolve(path.dirname(ctx.options.filePath), stripFileDecorator(payload));
 
     return ctx.options.requestFileLoader.getFileBody(filePath);
   } else {
@@ -107,7 +104,7 @@ export async function parseRequestBody(
 
   if (contentType === 'multipart/form-data') {
     const formData = new FormData();
-    const workflowFilePath = path.resolve(ctx.options.workflowPath);
+    const workflowFilePath = path.resolve(ctx.options.filePath);
 
     await getRequestBodyMultipartFormData(payload, formData, workflowFilePath, ctx);
 
diff --git a/packages/respect-core/src/modules/flow-runner/context/create-test-context.ts b/packages/respect-core/src/modules/flow-runner/context/create-test-context.ts
@@ -37,7 +37,7 @@ export async function createTestContext(
           const parsedDocument = await bundleOpenApi({
             descriptionPath: sourceDescription.url,
             config: options.config,
-            base: options.workflowPath,
+            base: options.filePath,
             externalRefResolver: options?.externalRefResolver,
           });
           const { paths, servers, info, security, components } = parsedDocument;
@@ -50,7 +50,7 @@ export async function createTestContext(
           };
         } else if (sourceDescription.type === 'arazzo') {
           const { url: sourceDescriptionPath, name } = sourceDescription;
-          const filePath = resolve(dirname(options.workflowPath), sourceDescriptionPath);
+          const filePath = resolve(dirname(options.filePath), sourceDescriptionPath);
           const bundledTestDescription = await bundleArazzo({
             filePath,
             version: options?.version,
diff --git a/packages/respect-core/src/modules/flow-runner/prepare-request.ts b/packages/respect-core/src/modules/flow-runner/prepare-request.ts
@@ -161,7 +161,6 @@ export async function prepareRequest(
       value: evaluateRuntimeExpressionPayload({
         payload: parameter.value,
         context: expressionContext,
-        // contentType,
         logger: ctx.options.logger,
       }),
     };
diff --git a/packages/respect-core/src/modules/flow-runner/runner.ts b/packages/respect-core/src/modules/flow-runner/runner.ts
@@ -32,7 +32,7 @@ import type {
 export async function runTestFile(options: RunOptions, collectSpecData?: CollectFn) {
   const workflowOptions = {
     ...options,
-    workflowPath: options.file, // filePath or documentPath
+    filePath: options.file,
     metadata: { ...options },
   };
 
@@ -94,7 +94,7 @@ export async function runWorkflow({
 }: RunWorkflowInput): Promise<WorkflowExecutionResult> {
   const { logger } = ctx.options;
   const workflowStartTime = performance.now();
-  const fileBaseName = basename(ctx.options.workflowPath);
+  const fileBaseName = basename(ctx.options.filePath);
   const workflow =
     typeof workflowInput === 'string'
       ? ctx.workflows.find((w) => w.workflowId === workflowInput)
@@ -263,7 +263,7 @@ export async function resolveWorkflowContext(
     ? await createTestContext(
         testDescription,
         {
-          workflowPath: findSourceDescriptionUrl(
+          filePath: findSourceDescriptionUrl(
             sourceDescriptionId,
             ctx.sourceDescriptions,
             ctx.options
@@ -304,7 +304,7 @@ function findSourceDescriptionUrl(
   } else if (sourceDescription.type === 'openapi') {
     return sourceDescription.url;
   } else if (sourceDescription.type === 'arazzo') {
-    return resolve(dirname(options.workflowPath), sourceDescription.url);
+    return resolve(dirname(options.filePath), sourceDescription.url);
   } else {
     throw new Error(
       `Unknown source description type ${(sourceDescription as SourceDescription).type}`
diff --git a/packages/respect-core/src/types.ts b/packages/respect-core/src/types.ts
@@ -114,7 +114,7 @@ export type ParsedParameters = {
   headerParams: Record<string, string>;
 };
 export type AppOptions = {
-  workflowPath: string;
+  filePath: string;
   workflow?: string | string[];
   skip?: string | string[];
   verbose?: boolean;
