Copy dev build if the environments match

Author: José Valim

lib/mix/lib/mix/deps/lock.ex

@@ -18,16 +18,30 @@ defmodule Mix.Deps.Lock do
   """
   def touch(manifest_path // Mix.Project.manifest_path) do
     File.mkdir_p!(manifest_path)
-    File.write!(Path.join(manifest_path, @manifest), System.version)
+    File.write!(Path.join(manifest_path, @manifest), "#{System.version}\n#{Mix.env}")
   end
 
   @doc """
-  Returns the elixir lock version.
+  Returns the elixir version in the lock manifest.
   """
   def elixir_vsn(manifest_path // Mix.Project.manifest_path) do
+    read_manifest(manifest_path) |> elem(0)
+  end
+
+  @doc """
+  Returns the mix env version in the lock manifest.
+  """
+  def mix_env(manifest_path // Mix.Project.manifest_path) do
+    read_manifest(manifest_path) |> elem(1)
+  end
+
+  defp read_manifest(manifest_path) do
     case File.read(manifest(manifest_path)) do
-      { :ok, contents } -> contents
-      { :error, _ } -> nil
+      { :ok, contents } ->
+        destructure [vsn, env], String.split(contents, "\n")
+        { vsn, env }
+      { :error, _ } ->
+        { nil, nil }
     end
   end
 

lib/mix/lib/mix/tasks/deps.check.ex

@@ -41,15 +41,15 @@ defmodule Mix.Tasks.Deps.Check do
     config = Mix.project
     if config[:build_per_environment] do
       paths = Mix.Project.build_path(config)
-              |> Path.join("lib/*")
+              |> Path.join("lib/*/ebin")
               |> Path.wildcard
-              |> List.delete(Mix.Project.app_path(config))
+              |> List.delete(Mix.Project.compile_path(config))
 
-      to_prune = Enum.reduce(all, paths, &(&2 -- Mix.Deps.source_paths(&1)))
+      to_prune = Enum.reduce(all, paths, &(&2 -- Mix.Deps.load_paths(&1)))
 
       Enum.map(to_prune, fn path ->
         Code.delete_path(path)
-        File.rm_rf!(path)
+        File.rm_rf!(path |> Path.dirname)
       end)
     end
   end

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

@@ -84,14 +84,23 @@ defmodule Mix.Tasks.Deps.Compile do
     :ok
   end
 
-  defp do_mix(Mix.Dep[opts: opts] = dep, config) do
+  defp do_mix(Mix.Dep[app: app, opts: opts] = dep, config) do
     # Set the app_path to be the one stored in the dependency.
     # This is important because the name of application in the
     # mix.exs file can be different than the actual name and we
     # choose to respect the one in the mix.exs.
     config = Keyword.put(config, :app_path, opts[:build])
 
     Mix.Deps.in_dependency dep, config, fn _ ->
+      case dev_compilation(app, config) do
+        { source, target } ->
+          File.rm_rf!(target)
+          File.mkdir_p!(target)
+          File.cp_r!(source, Path.dirname(target))
+        false ->
+          :ok
+      end
+
       try do
         res = Mix.Task.run("compile", ["--no-deps"])
         :ok in List.wrap(res)
@@ -106,6 +115,21 @@ defmodule Mix.Tasks.Deps.Compile do
     end
   end
 
+  # In case we have build per environments and the dependency was already
+  # compiled for development and the target is stale compared to the
+  # development (source) one, we simply copy the source to target and do
+  # the compilation on top of it.
+  defp dev_compilation(app, config) do
+    if config[:build_per_environment] do
+      source = config[:build_path] |> Path.dirname |> Path.join("dev/lib/#{app}")
+      target = Mix.Project.manifest_path(config)
+      source != target && Mix.Deps.Lock.mix_env(source) == to_string(Mix.env) &&
+        not Mix.Utils.stale?([target], [source]) && { source, target }
+    else
+      false
+    end
+  end
+
   defp do_rebar(Mix.Dep[app: app] = dep, config) do
     do_command dep, rebar_cmd(app), "compile skip_deps=true deps_dir=#{inspect config[:deps_path]}"
   end

lib/mix/test/fixtures/deps_status/deps/ok/priv/sample

@@ -0,0 +1 @@
+SAMPLE

lib/mix/test/mix/deps/lock_test.exs

@@ -30,4 +30,16 @@ defmodule Mix.Deps.LockTest do
       refute File.regular? "_build/shared/lib/sample/.compile.lock"
     end
   end
+
+  test "stores version and env in manifest" do
+    in_fixture "no_mixfile", fn ->
+      assert nil? Mix.Deps.Lock.elixir_vsn
+      assert nil? Mix.Deps.Lock.mix_env
+
+      Mix.Deps.Lock.touch
+
+      assert Mix.Deps.Lock.elixir_vsn == System.version
+      assert Mix.Deps.Lock.mix_env == "dev"
+    end
+  end
 end

lib/mix/test/mix/tasks/deps_test.exs

@@ -27,6 +27,16 @@ defmodule Mix.Tasks.DepsTest do
     end
   end
 
+  defmodule PerEnvironemtDepsApp do
+    def project do
+      [ app: :sample, version: "0.1.0", build_per_environment: true,
+        deps: [
+          { :ok, "0.1.0", path: "deps/ok" }
+        ]
+      ]
+    end
+  end
+
   defmodule ReqDepsApp do
     def project do
       [ app: :req_deps, version: "0.1.0",
@@ -155,19 +165,20 @@ defmodule Mix.Tasks.DepsTest do
   end
 
   test "compiles and prunes builds per environment" do
-    Mix.ProjectStack.post_config [build_per_environment: true]
-    Mix.Project.push SuccessfulDepsApp
+    Mix.Project.push PerEnvironemtDepsApp
 
     in_fixture "deps_status", fn ->
       Mix.Tasks.Deps.Compile.run []
+      Mix.Tasks.Deps.Check.run []
       assert File.exists?("_build/dev/lib/ok/ebin/ok.app")
+      assert File.exists?("_build/dev/lib/ok/priv/sample")
 
       Mix.Tasks.Compile.run []
       assert File.exists?("_build/dev/lib/sample/ebin/sample.app")
 
-      Mix.ProjectStack.post_config [build_per_environment: true, deps: []]
+      Mix.ProjectStack.post_config [deps: []]
       Mix.Project.pop
-      Mix.Project.push SuccessfulDepsApp
+      Mix.Project.push PerEnvironemtDepsApp
 
       Mix.Tasks.Deps.Check.run []
       refute File.exists?("_build/dev/lib/ok/ebin/ok.app")
@@ -177,6 +188,76 @@ defmodule Mix.Tasks.DepsTest do
     Mix.Project.pop
   end
 
+  test "copies dev dependency when building per environment" do
+    Mix.Project.push PerEnvironemtDepsApp
+
+    in_fixture "deps_status", fn ->
+      File.mkdir_p!("deps/ok/lib")
+      File.write!("deps/ok/lib/empty.ex", "")
+
+      Mix.Tasks.Deps.Compile.run []
+      assert File.exists?("_build/dev/lib/ok/ebin/ok.app")
+      assert_received { :mix_shell, :info, ["Generated ok.app"] }
+
+      Mix.Task.clear
+      Mix.env(:test)
+      Mix.Project.pop
+      Mix.Project.push PerEnvironemtDepsApp
+
+      Mix.Tasks.Deps.Compile.run []
+      assert File.exists?("_build/test/lib/ok/ebin/ok.app")
+      assert File.read!("_build/test/lib/ok/priv/sample") == "SAMPLE"
+      # We don't get a message becaused we copied the contents over
+      refute_received { :mix_shell, :info, ["Generated ok.app"] }
+    end
+  after
+    Mix.env(:dev)
+    Mix.Project.pop
+  end
+
+  test "does not choke when another environment is compiled first than dep" do
+    Mix.Project.push PerEnvironemtDepsApp
+    Mix.env(:test)
+
+    in_fixture "deps_status", fn ->
+      File.mkdir_p!("deps/ok/lib")
+      File.write!("deps/ok/lib/empty.ex", "")
+
+      Mix.Tasks.Deps.Compile.run []
+      assert File.exists?("_build/test/lib/ok/ebin/ok.app")
+      assert File.read!("_build/test/lib/ok/priv/sample") == "SAMPLE"
+      assert_received { :mix_shell, :info, ["Generated ok.app"] }
+    end
+  after
+    Mix.env(:dev)
+    Mix.Project.pop
+  end
+
+  test "does not copy if environments do not match" do
+    Mix.ProjectStack.post_config(deps: [{ :ok, "0.1.0", path: "deps/ok", env: Mix.env }])
+    Mix.Project.push PerEnvironemtDepsApp
+
+    in_fixture "deps_status", fn ->
+      File.mkdir_p!("deps/ok/lib")
+      File.write!("deps/ok/lib/empty.ex", "")
+
+      Mix.Tasks.Deps.Compile.run []
+      assert File.exists?("_build/dev/lib/ok/ebin/ok.app")
+      assert_received { :mix_shell, :info, ["Generated ok.app"] }
+
+      Mix.Task.clear
+      Mix.env(:test)
+      Mix.Project.pop
+      Mix.Project.push PerEnvironemtDepsApp
+
+      Mix.Tasks.Deps.Compile.run []
+      assert_received { :mix_shell, :info, ["Generated ok.app"] }
+    end
+  after
+    Mix.env(:dev)
+    Mix.Project.pop
+  end
+
   test "unlocks all deps" do
     Mix.Project.push DepsApp
     in_fixture "no_mixfile", fn ->