Skip to content

ref(integrations): Rename request_bodies to max_request_body_size#2247

Merged
sentrivana merged 2 commits into
getsentry:masterfrom
mgaligniana:ticket_926
Jul 14, 2023
Merged

ref(integrations): Rename request_bodies to max_request_body_size#2247
sentrivana merged 2 commits into
getsentry:masterfrom
mgaligniana:ticket_926

Conversation

@mgaligniana

@mgaligniana mgaligniana commented Jul 12, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Hi!

This PR fixes #926

🎗️ Question: Where can I update the Sentry's documentation for this change? https://docs.sentry.io/platforms/python/configuration/options/#request-bodies

mgaligniana
mgaligniana commented Jul 12, 2023
View reviewed changes
Comment thread test-requirements.txt
@sentrivana

sentrivana commented Jul 13, 2023

Copy link
Copy Markdown
Contributor

Hey @mgaligniana, thanks for this PR!

If we're renaming a client option the change needs to be backwards compatible so that things don't break for folks that are currently setting request_bodies explicitly. The usual way we do this is to allow both the old and new option to coexist at the same time, mark the old one as deprecated, and make it essentially just an alias to the new one in the background.

As for the docs, on each page if you scroll all the way to the bottom there's a Suggest an edit to this page link that takes you directly to the source.

@mgaligniana
mgaligniana force-pushed the ticket_926 branch 2 times, most recently from 3e17e7f to 8119f00 Compare July 13, 2023 20:15
@mgaligniana mgaligniana mentioned this pull request Jul 13, 2023
Merged
3 tasks
@mgaligniana

mgaligniana commented Jul 13, 2023

Copy link
Copy Markdown
Contributor Author

Hey @mgaligniana, thanks for this PR!

If we're renaming a client option the change needs to be backwards compatible so that things don't break for folks that are currently setting request_bodies explicitly. The usual way we do this is to allow both the old and new option to coexist at the same time, mark the old one as deprecated, and make it essentially just an alias to the new one in the background.

As for the docs, on each page if you scroll all the way to the bottom there's a Suggest an edit to this page link that takes you directly to the source.

Thank you @sentrivana!

I added a test similiar to the work made by Anton for other deprecated option: 888c0e1

I also created a PR on the sentry-docs repo to update the documentation: getsentry/sentry-docs#7432

sentrivana
sentrivana requested changes Jul 14, 2023
View reviewed changes

@sentrivana sentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! Thanks for adding a test, too. Please take a look at the comment.

Comment thread sentry_sdk/serializer.py Outdated
Comment thread sentry_sdk/serializer.py Outdated
@sentrivana
sentrivana merged commit 2b1d1cc into getsentry:master Jul 14, 2023
@sentrivana

sentrivana commented Jul 14, 2023

Copy link
Copy Markdown
Contributor

Thank you @mgaligniana! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sentrivana sentrivana sentrivana approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

request_bodies should be renamed to max_request_body_size

2 participants

@mgaligniana @sentrivana