top-level error handling (#865)

edwardfoyle · web-flow · commit 74846bd26ceb · 2024-01-04T12:47:48.000-08:00
diff --git a/.changeset/good-seals-fix.md b/.changeset/good-seals-fix.md
@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+gracefully handle errors that occur during a process event handler
diff --git a/packages/cli/src/amplify.ts b/packages/cli/src/amplify.ts
@@ -1,8 +1,10 @@
 #!/usr/bin/env node
 
 import { hideBin } from 'yargs/helpers';
-import * as process from 'process';
 import { createMainParser } from './main_parser_factory.js';
+import { attachUnhandledExceptionListeners } from './error_handler.js';
+
+attachUnhandledExceptionListeners();
 
 const parser = createMainParser();
 
diff --git a/packages/cli/src/command_failure_handler.test.ts b/packages/cli/src/command_failure_handler.test.ts
diff --git a/packages/cli/src/command_failure_handler.ts b/packages/cli/src/command_failure_handler.ts
diff --git a/packages/cli/src/commands/configure/configure_command.ts b/packages/cli/src/commands/configure/configure_command.ts
@@ -1,5 +1,4 @@
 import { Argv, CommandModule } from 'yargs';
-import { handleCommandFailure } from '../../command_failure_handler.js';
 
 /**
  * Root command to configure Amplify.
@@ -35,13 +34,6 @@ export class ConfigureCommand implements CommandModule<object> {
    * @inheritDoc
    */
   builder = (yargs: Argv): Argv => {
-    return yargs
-      .version(false)
-      .command(this.configureSubCommands)
-      .help()
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+    return yargs.version(false).command(this.configureSubCommands).help();
   };
 }
diff --git a/packages/cli/src/commands/configure/telemetry/configure_telemetry_command.ts b/packages/cli/src/commands/configure/telemetry/configure_telemetry_command.ts
@@ -4,7 +4,6 @@ import {
   USAGE_DATA_TRACKING_ENABLED,
 } from '@aws-amplify/platform-core';
 import { Argv, CommandModule } from 'yargs';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 /**
  * Command to configure AWS Amplify profile.
  */
@@ -54,10 +53,6 @@ export class ConfigureTelemetryCommand implements CommandModule<object> {
       })
       .demandCommand()
       .strictCommands()
-      .recommendCommands()
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+      .recommendCommands();
   };
 }
diff --git a/packages/cli/src/commands/generate/config/generate_config_command.ts b/packages/cli/src/commands/generate/config/generate_config_command.ts
@@ -3,7 +3,6 @@ import { ClientConfigFormat } from '@aws-amplify/client-config';
 import { BackendIdentifierResolver } from '../../../backend-identifier/backend_identifier_resolver.js';
 import { ClientConfigGeneratorAdapter } from '../../../client-config/client_config_generator_adapter.js';
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 export type GenerateConfigCommandOptions =
   ArgumentsKebabCase<GenerateConfigCommandOptionsCamelCase>;
@@ -100,10 +99,6 @@ export class GenerateConfigCommand
           'A path to directory where config is written. If not provided defaults to current process working directory.',
         type: 'string',
         array: false,
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
       });
   };
 }
diff --git a/packages/cli/src/commands/generate/forms/generate_forms_command.ts b/packages/cli/src/commands/generate/forms/generate_forms_command.ts
@@ -6,7 +6,6 @@ import { BackendIdentifierResolver } from '../../../backend-identifier/backend_i
 import { DEFAULT_UI_PATH } from '../../../form-generation/default_form_generation_output_paths.js';
 import { FormGenerationHandler } from '../../../form-generation/form_generation_handler.js';
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 export type GenerateFormsCommandOptions =
   ArgumentsKebabCase<GenerateFormsCommandOptionsCamelCase>;
@@ -128,10 +127,6 @@ export class GenerateFormsCommand
         type: 'string',
         array: true,
         group: 'Form Generation',
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
       });
   };
 }
diff --git a/packages/cli/src/commands/generate/generate_command.ts b/packages/cli/src/commands/generate/generate_command.ts
@@ -2,7 +2,6 @@ import { Argv, CommandModule } from 'yargs';
 import { GenerateConfigCommand } from './config/generate_config_command.js';
 import { GenerateFormsCommand } from './forms/generate_forms_command.js';
 import { GenerateGraphqlClientCodeCommand } from './graphql-client-code/generate_graphql_client_code_command.js';
-import { handleCommandFailure } from '../../command_failure_handler.js';
 import { CommandMiddleware } from '../../command_middleware.js';
 
 /**
@@ -61,10 +60,6 @@ export class GenerateCommand implements CommandModule {
           array: false,
         })
         .middleware([this.commandMiddleware.ensureAwsCredentialAndRegion])
-        .fail((msg, err) => {
-          handleCommandFailure(msg, err, yargs);
-          yargs.exit(1, err);
-        })
     );
   };
 }
diff --git a/packages/cli/src/commands/generate/graphql-client-code/generate_graphql_client_code_command.ts b/packages/cli/src/commands/generate/graphql-client-code/generate_graphql_client_code_command.ts
@@ -15,7 +15,6 @@ import {
   GenerateModelsOptions,
 } from '@aws-amplify/model-generator';
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 type GenerateOptions =
   | GenerateGraphqlCodegenOptions
@@ -321,10 +320,6 @@ export class GenerateGraphqlClientCodeCommand
         array: false,
         hidden: true,
       })
-      .showHidden('all')
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+      .showHidden('all');
   };
 }
diff --git a/packages/cli/src/commands/pipeline-deploy/pipeline_deploy_command.ts b/packages/cli/src/commands/pipeline-deploy/pipeline_deploy_command.ts
@@ -3,7 +3,6 @@ import { Argv, CommandModule } from 'yargs';
 import { BackendDeployer } from '@aws-amplify/backend-deployer';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import { ArgumentsKebabCase } from '../../kebab_case.js';
-import { handleCommandFailure } from '../../command_failure_handler.js';
 import { BackendIdentifier } from '@aws-amplify/plugin-types';
 
 export type PipelineDeployCommandOptions =
@@ -88,10 +87,6 @@ export class PipelineDeployCommand
           'A path to directory where config is written. If not provided defaults to current process working directory.',
         type: 'string',
         array: false,
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
       });
   };
 }
diff --git a/packages/cli/src/commands/sandbox/sandbox-delete/sandbox_delete_command.ts b/packages/cli/src/commands/sandbox/sandbox-delete/sandbox_delete_command.ts
@@ -1,7 +1,6 @@
 import { ArgumentsCamelCase, Argv, CommandModule } from 'yargs';
 import { SandboxSingletonFactory } from '@aws-amplify/sandbox';
 import { AmplifyPrompter } from '@aws-amplify/cli-core';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 /**
  * Command that deletes the sandbox environment.
@@ -76,10 +75,6 @@ export class SandboxDeleteCommand
           }
         }
         return true;
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
       });
   };
 }
diff --git a/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_command.ts b/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_command.ts
@@ -1,5 +1,4 @@
 import { Argv, CommandModule } from 'yargs';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 /**
  * Root command to manage sandbox secret.
@@ -35,12 +34,6 @@ export class SandboxSecretCommand implements CommandModule<object> {
    * @inheritDoc
    */
   builder = (yargs: Argv): Argv => {
-    return yargs
-      .command(this.secretSubCommands)
-      .help()
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+    return yargs.command(this.secretSubCommands).help();
   };
 }
diff --git a/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_get_command.ts b/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_get_command.ts
@@ -3,7 +3,6 @@ import { SecretClient } from '@aws-amplify/backend-secret';
 import { SandboxBackendIdResolver } from '../sandbox_id_resolver.js';
 import { Printer } from '@aws-amplify/cli-core';
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 /**
  * Command to get sandbox secret.
@@ -53,11 +52,7 @@ export class SandboxSecretGetCommand
         type: 'string',
         demandOption: true,
       })
-      .help()
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+      .help();
   };
 }
 
diff --git a/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_remove_command.ts b/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_remove_command.ts
@@ -2,7 +2,6 @@ import { Argv, CommandModule } from 'yargs';
 import { SecretClient } from '@aws-amplify/backend-secret';
 import { SandboxBackendIdResolver } from '../sandbox_id_resolver.js';
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 /**
  * Command to remove sandbox secret.
@@ -46,16 +45,11 @@ export class SandboxSecretRemoveCommand
    * @inheritDoc
    */
   builder = (yargs: Argv): Argv<SecretRemoveCommandOptions> => {
-    return yargs
-      .positional('secret-name', {
-        describe: 'Name of the secret to remove',
-        type: 'string',
-        demandOption: true,
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+    return yargs.positional('secret-name', {
+      describe: 'Name of the secret to remove',
+      type: 'string',
+      demandOption: true,
+    });
   };
 }
 
diff --git a/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_set_command.ts b/packages/cli/src/commands/sandbox/sandbox-secret/sandbox_secret_set_command.ts
@@ -4,7 +4,6 @@ import { SandboxBackendIdResolver } from '../sandbox_id_resolver.js';
 import { AmplifyPrompter } from '@aws-amplify/cli-core';
 
 import { ArgumentsKebabCase } from '../../../kebab_case.js';
-import { handleCommandFailure } from '../../../command_failure_handler.js';
 
 /**
  * Command to set sandbox secret.
@@ -49,16 +48,11 @@ export class SandboxSecretSetCommand
    * @inheritDoc
    */
   builder = (yargs: Argv): Argv<SecretSetCommandOptions> => {
-    return yargs
-      .positional('secret-name', {
-        describe: 'Name of the secret to set',
-        type: 'string',
-        demandOption: true,
-      })
-      .fail((msg, err) => {
-        handleCommandFailure(msg, err, yargs);
-        yargs.exit(1, err);
-      });
+    return yargs.positional('secret-name', {
+      describe: 'Name of the secret to set',
+      type: 'string',
+      demandOption: true,
+    });
   };
 }
 
diff --git a/packages/cli/src/commands/sandbox/sandbox_command.ts b/packages/cli/src/commands/sandbox/sandbox_command.ts
@@ -7,7 +7,6 @@ import {
   getClientConfigPath,
 } from '@aws-amplify/client-config';
 import { ArgumentsKebabCase } from '../../kebab_case.js';
-import { handleCommandFailure } from '../../command_failure_handler.js';
 import { ClientConfigLifecycleHandler } from '../../client-config/client_config_lifecycle_handler.js';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import { CommandMiddleware } from '../../command_middleware.js';
@@ -180,10 +179,6 @@ export class SandboxCommand
           return true;
         })
         .middleware([this.commandMiddleware.ensureAwsCredentialAndRegion])
-        .fail((msg, err) => {
-          handleCommandFailure(msg, err, yargs);
-          yargs.exit(1, err);
-        })
     );
   };
 
diff --git a/packages/cli/src/error_handler.test.ts b/packages/cli/src/error_handler.test.ts
diff --git a/packages/cli/src/error_handler.ts b/packages/cli/src/error_handler.ts
diff --git a/packages/cli/src/main_parser_factory.test.ts b/packages/cli/src/main_parser_factory.test.ts
diff --git a/packages/cli/src/main_parser_factory.ts b/packages/cli/src/main_parser_factory.ts
diff --git a/packages/cli/src/test-utils/command_runner.ts b/packages/cli/src/test-utils/command_runner.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@aws-amplify/backend-cli': patch
 +---
++
 +gracefully handle errors that occur during a process event handler