Skip to content
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.

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

fix(cloudformation-diff): string.replace error on cdk context (#2854) #2870

Merged
merged 1 commit into from
Jun 14, 2019
Merged

fix(cloudformation-diff): string.replace error on cdk context (#2854) #2870

merged 1 commit into from
Jun 14, 2019

Conversation

michaelmoussa
Copy link
Contributor

@michaelmoussa michaelmoussa commented Jun 13, 2019

Fixes #2854

@aws-sdk/cloudformation-diff depended on version ^2.1.1 of the string-width library in v0.28.0 of aws-sdk. In v0.29.0, the dependency was bumped to ^4.1.0, which inadvertently broke the cdk context command as reported in: #2854.

The current version of string-width executes a string replacement, which ends up failing when a non-string (such as the int row numbers of the cdk context values). This did not previously occur, as the typecheck for string would cause the function to return early and report zero-length.

The easiest solution here is to cast these values to string, which has the beneficial side effect of ensuring that their character lengths are taken into consideration rather than being defaulted to 0 as they had previously been.


re: PR checklist, I would need some assistance with the Testing, as I don't have a fully provisioned local development environment for CDK available. Title and Description is all set, though, and Docs / Sensitive Modules are not applicable here.


Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

`@aws-sdk/cloudformation-diff` depended on version `^2.1.1` of the `string-width`
library in `v0.28.0` of `aws-sdk`. In `v0.29.0`, the dependency was bumped to
`^4.1.0`, which inadvertently broke the `cdk context` command as reported
in: #2854.

The current version of `string-width` executes a [string replacement](sindresorhus/string-width@0bc308a#diff-168726dbe96b3ce427e7fedce31bb0bcR7), which ends up failing
when a non-string (such as the `int` row numbers of the `cdk context`
values). This did not previously occur, as the typecheck for `string`
would cause the function to return early and report zero-length.

The easiest solution here is to cast these values to `string`, which
has the beneficial side effect of ensuring that their character lengths
are taken into consideration rather than being defaulted to `0` as they
had previously been.
@michaelmoussa michaelmoussa requested a review from a team as a code owner June 13, 2019 20:37
@RomainMuller
Copy link
Contributor

Nice catch! Thank you for this contribution!

@RomainMuller RomainMuller merged commit b8a1c8e into aws:master Jun 14, 2019
@RomainMuller RomainMuller added bug This issue is a bug. @aws-cdk/core Related to core CDK functionality labels Jun 14, 2019
This was referenced Dec 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/core Related to core CDK functionality bug This issue is a bug.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cdk context returns "string.replace is not a function"
2 participants