sentry-sanitizer 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed85a8f652fb2b3b54796967d622c65699a630543a2911ccfdd1c30cf74704c7
-  data.tar.gz: 2cc6ea9f662817521cc22663734ae392a48ca6fbab77a785897e97d64766c70b
+  metadata.gz: fda0761b926ec58a8247355163c29c8b3b48fe3f0b343e3fb492b6e6402b6e6c
+  data.tar.gz: 4e53e4ab1fe8194c6757ff958ddda229dcf6603b8724798c94fd24ccbe8681a2
 SHA512:
-  metadata.gz: 727f6686da725234549fda38f2125e530ace8f641a9ea95469a692edf28f8a07863aeded84c4226ad7871c836ccbb6d6c504b671b97ed818fc02808b45e89e5c
-  data.tar.gz: 47da7c136e56db35e7435ae5d579ebc19f00bb2e0fb575c9e1b5e41e984a710d6804a815aa662428341b2a3d8b46254a392a529d015b93b06447c581ce8ade3e
+  metadata.gz: fb63ecf8b95c47080a0a376072600aac28839da51d3f3b3892c4cae7584bf7ec7367d81cee3f0db1afd687c45324d999135604b852f6c38dc99ec4b9ac03368c
+  data.tar.gz: 214ba8ef2ae130dcd99e5dce43d75c77b4fd6c2c1903479aa6e7f96915c4fccdaf0986860c96ed8192abcb9ff2a3c6f97735cbcaac7f907a1d5c0fad6184afef

data/.github/workflows/{ci-linux.yml → ci.yml}

@@ -1,4 +1,4 @@
-name: CI linux
+name: CI
 on:
   push:
   pull_request:
@@ -11,6 +11,7 @@ jobs:
       matrix:
         include:
           - { ruby_version: 3.3, sentry_version: "~> 6.0" }
+          - { ruby_version: 3.3, sentry_version: "~> 7.0" }
           - { ruby_version: 3.4, sentry_version: "~> 6.0" }
           - { ruby_version: 3.4, sentry_version: "~> 7.0" }
           - { ruby_version: 4.0, sentry_version: "~> 6.0" }

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.10.1
+
+- Sanitize `Sentry::TransactionEvent#spans` [#27](https://github.com/mrexox/sentry-sanitizer/pull/27)
+
+## 0.10.0
+
+- Sanitize transaction events (`before_send_transaction`) and check-in events (`before_send_check_in`). Only `request` and `extra` are sanitized; span data is not
+- Allow multiple `before_send_transaction` and `before_send_check_in` hooks
+- Stop the `before_send` hook chain when a hook returns `nil`, so next hooks do not get `nil`
+
 ## 0.9.0
 
 - Add `filter` option to pass a custom filter, e.g. `ActiveSupport::ParameterFilter` [#25](https://github.com/mrexox/sentry-sanitizer/pull/25)

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    sentry-sanitizer (0.9.0)
-      sentry-ruby (>= 5.3, < 8.0.0)
+    sentry-sanitizer (0.10.1)
+      sentry-ruby (>= 6.0, < 8.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-[![CI](https://github.com/mrexox/sentry-sanitizer/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/mrexox/sentry-sanitizer/actions/workflows/ci-linux.yml)
+[![CI](https://github.com/mrexox/sentry-sanitizer/actions/workflows/ci.yml/badge.svg)](https://github.com/mrexox/sentry-sanitizer/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/sentry-sanitizer.svg)](https://badge.fury.io/rb/sentry-sanitizer)
 [![Coverage Status](https://coveralls.io/repos/github/mrexox/sentry-sanitizer/badge.svg?branch=master)](https://coveralls.io/github/mrexox/sentry-sanitizer?branch=master)
 
@@ -21,16 +21,20 @@ Currently this gem provides following features
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sentry-sanitizer', '>= 0.2.0'
+gem 'sentry-sanitizer', '~> 0.10.0'
 ```
 
-And then execute:
+And then in the terminal:
 
-    $ bundle
+```sh
+bundle install
+```
 
-Or install it yourself as:
+Or alternatively:
 
-    $ gem install sentry-sanitizer
+```sh
+gem install sentry-sanitizer
+```
 
 ## Usage
 
@@ -74,15 +78,15 @@ end
 
 Install dependencies
 
-    $ bin/setup
+    bin/setup
 
 Experiment with the code in IRB
 
-    $ bin/console
+    bin/console
 
 Run tests
 
-    $ bin/rake test
+    bin/rake test
 
 ## Contributing
 

data/lib/sentry/sanitizer/cleaner.rb

@@ -46,6 +46,7 @@ module Sentry
           event.request.query_string = sanitize_query_string(event.request.query_string)
         end
         event.extra = sanitize_data(event.extra)
+        event.spans = sanitize_data(event.spans) if event.is_a?(Sentry::TransactionEvent)
       end
 
       def sanitize_hash!(event)
@@ -66,6 +67,12 @@ module Sentry
         elsif event[:extra]
           event[:extra] = sanitize_data(event[:extra])
         end
+
+        if event["spans"]
+          event["spans"] = sanitize_data(event["spans"])
+        elsif event[:spans]
+          event[:spans] = sanitize_data(event[:spans])
+        end
       end
 
       def sanitize_breadcrumb!(breadcrumb)

data/lib/sentry/sanitizer/configuration.rb

@@ -23,6 +23,18 @@ module Sentry
         event
       }
 
+      self.before_send_transaction = lambda { |event, _hint|
+        Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(event)
+
+        event
+      }
+
+      self.before_send_check_in = lambda { |event, _hint|
+        Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(event)
+
+        event
+      }
+
       self.before_breadcrumb = lambda { |breadcrumb, _hint|
         Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(breadcrumb)
 

data/lib/sentry/sanitizer/configuration_mixin.rb

@@ -4,11 +4,12 @@ module Sentry
   module Sanitizer
     module ConfigurationMixin
       # Allow adding multiple hooks to `before_send`, so user hooks are not ignored.
+      # Available since sentry-ruby 4.5.0
       #
       # @param [nil, #call] value
       #
       def before_send=(value)
-        raise ArgumentError, "before_send must be callable (or nil to disable)" unless value.nil? || value == false || value.respond_to?(:call)
+        _check_callable!("before_send", value)
 
         return unless value
 
@@ -18,6 +19,53 @@ module Sentry
         @before_send = lambda { |event, hint|
           @before_send_hook_list.each do |hook|
             event = hook.call(event, hint)
+            break unless event
+          end
+
+          event
+        }
+      end
+
+      # Allow adding multiple hooks to `before_send_transaction`, so user hooks are not ignored.
+      # Available since sentry-ruby 5.8.0
+      #
+      # @param [nil, #call] value
+      #
+      def before_send_transaction=(value)
+        _check_callable!("before_send_transaction", value)
+
+        return unless value
+
+        @before_send_transaction_hook_list ||= []
+        @before_send_transaction_hook_list << value
+
+        @before_send_transaction = lambda { |event, hint|
+          @before_send_transaction_hook_list.each do |hook|
+            event = hook.call(event, hint)
+            break unless event
+          end
+
+          event
+        }
+      end
+
+      # Allow adding multiple hooks to `before_send_check_in`, so user hooks are not ignored.
+      # Available since sentry-ruby 6.0.0
+      #
+      # @param [nil, #call] value
+      #
+      def before_send_check_in=(value)
+        _check_callable!("before_send_check_in", value)
+
+        return unless value
+
+        @before_send_check_in_hook_list ||= []
+        @before_send_check_in_hook_list << value
+
+        @before_send_check_in = lambda { |event, hint|
+          @before_send_check_in_hook_list.each do |hook|
+            event = hook.call(event, hint)
+            break unless event
           end
 
           event
@@ -25,11 +73,12 @@ module Sentry
       end
 
       # Allow adding multiple hooks to `before_breadcrumb`, so user hooks are not ignored.
+      # Available since sentry-ruby 4.5.0
       #
       # @param [nil, #call] value
       #
       def before_breadcrumb=(value)
-        raise ArgumentError, "before_breadcrumb must be callable (or nil to disable)" unless value.nil? || value == false || value.respond_to?(:call)
+        _check_callable!("before_breadcrumb", value)
 
         return unless value
 
@@ -45,6 +94,12 @@ module Sentry
           breadcrumb
         }
       end
+
+      private
+
+      def _check_callable!(hook, value)
+        raise ArgumentError, "#{hook} must be callable (or nil to disable)" unless value.nil? || value == false || value.respond_to?(:call)
+      end
     end
   end
 end

data/lib/sentry/sanitizer/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module Sanitizer
-    VERSION = "0.9.0"
+    VERSION = "0.10.1"
   end
 end

data/sentry-sanitizer.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "sentry-ruby", ">= 5.3", "< 8.0.0"
+  spec.add_runtime_dependency "sentry-ruby", ">= 6.0", "< 8.0.0"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Valentine Kiselev
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 8.0.0
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: 8.0.0
@@ -36,8 +36,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci-linux.yml"
-- ".github/workflows/ci-macos.yml"
+- ".github/workflows/ci.yml"
 - ".github/workflows/coveralls-report.yml"
 - ".gitignore"
 - ".rspec"

data/.github/workflows/ci-macos.yml

@@ -1,40 +0,0 @@
-name: CI macos
-on:
-  push:
-  pull_request:
-
-jobs:
-  rspec:
-    name: Unit tests
-    runs-on: macos-13
-    strategy:
-      matrix:
-        include:
-          - { ruby_version: 3.3, sentry_version: "~> 6.0" }
-          - { ruby_version: 3.4, sentry_version: "~> 6.0" }
-          - { ruby_version: 3.4, sentry_version: "~> 7.0" }
-          - { ruby_version: 4.0, sentry_version: "~> 6.0" }
-          - { ruby_version: 4.0, sentry_version: "~> 7.0" }
-          - { ruby_version: jruby, sentry_version: "~> 6.0" }
-    env:
-      SENTRY_VERSION: ${{ matrix.sentry_version }}
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Set up Ruby ${{ matrix.ruby_version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler: 2
-          ruby-version: ${{ matrix.ruby_version }}
-
-      - name: Run specs
-        run: |
-          bundle install --jobs 4 --retry 3 --no-cache
-          bundle exec rspec
-
-      - uses: coverallsapp/github-action@v2
-        env:
-          COVERALLS_SERVICE_NUMBER: ${{ github.sha }}
-        with:
-          flag-name: ruby-${{ join(matrix.*, '-') }}
-          parallel: true