wip

Author: sl0thentr0py

sentry-rails/lib/sentry/rails/active_job.rb

@@ -37,7 +37,7 @@ def serialize
             sentry_data["trace_propagation_headers"] = headers if headers && !headers.empty?
           end
 
-          if Sentry.configuration.send_default_pii
+          if Sentry.configuration.data_collection.user_info
             user = Sentry.get_current_scope.user
             allowed = user.transform_keys(&:to_s).slice(*USER_FIELDS_ALLOWLIST)
             sentry_data["user"] = allowed unless allowed.empty?

sentry-rails/spec/active_job/shared_examples/tracing/user_propagation.rb

@@ -11,11 +11,12 @@
     }
   end
 
-  context "when send_default_pii is true" do
+  context "when user_info is true" do
     let(:configure_sentry) do
       proc do |config|
         config.traces_sample_rate = 1.0
         config.send_default_pii = true
+        config.data_collection.user_info = true
       end
     end
 
@@ -58,11 +59,12 @@
     end
   end
 
-  context "when send_default_pii is true and logs are enabled" do
+  context "when user_info is true and logs are enabled" do
     let(:configure_sentry) do
       proc do |config|
         config.traces_sample_rate = 1.0
         config.send_default_pii = true
+        config.data_collection.user_info = true
         config.enable_logs = true
       end
     end
@@ -93,11 +95,12 @@ def perform
     end
   end
 
-  context "when send_default_pii is false" do
+  context "when user_info is false" do
     let(:configure_sentry) do
       proc do |config|
         config.traces_sample_rate = 1.0
-        config.send_default_pii = false
+        config.send_default_pii = true
+        config.data_collection.user_info = false
       end
     end
 

sentry-ruby/lib/sentry/event.rb

@@ -28,7 +28,7 @@ class Event
 
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
 
-    SKIP_INSPECTION_ATTRIBUTES = [:@modules, :@stacktrace_builder, :@send_default_pii, :@trusted_proxies, :@rack_env_whitelist]
+    SKIP_INSPECTION_ATTRIBUTES = [:@modules, :@stacktrace_builder, :@send_default_pii, :@data_collection, :@trusted_proxies, :@rack_env_whitelist]
 
     include CustomInspection
 
@@ -74,6 +74,7 @@ def initialize(configuration:, integration_meta: nil, message: nil)
 
       # configuration options to help events process data
       @send_default_pii = configuration.send_default_pii
+      @data_collection = configuration.data_collection
       @trusted_proxies = configuration.trusted_proxies
       @stacktrace_builder = configuration.stacktrace_builder
       @rack_env_whitelist = configuration.rack_env_whitelist
@@ -103,7 +104,7 @@ def rack_env=(env)
       unless request || env.empty?
         add_request_interface(env)
 
-        user[:ip_address] ||= calculate_real_ip_from_rack(env) if @send_default_pii
+        user[:ip_address] ||= calculate_real_ip_from_rack(env) if @data_collection.user_info
 
         if request_id = Utils::RequestId.read_from(env)
           tags[:request_id] = request_id

sentry-ruby/spec/sentry/event_spec.rb

@@ -117,6 +117,13 @@
         expect(event.request.headers.keys).not_to include("X-Real-Ip")
         expect(event.request.headers.keys).not_to include("X-Forwarded-For")
       end
+
+      it "preserves explicitly set user data set on the scope" do
+        Sentry.set_user(id: "user-1", username: "alice")
+        scope.apply_to_event(event)
+
+        expect(event.user).to include(id: "user-1", username: "alice")
+      end
     end
 
     context "with config.send_default_pii = true" do
@@ -147,6 +154,14 @@
         expect(event.to_h[:user][:ip_address]).to eq("3.3.3.3")
       end
 
+      it "does not auto-populate user information when data collection user_info is disabled" do
+        Sentry.configuration.data_collection.user_info = false
+
+        Sentry.get_current_scope.apply_to_event(event)
+
+        expect(event.to_h[:user][:ip_address]).to be_nil
+      end
+
       context "with config.trusted_proxies = [\"2.2.2.2\"]" do
         before do
           Sentry.configuration.trusted_proxies = ["2.2.2.2"]