Merge branch 'master' into sav/Switch-hackney-to-finch

Author: savhappy

.dialyzer_ignore.exs

@@ -1,3 +1,4 @@
 [
-  {"test/support/example_plug_application.ex"}
+  {"test/support/example_plug_application.ex"},
+  {"test/support/test_helpers.ex"}
 ]

.github/workflows/main.yml

@@ -14,25 +14,29 @@ env:
 jobs:
   test:
     name: Test (Elixir ${{ matrix.elixir }}, OTP ${{ matrix.otp }})
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
     strategy:
       fail-fast: false
       matrix:
         # https://hexdocs.pm/elixir/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp
         include:
           # Newest supported Elixir/Erlang pair.
-          - elixir: '1.17'
-            otp: '27.0'
+          - elixir: '1.18'
+            otp: '27.2'
             lint: true
             dialyzer: true
+            os: ubuntu-latest
 
           # One version before the last supported one.
-          - elixir: '1.16'
+          - elixir: '1.17'
             otp: '26.2'
+            os: ubuntu-22.04
 
           # Oldest supported Elixir/Erlang pair.
           - elixir: '1.13.4-otp-22'
             otp: '22.3.4'
+            os: ubuntu-20.04
 
     steps:
     - name: Check out this repository
@@ -44,53 +48,74 @@ jobs:
         elixir-version: ${{ matrix.elixir }}
         otp-version: ${{ matrix.otp }}
 
-    # We need to manually restore and then save, so that we can save the "_build" directory
-    # *without* the Elixir compiled code in it.
-    - name: Restore Mix dependencies cache
-      uses: actions/cache/restore@v4
-      id: mix-deps-cache
+    - name: Cache downloaded dependencies
+      uses: actions/cache@v4
+      id: mix-downloaded-deps-cache
       with:
         path: |
-          _build
           deps
+          test_integrations/phoenix_app/deps
         key: |
-          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
+          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-deps-${{ hashFiles('**/mix.lock') }}
 
-    - name: Install and compile Mix dependencies
-      if: steps.mix-deps-cache.outputs.cache-hit != 'true'
-      run: mix do deps.get --check-locked, deps.compile
+    - name: Download Mix dependencies
+      if: steps.mix-downloaded-deps-cache.outputs.cache-hit != 'true'
+      run: |
+        if [ ${{ matrix.elixir }} != '1.13.4-otp-22' ]; then
+          mix deps.get --check-locked
+        else
+          mix deps.get
+        fi
+
+        if [ ${{ matrix.elixir }} != '1.13.4-otp-22' ]; then
+          cd test_integrations/phoenix_app
+
+          if [ ${{ matrix.lint }} == 'true' ]; then
+            mix deps.get --check-locked
+          else
+            mix deps.get
+          fi
+        fi
 
-    - name: Save Mix dependencies cache
-      uses: actions/cache/save@v4
-      if: steps.mix-deps-cache.outputs.cache-hit != 'true'
+    # We need to manually restore and then save, so that we can save the "_build" directory
+    # *without* the Elixir compiled code in it.
+    - name: Cache compiled Elixir code
+      uses: actions/cache@v4
+      id: mix-cache
       with:
         path: |
           _build
-          deps
+          test_integrations/phoenix_app/_build
         key: |
-          ${{ steps.mix-deps-cache.outputs.cache-primary-key }}
+          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
 
-    - name: Check formatting
+    - name: Compile Elixir code (with --warnings-as-errors)
       if: matrix.lint
-      run: mix format --check-formatted
+      run: |
+        mix compile --warnings-as-errors
+        cd test_integrations/phoenix_app
+        mix compile --warnings-as-errors
 
-    - name: Check compiler warnings
+    - name: Check formatting
       if: matrix.lint
-      run: mix compile --warnings-as-errors
+      run: mix format --check-formatted
 
     - name: Run tests
       run: mix test
 
-    - name: Retrieve PLT Cache
+    - name: Run integration tests
+      run: mix test.integrations
+
+    - name: Cache Dialyzer PLT
       uses: actions/cache@v4
       if: matrix.dialyzer
       id: plt-cache
       with:
         path: plts
         key: |
-          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plts-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+          ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plts-${{ hashFiles(format('**/mix.lock')) }}
         restore-keys: |
           ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plts-
 
@@ -102,4 +127,4 @@ jobs:
 
     - name: Run dialyzer
       if: matrix.dialyzer
-      run: mix dialyzer --no-check --halt-exit-status
+      run: mix dialyzer --no-check

.github/workflows/release.yml

@@ -15,14 +15,20 @@ jobs:
     runs-on: ubuntu-latest
     name: "Release a new version"
     steps:
+      - name: Get auth token
+        id: token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        with:
+          app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
+          private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}
       - uses: actions/checkout@v3
         with:
-          token: ${{ secrets.GH_RELEASE_PAT }}
+          token: ${{ steps.token.outputs.token }}
           fetch-depth: 0
       - name: Prepare release
         uses: getsentry/action-prepare-release@v1
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }}
+          GITHUB_TOKEN: ${{ steps.token.outputs.token }}
         with:
           version: ${{ github.event.inputs.version }}
           force: ${{ github.event.inputs.force }}

.gitignore

@@ -12,3 +12,5 @@ erl_crash.dump
 
 # Generated by "mix sentry.package_source_code"
 /priv/sentry.map
+
+test_integrations/phoenix_app/db

CHANGELOG.md

@@ -1,5 +1,66 @@
 # Changelog
 
+## 10.8.1
+
+### Various fixes & improvements
+
+- Update to LiveView 1.0 🎉 (#826) by @solnic
+- Replace release bot with GH app (#828) by @Jeffreyhung
+
+## 10.8.0
+
+This release bumps the minimum Elixir requirement to 1.13, fixes a few bugs, and introduces **client reports**. Client reports will be sent to Sentry by default, but you can disable them with:
+
+```elixir
+config :sentry,
+  # ...,
+  send_client_reports: false
+```
+
+### Improvements and new features
+
+- Add support for [client reports](https://develop.sentry.dev/sdk/telemetry/client-reports/) (#801) by @savhappy
+- Add option for generating custom cron monitor slugs (#803) by @iautom8things
+- Improvements to documentation
+- Require Elixir 1.13+ (21f0f77e) by @whatyouhide
+- Validate that custom HTTP clients return correct stuff (#794) by @savhappy
+
+### Bug fixes
+
+- Fix stacktraces with no frames (#787) by @savhappy
+- Special-case Ranch errors in the logger handler for OTP 25 (#818) by @whatyouhide
+- Few fixes to `mix sentry.send_test_event`
+- Handle Bandit exception when fetching peer data (#814) by @ardhitama
+- Support non-exception error values from Oban jobs (#807) by @savhappy
+
+## 10.7.1
+
+### Various fixes & improvements
+
+- Add `:monitor_config_defaults` integrations option (#782). — *@whatyouhide*
+- Allow `--no-compile`/`--no-check-deps` flags for `mix sentry.package_source_code` (#776). — *@razielgn*
+- Accept structs as structured logs in `Sentry.LoggerHandler` (#780). — *@mrdotb*
+- Fix a bug where we were accidentally sending the `:integration_meta` field (116140d6). — *@whatyouhide*
+- Reduce memory usage of source code maps (#777). — *@whatyouhide*
+
+## 10.7.0
+
+### Various fixes & improvements
+
+New features:
+
+- Add `Sentry.ClientError` for more structured client errors. You can use this to programmatically deal with errors when reporting events, if you need to. — *@savhappy*
+- Add `:integration_meta` key to `Sentry.Event`. — *(#771) by @savhappy*
+- Validate Sentry options even if DSN is not set. — *(#772) by @savhappy*
+
+Bug fixes:
+
+- Fix Sentry check-ins by internally mapping check-in IDs for "start" and "stop" events. — *@savhappy*
+- Fix `mix sentry.package_source_code` edge cases by compiling code before running the task. — *@whatyouhide*
+- Support structured logs in `Sentry.LoggerHandler`. — *(#765) by @martosaur*
+- Handle `nil` environment correctly in Sentry config — *(#753) by @fahchen*
+- Fix exceptions with an empty stacktrace. — *(#755) by @savhappy*
+
 ## 10.6.2
 
 ### Various fixes & improvements

README.md

@@ -18,20 +18,35 @@ This is the official Sentry SDK for [Sentry].
 
 ### Install
 
-To use Sentry in your project, add it as a dependency in your `mix.exs` file. Sentry does not install a JSON library nor HTTP client by itself. Sentry will default to trying to use [Jason] for JSON serialization and [Finch] for HTTP requests, but can be configured to use other ones. To use the default ones, do:
+To use Sentry in your project, add it as a dependency in your `mix.exs` file.
+
+Sentry does not install a JSON library nor an HTTP client by itself. Sentry will default to the [built-in `JSON`](https://hexdocs.pm/elixir/JSON.html) for JSON and [Finch] for HTTP requests, but can be configured to use other ones. To use the default ones, do:
+
 
 ```elixir
 defp deps do
   [
     # ...
-
-    {:sentry, "~> 10.0"},
+    {:sentry, "~> 10.8"},
     {:jason, "~> 1.4"},
     {:finch, "~> 0.18"}
   ]
 end
 ```
 
+> [!WARNING]
+> If you're using an Elixir version before 1.18, the Sentry SDK will default to [Jason] as the JSON library. However, you **must** add it to your dependencies:
+>
+> ```elixir
+> defp deps do
+>   [
+>     # ...
+>     {:sentry, "~> 10.8.1"},
+>     {:jason, "~> 1.4"}
+>   ]
+> end
+> ```
+
 ### Configuration
 
 Sentry has a range of configuration options, but most applications will have a configuration that looks like the following:
@@ -40,24 +55,65 @@ Sentry has a range of configuration options, but most applications will have a c
 # config/config.exs
 config :sentry,
   dsn: "https://[email protected]/1",
-  environment_name: Mix.env(),
+  environment_name: config_env(),
   enable_source_code_context: true,
   root_source_code_paths: [File.cwd!()]
 ```
 
 ### Usage
 
-This library comes with a [`:logger` handler][logger-handlers] to capture error messages coming from process crashes. To enable this, add the handler when your application starts:
+This library comes with a [`:logger` handler][logger-handlers] to capture error messages coming from process crashes. To enable this, add [`Sentry.LoggerHandler`](https://hexdocs.pm/sentry/Sentry.LoggerHandler.html) to your production configuration:
 
-```diff
-  def start(_type, _args) do
-+   :logger.add_handler(:sentry_handler, Sentry.LoggerHandler, %{})
+```elixir
+# config/prod.exs
+config :my_app, :logger, [
+  {:handler, :my_sentry_handler, Sentry.LoggerHandler, %{
+    config: %{
+      metadata: [:file, :line],
+      rate_limiting: [max_events: 10, interval: _1_second = 1_000],
+      # Logs all messages with level `:error` and above to Sentry.
+      # Remove :capture_log_messages and :level if you only want to report crashes.
+      capture_log_messages: true,
+      level: :error
+    }
+  }}
+]
 
-    # ...
-  end
 ```
 
-The handler can also be configured to capture `Logger` metadata. See the documentation [here](https://hexdocs.pm/sentry/Sentry.LoggerBackend.html).
+And then add your logger when your application starts:
+
+```elixir
+# lib/my_app/application.ex
+def start(_type, _args) do
+  Logger.add_handlers(:my_app)
+
+  # ...
+end
+```
+
+Alternatively, you can skip the `:logger` configuration and add the handler directly
+to your application's `start/2` callback:
+
+```elixir
+# lib/my_app/application.ex
+def start(_type, _args) do
+  :logger.add_handler(:my_sentry_handler, Sentry.LoggerHandler, %{
+    config: %{
+      metadata: [:file, :line],
+      rate_limiting: [max_events: 10, interval: _1_second = 1_000],
+      capture_log_messages: true,
+      level: :error
+    }
+  })
+
+  # ...
+end
+```
+
+See all logger configuration options [here](https://hexdocs.pm/sentry/Sentry.LoggerHandler.html).
+
+#### Capture exceptions manually
 
 Sometimes you want to capture specific exceptions manually. To do so, use [`Sentry.capture_exception/2`](https://hexdocs.pm/sentry/Sentry.html#capture_exception/2).
 
@@ -130,10 +186,9 @@ Thanks to everyone who has contributed to this project so far.
   <img src="https://contributors-img.web.app/image?repo=getsentry/sentry-elixir" />
 </a>
 
-
 ## Getting Help/Support
 
-If you need help setting up or configuring the Python SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
+If you need help setting up or configuring the Elixir SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
 
 ## Resources
 

config/config.exs

@@ -15,4 +15,4 @@ if config_env() == :test do
   config :logger, backends: []
 end
 
-config :phoenix, :json_library, Jason
+config :phoenix, :json_library, if(Code.ensure_loaded?(JSON), do: JSON, else: Jason)