Add :in_app_otp_apps option (#854)

Co-authored-by: Andrea Leopardi <[email protected]>

Author: solnic

lib/sentry/application.ex

@@ -10,6 +10,11 @@ defmodule Sentry.Application do
     config = Config.validate!()
     :ok = Config.persist(config)
 
+    Config.put_config(
+      :in_app_module_allow_list,
+      Config.in_app_module_allow_list() ++ resolve_in_app_module_allow_list()
+    )
+
     http_client = Keyword.fetch!(config, :client)
 
     maybe_http_client_spec =
@@ -71,4 +76,13 @@ defmodule Sentry.Application do
       Sentry.Integrations.Quantum.Cron.attach_telemetry_handler()
     end
   end
+
+  defp resolve_in_app_module_allow_list do
+    Enum.flat_map(Config.in_app_otp_apps(), fn app ->
+      case :application.get_key(app, :modules) do
+        {:ok, modules} -> modules
+        _ -> []
+      end
+    end)
+  end
 end

lib/sentry/config.ex

@@ -388,6 +388,20 @@ defmodule Sentry.Config do
       The number of lines of source code
       before and after the line that caused the exception to report.
       """
+    ],
+    in_app_otp_apps: [
+      type: {:list, :atom},
+      default: [],
+      type_doc: "list of `t:atom/0`",
+      doc: """
+      A list of OTP application names that will be used to populate additional modules for the
+      `:in_app_module_allow_list` option. List your application (or the applications in your
+      umbrella project) for them to show as "in-app" in stacktraces in Sentry. We recommend using
+      this option over `:in_app_module_allow_list`, unless you need more control over the exact
+      modules to consider as "in-app".
+
+      *Available since v10.9.0*.
+      """
     ]
   ]
 
@@ -575,6 +589,9 @@ defmodule Sentry.Config do
   @spec report_deps?() :: boolean()
   def report_deps?, do: fetch!(:report_deps)
 
+  @spec in_app_otp_apps() :: [atom()]
+  def in_app_otp_apps, do: fetch!(:in_app_otp_apps)
+
   @spec json_library() :: module()
   def json_library, do: fetch!(:json_library)
 

mix.exs

@@ -136,6 +136,7 @@ defmodule Sentry.Mixfile do
 
   defp run_integration_tests_if_supported(args) do
     if Version.match?(System.version(), ">= 1.16.0") do
+      run_integration_tests("umbrella", args)
       run_integration_tests("phoenix_app", args)
     else
       Mix.shell().info("Skipping integration tests for Elixir versions < 1.16")

test_integrations/umbrella/.formatter.exs

@@ -0,0 +1,5 @@
+# Used by "mix format"
+[
+  inputs: ["mix.exs", "config/*.exs"],
+  subdirectories: ["apps/*"]
+]

test_integrations/umbrella/.gitignore

@@ -0,0 +1,20 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Temporary files, for example, from tests.
+/tmp/

test_integrations/umbrella/README.md

@@ -0,0 +1,4 @@
+# PhoenixAppUmbrella
+
+**TODO: Add description**
+

test_integrations/umbrella/apps/admin/.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

test_integrations/umbrella/apps/admin/.gitignore

@@ -0,0 +1,23 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+admin-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/

test_integrations/umbrella/apps/admin/README.md

@@ -0,0 +1,21 @@
+# Admin
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `admin` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:admin, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at <https://hexdocs.pm/admin>.
+

test_integrations/umbrella/apps/admin/lib/admin.ex

@@ -0,0 +1,18 @@
+defmodule Admin do
+  @moduledoc """
+  Documentation for `Admin`.
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> Admin.hello()
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end