chore: deprecate @aws-cdk/yaml-cfn
#14001
Merged
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
`aws-cdk-lib` needs to have no dependencies (except for `constructs`), and we don't want to support this package as part of its public API. Therefore, it needs to be bundled into all packages that consume it. NPM has a bug that makes it impossible to `bundledDependencies` a package that is linked from the monorepo. We tried to work around that bug but it blocked our build because the `.tgz` is sometimes not available during the `postpack` phase (#13933). Simplest way around this now is to just copy/paste the implementation of `yaml-cfn` 3 times. Should we ever need to bundle monorepo dependencies again in the future, we can try to revive the `postpack` solution of #13933.
|
|
nija-at
reviewed
Apr 6, 2021
| * @param obj the data structure to serialize | ||
| * @returns a string containing the YAML representation of {@param obj} | ||
| */ | ||
| export function serialize(obj: any): string { |
There was a problem hiding this comment.
How about moving this to 'core' and reduce the dupes?
There was a problem hiding this comment.
CLI still cannot depend on core so doesn't help that much.
Also it should not be part of the public API, this package is/was an implementation detail.
There was a problem hiding this comment.
(not a strong opinion but) put it in cx-api but not export it? Usage would be -
import * as yaml_cfn from '@aws-cdk/cx-api/yaml-cfn'
There was a problem hiding this comment.
We have tricks/hacks for making things in core not public. See cfn-parse.ts, for example.
nija-at
approved these changes
Apr 6, 2021
| * @param obj the data structure to serialize | ||
| * @returns a string containing the YAML representation of {@param obj} | ||
| */ | ||
| export function serialize(obj: any): string { |
There was a problem hiding this comment.
(not a strong opinion but) put it in cx-api but not export it? Usage would be -
import * as yaml_cfn from '@aws-cdk/cx-api/yaml-cfn'
skinny85
reviewed
Apr 6, 2021
Comment on lines
21
to
59
| /** | ||
| * Deserialize the YAML into the appropriate data structure. | ||
| * | ||
| * @param str the string containing YAML | ||
| * @returns the data structure the YAML represents | ||
| * (most often in case of CloudFormation, an object) | ||
| */ | ||
| export function deserialize(str: string): any { | ||
| return parseYamlStrWithCfnTags(str); | ||
| } | ||
|
|
||
| function makeTagForCfnIntrinsic(intrinsicName: string, addFnPrefix: boolean): yaml_types.Schema.CustomTag { | ||
| return { | ||
| identify(value: any) { return typeof value === 'string'; }, | ||
| tag: `!${intrinsicName}`, | ||
| resolve: (_doc: yaml.Document, cstNode: yaml_cst.CST.Node) => { | ||
| const ret: any = {}; | ||
| ret[addFnPrefix ? `Fn::${intrinsicName}` : intrinsicName] = | ||
| // the +1 is to account for the ! the short form begins with | ||
| parseYamlStrWithCfnTags(cstNode.toString().substring(intrinsicName.length + 1)); | ||
| return ret; | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| const shortForms: yaml_types.Schema.CustomTag[] = [ | ||
| 'Base64', 'Cidr', 'FindInMap', 'GetAZs', 'ImportValue', 'Join', 'Sub', | ||
| 'Select', 'Split', 'Transform', 'And', 'Equals', 'If', 'Not', 'Or', 'GetAtt', | ||
| ].map(name => makeTagForCfnIntrinsic(name, true)).concat( | ||
| makeTagForCfnIntrinsic('Ref', false), | ||
| makeTagForCfnIntrinsic('Condition', false), | ||
| ); | ||
|
|
||
| function parseYamlStrWithCfnTags(text: string): any { | ||
| return yaml.parse(text, { | ||
| customTags: shortForms, | ||
| schema: 'core', | ||
| }); | ||
| } |
There was a problem hiding this comment.
Since we only use serialize in CodeBuild, let's maybe remove all this?
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Closed
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
`aws-cdk-lib` needs to have no dependencies (except for `constructs`), and we don't want to support this package as part of its public API. Therefore, it needs to be bundled into all packages that consume it. NPM has a bug that makes it impossible to `bundledDependencies` a package that is linked from the monorepo. We tried to work around that bug but it blocked our build because the `.tgz` is sometimes not available during the `postpack` phase (aws#13933). Simplest way around this now is to just copy/paste the implementation of `yaml-cfn` 3 times. Should we ever need to bundle monorepo dependencies again in the future, we can try to revive the `postpack` solution of aws#13933. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
aws-cdk-libneeds to have no dependencies (except forconstructs),and we don't want to support this package as part of its public API.
Therefore, it needs to be bundled into all packages that consume it.
NPM has a bug that makes it impossible to
bundledDependenciesapackage that is linked from the monorepo.
We tried to work around that bug but it blocked our build because the
.tgzis sometimes not available during thepostpackphase (#13933).Simplest way around this now is to just copy/paste the implementation
of
yaml-cfn3 times. Should we ever need to bundle monorepodependencies again in the future, we can try to revive the
postpacksolution of #13933.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license