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(iam): conditions parameters accept array values #21009

Merged
merged 6 commits into from
Jul 8, 2022

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Jul 6, 2022

Because of the type declaration of Conditions, which was { [key: string]: any }, and the way TypeScript interprets any, it was possible to pass arrays in where maps/objects were expected.

Change the type of Condition to unknown, which makes the type of Conditions == { [key: string]: unknown }. This makes TypeScript no longer accept arrays where objects were expected.

Would love loved to make the type of Condition == { [key: string]: unknown } as well to be even tighter, but apparently we rely on being able to pass CfnJson in where a condition goes, which is an object.

Closes #20974.


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

Because of the type declaration of `Conditions`, which was `{ [key:
string}: any }`, and the way TypeScript interprets `any`, it was
possible to pass arrays in where maps/objects were expected.

Tighten up the type, which is now possible because of a change in jsii.

Closes #20974.
@rix0rrr rix0rrr requested a review from a team July 6, 2022 08:37
@rix0rrr rix0rrr self-assigned this Jul 6, 2022
@gitpod-io
Copy link

gitpod-io bot commented Jul 6, 2022

@github-actions github-actions bot added bug This issue is a bug. p2 labels Jul 6, 2022
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jul 6, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team July 6, 2022 08:38
// need to emit the type as `Map<String, ? extends Object>`.
//
// Feature request in https://github.com/aws/jsii/issues/1517
export type Condition = Record<string, unknown>;
Copy link
Contributor

Choose a reason for hiding this comment

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

This has all my non-full-context alarms blaring: is this a victimless change of 1 line, no dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should have been, but it doesn't work.

@rix0rrr rix0rrr added the pr-linter/exempt-test The PR linter will not require test changes label Jul 7, 2022
@github-actions github-actions bot added effort/small Small work item – less than a day of effort p1 and removed p2 labels Jul 7, 2022
@rix0rrr rix0rrr requested a review from a team July 7, 2022 13:18
mrgrain
mrgrain previously requested changes Jul 7, 2022
packages/@aws-cdk/aws-iam/lib/policy-statement.ts Outdated Show resolved Hide resolved
@rix0rrr rix0rrr requested a review from a team July 8, 2022 08:34
@mrgrain mrgrain dismissed their stale review July 8, 2022 10:54

Request Change addressed.

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

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

Looking good now!

@mergify
Copy link
Contributor

mergify bot commented Jul 8, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 23ecf19
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Jul 8, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 0aad6c9 into main Jul 8, 2022
@mergify mergify bot deleted the huijbers/conditions-type branch July 8, 2022 13:01
daschaa pushed a commit to daschaa/aws-cdk that referenced this pull request Jul 9, 2022
Because of the type declaration of `Conditions`, which was `{ [key: string]: any }`, and the way TypeScript interprets `any`, it was possible to pass arrays in where maps/objects were expected.

Change the type of `Condition` to `unknown`, which makes the type of `Conditions == { [key: string]: unknown }`. This makes TypeScript no longer accept arrays where objects were expected.

Would love loved to make the type of `Condition == { [key: string]: unknown }` as well to be even tighter, but apparently we rely on being able to pass `CfnJson` in where a condition goes, which is an object.

Closes aws#20974.


----

*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
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort p1 pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(iam): principal conditions are not type-checked correctly
4 participants