feat(events): complex event pattern matching with the `Match` class #21310

otaviomacedo · 2022-07-25T10:38:47Z

The current API restricts event pattern matchers to arrays of strings, which do not cover all the functionality available for EventBridge patterns.

Add a new matcher API that gets translated to the low-level JSON pattern matchers, to be consumed by EventBridge. This high-level API also adds:

Better ergonomics: users don’t have to remember where to use curly or square brackets; 'OR' and 'AND' conditions (where applicable) are clearly indicated.
Aliases/syntax sugar: ipAddressRange(), anythingButPrefix() and interval() hide some of the lower level complexity.
Validation: you can’t pass an invalid IP address range, or an interval with lower and upper bounds swapped, or empty lists of conditions.

Resolves #20486, resolves #13330.

All Submissions:

Have you followed the guidelines in our Contributing guide?

Adding new Unconventional Dependencies:

This PR adds new unconventional dependencies following the process described here

New Features

Have you added the new feature to an integration test?
- Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

gitpod-io · 2022-07-25T10:38:53Z

rix0rrr

Nice! I love this! Just need to find a different way to encode the matchers... via tokens maybe?

rix0rrr · 2022-07-27T12:29:24Z

packages/@aws-cdk/aws-events/lib/event-pattern.ts

   * @default - No filtering on version
   */
-  readonly version?: string[];
+  readonly version?: string[] | IMatcher;


Avoid using union types in L2 libraries. Even though they work fine in TypeScript, they do not behave well in many of the other languages we target (See Design Guidelines, API Design, Props, Unions).

rix0rrr · 2022-07-27T12:30:02Z

packages/@aws-cdk/aws-events/lib/event-pattern.ts

+/**
+ * A collection of matchers for constructing event patterns
+ */
+export class Matchers {


I think I'd prefer Match as a class name? It'll look nicer in code? As in, Match.anythingBut(...) ?

mrgrain · 2022-07-27T16:03:00Z

@otaviomacedo Is this missing a Matcher for an AND condition? Or is that something the service doesn't support?

otaviomacedo · 2022-08-01T14:27:04Z

@otaviomacedo Is this missing a Matcher for an AND condition? Or is that something the service doesn't support?

There is no general way to represent and AND condition. But there are two special cases:

The list of properties is interpreted as a conjunction: {"foo": ["a"], bar: ["b"]} means that you expect both fields to match.
In numeric patterns, the list of conditions passed to the array is interpreted as conjunction: foo: [{"numeric": [">", 0, "<", 5]}] means that the number should be greater than 0 and less than 5. This is exposed by the Match.allOf() method.

rix0rrr · 2022-08-08T13:17:31Z

packages/@aws-cdk/aws-events/lib/event-pattern.ts

+
+  public readonly creationStack: string[];
+
+  constructor(private readonly matchers: any[],


For current safety, can we make this a private constructor? I don't think I want people calling new Match() directly...

mergify · 2022-08-08T13:20:36Z

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 · 2022-08-08T13:22:53Z

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 · 2022-08-08T14:30:29Z

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 · 2022-08-08T15:42:38Z

AWS CodeBuild CI Report

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

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

mergify · 2022-08-08T15:42:58Z

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

…ws#21310) The current API restricts event pattern matchers to arrays of strings, which do not cover all the functionality available for EventBridge patterns. Add a new matcher API that gets translated to the low-level JSON pattern matchers, to be consumed by EventBridge. This high-level API also adds: * **Better ergonomics**: users don’t have to remember where to use curly or square brackets; 'OR' and 'AND' conditions (where applicable) are clearly indicated. * **Aliases/syntax sugar**: `ipAddressRange()`, `anythingButPrefix()` and `interval()` hide some of the lower level complexity. * **Validation**: you can’t pass an invalid IP address range, or an interval with lower and upper bounds swapped, or empty lists of conditions. Resolves aws#20486, resolves aws#13330. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

otaviomacedo added 2 commits July 25, 2022 10:54

feat(events): Event pattern matchers

dda9ef4

New test case

e38f2ca

github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 labels Jul 25, 2022

aws-cdk-automation requested a review from a team July 25, 2022 10:39

mergify bot added the contribution/core This is a PR that came from AWS. label Jul 25, 2022

otaviomacedo added 3 commits July 25, 2022 15:49

Added integration test

0ca5547

Addressing the case where patterns are null

08e1719

Simplified comparison matchers

aac1669

otaviomacedo removed the bug This issue is a bug. label Jul 26, 2022

github-actions bot added the feature-request A feature should be added or improved. label Jul 26, 2022

rix0rrr requested changes Jul 27, 2022

View reviewed changes

otaviomacedo added 2 commits August 1, 2022 15:14

Pattern matchers encoded as tokens

910f25f

Updated README

a76004e

otaviomacedo requested a review from rix0rrr August 1, 2022 14:27

otaviomacedo added 5 commits August 1, 2022 15:52

Refactoring

332f68b

flatMap() -> flat()

85e2681

flatMap

7af8e7e

Removed superfluous test

b9f4ca7

Removed unused import

be3360b

rix0rrr approved these changes Aug 8, 2022

View reviewed changes

rix0rrr changed the title ~~feat(events): Event pattern matchers~~ feat(events): complex event pattern matching with the Match class Aug 8, 2022

Merge branch 'main' into otaviom/event-pattern-matchers

8d0b5d1

otaviomacedo added the pr/do-not-merge This PR should not be merged at this time. label Aug 8, 2022

Made Match constructor private

40e304e

otaviomacedo removed the pr/do-not-merge This PR should not be merged at this time. label Aug 8, 2022

Merge branch 'main' into otaviom/event-pattern-matchers

da8199c

mergify bot merged commit fe7651f into main Aug 8, 2022

mergify bot deleted the otaviom/event-pattern-matchers branch August 8, 2022 15:42


		public readonly creationStack: string[];

		constructor(private readonly matchers: any[],

feat(events): complex event pattern matching with the Match class #21310

feat(events): complex event pattern matching with the Match class #21310

Uh oh!

Conversation

otaviomacedo commented Jul 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All Submissions:

Adding new Unconventional Dependencies:

New Features

Uh oh!

gitpod-io bot commented Jul 25, 2022

Uh oh!

rix0rrr left a comment

Choose a reason for hiding this comment

Uh oh!

rix0rrr Jul 27, 2022

Choose a reason for hiding this comment

Uh oh!

rix0rrr Jul 27, 2022

Choose a reason for hiding this comment

Uh oh!

mrgrain commented Jul 27, 2022

Uh oh!

otaviomacedo commented Aug 1, 2022

Uh oh!

rix0rrr Aug 8, 2022

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Aug 8, 2022

Uh oh!

mergify bot commented Aug 8, 2022

Uh oh!

mergify bot commented Aug 8, 2022

Uh oh!

aws-cdk-automation commented Aug 8, 2022

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Aug 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(events): complex event pattern matching with the `Match` class #21310

feat(events): complex event pattern matching with the `Match` class #21310

otaviomacedo commented Jul 25, 2022 •

edited

Loading