[DevTools] PR2: Backend Services, Console Viewer, and Resources #2879
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| '@aws-amplify/sandbox': minor | ||
| '@aws-amplify/backend-cli': minor | ||
| '@aws-amplify/backend-deployer': patch | ||
| '@aws-amplify/ai-constructs': patch | ||
| --- | ||
|
|
||
| Devtools PR2 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| /** | ||
| * Creates a friendly name for a resource, using CDK metadata when available. | ||
| * @param logicalId The logical ID of the resource | ||
| * @param metadata Optional CDK metadata that may contain construct path | ||
| * @param metadata.constructPath Optional construct path from CDK metadata | ||
| * @returns A user-friendly name for the resource | ||
| */ | ||
| export const createFriendlyName = ( | ||
|
There was a problem hiding this comment. Borderline arcane incantations herein. Partially cp-ing a comment from below. Examples in docstrings will help future maintainers. There was a problem hiding this comment. Thank-you! Probably goes without saying, but explicit test coverage would also be ideal. Unless I'm overlooking it, just a small set of examples like you have here in a test loop would be good. |
||
| logicalId: string, | ||
| metadata?: { constructPath?: string }, | ||
| ): string => { | ||
| // If we have CDK metadata with a construct path, use it | ||
| if (metadata?.constructPath) { | ||
| return normalizeCDKConstructPath(metadata.constructPath); | ||
| } | ||
|
|
||
| // For CloudFormation stacks, try to extract a friendly name | ||
| if ( | ||
| logicalId.includes('NestedStack') || | ||
| logicalId.endsWith('StackResource') | ||
| ) { | ||
| const nestedStackName = getFriendlyNameFromNestedStackName(logicalId); | ||
| if (nestedStackName) { | ||
| return nestedStackName; | ||
| } | ||
| } | ||
|
|
||
| // Fall back to the basic transformation | ||
| let name = logicalId.replace(/^amplify/, '').replace(/^Amplify/, ''); | ||
| name = name.replace(/([A-Z])/g, ' $1').trim(); | ||
| name = name.replace(/[0-9]+[A-Z]*[0-9]*/, ''); | ||
|
|
||
| return name || logicalId; | ||
| }; | ||
|
|
||
| /** | ||
| * Normalizes a CDK construct path to create a more readable friendly name | ||
| * @param constructPath The CDK construct path | ||
| * @returns A normalized construct path | ||
| */ | ||
| const normalizeCDKConstructPath = (constructPath: string): string => { | ||
|
There was a problem hiding this comment. This seems duplicated from here We should see if we can refactor There was a problem hiding this comment. pulled that function out and exported it to get rid of duplication. |
||
| // Don't process very long paths to avoid performance issues | ||
| if (constructPath.length > 1000) return constructPath; | ||
|
|
||
| // Handle nested stack paths | ||
| const nestedStackRegex = | ||
| /(?<nestedStack>[a-zA-Z0-9_]+)\.NestedStack\/\1\.NestedStackResource$/; | ||
|
|
||
| return constructPath | ||
| .replace(nestedStackRegex, '$<nestedStack>') | ||
| .replace('/amplifyAuth/', '/') | ||
| .replace('/amplifyData/', '/'); | ||
| }; | ||
|
|
||
| /** | ||
| * Extracts a friendly name from a nested stack logical ID | ||
| * @param stackName The stack name to process | ||
| * @returns A friendly name or undefined if no match | ||
| */ | ||
| const getFriendlyNameFromNestedStackName = ( | ||
| stackName: string, | ||
| ): string | undefined => { | ||
| const parts = stackName.split('-'); | ||
|
|
||
| if (parts && parts.length === 7 && parts[3] === 'sandbox') { | ||
| return parts[5].slice(0, -10) + ' stack'; | ||
| } else if (parts && parts.length === 5 && parts[3] === 'sandbox') { | ||
| return 'root stack'; | ||
| } | ||
|
|
||
| return undefined; | ||
| }; | ||
|
There was a problem hiding this comment. A good habit when baking arcane splits and magic numbers into a function like this is to show an example or two of the before/after in the docstring. If there is a good name you can give to the magic constants here, give them names. Else, it's helpful to indicate where they come from in the docstring examples. In this case, the naming patterns might be completely obvious to others in the codebase. But, if someone new (it's always Day 1, right?) jumps in at this point, examples will help. Leaving this comment on this particularly arcane looking set of manipulations. But, please apply anywhere you feel arcane incantations are being performed. There was a problem hiding this comment. got it. actually figured out how to actually get non-null metadata which eliminates the need for some of these functions. but examples have been added in the remaining functions where I felt it was needed. |
||
|
|
||
| /** | ||
| * Clean ANSI escape codes from text | ||
| * @param text The text to clean | ||
| * @returns The cleaned text | ||
| */ | ||
| export const cleanAnsiCodes = (text: string): string => { | ||
| // Split the regex into parts to avoid control characters | ||
| const ansiEscapeCodesPattern = new RegExp( | ||
| [ | ||
| // ESC [ n ; n ; ... m | ||
| String.fromCharCode(27) + '\\[\\d+(?:;\\d+)*m', | ||
| // Other common ANSI sequences | ||
| '\\[2m', | ||
| '\\[22m', | ||
| '\\[1m', | ||
| '\\[36m', | ||
| '\\[39m', | ||
| ].join('|'), | ||
| 'g', | ||
| ); | ||
|
|
||
| return text.replace(ansiEscapeCodesPattern, ''); | ||
| }; | ||
|
There was a problem hiding this comment. What's functionally different about this cleaner and the one below? There was a problem hiding this comment. already resolved in commit 87fa132 (duplicate from trimming down PR) |
||
|
|
||
| /** | ||
| * Check if a message is a deployment progress message | ||
| * @param message The message to check | ||
| * @returns True if the message is a deployment progress message | ||
| */ | ||
| export const isDeploymentProgressMessage = (message: string): boolean => { | ||
| const cleanedMessage = cleanAnsiCodes(message); | ||
| return ( | ||
| cleanedMessage.includes('_IN_PROGRESS') || | ||
| cleanedMessage.includes('CREATE_') || | ||
| cleanedMessage.includes('DELETE_') || | ||
| cleanedMessage.includes('UPDATE_') || | ||
| cleanedMessage.includes('Deployment in progress') || | ||
| cleanedMessage.includes('COMPLETE') || | ||
| cleanedMessage.includes('FAILED') || | ||
|
There was a problem hiding this comment. Wouldn't mind seeing something like this if it speaks to you: [
'_IN_PROGRESS',
'CREATE_',
'DELETE_',
'UPDATE_',
'Deployment in progress',
'COMPLETE',
'FAILED'
].some(pattern => cleanedMessage.includes(pattern))But, with room for opinion here, so adopt only if it really speaks to you. |
||
| // Match CloudFormation resource status patterns | ||
| /\d+:\d+:\d+\s+[AP]M\s+\|\s+[A-Z_]+\s+\|\s+.+\s+\|\s+.+/.test( | ||
|
There was a problem hiding this comment. This one's a bit arcane for me. Examples please. There was a problem hiding this comment. got it. this actually belongs in a different PR, so I'm getting rid of it here. |
||
| cleanedMessage, | ||
| ) | ||
| ); | ||
| }; | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still see these upgrades for some aws-sdk clients. We should avoid this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops. missed that. fixed now!