feat: sandbox deployment events

packages/cli/src/commands/generate/config/generate_config_command.test.ts

@@ -8,6 +8,7 @@ import {
   TestCommandRunner,
 } from '../../../test-utils/command_runner.js';
 import assert from 'node:assert';
+import { BackendIdentifierResolver } from '../../../backend-identifier/backend_identifier_resolver.js';
 import { ClientConfigGeneratorAdapter } from '../../../client-config/client_config_generator_adapter.js';
 
 describe('generate config command', () => {

packages/cli/src/commands/generate/config/generate_config_command.ts

@@ -1,7 +1,6 @@
 import { ArgumentsCamelCase, Argv, CommandModule } from 'yargs';
 import { ClientConfigFormat } from '@aws-amplify/client-config';
-import { AppNameResolver } from '../../../local_app_name_resolver.js';
-import { BackendIdentifier } from '@aws-amplify/deployed-backend-client';
+import { BackendIdentifierResolver } from '../../../backend-identifier/backend_identifier_resolver.js';
 import { ClientConfigGeneratorAdapter } from '../../../client-config/client_config_generator_adapter.js';
 
 export type GenerateConfigCommandOptions = {

packages/cli/src/commands/generate/generate_command_factory.ts

@@ -2,8 +2,9 @@ import { CommandModule } from 'yargs';
 import { GenerateCommand } from './generate_command.js';
 import { GenerateConfigCommand } from './config/generate_config_command.js';
 import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
-import { LocalAppNameResolver } from '../../local_app_name_resolver.js';
 import { CwdPackageJsonLoader } from '../../cwd_package_json_loader.js';
+import { LocalAppNameResolver } from '../../backend-identifier/local_app_name_resolver.js';
+import { BackendIdentifierResolver } from '../../backend-identifier/backend_identifier_resolver.js';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 
 /**

packages/cli/src/commands/sandbox/sandbox-delete/sandbox_delete_command.test.ts

@@ -6,17 +6,10 @@ import assert from 'node:assert';
 import { SandboxDeleteCommand } from './sandbox_delete_command.js';
 import { SandboxCommand } from '../sandbox_command.js';
 import { SandboxSingletonFactory } from '@aws-amplify/sandbox';
-import { ClientConfigGeneratorAdapter } from '../../../client-config/client_config_generator_adapter.js';
 
 describe('sandbox delete command', () => {
   let commandRunner: TestCommandRunner;
   let sandboxDeleteMock = mock.fn();
-  let generatorAdapter: ClientConfigGeneratorAdapter =
-    {} as ClientConfigGeneratorAdapter;
-  const sandboxIdResolver = async () => ({
-    branchName: 'sandbox',
-    backendId: 'a-fake-backend',
-  });
 
   beforeEach(async () => {
     const sandboxFactory = new SandboxSingletonFactory(() =>
@@ -31,8 +24,7 @@ describe('sandbox delete command', () => {
 
     const sandboxCommand = new SandboxCommand(
       sandboxFactory,
-      sandboxDeleteCommand,
-      () => async () => {}
+      sandboxDeleteCommand
     );
     const parser = yargs().command(sandboxCommand as unknown as CommandModule);
     commandRunner = new TestCommandRunner(parser);

packages/cli/src/commands/sandbox/sandbox_command.test.ts

@@ -7,7 +7,11 @@
 } from '../../test-utils/command_runner.js';
 import assert from 'node:assert';
 import fs from 'fs';
-import { SandboxCommand } from './sandbox_command.js';
+import {
+  EventHandler,
+  SandboxCommand,
+  SandboxEventHandlerCreator,
+} from './sandbox_command.js';
 import { createSandboxCommand } from './sandbox_command_factory.js';
 import { SandboxDeleteCommand } from './sandbox-delete/sandbox_delete_command.js';
 import { Sandbox, SandboxSingletonFactory } from '@aws-amplify/sandbox';
@@ -25,7 +29,7 @@
   let sandboxStartMock = mock.fn<typeof sandbox.start>();
   let mockGenerate =
     mock.fn<ClientConfigGeneratorAdapter['generateClientConfigToFile']>();
-  const generationMock = mock.fn<() => Promise<void>>();
+  const generationMock = mock.fn<EventHandler>();
 
   beforeEach(async () => {
     const sandboxFactory = new SandboxSingletonFactory(() =>
@@ -39,7 +43,9 @@
     const sandboxCommand = new SandboxCommand(
       sandboxFactory,
       sandboxDeleteCommand,
-      () => generationMock
+      () => ({
+        successfulDeployment: [generationMock],
+      })
     );
     const parser = yargs().command(sandboxCommand as unknown as CommandModule);
     commandRunner = new TestCommandRunner(parser);

packages/cli/src/commands/sandbox/sandbox_command.ts

@@ -7,8 +7,6 @@ import {
   ClientConfigFormat,
   getClientConfigPath,
 } from '@aws-amplify/client-config';
-import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
-import { BackendIdentifier } from '@aws-amplify/deployed-backend-client';
 
 export type SandboxCommandOptions = {
   dirToWatch: string | undefined;
@@ -19,6 +17,22 @@ export type SandboxCommandOptions = {
   profile: string | undefined;
 };
 
+export type EventHandler = () => void;
+
+export type SandboxEventHandlers = {
+  successfulDeployment: EventHandler[];
+};
+
+export type SandboxEventHandlerParams = {
+  appName?: string;
+  outDir?: string;
+  format?: ClientConfigFormat;
+};
+
+export type SandboxEventHandlerCreator = (
+  params: SandboxEventHandlerParams
+) => SandboxEventHandlers;
+
 /**
  * Command that starts sandbox.
  */
@@ -43,11 +57,7 @@ export class SandboxCommand
   constructor(
     private readonly sandboxFactory: SandboxSingletonFactory,
     private readonly sandboxDeleteCommand: SandboxDeleteCommand,
-    private readonly createConfigGenerationCallback: (
-      appName?: string,
-      outDir?: string,
-      format?: ClientConfigFormat
-    ) => () => Promise<void>
+    private readonly createConfigGenerationCallback?: SandboxEventHandlerCreator
   ) {
     this.command = 'sandbox';
     this.describe = 'Starts sandbox, watch mode for amplify deployments';
@@ -61,12 +71,16 @@ export class SandboxCommand
   ): Promise<void> => {
     const sandbox = await this.sandboxFactory.getInstance();
     this.appName = args.name;
-    const generationCommand = this.createConfigGenerationCallback(
-      args.name,
-      args.out,
-      args.format
-    );
-    sandbox.on('successfulDeployment', generationCommand);
+    const eventHandlers = this.createConfigGenerationCallback?.({
+      appName: args.name,
+      format: args.format,
+      outDir: args.out,
+    });
+    if (eventHandlers) {
+      Object.entries(eventHandlers).forEach(([event, handlers]) => {
+        handlers.forEach((handler) => sandbox.on(event, handler));
+      });
+    }
     const watchExclusions = args.exclude ?? [];
     const clientConfigWritePath = await getClientConfigPath(
       args.out,

packages/cli/src/commands/sandbox/sandbox_command_factory.ts

@@ -7,6 +7,7 @@ import { CwdPackageJsonLoader } from '../../cwd_package_json_loader.js';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
 import { ClientConfigFormat } from '@aws-amplify/client-config';
+import { LocalAppNameResolver } from '../../backend-identifier/local_app_name_resolver.js';
 
 /**
  * Creates wired sandbox command.
@@ -30,14 +31,18 @@ export const createSandboxCommand = (): CommandModule<
   return new SandboxCommand(
     sandboxFactory,
     new SandboxDeleteCommand(sandboxFactory),
-    (appName?: string, outDir?: string, format?: ClientConfigFormat) => {
-      return async () => {
-        const id = await getBackendIdentifier(appName);
-        clientConfigGeneratorAdapter.generateClientConfigToFile(
-          id,
-          outDir,
-          format
-        );
+    ({ appName, outDir, format }) => {
+      return {
+        successfulDeployment: [
+          async () => {
+            const id = await getBackendIdentifier(appName);
+            clientConfigGeneratorAdapter.generateClientConfigToFile(
+              id,
+              outDir,
+              format
+            );
+          },
+        ],
       };
     }
   );