Add source field to user-agent header (stripe#1874)

Author: xavdid

lib/stripe/api_requestor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "digest"
+require "socket"
 require "stripe/instrumentation"
 
 module Stripe
@@ -1066,6 +1068,31 @@ def dup_from_response_headers(headers)
     # in so that we can generate a rich user agent header to help debug
     # integrations.
     class SystemProfiler
+      UNAME_HASH = begin
+        parts = []
+        parts << if RUBY_PLATFORM.match?(/mswin|mingw|cygwin/)
+                   begin
+                     `ver 2>NUL`.strip
+                   rescue StandardError
+                     ""
+                   end
+                 else
+                   begin
+                     `uname -a 2>/dev/null`.strip
+                   rescue StandardError
+                     ""
+                   end
+                 end
+        parts << begin
+          Socket.gethostname
+        rescue StandardError
+          ""
+        end
+        Digest::MD5.hexdigest(parts.join(" "))
+      rescue StandardError
+        ""
+      end
+
       AI_AGENTS = [
         # aiAgents: The beginning of the section generated from our OpenAPI spec
         %w[ANTIGRAVITY_CLI_ALIAS antigravity],
@@ -1101,7 +1128,10 @@ def self.user_agent
           engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
         }.delete_if { |_k, v| v.nil? }
 
-        ua[:platform] = RUBY_PLATFORM if Stripe.enable_telemetry?
+        if Stripe.enable_telemetry?
+          ua[:platform] = RUBY_PLATFORM
+          ua[:source] = UNAME_HASH unless UNAME_HASH.empty?
+        end
 
         ai_agent = detect_ai_agent
         ua[:ai_agent] = ai_agent unless ai_agent.empty?

test/stripe/api_requestor_test.rb

@@ -1799,6 +1799,32 @@ class SystemProfilerTest < Test::Unit::TestCase
       ensure
         Stripe.enable_telemetry = false
       end
+
+      should "omit source when UNAME_HASH is empty" do
+        original = APIRequestor::SystemProfiler::UNAME_HASH
+        APIRequestor::SystemProfiler.send(:remove_const, :UNAME_HASH)
+        APIRequestor::SystemProfiler.const_set(:UNAME_HASH, "")
+        Stripe.enable_telemetry = true
+        ua = APIRequestor::SystemProfiler.user_agent
+        refute ua.key?(:source)
+      ensure
+        APIRequestor::SystemProfiler.send(:remove_const, :UNAME_HASH)
+        APIRequestor::SystemProfiler.const_set(:UNAME_HASH, original)
+        Stripe.enable_telemetry = false
+      end
+
+      should "include source when UNAME_HASH is non-empty" do
+        original = APIRequestor::SystemProfiler::UNAME_HASH
+        APIRequestor::SystemProfiler.send(:remove_const, :UNAME_HASH)
+        APIRequestor::SystemProfiler.const_set(:UNAME_HASH, "abc123")
+        Stripe.enable_telemetry = true
+        ua = APIRequestor::SystemProfiler.user_agent
+        assert_equal "abc123", ua[:source]
+      ensure
+        APIRequestor::SystemProfiler.send(:remove_const, :UNAME_HASH)
+        APIRequestor::SystemProfiler.const_set(:UNAME_HASH, original)
+        Stripe.enable_telemetry = false
+      end
     end
 
     context ".detect_ai_agent" do