Amazon Q: Added telemetry metrics and modified customer facing messages for Q Codescans. #4951
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ctlai95
reviewed
May 8, 2024
laileni-aws
changed the title
ctlai95
reviewed
May 9, 2024
packages/toolkit/.changes/next-release/Bug Fix-ebe770da-054d-43e7-8141-cd32b6159e3e.json
Outdated
Show resolved
Hide resolved
packages/toolkit/.changes/next-release/Bug Fix-ebe770da-054d-43e7-8141-cd32b6159e3e.json
Outdated
Show resolved
Hide resolved
ctlai95
approved these changes
May 9, 2024
justinmk3
reviewed
May 12, 2024
| CodeScanJobFailedError = 'CodeScanJobFailedError', | ||
| } | ||
|
|
||
| export const mapErrorToCustomerFacingMessage: Record<ErrorCodes, string> = { |
There was a problem hiding this comment.
why not just store the "customer facing message" on the error? there is way too much over-abstraction and indirection in this PR
justinmk3
reviewed
May 12, 2024
| } | ||
| } | ||
|
|
||
| export class ProjectSizeExceededError extends ToolkitError { |
There was a problem hiding this comment.
you are creating custom classes for every error, yet not using the features of a class. the class could store the "customer facing message", and possibly could also avoid the enums and "mapping" indirection
There was a problem hiding this comment.
Created a new SecurityScanError class which extends ToolkitError to add a new field customerFacingMessage. This will work without ErrorCodes enum and mapErrorToCustomerFacingMessage.
ctlai95
approved these changes
May 13, 2024
justinmk3
reviewed
May 13, 2024
Comment on lines
+297
to
+300
| export const DefaultCodeScanErrorMessage = | ||
| 'Amazon Q encountered an error while scanning for security issues. Try again later.' | ||
|
|
||
| export const FileSizeExceededErrorMessage = `Amazon Q: The selected file exceeds the input artifact limit. Try again with a smaller file. For more information about scan limits, see the [Amazon Q documentation](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/security-scans.html#quotas).` |
There was a problem hiding this comment.
these could be stored directly on the Error classes.
justinmk3
approved these changes
May 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Solution
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.