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(jmespath): add powertools functions #2264

Merged
merged 2 commits into from
Mar 24, 2024
Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR is a follow up to #2259 and introduces a series of custom functions to the JMESPath utility which will allow customer to work with complex data types like JSON, base64, and gzip encoded fields.

These function match 1:1 the ones available in Powertools for AWS Lambda (Python) and are one of the key differentiator of the Powertools JMESPath utility versus other JMESPath libraries available on npm.

At the moment we support the following functions:

  • powertools_json
  • powertools_base64
  • powertools_base64_gzip

Customers will be able to use them with AWS as well as own events. For example, when processing an event coming from API Gateway the body field will be JSON stringified and might be also base64-encoded.

Taking an example event like:

{
  "headers": [],
  "method": "GET",
  "body": "{\"foo\": 1}"
}

Without these functions the customer would be able to only use expressions like search(event, 'body'), but would have to handle the actual content of the body on their own.

With these functions they will be able to do things like search(event, 'powertools_json(body).foo') to select fields within the parsed body.

Related issues, RFCs

Issue number: #2207

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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.

@dreamorosi dreamorosi self-assigned this Mar 21, 2024
@dreamorosi dreamorosi requested review from a team as code owners March 21, 2024 15:55
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Mar 21, 2024
@dreamorosi dreamorosi linked an issue Mar 21, 2024 that may be closed by this pull request
2 tasks
@dreamorosi dreamorosi requested review from sthulb and am29d March 21, 2024 15:55
@github-actions github-actions bot added the feature PRs that introduce new features or minor changes label Mar 21, 2024
Copy link

sonarcloud bot commented Mar 24, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@dreamorosi dreamorosi merged commit a8dc5fa into main Mar 24, 2024
12 checks passed
@dreamorosi dreamorosi deleted the feat/jmespath_powertools_fns branch March 24, 2024 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature PRs that introduce new features or minor changes size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: JMESPath powertools functions
2 participants