Raise when a reference conflicts with the scope on schema generation (#6489)

* Raise when a reference conflicts with the scope

* Add reference-scope conflict test for context generator

* Use scope schema key for checking reference and scope conflict on schema generation

Author: vinceurag

lib/mix/phoenix/schema.ex

@@ -85,7 +85,7 @@ defmodule Mix.Phoenix.Schema do
     table = opts[:table] || schema_plural
     scope = Mix.Phoenix.Scope.scope_from_opts(ctx_app, opts[:scope], opts[:no_scope])
     {cli_attrs, uniques, redacts} = extract_attr_flags(cli_attrs)
-    {assocs, attrs} = partition_attrs_and_assocs(module, attrs(cli_attrs))
+    {assocs, attrs} = partition_attrs_and_assocs(module, attrs(cli_attrs), scope)
     types = types(attrs)
     web_namespace = opts[:web] && Phoenix.Naming.camelize(opts[:web])
     web_path = web_namespace && Phoenix.Naming.underscore(web_namespace)
@@ -450,7 +450,7 @@ defmodule Mix.Phoenix.Schema do
     )
   end
 
-  defp partition_attrs_and_assocs(schema_module, attrs) do
+  defp partition_attrs_and_assocs(schema_module, attrs, scope) do
     {assocs, attrs} =
       Enum.split_with(attrs, fn
         {_, {:references, _}} ->
@@ -470,6 +470,8 @@ defmodule Mix.Phoenix.Schema do
 
     assocs =
       Enum.map(assocs, fn {key_id, {:references, source}} ->
+        validate_scope_and_reference_conflict!(scope, key_id)
+
         key = String.replace(Atom.to_string(key_id), "_id", "")
         base = schema_module |> Module.split() |> Enum.drop(-1)
         module = Module.concat(base ++ [Phoenix.Naming.camelize(key)])
@@ -479,6 +481,17 @@ defmodule Mix.Phoenix.Schema do
     {assocs, attrs}
   end
 
+  defp validate_scope_and_reference_conflict!(
+         %Mix.Phoenix.Scope{schema_key: reference_key},
+         reference_key
+       ) do
+    Mix.raise("""
+    Reference #{inspect(reference_key)} has the same name as the scope schema key, either skip the reference or pass it with the --no-scope flag.
+    """)
+  end
+
+  defp validate_scope_and_reference_conflict!(_scope, _source), do: :ok
+
   defp schema_defaults(attrs) do
     Enum.into(attrs, %{}, fn
       {key, :boolean} -> {key, ", default: false"}

test/mix/tasks/phx.gen.context_test.exs

@@ -576,4 +576,32 @@ defmodule Mix.Tasks.Phx.Gen.ContextTest do
       )
     end)
   end
+
+  test "raises when a reference conflicts with the scope", config do
+    in_tmp_project(config.test, fn ->
+      with_scope_env(
+        :phoenix,
+        [
+          user: [
+            default: true,
+            module: MyApp.Accounts.Scope,
+            assign_key: :current_scope,
+            access_path: [:user, :id],
+            schema_key: :user_id,
+            schema_type: :binary_id,
+            schema_table: :users
+          ]
+        ],
+        fn ->
+          assert_raise Mix.Error,
+                       ~r"Reference :user_id has the same name as the scope schema key, either skip the reference or pass it with the --no-scope flag.",
+                       fn ->
+                         Gen.Context.run(
+                           ~w(Blog Post posts title:string user_id:references:users)
+                         )
+                       end
+        end
+      )
+    end)
+  end
 end

test/mix/tasks/phx.gen.schema_test.exs

@@ -663,4 +663,32 @@ defmodule Mix.Tasks.Phx.Gen.SchemaTest do
       end
     )
   end
+
+  test "raises when a reference conflicts with the scope", config do
+    in_tmp_project(config.test, fn ->
+      with_scope_env(
+        :phoenix,
+        [
+          user: [
+            default: true,
+            module: MyApp.Accounts.Scope,
+            assign_key: :current_scope,
+            access_path: [:user, :id],
+            schema_key: :user_id,
+            schema_type: :id,
+            schema_table: :users
+          ]
+        ],
+        fn ->
+          assert_raise Mix.Error,
+                       ~r"Reference :user_id has the same name as the scope schema key, either skip the reference or pass it with the --no-scope flag.",
+                       fn ->
+                         Gen.Schema.run(
+                           ~w(Blog.Post blog_posts title:string user_id:references:users)
+                         )
+                       end
+        end
+      )
+    end)
+  end
 end