refactor(toolkit): resource metadata #243
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import { ArtifactMetadataEntryType, type MetadataEntry } from '@aws-cdk/cloud-assembly-schema'; | ||
| import type { CloudFormationStackArtifact } from '@aws-cdk/cx-api'; | ||
|
|
||
| /** | ||
| * Metadata entry for a resource within a CloudFormation stack | ||
| */ | ||
| export interface ResourceMetadata { | ||
| /** | ||
| * The resource's metadata as declared in the cloud assembly | ||
| */ | ||
| readonly entry: MetadataEntry; | ||
| /** | ||
| * The construct path of the resource | ||
| */ | ||
| readonly constructPath: string; | ||
| } | ||
|
|
||
| /** | ||
| * Attempts to read metadata for resources from a CloudFormation stack artifact | ||
| * | ||
| * @param stack The CloudFormation stack to read from | ||
| * @param logicalId The logical ID of the resource to read | ||
| * | ||
| * @returns The resource metadata, or undefined if the resource was not found | ||
| */ | ||
| export function resourceMetadata(stack: CloudFormationStackArtifact, logicalId: string): ResourceMetadata | undefined { | ||
| const metadata = stack.manifest?.metadata; | ||
| if (!metadata) { | ||
| return undefined; | ||
| } | ||
|
|
||
| for (const path of Object.keys(metadata)) { | ||
| const entry = metadata[path] | ||
| .filter((e) => e.type === ArtifactMetadataEntryType.LOGICAL_ID) | ||
| .find((e) => e.data === logicalId); | ||
| if (entry) { | ||
| return { | ||
| entry, | ||
| constructPath: simplifyConstructPath(path, stack.stackName), | ||
| }; | ||
| } | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| function simplifyConstructPath(path: string, stackName: string) { | ||
| path = path.replace(/\/Resource$/, ''); | ||
| path = path.replace(/^\//, ''); // remove "/" prefix | ||
|
|
||
| // remove "<stack-name>/" prefix | ||
| if (stackName) { | ||
| if (path.startsWith(stackName + '/')) { | ||
| path = path.slice(stackName.length + 1); | ||
| } | ||
| } | ||
| return path; | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
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 assume by the way you are "enforcing" this that these are not meant to be strongly enforced at all, and will rely on our attention to detail to ensure we follow.
i feel like we are getting to the point where these rules may be hard to get right when we eventually introduce new message codes.