Include X-Synapse-Version header in pkg.load requests (SYN-8474) (#4074)

vertexproject · Jan 16, 2025 · ce88a74 · ce88a74
1 parent df25a32
commit ce88a74
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/changes/8221696241d0c8e0142d663ec70cc6da.yaml b/changes/8221696241d0c8e0142d663ec70cc6da.yaml
@@ -0,0 +1,6 @@
+---
+desc: Updated the ``pkg.load`` Storm command to include an ``X-Synapse-Version`` HTTP header
+  in requests.
+prs: []
+type: feat
+...
diff --git a/synapse/lib/storm.py b/synapse/lib/storm.py
@@ -984,7 +984,9 @@
                 $ssl = $lib.true
                 if $cmdopts.ssl_noverify { $ssl = $lib.false }
 
-                $resp = $lib.inet.http.get($cmdopts.url, ssl_verify=$ssl)
+                $headers = ({'X-Synapse-Version': $lib.str.join('.', $lib.version.synapse())})
+
+                $resp = $lib.inet.http.get($cmdopts.url, ssl_verify=$ssl, headers=$headers)
 
                 if ($resp.code != 200) {
                     $lib.warn("pkg.load got HTTP code: {code} for URL: {url}", code=$resp.code, url=$cmdopts.url)

diff --git a/synapse/tests/test_lib_storm.py b/synapse/tests/test_lib_storm.py
@@ -2742,6 +2742,7 @@ async def test_storm_pkg_load(self):
         class PkgHandler(s_httpapi.Handler):
 
             async def get(self, name):
+                assert self.request.headers.get('X-Synapse-Version') == s_version.verstring
 
                 if name == 'notok':
                     self.sendRestErr('FooBar', 'baz faz')
@@ -2751,6 +2752,8 @@ async def get(self, name):
 
         class PkgHandlerRaw(s_httpapi.Handler):
             async def get(self, name):
+                assert self.request.headers.get('X-Synapse-Version') == s_version.verstring
+
                 self.set_header('Content-Type', 'application/json')
                 return self.write(pkg)