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.

Sign up for GitHub

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

Jump to bottom

fix(core): allow embedding condition expression as strings #2007

Merged
merged 1 commit into from
Mar 13, 2019
Merged

fix(core): allow embedding condition expression as strings #2007

merged 1 commit into from
Mar 13, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Mar 13, 2019 •
edited
Loading

Expose the underlying toString in the IConditionExpression interface
so they can be embedded as string values in jsii languages.

Fixes #1984

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
  • Title and Description
    • Change type: title prefixed with fix, feat 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.

fix(core): allow embedding condition expression as strings
c0ec23e 
Expose the underlying `toString` in the `IConditionExpression` interface
so they can be embedded as string values in jsii languages.

Fixes #1984
@eladb eladb requested a review from a team as a code owner March 13, 2019 06:51
@eladb eladb mentioned this pull request Mar 13, 2019
Closed
rix0rrr
rix0rrr reviewed Mar 13, 2019
View reviewed changes
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not implicitly expose toString() for all objects, like is true in Java?

@eladb
Copy link
Contributor Author

eladb commented Mar 13, 2019

Why not implicitly expose toString() for all objects, like is true in Java?

That's a good point. I will follow up with a PR in jsii to address this: aws/jsii#380

I still think it makes sense to call this out here explicitly given the string tokensization behavior, no?

@rix0rrr
Copy link
Contributor

rix0rrr commented Mar 13, 2019

I suppose

@eladb eladb merged commit 6afa87f into master Mar 13, 2019
@eladb eladb deleted the benisrae/fix-condition-expression-string branch March 13, 2019 08:28
RomainMuller
RomainMuller reviewed Mar 13, 2019
View reviewed changes
packages/@aws-cdk/cdk/lib/cloudformation/condition.ts
* "just work" since conditions are eventually tokens that implement `toString`,
* in order for jsii languages like Java to proxy this to jsii.
*/
toString(): string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this instead have extended some IToken interface? I wonder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#79

@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

This was referenced Dec 12, 2019
Closed
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RomainMuller RomainMuller RomainMuller left review comments

@rix0rrr rix0rrr rix0rrr approved these changes

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fn.conditionIf(...).toString() fails to serialize in Java
4 participants
@eladb @rix0rrr @RomainMuller @NGL321