Move Stainless HTTP request header sanitizer into client library test code (#44231)

Author: dargilco

eng/tools/azure-sdk-tools/devtools_testutils/proxy_testcase.py

@@ -189,12 +189,6 @@ def transform_httpx_request(request, recording_id: str) -> None:
     request.headers["x-recording-id"] = recording_id
     request.headers["x-recording-mode"] = "record" if is_live() else "playback"
 
-    # Remove all request headers that start with `x-stainless`, since they contain CPU info, OS info, etc.
-    # Those change depending on which machine the tests are run on, so we cannot have a single test recording with those.
-    headers_to_remove = [key for key in request.headers.keys() if key.lower().startswith("x-stainless")]
-    for header in headers_to_remove:
-        del request.headers[header]
-
     # Rewrite URL to proxy
     updated_target = parsed_result._replace(**get_proxy_netloc()).geturl()
     request.url = httpx.URL(updated_target)

sdk/ai/azure-ai-projects/tests/conftest.py

@@ -6,7 +6,12 @@
 import os
 import pytest
 from dotenv import load_dotenv, find_dotenv
-from devtools_testutils import remove_batch_sanitizers, add_general_regex_sanitizer, add_body_key_sanitizer
+from devtools_testutils import (
+    remove_batch_sanitizers,
+    add_general_regex_sanitizer,
+    add_body_key_sanitizer,
+    add_remove_header_sanitizer,
+)
 
 if not load_dotenv(find_dotenv(), override=True):
     print("Did not find a .env file. Using default environment variable values for tests.")
@@ -101,6 +106,24 @@ def sanitize_url_paths():
     add_body_key_sanitizer(json_path="blobReference.credential.sasUri", value="sanitized-sas-uri")
     add_body_key_sanitizer(json_path="blobReferenceForConsumption.credential.sasUri", value="sanitized-sas-uri")
 
+    # Remove Stainless headers from OpenAI client requests, since they include platform and OS specific info, which we can't have in recorded requests.
+    # Here is an example of all the `x-stainless` headers from a Responses call:
+    #   x-stainless-arch: other:amd64
+    #   x-stainless-async: false
+    #   x-stainless-lang: python
+    #   x-stainless-os: Windows
+    #   x-stainless-package-version: 2.8.1
+    #   x-stainless-read-timeout: 600
+    #   x-stainless-retry-count: 0
+    #   x-stainless-runtime: CPython
+    #   x-stainless-runtime-version: 3.14.0
+    # Note that even though the doc string for `add_remove_header_sanitizer` says `condition` is supported, it is not implemented. So we can't do this:
+    #   add_remove_header_sanitizer(condition='{"uriRegex": "(?i)^x-stainless-.*$"}')
+    # We have to explicitly list all the headers to remove:
+    add_remove_header_sanitizer(
+        headers="x-stainless-arch, x-stainless-async, x-stainless-lang, x-stainless-os, x-stainless-package-version, x-stainless-read-timeout, x-stainless-retry-count, x-stainless-runtime, x-stainless-runtime-version"
+    )
+
     # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive:
     #  - AZSDK3493: $..name
     #  - AZSDK3430: $..id