Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Implement CPS non-asyncio subscriber (#25)
* feat: Implement publisher and subscriber factories. * Implement CPS subscriber that takes a message callback and returns a StreamingPullFuture. * docs: document why we have two phase init
- Loading branch information
1 parent
4890cae
commit a9293c1
Showing
7 changed files
with
247 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
google/cloud/pubsublite/cloudpubsub/internal/streaming_pull_manager.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
from abc import ABC, abstractmethod | ||
from typing import Optional, Callable | ||
|
||
from google.api_core.exceptions import GoogleAPICallError | ||
|
||
|
||
CloseCallback = Callable[["StreamingPullManager", Optional[GoogleAPICallError]], None] | ||
|
||
|
||
class StreamingPullManager(ABC): | ||
"""The API expected by StreamingPullFuture.""" | ||
@abstractmethod | ||
def add_close_callback(self, close_callback: CloseCallback): | ||
pass | ||
|
||
@abstractmethod | ||
def close(self): | ||
pass |
80 changes: 80 additions & 0 deletions
80
google/cloud/pubsublite/cloudpubsub/internal/subscriber_impl.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
import concurrent.futures | ||
import threading | ||
from asyncio import CancelledError | ||
from concurrent.futures.thread import ThreadPoolExecutor | ||
from typing import ContextManager, Optional | ||
from google.api_core.exceptions import GoogleAPICallError | ||
from google.cloud.pubsublite.cloudpubsub.internal.managed_event_loop import ManagedEventLoop | ||
from google.cloud.pubsublite.cloudpubsub.internal.streaming_pull_manager import StreamingPullManager, CloseCallback | ||
from google.cloud.pubsublite.cloudpubsub.subscriber import AsyncSubscriber, MessageCallback | ||
|
||
|
||
class SubscriberImpl(ContextManager, StreamingPullManager): | ||
_underlying: AsyncSubscriber | ||
_callback: MessageCallback | ||
_executor: ThreadPoolExecutor | ||
|
||
_event_loop: ManagedEventLoop | ||
|
||
_poller_future: concurrent.futures.Future | ||
_close_lock: threading.Lock | ||
_failure: Optional[GoogleAPICallError] | ||
_close_callback: Optional[CloseCallback] | ||
_closed: bool | ||
|
||
def __init__(self, underlying: AsyncSubscriber, callback: MessageCallback, executor: ThreadPoolExecutor): | ||
self._underlying = underlying | ||
self._callback = callback | ||
self._executor = executor | ||
self._event_loop = ManagedEventLoop() | ||
self._close_lock = threading.Lock() | ||
self._failure = None | ||
self._close_callback = None | ||
self._closed = False | ||
|
||
def add_close_callback(self, close_callback: CloseCallback): | ||
""" | ||
A close callback must be set exactly once by the StreamingPullFuture managing this subscriber. | ||
This two-phase init model is made necessary by the requirements of StreamingPullFuture. | ||
""" | ||
with self._close_lock: | ||
assert self._close_callback is None | ||
self._close_callback = close_callback | ||
|
||
def close(self): | ||
with self._close_lock: | ||
if not self._closed: | ||
self._closed = True | ||
self.__exit__(None, None, None) | ||
|
||
def _fail(self, error: GoogleAPICallError): | ||
self._failure = error | ||
self.close() | ||
|
||
async def _poller(self): | ||
try: | ||
while True: | ||
message = await self._underlying.read() | ||
self._executor.submit(self._callback, message) | ||
except GoogleAPICallError as e: | ||
self._executor.submit(lambda: self._fail(e)) | ||
|
||
def __enter__(self): | ||
assert self._close_callback is not None | ||
self._event_loop.__enter__() | ||
self._event_loop.submit(self._underlying.__aenter__()).result() | ||
self._poller_future = self._event_loop.submit(self._poller()) | ||
return self | ||
|
||
def __exit__(self, exc_type, exc_value, traceback): | ||
try: | ||
self._poller_future.cancel() | ||
self._poller_future.result() | ||
except CancelledError: | ||
pass | ||
self._event_loop.submit(self._underlying.__aexit__(exc_type, exc_value, traceback)).result() | ||
self._event_loop.__exit__(exc_type, exc_value, traceback) | ||
assert self._close_callback is not None | ||
self._executor.shutdown(wait=False) # __exit__ may be called from the executor. | ||
self._close_callback(self, self._failure) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
tests/unit/pubsublite/cloudpubsub/internal/assigning_subscriber_test.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
93 changes: 93 additions & 0 deletions
93
tests/unit/pubsublite/cloudpubsub/internal/subscriber_impl_test.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
import asyncio | ||
import concurrent | ||
from concurrent.futures.thread import ThreadPoolExecutor | ||
from queue import Queue | ||
|
||
from asynctest.mock import MagicMock | ||
import pytest | ||
from google.api_core.exceptions import FailedPrecondition | ||
from google.cloud.pubsub_v1.subscriber.message import Message | ||
from google.pubsub_v1 import PubsubMessage | ||
|
||
from google.cloud.pubsublite.cloudpubsub.internal.streaming_pull_manager import CloseCallback | ||
from google.cloud.pubsublite.cloudpubsub.internal.subscriber_impl import SubscriberImpl | ||
from google.cloud.pubsublite.cloudpubsub.subscriber import AsyncSubscriber, MessageCallback | ||
from google.cloud.pubsublite.testing.test_utils import Box | ||
|
||
|
||
@pytest.fixture() | ||
def async_subscriber(): | ||
subscriber = MagicMock(spec=AsyncSubscriber) | ||
subscriber.__aenter__.return_value = subscriber | ||
return subscriber | ||
|
||
|
||
@pytest.fixture() | ||
def message_callback(): | ||
return MagicMock(spec=MessageCallback) | ||
|
||
|
||
@pytest.fixture() | ||
def close_callback(): | ||
return MagicMock(spec=CloseCallback) | ||
|
||
|
||
@pytest.fixture() | ||
def subscriber(async_subscriber, message_callback, close_callback): | ||
return SubscriberImpl(async_subscriber, message_callback, ThreadPoolExecutor(max_workers=1)) | ||
|
||
|
||
async def sleep_forever(*args, **kwargs): | ||
await asyncio.sleep(float("inf")) | ||
|
||
|
||
def test_init(subscriber: SubscriberImpl, async_subscriber, close_callback): | ||
async_subscriber.read.side_effect = sleep_forever | ||
subscriber.add_close_callback(close_callback) | ||
subscriber.__enter__() | ||
async_subscriber.__aenter__.assert_called_once() | ||
subscriber.close() | ||
async_subscriber.__aexit__.assert_called_once() | ||
close_callback.assert_called_once_with(subscriber, None) | ||
|
||
|
||
def test_failed(subscriber: SubscriberImpl, async_subscriber, close_callback): | ||
error = FailedPrecondition("bad read") | ||
async_subscriber.read.side_effect = error | ||
|
||
close_called = concurrent.futures.Future() | ||
close_callback.side_effect = lambda manager, err: close_called.set_result(None) | ||
|
||
subscriber.add_close_callback(close_callback) | ||
subscriber.__enter__() | ||
async_subscriber.__aenter__.assert_called_once() | ||
close_called.result() | ||
async_subscriber.__aexit__.assert_called_once() | ||
close_callback.assert_called_once_with(subscriber, error) | ||
|
||
|
||
def test_messages_received(subscriber: SubscriberImpl, async_subscriber, message_callback, close_callback): | ||
message1 = Message(PubsubMessage(message_id="1")._pb, "", 0, None) | ||
message2 = Message(PubsubMessage(message_id="2")._pb, "", 0, None) | ||
|
||
counter = Box[int]() | ||
counter.val = 0 | ||
|
||
async def on_read() -> Message: | ||
counter.val += 1 | ||
if counter.val == 1: | ||
return message1 | ||
if counter.val == 2: | ||
return message2 | ||
await sleep_forever() | ||
|
||
async_subscriber.read.side_effect = on_read | ||
|
||
results = Queue() | ||
message_callback.side_effect = lambda m: results.put(m.message_id) | ||
|
||
subscriber.add_close_callback(close_callback) | ||
subscriber.__enter__() | ||
assert results.get() == "1" | ||
assert results.get() == "2" | ||
subscriber.close() |