Add ability to configure the behavior of writing to a non-writable field

Author: green-david

lib/ecto/repo/schema.ex

@@ -6,6 +6,7 @@ defmodule Ecto.Repo.Schema do
   alias Ecto.Changeset
   alias Ecto.Changeset.Relation
   require Ecto.Query
+  require Logger
 
   import Ecto.Query.Planner, only: [attach_prefix: 2]
 
@@ -433,7 +434,7 @@ defmodule Ecto.Repo.Schema do
     struct = struct_from_changeset!(:insert, changeset)
     schema = struct.__struct__
     dumper = schema.__schema__(:dump)
-    {keep_fields, drop_fields} = schema.__schema__(:insertable_fields)
+    {insertable_fields, non_insertable} = schema.__schema__(:insertable)
     assocs = schema.__schema__(:associations)
     embeds = schema.__schema__(:embeds)
 
@@ -451,8 +452,8 @@ defmodule Ecto.Repo.Schema do
     # On insert, we always merge the whole struct into the
     # changeset as changes, except the primary key if it is nil.
     changeset = put_repo_and_action(changeset, :insert, repo, tuplet)
-    changeset = Relation.surface_changes(changeset, struct, keep_fields ++ assocs)
-    changeset = update_in(changeset.changes, &Map.drop(&1, drop_fields))
+    changeset = Relation.surface_changes(changeset, struct, insertable_fields ++ assocs)
+    changeset = update_in(changeset.changes, &drop_non_writable_changes!(&1, non_insertable, :insert))
 
     wrap_in_transaction(adapter, adapter_meta, opts, changeset, assocs, embeds, prepare, fn ->
       assoc_opts = assoc_opts(assocs, opts)
@@ -471,7 +472,7 @@ defmodule Ecto.Repo.Schema do
         {changes, cast_extra, dump_extra, return_types, return_sources} =
           autogenerate_id(autogen_id, changes, return_types, return_sources, adapter)
 
-        changes = Map.take(changes, keep_fields)
+        changes = Map.take(changes, insertable_fields)
         autogen = autogenerate_changes(schema, :insert, changes)
 
         dump_changes =
@@ -543,7 +544,7 @@ defmodule Ecto.Repo.Schema do
     struct = struct_from_changeset!(:update, changeset)
     schema = struct.__struct__
     dumper = schema.__schema__(:dump)
-    {keep_fields, drop_fields} = schema.__schema__(:updatable_fields)
+    {updatable_fields, non_updatable} = schema.__schema__(:updatable)
     assocs = schema.__schema__(:associations)
     embeds = schema.__schema__(:embeds)
 
@@ -560,7 +561,7 @@ defmodule Ecto.Repo.Schema do
     # fields into the changeset. All changes must be in the
     # changeset before hand.
     changeset = put_repo_and_action(changeset, :update, repo, tuplet)
-    changeset = update_in(changeset.changes, &Map.drop(&1, drop_fields))
+    changeset = update_in(changeset.changes, &drop_non_writable_changes!(&1, non_updatable, :update))
 
     if changeset.changes != %{} or force? do
       wrap_in_transaction(adapter, adapter_meta, opts, changeset, assocs, embeds, prepare, fn ->
@@ -575,7 +576,7 @@ defmodule Ecto.Repo.Schema do
         if changeset.valid? do
           embeds = Ecto.Embedded.prepare(changeset, embeds, adapter, :update)
 
-          changes = changeset.changes |> Map.merge(embeds) |> Map.take(keep_fields)
+          changes = changeset.changes |> Map.merge(embeds) |> Map.take(updatable_fields)
           autogen = autogenerate_changes(schema, :update, changes)
           dump_changes = dump_changes!(:update, changes, autogen, schema, [], dumper, adapter)
 
@@ -624,6 +625,31 @@ defmodule Ecto.Repo.Schema do
     {:error, put_repo_and_action(changeset, :update, repo, tuplet)}
   end
 
+  defp drop_non_writable_changes!(changes, non_writable, action) do
+    Enum.reduce(non_writable, changes, fn {name, on_writable_violation}, changes ->
+      case Map.pop(changes, name) do
+        {nil, changes} ->
+          changes
+        {_change, changes} ->
+          handle_writable_violation(name, on_writable_violation, action)
+          changes
+      end
+    end)
+  end
+
+  defp handle_writable_violation(name, on_writable_violation, action) do
+    message = "attempted to write to non-writable field #{inspect(name)} during #{action}"
+
+    case on_writable_violation do
+      :raise ->
+        raise ArgumentError, message
+      :warn ->
+        Logger.warning(message)
+      _ ->
+        :ok
+    end
+  end
+
   @doc """
   Implementation for `Ecto.Repo.insert_or_update/2`.
   """
@@ -964,7 +990,7 @@ defmodule Ecto.Repo.Schema do
   end
 
   defp replace_all_fields!(_kind, schema, to_remove) do
-    {updatable_fields, _} = schema.__schema__(:updatable_fields)
+    {updatable_fields, _} = schema.__schema__(:updatable)
     Enum.map(updatable_fields -- to_remove, &field_source!(schema, &1))
   end
 

lib/ecto/schema.ex

@@ -544,7 +544,8 @@ defmodule Ecto.Schema do
     :where,
     :references,
     :skip_default_validation,
-    :writable
+    :writable,
+    :on_writable_violation
   ]
 
   @doc """
@@ -700,6 +701,13 @@ defmodule Ecto.Schema do
       be further modified, even in an upsert. If set to `:never`, the field becomes
       read only. Defaults to `:always`.
 
+    * `:on_writable_violation` - Defines what action to take when performing an insert or update
+      attempts to modify a field that should not be modified according to it's `:writable` value.
+      Must be one of `:nothing`, `:warn`, or `:raise`. If set to `:nothing`, the modification is
+      silently ignored. If set to `:warn`, the modification is ignored and a warning is logged. If set
+      to `:raise`, an exception is raised and the operation is aborted. If `:writable` is set to `:always`,
+      `:on_writable_violation` must be set to `:nothing`. Defaults to `:nothing`.
+
   """
   defmacro field(name, type \\ :string, opts \\ []) do
     quote do
@@ -2013,6 +2021,7 @@ defmodule Ecto.Schema do
     virtual? = opts[:virtual] || false
     pk? = opts[:primary_key] || false
     writable = opts[:writable] || :always
+    on_writable_violation = opts[:on_writable_violation] || :nothing
     put_struct_field(mod, name, Keyword.get(opts, :default))
 
     redact_field? =
@@ -2069,6 +2078,10 @@ defmodule Ecto.Schema do
         raise ArgumentError, "autogenerated fields must always be writable"
       end
 
+      if writable == :always and on_writable_violation != :nothing do
+        raise ArgumentError, "on_writable_violation must be :nothing for always writable fields"
+      end
+
       if pk? do
         Module.put_attribute(mod, :ecto_primary_keys, name)
       end
@@ -2077,7 +2090,7 @@ defmodule Ecto.Schema do
         Module.put_attribute(mod, :ecto_query_fields, {name, type})
       end
 
-      Module.put_attribute(mod, :ecto_fields, {name, {type, writable}})
+      Module.put_attribute(mod, :ecto_fields, {name, {type, {writable, on_writable_violation}}})
     end
   end
 
@@ -2383,7 +2396,7 @@ defmodule Ecto.Schema do
       end
 
     load =
-      for {name, {type, _writable}} <- fields do
+      for {name, {type, {_writable, _on_writable_violation}}} <- fields do
         if alias = field_sources[name] do
           {name, {:source, alias, type}}
         else
@@ -2392,17 +2405,17 @@ defmodule Ecto.Schema do
       end
 
     dump =
-      for {name, {type, writable}} <- fields do
+      for {name, {type, {writable, _on_writable_violation}}} <- fields do
         {name, {field_sources[name] || name, type, writable}}
       end
 
     field_sources_quoted =
-      for {name, {_type, _writable}} <- fields do
+      for {name, {_type, {_writable, _on_writable_violation}}} <- fields do
         {[:field_source, name], field_sources[name] || name}
       end
 
     types_quoted =
-      for {name, {type, _writable}} <- fields do
+      for {name, {type, {_writable, _on_writable_violation}}} <- fields do
         {[:type, name], Macro.escape(type)}
       end
 
@@ -2426,19 +2439,19 @@ defmodule Ecto.Schema do
     embed_names = Enum.map(embeds, &elem(&1, 0))
 
     updatable =
-      for {name, {_, writable}} <- fields, reduce: {[], []} do
+      for {name, {_, {writable, on_writable_violation}}} <- fields, reduce: {[], []} do
         {keep, drop} ->
           case writable do
             :always -> {[name | keep], drop}
-            _ -> {keep, [name | drop]}
+            _ -> {keep, [{name, on_writable_violation} | drop]}
           end
       end
 
     insertable =
-      for {name, {_, writable}} <- fields, reduce: {[], []} do
+      for {name, {_, {writable, on_writable_violation}}} <- fields, reduce: {[], []} do
         {keep, drop} ->
           case writable do
-            :never -> {keep, [name | drop]}
+            :never -> {keep, [{name, on_writable_violation} | drop]}
             _ -> {[name | keep], drop}
           end
       end
@@ -2448,8 +2461,8 @@ defmodule Ecto.Schema do
       {[:load], load |> Macro.escape()},
       {[:associations], assoc_names},
       {[:embeds], embed_names},
-      {[:updatable_fields], updatable},
-      {[:insertable_fields], insertable},
+      {[:updatable], updatable},
+      {[:insertable], insertable},
       {[:redact_fields], redacted_fields},
       {[:autogenerate_fields], Enum.flat_map(autogenerate, &elem(&1, 0))},
       {[:virtual_fields], Enum.map(virtual_fields, &elem(&1, 0))},

test/ecto/repo_test.exs

@@ -3,6 +3,7 @@ defmodule Ecto.RepoTest do
 
   import Ecto.Query
   import Ecto, only: [put_meta: 2]
+  import ExUnit.CaptureLog
   alias Ecto.TestRepo
 
   defmodule MyParent do
@@ -181,6 +182,26 @@ defmodule Ecto.RepoTest do
     end
   end
 
+  defmodule MySchemaWritableWarn do
+    use Ecto.Schema
+
+    schema "my_schema" do
+      field :never, :integer, writable: :never, on_writable_violation: :warn
+      field :always, :integer, writable: :always
+      field :insert, :integer, writable: :insert, on_writable_violation: :warn
+    end
+  end
+
+  defmodule MySchemaWritableRaise do
+    use Ecto.Schema
+
+    schema "my_schema" do
+      field :never, :integer, writable: :never, on_writable_violation: :raise
+      field :always, :integer, writable: :always
+      field :insert, :integer, writable: :insert, on_writable_violation: :raise
+    end
+  end
+
   defmodule MySchemaOneField do
     use Ecto.Schema
 
@@ -2418,14 +2439,47 @@ defmodule Ecto.RepoTest do
              ]
     end
 
-    test "update only saves changes for writable: :always" do
+    test "update with on_writable_violation: :nothing saves changes for writable: :always and ignores changes for writable: :insert/:never" do
       %MySchemaWritable{id: 1}
       |> Ecto.Changeset.change(%{always: 10, never: 11, insert: 12})
       |> TestRepo.update()
 
       assert_received {:update, %{changes: [always: 10]}}
     end
 
+    test "update with on_writable_violation: :warn saves changes for writable: :always, ignores changes for writable: :insert/:never, and logs a warning" do
+      log = capture_log(fn ->
+        %MySchemaWritableWarn{id: 1}
+        |> Ecto.Changeset.change(%{always: 10, never: 11, insert: 12})
+        |> TestRepo.update()
+
+        assert_received {:update, %{changes: [always: 10]}}
+      end)
+
+      assert log =~ "attempted to write to non-writable field :insert during update"
+      assert log =~ "attempted to write to non-writable field :never during update"
+    end
+
+    test "update with on_writable_violation: :raise saves changes for writable: :always and raises for changes for writable: :insert/:never" do
+      assert_raise ArgumentError, "attempted to write to non-writable field :never during update", fn ->
+        %MySchemaWritableRaise{id: 1}
+        |> Ecto.Changeset.change(%{never: 10})
+        |> TestRepo.update()
+      end
+
+      assert_raise ArgumentError, "attempted to write to non-writable field :insert during update", fn ->
+        %MySchemaWritableRaise{id: 2}
+        |> Ecto.Changeset.change(%{insert: 11})
+        |> TestRepo.update()
+      end
+
+      %MySchemaWritableRaise{id: 3}
+      |> Ecto.Changeset.change(%{always: 12})
+      |> TestRepo.update()
+
+      assert_received {:update, %{changes: [always: 12]}}
+    end
+
     test "update is a no-op when updatable fields are not changed" do
       %MySchemaWritable{id: 1}
       |> Ecto.Changeset.change(%{never: "can't update", insert: "can't update either"})
@@ -2459,7 +2513,7 @@ defmodule Ecto.RepoTest do
                    end
     end
 
-    test "insert only saves changes for writable: :always/:insert" do
+    test "insert with on_writable_violation: :nothing saves changes for writable: :always/:insert and ignores changes for writable: :never" do
       %MySchemaWritable{id: 1}
       |> Ecto.Changeset.change(%{always: 10, never: 11, insert: 12})
       |> TestRepo.insert()
@@ -2468,6 +2522,34 @@ defmodule Ecto.RepoTest do
       assert Enum.sort(inserted_fields) == [always: 10, id: 1, insert: 12]
     end
 
+    test "insert with on_writable_violation: :warn saves changes for writable: :always/:insert, ignores changes for writable: :never, and logs a warning" do
+      log = capture_log(fn ->
+        %MySchemaWritableWarn{id: 1}
+        |> Ecto.Changeset.change(%{always: 10, never: 11, insert: 12})
+        |> TestRepo.insert()
+
+        assert_received {:insert, %{fields: inserted_fields}}
+        assert Enum.sort(inserted_fields) == [always: 10, id: 1, insert: 12]
+      end)
+
+      assert log =~ "attempted to write to non-writable field :never during insert"
+    end
+
+    test "insert with on_writable_violation: :raise saves changes for writable: :always/:insert and raises for changes for writable: :never" do
+      assert_raise ArgumentError, "attempted to write to non-writable field :never during insert", fn ->
+        %MySchemaWritableRaise{id: 1}
+        |> Ecto.Changeset.change(%{never: 10})
+        |> TestRepo.insert()
+      end
+
+      %MySchemaWritableRaise{id: 2}
+      |> Ecto.Changeset.change(%{insert: 11, always: 12})
+      |> TestRepo.insert()
+
+      assert_received {:insert, %{fields: inserted_fields}}
+      assert Enum.sort(inserted_fields) == [always: 12, id: 2, insert: 11]
+    end
+
     test "insert with returning" do
       %MySchemaWritable{id: 1}
       |> Ecto.Changeset.change(%{always: 10, never: 11, insert: 12})