feat(stepfunctions): added new condition operators #9920

michaelwiles · 2020-08-23T14:11:50Z

Added the following Conditons:

Condition.isPresent - matches if a json path is present
Condition.isNotPresent - matches if a json path is not present
Condition.isString - matches if a json path contains a string
Condition.isNotString - matches if a json path is not a string
Condition.isNumeric - matches if a json path is numeric
Condition.isNotNumeric - matches if a json path is not numeric
Condition.isBoolean - matches if a json path is boolean
Condition.isNotBoolean - matches if a json path is not boolean
Condition.isTimestamp - matches if a json path is a timestamp
Condition.isNotTimestamp - matches if a json path is not a
timestamp
Condition.isNotNull - matches if a json path is not null
Condition.isNull - matches if a json path is null
Condition.booleanEqualsJsonPath - matches if a boolean field equals
a value in a given mapping path
Condition.stringEqualsJsonPath - matches if a string field equals a
given mapping path
Condition.stringLessThanJsonPath - Matches if a string field sorts
before a value at given mapping path
Condition.stringLessThanEqualsJsonPath - Matches if a string field
sorts equal to or before a given mapping
Condition.stringGreaterThanJsonPath - Matches if a string field
sorts after a value at a given mapping path
Condition.stringGreaterThanEqualsJsonPath - Matches if a string
field sorts after or equal to value at a given mapping path
Condition.numberEqualsJsonPath - matches if a numeric field has the
value in a given mapping path
Condition.numberLessThan - matches if a numeric field is less than
the given value
Condition.numberLessThanJsonPath - matches if a numeric field is
less than the value at the given mapping path
Condition.numberLessThanEqualsJsonPath - matches if a numeric field
is less than or equal to the numeric value at given mapping path
Condition.numberGreaterThanJsonPath - matches if a numeric field is
greater than the value at a given mapping path
Condition.numberGreaterThanEqualsJsonPath - matches if a numeric
field is greater than or equal to the value at a given mapping path
Condition.timestampEqualsJsonPath - matches if a timestamp field is
the same time as the timestamp at a given mapping path
Condition.timestampLessThanJsonPath - matches if a timestamp field
is before the timestamp at a given mapping path
Condition.timestampLessThanEqualsJsonPath - matches if a timestamp
field is before or equal to the timestamp at a given mapping path
Condition.timestampGreaterThanJsonPath - matches if a timestamp
field is after the timestamp at a given mapping path
Condition.timestampGreaterThanEqualsJsonPath - matches if a
timestamp field is after or equal to the timestamp at a given mapping
path
Condition.stringMatches - matches a field with the ability to use as
a wild card e.g: log-.txt or LATEST. No other characters other than ""
have any special meaning ( can be escaped: \*)

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

shivlaks

thanks for starting this @michaelwiles

The commit body should be updated with the list of condition operators we are adding support for.
can you update the README as well to include the new conditions
had a question about naming the methods that will support a JsonPath

shivlaks · 2020-09-09T06:41:11Z

packages/@aws-cdk/aws-stepfunctions/lib/condition.ts

+  /**
+   * Tests if variable is not a timestamp
+   */


the terminology tests and matches are used. can we be consistent (I think I prefer Matches which already exists on a the comparison operators that are available today)

happy with that

shivlaks · 2020-09-09T06:44:12Z

packages/@aws-cdk/aws-stepfunctions/lib/condition.ts

  /**
   * Matches if a boolean field has the given value
   */
  public static booleanEquals(variable: string, value: boolean): Condition {
    return new VariableComparison(variable, ComparisonOperator.BooleanEquals, value);
  }

+  /**
+   * Matches if a boolean field has the given value


Suggested change

* Matches if a boolean field has the given value

* Matches if a boolean field has the given value path

shivlaks · 2020-09-09T06:46:53Z

packages/@aws-cdk/aws-stepfunctions/lib/condition.ts

+  /**
+   * Matches if a boolean field has the given value
+   */
+  public static booleanEqualsPath(variable: string, value: string): Condition {


wondering if Path is the right suffix for these methods?
I think we've been explicit about adding fromJsonPath when naming these methods. what do you think?

Yeah - you have a point. In the Dynamo attribute value context json path is used.

I guess in this case I took inspiration from the cloudformation naming which doesn't use the json path.

I'm happy to stick with json path... don't have strong feelings against it

shivlaks · 2020-09-09T06:47:18Z

packages/@aws-cdk/aws-stepfunctions/lib/condition.ts

  /**
   * Matches if a numeric field is less than or equal to the given value
   */
  public static numberLessThanEquals(variable: string, value: number): Condition {
    return new VariableComparison(variable, ComparisonOperator.NumericLessThanEquals, value);
  }

+  /**
+   * Matches if a numeric field is less than or equal to the numeric value at given maping path


Suggested change

* Matches if a numeric field is less than or equal to the numeric value at given maping path

* Matches if a numeric field is less than or equal to the numeric value at given mapping path

shivlaks · 2020-09-09T06:51:13Z

packages/@aws-cdk/aws-stepfunctions/test/condition.test.ts

@@ -28,13 +28,85 @@ describe('Condition Variables', () => {
      },
    );
  }),
-  test('Exercise a number of other conditions', () => {
+  test('Exercise string conditions', () => {


ideally we do not modify existing tests. it's preferred to only add new tests to ensure we don't introduce a regression. can we preserve this test as it was and test our conditions through new tests cases only?

shivlaks · 2020-09-11T22:55:11Z

@yoodan93 @wong-a - can y'all have a look at this PR as well?

Pull request has been modified.

michaelwiles · 2020-09-13T15:21:19Z

@shivlaks changes implemented

shivlaks

@michaelwiles - changes look fine to me! can you update the commit body to include the implementation details / documentation, etc for this commit?

note: also added a do-not-merge label so that @yoodan93 and @wong-a have a chance to take a look at the changes as they might have additional suggestions.

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

Added the following Conditons: * `Condition.isJsonPathPresent` - matches a json path is present * `Condition.isJsonPathNotPresent` - matches a json path is not present * `Condition.isJsonPathString` - matches a json path contains a string * `Condition.isJsonPathNotString` - matches a json path is not a string * `Condition.isJsonPathNumeric` - matches a json path is numeric * `Condition.isJsonPathNotNumeric` - matches a json path is not numeric * `Condition.isJsonPathBoolean` - matches a json path is boolean * `Condition.isJsonPathNotBoolean` - matches a json path is not boolean * `Condition.isJsonPathTimestamp` - matches a json path is a timestamp * `Condition.isJsonPathNotTimestamp` - matches a json path is not a timestamp * `Condition.isJsonPathNotNull` - matches a json path is not null * `Condition.isJsonPathNull` - matches a json path is null * `Condition.booleanEqualsJsonPath` - matches a boolean field equals a value in a given mapping path * `Condition.stringEqualsJsonPath` - matches a string field equals a given mapping path * `Condition.stringLessThanJsonPath` - Matches a string field sorts before a value at given mapping path * `Condition.stringLessThanEqualsJsonPath` - Matches if a string field sorts equal to or before a given mapping * `Condition.stringGreaterThanJsonPath` - Matches if a string field sorts after a value at a given mapping path * `Condition.stringGreaterThanEqualsJsonPath` - Matches if a string field sorts after or equal to value at a given mapping path * `Condition.numberEqualsJsonPath` - Matches if a numeric field has the value in a given mapping path * `Condition.numberLessThan` - Matches if a numeric field is less than the given value * `Condition.numberLessThanJsonPath` - Matches if a numeric field is less than the value at the given mapping path * `Condition.numberLessThanEqualsJsonPath` - Matches if a numeric field is less than or equal to the numeric value at given mapping path * `Condition.numberGreaterThanJsonPath` - Matches if a numeric field is greater than the value at a given mapping path * `Condition.numberGreaterThanEqualsJsonPath` - Matches if a numeric field is greater than or equal to the value at a given mapping path * `Condition.timestampEqualsJsonPath` - Matches if a timestamp field is the same time as the timestamp at a given mapping path * `Condition.timestampLessThanJsonPath` - Matches if a timestamp field is before the timestamp at a given mapping path * `Condition.timestampLessThanEqualsJsonPath` - Matches if a timestamp field is before or equal to the timestamp at a given mapping path * `Condition.timestampGreaterThanJsonPath` - Matches if a timestamp field is after the timestamp at a given mapping path * `Condition.timestampGreaterThanEqualsJsonPath` - Matches if a timestamp field is after or equal to the timestamp at a given mapping path * `Condition.stringMatches`

Pull request has been modified.

michaelwiles · 2020-09-15T07:38:13Z

commit body updated

yoodan93

Looks good to me!

shivlaks · 2020-09-15T16:43:13Z

commit body updated

@michaelwiles by commit body i meant the description of this PR :)
sorry, i should have been clearer!!! - the PR description will be used as the commit body when merging

wong-a · 2020-09-15T16:55:50Z

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

@@ -217,6 +217,54 @@ If your `Choice` doesn't have an `otherwise()` and none of the conditions match
 the JSON state, a `NoChoiceMatched` error will be thrown. Wrap the state machine
 in a `Parallel` state if you want to catch and recover from this.

+#### Available Conditions: 
+see [step function comparison operators](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html#amazon-states-language-choice-state-rules)
+* `Condition.isJsonPathPresent` - matches a json path is present


Am I missing something or do these isJsonPath<operator> conditions not exist? IsPresent is only accepts a JSONPath anyways.

not sure what you are asking?

I meant that isJsonPathPresent, isJsonPathNotPresent, etc. aren't defined in the Condition class

Very good point - thank you. The jsonpath here is superfluous and does not match the code - will address.

updated accordingly - made README match the code.

wong-a · 2020-09-15T16:57:04Z

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

+* `Condition.isJsonPathNotTimestamp` - matches a json path is not a timestamp
+* `Condition.isJsonPathNotNull` - matches a json path is not null
+* `Condition.isJsonPathNull` - matches a json path is null
+* `Condition.booleanEquals` - matches a boolean field has a given value


nit: Can we consistent text as the comment on the actual conditions? The casing and structure also differs from lines below.

Suggested change

* `Condition.booleanEquals` - matches a boolean field has a given value

* `Condition.booleanEquals` - Matches if a boolean field has a given value

and fixed consistency of case and wording

Added the following Conditons: * `Condition.isPresent` - matches if a json path is present * `Condition.isNotPresent` - matches if a json path is not present * `Condition.isString` - matches if a json path contains a string * `Condition.isNotString` - matches if a json path is not a string * `Condition.isNumeric` - matches if a json path is numeric * `Condition.isNotNumeric` - matches if a json path is not numeric * `Condition.isBoolean` - matches if a json path is boolean * `Condition.isNotBoolean` - matches if a json path is not boolean * `Condition.isTimestamp` - matches if a json path is a timestamp * `Condition.isNotTimestamp` - matches if a json path is not a timestamp * `Condition.isNotNull` - matches if a json path is not null * `Condition.isNull` - matches if a json path is null * `Condition.booleanEqualsJsonPath` - matches if a boolean field equals a value in a given mapping path * `Condition.stringEqualsJsonPath` - matches if a string field equals a given mapping path * `Condition.stringLessThanJsonPath` - Matches if a string field sorts before a value at given mapping path * `Condition.stringLessThanEqualsJsonPath` - Matches if a string field sorts equal to or before a given mapping * `Condition.stringGreaterThanJsonPath` - Matches if a string field sorts after a value at a given mapping path * `Condition.stringGreaterThanEqualsJsonPath` - Matches if a string field sorts after or equal to value at a given mapping path * `Condition.numberEqualsJsonPath` - matches if a numeric field has the value in a given mapping path * `Condition.numberLessThan` - matches if a numeric field is less than the given value * `Condition.numberLessThanJsonPath` - matches if a numeric field is less than the value at the given mapping path * `Condition.numberLessThanEqualsJsonPath` - matches if a numeric field is less than or equal to the numeric value at given mapping path * `Condition.numberGreaterThanJsonPath` - matches if a numeric field is greater than the value at a given mapping path * `Condition.numberGreaterThanEqualsJsonPath` - matches if a numeric field is greater than or equal to the value at a given mapping path * `Condition.timestampEqualsJsonPath` - matches if a timestamp field is the same time as the timestamp at a given mapping path * `Condition.timestampLessThanJsonPath` - matches if a timestamp field is before the timestamp at a given mapping path * `Condition.timestampLessThanEqualsJsonPath` - matches if a timestamp field is before or equal to the timestamp at a given mapping path * `Condition.timestampGreaterThanJsonPath` - matches if a timestamp field is after the timestamp at a given mapping path * `Condition.timestampGreaterThanEqualsJsonPath` - matches if a timestamp field is after or equal to the timestamp at a given mapping path * `Condition.stringMatches` - matches a field with the ability to use as a wild card e.g: log-.txt or LATEST. No other characters other than "*" have any special meaning (* can be escaped: \\*)

michaelwiles · 2020-09-17T07:48:02Z

@shivlaks please can you move this along? we want to use these new conditions...

shivlaks · 2020-09-17T08:01:26Z

@michaelwiles thanks for the contribution! dropped the do-not-merge label. This feature will be included in the next release.

michaelwiles · 2020-09-17T11:38:49Z

@shivlaks it looks like you still need to approve the pull request..?

aws-cdk-automation · 2020-09-17T12:03:55Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 137fd27
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2020-09-17T14:42:16Z

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

michaelwiles changed the title ~~feat(aws-stepfunctions): added new condition operators closes #9821~~ feat(aws-stepfunctions): added new condition operators Aug 23, 2020

michaelwiles mentioned this pull request Aug 30, 2020

[aws-stepfunctions] Please add support for new Condition operators for step functions #9821

Closed

2 tasks

SomayaB assigned shivlaks Aug 31, 2020

shivlaks self-requested a review August 31, 2020 20:59

shivlaks previously requested changes Sep 9, 2020

View reviewed changes

shivlaks changed the title ~~feat(aws-stepfunctions): added new condition operators~~ feat(stepfunctions): added new condition operators Sep 15, 2020

shivlaks added the pr/do-not-merge This PR should not be merged at this time. label Sep 15, 2020

shivlaks previously approved these changes Sep 15, 2020

View reviewed changes

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

yoodan93 approved these changes Sep 15, 2020

View reviewed changes

wong-a suggested changes Sep 15, 2020

View reviewed changes

wong-a approved these changes Sep 16, 2020

View reviewed changes

shivlaks removed the pr/do-not-merge This PR should not be merged at this time. label Sep 17, 2020

Merge branch 'master' into master

137fd27

shivlaks approved these changes Sep 17, 2020

View reviewed changes

mergify bot merged commit b8490f2 into aws:master Sep 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stepfunctions): added new condition operators #9920

feat(stepfunctions): added new condition operators #9920

michaelwiles commented Aug 23, 2020 •

edited

Loading

shivlaks left a comment

shivlaks Sep 9, 2020

michaelwiles Sep 9, 2020

shivlaks Sep 9, 2020

michaelwiles Sep 9, 2020

shivlaks Sep 9, 2020

michaelwiles Sep 9, 2020

shivlaks Sep 9, 2020

shivlaks Sep 9, 2020

shivlaks commented Sep 11, 2020

michaelwiles commented Sep 13, 2020

shivlaks left a comment

michaelwiles commented Sep 15, 2020

yoodan93 left a comment

shivlaks commented Sep 15, 2020

wong-a Sep 15, 2020

michaelwiles Sep 15, 2020 •

edited

Loading

wong-a Sep 15, 2020

michaelwiles Sep 15, 2020

michaelwiles Sep 16, 2020

wong-a Sep 15, 2020

michaelwiles Sep 16, 2020

michaelwiles commented Sep 17, 2020

shivlaks commented Sep 17, 2020

michaelwiles commented Sep 17, 2020

aws-cdk-automation commented Sep 17, 2020

mergify bot commented Sep 17, 2020

	* Matches if a boolean field has the given value
	* Matches if a boolean field has the given value path

	* Matches if a numeric field is less than or equal to the numeric value at given maping path
	* Matches if a numeric field is less than or equal to the numeric value at given mapping path

	* `Condition.booleanEquals` - matches a boolean field has a given value
	* `Condition.booleanEquals` - Matches if a boolean field has a given value

feat(stepfunctions): added new condition operators #9920

feat(stepfunctions): added new condition operators #9920

Conversation

michaelwiles commented Aug 23, 2020 • edited Loading

shivlaks 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

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

shivlaks commented Sep 11, 2020

michaelwiles commented Sep 13, 2020

shivlaks left a comment

Choose a reason for hiding this comment

michaelwiles commented Sep 15, 2020

yoodan93 left a comment

Choose a reason for hiding this comment

shivlaks commented Sep 15, 2020

Choose a reason for hiding this comment

michaelwiles Sep 15, 2020 • 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

michaelwiles commented Sep 17, 2020

shivlaks commented Sep 17, 2020

michaelwiles commented Sep 17, 2020

aws-cdk-automation commented Sep 17, 2020

AWS CodeBuild CI Report

mergify bot commented Sep 17, 2020

michaelwiles commented Aug 23, 2020 •

edited

Loading

michaelwiles Sep 15, 2020 •

edited

Loading