Add error mapping for Amplify app not found in specified region #2313

vigy02 · 2024-12-09T22:06:09Z

Problem

This error specifically occurs when using the following generate commands with only the --branch option:

npx ampx generate graphql-client-code --branch <branch-name>
npx ampx generate forms --branch <branch-name>
npx ampx generate outputs --branch <branch-name>

When users run these commands with only the --branch parameter and the Amplify app doesn't exist in the current AWS region, they will receive the error message:
"No Amplify app found with name '{appName}' in region '{region}'"

To properly use these commands, users should either:

Include both --app-id and --branch parameters
Ensure they are working in the correct AWS region where their Amplify app exists

For example, the correct usage would be:

npx ampx generate graphql-client-code --branch <branch-name> --app-id <app-id>

Changes

Added a new error mapping for the "Amplify app not found" scenario
Updated backend identifier resolver

Validation & Reproduction Steps

To reproduce the error scenario:

Create an Amplify app in region A (e.g., us-east-1)
Switch to a different region B (e.g., us-west-2)
Run the generate command with just the --branch option in the CLI
The system will now show a clear error message indicating the app doesn't exist in region B

changeset-bot · 2024-12-09T22:06:13Z

🦋 Changeset detected

Latest commit: 31b406a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@aws-amplify/backend-cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/backend-deployer/src/cdk_error_mapper.ts

Amplifiyer · 2024-12-10T11:05:31Z

packages/cli/src/commands/generate/graphql-client-code/generate_graphql_client_code_command.ts

+      const appNotFoundMatch = (error as Error).message.match(
+        /No apps found with name (?<appName>.*) in region (?<region>.*)/
+      );

-    await result.writeToDirectory(out);
+      if (appNotFoundMatch?.groups) {
+        const { appName, region } = appNotFoundMatch.groups;
+        throw new AmplifyUserError('AmplifyAppNotFoundError', {
+          message: `No Amplify app found with name "${appName}" in region "${region}".`,
+          resolution: `Ensure that an Amplify app named "${appName}" exists in the "${region}" region.`,
+        });
+      }


My question is still not answered. How are you able to reproduce this and validate it? I don't see appName as a user input anywhere so not sure how this can be easily categorized as a User Error.
What situation(s) can lead to this error?

I have moved the try-catch wrapper to a common resolver where all the generate command finally lands.I have updated the repro steps in the description. Seems to be happening only if the --branch option is set without the AppID

This is mostly happening in the console (based on the isCI flag in the telemetry) where customers might not be explicitly providing these values and the region should match if customers are using the Amplify Console to download the output file.

Seems to be happening only if the --branch option is set without the AppID

Yes, when only --branch is set, the appName is loaded from the Amplify Service and filtered on the appName which is coming from the packageJson#Name (I think).

This is mostly happening in the console (based on the isCI flag in the telemetry) where customers might not be explicitly providing these values and the region should match if customers are using the Amplify Console to download the output file.

Input Command CI Percentage Non-CI Percentage

UnknownCommand 31.03 68.97

generate graphql-client-code 0 100

generate outputs 56.33 43.67

Its a valid concern, since appName is internally derived. When I tested out in the right region it works every time. When I'm working in the wrong region it fails. So we can safely call it as UserError.
This condition is triggered only when --branch is used with wrong region

Have you tested this in the Console? I understand you can reproduce this in the CLI, but the fact that this issue happens in CI points to the issue could be something else.

Yes I was able to repro this issue on the console side. I edited the amplify.yml and added wrong build command which caused this issue. The changes that I have implemented in the cli package will be able to handle this.

Amplifiyer · 2024-12-10T20:15:10Z

packages/cli/src/backend-identifier/backend_identifier_resolver.ts

+      if (args.stack) {
+        return { stackName: args.stack };
+      } else if (args.appId && args.branch) {
+        return {
+          namespace: args.appId,
+          name: args.branch,
+          type: 'branch',
+        };
+      } else if (args.branch) {
+        const resolvedNamespace = await this.namespaceResolver.resolve();
+        return {
+          appName: resolvedNamespace,
+          branchName: args.branch,
+        };
+      }
+      return undefined;
+    } catch (error) {
+      const appNotFoundMatch = (error as Error).message.match(
+        /No apps found with name (?<appName>.*) in region (?<region>.*)/
+      );
+
+      if (appNotFoundMatch?.groups) {


which line here is throwing the exception that you are catching? Afaik this.namespaceResolver.resolve(); doesn't throw this exception, but this does

amplify-backend/packages/deployed-backend-client/src/stack-name-resolvers/app_name_and_branch_main_stack_name_resolver.ts

Line 42 in 3838849

`No apps found with name ${this.appNameAndBranch.appName} in region ${region}`

as I mentioned in my previous comment #2313 (comment)

The error originates in app_name_and_branch_main_stack_name_resolver.ts. Since we are unable to place AmplifyUserError in the deployed-backend-client, I've moved the error handling to
the CLI layer where the error bubbles up. I've successfully implemented error catching at this level. You can see in the screenshot I've added to the description.

Amplifiyer

this is looking good. Need to add tests as well.

Amplifiyer · 2024-12-12T17:15:46Z

packages/cli/src/commands/generate/graphql-client-code/generate_graphql_client_code_command.ts

+      const appNotFoundMatch = (error as Error).message.match(
+        /No apps found with name (?<appName>.*) in region (?<region>.*)/


Instead of regex matching, we should update the error thrown to have contextual information. E.g. see this example here in the deployed-backend-client package

amplify-backend/packages/deployed-backend-client/src/backend_output_client_factory.ts

Lines 9 to 21 in 3838849

export enum BackendOutputClientErrorType {

METADATA_RETRIEVAL_ERROR = 'MetadataRetrievalError',

NO_OUTPUTS_FOUND = 'NoOutputsFound',

DEPLOYMENT_IN_PROGRESS = 'DeploymentInProgress',

NO_STACK_FOUND = 'NoStackFound',

CREDENTIALS_ERROR = 'CredentialsError',

ACCESS_DENIED = 'AccessDenied',

}

/**

* Error type for BackendOutputClientError

*/

export class BackendOutputClientError extends Error {

public code: BackendOutputClientErrorType;

and usage here 3cf0738#diff-6575515384ffad97860f57f5a6eea59fb54b2813c72d8c610b7c7a8c5cc29258

Amplifiyer · 2024-12-13T19:54:48Z

packages/cli/src/commands/generate/outputs/generate_outputs_command.test.ts

+void describe('GenerateOutputsCommand error handling', () => {
+  let clientConfigGenerator: ClientConfigGeneratorAdapter;
+  let backendIdentifierResolver: AppBackendIdentifierResolver;
+  let generateOutputsCommand: GenerateOutputsCommand;
+
+  beforeEach(() => {
+    // Mock the dependencies
+    clientConfigGenerator = {
+      generateClientConfigToFile: mock.fn(),
+    } as unknown as ClientConfigGeneratorAdapter;
+


Why not use the existing describe that is already doing all the mock setup

Updated it, keeping it consistent
I was planning to create Test suites separate for handling all negative test cases

Amplifiyer · 2024-12-13T19:55:21Z

packages/cli/src/commands/generate/outputs/generate_outputs_command.test.ts

+      await generateOutputsCommand.handler({
+        stack: undefined,
+        appId: 'test-app',
+        'app-id': 'test-app',
+        branch: 'main',
+        format: undefined,
+        outDir: undefined,
+        'out-dir': undefined,
+        outputsVersion: '1.3',
+        'outputs-version': '1.3',
+        _: [],
+        $0: 'command-name',
+      });
+      assert.fail('Expected error was not thrown');


use commandRunner.runCommand as used in other tests.

Amplifiyer · 2024-12-13T19:55:39Z

packages/cli/src/commands/generate/graphql-client-code/generate_graphql_client_code_command.ts

+      await result.writeToDirectory(out);
+    } catch (error) {
+      if (
+        error instanceof BackendOutputClientError &&


As per the lint, don't use instanceof as it might not work if there are multiple versions of DeployedBackendClient package in the node_modules.

Amplifiyer · 2024-12-13T19:56:09Z

...oyed-backend-client/src/stack-name-resolvers/app_name_and_branch_main_stack_name_resolver.ts

+import {
+  BackendOutputClientError,
+  BackendOutputClientErrorType,
+} from '../backend_output_client_factory.js';


BackendOutputClientError is probably not the right error type to use here since based on it's name, it should be used with BackendOutputClient only.

packages/cli/src/commands/generate/outputs/generate_outputs_command.test.ts

vigy02 added 3 commits December 9, 2024 12:39

Added error mapping for app name not found fault

16e96d7

Updated the test case for this fault

f0e0bbe

Updated the mapper and the test case to catch the AppNotFound Error

645e1e0

vigy02 marked this pull request as ready for review December 9, 2024 22:06

vigy02 requested a review from a team as a code owner December 9, 2024 22:06

Amplifiyer reviewed Dec 9, 2024

View reviewed changes

packages/backend-deployer/src/cdk_error_mapper.ts Outdated Show resolved Hide resolved

vigy02 requested a review from a team December 9, 2024 22:10

Updated the code to catch the error app name not available in the region

28a37d6

Amplifiyer reviewed Dec 10, 2024

View reviewed changes

vigy02 added 2 commits December 10, 2024 11:41

Merge branch 'aws-amplify:main' into fix/AppNotFound

afb801e

Updated backend identifier resolver

a2c4031

vigy02 requested a review from Amplifiyer December 10, 2024 19:57

Amplifiyer reviewed Dec 10, 2024

View reviewed changes

vigy02 added 3 commits December 10, 2024 14:57

Updated to handle the No apps found error

a5692a0

Updated generate-graphql command as well to catch the error

6e73f46

reset the backend resolver

33b2ccd

vigy02 requested a review from Amplifiyer December 12, 2024 16:46

Amplifiyer reviewed Dec 12, 2024

View reviewed changes

vigy02 added 3 commits December 13, 2024 10:22

Updated the error code and added test cases to test the error handling

536dad0

chore: Updated the API

eab450f

chore: updated API

b400709

vigy02 requested review from a team as code owners December 13, 2024 18:30

Updated error handling to show the full error details

37b62bb

Amplifiyer reviewed Dec 13, 2024

View reviewed changes

added the unit test cases to the existing test suite

3236c1e

github-advanced-security bot found potential problems Dec 13, 2024

View reviewed changes

packages/cli/src/commands/generate/outputs/generate_outputs_command.test.ts Fixed Show fixed Hide fixed

fixed lint errors

31b406a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add error mapping for Amplify app not found in specified region #2313

Add error mapping for Amplify app not found in specified region #2313

vigy02 commented Dec 9, 2024 •

edited

Loading

changeset-bot bot commented Dec 9, 2024 •

edited

Loading

Amplifiyer Dec 10, 2024

vigy02 Dec 10, 2024

Amplifiyer Dec 10, 2024

vigy02 Dec 10, 2024

vigy02 Dec 11, 2024

Amplifiyer Dec 11, 2024

vigy02 Dec 12, 2024 •

edited

Loading

Amplifiyer Dec 10, 2024

vigy02 Dec 10, 2024

Amplifiyer left a comment

Amplifiyer Dec 12, 2024

vigy02 Dec 13, 2024

Amplifiyer Dec 13, 2024

vigy02 Dec 13, 2024

Amplifiyer Dec 13, 2024

vigy02 Dec 13, 2024

Amplifiyer Dec 13, 2024

Amplifiyer Dec 13, 2024 •

edited

Loading

Input Command	CI Percentage	Non-CI Percentage
UnknownCommand	31.03	68.97
generate graphql-client-code	0	100
generate outputs	56.33	43.67

		const appNotFoundMatch = (error as Error).message.match(
		/No apps found with name (?<appName>.) in region (?<region>.)/

	export enum BackendOutputClientErrorType {
	METADATA_RETRIEVAL_ERROR = 'MetadataRetrievalError',
	NO_OUTPUTS_FOUND = 'NoOutputsFound',
	DEPLOYMENT_IN_PROGRESS = 'DeploymentInProgress',
	NO_STACK_FOUND = 'NoStackFound',
	CREDENTIALS_ERROR = 'CredentialsError',
	ACCESS_DENIED = 'AccessDenied',
	}
	/**
	* Error type for BackendOutputClientError
	*/
	export class BackendOutputClientError extends Error {
	public code: BackendOutputClientErrorType;

Add error mapping for Amplify app not found in specified region #2313

Are you sure you want to change the base?

Add error mapping for Amplify app not found in specified region #2313

Conversation

vigy02 commented Dec 9, 2024 • edited Loading

Problem

Changes

Validation & Reproduction Steps

changeset-bot bot commented Dec 9, 2024 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vigy02 Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amplifiyer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amplifiyer Dec 13, 2024 • edited Loading

Choose a reason for hiding this comment

vigy02 commented Dec 9, 2024 •

edited

Loading

changeset-bot bot commented Dec 9, 2024 •

edited

Loading

vigy02 Dec 12, 2024 •

edited

Loading

Amplifiyer Dec 13, 2024 •

edited

Loading