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

feat(stepfunctions): add getters for context object fields #25646

Merged
merged 18 commits into from
May 26, 2023

Conversation

colifran
Copy link
Contributor

This PR adds additional getters to allow easy access to context object fields. We currently have getters allowing easy access to the entire context object and the context object task token field. This adds getters for the following additional context object fields:

  • Execution id
  • Execution input
  • Execution name
  • Execution role arn
  • Execution start time
  • State entered time
  • State name
  • State retry count
  • State machine id
  • State machine name

Closes #25415


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

@gitpod-io
Copy link

gitpod-io bot commented May 19, 2023

@aws-cdk-automation aws-cdk-automation requested a review from a team May 19, 2023 03:51
@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels May 19, 2023
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 19, 2023
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 19, 2023
Copy link
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

Just 1 comment on the integration test.

@@ -49,6 +49,18 @@ const checkJobState = new LambdaInvoke(stack, 'Check the job state', {
resultSelector: {
status: sfn.JsonPath.stringAt('$.Payload.status'),
},
payload: sfn.TaskInput.fromObject({
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add an assertion here to assert that the state machine execution
succeeded? The reason that the assertion is needed is because this test
currently only tests that the state machine is able to be deployed, but there is
not any validation that the state machine is actually valid and will execute.

You can find an example here
https://github.com/corymhall/aws-cdk/blob/53d24f1a1357410746052bbf25b5b89b985f7b80/packages/@aws-cdk-testing/framework-integ/test/aws-stepfunctions-tasks/test/aws-sdk/integ.call-aws-service-sfn.ts#L38-L49

You can probably also have the lambda function validate that all those fields
are set.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching this and providing an example. I used the example you provided to include an assertion. I also added code that passes a payload to the lambda function with the newly added fields set. The lambda then checks that each of the expected fields are set and returns SUCCEEDED only if all fields are set (not undefined) and the statusCode is 200.

Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation added pr/needs-cli-test-run This PR needs CLI tests run against it. and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels May 26, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review May 26, 2023 14:07

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

🚀

const res = integ.assertions.awsApiCall('StepFunctions', 'startExecution', {
stateMachineArn: sm.stateMachineArn,
});
const executionArn = res.getAttString('executionArn');
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

@mergify
Copy link
Contributor

mergify bot commented May 26, 2023

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 42b43d6 into main May 26, 2023
@mergify mergify bot deleted the colifran/stepfunction-context-fields branch May 26, 2023 17:23
@mergify
Copy link
Contributor

mergify bot commented May 26, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-cli-test-run This PR needs CLI tests run against it.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

stepfunctions: easy access to fields in execution context object
4 participants