varco-ws 0.1.0__tar.gz

varco_ws-0.1.0/.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+todo*.txt
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

varco_ws-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: varco-ws
+Version: 0.1.0
+Summary: WebSocket and SSE event bus backends for varco — real-time browser push
+Project-URL: Homepage, https://github.com/edoardoscarpaci/varco
+Project-URL: Repository, https://github.com/edoardoscarpaci/varco/tree/main/varco_ws
+Project-URL: Issues, https://github.com/edoardoscarpaci/varco/issues
+Author-email: "edoardo.scarpaci" <edoardo.scarpaci@gmail.com>
+License: Apache-2.0
+Keywords: async,domain-events,event-bus,fastapi,sse,varco,websocket
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: varco-core

varco_ws-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name          = "varco-ws"
+version       = "0.1.0"
+description   = "WebSocket and SSE event bus backends for varco — real-time browser push"
+authors       = [{ name = "edoardo.scarpaci", email = "edoardo.scarpaci@gmail.com" }]
+readme        = "README.md"
+license       = { text = "Apache-2.0" }
+requires-python = ">=3.12"
+keywords      = ["fastapi", "websocket", "sse", "async", "event-bus", "domain-events", "varco"]
+classifiers   = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    # Workspace sibling — resolved from the monorepo via [tool.uv.sources] below.
+    "varco-core",
+]
+
+[project.urls]
+Homepage   = "https://github.com/edoardoscarpaci/varco"
+Repository = "https://github.com/edoardoscarpaci/varco/tree/main/varco_ws"
+Issues     = "https://github.com/edoardoscarpaci/varco/issues"
+
+[tool.uv.sources]
+# Resolve varco-core from the workspace instead of PyPI during development.
+varco-core = { workspace = true }
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+]
+
+[build-system]
+requires      = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["varco_ws"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths    = ["tests"]

varco_ws-0.1.0/tests/test_di.py

@@ -0,0 +1,261 @@
+"""
+tests.test_di
+=============
+Unit tests for varco_ws.di — WebSocketConfiguration and SSEConfiguration.
+
+Covers:
+    WebSocketConfiguration  — provides a WebSocketEventBus singleton that
+                               wraps the container's AbstractEventBus.
+    SSEConfiguration        — provides an SSEEventBus singleton that wraps
+                               the container's AbstractEventBus.
+    varco_ws public __init__ — DI classes are exported at the package level.
+
+All tests use InMemoryEventBus — no real broker required.
+"""
+
+from __future__ import annotations
+
+import pytest
+
+from varco_core.event.base import AbstractEventBus
+from varco_core.event.memory import InMemoryEventBus
+
+from varco_ws import SSEConfiguration, WebSocketConfiguration
+from varco_ws.di import SSEConfiguration as SSEConfigurationDirect
+from varco_ws.di import WebSocketConfiguration as WebSocketConfigurationDirect
+from varco_ws.sse import SSEEventBus
+from varco_ws.websocket import WebSocketEventBus
+
+
+# ── Helpers ────────────────────────────────────────────────────────────────────
+
+
+def _make_container_with_bus() -> tuple[object, InMemoryEventBus]:
+    """
+    Build a minimal providify DIContainer with an InMemoryEventBus registered
+    as AbstractEventBus.  Returns (container, bus).
+    """
+    try:
+        from providify import DIContainer
+    except ImportError:
+        pytest.skip("providify not installed — skipping DI tests")
+
+    container = DIContainer()
+    bus = InMemoryEventBus()
+    # Register InMemoryEventBus as the AbstractEventBus implementation.
+    container.provide(lambda: bus, AbstractEventBus)
+    return container, bus
+
+
+# ── __init__ re-export tests ───────────────────────────────────────────────────
+
+
+def test_websocket_configuration_exported_from_init() -> None:
+    """
+    WebSocketConfiguration must be importable from the top-level varco_ws package.
+    This guards against accidental removal from __init__.py.
+    """
+    assert WebSocketConfiguration is WebSocketConfigurationDirect
+
+
+def test_sse_configuration_exported_from_init() -> None:
+    """
+    SSEConfiguration must be importable from the top-level varco_ws package.
+    """
+    assert SSEConfiguration is SSEConfigurationDirect
+
+
+# ── WebSocketConfiguration tests ──────────────────────────────────────────────
+
+
+def test_websocket_configuration_provides_websocket_event_bus() -> None:
+    """
+    After installing WebSocketConfiguration, the container must resolve
+    WebSocketEventBus.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+
+    ws_bus = container.get(WebSocketEventBus)
+    assert isinstance(ws_bus, WebSocketEventBus)
+
+
+def test_websocket_configuration_wraps_registered_bus() -> None:
+    """
+    The WebSocketEventBus provided by WebSocketConfiguration must wrap
+    the AbstractEventBus that was registered in the container.
+    """
+    container, bus = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+
+    ws_bus = container.get(WebSocketEventBus)
+    # Internal attribute _bus must be the registered InMemoryEventBus.
+    assert ws_bus._bus is bus
+
+
+def test_websocket_configuration_singleton() -> None:
+    """
+    WebSocketEventBus must be a singleton — resolving it twice returns the
+    same instance.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+
+    first = container.get(WebSocketEventBus)
+    second = container.get(WebSocketEventBus)
+    assert first is second
+
+
+def test_websocket_configuration_bus_not_started_after_install() -> None:
+    """
+    The WebSocketEventBus must NOT be started automatically by the DI module.
+    Callers must call start() explicitly in their lifespan handler.
+
+    DESIGN: not starting automatically avoids an asyncio.Loop dependency at
+    installation time — the container may be built synchronously before an
+    event loop is running.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+
+    ws_bus = container.get(WebSocketEventBus)
+    # Internal subscription handle is None when not started.
+    assert ws_bus._subscription is None
+
+
+# ── SSEConfiguration tests ────────────────────────────────────────────────────
+
+
+def test_sse_configuration_provides_sse_event_bus() -> None:
+    """
+    After installing SSEConfiguration, the container must resolve SSEEventBus.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(SSEConfiguration)
+
+    sse_bus = container.get(SSEEventBus)
+    assert isinstance(sse_bus, SSEEventBus)
+
+
+def test_sse_configuration_wraps_registered_bus() -> None:
+    """
+    The SSEEventBus provided by SSEConfiguration must wrap the
+    AbstractEventBus that was registered in the container.
+    """
+    container, bus = _make_container_with_bus()
+    container.install(SSEConfiguration)
+
+    sse_bus = container.get(SSEEventBus)
+    assert sse_bus._bus is bus
+
+
+def test_sse_configuration_singleton() -> None:
+    """SSEEventBus must be a singleton."""
+    container, _ = _make_container_with_bus()
+    container.install(SSEConfiguration)
+
+    first = container.get(SSEEventBus)
+    second = container.get(SSEEventBus)
+    assert first is second
+
+
+def test_sse_configuration_bus_not_started_after_install() -> None:
+    """
+    The SSEEventBus must NOT be started automatically.  Callers start it
+    in the FastAPI lifespan handler.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(SSEConfiguration)
+
+    sse_bus = container.get(SSEEventBus)
+    assert sse_bus._subscription is None
+
+
+# ── Combined WS + SSE tests ───────────────────────────────────────────────────
+
+
+def test_both_configurations_can_be_installed_together() -> None:
+    """
+    Installing both WebSocketConfiguration and SSEConfiguration in the same
+    container must not conflict — they provide different types.
+    """
+    container, _ = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+    container.install(SSEConfiguration)
+
+    ws_bus = container.get(WebSocketEventBus)
+    sse_bus = container.get(SSEEventBus)
+
+    # Different types — different instances.
+    assert isinstance(ws_bus, WebSocketEventBus)
+    assert isinstance(sse_bus, SSEEventBus)
+    assert ws_bus is not sse_bus
+
+
+async def test_ws_bus_is_functional_after_start() -> None:
+    """
+    The WebSocketEventBus obtained from the container must be fully functional
+    after manually calling start().
+
+    DESIGN: functional test to confirm the DI-provided adapter delivers events,
+    not just that it was constructed correctly.
+    """
+    import asyncio
+
+    from varco_core.event.base import Event
+
+    class PingEvent(Event):
+        __event_type__ = "test.ping"
+        count: int = 0
+
+    container, bus = _make_container_with_bus()
+    container.install(WebSocketConfiguration)
+
+    ws_bus = container.get(WebSocketEventBus)
+    await ws_bus.start()
+
+    class FakeWebSocket:
+        sent: list[str] = []
+
+        async def send_text(self, msg: str) -> None:
+            self.sent.append(msg)
+
+    fake_ws = FakeWebSocket()
+    async with ws_bus.connect(fake_ws):
+        await bus.publish(PingEvent(count=1))
+        await asyncio.sleep(0)
+        await asyncio.sleep(0)
+
+    assert len(fake_ws.sent) == 1
+
+    await ws_bus.stop()
+
+
+async def test_sse_bus_is_functional_after_start() -> None:
+    """
+    The SSEEventBus obtained from the container must be fully functional
+    after manually calling start().
+    """
+    import asyncio
+
+    from varco_core.event.base import Event
+
+    class PongEvent(Event):
+        __event_type__ = "test.pong"
+        value: str = ""
+
+    container, bus = _make_container_with_bus()
+    container.install(SSEConfiguration)
+
+    sse_bus = container.get(SSEEventBus)
+    await sse_bus.start()
+
+    async with sse_bus.subscribe() as conn:
+        await bus.publish(PongEvent(value="hello"))
+        await asyncio.sleep(0)
+
+        message = await asyncio.wait_for(conn._queue.get(), timeout=1.0)
+        assert "test.pong" in message
+        assert "hello" in message
+
+    await sse_bus.stop()