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: Add ability to use waitForTaskToken for ECS tasks #180

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nicolaei
Copy link

@nicolaei nicolaei commented Nov 12, 2021

Description

This change adds the ability to use waitForTaskToken for ECS tasks.

Why is the change necessary?

To add support for documentet features. Ref the ECS step docs in the step function documentation.

Solution

The solution uses the already established pattern of having an argument wait_for_callback, as seen in the lambda task.

But because we can't have both wait_for_completion and wait_for_callback at the same time, I've added a condition to raise a ValueError if both are set to True. I'm happy to change this if you've already got an established pattern for argument errors.

Testing

Created a Unittest and also using this in a project at work.


Pull Request Checklist

Please check all boxes (including N/A items)

Testing

  • Unit tests added
  • Integration test added
  • Manual testing - why was it necessary? could it be automated?

Documentation

  • docs: All relevant docs updated
  • docstrings: All public APIs documented

Title and description

  • Change type: Title is prefixed with change type: and follows conventional commits
  • References: Indicate issues fixed via: Fixes #xxx

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

@nicolaei nicolaei changed the title Add ability to use waitForTaskToken for ECS tasks feat: Add ability to use waitForTaskToken for ECS tasks Nov 12, 2021
@wong-a
Copy link
Contributor

wong-a commented Nov 12, 2021

Thanks for the PR! For integrations that support all 3 integration patterns, we started to introduce a different way to set this using the IntegrationPattern enum instead of separate args for each pattern.

@nicolaei
Copy link
Author

nicolaei commented Nov 12, 2021

Sorry about the multiples of force-pushes (and subsequent spams from the build). Had some issues with the test-suite on my local machine for some reason 🤔


Thanks for the PR! For integrations that support all 3 integration patterns, we started to introduce a different way to set this using the IntegrationPattern enum instead of separate args for each pattern.

Would you like me to change the PR to use that pattern? I could introduce it to all the other task classes in compute.py while I'm at it if you'd like.

Seeing that it would be a breaking change as well, I'd probably have to change the PR title to breaking?

src/stepfunctions/steps/compute.py Outdated Show resolved Hide resolved
@wong-a
Copy link
Contributor

wong-a commented Nov 12, 2021

Would you like me to change the PR to use that pattern?
Seeing that it would be a breaking change as well, I'd probably have to change the PR title to breaking?

See #180 (comment)

I could introduce it to all the other task classes in compute.py while I'm at it if you'd like.

We like to keep PRs small, so just ECS is more than fine. The main motivation here is supporting all 3 integration patterns and ECS is the only implemented integration that doesn't expose all of them.

@nicolaei
Copy link
Author

Sorry for the late change here, but here you go!

@nicolaei
Copy link
Author

nicolaei commented Jul 6, 2022

@wong-a: Any chance we can get this merged? 😄

Copy link

@jormello jormello left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the feedback from @wong-a and for reaching back out for an update @nicolaei.

Source code changes look okay to me. For the test code changes, can you add test cases for each of the integration patterns? Right now there's only coverage for IntegrationPattern.WaitForTaskToken.

@StepFunctions-Bot
Copy link
Contributor

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-sEHrOdk7acJc
  • Commit ID: f7ca980
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@nicolaei
Copy link
Author

I updated the tests with explicit testing of both old-style and new-style parameters now!

I'm a bit confused why the tests are failing though, because these build-issues seem totally unrelated, and I only updated my test-code 🤔 Any thoughts @jormello?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants