Skip to content

ref(transport): Add shared sync/async transport superclass and create a sync http subclass #4572

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

Open
wants to merge 12 commits into
base: potel-base
Choose a base branch
from

Conversation

srothh
Copy link
Member

@srothh srothh commented Jul 11, 2025

Moved shared sync/async logic into superclass, and moved sync transport specific code into a new subclass(BaseSyncHttpTransport), from which the current transport implementations inherit. Note that currently the threaded worker is still being created in the superclass. In a next step, I want to add an abstract worker class for both the threaded and async task worker, however I wanted to keep this PR atomic and only re-implement the sync transport with the new hierarchy.

Fixes GH-4568

Copy link

codecov bot commented Jul 11, 2025

❌ 17 Tests Failed:

Tests completed Failed Passed Skipped
20854 17 20837 1098
View the top 3 failed test(s) by shortest run time
tests.integrations.redis.test_redis::test_breadcrumbs
Stack Traces | 0.108s run time
.../integrations/redis/test_redis.py:231: in test_breadcrumbs
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'
tests.integrations.redis.test_redis::test_redis_pipeline[True-True-expected_first_ten1]
Stack Traces | 0.11s run time
.../integrations/redis/test_redis.py:62: in test_redis_pipeline
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'
tests.integrations.redis.test_redis::test_data_truncation_custom
Stack Traces | 0.111s run time
.../integrations/redis/test_redis.py:205: in test_data_truncation_custom
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

@srothh srothh changed the title ref(transport): Added shared sync/async transport superclass and created a sync http subclass ref(transport): Add shared sync/async transport superclass and create a sync http subclass Jul 11, 2025
@srothh srothh marked this pull request as ready for review July 11, 2025 12:16
@srothh srothh requested a review from a team as a code owner July 11, 2025 12:16
@srothh srothh marked this pull request as draft July 11, 2025 12:17
@srothh srothh marked this pull request as ready for review July 11, 2025 12:17
@srothh srothh marked this pull request as draft July 17, 2025 09:43
@srothh srothh force-pushed the srothh/transport-class-hierarchy branch from 53b92f2 to 3607d44 Compare July 21, 2025 09:48
@srothh srothh marked this pull request as ready for review July 22, 2025 10:02
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

Other than my little nitpicking, this looks great!

srothh added 10 commits July 28, 2025 10:48
…ted a sync transport HTTP subclass

Moved shared sync/async logic into a new superclass (HttpTransportCore), and moved sync transport specific code into a new subclass(BaseSyncHttpTransport), from which the current transport implementations inherit

Fixes GH-4568
Removed an unnecessary TODO message and reverted a class name change for BaseHTTPTransport.

GH-4568
Adds test coverage for the error handling path when HTTP requests return
error status codes.

GH-4568
Restore comments accidentally removed during a previous commit.
Refactored class names such that BaseHttpTransport now has the same functionality as before the hierarchy refactor

GH-4568
Add a new flush_async method in the Transport ABC. This is needed for the async transport, as calling it from the client
while preserving execution order in close will require flush to be a coroutine, not a function.

GH-4568
Move flush_async down to the specific async transport subclass. This makes more sense anyway, as
this will only be required by the async transport. If more async transports are expected,
another shared superclass can be created.

GH-4568
Add necessary type annotations to the core HttpTransport to accomodate for async transport.

GH-4568
@srothh srothh force-pushed the srothh/transport-class-hierarchy branch from 062ab5b to 4e56e5c Compare July 28, 2025 08:48
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

Looks good.

@sl0thentr0py
Copy link
Member

sl0thentr0py commented Aug 12, 2025

okay, so now that we have 2 base/core classes, it's a bit more confusing than before what the contracts of each entity actually are.

I want us to define more clearly and explicitly what is

  • shared across sync and async
  • only sync
    • only http2
  • only async

but I think it's clearer if we merge all the changes in first and then do some shuffling. We will do that with mixin classes.
https://adamj.eu/tech/2025/05/01/python-type-hints-mixin-classes/

srothh and others added 2 commits August 12, 2025 15:13
…orker (#4580)

Add a new abstract base class for the background worker implementations
in the transport. This allows for implementation of the upcoming async
task-based worker in addition to the current thread based worker used in
the sync context. Additionally, add a factory method in the
HttpTransportCore shared class, to allow the worker methods to live
higher up in the class hierarchy regardless of specific implementation.

GH-4578
Add a new implementation of the transport background worker based on an
async task. This worker mostly mirrors the same functionality as the
thread-based worker, with the exception that it exposes a non-blocking
async flush (which can be awaited from an async context). Furthermore,
the worker itself is not thread-safe and should be called using
[run_coroutine_threadsafe](https://docs.python.org/3/library/asyncio-task.html#asyncio.run_coroutine_threadsafe)
or similar when called from another thread (this is fixed and handled by
the transport). I have kept the fork check from the threaded worker, but
I am not sure if it is necessary as forking in an async application
would also break the event loop.

GH-4581

---------

Co-authored-by: Neel Shah <neel.shah@sentry.io>
async def _process_callback(self, callback: Callable[[], Any]) -> None:
# Callback is an async coroutine, need to await it
await callback()

Copy link

Choose a reason for hiding this comment

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

Bug: AsyncWorker Fails with Synchronous Callbacks

The AsyncWorker._process_callback method unconditionally awaits the callback. This conflicts with the Worker.submit interface, which accepts Callable[[], Any] (including synchronous functions). As a result, passing synchronous callbacks (like those used in BaseHttpTransport.capture_envelope) to AsyncWorker will cause a TypeError ("object is not awaitable"), making it incompatible with current usage.

Fix in Cursor Fix in Web

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.

3 participants