allow different verion_schema and tracked_schemas for different ecto repo

Author: KaFai Choi

config/test.exs

@@ -12,14 +12,17 @@ config :ex_audit, ExAudit.Test.Repo,
 config :logger, level: :info
 
 config :ex_audit,
-  ecto_repos: [ExAudit.Test.Repo],
-  version_schema: ExAudit.Test.Version,
-  tracked_schemas: [
-    ExAudit.Test.User,
-    ExAudit.Test.BlogPost,
-    ExAudit.Test.BlogPost.Section,
-    ExAudit.Test.Comment
-  ],
+  ecto_repos: %{
+    ExAudit.Test.Repo => %{
+      version_schema: ExAudit.Test.Version,
+      tracked_schemas: [
+        ExAudit.Test.User,
+        ExAudit.Test.BlogPost,
+        ExAudit.Test.BlogPost.Section,
+        ExAudit.Test.Comment
+      ]
+    }
+  },
   primitive_structs: [
     Date
   ]

lib/repo/queryable.ex

@@ -1,14 +1,7 @@
 defmodule ExAudit.Queryable do
   require Logger
-
   import Ecto.Query, only: [from: 2, where: 3]
 
-  defp version_schema() do
-    Application.get_env(:ex_audit, :version_schema)
-  end
-
-  @compile {:inline, version_schema: 0}
-
   def update_all(module, queryable, updates, opts) do
     Ecto.Repo.Queryable.update_all(module, queryable, updates, opts)
   end
@@ -20,7 +13,7 @@ defmodule ExAudit.Queryable do
   def history(module, struct, opts) do
     query =
       from(
-        v in version_schema(),
+        v in version_schema(module),
         order_by: [desc: :recorded_at]
       )
 
@@ -64,7 +57,7 @@ defmodule ExAudit.Queryable do
 
       versions ++
         [
-          struct(version_schema(), %{
+          struct(version_schema(module), %{
             id: oldest_id
           })
           |> Map.put(:original, empty_map_to_nil(oldest_struct))
@@ -92,7 +85,7 @@ defmodule ExAudit.Queryable do
 
     query =
       from(
-        v in version_schema(),
+        v in version_schema(module),
         where: v.entity_id == ^version.entity_id,
         where: v.entity_schema == ^version.entity_schema,
         where: v.recorded_at >= ^version.recorded_at,
@@ -185,4 +178,8 @@ defmodule ExAudit.Queryable do
   defp reverse_action(:updated), do: :updated
   defp reverse_action(:created), do: :deleted
   defp reverse_action(:deleted), do: :created
+
+  defp version_schema(repo_module) do
+    Application.get_env(:ex_audit, :ecto_repos) |> get_in([repo_module, :version_schema])
+  end
 end

lib/repo/repo.ex

@@ -74,8 +74,10 @@ defmodule ExAudit.Repo do
           end
         ```
       """
-      def tracked?(struct_or_changeset) do
-        tracked_schemas = Application.get_env(:ex_audit, :tracked_schemas, [])
+      @compile {:inline, tracked?: 2}
+
+      defp tracked?(repo_module, struct_or_changeset) do
+        tracked_schemas = ExAudit.Tracking.tracked_schemas(repo_module)
 
         schema =
           case struct_or_changeset do
@@ -89,14 +91,11 @@ defmodule ExAudit.Repo do
         schema in tracked_schemas
       end
 
-      @compile {:inline, tracked?: 1}
-
-      defoverridable(tracked?: 1)
-
+      defoverridable(tracked?: 2)
       def insert(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.insert(
             __MODULE__,
             repo,
@@ -111,7 +110,7 @@ defmodule ExAudit.Repo do
       def update(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.update(
             __MODULE__,
             repo,
@@ -126,7 +125,7 @@ defmodule ExAudit.Repo do
       def insert_or_update(changeset, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(changeset) do
+        if tracked?(__MODULE__, changeset) do
           ExAudit.Schema.insert_or_update(
             __MODULE__,
             repo,
@@ -141,7 +140,7 @@ defmodule ExAudit.Repo do
       def delete(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.delete(
             __MODULE__,
             repo,
@@ -156,7 +155,7 @@ defmodule ExAudit.Repo do
       def insert!(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.insert!(
             __MODULE__,
             repo,
@@ -171,7 +170,7 @@ defmodule ExAudit.Repo do
       def update!(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.update!(
             __MODULE__,
             repo,
@@ -186,7 +185,7 @@ defmodule ExAudit.Repo do
       def insert_or_update!(changeset, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(changeset) do
+        if tracked?(__MODULE__, changeset) do
           ExAudit.Schema.insert_or_update!(
             __MODULE__,
             repo,
@@ -201,7 +200,7 @@ defmodule ExAudit.Repo do
       def delete!(struct, opts) do
         repo = get_dynamic_repo()
 
-        if tracked?(struct) do
+        if tracked?(__MODULE__, struct) do
           ExAudit.Schema.delete!(
             __MODULE__,
             repo,

lib/repo/schema.ex

@@ -1,5 +1,6 @@
 defmodule ExAudit.Schema do
   require Logger
+
   def insert_all(module, name, schema_or_source, entries, tuplet = {_adapter_meta, opts}) do
     # TODO!
     opts = augment_opts(opts)
@@ -32,7 +33,7 @@ defmodule ExAudit.Schema do
 
       case result do
         {:ok, resulting_struct} ->
-            track_change(module, :updated, struct, resulting_struct, opts)
+          track_change(module, :updated, struct, resulting_struct, opts)
 
         _ ->
           :ok

lib/repo/schema_type.ex

@@ -39,7 +39,9 @@ defmodule ExAudit.Type.Schema do
 
   def type, do: :string
 
-  defp schemas do
-    Application.get_env(:ex_audit, :tracked_schemas, [])
+  defp schemas() do
+    Application.get_env(:ex_audit, :ecto_repos)
+    |> Map.values()
+    |> Enum.flat_map(& &1.tracked_schemas)
   end
 end

lib/tracking/tracking.ex

@@ -1,5 +1,5 @@
 defmodule ExAudit.Tracking do
-  def find_changes(action, struct_or_changeset, resulting_struct) do
+  def find_changes(module, action, struct_or_changeset, resulting_struct) do
     old =
       case {action, struct_or_changeset} do
         {:created, _} -> %{}
@@ -17,13 +17,13 @@ defmodule ExAudit.Tracking do
           %{}
       end
 
-    compare_versions(action, old, new)
+    compare_versions(module, action, old, new)
   end
 
-  def compare_versions(action, old, new) do
+  def compare_versions(module, action, old, new) do
     schema = Map.get(old, :__struct__, Map.get(new, :__struct__))
 
-    if schema in tracked_schemas() do
+    if schema in tracked_schemas(module) do
       assocs = schema.__schema__(:associations)
 
       patch =
@@ -53,7 +53,7 @@ defmodule ExAudit.Tracking do
 
   def track_change(module, action, changeset, resulting_struct, opts) do
     if not Keyword.get(opts, :ignore_audit, false) do
-      changes = find_changes(action, changeset, resulting_struct)
+      changes = find_changes(module, action, changeset, resulting_struct)
 
       insert_versions(module, changes, opts)
     end
@@ -85,7 +85,7 @@ defmodule ExAudit.Tracking do
 
       _ ->
         opts = Keyword.drop(opts, [:on_conflict, :conflict_target])
-        module.insert_all(version_schema(), changes, opts)
+        module.insert_all(version_schema(module), changes, opts)
     end
   end
 
@@ -109,7 +109,7 @@ defmodule ExAudit.Tracking do
       root ++ Enum.map(root, &find_assoc_deletion(module, &1, repo_opts))
     end)
     |> List.flatten()
-    |> Enum.flat_map(&compare_versions(:deleted, &1, %{}))
+    |> Enum.flat_map(&compare_versions(module, :deleted, &1, %{}))
   end
 
   def track_assoc_deletion(module, struct, opts) do
@@ -118,11 +118,11 @@ defmodule ExAudit.Tracking do
     insert_versions(module, deleted_structs, opts)
   end
 
-  defp tracked_schemas do
-    Application.get_env(:ex_audit, :tracked_schemas, [])
+  def tracked_schemas(repo_module) do
+    Application.get_env(:ex_audit, :ecto_repos) |> get_in([repo_module, :tracked_schemas])
   end
 
-  defp version_schema do
-    Application.get_env(:ex_audit, :version_schema)
+  defp version_schema(repo_module) do
+    Application.get_env(:ex_audit, :ecto_repos) |> get_in([repo_module, :version_schema])
   end
 end