Proper beam compilation and .app file generation

Author: Papipo

lib/mix/lib/mix/dep/loader.ex

@@ -107,7 +107,7 @@ defmodule Mix.Dep.Loader do
           make_dep(dep)
 
         gleam?(dep) ->
-          gleam_dep(dep, children, locked?)
+          gleam_dep(dep, children, manager, locked?)
 
         true ->
           {dep, []}
@@ -367,18 +367,18 @@ defmodule Mix.Dep.Loader do
     {dep, []}
   end
 
-  defp gleam_dep(%Mix.Dep{opts: opts} = dep, _children = nil, locked?) do
+  defp gleam_dep(%Mix.Dep{opts: opts} = dep, _children = nil, manager, locked?) do
     Mix.Gleam.require!()
 
     config = File.cd!(opts[:dest], fn -> Mix.Gleam.load_config(".") end)
     from = Path.join(opts[:dest], "gleam.toml")
-    deps = Enum.map(config[:deps], &to_dep(&1, from, _manager = nil, locked?))
+    deps = Enum.map(config[:deps], &to_dep(&1, from, manager, locked?))
 
     {dep, deps}
   end
 
-  defp gleam_dep(%Mix.Dep{opts: opts} = dep, children, locked?) do
-    {dep, Enum.map(children, &to_dep(&1, opts[:dest], _manager = nil, locked?))}
+  defp gleam_dep(%Mix.Dep{opts: opts} = dep, children, manager, locked?) do
+    {dep, Enum.map(children, &to_dep(&1, opts[:dest], manager, locked?))}
   end
 
   defp mix_children(config, locked?, opts) do

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

@@ -324,65 +324,59 @@ defmodule Mix.Tasks.Deps.Compile do
 
   defp do_gleam(%Mix.Dep{opts: opts} = dep, config) do
     Mix.Gleam.require!()
+    Mix.Project.ensure_structure()
 
     lib = Path.join(Mix.Project.build_path(), "lib")
     out = opts[:build]
     package = opts[:dest]
 
     command =
       {"gleam",
-       ["compile-package", "--target", "erlang", "--package", package, "--out", out, "--lib", lib]}
+       [
+         "compile-package",
+         "--no-beam",
+         "--target",
+         "erlang",
+         "--package",
+         package,
+         "--out",
+         out,
+         "--lib",
+         lib
+       ]}
 
     shell_cmd!(dep, config, command)
 
-    ebin = Path.join(out, "ebin")
-    app_file_path = Keyword.get(opts, :app, Path.join(ebin, "#{dep.app}.app"))
-    create_app_file = app_file_path && !File.exists?(app_file_path)
+    File.cd!(package, fn -> Mix.Gleam.load_config(".") end)
+    |> push_gleam_project(dep, Keyword.fetch!(config, :deps_path))
 
-    if create_app_file do
-      generate_gleam_app_file(opts)
-    end
-
-    Code.prepend_path(ebin, cache: true)
+    Code.prepend_path(Path.join(out, "ebin"), cache: true)
   end
 
-  defp gleam_extra_applications(config) do
-    config
-    |> Map.get(:extra_applications, [])
-    |> Enum.map(&String.to_atom/1)
-  end
-
-  defp gleam_mod(config) do
-    case config[:mod] do
-      nil -> []
-      mod -> {String.to_atom(mod), []}
-    end
-  end
-
-  defp generate_gleam_app_file(opts) do
-    toml = File.cd!(opts[:dest], fn -> Mix.Gleam.load_config(".") end)
-
-    module =
-      quote do
-        def project do
-          [
-            app: unquote(toml.name) |> String.to_atom(),
-            version: "#{unquote(toml.version)}"
-          ]
-        end
-
-        def application do
-          [
-            mod: unquote(gleam_mod(toml)),
-            extra_applications: unquote(gleam_extra_applications(toml))
-          ]
-        end
-      end
-
-    module_name = String.to_atom("Gleam.#{toml.name}")
-    Module.create(module_name, module, Macro.Env.location(__ENV__))
-    Mix.Project.push(module_name)
-    Mix.Tasks.Compile.App.run([])
+  defp push_gleam_project(toml, dep, deps_path) do
+    build = Path.expand(dep.opts[:build])
+    src = Path.join(build, "_gleam_artefacts")
+    File.mkdir(Path.join(build, "ebin"))
+
+    config =
+      [
+        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(),
+        deps_path: deps_path,
+        erlc_paths: [src],
+        erlc_include_path: Path.join(build, "include")
+      ]
+
+    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")
   end
 
   defp make_command(dep) do

lib/mix/test/fixtures/gleam_dep/src/collocated_erlang.erl

@@ -0,0 +1,5 @@
+-module(collocated_erlang).
+-export([hello/0]).
+
+hello() ->
+    "Hello from Collocated Erlang!".

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

@@ -1,3 +1,6 @@
 pub fn main() {
   True
 }
+
+@external(erlang, "collocated_erlang", "hello")
+pub fn erl() -> String

lib/mix/test/mix/gleam_test.exs

@@ -68,7 +68,9 @@ defmodule Mix.GleamTest do
                  {:my_other_project, path: "../my_other_project"},
                  {:gleeunit, ">= 1.0.0 and < 2.0.0", only: :dev}
                ],
-               mod: "some@application"
+               application: [
+                 mod: {:some@application, []}
+               ]
              }
     end
   end
@@ -81,10 +83,10 @@ defmodule Mix.GleamTest do
         Mix.Tasks.Deps.Get.run([])
         assert_received {:mix_shell, :info, ["* Getting gleam_stdlib " <> _]}
         assert_received {:mix_shell, :info, ["* Getting gleam_otp " <> _]}
-        assert_received {:mix_shell, :info, ["* Getting gleeunit " <> _]}
 
         Mix.Tasks.Deps.Compile.run([])
         assert :gleam_dep.main()
+        assert :gleam_dep.erl() == ~c'Hello from Collocated Erlang!'
         assert :gleam@int.to_string(1) == "1"
 
         {:ok, content} = :file.consult("_build/dev/lib/gleam_dep/ebin/gleam_dep.app")
@@ -94,13 +96,15 @@ defmodule Mix.GleamTest do
                    :application,
                    :gleam_dep,
                    [
-                     {:modules, [:gleam_dep]},
+                     {:modules, [:collocated_erlang, :gleam_dep]},
                      {:optional_applications, []},
-                     {:applications, [:kernel, :stdlib, :elixir, :ssl]},
+                     {:applications,
+                      [:kernel, :stdlib, :elixir, :gleam_otp, :gleam_stdlib, :gleeunit]},
                      {:description, ~c"gleam_dep"},
                      {:registered, []},
-                     {:vsn, ~c"1.0.0"},
-                     {:mod, {:gleam_dep@somemodule, []}}
+                     {:vsn, ~c"1.0.0"}
+                     # Need to add support for :application option in Compile.App
+                     #  {:mod, {:gleam_dep@somemodule, []}}
                    ]
                  }
                ]