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

ref(integrations): Rename request_bodies to max_request_body_size #2247

Merged
merged 2 commits into from
Jul 14, 2023

Conversation

mgaligniana
Copy link
Contributor

@mgaligniana mgaligniana commented Jul 12, 2023

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

@sentrivana
Copy link
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
Copy link
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

Copy link
Contributor

@sentrivana sentrivana left a comment

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.

sentry_sdk/serializer.py Outdated Show resolved Hide resolved
sentry_sdk/serializer.py Outdated Show resolved Hide resolved
@sentrivana sentrivana merged commit 2b1d1cc into getsentry:master Jul 14, 2023
246 checks passed
@sentrivana
Copy link
Contributor

Thank you @mgaligniana! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

request_bodies should be renamed to max_request_body_size
2 participants