Skip to content

fix(python): Update note on default behavior in StrawberryIntegration - #15336

Merged
sentrivana merged 1 commit into
masterfrom
ivana/python/strawberry-behavior-change
Oct 29, 2025
Merged

sentrivana merged 1 commit into
masterfrom
ivana/python/strawberry-behavior-change

Conversation

@sentrivana

@sentrivana sentrivana commented Oct 29, 2025 •

Copy link
Copy Markdown
Contributor

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.):
  • 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

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

@vercel

vercel Bot commented Oct 29, 2025 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Oct 29, 2025 0:30am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Oct 29, 2025 0:30am

Comment on lines +126 to 127
By default, the SDK will use the synchronous version of the integration.

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.

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.

@codecov

codecov Bot commented Oct 29, 2025 •

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.16MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.98MB -9 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js 6.46kB 7.46kB 645.5% ⚠️
server/middleware-*.js -6.46kB 1.0kB -86.59%
static/hEzbwYu8uIjV20WtAyuz7/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/hEzbwYu8uIjV20WtAyuz7/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/t895JvXRAA8Zl7C4tlD0F/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/t895JvXRAA8Zl7C4tlD0F/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@sentrivana
sentrivana merged commit 1d6b9ce into master Oct 29, 2025
13 checks passed
@sentrivana
sentrivana deleted the ivana/python/strawberry-behavior-change branch October 29, 2025 13:09
philippsuess pushed a commit that referenced this pull request Oct 30, 2025
…#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/)
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 14, 2025

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 28fa9091 Deployed Oct 29, 2025 by vercel[bot]
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants