Repository navigation
Tech debt: Review the name of the method extract_data_from_envelope in JMESPath Functions #4218
Description
Why is this needed?
The extract_data_from_envelope method name seems strange for customers to understand what it is for. We now have the opportunity to deprecate this method, add a warning, and create a new one.
Which area does this relate to?
JMESPath functions
Suggestion
Deprectaed this method.
Acknowledgment
- This request meets Powertools for AWS Lambda (Python) Tenets
- Should this be considered in other Powertools for AWS Lambda languages? i.e. Java, TypeScript, and .NET
Activity
dreamorosi commentedon May 7, 2024
We just added this method in the TypeScript repo a few weeks ago.
Do we have any anecdotes for deprecating this and how we can improve?
I'm not necessarily challenging the idea, I'm more interested in how we can disambiguate it and make it clearer.
leandrodamascena commentedon May 31, 2024
Hello @dreamorosi! I don't have enough anecdotes about this. @heitorlessa may have more context about the reasons behind this change and any customer feedback received.
Regardless, we do not plan to remove this method entirely. Instead, we will add a deprecation warning and remove it in the V4 release. As for the new method name, we believe
querywould be a good name, as it better conveys the idea of retrieving data, and thequeryname is more commonly used across similar concepts of data querying.refactor!(jmespath_utils): deprecate extract_data_from_envelope in jm…
refactor(jmespath_utils): deprecate extract_data_from_envelope in fav…
leandrodamascena commentedon Aug 7, 2024
Closed via #4907
github-actions commentedon Aug 7, 2024
This issue is now closed. Please be mindful that future comments are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.