fixup! Updates Sentry.Sources to support multiple source code root paths

Author: jbernardo95

lib/sentry/config.ex

@@ -90,6 +90,14 @@ defmodule Sentry.Config do
     path = get_config(:root_source_code_path)
 
     cond do
+      not is_nil(path) and not is_nil(paths) ->
+        raise ArgumentError, """
+        :root_source_code_path and :root_source_code_paths can't be configured at the \
+        same time.
+
+        :root_source_code_path is deprecated. Set :root_source_code_paths instead.
+        """
+
       not is_nil(paths) ->
         paths
 

lib/sentry/sources.ex

@@ -65,21 +65,11 @@ defmodule Sentry.Sources do
   @type source_map :: %{String.t() => file_map}
 
   def load_files do
-    root_paths = Config.root_source_code_paths()
-    path_pattern = Config.source_code_path_pattern()
-    exclude_patterns = Config.source_code_exclude_patterns()
-
-    Enum.reduce(root_paths, %{}, fn root_path, acc1 ->
-      Path.join(root_path, path_pattern)
-      |> Path.wildcard()
-      |> exclude_files(exclude_patterns)
-      |> Enum.reduce(acc1, fn path, acc2 ->
-        key = Path.relative_to(path, root_path)
-        value = source_to_lines(File.read!(path))
-
-        Map.put(acc2, key, value)
-      end)
-    end)
+    Enum.reduce(
+      Config.root_source_code_paths(),
+      %{},
+      &load_files_for_root_path/2
+    )
   end
 
   @doc """
@@ -128,6 +118,37 @@ defmodule Sentry.Sources do
     end)
   end
 
+  defp load_files_for_root_path(root_path, files) do
+    root_path
+    |> find_files_for_root_path()
+    |> Enum.reduce(files, fn path, acc ->
+      key = Path.relative_to(path, root_path)
+
+      if Map.has_key?(acc, key) do
+        raise RuntimeError, """
+        Found two source files in different source root paths with the same relative \
+        path: #{key}
+
+        This means that both source files would be reported to Sentry as the same \
+        file. Please rename one of them to avoid this.
+        """
+      else
+        value = source_to_lines(File.read!(path))
+
+        Map.put(acc, key, value)
+      end
+    end)
+  end
+
+  defp find_files_for_root_path(root_path) do
+    path_pattern = Config.source_code_path_pattern()
+    exclude_patterns = Config.source_code_exclude_patterns()
+
+    Path.join(root_path, path_pattern)
+    |> Path.wildcard()
+    |> exclude_files(exclude_patterns)
+  end
+
   defp exclude_files(file_names, []), do: file_names
 
   defp exclude_files(file_names, [exclude_pattern | rest]) do

test/config_test.exs

@@ -72,4 +72,46 @@ defmodule Sentry.ConfigTest do
       assert ["test", "dev"] == Config.included_environments()
     end
   end
+
+  describe "root_source_code_paths" do
+    test "raises error if :root_source_code_path and :root_source_code_paths are set" do
+      modify_env(:sentry, root_source_code_path: "/test")
+      modify_env(:sentry, root_source_code_paths: ["/test"])
+
+      expected_error_message = """
+      :root_source_code_path and :root_source_code_paths can't be configured at the \
+      same time.
+
+      :root_source_code_path is deprecated. Set :root_source_code_paths instead.
+      """
+
+      assert_raise ArgumentError, expected_error_message, fn ->
+        Config.root_source_code_paths()
+      end
+    end
+
+    test "raises error if :root_source_code_path and :root_source_code_paths are not set" do
+      delete_env(:sentry, [:root_source_code_path, :root_source_code_paths])
+
+      expected_error_message = ":root_source_code_paths must be configured"
+
+      assert_raise ArgumentError, expected_error_message, fn ->
+        Config.root_source_code_paths()
+      end
+    end
+
+    test "returns :root_source_code_path if it's set" do
+      modify_env(:sentry, root_source_code_path: "/test")
+      modify_env(:sentry, root_source_code_paths: nil)
+
+      assert Config.root_source_code_paths() == ["/test"]
+    end
+
+    test "returns :root_source_code_paths if it's set" do
+      modify_env(:sentry, root_source_code_path: nil)
+      modify_env(:sentry, root_source_code_paths: ["/test"])
+
+      assert Config.root_source_code_paths() == ["/test"]
+    end
+  end
 end

test/sources_test.exs

@@ -27,6 +27,25 @@ defmodule Sentry.SourcesTest do
                }
              } = Sentry.Sources.load_files()
     end
+
+    test "raises error when two files have the same relative path" do
+      Application.put_env(:sentry, :root_source_code_paths, [
+        File.cwd!() <> "/test/support/example-umbrella-app-with-conflict/apps/app_a",
+        File.cwd!() <> "/test/support/example-umbrella-app-with-conflict/apps/app_b"
+      ])
+
+      expected_error_message = """
+      Found two source files in different source root paths with the same relative \
+      path: lib/module_a.ex
+
+      This means that both source files would be reported to Sentry as the same \
+      file. Please rename one of them to avoid this.
+      """
+
+      assert_raise RuntimeError, expected_error_message, fn ->
+        Sentry.Sources.load_files()
+      end
+    end
   end
 
   test "exception makes call to Sentry API" do

test/support/example-umbrella-app-with-conflict/apps/app_a/lib/module_a.ex

@@ -0,0 +1,5 @@
+defmodule ModuleA do
+  def test do
+    "test a"
+  end
+end

test/support/example-umbrella-app-with-conflict/apps/app_b/lib/module_a.ex

@@ -0,0 +1,5 @@
+defmodule ModuleB do
+  def test do
+    "test b"
+  end
+end