Rename wizard types for reuse across Campaign and Benchmark (#2185)

Part of OPS-4044.

Author: MarceloRGonc

packages/react-ui/src/app/features/benchmark/benchmark-api.ts

@@ -2,30 +2,30 @@ import {
   BenchmarkCreationResult,
   BenchmarkStatusResponse,
   BenchmarkWebhookPayload,
-  BenchmarkWizardRequest,
-  BenchmarkWizardStepResponse,
   ListBenchmarksResponse,
+  WizardRequest,
+  WizardStepResponse,
 } from '@openops/shared';
 
 import { api } from '@/app/lib/api';
 
 const getWizardStep = (
   provider: string,
-  request: BenchmarkWizardRequest,
-): Promise<BenchmarkWizardStepResponse> =>
-  api.post<BenchmarkWizardStepResponse, BenchmarkWizardRequest>(
+  request: WizardRequest,
+): Promise<WizardStepResponse> =>
+  api.post<WizardStepResponse, WizardRequest>(
     `/v1/benchmarks/${provider}/wizard`,
     request,
   );
 
 const createBenchmark = (
   provider: string,
-  benchmarkConfiguration: Record<string, string[]>,
+  wizardState: Record<string, string[]>,
 ): Promise<BenchmarkCreationResult> =>
-  api.post<
-    BenchmarkCreationResult,
-    { benchmarkConfiguration: Record<string, string[]> }
-  >(`/v1/benchmarks/${provider}`, { benchmarkConfiguration });
+  api.post<BenchmarkCreationResult, { wizardState: Record<string, string[]> }>(
+    `/v1/benchmarks/${provider}`,
+    { wizardState: wizardState },
+  );
 
 const runBenchmark = (
   orchestratorFlowId: string,

packages/react-ui/src/app/features/benchmark/components/dynamic-benchmark-step/types.ts

@@ -1,7 +1,7 @@
-import { BenchmarkWizardStepResponse } from '@openops/shared';
+import { WizardStepResponse } from '@openops/shared';
 
 export interface DynamicBenchmarkStepProps {
-  stepResponse: BenchmarkWizardStepResponse;
+  stepResponse: WizardStepResponse;
   value: string[];
   onValueChange: (value: string[]) => void;
   stepBodyClassName?: string;

packages/react-ui/src/app/features/benchmark/use-benchmark-wizard-navigation.test.ts

@@ -1,5 +1,5 @@
 import { INTERNAL_ERROR_TOAST, toast } from '@openops/components/ui';
-import { BenchmarkWizardStepResponse } from '@openops/shared';
+import { WizardStepResponse } from '@openops/shared';
 import { useMutation, useQueryClient } from '@tanstack/react-query';
 import { act, renderHook } from '@testing-library/react';
 
@@ -31,8 +31,8 @@ const mockCreateBenchmark = benchmarkApi.createBenchmark as jest.Mock;
 const mockToast = toast as jest.Mock;
 
 const buildStepResponse = (
-  overrides?: Partial<BenchmarkWizardStepResponse>,
-): BenchmarkWizardStepResponse => ({
+  overrides?: Partial<WizardStepResponse>,
+): WizardStepResponse => ({
   currentStep: 'region',
   title: 'Select Region',
   description: 'Choose your cloud region',
@@ -327,7 +327,7 @@ describe('useBenchmarkWizardNavigation', () => {
 
       expect(mockGetWizardStep).toHaveBeenNthCalledWith(2, 'aws', {
         currentStep: 'region',
-        benchmarkConfiguration: { region: ['us-east-1'] },
+        wizardState: { region: ['us-east-1'] },
       });
       expect(result.current.currentStepResponse).toEqual(secondStep);
       expect(result.current.currentSelections).toEqual([]);
@@ -399,7 +399,7 @@ describe('useBenchmarkWizardNavigation', () => {
 
       expect(mockGetWizardStep).toHaveBeenNthCalledWith(3, 'aws', {
         currentStep: 'instance-type',
-        benchmarkConfiguration: {
+        wizardState: {
           region: ['us-east-1'],
           'instance-type': ['t3.medium'],
         },
@@ -502,9 +502,7 @@ describe('useBenchmarkWizardNavigation', () => {
   });
 
   describe('isNextDisabled in provider-step phase', () => {
-    const setupAtProviderStep = async (
-      stepResponse: BenchmarkWizardStepResponse,
-    ) => {
+    const setupAtProviderStep = async (stepResponse: WizardStepResponse) => {
       mockGetWizardStep.mockResolvedValue(stepResponse);
       const { result } = renderHook(() =>
         useBenchmarkWizardNavigation(connectedProviders),

packages/react-ui/src/app/features/benchmark/use-benchmark-wizard-navigation.ts

@@ -1,8 +1,8 @@
 import { handleMutationError } from '@/app/interceptors/interceptor-utils';
 import {
   BenchmarkCreationResult,
-  BenchmarkWizardRequest,
-  BenchmarkWizardStepResponse,
+  WizardRequest,
+  WizardStepResponse,
 } from '@openops/shared';
 import { useMutation, useQueryClient } from '@tanstack/react-query';
 import { useState } from 'react';
@@ -13,11 +13,11 @@ import { benchmarkApi } from './benchmark-api';
 export type WizardPhase = 'initial' | 'provider-step' | 'benchmark-ready';
 
 type StepHistoryEntry = {
-  stepResponse: BenchmarkWizardStepResponse;
+  stepResponse: WizardStepResponse;
   selections: string[];
 };
 
-const buildBenchmarkConfiguration = (
+const buildWizardState = (
   history: StepHistoryEntry[],
 ): Record<string, string[]> =>
   history.reduce<Record<string, string[]>>((acc, entry) => {
@@ -29,7 +29,7 @@ type UseBenchmarkWizardNavigationResult = {
   selectedProvider: string | undefined;
   setSelectedProvider: (provider: string) => void;
   wizardPhase: WizardPhase;
-  currentStepResponse: BenchmarkWizardStepResponse | null;
+  currentStepResponse: WizardStepResponse | null;
   currentSelections: string[];
   setCurrentSelections: (selections: string[]) => void;
   isLoadingStep: boolean;
@@ -49,7 +49,7 @@ export const useBenchmarkWizardNavigation = (
   const [selectedProvider, setSelectedProvider] = useState<string>();
   const [wizardPhase, setWizardPhase] = useState<WizardPhase>('initial');
   const [currentStepResponse, setCurrentStepResponse] =
-    useState<BenchmarkWizardStepResponse | null>(null);
+    useState<WizardStepResponse | null>(null);
   const [currentSelections, setCurrentSelections] = useState<string[]>([]);
   const [stepHistory, setStepHistory] = useState<StepHistoryEntry[]>([]);
   const [benchmarkCreateResult, setBenchmarkCreateResult] =
@@ -62,7 +62,7 @@ export const useBenchmarkWizardNavigation = (
         request,
       }: {
         provider: string;
-        request: BenchmarkWizardRequest;
+        request: WizardRequest;
       }) => benchmarkApi.getWizardStep(provider, request),
       onError: handleMutationError,
     });
@@ -73,11 +73,11 @@ export const useBenchmarkWizardNavigation = (
     useMutation({
       mutationFn: ({
         provider,
-        benchmarkConfiguration,
+        wizardState,
       }: {
         provider: string;
-        benchmarkConfiguration: Record<string, string[]>;
-      }) => benchmarkApi.createBenchmark(provider, benchmarkConfiguration),
+        wizardState: Record<string, string[]>;
+      }) => benchmarkApi.createBenchmark(provider, wizardState),
       onSuccess: (result) => {
         setBenchmarkCreateResult(result);
         setWizardPhase('benchmark-ready');
@@ -115,13 +115,13 @@ export const useBenchmarkWizardNavigation = (
       selections: currentSelections,
     };
     const newHistory = [...stepHistory, committed];
-    const benchmarkConfiguration = buildBenchmarkConfiguration(newHistory);
+    const wizardState = buildWizardState(newHistory);
 
     if (currentStepResponse.nextStep === null) {
       setStepHistory(newHistory);
       await runCreateBenchmark({
         provider: selectedProvider,
-        benchmarkConfiguration,
+        wizardState: wizardState,
       });
       return;
     }
@@ -130,7 +130,7 @@ export const useBenchmarkWizardNavigation = (
       provider: selectedProvider,
       request: {
         currentStep: currentStepResponse.currentStep,
-        benchmarkConfiguration,
+        wizardState: wizardState,
       },
     });
 

packages/server/api/src/app/benchmark/attach-benchmark-flows.service.ts

@@ -1,9 +1,9 @@
 import {
   BenchmarkProviders,
   openOpsId,
-  type BenchmarkConfiguration,
   type BenchmarkWebhookPayload,
   type BenchmarkWorkflowBase,
+  type WizardState,
 } from '@openops/shared';
 import { webhookUtils } from 'server-worker';
 import { transaction } from '../core/db/transaction';
@@ -13,7 +13,7 @@ import { benchmarkRepo } from './benchmark.repo';
 import { throwValidationError } from './errors';
 
 export type AttachFlowsToBenchmarkRequest = {
-  benchmarkConfiguration: BenchmarkConfiguration;
+  wizardState: WizardState;
   workflows: BenchmarkWorkflowBase[];
   projectId: string;
   provider: BenchmarkProviders;
@@ -28,10 +28,10 @@ export type AttachFlowsToBenchmarkResponse = {
 
 async function buildPayloadForWebhook(params: {
   provider: BenchmarkProviders;
-  benchmarkConfiguration: BenchmarkConfiguration;
+  wizardState: WizardState;
   workflows: BenchmarkWorkflowBase[];
 }): Promise<BenchmarkWebhookPayload> {
-  const { provider, benchmarkConfiguration, workflows } = params;
+  const { provider, wizardState, workflows } = params;
 
   if (workflows.length < 3) {
     throwValidationError(
@@ -51,19 +51,19 @@ async function buildPayloadForWebhook(params: {
     webhookBaseUrl,
     workflows: subWorkflowFlowIds,
     cleanupWorkflows: cleanupFlowIds,
-    regions: benchmarkConfiguration.regions ?? [],
+    regions: wizardState.regions ?? [],
   };
 
   switch (provider) {
     case BenchmarkProviders.AWS:
       return {
         ...webhookPayloadCommon,
-        accounts: benchmarkConfiguration.accounts ?? [],
+        accounts: wizardState.accounts ?? [],
       };
     case BenchmarkProviders.AZURE:
       return {
         ...webhookPayloadCommon,
-        subscriptions: benchmarkConfiguration.subscriptions ?? [],
+        subscriptions: wizardState.subscriptions ?? [],
       };
     default: {
       throwValidationError(
@@ -119,7 +119,7 @@ export async function attachFlowsToBenchmark(
   params: AttachFlowsToBenchmarkRequest,
 ): Promise<AttachFlowsToBenchmarkResponse> {
   const {
-    benchmarkConfiguration,
+    wizardState,
     workflows,
     projectId,
     provider,
@@ -129,7 +129,7 @@ export async function attachFlowsToBenchmark(
 
   const payload = await buildPayloadForWebhook({
     provider,
-    benchmarkConfiguration,
+    wizardState,
     workflows,
   });
 

packages/server/api/src/app/benchmark/benchmark.controller.ts

@@ -6,18 +6,19 @@ import {
   BenchmarkCreationResult,
   BenchmarkProviders,
   BenchmarkStatusResponse,
-  BenchmarkWizardRequest,
-  BenchmarkWizardStepResponse,
   CreateBenchmarkRequest,
   ListBenchmarksResponse,
   Permission,
   PrincipalType,
+  WizardRequest,
+  WizardStepResponse,
 } from '@openops/shared';
 import { StatusCodes } from 'http-status-codes';
 import { getProjectScopedRoutePolicy } from '../core/security/route-policies/route-security-policy-factory';
 import { assertBenchmarkFeatureEnabled } from './benchmark-feature-guard';
 import { getBenchmarkStatus, listBenchmarks } from './benchmark-status.service';
 import { createBenchmark } from './create-benchmark.service';
+import { getProvider } from './providers/providers-registry';
 import { resolveWizardNavigation } from './wizard.service';
 
 export const benchmarkController: FastifyPluginAsyncTypebox = async (app) => {
@@ -27,11 +28,15 @@ export const benchmarkController: FastifyPluginAsyncTypebox = async (app) => {
     '/:provider/wizard',
     WizardStepRequestOptions,
     async (request, reply) => {
+      const provider = request.params.provider;
+      const providerAdapter = getProvider(provider);
+
       const step = await resolveWizardNavigation(
-        request.params.provider,
+        provider,
+        providerAdapter,
         {
           currentStep: request.body.currentStep,
-          benchmarkConfiguration: request.body.benchmarkConfiguration,
+          wizardState: request.body.wizardState,
         },
         request.principal.projectId,
       );
@@ -47,7 +52,7 @@ export const benchmarkController: FastifyPluginAsyncTypebox = async (app) => {
         provider: request.params.provider,
         projectId: request.principal.projectId,
         userId: request.principal.id,
-        benchmarkConfiguration: request.body.benchmarkConfiguration,
+        wizardState: request.body.wizardState,
       });
 
       return reply.status(StatusCodes.CREATED).send(result);
@@ -116,9 +121,9 @@ const WizardStepRequestOptions = {
     params: Type.Object({
       provider: Type.Enum(BenchmarkProviders),
     }),
-    body: BenchmarkWizardRequest,
+    body: WizardRequest,
     response: {
-      [StatusCodes.OK]: BenchmarkWizardStepResponse,
+      [StatusCodes.OK]: WizardStepResponse,
     },
   },
 };

packages/server/api/src/app/benchmark/common-resolvers.ts

@@ -1,7 +1,7 @@
 import {
   AppConnectionStatus,
-  BenchmarkWizardOption,
   WizardContext,
+  WizardOption,
 } from '@openops/shared';
 import { appConnectionService } from '../app-connection/app-connection-service/app-connection-service';
 import { getAuthProviderMetadata } from '../app-connection/connection-providers-resolver';
@@ -17,7 +17,7 @@ export async function getAuthProviderLogoUrl(
 
 export async function listConnections(
   context: WizardContext,
-): Promise<BenchmarkWizardOption[]> {
+): Promise<WizardOption[]> {
   if (!context.projectId) {
     throwValidationError('projectId is required to list connections');
   }