sentry-raven 3.0.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765b22e2ec433b8ab12697da42d40ba6c0f2f95956bd6ce93b0923b9160f386f
-  data.tar.gz: b4f97a6effa6828a10cb7844001852db042627dfe375aae61e93b92d10eb2ba7
+  metadata.gz: 9409fd1db13a8eec36f00e801c3391b84739dc6166123e5397494b85766149ec
+  data.tar.gz: 3a9eb01cfdf1922ec4e8b1a5553a31d224a7df39fc6a37ddbed9277e4b3d72ab
 SHA512:
-  metadata.gz: 25c1a39ce4a97b7e40fa66fc1dd1eb7ae4ef96a6e0956f7600db04717eb8c9f147d83317513ba072db31a4390b678b9c56f406f6ba02377f11b4810a3fef5128
-  data.tar.gz: 17adf7a479a1539a9fdc81003b2204c0334334cb54482812339af18cd7a75eb9830e22389fc0eed7e304787b993f8aaca92bb1d1c2f414e88a61858acadf08aa
+  metadata.gz: 46c863f1960b12c97a03a91edda72dd4ec16d04da2e6890a80bd736b092b11e44e74822c6497219883f7ed1c5c135e7b789b36da299fcba389f2accdefb83b97
+  data.tar.gz: 560dad6f93a0fbd345100b4c4de7e578dedb874a8fab63a8168f629b53d13938276cf4f10db6e2dd357ffc8fa04dc91a87dac6185bcd7e5e3585bbf98ef09e5c

data/.craft.yml

@@ -1,4 +1,4 @@
-minVersion: '0.9.0'
+minVersion: '0.11.0'
 github:
     owner: getsentry
     repo: raven-ruby
@@ -7,6 +7,7 @@ preReleaseCommand: ruby .scripts/bump-version.sh
 statusProvider: 
     name: github
 targets:
+    - name: gem
     - name: github
     - name: registry
       type: sdk

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: st0012
+
+---
+
+**Describe the bug**
+
+**To Reproduce**
+
+**Expected behavior**
+
+**Actual behavior**
+
+**Environment**
+ - Ruby Version: 
+ - SDK Version:
+ - Integration Versions (if any):
+  - e.g. Rails 6.0, Sidekiq 6.1.2
+
+**Raven Config**
+
+This is not necessary but could be helpful.
+
+```ruby
+Raven.configure do |config|
+  # the config you're using, without DSN and other sensitive data
+end
+```

data/.github/pull_request_template.md

@@ -0,0 +1,16 @@
+Thanks for your Pull Request 🎉 
+
+**Please keep these instructions in mind so we can review it more efficiently:**
+
+- Add the references of all the related issues/PRs in the description
+- Whether it's a new feature or a bug fix, make sure they're covered by new test cases
+- If this PR contains any refactoring work, please give it its own commit(s)
+
+
+**Other Notes**
+- We squash all commits before merging
+- We generally review new PRs within a week
+- If you have any question, you can ask for feedback in our [discord community](https://discord.gg/Ww9hbqr) first
+
+## Description
+Describe your changes:

data/.github/workflows/test.yml

@@ -1,10 +1,9 @@
 name: Test
 
-on: 
+on:
   push:
     branches:
       - master
-      - release/**
   pull_request:
 jobs:
   test:
@@ -44,34 +43,50 @@ jobs:
         bundler: 1
         ruby-version: ${{ matrix.ruby_version }}
 
+    - name: Start Redis
+      uses: supercharge/redis-github-action@1.1.0
+      with:
+        redis-version: 5
+
     - name: Build with Rails ${{ matrix.rails_version }}
       env:
         RAILS_VERSION: ${{ matrix.rails_version }}
-      run: | 
+      run: |
         bundle install --jobs 4 --retry 3
         bundle exec rake
 
-  job_zeus:
-    name: Zeus
-    runs-on: ubuntu-latest
+  compare_allocation:
+    name: Compare memory allocation with ${{ matrix.ruby_version }} and rails ${{ matrix.rails_version }}
+    runs-on: ${{ matrix.os }}
+    needs: test
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    strategy:
+      matrix:
+        rails_version: [5.2, 6.0]
+        ruby_version: [2.6, 2.7]
+        os: [ubuntu-latest]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.6 # Not needed with a .ruby-version file
-      - run: bundle install
-      - name: Install Zeus
-        run: |
-          yarn global add @zeus-ci/cli
-          echo "::add-path::$(yarn global bin)"
-      - name: Upload to Zeus
-        env:
-          ZEUS_API_TOKEN: ${{ secrets.ZEUS_API_TOKEN }}
-          ZEUS_HOOK_BASE: ${{ secrets.ZEUS_HOOK_BASE }}
-        run: |
-          zeus job update -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
-          gem build sentry-raven.gemspec
-          zeus upload -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -t "application/tar+gem" ./*.gem
-          zeus job update --status=passed -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler: 1
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - uses: actions/checkout@v2
+      with:
+        ref: master
+
+    - name: Build and run allocation report on master
+      run: |
+        bundle install --jobs 4 --retry 3
+        bundle exec ruby benchmarks/allocation_comparison.rb
+
+    - uses: actions/checkout@v1
+
+    - name: Rebuild on the branch
+      run: |
+        bundle install --jobs 4 --retry 3
+    - name: Run allocation report on the branch
+      run: |
+        bundle exec ruby benchmarks/allocation_comparison.rb

data/.github/workflows/zeus_upload.yml

@@ -0,0 +1,32 @@
+name: Zeus Upload
+
+on:
+  push:
+    branches:
+      - release/**
+
+jobs:
+  zeus_upload:
+    name: Zeus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6 # Not needed with a .ruby-version file
+      - run: bundle install
+      - name: Install Zeus
+        run: |
+          yarn global add @zeus-ci/cli
+          echo "::add-path::$(yarn global bin)"
+      - name: Upload to Zeus
+        env:
+          ZEUS_API_TOKEN: ${{ secrets.ZEUS_API_TOKEN }}
+          ZEUS_HOOK_BASE: ${{ secrets.ZEUS_HOOK_BASE }}
+        run: |
+          zeus job update -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
+          gem build sentry-raven.gemspec
+          zeus upload -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -t "application/tar+gem" ./*.gem
+          zeus job update --status=passed -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA

data/.gitignore

@@ -1,5 +1,6 @@
 coverage
 pkg
+tmp
 ruby/
 log/
 .bundle

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
      - 'vendor/**/*'
 
 Metrics/ClassLength:
-  Max: 300
+  Max: 350
   CountComments: false
 
 Metrics/AbcSize:
@@ -23,7 +23,7 @@ Metrics/PerceivedComplexity:
   Max: 11
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 40
 
 Style/SymbolArray:
   Enabled: false
@@ -55,6 +55,9 @@ Style/CommentedKeyword:
 Style/RescueModifier:
   Enabled: false
 
+Style/RegexpLiteral:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: false
 
@@ -75,7 +78,7 @@ Style/NumericLiterals:
     - 'spec/raven/processors/sanitizedata_processor_spec.rb'
 
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+  Enabled: false
 
 Style/IfUnlessModifier:
   Enabled: false

data/{changelog.md → CHANGELOG.md}

@@ -1,14 +1,164 @@
 # Changelog
 
-## Unreleased
+## 3.1.1
+
+**Feature**
+
+- Add request id to headers if exists ([#1033](https://github.com/getsentry/sentry-ruby/pull/1033))
+
+- Allow blocks on user_context ([#1023](https://github.com/getsentry/sentry-ruby/pull/1023))
+
+- Enable configurable rack environment recorded parameters ([#860](https://github.com/getsentry/sentry-ruby/pull/860))
+
+- Remove ActiveJob keys for both Sidekiq and DelayedJob ([#898](https://github.com/getsentry/sentry-ruby/pull/898))
+
+**Fix**
+
+- Remove circular dependency in transport/http.rb ([#1035](https://github.com/getsentry/sentry-ruby/pull/1035))
+
+## 3.1.0
+
+**Feature**
+
+- Exclude all 4xx Rails errors ([#1004](https://github.com/getsentry/raven-ruby/pull/1004))
+
+    See the full list [here](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb#L198-L219)
+
+- Add some error context in `transport_failure_callback` ([#1003](https://github.com/getsentry/raven-ruby/pull/1003))
+
+    Before:
+
+    ```ruby
+    config.transport_failure_callback = lambda { |event|
+      AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
+    }
+    ```
+
+    After:
+
+    ```ruby
+    config.transport_failure_callback = lambda { |event, error|
+      AdminMailer.email_admins("Oh god, it's on fire because #{error.message}!", event).deliver_later
+    }
+    ```
+
+- Support cleaning up exception backtrace with customized backtrace_cleaner ([#1011](https://github.com/getsentry/raven-ruby/pull/1011))
+
+    The new config `backtrace_cleanup_callback` takes a lambda/proc object (default is `nil`) and will be called with exception's backtrace
+
+    ```ruby
+    Raven.configure do |config|
+      config.backtrace_cleanup_callback = lambda do |backtrace|
+        Rails.backtrace_cleaner.clean(backtrace)
+      end
+    end
+    ```
+
+    And with the Rails integration, it'll automatically use a customized `Raven::Rails::BacktraceCleaner` to clean up exception's backtrace. It's basically Rails 6's [backtrace cleaner](https://github.com/rails/rails/blob/master/railties/lib/rails/backtrace_cleaner.rb) but without silencers. 
+    
+    The main reason to add this cleaner is to remove template methods from the trace, e.g.
+
+    ```
+    app/views/welcome/view_error.html.erb in _app_views_welcome_view_error_html_erb__2807287320172182514_65600 at line 1
+    ```
+
+    will become
+
+    ```
+    app/views/welcome/view_error.html.erb at line 1
+    ```
+
+    This can help Sentry group issues more accurately. See [#957](https://github.com/getsentry/raven-ruby/issues/957) for more information about this.
+    
+    If you don't want this change, you can disable it with:
+
+    ```ruby
+    Raven.configure do |config|
+      config.backtrace_cleanup_callback = nil
+    end
+    ```
+
+
+- Make dsn value accessable from config ([#1012](https://github.com/getsentry/raven-ruby/pull/1012))
+
+    You can now access the dsn value via `Raven.configuration.dsn`
+    
+**Deprecation**
+
+- Deprecate dasherized filenames ([#1006](https://github.com/getsentry/raven-ruby/pull/1006))
+
+    If you're using 
+    
+    ```ruby
+    gem 'sentry-raven', require: 'sentry-raven-without-integrations'
+    # or 
+    require "sentry-raven-without-integrations"
+    ```
+    
+    you will start seeing deprecation warnings. Please change them into
+    
+    ```ruby
+    gem 'sentry-raven', require: 'sentry_raven_without_integrations'
+    # or 
+    require "sentry_raven_without_integrations"
+    ```
+    
+- Unify breadcrumb loggers activation ([#1016](https://github.com/getsentry/raven-ruby/pull/1016))
+
+    Currently, we activate our breadcrumb loggers differently:
+
+    ```ruby
+    require "raven/breadcrumbs/sentry_logger"
+    Raven.configuration.rails_activesupport_breadcrumbs = true
+    ```
+
+    It's not a nice user interface, so this PR adds a new configuration
+    option `breadcrumbs_logger` to improve this:
+
+    ```ruby
+    Raven.configuration.breadcrumbs_logger = :sentry_logger
+    Raven.configuration.breadcrumbs_logger = :active_support_logger
+    Raven.configuration.breadcrumbs_logger = [:sentry_logger, :active_support_logger]
+    ```
+
+    Please migrate to the new activation apporach, otherwise you'll see depraction warnings. And old ones will be dropped in version 4.0.
+    
+**Refactor**
+
+- Accept non-string message in Event.from_exception ([#1005](https://github.com/getsentry/raven-ruby/pull/1005))
+- Refactor event initialization ([#1010](https://github.com/getsentry/raven-ruby/pull/1010))
+- Refactor sidekiq integration ([#1019](https://github.com/getsentry/raven-ruby/pull/1019))
+
+**Fix**
+
+- Replace sys_command usages in context.rb ([#1017](https://github.com/getsentry/raven-ruby/pull/1017))
+- Fix merge error from rack-timeout raven_context on old releases ([#1007](https://github.com/getsentry/raven-ruby/pull/1007))
+- Return value of `rescue_with_handler` when intercepting ActiveJob exceptions ([#1027](https://github.com/getsentry/raven-ruby/pull/1027))
+
+## 3.0.4
+
+- fix: Don't log warning messages when it doesn't need to (#1000)
+- fix: Revert "Refactor Raven::Client class" (#1002)
+
+## 3.0.3
+
+- fix: Ensure Processor::Cookie can run after Processor::RemoveCircularReferences (#996)
+- fix: Avoid mutating user passed in options (#994)
+- fix: Fix/Refactor Raven::Cli (#989)
+- ref: Refactor Raven::Client class (#995)
+  - It adds `Event#message_from_exception` and `Event#log_message` interfaces
+
+## 3.0.2
+
+- fix: Add gem target for craft
 
 ## 3.0.1
 
-* fix: Improve SanitizeData processor (#984)
-* fix: Masking cookies as key/pair instead of a single string (#983)
-* fix: Transports classes' requiring issue (#986)
-* fix: Frozen string issues (#977)
-* feat: Officially support Rails 6 (#982)
+- fix: Improve SanitizeData processor (#984)
+- fix: Masking cookies as key/pair instead of a single string (#983)
+- fix: Transports classes' requiring issue (#986)
+- fix: Frozen string issues (#977)
+- feat: Officially support Rails 6 (#982)
 
 3.0.0
 ----
@@ -495,7 +645,7 @@ OTHER CHANGES:
 0.12.0
 ------
 
-- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.getsentry.com/hosted/clients/ruby/config/). [jamescway, #232]
+- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.sentry.io/platforms/ruby/config/). [jamescway, #232]
 - An additional processor has been added, though it isn't turned on by default: RemoveStacktrace. Use it to remove stacktraces from exception reports. [nateberkopec, #233]
 - Dependency on `uuidtools` has been removed. [nateberkopec, #231]
 

data/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Contributing
+
+You can contribute this project in the following ways:
+
+- File a [bug report] or propose a feature
+- Open a PR for bug fixes or implementing requested features
+- Give feedback to opened issues/pull requests
+- Test the latest version - `gem 'sentry-raven', github: 'getsentry/raven-ruby'`
+- Contribute documentation in the [document repo]
+
+
+And if you have any questions, please feel free to reach out on [Discord].
+
+
+[bug report]: https://github.com/getsentry/raven-ruby/issues/new?template=bug_report.md
+[document repo]: https://github.com/getsentry/sentry-docs
+[Discord]: https://discord.gg/Ww9hbqr
+
+## How To Contribute
+
+### Running Tests
+
+#### RAILS_VERSION
+
+Because this SDK supports multiple versions of Rails, or even without Rails, you might want to run your test against different versions of Rails.
+
+You can do this by changing the `RAILS_VERSION` environment variable:
+
+
+```
+$ echo RAILS_VERSION=6.0
+$ bundle update # this is necessary if you're switching between Rails versions
+$ bundle exec rake
+```
+
+If not specified, it runs tests against `Rails 5.2`. 
+
+And if you don't want to run the Rails related test cases, you can use `RAILS_VERSION=0`
+
+```
+$ RAILS_VERSION=0 bundle exec rake # runs without Rails related test cases
+```
+
+### Testing Your Change Against Example Rails Apps
+
+We have a few example apps for different Rails versions under the `/examples` folder. You can use them to perform an end-to-end testing on your changes (just remember to change the DSN to your project's).
+
+At this moment, we recommend testing against the [Rails 6 example](https://github.com/getsentry/raven-ruby/tree/master/examples/rails-6.0) first. Please read its readme to see what kind of testing you can perform with it.
+
+
+## Making a release
+
+Install and use `craft`: https://github.com/getsentry/craft
+
+Make sure the `CHANGELOG.md` is update and latest `master` contains all changes.
+
+Run:
+
+```bash
+craft prepare x.x.x
+```
+
+Where `x.x.x` stands for the version you want to release.
+Afterwards reach out to an employee of Sentry, they will cut a release by running the `publish` process of `craft`.