Send service header on all requests (#492)

Author: kat-statsig

statsig/http_worker.py

@@ -314,7 +314,7 @@ def _request(
                 create_marker().start({"markerID": marker_id})
             )
 
-        headers = self._prepare_headers(headers, zipped, url)
+        headers = self._prepare_headers(headers, zipped)
 
         if payload is not None:
             payload = self._prepare_payload(payload, url, zipped)
@@ -447,7 +447,7 @@ def _is_success_code(self, status_code: Optional[int]) -> bool:
         return 200 <= status_code < 300
 
     def _prepare_headers(
-        self, headers: Optional[Dict[str, Any]], zipped: bool, url: str
+        self, headers: Optional[Dict[str, Any]], zipped: bool
     ) -> Dict[str, Any]:
         base_headers = {
             "Content-type": "application/json",
@@ -458,6 +458,7 @@ def _prepare_headers(
             "STATSIG-SDK-VERSION": self.__statsig_metadata["sdkVersion"],
             "STATSIG-RETRY": "0",
             "Accept-Encoding": "gzip, deflate, br",
+            "x-request-service": self.__service_name,
         }
 
         if zipped:
@@ -466,9 +467,6 @@ def _prepare_headers(
         if headers is not None:
             base_headers.update(headers)
 
-        if "statsig-foward-proxy" in url:
-            base_headers.update({"x-request-service": self.__service_name})
-
         return base_headers
 
     def _zip_payload(self, payload: str) -> bytes:

tests/test_network.py

@@ -95,7 +95,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
 
         self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
-    def test_dcs_service_header_not_sent_without_forward_proxy_url(self):
+    def test_dcs_service_header_sent_without_forward_proxy_url(self):
         captured_headers = {}
         self.net._HttpWorker__service_name = "unit-test-service"
         self.net._HttpWorker__api_for_download_config_specs = "http://test/no-forward-proxy/"
@@ -107,7 +107,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
         with patch.object(self.net, "_run_request_with_strict_timeout", side_effect=fake_request):
             self.net.get_dcs(lambda *_: None)
 
-        self.assertIsNone(captured_headers.get("x-request-service"))
+        self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
     def test_id_lists_service_header_sent_for_forward_proxy_url(self):
         captured_headers = {}
@@ -123,7 +123,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
 
         self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
-    def test_id_lists_service_header_not_sent_without_forward_proxy_url(self):
+    def test_id_lists_service_header_sent_without_forward_proxy_url(self):
         captured_headers = {}
         self.net._HttpWorker__service_name = "unit-test-service"
         self.net._HttpWorker__api_for_get_id_lists = "http://test/no-forward-proxy/"
@@ -135,7 +135,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
         with patch.object(self.net, "_run_request_with_strict_timeout", side_effect=fake_request):
             self.net.get_id_lists(lambda *_: None)
 
-        self.assertIsNone(captured_headers.get("x-request-service"))
+        self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
     def test_id_list_service_header_sent_for_forward_proxy_url(self):
         captured_headers = {}
@@ -150,7 +150,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
 
         self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
-    def test_id_list_service_header_not_sent_without_forward_proxy_url(self):
+    def test_id_list_service_header_sent_without_forward_proxy_url(self):
         captured_headers = {}
         self.net._HttpWorker__service_name = "unit-test-service"
 
@@ -161,7 +161,7 @@ def fake_request(_method, _url, headers, *_args, **_kwargs):
         with patch.object(self.net, "_run_request_with_strict_timeout", side_effect=fake_request):
             self.net.get_id_list(lambda *_: None, "http://test/no-forward-proxy/list_1", headers={})
 
-        self.assertIsNone(captured_headers.get("x-request-service"))
+        self.assertEqual(captured_headers.get("x-request-service"), "unit-test-service")
 
     def test_network_latency_metric_includes_required_tags(self):
         self.net._HttpWorker__api_for_get_id_lists = "https://api.statsigcdn.com/v1/"

tests/test_sync_config_fallback.py

@@ -186,13 +186,14 @@ def verify_headers(url, **kwargs):
 
         self.assertTrue(headers_verified, "Headers were not verified")
 
-    def test_service_name_header_not_sent_without_forward_proxy_url(self, mock_request):
+    def test_service_name_header_sent_without_forward_proxy_url(self, mock_request):
         headers_verified = False
+        captured_service_name = None
 
         def verify_headers(url, **kwargs):
-            nonlocal headers_verified
+            nonlocal headers_verified, captured_service_name
             request_headers = kwargs.get("headers", {})
-            self.assertIsNone(request_headers.get("x-request-service"))
+            captured_service_name = request_headers.get("x-request-service")
             headers_verified = True
             return PARSED_CONFIG_SPEC
 
@@ -207,6 +208,7 @@ def verify_headers(url, **kwargs):
         statsig.shutdown()
 
         self.assertTrue(headers_verified, "Service name header was not verified")
+        self.assertEqual(captured_service_name, "unit-test-service")
 
     def wait_for_sync_and_validate(self):
         _network_stub.stub_statsig_api_request_with_value("download_config_specs/.*", 200,