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(assertions): object partiality is dropped passing through arrays #18525

Merged
merged 2 commits into from
Jan 19, 2022

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Jan 19, 2022

objectLike() imposes partial object matching. That means that we don't
need to fully specify all properties of an object to match it, but
just the properties we care about (all other properties can have any
value).

Partial object matching is inherited. That means that in nested
objects, the partiality is maintained:

objectLike({
  x: 'x',
  inner: {
    // Matches any object that has AT LEAST an 'y' property
    y: 'y',
  }
})

However, the partiality is dropped when passing through arrays:

objectLike({
  x: 'x',
  inner: [
    {
      // Matches any object that has ONLY an 'y' property
      y: 'y',
    }
  ],
})

This is both unintuitive and different from past behavior, which makes
migrating tests unnecessarily hard.

Fix the discrepancy.


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

`objectLike()` imposes partial object matching. That means that we don't
need to fully specify all properties of an object to match it, but
just the properties we care about (all other properties can have any
value).

Partial object matching is inherited. That means that in nested
objects, the partiality is maintained:

```ts
objectLike({
  x: 'x',
  inner: {
    // Matches any object that has AT LEAST an 'y' property
    y: 'y',
  }
})
```

However, the partiality is dropped when passing through arrays:

```ts
objectLike({
  x: 'x',
  inner: [
    {
      // Matches any object that has ONLY an 'y' property
      y: 'y',
    }
  ],
})
```

This is both unintuitive and different from past behavior, which makes
migrating tests unnecessarily hard.

Fix the discrepancy.
@rix0rrr rix0rrr requested a review from a team January 19, 2022 09:58
@rix0rrr rix0rrr self-assigned this Jan 19, 2022
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 19, 2022
@github-actions github-actions bot added the @aws-cdk/assertions Related to the @aws-cdk/assertv2 package label Jan 19, 2022
Copy link
Contributor

@otaviomacedo otaviomacedo left a comment

Choose a reason for hiding this comment

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

Thanks!

@mergify
Copy link
Contributor

mergify bot commented Jan 19, 2022

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).

@gitpod-io
Copy link

gitpod-io bot commented Jan 19, 2022

@mergify mergify bot merged commit eb29e6f into master Jan 19, 2022
@mergify mergify bot deleted the huijbers/assertions-partial branch January 19, 2022 17:55
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 581f6a0
  • 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 Jan 19, 2022

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).

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
…ws#18525)

`objectLike()` imposes partial object matching. That means that we don't
need to fully specify all properties of an object to match it, but
just the properties we care about (all other properties can have any
value).

Partial object matching is inherited. That means that in nested
objects, the partiality is maintained:

```ts
objectLike({
  x: 'x',
  inner: {
    // Matches any object that has AT LEAST an 'y' property
    y: 'y',
  }
})
```

However, the partiality is dropped when passing through arrays:

```ts
objectLike({
  x: 'x',
  inner: [
    {
      // Matches any object that has ONLY an 'y' property
      y: 'y',
    }
  ],
})
```

This is both unintuitive and different from past behavior, which makes
migrating tests unnecessarily hard.

Fix the discrepancy.


----

*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
@aws-cdk/assertions Related to the @aws-cdk/assertv2 package contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants