openframe-protocol-grpc 0.2.0__tar.gz → 0.4.0__tar.gz

{openframe_protocol_grpc-0.2.0 → openframe_protocol_grpc-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: openframe-protocol-grpc
-Version: 0.2.0
+Version: 0.4.0
 Summary: OpenFrame Microservice Suite - gRPC server and client binding for openframe.core.inbound/remote.
 Project-URL: Homepage, https://github.com/Furious-Meteors/openframe-protocol
 Project-URL: Documentation, https://furious-meteors.github.io/openframe-protocol/
@@ -35,6 +35,7 @@ Requires-Dist: pytest-mock>=3.14; extra == 'dev'
 Requires-Dist: pytest>=8.0; extra == 'dev'
 Provides-Extra: server
 Requires-Dist: grpcio>=1.60; extra == 'server'
+Requires-Dist: pydantic>=2.0; extra == 'server'
 Description-Content-Type: text/markdown
 
 # openframe-protocol-grpc
@@ -87,10 +88,31 @@ get_item = GrpcRemoteQueryClient(target="items-service:50051", route="get_item")
 item = await get_item.execute("abc-123")
 ```
 
+## Streaming — `bind_service_stream`
+
+`GenericService` also has `CallStream` (`stream GenericRequest` → `stream GenericResponse`), the
+bidirectional-streaming counterpart to `Call` — the `SessionHandler` (ADR-008, `openframe-core`)
+binding for long-lived connections, same route-multiplexing trick (`x-openframe-route` metadata).
+Needed no new dependency — `grpcio` already supports streaming natively; this package simply hadn't
+used it until now:
+
+```python
+from openframe.protocol.grpc import bind_service_stream
+
+bind_service_stream(server, "artifact_updates", handler_factory=lambda: ArtifactUpdates())
+```
+
+`on_open` runs — and can reject — before the method's first `yield`, mirroring `bind_service`'s own
+reject path exactly. A real race not present in `-http`'s own session transports (SSE, WebSocket):
+the inbound `request_iterator` and the method's own outbound `yield` loop are two
+independently-scheduled `grpc.aio` signals for the same disconnect, confirmed by spiking to resolve
+consistently (not randomly) in one specific order — see `openframe.protocol.grpc.server`'s own
+module docstring for the full finding and fix (polling `context.cancelled()` for a short window
+rather than trusting the inbound side ending on its own).
+
 ## Status
 
-Experimental, M4 of the project's own build plan. Both
-`TransportConformanceTests` and `RemoteClientConformanceTests`
-(`openframe-protocol-base`) pass against this package for real — the
-point of building it: proving the architecture generalizes past HTTP,
-not just adding a second transport for its own sake.
+Experimental, M4 of the project's own build plan. `TransportConformanceTests`,
+`RemoteClientConformanceTests`, and `SessionConformanceTests` (all `openframe-protocol-base`) pass
+against this package for real — the point of building it: proving the architecture generalizes past
+HTTP, not just adding a second transport for its own sake.

{openframe_protocol_grpc-0.2.0 → openframe_protocol_grpc-0.4.0}/README.md

@@ -48,10 +48,31 @@ get_item = GrpcRemoteQueryClient(target="items-service:50051", route="get_item")
 item = await get_item.execute("abc-123")
 ```
 
+## Streaming — `bind_service_stream`
+
+`GenericService` also has `CallStream` (`stream GenericRequest` → `stream GenericResponse`), the
+bidirectional-streaming counterpart to `Call` — the `SessionHandler` (ADR-008, `openframe-core`)
+binding for long-lived connections, same route-multiplexing trick (`x-openframe-route` metadata).
+Needed no new dependency — `grpcio` already supports streaming natively; this package simply hadn't
+used it until now:
+
+```python
+from openframe.protocol.grpc import bind_service_stream
+
+bind_service_stream(server, "artifact_updates", handler_factory=lambda: ArtifactUpdates())
+```
+
+`on_open` runs — and can reject — before the method's first `yield`, mirroring `bind_service`'s own
+reject path exactly. A real race not present in `-http`'s own session transports (SSE, WebSocket):
+the inbound `request_iterator` and the method's own outbound `yield` loop are two
+independently-scheduled `grpc.aio` signals for the same disconnect, confirmed by spiking to resolve
+consistently (not randomly) in one specific order — see `openframe.protocol.grpc.server`'s own
+module docstring for the full finding and fix (polling `context.cancelled()` for a short window
+rather than trusting the inbound side ending on its own).
+
 ## Status
 
-Experimental, M4 of the project's own build plan. Both
-`TransportConformanceTests` and `RemoteClientConformanceTests`
-(`openframe-protocol-base`) pass against this package for real — the
-point of building it: proving the architecture generalizes past HTTP,
-not just adding a second transport for its own sake.
+Experimental, M4 of the project's own build plan. `TransportConformanceTests`,
+`RemoteClientConformanceTests`, and `SessionConformanceTests` (all `openframe-protocol-base`) pass
+against this package for real — the point of building it: proving the architecture generalizes past
+HTTP, not just adding a second transport for its own sake.

{openframe_protocol_grpc-0.2.0 → openframe_protocol_grpc-0.4.0}/openframe/protocol/grpc/__init__.py

@@ -39,10 +39,18 @@ from openframe.protocol.grpc import generic_pb2, generic_pb2_grpc
 
 if TYPE_CHECKING:
     from openframe.protocol.grpc.client import GrpcRemoteCommandClient, GrpcRemoteQueryClient
-    from openframe.protocol.grpc.server import ROUTE_METADATA_KEY, bind_service, create_server
+    from openframe.protocol.grpc.server import (
+        ROUTE_METADATA_KEY,
+        GrpcSession,
+        bind_service,
+        bind_service_stream,
+        create_server,
+    )
 
 __all__ = [
     "bind_service",
+    "bind_service_stream",
+    "GrpcSession",
     "ROUTE_METADATA_KEY",
     "create_server",
     "GrpcRemoteQueryClient",
@@ -51,7 +59,7 @@ __all__ = [
     "generic_pb2_grpc",
 ]
 
-_FROM_SERVER = {"bind_service", "ROUTE_METADATA_KEY", "create_server"}
+_FROM_SERVER = {"bind_service", "bind_service_stream", "GrpcSession", "ROUTE_METADATA_KEY", "create_server"}
 _FROM_CLIENT = {"GrpcRemoteQueryClient", "GrpcRemoteCommandClient"}
 
 

{openframe_protocol_grpc-0.2.0 → openframe_protocol_grpc-0.4.0}/openframe/protocol/grpc/generic.proto

@@ -15,4 +15,8 @@ message GenericResponse {
 
 service GenericService {
   rpc Call(GenericRequest) returns (GenericResponse);
+  // Bidirectional streaming counterpart to Call, same route-multiplexing
+  // trick (x-openframe-route metadata) — the SessionHandler (ADR-008)
+  // binding, not a per-route message type.
+  rpc CallStream(stream GenericRequest) returns (stream GenericResponse);
 }

openframe_protocol_grpc-0.4.0/openframe/protocol/grpc/generic_pb2.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: openframe/protocol/grpc/generic.proto
+# Protobuf Python Version: 7.35.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    7,
+    35,
+    1,
+    '',
+    'openframe/protocol/grpc/generic.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n%openframe/protocol/grpc/generic.proto\x12\x17openframe.protocol.grpc\"&\n\x0eGenericRequest\x12\x14\n\x0cjson_payload\x18\x01 \x01(\t\"\'\n\x0fGenericResponse\x12\x14\n\x0cjson_payload\x18\x01 \x01(\t2\xd0\x01\n\x0eGenericService\x12Y\n\x04\x43\x61ll\x12\'.openframe.protocol.grpc.GenericRequest\x1a(.openframe.protocol.grpc.GenericResponse\x12\x63\n\nCallStream\x12\'.openframe.protocol.grpc.GenericRequest\x1a(.openframe.protocol.grpc.GenericResponse(\x01\x30\x01\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'openframe.protocol.grpc.generic_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_GENERICREQUEST']._serialized_start=66
+  _globals['_GENERICREQUEST']._serialized_end=104
+  _globals['_GENERICRESPONSE']._serialized_start=106
+  _globals['_GENERICRESPONSE']._serialized_end=145
+  _globals['_GENERICSERVICE']._serialized_start=148
+  _globals['_GENERICSERVICE']._serialized_end=356
+# @@protoc_insertion_point(module_scope)

openframe_protocol_grpc-0.4.0/openframe/protocol/grpc/generic_pb2.pyi

@@ -0,0 +1,17 @@
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Optional as _Optional
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class GenericRequest(_message.Message):
+    __slots__ = ("json_payload",)
+    JSON_PAYLOAD_FIELD_NUMBER: _ClassVar[int]
+    json_payload: str
+    def __init__(self, json_payload: _Optional[str] = ...) -> None: ...
+
+class GenericResponse(_message.Message):
+    __slots__ = ("json_payload",)
+    JSON_PAYLOAD_FIELD_NUMBER: _ClassVar[int]
+    json_payload: str
+    def __init__(self, json_payload: _Optional[str] = ...) -> None: ...

openframe_protocol_grpc-0.4.0/openframe/protocol/grpc/generic_pb2_grpc.py

@@ -0,0 +1,143 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from openframe.protocol.grpc import generic_pb2 as openframe_dot_protocol_dot_grpc_dot_generic__pb2
+
+GRPC_GENERATED_VERSION = '1.84.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + ' but the generated code in openframe/protocol/grpc/generic_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class GenericServiceStub:
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Call = channel.unary_unary(
+                '/openframe.protocol.grpc.GenericService/Call',
+                request_serializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.SerializeToString,
+                response_deserializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.FromString,
+                _registered_method=True)
+        self.CallStream = channel.stream_stream(
+                '/openframe.protocol.grpc.GenericService/CallStream',
+                request_serializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.SerializeToString,
+                response_deserializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.FromString,
+                _registered_method=True)
+
+
+class GenericServiceServicer:
+    """Missing associated documentation comment in .proto file."""
+
+    def Call(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def CallStream(self, request_iterator, context):
+        """Bidirectional streaming counterpart to Call, same route-multiplexing
+        trick (x-openframe-route metadata) — the SessionHandler (ADR-008)
+        binding, not a per-route message type.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_GenericServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Call': grpc.unary_unary_rpc_method_handler(
+                    servicer.Call,
+                    request_deserializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.FromString,
+                    response_serializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.SerializeToString,
+            ),
+            'CallStream': grpc.stream_stream_rpc_method_handler(
+                    servicer.CallStream,
+                    request_deserializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.FromString,
+                    response_serializer=openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'openframe.protocol.grpc.GenericService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('openframe.protocol.grpc.GenericService', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class GenericService:
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Call(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/openframe.protocol.grpc.GenericService/Call',
+            openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.SerializeToString,
+            openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def CallStream(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/openframe.protocol.grpc.GenericService/CallStream',
+            openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericRequest.SerializeToString,
+            openframe_dot_protocol_dot_grpc_dot_generic__pb2.GenericResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)