feat(iotevents): support transition events #18768

yamatatsu · 2022-02-01T15:45:34Z

This PR allow IoT Events detector model to transit to multiple states.
This PR is in roadmap of #17711.

Following image is the graph displayed on AWS console when this integ test deployed. Compared to the previous version, you can see that the state transitions are now represented.

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

gitpod-io · 2022-02-01T15:45:37Z

packages/@aws-cdk/aws-iotevents/README.md

packages/@aws-cdk/aws-iotevents/lib/event.ts

packages/@aws-cdk/aws-iotevents/test/detector-model.test.ts

skinny85

Thanks for the contribution @yamatatsu! This is a very interesting functionality that has some interesting challenges, including some nice programming interview question-level sub-tasks 🙂. I'd like to see a few more iterations on the API itself before we can merge this in.

packages/@aws-cdk/aws-iotevents/lib/event.ts

packages/@aws-cdk/aws-iotevents/lib/state.ts

packages/@aws-cdk/aws-iotevents/test/detector-model.test.ts

packages/@aws-cdk/aws-iotevents/test/integ.detector-model.ts

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

Pull request has been modified.

skinny85

Looks fantastic @yamatatsu! So much cleaner and easier to read than the initial version 🙂.

I have a few small last comments, but nothing major.

packages/@aws-cdk/aws-iotevents/README.md

skinny85 · 2022-02-02T22:41:57Z

packages/@aws-cdk/aws-iotevents/lib/state.ts

+  /**
+   * The Boolean expression that, when TRUE, causes the state transition and the actions to be performed.
+   */
+  readonly condition: Expression;


What do you think about calling this property when? This way, the code will read:

someState.transitionTo(otherState, { when: iotevents.Expression...., });

Which I think looks really nice 🙂.

@yamatatsu I see you did not address this comment. Any reason? Do you disagree with this name?

Sorry! I mistakenly lost this task.

@skinny85
I've modified it!

packages/@aws-cdk/aws-iotevents/lib/state.ts

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

Pull request has been modified.

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

skinny85

Looks great @yamatatsu! Last round of minor comments.

skinny85 · 2022-02-04T19:06:18Z

packages/@aws-cdk/aws-iotevents/README.md

  onEnter: [{
    eventName: 'test-event',
-    condition: iotevents.Expression.currentInput(input),
+    when: iotevents.Expression.currentInput(input),


BTW, is this not a weird condition? What does just currentInput() mean here? Is this true whenever the current input is not empty?

Is this true whenever the current input is not empty?

Yes🙂. In this case, Every messages to this input cause this event and create new detector by the property key.

skinny85 · 2022-02-04T19:11:43Z

packages/@aws-cdk/aws-iotevents/lib/event.ts

   *
   * @default - none (the actions are always executed)
   */
-  readonly condition?: Expression;
+  readonly when?: Expression;


Hmm, not sure about this change. My comment was only changing this in TransitionOptions, not here (it doesn't read that well here as it does in transitionTo().

I would leave this as-is. If you feel passionate that this is the way to go, fine, but then we need a "Breaking change" note in the PR description.

Ah. I assumed by mistake😅.

skinny85 · 2022-02-04T19:14:09Z

packages/@aws-cdk/aws-iotevents/lib/state.ts

+   * The condition that is used to determine to cause the state transition and the actions.
+   * When this was evaluated to TRUE, the state transition and the actions are triggered.
+   */
+  readonly when: Expression;


It's fine to leave this name as condition (this is a package-private interface, it doesn't really matter what this name is - we can change it at any time. For that same reason, I'm pretty sure you can remove all of the documentation from this interface if you don't need it).

packages/@aws-cdk/aws-iotevents/lib/state.ts

Pull request has been modified.

yamatatsu · 2022-02-06T06:30:16Z

packages/@aws-cdk/aws-iotevents/lib/detector-model.ts

  /**
-   * When setting to SERIAL, variables are updated and event conditions are evaluated in the order
-   * that the events are defined.
+   * When setting to BATCH, variables within a state are updated and events within a state are
+   * performed only after all event conditions are evaluated.
   */
  BATCH = 'BATCH',
+
  /**
-   * When setting to BATCH, variables within a state are updated and events within a state are
-   * performed only after all event conditions are evaluated.
+   * When setting to SERIAL, variables are updated and event conditions are evaluated in the order
+   * that the events are defined.
   */
  SERIAL = 'SERIAL',


Sorry that my funny mistake😓. Let me include it in this PR.

skinny85

Looks great @yamatatsu!

mergify · 2022-02-07T20:21:54Z

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

aws-cdk-automation · 2022-02-07T21:08:36Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: beb3341
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2022-02-07T21:09:04Z

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

This PR allow IoT Events detector model to transit to multiple states. This PR is in roadmap of aws#17711. <img width="561" alt="スクリーンショット 2022-02-02 0 38 10" src="https://user-images.githubusercontent.com/11013683/151999891-45afa8e8-57ed-4264-a323-16b84ed35348.png"> Following image is the graph displayed on AWS console when this integ test deployed. [Compared to the previous version](aws#18049), you can see that the state transitions are now represented. ![image](https://user-images.githubusercontent.com/11013683/151999116-5b3b36b0-d2b9-4e3a-9483-824dc0618f4b.png) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(iotevents): support transition event

cee19c0

github-actions bot added the @aws-cdk/aws-iotevents Related to AWS IoT Events label Feb 1, 2022

github-actions bot assigned skinny85 Feb 1, 2022

yamatatsu commented Feb 1, 2022

View reviewed changes

packages/@aws-cdk/aws-iotevents/README.md Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-iotevents/lib/event.ts Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-iotevents/test/detector-model.test.ts Outdated Show resolved Hide resolved

skinny85 previously requested changes Feb 1, 2022

View reviewed changes

yamatatsu mentioned this pull request Feb 2, 2022

(iotevents): add aws-iotevents DetectorModel L2 Construct #17711

Closed

2 tasks

Update packages/@aws-cdk/aws-iotevents/lib/state.ts

674459c

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

yamatatsu added 2 commits February 2, 2022 21:46

address comments

ab42260

address comments

f31211e

yamatatsu force-pushed the iotevents-dm-transitions branch from 33e3c0f to f31211e Compare February 2, 2022 13:32

yamatatsu added 2 commits February 2, 2022 23:03

add validation for transitionTo()

94685b6

fix readme code block

dbc42d0

yamatatsu requested a review from skinny85 February 2, 2022 22:03

skinny85 previously requested changes Feb 2, 2022

View reviewed changes

Update packages/@aws-cdk/aws-iotevents/lib/state.ts

514a77a

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

yamatatsu and others added 3 commits February 3, 2022 08:57

Update packages/@aws-cdk/aws-iotevents/lib/state.ts

7f52f71

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

address comments

e520bf7

fix test

75ad95b

yamatatsu requested a review from skinny85 February 3, 2022 15:09

yamatatsu added 2 commits February 4, 2022 23:33

rename condition to when

3f3dff0

Merge branch 'master' into iotevents-dm-transitions

aebc589

skinny85 previously requested changes Feb 4, 2022

View reviewed changes

yamatatsu requested a review from skinny85 February 5, 2022 07:37

address comments

da02f80

yamatatsu force-pushed the iotevents-dm-transitions branch from 61ac068 to da02f80 Compare February 5, 2022 07:39

fix comments

a3c094d

yamatatsu commented Feb 6, 2022

View reviewed changes

skinny85 approved these changes Feb 7, 2022

View reviewed changes

Merge branch 'master' into iotevents-dm-transitions

beb3341

mergify bot merged commit ccc1988 into aws:master Feb 7, 2022

yamatatsu deleted the iotevents-dm-transitions branch April 6, 2022 15:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(iotevents): support transition events #18768

feat(iotevents): support transition events #18768

yamatatsu commented Feb 1, 2022

gitpod-io bot commented Feb 1, 2022

skinny85 left a comment

skinny85 left a comment

skinny85 Feb 2, 2022

skinny85 Feb 3, 2022

yamatatsu Feb 4, 2022

yamatatsu Feb 4, 2022

skinny85 left a comment

skinny85 Feb 4, 2022

yamatatsu Feb 5, 2022 •

edited

Loading

skinny85 Feb 4, 2022

yamatatsu Feb 5, 2022

skinny85 Feb 4, 2022

yamatatsu Feb 6, 2022 •

edited

Loading

skinny85 left a comment

mergify bot commented Feb 7, 2022

aws-cdk-automation commented Feb 7, 2022

mergify bot commented Feb 7, 2022

feat(iotevents): support transition events #18768

feat(iotevents): support transition events #18768

Conversation

yamatatsu commented Feb 1, 2022

gitpod-io bot commented Feb 1, 2022

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yamatatsu Feb 5, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yamatatsu Feb 6, 2022 • edited Loading

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

mergify bot commented Feb 7, 2022

aws-cdk-automation commented Feb 7, 2022

AWS CodeBuild CI Report

mergify bot commented Feb 7, 2022

yamatatsu Feb 5, 2022 •

edited

Loading

yamatatsu Feb 6, 2022 •

edited

Loading