feat(iotevents): support timer actions #19949

yamatatsu · 2022-04-18T01:38:33Z

This PR is a part of roadmap in #17711. And if this PR is merged, I will close this issue and create some good first issues to implement rest actions and expressions.

This PR supports the timer actions (SetTimerAction, ResetTimerAction and ClearTimerAction) and timeout() expression.

These allow to embed a timer to the state machine of the detector model.
Below figure illustrate the state machine Device Heartbeat. This detector model is used to alert if the message is interrupted for a certain period of time. The integ-test included in this PR is example of creating Device Heartbeat detector model.

stateDiagram-v2
  [*] --> Online: set a timer on input message
  Online --> Online: reset the timer\non input messages
  Online --> Offline: timeout the timer
  Offline --> Online: input messages

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-04-18T01:38:41Z

TheRealAmazonKendra

Apologies for our delay in getting to this review. Now that we've moved the branch to v2, can you please take a look at resolving the conflicts and/or opening a new PR for this if resolving them is too messy?

Pull request has been modified.

TheRealAmazonKendra

Thanks for your work on this! Overall this looks quite good. Please see my specific feedback inline.

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

TheRealAmazonKendra · 2022-08-01T21:01:17Z

packages/@aws-cdk/aws-iotevents-actions/lib/set-timer-action.ts

+   *
+   * @default - none, required if no `durationExpression` is defined.
+   */
+  readonly duration?: cdk.Duration;


I'm not a fan of mutually exclusive props. I think this should go in the direction of one required prop that gets translated properly into Duration or Expression. Take a look at the model of this we use for Schedule in aws-events.

Cool! 🤩 I will implement as it. Thank you!

TheRealAmazonKendra · 2022-08-01T21:03:13Z

packages/@aws-cdk/aws-iotevents-actions/lib/set-timer-action.ts

+    }
+  }
+
+  bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {


Suggested change

bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {

public _bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {

This would be better off as it is I think.
This is implementation of IAction and is following Integration in DESIGN_GUIDELINE as same as aws-events target.

Yeah, I'm annoyed with that but it's not in scope here to ask you to fix an old contract I'm mad at. Maybe I'll get neurotic about it and do some excessive refactoring.

I've understood that refactoring is necessary even in light of the current implementations.
I'll refactor it!

Pull request has been modified.

TheRealAmazonKendra · 2022-08-03T03:43:50Z

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

 - Set variable to detector instanse
 - Invoke a Lambda function

+## Use timer


Excellent README!

TheRealAmazonKendra · 2022-08-03T03:44:09Z

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

-          iotevents.Expression.inputAttribute(input, 'payload.temperature'),
-        ),
-      ],
+      new actions.SetVariableAction(


TheRealAmazonKendra · 2022-08-03T03:51:30Z

packages/@aws-cdk/aws-iotevents-actions/lib/set-timer-action.ts

+    }
+  }
+
+  bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {


Yeah, I'm annoyed with that but it's not in scope here to ask you to fix an old contract I'm mad at. Maybe I'll get neurotic about it and do some excessive refactoring.

TheRealAmazonKendra

Looks great!

mergify · 2022-08-03T03:52:47Z

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-03T05:05:18Z

AWS CodeBuild CI Report

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

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

mergify · 2022-08-03T05:05:28Z

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

This PR is a part of roadmap in aws#17711. And if this PR is merged, I will close this issue and create some good first issues to implement rest actions and expressions. This PR supports the timer actions (`SetTimerAction`, `ResetTimerAction` and `ClearTimerAction`) and `timeout()` expression. These allow to embed a timer to the state machine of the detector model. Below figure illustrate the state machine [Device Heartbeat](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-examples-dhb.html). This detector model is used to alert if the message is interrupted for a certain period of time. The integ-test included in this PR is example of creating Device Heartbeat detector model. ```mermaid stateDiagram-v2 [*] --> Online: set a timer on input message Online --> Online: reset the timer\non input messages Online --> Offline: timeout the timer Offline --> Online: input messages ``` ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/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/master/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*

aws-cdk-automation requested a review from a team April 18, 2022 01:38

github-actions bot added the p2 label Apr 18, 2022

TheRealAmazonKendra changed the base branch from v1-main to main July 13, 2022 00:06

TheRealAmazonKendra previously requested changes Jul 14, 2022

View reviewed changes

feat(iotevents): Support the timer actions

1af03c9

yamatatsu force-pushed the iotevents-actions-timer branch from d53da27 to 1af03c9 Compare July 31, 2022 13:02

TheRealAmazonKendra previously requested changes Aug 1, 2022

View reviewed changes

address comments

d815bbc

address comment

baaa3d0

yamatatsu requested a review from TheRealAmazonKendra August 2, 2022 16:21

TheRealAmazonKendra changed the title ~~feat(iotevents): Support the timer actions~~ feat(iotevents): support timer actions Aug 3, 2022

TheRealAmazonKendra reviewed Aug 3, 2022

View reviewed changes

TheRealAmazonKendra approved these changes Aug 3, 2022

View reviewed changes

Merge branch 'main' into iotevents-actions-timer

9c62a4a

mergify bot merged commit af301dd into aws:main Aug 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(iotevents): support timer actions #19949

feat(iotevents): support timer actions #19949

yamatatsu commented Apr 18, 2022

gitpod-io bot commented Apr 18, 2022

TheRealAmazonKendra left a comment

TheRealAmazonKendra left a comment

TheRealAmazonKendra Aug 1, 2022

yamatatsu Aug 2, 2022 •

edited

Loading

TheRealAmazonKendra Aug 1, 2022

yamatatsu Aug 2, 2022

TheRealAmazonKendra Aug 3, 2022

yamatatsu Aug 3, 2022

TheRealAmazonKendra Aug 3, 2022

TheRealAmazonKendra Aug 3, 2022

TheRealAmazonKendra Aug 3, 2022

TheRealAmazonKendra left a comment

mergify bot commented Aug 3, 2022

aws-cdk-automation commented Aug 3, 2022

mergify bot commented Aug 3, 2022

	bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {
	public _bind(_scope: Construct, _options: iotevents.ActionBindOptions): iotevents.ActionConfig {

feat(iotevents): support timer actions #19949

feat(iotevents): support timer actions #19949

Conversation

yamatatsu commented Apr 18, 2022

All Submissions:

Adding new Unconventional Dependencies:

New Features

gitpod-io bot commented Apr 18, 2022

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yamatatsu Aug 2, 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

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

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

mergify bot commented Aug 3, 2022

aws-cdk-automation commented Aug 3, 2022

AWS CodeBuild CI Report

mergify bot commented Aug 3, 2022

yamatatsu Aug 2, 2022 •

edited

Loading