feat(commons): add cleanupPowertools
function
#1473
Merged
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.
Description of your changes
This PR introduces a new function used to cleanup Powertools for AWS resources when a Middy middleware returns early and terminates the middleware chain.
When a middleware returns early, all the middleware lifecycle functions that come after it are not executed. This means that if a middleware was relying on certain logic to be run during the
after
oronError
lifecycle functions, that logic will not be executed.All Powertools for AWS middlewares rely on these lifecycle functions to perform some operations like:
The function in this PR is aimed at advanced Middy users who author their own middlewares, as well as ourselves in future middleware implementations. The idea is that when writing a middleware that might return early you only have to import the
cleanupPowertools
function and run it before returning early. The function will then take care of inspecting the Middy internal object and execute any Powertools related function that might be present.Related issues, RFCs
Issue number: #1410
Checklist
Breaking change checklist
Is it a breaking change?: NO
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.