fix: propagate headers as sequence; add tests

Author: Test User

packages/google-api-core/google/api_core/resumable_media/_upload.py

@@ -18,7 +18,7 @@
 """
 
 import logging
-from typing import Dict, Optional, Tuple
+from typing import Dict, Optional, Sequence, Tuple
 
 from google.api_core import exceptions
 from google.api_core.resumable_media import _common
@@ -83,14 +83,14 @@ def chunk_size(self) -> int:
 
     def build_initiate_request(
         self,
-        stream_metadata: Optional[Dict[str, str]] = None,
+        stream_metadata: Optional[Sequence[Tuple[str, str]]] = None,
         content_type: Optional[str] = None,
         size: Optional[int] = None,
     ) -> Tuple[str, str, Dict[str, str], bytes]:
         """Constructs an upload initiation request.
 
         Args:
-            stream_metadata (Optional[Dict[str, str]]): Additional headers for
+            stream_metadata (Optional[Sequence[Tuple[str, str]]]): Additional headers for
                 the upload initiation request. These headers are ONLY applied to
                 the initial request and will NOT be included in subsequent chunk
                 upload requests. If not specified, no additional headers will be appended.
@@ -109,7 +109,7 @@ def build_initiate_request(
 
         # Merge user metadata first
         if stream_metadata:
-            for k, v in stream_metadata.items():
+            for k, v in stream_metadata:
                 headers[k] = str(v)
 
         # Critical protocol headers overwrite user metadata

packages/google-api-core/tests/unit/resumable_media/test_requests_upload.py

@@ -307,3 +307,48 @@ def test_logging_success_path(caplog):
     # Check for final response logs
     assert "'final'" in caplog.text.lower() or "final" in caplog.text.lower()
     assert "Body: Final Success" in caplog.text
+
+
+@responses.activate
+def test_make_resumable_upload_with_custom_headers(caplog):
+    caplog.set_level("DEBUG")
+    initial_url = "http://example.com/start"
+    session_url = "http://example.com/session/123"
+    data = b"test data"
+    stream = io.BytesIO(data)
+    custom_headers = [("X-Custom-Header", "CustomValue")]
+
+    responses.add(
+        responses.POST,
+        initial_url,
+        status=200,
+        headers={"X-Goog-Upload-Status": "active", "X-Goog-Upload-URL": session_url},
+        body="",
+    )
+    responses.add(
+        responses.POST,
+        session_url,
+        status=200,
+        headers={"X-Goog-Upload-Status": "final"},
+        body="Final Success",
+    )
+
+    session = requests.Session()
+    requests_upload.make_resumable_upload(
+        transport=session,
+        request_body="metadata",
+        stream=stream,
+        upload_url=initial_url,
+        size=len(data),
+        chunk_size=1024,
+        headers=custom_headers,
+    )
+
+    # Check for initiation request logs containing the custom header
+    assert f"HTTP Request: POST {initial_url}" in caplog.text
+    assert "'X-Custom-Header': 'CustomValue'" in caplog.text
+
+    # Check for upload/finalize request logs NOT containing the custom header
+    assert f"HTTP Request: POST {session_url}" in caplog.text
+    assert caplog.text.count("'X-Custom-Header': 'CustomValue'") == 1
+

packages/google-api-core/tests/unit/resumable_media/test_upload.py

@@ -37,7 +37,7 @@ def test_chunk_size_granularity(self):
     def test_initiate_request(self):
         upload = _upload.ResumableUpload("http://test.local/upload")
         method, url, headers, body = upload.build_initiate_request(
-            stream_metadata={"x-custom-meta": "value"},
+            stream_metadata=[("x-custom-meta", "value")],
             content_type="text/plain",
             size=100,
         )
@@ -53,12 +53,12 @@ def test_initiate_request(self):
     def test_initiate_request_conflicting_metadata(self):
         upload = _upload.ResumableUpload("http://test.local/upload")
         method, url, headers, body = upload.build_initiate_request(
-            stream_metadata={
-                "x-custom-meta": "value",
-                _common.UPLOAD_PROTOCOL_HEADER: "malicious-protocol",
-                _common.UPLOAD_COMMAND_HEADER: "malicious-command",
-                _common.UPLOAD_CONTENT_TYPE_HEADER: "malicious/type",
-            },
+            stream_metadata=[
+                ("x-custom-meta", "value"),
+                (_common.UPLOAD_PROTOCOL_HEADER, "malicious-protocol"),
+                (_common.UPLOAD_COMMAND_HEADER, "malicious-command"),
+                (_common.UPLOAD_CONTENT_TYPE_HEADER, "malicious/type"),
+            ],
             content_type="text/plain",
             size=100,
         )