8000 Remove legacy StepFunctions v1 provider by joe4dev · Pull Request #11734 · localstack/localstack · GitHub
[go: up one dir, main page]

Skip to content

Remove legacy StepFunctions v1 provider #11734

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

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

joe4dev
Copy link
Member
@joe4dev joe4dev commented Oct 23, 2024

Depends on CI job removal #11778

Motivation

The new StepFunctions provider v2 has been the default implementation since LocalStack 3.0.0 and we announced in the blog post that we are planning to remove the legacy v1 implementation with the next major release.

Changes

  • Remove legacy provider initialization providers.py
  • Remove code localstack-core/localstack/services/stepfunctions/legacy including the package installers not required anymore 🧹
  • Remove test suite only for legacy provider tests/aws/services/stepfunctions/legacy
  • Add deprecation warning for PROVIDER_OVERRIDE_STEPFUNCTIONS

Testing

Mostly regression test suite.

Deprecations could be tested manually.

Known Regressions

There are no known regressions and only few tests were executed for the legacy StepFunctions provider (only the legacy tests directory).

These tests had a conditional v2 skip but are likely just new snapshot skips rather than regressions (thanks @MEPalma for the clarification):

  • aws.services.stepfunctions.v2.scenarios.test_sfn_scenarios.TestFundamental.test_step_functions_calling_api_gateway
    • paths=["$..content-type"], # *FIXME: v2 includes extra content-type fields in Header fields.*
  • aws.services.stepfunctions.v2.scenarios.test_sfn_scenarios.TestFundamental.test_wait_for_callback
    • paths=["$..MessageId"]

TODO

What's left to do:

  • Update StepFunctions docs (near v4 release)

@joe4dev joe4dev added the semver: major Breaking changes which can be included in a major release only label Oct 23, 2024
@joe4dev joe4dev added this to the 4.0 milestone Oct 23, 2024
@joe4dev joe4dev self-assigned this Oct 23, 2024
@localstack-bot
Copy link
Collaborator

Currently, only minor and patch changes are allowed on master. Your PR labels (semver: major) indicate that it cannot be merged into the master at this time.

Copy link
github-actions bot commented Oct 23, 2024

S3 Image Test Results (AMD64 / ARM64)

  2 files  ±0    2 suites  ±0   4m 11s ⏱️ +19s
421 tests ±0  369 ✅ ±0   52 💤 ±0  0 ❌ ±0 
842 runs  ±0  738 ✅ ±0  104 💤 ±0  0 ❌ ±0 

Results for commit dca3679. ± Comparison against base commit 39769d1.

♻️ This comment has been updated with latest results.

Copy link
github-actions bot commented Oct 23, 2024

LocalStack Community integration with Pro

    2 files  ± 0      2 suites  ±0   1h 43m 31s ⏱️ +23s
3 522 tests  - 14  3 128 ✅ ±0  394 💤  - 14  0 ❌ ±0 
3 524 runs   - 14  3 128 ✅ ±0  396 💤  - 14  0 ❌ ±0 

Results for commit dca3679. ± Comparison against base commit 39769d1.

♻️ This comment has been updated with latest results.

@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch 3 times, most recently from a733173 to 5ee2932 Compare October 25, 2024 13:37
@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch from 5ee2932 to 8528151 Compare November 5, 2024 08:34
@joe4dev joe4dev changed the base branch from master to release/v4 November 5, 2024 08:35
@joe4dev joe4dev marked this pull request as ready for review November 5, 2024 08:51
@dfangl dfangl force-pushed the remove-legacy-stepfunctions-provider branch 2 times, most recently from 726af73 to e03de05 Compare November 6, 2024 12:13
@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch from e03de05 to 89bd89e Compare November 7, 2024 09:24
@alexrashed alexrashed mentioned this pull request Nov 7, 2024
9 tasks
@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch from 89bd89e to d99e92c Compare November 7, 2024 13:50
Copy link
Member
@dominikschubert dominikschubert left a comment

Choose a reason for hiding this comment

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

LGTM, nice attention to detail with the explicit v2 provider as well. We could even leave this in until 5.0 for a longer phase-out but less code is always nice of course.

It's great that we can now finally remove the fairly hacky v1 provider and SO much complex (and now unused) code 🧹

The artifacts that we're hosting in the artifacts repo need to stay a while longer unfortunately to keep supporting older versions.

@alexrashed alexrashed force-pushed the remove-legacy-stepfunctions-provider branch from d99e92c to 11e79e5 Compare November 8, 2024 07:48
@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch from 11e79e5 to aecea48 Compare November 8, 2024 19:43
# Conflicts:
#	localstack-core/localstack/deprecations.py
#	localstack-core/localstack/services/lambda_/provider.py
@joe4dev joe4dev force-pushed the remove-legacy-stepfunctions-provider branch from aecea48 to dca3679 Compare November 12, 2024 13:13
@joe4dev joe4dev merged commit 332b68b into release/v4 Nov 13, 2024
36 checks passed
@joe4dev joe4dev deleted the remove-legacy-stepfunctions-provider branch November 13, 2024 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver: major Breaking changes which can be included in a major release only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0