Refactor benchmark wizard (#2183)

MarceloRGonc · web-flow · commit 4a6492e38605 · 2026-03-31T15:00:37.000+01:00
Part of OPS-4044.
diff --git a/packages/server/api/src/app/benchmark/common-resolvers.ts b/packages/server/api/src/app/benchmark/common-resolvers.ts
@@ -1,8 +1,11 @@
-import { AppConnectionStatus, BenchmarkWizardOption } from '@openops/shared';
+import {
+  AppConnectionStatus,
+  BenchmarkWizardOption,
+  WizardContext,
+} from '@openops/shared';
 import { appConnectionService } from '../app-connection/app-connection-service/app-connection-service';
 import { getAuthProviderMetadata } from '../app-connection/connection-providers-resolver';
 import { throwValidationError } from './errors';
-import type { WizardContext } from './provider-adapter';
 
 export async function getAuthProviderLogoUrl(
   authProviderKey: string,
diff --git a/packages/server/api/src/app/benchmark/providers/aws/aws-condition-resolver.ts b/packages/server/api/src/app/benchmark/providers/aws/aws-condition-resolver.ts
@@ -1,5 +1,5 @@
+import { WizardContext } from '@openops/shared';
 import { throwValidationError } from '../../errors';
-import type { WizardContext } from '../../provider-adapter';
 import { getConnectionAccounts } from './aws-option-resolver';
 
 export async function evaluateCondition(
diff --git a/packages/server/api/src/app/benchmark/providers/aws/aws-option-resolver.ts b/packages/server/api/src/app/benchmark/providers/aws/aws-option-resolver.ts
@@ -3,14 +3,14 @@ import {
   BenchmarkWizardOption,
   CustomAuthConnectionValue,
   REGION_IMAGE_LOGO_URL,
+  WizardContext,
 } from '@openops/shared';
 import { appConnectionService } from '../../../app-connection/app-connection-service/app-connection-service';
 import {
   getAuthProviderLogoUrl,
   listConnections,
 } from '../../common-resolvers';
 import { throwValidationError } from '../../errors';
-import type { WizardContext } from '../../provider-adapter';
 
 type AwsAuthProps = {
   roles?: Array<{ assumeRoleArn: string; accountName: string }>;
diff --git a/packages/server/api/src/app/benchmark/providers/aws/index.ts b/packages/server/api/src/app/benchmark/providers/aws/index.ts
@@ -1,4 +1,4 @@
-import type { ProviderAdapter, WizardConfig } from '../../provider-adapter';
+import type { ProviderAdapter, WizardConfig } from '@openops/shared';
 import { evaluateCondition } from './aws-condition-resolver';
 import { resolveOptions } from './aws-option-resolver';
 import awsConfig from './aws.json';
diff --git a/packages/server/api/src/app/benchmark/providers/azure/azure-option-resolver.ts b/packages/server/api/src/app/benchmark/providers/azure/azure-option-resolver.ts
@@ -8,14 +8,14 @@ import {
   BenchmarkWizardOption,
   CustomAuthConnectionValue,
   REGION_IMAGE_LOGO_URL,
+  WizardContext,
 } from '@openops/shared';
 import { appConnectionService } from '../../../app-connection/app-connection-service/app-connection-service';
 import {
   getAuthProviderLogoUrl,
   listConnections,
 } from '../../common-resolvers';
 import { throwValidationError } from '../../errors';
-import type { WizardContext } from '../../provider-adapter';
 
 export async function resolveOptions(
   method: string,
diff --git a/packages/server/api/src/app/benchmark/providers/azure/index.ts b/packages/server/api/src/app/benchmark/providers/azure/index.ts
@@ -1,4 +1,4 @@
-import type { ProviderAdapter, WizardConfig } from '../../provider-adapter';
+import type { ProviderAdapter, WizardConfig } from '@openops/shared';
 import { resolveOptions } from './azure-option-resolver';
 import azureConfig from './azure.json';
 
diff --git a/packages/server/api/src/app/benchmark/providers/providers-registry.ts b/packages/server/api/src/app/benchmark/providers/providers-registry.ts
@@ -0,0 +1,23 @@
+import { BenchmarkProviders, ProviderAdapter } from '@openops/shared';
+import { throwValidationError } from '../errors';
+import { awsProviderAdapter } from './aws';
+import { azureProviderAdapter } from './azure';
+
+const providers = new Map<string, ProviderAdapter>();
+
+export function getProvider(provider: string): ProviderAdapter {
+  const adapter = providers.get(provider);
+
+  if (!adapter) {
+    throwValidationError(`Provider not found: ${provider}`);
+  }
+
+  return adapter;
+}
+
+function registerProviders(): void {
+  providers.set(BenchmarkProviders.AWS, awsProviderAdapter);
+  providers.set(BenchmarkProviders.AZURE, azureProviderAdapter);
+}
+
+registerProviders();
diff --git a/packages/server/api/src/app/benchmark/register-providers.ts b/packages/server/api/src/app/benchmark/register-providers.ts
diff --git a/packages/server/api/src/app/benchmark/wizard.service.ts b/packages/server/api/src/app/benchmark/wizard.service.ts
@@ -2,17 +2,14 @@ import {
   BenchmarkWizardOption,
   BenchmarkWizardRequest,
   BenchmarkWizardStepResponse,
+  ProviderAdapter,
+  StaticOptionValue,
+  WizardConfig,
+  WizardConfigStep,
+  WizardContext,
 } from '@openops/shared';
 import { throwValidationError } from './errors';
-import {
-  getProvider,
-  type ProviderAdapter,
-  type StaticOptionValue,
-  type WizardConfig,
-  type WizardConfigStep,
-  type WizardContext,
-} from './provider-adapter';
-import './register-providers';
+import { getProvider } from './providers/providers-registry';
 
 function getStepProgress(
   config: WizardConfig,
diff --git a/packages/server/api/test/unit/benchmark/wizard.service.test.ts b/packages/server/api/test/unit/benchmark/wizard.service.test.ts
@@ -1,8 +1,6 @@
-import type { ProviderAdapter } from '../../../src/app/benchmark/provider-adapter';
+import type { ProviderAdapter } from '@openops/shared';
 import { resolveWizardNavigation } from '../../../src/app/benchmark/wizard.service';
 
-jest.mock('../../../src/app/benchmark/register-providers', () => ({}));
-
 const mockResolveOptions = jest.fn().mockResolvedValue([]);
 const mockEvaluateCondition = jest.fn().mockResolvedValue(true);
 
@@ -66,14 +64,15 @@ adapters.set('test', mockProviderAdapter);
 
 const mockGetProvider = jest.fn((provider: string): ProviderAdapter => {
   const adapter = adapters.get(provider);
+
   if (!adapter) {
     throw new Error(`Provider not found: ${provider}`);
   }
+
   return adapter;
 });
 
-jest.mock('../../../src/app/benchmark/provider-adapter', () => ({
-  ...jest.requireActual('../../../src/app/benchmark/provider-adapter'),
+jest.mock('../../../src/app/benchmark/providers/providers-registry', () => ({
   getProvider: (p: string): ProviderAdapter => mockGetProvider(p),
 }));
 
diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts
@@ -66,6 +66,7 @@ export * from './lib/user';
 export * from './lib/user-settings';
 export * from './lib/webhook';
 export * from './lib/websocket';
+export * from './lib/wizard';
 export * from './lib/workers';
 export * from './lib/workflow-stats';
 // Look at https://github.com/sinclairzx81/typebox/issues/350
diff --git a/packages/shared/src/lib/benchmark/dto/create-benchmark-request.ts b/packages/shared/src/lib/benchmark/dto/create-benchmark-request.ts
@@ -1,5 +1,5 @@
 import { Static, Type } from '@sinclair/typebox';
-import { BenchmarkConfiguration } from './wizard-request';
+import { BenchmarkConfiguration } from '../../wizard/wizard-request';
 
 export const CreateBenchmarkRequest = Type.Object({
   benchmarkConfiguration: BenchmarkConfiguration,
diff --git a/packages/shared/src/lib/benchmark/dto/index.ts b/packages/shared/src/lib/benchmark/dto/index.ts
@@ -3,5 +3,3 @@ export * from './create-benchmark-request';
 export * from './create-benchmark-response';
 export * from './list-benchmarks-response';
 export * from './run-benchmark-response';
-export * from './wizard-request';
-export * from './wizard-response';
diff --git a/packages/shared/src/lib/wizard/index.ts b/packages/shared/src/lib/wizard/index.ts
@@ -0,0 +1,3 @@
+export * from './provider-adapter';
+export * from './wizard-request';
+export * from './wizard-response';
diff --git a/packages/shared/src/lib/wizard/provider-adapter.ts b/packages/shared/src/lib/wizard/provider-adapter.ts
@@ -1,5 +1,5 @@
-import { BenchmarkConfiguration, BenchmarkWizardOption } from '@openops/shared';
-import { throwValidationError } from './errors';
+import { BenchmarkConfiguration } from './wizard-request';
+import { BenchmarkWizardOption } from './wizard-response';
 
 export type WizardContext = {
   benchmarkConfiguration?: BenchmarkConfiguration;
@@ -54,20 +54,3 @@ export type ProviderAdapter = {
     context: WizardContext,
   ) => Promise<boolean>;
 };
-
-const providers = new Map<string, ProviderAdapter>();
-
-export function registerProvider(
-  provider: string,
-  adapter: ProviderAdapter,
-): void {
-  providers.set(provider, adapter);
-}
-
-export function getProvider(provider: string): ProviderAdapter {
-  const adapter = providers.get(provider);
-  if (!adapter) {
-    throwValidationError(`Provider not found: ${provider}`);
-  }
-  return adapter;
-}
diff --git a/packages/shared/src/lib/wizard/wizard-request.ts b/packages/shared/src/lib/wizard/wizard-request.ts
diff --git a/packages/shared/src/lib/wizard/wizard-response.ts b/packages/shared/src/lib/wizard/wizard-response.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { ProviderAdapter, WizardConfig } from '../../provider-adapter';`
	`1`	`+import type { ProviderAdapter, WizardConfig } from '@openops/shared';`
`2`	`2`	`import { evaluateCondition } from './aws-condition-resolver';`
`3`	`3`	`import { resolveOptions } from './aws-option-resolver';`
`4`	`4`	`import awsConfig from './aws.json';`