Clarify coverage error messages to distinguish license and emulation limits #12547
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
silv-io
approved these changes
Apr 23, 2025
| f"API %sfor service '%s' not yet implemented or pro feature" | ||
| f" - please check {COVERAGE_LINK_BASE}%s for further information" | ||
| ) | ||
| _COVERAGE_LINK_BASE = "https://docs.localstack.cloud/references/coverage" |
There was a problem hiding this comment.
This link will probably be replaced by the feature catalog in the future, but for now it's the only thing we have.
/cc @k-a-il for the future, when this will have to change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
By refining our coverage error messages to explicitly distinguish between license-plan restrictions and missing LocalStack emulation, developers immediately know whether they need to upgrade or await feature support. This is especially valuable for integrated services like Step Functions, where missing or unlicensed services defined in the state machines can result in evaluation failure.
Changes
Error for service action limitations rewritten from
API action <action-name> for service <service-name> not yet implemented or pro feature - please check https://docs.localstack.cloud/references/coverage/coverage_s3/ for further informationto
The API action <action-name> for service <service-name> is either not available in your current license plan or has not yet been emulated by LocalStack. Please refer to https://docs.localstack.cloud/references/coverage/coverage_<service-name> for more information.Error for service limitations rewritten from
API for service <service-name> not yet implemented or pro feature - please check https://docs.localstack.cloud/references/coverage/ for further informationto
The API for service <service-name> is either not included in your current license plan or has not yet been emulated by LocalStack. Please refer to https://docs.localstack.cloud/references/coverage for more details.Future Work
Extend these error messages to suggest the specific license tier required to enable a given service or API action, or to clearly indicate when the requested service isn’t supported by LocalStack