Proper handling of deeply nested and dev gleam deps

Co-authored-by: selenil <[email protected]>

Author: Papipo

lib/mix/lib/mix/gleam.ex

@@ -22,7 +22,7 @@ defmodule Mix.Gleam do
 
     dev_deps =
       Map.get(json, "dev-dependencies", %{})
-      |> Enum.map(&parse_dep(&1, only: :dev))
+      |> Enum.map(&parse_dep(&1, only: [:dev, :test]))
 
     %{
       name: Map.fetch!(json, "name"),
@@ -45,7 +45,7 @@ defmodule Mix.Gleam do
           {dep, version, opts}
 
         %{"path" => path} ->
-          {dep, Keyword.merge(opts, path: path)}
+          {dep, Keyword.merge(opts, path: Path.expand(path))}
 
         %{"git" => git, "ref" => ref} ->
           {dep, git: git, ref: ref}

lib/mix/lib/mix/tasks/deps.compile.ex

@@ -333,24 +333,41 @@ defmodule Mix.Tasks.Deps.Compile do
     File.mkdir(Path.join(build, "ebin"))
 
     config =
-      [
+      Mix.Project.deps_config()
+      |> Keyword.merge(
         app: dep.app,
         version: toml.version,
         deps: toml.deps,
         build_per_environment: true,
         lockfile: "mix.lock",
         # Remove per-environment segment from the path since ProjectStack.push below will append it
         build_path: Mix.Project.build_path() |> Path.split() |> Enum.drop(-1) |> Path.join(),
+        build_scm: dep.scm,
         deps_path: deps_path,
+        deps_app_path: build,
         erlc_paths: [src],
+        elixirc_paths: [src],
         erlc_include_path: Path.join(build, "include")
-      ]
+      )
+
+    env = dep.opts[:env] || :prod
+    old_env = Mix.env()
+
+    try do
+      Mix.env(env)
+      Mix.ProjectStack.push(dep.app, config, "nofile")
 
-    Mix.ProjectStack.pop()
-    Mix.ProjectStack.push(dep.app, config, "nofile")
-    # Somehow running just `compile` task won't work (doesn't compile the .erl files)
-    Mix.Task.run("compile.erlang", ["--force"])
-    Mix.Task.run("compile.app")
+      options = ["--from-mix-deps-compile", "--no-warnings-as-errors", "--no-code-path-pruning"]
+
+      # Somehow running just `compile` task won't work (doesn't compile the .erl files)
+      Mix.Task.run("compile.erlang", options)
+      Mix.Task.run("compile.elixir", options)
+      Mix.Task.run("compile.app", options)
+
+      Mix.ProjectStack.pop()
+    after
+      Mix.env(old_env)
+    end
   end
 
   defp make_command(dep) do

lib/mix/test/fixtures/gleam_dep/.gitignore

@@ -1,6 +1,9 @@
 # The directory Mix will write compiled artifacts to.
 /_build/
 
+# The directory gleam will write compiled artifacts to.
+/build/
+
 # If the VM crashes, it generates a dump, let's ignore it too.
 erl_crash.dump
 

lib/mix/test/fixtures/gleam_dep/gleam.toml

@@ -21,4 +21,3 @@ gleeunit = ">= 1.0.0 and < 2.0.0"
 
 [erlang]
 extra_applications = ["ssl"]
-application_start_module = "gleam_dep@somemodule"

lib/mix/test/fixtures/subfolder/deeper_gleam_dep/.gitignore

@@ -0,0 +1,14 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# The directory gleam will write compiled artifacts to.
+/build/
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# BEAM bytecode files.
+*.beam
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez

lib/mix/test/fixtures/subfolder/deeper_gleam_dep/gleam.toml

@@ -0,0 +1,17 @@
+name = "deeper_gleam_dep"
+version = "1.0.0"
+
+# Fill out these fields if you intend to generate HTML documentation or publish
+# your project to the Hex package manager.
+#
+# description = ""
+# licences = ["Apache-2.0"]
+# repository = { type = "github", user = "", repo = "" }
+# links = [{ title = "Website", href = "" }]
+#
+# For a full reference of all the available options, you can have a look at
+# https://gleam.run/writing-gleam/gleam-toml/.
+
+[dependencies]
+gleam_dep = { path = "../../gleam_dep" }
+gleam_stdlib = ">= 0.59.0 and < 1.0.0"

lib/mix/test/fixtures/subfolder/deeper_gleam_dep/manifest.toml

@@ -0,0 +1,13 @@
+# This file was generated by Gleam
+# You typically do not need to edit this file
+
+packages = [
+  { name = "gleam_dep", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_otp", "gleam_stdlib"], source = "local", path = "../../gleam_dep" },
+  { name = "gleam_erlang", version = "0.34.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "0C38F2A128BAA0CEF17C3000BD2097EB80634E239CE31A86400C4416A5D0FDCC" },
+  { name = "gleam_otp", version = "0.16.1", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "50DA1539FC8E8FA09924EB36A67A2BBB0AD6B27BCDED5A7EF627057CF69D035E" },
+  { name = "gleam_stdlib", version = "0.59.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "F8FEE9B35797301994B81AF75508CF87C328FE1585558B0FFD188DC2B32EAA95" },
+]
+
+[requirements]
+gleam_dep = { path = "../../gleam_dep" }
+gleam_stdlib = { version = ">= 0.59.0 and < 1.0.0" }

lib/mix/test/fixtures/subfolder/deeper_gleam_dep/src/deeper_gleam_dep.gleam

@@ -0,0 +1,5 @@
+import gleam_dep
+
+pub fn main() -> Bool {
+  gleam_dep.main()
+}

lib/mix/test/mix/gleam_test.exs

@@ -8,15 +8,15 @@ defmodule Mix.GleamTest do
   use MixTest.Case
   @moduletag :gleam
 
-  @compile {:no_warn_undefined, [:gleam_dep, :gleam@int]}
+  @compile {:no_warn_undefined, [:gleam_dep, :gleam@int, :deeper_gleam_dep]}
 
   defmodule GleamAsDep do
     def project do
       [
         app: :gleam_as_dep,
         version: "0.1.0",
         deps: [
-          {:gleam_dep, path: MixTest.Case.tmp_path("gleam_dep"), app: false}
+          {:deeper_gleam_dep, path: MixTest.Case.tmp_path("subfolder/deeper_gleam_dep")}
         ]
       ]
     end
@@ -30,7 +30,7 @@ defmodule Mix.GleamTest do
       expected = [
         {:gleam_stdlib, ">= 0.44.0 and < 2.0.0"},
         {:gleam_otp, ">= 0.16.1 and < 1.0.0"},
-        {:gleeunit, ">= 1.0.0 and < 2.0.0", only: :dev}
+        {:gleeunit, ">= 1.0.0 and < 2.0.0", only: [:dev, :test]}
       ]
 
       assert Enum.sort(config[:deps]) == Enum.sort(expected)
@@ -46,8 +46,7 @@ defmodule Mix.GleamTest do
           "gleam" => ">= 1.8.0",
           "dependencies" => %{
             "git_dep" => %{"git" => "../git_dep", "ref" => "957b83b"},
-            "gleam_stdlib" => %{"version" => ">= 0.18.0 and < 2.0.0"},
-            "my_other_project" => %{"path" => "../my_other_project"}
+            "gleam_stdlib" => %{"version" => ">= 0.18.0 and < 2.0.0"}
           },
           "dev-dependencies" => %{
             "gleeunit" => %{"version" => ">= 1.0.0 and < 2.0.0"}
@@ -66,8 +65,7 @@ defmodule Mix.GleamTest do
                deps: [
                  {:git_dep, git: "../git_dep", ref: "957b83b"},
                  {:gleam_stdlib, ">= 0.18.0 and < 2.0.0"},
-                 {:my_other_project, path: "../my_other_project"},
-                 {:gleeunit, ">= 1.0.0 and < 2.0.0", only: :dev}
+                 {:gleeunit, ">= 1.0.0 and < 2.0.0", only: [:dev, :test]}
                ],
                application: [
                  mod: {:some@application, []},
@@ -90,6 +88,7 @@ defmodule Mix.GleamTest do
         assert :gleam_dep.main()
         assert :gleam_dep.erl() == ~c'Hello from Collocated Erlang!'
         assert :gleam@int.to_string(1) == "1"
+        assert :deeper_gleam_dep.main()
 
         {:ok, content} = :file.consult("_build/dev/lib/gleam_dep/ebin/gleam_dep.app")
 
@@ -100,14 +99,16 @@ defmodule Mix.GleamTest do
                    [
                      {:modules, [:collocated_erlang, :gleam_dep]},
                      {:optional_applications, []},
-                     {:applications,
-                      [:kernel, :stdlib, :elixir, :gleam_otp, :gleam_stdlib, :gleeunit]},
+                     {:applications, [:kernel, :stdlib, :elixir, :gleam_otp, :gleam_stdlib]},
                      {:description, ~c"gleam_dep"},
                      {:registered, []},
                      {:vsn, ~c"1.0.0"}
                    ]
                  }
                ]
+
+        assert File.exists?("_build/dev/lib/deeper_gleam_dep/ebin/deeper_gleam_dep.app")
+        assert :ok == Mix.Tasks.Deps.Loadpaths.run([])
       end)
     end
   end

lib/mix/test/test_helper.exs

@@ -291,12 +291,14 @@ end)
 
 ## Set up Gleam fixtures
 
-fixture = "gleam_dep"
+fixtures = ~w(gleam_dep subfolder)
 
-source = MixTest.Case.fixture_path(fixture)
-dest = MixTest.Case.tmp_path(fixture)
-File.mkdir_p!(dest)
-File.cp_r!(source, dest)
+Enum.each(fixtures, fn fixture ->
+  source = MixTest.Case.fixture_path(fixture)
+  dest = MixTest.Case.tmp_path(fixture)
+  File.mkdir_p!(dest)
+  File.cp_r!(source, dest)
+end)
 
 ## Set up Git fixtures