chore: add agent details and new runtime version header

.github/workflows/on-pull-request.yml

@@ -40,18 +40,17 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1
         with:
           version: 1.3.1
           virtualenvs-in-project: true
 
-      - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: poetry
-
       - name: Install dependencies
         run: poetry install
 

.github/workflows/on-push-to-release-branch.yml

@@ -61,17 +61,17 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1
         with:
           version: 1.3.1
           virtualenvs-in-project: true
 
-      - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-
       - name: Install dependencies
         run: poetry install
 

src/momento/internal/_utilities/__init__.py

@@ -1,3 +1,4 @@
+from ._client_type import ClientType
 from ._data_validation import (
     _as_bytes,
     _gen_dictionary_fields_as_bytes,
@@ -14,4 +15,5 @@
     _validate_ttl,
 )
 from ._momento_version import momento_version
+from ._python_runtime_version import PYTHON_RUNTIME_VERSION
 from ._time import _timedelta_to_ms

src/momento/internal/_utilities/_client_type.py

@@ -0,0 +1,13 @@
+"""Enumerates the types of clients that can be used.
+
+Used to populate the agent header in gRPC requests.
+"""
+
+from enum import Enum
+
+
+class ClientType(Enum):
+    """Describes the type of client that is being used."""
+
+    CACHE = "cache"
+    TOPIC = "topic"

src/momento/internal/_utilities/_python_runtime_version.py

@@ -0,0 +1,10 @@
+"""Python runtime version information.
+
+Used to populate the `runtime-version` header in gRPC requests.
+"""
+import sys
+
+PYTHON_RUNTIME_VERSION = (
+    f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro} "
+    f"({sys.version_info.releaselevel} {sys.version_info.serial})"
+)

src/momento/internal/aio/_add_header_client_interceptor.py

@@ -10,7 +10,7 @@
 
 
 class Header:
-    once_only_headers = ["agent"]
+    once_only_headers = ["agent", "runtime-version"]
 
     def __init__(self, name: str, value: str):
         self.name = name

src/momento/internal/aio/_scs_grpc_manager.py

@@ -13,7 +13,7 @@
 from momento.config import Configuration, TopicConfiguration
 from momento.config.transport.transport_strategy import StaticGrpcConfiguration
 from momento.errors.exceptions import ConnectionException
-from momento.internal._utilities import momento_version
+from momento.internal._utilities import PYTHON_RUNTIME_VERSION, ClientType, momento_version
 from momento.internal._utilities._channel_credentials import (
     channel_credentials_from_root_certs_or_default,
 )
@@ -42,7 +42,9 @@ def __init__(self, configuration: Configuration, credential_provider: Credential
         self._secure_channel = grpc.aio.secure_channel(
             target=credential_provider.control_endpoint,
             credentials=channel_credentials_from_root_certs_or_default(configuration),
-            interceptors=_interceptors(credential_provider.auth_token, configuration.get_retry_strategy()),
+            interceptors=_interceptors(
+                credential_provider.auth_token, ClientType.CACHE, configuration.get_retry_strategy()
+            ),
             options=grpc_control_channel_options_from_grpc_config(
                 grpc_config=configuration.get_transport_strategy().get_grpc_configuration(),
             ),
@@ -65,7 +67,9 @@ def __init__(self, configuration: Configuration, credential_provider: Credential
         self._secure_channel = grpc.aio.secure_channel(
             target=credential_provider.cache_endpoint,
             credentials=channel_credentials_from_root_certs_or_default(configuration),
-            interceptors=_interceptors(credential_provider.auth_token, configuration.get_retry_strategy()),
+            interceptors=_interceptors(
+                credential_provider.auth_token, ClientType.CACHE, configuration.get_retry_strategy()
+            ),
             # Here is where you would pass override configuration to the underlying C gRPC layer.
             # However, I have tried several different tuning options here and did not see any
             # performance improvements, so sticking with the defaults for now.
@@ -142,7 +146,7 @@ def __init__(self, configuration: TopicConfiguration, credential_provider: Crede
         self._secure_channel = grpc.aio.secure_channel(
             target=credential_provider.cache_endpoint,
             credentials=grpc.ssl_channel_credentials(),
-            interceptors=_interceptors(credential_provider.auth_token, None),
+            interceptors=_interceptors(credential_provider.auth_token, ClientType.TOPIC, None),
             options=grpc_data_channel_options_from_grpc_config(grpc_config),
         )
 
@@ -165,7 +169,7 @@ def __init__(self, configuration: TopicConfiguration, credential_provider: Crede
         self._secure_channel = grpc.aio.secure_channel(
             target=credential_provider.cache_endpoint,
             credentials=grpc.ssl_channel_credentials(),
-            interceptors=_stream_interceptors(credential_provider.auth_token),
+            interceptors=_stream_interceptors(credential_provider.auth_token, ClientType.TOPIC),
             options=grpc_data_channel_options_from_grpc_config(grpc_config),
         )
 
@@ -176,10 +180,13 @@ def async_stub(self) -> pubsub_client.PubsubStub:
         return pubsub_client.PubsubStub(self._secure_channel)  # type: ignore[no-untyped-call]
 
 
-def _interceptors(auth_token: str, retry_strategy: Optional[RetryStrategy] = None) -> list[grpc.aio.ClientInterceptor]:
+def _interceptors(
+    auth_token: str, client_type: ClientType, retry_strategy: Optional[RetryStrategy] = None
+) -> list[grpc.aio.ClientInterceptor]:
     headers = [
         Header("authorization", auth_token),
-        Header("agent", f"python:{_ControlGrpcManager.version}"),
+        Header("agent", f"python:{client_type.value}:{_ControlGrpcManager.version}"),
+        Header("runtime-version", f"python {PYTHON_RUNTIME_VERSION}"),
     ]
     return list(
         filter(
@@ -192,9 +199,10 @@ def _interceptors(auth_token: str, retry_strategy: Optional[RetryStrategy] = Non
     )
 
 
-def _stream_interceptors(auth_token: str) -> list[grpc.aio.UnaryStreamClientInterceptor]:
+def _stream_interceptors(auth_token: str, client_type: ClientType) -> list[grpc.aio.UnaryStreamClientInterceptor]:
     headers = [
         Header("authorization", auth_token),
-        Header("agent", f"python:{_PubsubGrpcStreamManager.version}"),
+        Header("agent", f"python:{client_type.value}:{_PubsubGrpcStreamManager.version}"),
+        Header("runtime-version", f"python {PYTHON_RUNTIME_VERSION}"),
     ]
     return [AddHeaderStreamingClientInterceptor(headers)]

src/momento/internal/synchronous/_scs_grpc_manager.py

@@ -14,7 +14,7 @@
 from momento.config import Configuration, TopicConfiguration
 from momento.config.transport.transport_strategy import StaticGrpcConfiguration
 from momento.errors.exceptions import ConnectionException
-from momento.internal._utilities import momento_version
+from momento.internal._utilities import PYTHON_RUNTIME_VERSION, ClientType, momento_version
 from momento.internal._utilities._channel_credentials import (
     channel_credentials_from_root_certs_or_default,
 )
@@ -46,7 +46,8 @@ def __init__(self, configuration: Configuration, credential_provider: Credential
             ),
         )
         intercept_channel = grpc.intercept_channel(
-            self._secure_channel, *_interceptors(credential_provider.auth_token, configuration.get_retry_strategy())
+            self._secure_channel,
+            *_interceptors(credential_provider.auth_token, ClientType.CACHE, configuration.get_retry_strategy()),
         )
         self._stub = control_client.ScsControlStub(intercept_channel)  # type: ignore[no-untyped-call]
 
@@ -73,7 +74,8 @@ def __init__(self, configuration: Configuration, credential_provider: Credential
         )
 
         intercept_channel = grpc.intercept_channel(
-            self._secure_channel, *_interceptors(credential_provider.auth_token, configuration.get_retry_strategy())
+            self._secure_channel,
+            *_interceptors(credential_provider.auth_token, ClientType.CACHE, configuration.get_retry_strategy()),
         )
         self._stub = cache_client.ScsStub(intercept_channel)  # type: ignore[no-untyped-call]
 
@@ -164,7 +166,7 @@ def __init__(self, configuration: TopicConfiguration, credential_provider: Crede
             options=grpc_data_channel_options_from_grpc_config(grpc_config),
         )
         intercept_channel = grpc.intercept_channel(
-            self._secure_channel, *_interceptors(credential_provider.auth_token, None)
+            self._secure_channel, *_interceptors(credential_provider.auth_token, ClientType.TOPIC, None)
         )
         self._stub = pubsub_client.PubsubStub(intercept_channel)  # type: ignore[no-untyped-call]
 
@@ -190,7 +192,7 @@ def __init__(self, configuration: TopicConfiguration, credential_provider: Crede
             options=grpc_data_channel_options_from_grpc_config(grpc_config),
         )
         intercept_channel = grpc.intercept_channel(
-            self._secure_channel, *_stream_interceptors(credential_provider.auth_token)
+            self._secure_channel, *_stream_interceptors(credential_provider.auth_token, ClientType.TOPIC)
         )
         self._stub = pubsub_client.PubsubStub(intercept_channel)  # type: ignore[no-untyped-call]
 
@@ -202,19 +204,24 @@ def stub(self) -> pubsub_client.PubsubStub:
 
 
 def _interceptors(
-    auth_token: str, retry_strategy: Optional[RetryStrategy] = None
+    auth_token: str, client_type: ClientType, retry_strategy: Optional[RetryStrategy] = None
 ) -> list[grpc.UnaryUnaryClientInterceptor]:
-    headers = [Header("authorization", auth_token), Header("agent", f"python:{_ControlGrpcManager.version}")]
+    headers = [
+        Header("authorization", auth_token),
+        Header("agent", f"python:{client_type.value}:{_ControlGrpcManager.version}"),
+        Header("runtime-version", f"python {PYTHON_RUNTIME_VERSION}"),
+    ]
     return list(
         filter(
             None, [AddHeaderClientInterceptor(headers), RetryInterceptor(retry_strategy) if retry_strategy else None]
         )
     )
 
 
-def _stream_interceptors(auth_token: str) -> list[grpc.UnaryStreamClientInterceptor]:
+def _stream_interceptors(auth_token: str, client_type: ClientType) -> list[grpc.UnaryStreamClientInterceptor]:
     headers = [
         Header("authorization", auth_token),
-        Header("agent", f"python:{_PubsubGrpcStreamManager.version}"),
+        Header("agent", f"python:{client_type.value}:{_PubsubGrpcStreamManager.version}"),
+        Header("runtime-version", f"python {PYTHON_RUNTIME_VERSION}"),
     ]
     return [AddHeaderStreamingClientInterceptor(headers)]