use prefix instead of suffix for vcr cassette names from test_name (#232)

Cassette name additions passed in as test_name for /vcr/test/start are now used as a prefix for generated cassette names instead of a suffix.

openai_embeddings_post_48694087_test_embedding.yaml → test_embedding_openai_embeddings_post_48694087.yaml

tested by using this dev image in some shared test tooling for datadog llm observability

Author: sabrenner

ddapm_test_agent/agent.py

@@ -113,7 +113,7 @@ def _session_token(request: Request) -> Optional[str]:
     return token
 
 
-async def _vcr_proxy_cassette_suffix(request: Request) -> Optional[str]:
+async def _vcr_proxy_cassette_prefix(request: Request) -> Optional[str]:
     try:
         request_body: dict[str, str] = await request.json()
         requested_test_name = request_body.get("test_name")
@@ -263,7 +263,7 @@ def __init__(self) -> None:
             lambda: _AgentSession(sample_rate_by_service_env={})
         )
 
-        self.vcr_cassette_suffix: Optional[str] = None
+        self.vcr_cassette_prefix: Optional[str] = None
 
     async def traces(self) -> TraceMap:
         """Return the traces stored by the agent in the order in which they
@@ -1112,24 +1112,24 @@ async def vcr_proxy_suffix_middleware(self, request: Request, handler: _Handler)
         if not request.path.startswith("/vcr"):
             return await handler(request)
 
-        if self.vcr_cassette_suffix is not None:
-            request["vcr_cassette_suffix"] = self.vcr_cassette_suffix
+        if self.vcr_cassette_prefix is not None:
+            request["vcr_cassette_prefix"] = self.vcr_cassette_prefix
         else:
-            vcr_cassette_suffix = await _vcr_proxy_cassette_suffix(request)
-            if vcr_cassette_suffix:
-                self.vcr_cassette_suffix = vcr_cassette_suffix
-                request["vcr_cassette_suffix"] = vcr_cassette_suffix
+            vcr_cassette_prefix = await _vcr_proxy_cassette_prefix(request)
+            if vcr_cassette_prefix:
+                self.vcr_cassette_prefix = vcr_cassette_prefix
+                request["vcr_cassette_prefix"] = vcr_cassette_prefix
         return await handler(request)
 
     async def check_vcr_proxy_suffix(self, request: Request) -> web.Response:
         """Verify that the middleware has set the VCR proxy suffix"""
-        if self.vcr_cassette_suffix is None:
+        if self.vcr_cassette_prefix is None:
             return web.HTTPBadRequest(body="VCR proxy suffix not set, please specify `test_name` in the request body")
         return web.HTTPOk()
 
     async def unset_vcr_proxy_suffix(self, request: Request) -> web.Response:
         """Unset the VCR proxy suffix for the request."""
-        self.vcr_cassette_suffix = None
+        self.vcr_cassette_prefix = None
         return web.HTTPOk()
 
     @middleware

ddapm_test_agent/vcr_proxy.py

@@ -84,7 +84,7 @@ def get_vcr(subdirectory: str, vcr_cassettes_directory: str) -> vcr.VCR:
     )
 
 
-def generate_cassette_name(path: str, method: str, body: bytes, vcr_cassette_suffix: Optional[str]) -> str:
+def generate_cassette_name(path: str, method: str, body: bytes, vcr_cassette_prefix: Optional[str]) -> str:
     decoded_body = normalize_multipart_body(body) if body else ""
     try:
         parsed_body = json.loads(decoded_body) if decoded_body else {}
@@ -96,11 +96,11 @@ def generate_cassette_name(path: str, method: str, body: bytes, vcr_cassette_suf
     hash_hex = hash_object.hexdigest()[:8]
     safe_path = _file_safe_string(path)
 
-    safe_vcr_cassette_suffix = _file_safe_string(vcr_cassette_suffix) if vcr_cassette_suffix else None
+    safe_vcr_cassette_prefix = _file_safe_string(vcr_cassette_prefix) if vcr_cassette_prefix else None
 
     return (
-        f"{safe_path}_{method.lower()}_{hash_hex}_{safe_vcr_cassette_suffix}"
-        if safe_vcr_cassette_suffix
+        f"{safe_vcr_cassette_prefix}_{safe_path}_{method.lower()}_{hash_hex}"
+        if safe_vcr_cassette_prefix
         else f"{safe_path}_{method.lower()}_{hash_hex}"
     )
 
@@ -124,9 +124,9 @@ async def proxy_request(request: Request, vcr_cassettes_directory: str) -> Respo
 
     body_bytes = await request.read()
 
-    vcr_cassette_suffix = request.pop("vcr_cassette_suffix", None)
+    vcr_cassette_prefix = request.pop("vcr_cassette_prefix", None)
 
-    cassette_name = generate_cassette_name(path, request.method, body_bytes, vcr_cassette_suffix)
+    cassette_name = generate_cassette_name(path, request.method, body_bytes, vcr_cassette_prefix)
     with get_vcr(provider, vcr_cassettes_directory).use_cassette(f"{cassette_name}.yaml"):
         oai_response = requests.request(
             method=request.method,

releasenotes/notes/vcr-prefix-instead-of-suffix-4c56dcb5038d222e.yaml

@@ -0,0 +1,4 @@
+---
+upgrade:
+  - |
+    vcr: ``test_name`` specified in ``/vcr/test/start`` is now used as a prefix for generated cassette names instead of a suffix.