Skip to content

chore: log error for stackUpdateComplete #13773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 15, 2024
Merged

chore: log error for stackUpdateComplete #13773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3972e9f
chore: log error for stackUpdateComplete
May 10, 2024
31304a8
Revert "chore: log error for stackUpdateComplete"
May 11, 2024
7e18533
chore: log stackUpdateComplete message with errorDetails
May 11, 2024
e725d19
chore: tweak stackUpdateComplete message with errorDetails
May 11, 2024
6ac70a1
Update packages/amplify-provider-awscloudformation/src/aws-utils/aws-…
0618 May 13, 2024
8f59370
chore: import EOL from os
May 13, 2024
30aa596
chore: change printAmplifyException instead of aws-cfn
May 13, 2024
7682b62
Update packages/amplify-cli/src/amplify-exception-handler.ts
0618 May 14, 2024
bcb27aa
chore: import EOL from os
May 14, 2024
0f2375d
test: fix amplify-exception-handler
May 14, 2024
db73695
test: fix amplify-exception-handler
May 15, 2024
63146cf
chore: make test error mock content explicitly different
May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions packages/amplify-cli/src/__tests__/amplify-exception-handler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { EOL } from 'os';
import { AmplifyError } from '@aws-amplify/amplify-cli-core';
import { printer } from '@aws-amplify/amplify-prompts'; // eslint-disable-line import/no-extraneous-dependencies
import { reportError } from '../commands/diagnose';
Expand Down Expand Up @@ -56,30 +57,34 @@ describe('test exception handler', () => {

it('error handler should print error', async () => {
const amplifyError = new AmplifyError('NotImplementedError', {
message: 'Test Not implemented',
details: 'Test Not implemented',
resolution: 'Test Not implemented',
message: 'Test Not implemented(message)',
details: 'Test Not implemented(details)',
resolution: 'Test Not implemented(resolution)',
});

await handleException(amplifyError);

expect(printerMock.error).toHaveBeenCalledWith(amplifyError.message);
expect(printerMock.info).toHaveBeenCalledWith(amplifyError.details);
expect(printerMock.error).toHaveBeenCalledWith(`${amplifyError.message}${EOL}${amplifyError.details}`);
expect(printerMock.info).toHaveBeenCalledTimes(2);
expect(printerMock.info).toHaveBeenNthCalledWith(1, `Resolution: ${amplifyError.resolution}`);
expect(printerMock.info).toHaveBeenLastCalledWith('Learn more at: https://docs.amplify.aws/cli/project/troubleshooting/');
expect(printerMock.debug).toHaveBeenCalledWith(amplifyError.stack);
});

it('error handler should handle encountered errors gracefully', async () => {
const amplifyError = new AmplifyError('NotImplementedError', {
message: 'Test Not implemented',
details: 'Test Not implemented',
resolution: 'Test Not implemented',
message: 'Test Not implemented(message)',
details: 'Test Not implemented(details)',
resolution: 'Test Not implemented(resolution)',
});

reportErrorMock.mockRejectedValueOnce(new Error('MockTestError'));
await handleException(amplifyError);

expect(printerMock.error).toHaveBeenCalledWith(amplifyError.message);
expect(printerMock.info).toHaveBeenCalledWith(amplifyError.details);
expect(printerMock.error).toHaveBeenCalledWith(`${amplifyError.message}${EOL}${amplifyError.details}`);
expect(printerMock.info).toHaveBeenCalledTimes(2);
expect(printerMock.info).toHaveBeenNthCalledWith(1, `Resolution: ${amplifyError.resolution}`);
expect(printerMock.info).toHaveBeenLastCalledWith('Learn more at: https://docs.amplify.aws/cli/project/troubleshooting/');
expect(printerMock.debug).toHaveBeenCalledWith(amplifyError.stack);
expect(printerMock.error).toHaveBeenCalledWith('Failed to report error: MockTestError');
});
Expand Down
7 changes: 4 additions & 3 deletions packages/amplify-cli/src/amplify-exception-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { EOL } from 'os';
import {
$TSAny,
AmplifyException,
Expand Down Expand Up @@ -123,10 +124,10 @@ const executeSafely = async (functionToExecute: () => Promise<void> | void, erro

const printAmplifyException = (amplifyException: AmplifyException): void => {
const { message, details, resolution, link, stack } = amplifyException;

printer.error(message);
if (details) {
printer.info(details);
printer.error(message + EOL + details);
} else {
printer.error(message);
}
printer.blankLine();
if (resolution) {
Expand Down