Skip to content

fix(event_handler): apply serialization as the last operation for middlewares #3392

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

Merged
merged 5 commits into from
Nov 22, 2023

Conversation

rubenfonseca
Copy link
Contributor

@rubenfonseca rubenfonseca commented Nov 22, 2023

Issue number: #3391

Summary

Changes

Please provide a summary of what's being changed

This PR moves the serialization on event handler to the very last step before returning to the client. This allows all middlewares to see the original returns from the handler.

The serialization is also only applied if the content type of the response is JSON. This means we don't try to apply the serialization to HTML or PLAIN responses.

User experience

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

After this PR, a user can again use a custom serializer, even when using data validation.

Checklist

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

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.

@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 22, 2023
@rubenfonseca rubenfonseca changed the title chore(event_handler): only apply serialization at the end chore(event_handler): apply serialization as the last operation Nov 22, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f94526f) 95.39% compared to head (1498b9d) 95.39%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3392   +/-   ##
========================================
  Coverage    95.39%   95.39%           
========================================
  Files          208      208           
  Lines         9637     9638    +1     
  Branches      1766     1766           
========================================
+ Hits          9193     9194    +1     
  Misses         330      330           
  Partials       114      114           

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

@rubenfonseca rubenfonseca marked this pull request as ready for review November 22, 2023 12:37
@rubenfonseca rubenfonseca requested review from a team and heitorlessa November 22, 2023 12:37
@heitorlessa heitorlessa changed the title chore(event_handler): apply serialization as the last operation fix(event_handler): apply serialization as the last operation for middlewares Nov 22, 2023
@pull-request-size pull-request-size bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 22, 2023
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pending CI checks

Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tiny change to prevent a possible hyrum law case of an unknown internal dependency

Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@heitorlessa heitorlessa merged commit 6a47ee8 into develop Nov 22, 2023
@heitorlessa heitorlessa deleted the rf/move_json_dumps_v2 branch November 22, 2023 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
event_handlers size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: JSON serialization should be the last operation before returning a response from an event handler
3 participants