Clean up --output flag for "mix sentry.package_source_code"

Author: whatyouhide

lib/mix/tasks/sentry.package_source_code.ex

@@ -43,34 +43,18 @@ defmodule Mix.Tasks.Sentry.PackageSourceCode do
   > source-context-related options in compile-time config files (like `config/config.exs`
   > or `config/prod.exs`).
 
-  > #### Building with Nix {: .tip}
-  >
-  > If you build your application using nixpkgs' `mixRelease`,
-  > `mix sentry.package_source_code` will fail, because Sentry's source is read-only.
-  >
-  > To fix this, you can use the `--output` option to write the map file to a writable location,
-  > then copy it to Sentry's `priv` in the final OTP release.
-  >
-  > Example:
-  >
-  > ```nix
-  > mixRelease {
-  >   preBuild = ''
-  >     mix sentry.package_source_code --output sentry.map
-  >   '';
-  >
-  >   postInstall = ''
-  >     sentryPrivDir="$(find $out/lib -maxdepth 1 -name "sentry-*")/priv"
-  >     mkdir "$sentryPrivDir"
-  >     cp -a sentry.map "$sentryPrivDir"
-  >   '';
-  > }
-  > ```
-
   ## Options
 
     * `--debug` - print more information about collecting and encoding source code
-    * `--output path` - write file to the given path. Example: `path/to/sentry.map`
+    * `--output PATH` - write source map file to the given `PATH`. If you don't specify
+      this option, the file will be written to the default path, which is inside the `priv`
+      directory of the `:sentry` application. If you use this option, remember to also
+      **configure the `:source_code_map_path` option**, otherwise Sentry will try to
+      *read* the file from the default location. See `Sentry` for more information.
+      This option can be useful when the source
+      `priv` directory is read-only, such as with [NixOS](https://github.com/NixOS/nixpkgs)
+      and similar tools.
+      *Available since v10.2.0*.
 
   """
 

lib/sentry/config.ex

@@ -61,15 +61,6 @@ defmodule Sentry.Config do
       The name of the server running the application. Not used by default.
       """
     ],
-    source_code_map_path: [
-      type: {:custom, __MODULE__, :__validate_path__, []},
-      default: nil,
-      type_doc: "`t:Path.t/0` or `nil`",
-      doc: """
-      The path to the map file when mix task `sentry.package_source_code` was invoked with
-      `--output path/to/file.map`
-      """
-    ],
     sample_rate: [
       type: {:custom, __MODULE__, :__validate_sample_rate__, []},
       default: 1.0,
@@ -254,6 +245,15 @@ defmodule Sentry.Config do
       exclude from source code context.
       """
     ],
+    source_code_map_path: [
+      type: :string,
+      type_doc: "`t:Path.t/0`",
+      doc: """
+      The path to the source code map file. See
+      [`mix sentry.package_source_code`](`Mix.Tasks.Sentry.PackageSourceCode`).
+      Defaults to a private path inside Sentry's `priv` directory. *Available since v10.2.0*.
+      """
+    ],
     context_lines: [
       type: :pos_integer,
       default: 3,

lib/sentry/sources.ex

@@ -14,9 +14,8 @@ defmodule Sentry.Sources do
 
   # Default argument is here for testing.
   @spec load_source_code_map_if_present(Path.t()) :: {:loaded, source_map()} | {:error, term()}
-  def load_source_code_map_if_present(
-        path \\ Config.source_code_map_path() || path_of_packaged_source_code()
-      ) do
+  def load_source_code_map_if_present(path_for_tests \\ nil) do
+    path = path_for_tests || Config.source_code_map_path() || path_of_packaged_source_code()
     path = Path.relative_to_cwd(path)
 
     with {:ok, contents} <- File.read(path),

test/sentry/config_test.exs

@@ -50,20 +50,11 @@ defmodule Sentry.ConfigTest do
       end
     end
 
-    @tag :tmp_dir
-    test ":source_code_map_path from option", %{tmp_dir: tmp_dir} do
-      source_code_map_path = Path.join([tmp_dir, "test.map"])
+    test ":source_code_map_path from option" do
+      assert Config.validate!()[:source_code_map_path] == nil
 
-      assert Config.validate!(source_code_map_path: nil)[:source_code_map_path] == nil
-
-      assert_raise ArgumentError, ~r/path does not exist/, fn ->
-        assert Config.validate!(source_code_map_path: source_code_map_path)
-      end
-
-      File.touch!(source_code_map_path)
-
-      assert Config.validate!(source_code_map_path: source_code_map_path)[:source_code_map_path] ==
-               source_code_map_path
+      assert Config.validate!(source_code_map_path: "test.map")[:source_code_map_path] ==
+               "test.map"
     end
 
     test ":release from option" do