feat(parser): add models for API GW Websockets events #5597

ran-isenberg · 2024-11-20T07:24:13Z

Issue number: #5543

Summary

Added support for parser and websockers api

Changes

Parser envelope for the message type.
models for message, connect and disconnect
unit tests
3 input files
documentation

Used this doc and my own files.
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Meet tenets criteria
I have performed a self-review of this change
Changes have been tested
Changes are documented
PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

Migration process documented
Implement warnings (if it can live side by side)

Acknowledgment

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.

github-actions · 2024-11-20T09:23:16Z

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

leandrodamascena · 2024-11-20T09:23:49Z

Hi @ran-isenberg! Thanks for submitting this PR!

Assigning @anafalcao to review this.

codecov · 2024-11-20T09:27:29Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.17%. Comparing base (3726a4b) to head (a149ac1).
Report is 2 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #5597      +/-   ##
===========================================
+ Coverage    96.14%   96.17%   +0.02%     
===========================================
  Files          229      231       +2     
  Lines        10854    10915      +61     
  Branches      2018     2018              
===========================================
+ Hits         10436    10497      +61     
  Misses         329      329              
  Partials        89       89

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

anafalcao · 2024-11-20T23:56:11Z

Thank you for submitting this PR so promptly, @ran-isenberg ! I was off today, but tomorrow I'll begin to review it :)

aws_lambda_powertools/utilities/parser/models/__init__.py

anafalcao

Hey @ran-isenberg, I suggested some changes in a initial review.
I see the CI is failing, but don't worry, it's not related to your PR. We are verifying it

aws_lambda_powertools/utilities/parser/models/__init__.py

aws_lambda_powertools/utilities/parser/models/apigw_websocket_api.py

ran-isenberg · 2024-11-21T15:01:19Z

@anafalcao all fixed! also renamed one of the files and found a documentation mistake.
Please review again :)

anafalcao

Hey @ran-isenberg ! Looking good so far, but there are a few comments. Can you take a look, please?

aws_lambda_powertools/utilities/parser/models/apigw_websocket.py

docs/utilities/parser.md

anafalcao · 2024-11-22T14:41:42Z

Np, thanks again @ran-isenberg ! I pushed those small changes, but the overall looks very good!
@leandrodamascena can you review it as well?
Thanks!

leandrodamascena

Hi @ran-isenberg! Thank you very much for sending this PR, it's very good as always.

I know that the event sent by AWS uses CamelCase by default and we can't change it for obvious reasons, but I would like to make the fields snake case on our side and work with Pydantic Fields. I also know that most of our events use CamelCase, but I would like to have this convention about capitalization - We've done this on newer models like Cloudformation Custom Resource, VPC Lattice 2, and Bedrock. Can you please change this @anafalcao? I left 2 examples that you can extend to any other.

After this change we are good to merge this PR! 🚀

aws_lambda_powertools/utilities/parser/models/apigw_websocket.py

aws_lambda_powertools/utilities/parser/envelopes/apigw_websocket_api.py

aws_lambda_powertools/utilities/parser/models/apigw_websocket.py

aws_lambda_powertools/utilities/parser/envelopes/apigw_websocket_api.py

sonarqubecloud · 2024-11-24T21:23:04Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

I'm approving

leandrodamascena

Thanks for addressing all the feedback @anafalcao!

I'm approving this PullRequest and please open a new issue to add the same support for Event Source Data Classes!

APPROVED!!!

ran-isenberg · 2024-11-25T04:24:48Z

Whoohooo! Thx @anafalcao and @leandrodamascena

feature(parser): Parser models for API GW Websockets Events

b8a45ac

ran-isenberg requested a review from a team as a code owner November 20, 2024 07:24

boring-cyborg bot added documentation Improvements or additions to documentation tests labels Nov 20, 2024

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 20, 2024

ran-isenberg changed the title ~~feature(parser): Parser models for API GW Websockets Events~~ feat(parser): Parser models for API GW Websockets Events Nov 20, 2024

ran-isenberg mentioned this pull request Nov 20, 2024

Feature request: Parser models for API GW Websockets Events #5543

Closed

2 tasks

leandrodamascena requested a review from anafalcao November 20, 2024 09:22

github-actions bot added do-not-merge need-issue PRs that are missing related issues feature New feature or functionality and removed documentation Improvements or additions to documentation labels Nov 20, 2024

leandrodamascena linked an issue Nov 20, 2024 that may be closed by this pull request

Feature request: Parser models for API GW Websockets Events #5543

Closed

2 tasks

Merge branch 'develop' into websocket

efb0d79

boring-cyborg bot added the documentation Improvements or additions to documentation label Nov 20, 2024

github-actions bot removed the documentation Improvements or additions to documentation label Nov 20, 2024

Merge branch 'develop' into websocket

bb7ef68

boring-cyborg bot added the documentation Improvements or additions to documentation label Nov 20, 2024

Merge branch 'develop' into websocket

90ff222

anafalcao changed the title ~~feat(parser): Parser models for API GW Websockets Events~~ feat(parser): add models for API GW Websockets events Nov 21, 2024

Merge branch 'develop' into websocket

5d7573c

anafalcao reviewed Nov 21, 2024

View reviewed changes

aws_lambda_powertools/utilities/parser/models/__init__.py Outdated Show resolved Hide resolved

anafalcao requested changes Nov 21, 2024

View reviewed changes

aws_lambda_powertools/utilities/parser/models/__init__.py Outdated Show resolved Hide resolved

aws_lambda_powertools/utilities/parser/models/apigw_websocket_api.py Outdated Show resolved Hide resolved

code review fixes

963b508

anafalcao previously requested changes Nov 22, 2024

View reviewed changes

aws_lambda_powertools/utilities/parser/models/apigw_websocket.py Show resolved Hide resolved

docs/utilities/parser.md Outdated Show resolved Hide resolved

anafalcao and others added 2 commits November 22, 2024 10:54

Merge branch 'develop' into websocket

b23f9f3

fix typo in the doc. add optional model

1c8f1c6

anafalcao requested a review from leandrodamascena November 22, 2024 14:41

Ana Falcao and others added 3 commits November 22, 2024 12:01

fix optional field

9aad542

Merge branch 'develop' into websocket

ecc49cb

Merge branch 'develop' into websocket

1a100f7

leandrodamascena requested changes Nov 23, 2024

View reviewed changes

Merge branch 'develop' into websocket

f13d128

leandrodamascena reviewed Nov 23, 2024

View reviewed changes

aws_lambda_powertools/utilities/parser/envelopes/apigw_websocket_api.py Outdated Show resolved Hide resolved

Ana Falcao and others added 3 commits November 24, 2024 11:40

change names to snake case

bffc462

Merge branch 'develop' into websocket

4c65191

Merge branch 'develop' into websocket

a149ac1

leandrodamascena self-requested a review November 24, 2024 21:27

leandrodamascena approved these changes Nov 24, 2024

View reviewed changes

leandrodamascena merged commit 20c0b74 into aws-powertools:develop Nov 24, 2024
10 of 12 checks passed

ran-isenberg deleted the websocket branch November 25, 2024 04:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(parser): add models for API GW Websockets events #5597

feat(parser): add models for API GW Websockets events #5597

ran-isenberg commented Nov 20, 2024 •

edited by anafalcao

Loading

github-actions bot commented Nov 20, 2024

leandrodamascena commented Nov 20, 2024

codecov bot commented Nov 20, 2024 •

edited

Loading

anafalcao commented Nov 20, 2024

anafalcao left a comment

ran-isenberg commented Nov 21, 2024

anafalcao left a comment

anafalcao commented Nov 22, 2024

leandrodamascena left a comment

sonarqubecloud bot commented Nov 24, 2024

leandrodamascena left a comment

ran-isenberg commented Nov 25, 2024

feat(parser): add models for API GW Websockets events #5597

feat(parser): add models for API GW Websockets events #5597

Conversation

ran-isenberg commented Nov 20, 2024 • edited by anafalcao Loading

Summary

Changes

User experience

Checklist

Acknowledgment

github-actions bot commented Nov 20, 2024

leandrodamascena commented Nov 20, 2024

codecov bot commented Nov 20, 2024 • edited Loading

Codecov Report

anafalcao commented Nov 20, 2024

anafalcao left a comment

Choose a reason for hiding this comment

ran-isenberg commented Nov 21, 2024

anafalcao left a comment

Choose a reason for hiding this comment

anafalcao commented Nov 22, 2024

leandrodamascena left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 24, 2024

Quality Gate passed

leandrodamascena left a comment

Choose a reason for hiding this comment

ran-isenberg commented Nov 25, 2024

ran-isenberg commented Nov 20, 2024 •

edited by anafalcao

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading