Repository navigation
fix(python): Update note on default behavior in StrawberryIntegration - #15336
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| By default, the SDK will use the synchronous version of the integration. | ||
|
|
There was a problem hiding this comment.
Bug: Documentation states SDK defaults to synchronous execution for async_execution, but SDK still guesses based on frameworks.
Severity: HIGH | Confidence: 0.95
🔍 Detailed Analysis
The documentation states that the SDK will default to synchronous execution when the async_execution parameter is not explicitly provided. However, the actual SDK behavior is to make a best-effort guess regarding async_execution based on installed web frameworks. This discrepancy can mislead users into incorrectly configuring their Strawberry integration, potentially causing silent failures or unexpected behavior when async resolvers are used.
💡 Suggested Fix
Either update the SDK code to default to synchronous execution when async_execution is not provided, or revert the documentation to accurately reflect the SDK's current best-effort guessing behavior.
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: docs/platforms/python/integrations/strawberry/index.mdx#L126-L127
Potential issue: The documentation states that the SDK will default to synchronous
execution when the `async_execution` parameter is not explicitly provided. However, the
actual SDK behavior is to make a best-effort guess regarding `async_execution` based on
installed web frameworks. This discrepancy can mislead users into incorrectly
configuring their Strawberry integration, potentially causing silent failures or
unexpected behavior when async resolvers are used.
Did we get this right? 👍 / 👎 to inform future reviews.
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
…#15336) <!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR We changed the default behavior of the integration in the latest Python SDK release. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [x] Other deadline: ASAP as we just released this - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
DESCRIBE YOUR PR
We changed the default behavior of the integration in the latest Python SDK release.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES