Refactor EctoTrail for better performance and idiomatic Elixir

README.md

@@ -29,7 +29,7 @@ defmodule EctoTrail.TestRepo.Migrations.CreateAuditLogTable do
   @moduledoc false
   use Ecto.Migration
 
-  @table_name String.to_atom(Application.fetch_env!(:ecto_trail, :table_name))
+  @table_name String.to_atom(Application.compile_env(:ecto_trail, :table_name, "audit_log"))
 
   def change(table_name \\ @table_name) do
     EctoTrailChangeEnum.create_type

benchmark/README.md

@@ -0,0 +1,67 @@
+# EctoTrail Performance Benchmarks
+
+This directory contains tools to measure the performance of EctoTrail operations and compare different branches.
+
+## Benchmark Script
+
+The `ecto_trail_benchmark.exs` script tests various EctoTrail operations:
+
+1. Simple insert (small changeset)
+2. Complex insert (large changeset with embeds and associations)
+3. Simple update (small changeset)
+4. Complex update (large changeset)
+5. Delete operation
+6. Bulk operations (multiple items)
+7. Insert with redacted fields
+8. Tests with different actor_id data types (string, atom, integer)
+
+Each operation is benchmarked for execution time and memory usage.
+
+## Running Benchmarks
+
+### Option 1: Run on current branch only
+
+```bash
+mix run benchmark/ecto_trail_benchmark.exs
+```
+
+This will run the benchmark on your current branch and output results to the console and an HTML file.
+
+### Option 2: Compare two branches
+
+Use the comparison script to automatically benchmark both the main branch and your optimized branch:
+
+```bash
+./benchmark/compare_branches.sh your-branch-name
+```
+
+For example:
+
+```bash
+./benchmark/compare_branches.sh acrogenesis/updates-n-warnings
+```
+
+This will:
+1. Run benchmarks on the main branch
+2. Run benchmarks on your optimized branch
+3. Save console output to text files
+4. Save HTML reports for detailed analysis
+5. Return to your original branch
+
+## Interpreting Results
+
+The benchmark results include:
+
+- **Average time**: Average execution time per operation
+- **ips**: Iterations per second (higher is better)
+- **Comparison**: Relative performance between scenarios
+- **Memory usage**: Memory consumption per operation
+
+Look for improvements in both execution time (speed) and memory usage between branches.
+
+## Tips for Fair Comparison
+
+- Run benchmarks when your system is not under heavy load
+- Close other applications that might consume system resources
+- Run multiple times to account for variance
+- Focus on the relative differences rather than absolute values

benchmark/compare_branches.sh

@@ -0,0 +1,68 @@
+#!/bin/bash
+# Script to compare EctoTrail performance between branches
+
+# Check if branch name is provided
+if [ -z "$1" ]; then
+  echo "Usage: $0 <optimized_branch_name>"
+  echo "Example: $0 acrogenesis/updates-n-warnings"
+  exit 1
+fi
+
+OPTIMIZED_BRANCH=$1
+MAIN_BRANCH="main"
+CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+
+# Create results directory
+mkdir -p benchmark_results
+
+echo "========================================================"
+echo "Running performance comparison between branches:"
+echo "Main branch: $MAIN_BRANCH"
+echo "Optimized branch: $OPTIMIZED_BRANCH"
+echo "========================================================"
+
+# Function to run benchmark on a branch
+run_benchmark() {
+  BRANCH=$1
+  RESULT_FILE=$2
+
+  echo "Switching to $BRANCH branch..."
+  git checkout $BRANCH
+
+  echo "Getting dependencies..."
+  mix deps.get
+
+  echo "Compiling..."
+  mix compile
+
+  echo "Running benchmark..."
+  mix run benchmark/ecto_trail_benchmark.exs >$RESULT_FILE
+
+  # Extract the HTML result and copy it
+  cp benchmark_results.html $RESULT_FILE.html
+}
+
+# Run benchmarks on main branch
+echo "========================================================"
+echo "Running benchmark on $MAIN_BRANCH branch..."
+echo "========================================================"
+run_benchmark $MAIN_BRANCH "benchmark_results/main_results.txt"
+
+# Run benchmarks on optimized branch
+echo "========================================================"
+echo "Running benchmark on $OPTIMIZED_BRANCH branch..."
+echo "========================================================"
+run_benchmark $OPTIMIZED_BRANCH "benchmark_results/optimized_results.txt"
+
+# Return to original branch
+echo "Returning to original branch: $CURRENT_BRANCH"
+git checkout $CURRENT_BRANCH
+
+echo "========================================================"
+echo "Benchmark results saved to:"
+echo "Main branch: benchmark_results/main_results.txt"
+echo "Main branch HTML: benchmark_results/main_results.txt.html"
+echo "Optimized branch: benchmark_results/optimized_results.txt"
+echo "Optimized branch HTML: benchmark_results/optimized_results.txt.html"
+echo "========================================================"
+echo "You can open the HTML files to see detailed comparisons."

benchmark/ecto_trail_benchmark.exs

@@ -0,0 +1,174 @@
+# Usage: mix run benchmark/ecto_trail_benchmark.exs
+# Compare with main branch by running the same script on both branches
+
+# Enable test environment
+Mix.env(:test)
+
+# Start the test repo
+Application.ensure_all_started(:postgrex)
+Application.ensure_all_started(:ecto)
+
+alias EctoTrail.TestRepo
+alias Ecto.Changeset
+
+# Ensure the repo is started and create tables
+TestRepo.start_link()
+
+defmodule EctoTrailBench do
+  @moduledoc """
+  Performance benchmarks for EctoTrail operations.
+  """
+
+  def setup do
+    # Clean up any existing data
+    cleanup()
+
+    # Create test data
+    create_test_resources()
+  end
+
+  def cleanup do
+    # Drop and recreate tables
+    Enum.each(
+      ~w(audit_log resources categories comments),
+      fn table ->
+        TestRepo.query!("TRUNCATE #{table} RESTART IDENTITY CASCADE")
+      end
+    )
+  end
+
+  def create_test_resources do
+    # Create test resources of various sizes for benchmarking
+    Enum.each(1..100, fn i ->
+      %Resource{name: "Resource #{i}"}
+      |> TestRepo.insert!()
+    end)
+  end
+
+  # Benchmark scenarios
+
+  # 1. Simple insert with a small changeset
+  def simple_insert(actor_id) do
+    %Resource{}
+    |> Changeset.change(%{name: "Simple Insert Test"})
+    |> TestRepo.insert_and_log(actor_id)
+  end
+
+  # 2. Insert with a large changeset
+  def complex_insert(actor_id) do
+    attrs = %{
+      name: "Complex Insert Test",
+      array: Enum.map(1..50, &"Item #{&1}"),
+      map: Enum.into(1..50, %{}, fn i -> {"key_#{i}", "value_#{i}"} end),
+      data: %{key1: "Large value 1", key2: "Large value 2"},
+      category: %{"title" => "Test Category"},
+      comments: Enum.map(1..20, fn i -> %{"title" => "Comment #{i}"} end),
+      items: Enum.map(1..20, fn i -> %{name: "Item #{i}"} end)
+    }
+
+    %Resource{}
+    |> Changeset.cast(attrs, [:name, :array, :map])
+    |> Changeset.cast_embed(:data, with: &Resource.embed_changeset/2)
+    |> Changeset.cast_embed(:items, with: &Resource.embeds_many_changeset/2)
+    |> Changeset.cast_assoc(:category)
+    |> Changeset.cast_assoc(:comments)
+    |> TestRepo.insert_and_log(actor_id)
+  end
+
+  # 3. Update with a small changeset
+  def simple_update(actor_id) do
+    resource = TestRepo.get(Resource, 1)
+
+    resource
+    |> Changeset.change(%{name: "Updated Simple #{:rand.uniform(1000)}"})
+    |> TestRepo.update_and_log(actor_id)
+  end
+
+  # 4. Update with a large changeset
+  def complex_update(actor_id) do
+    resource = TestRepo.get(Resource, 2)
+
+    attrs = %{
+      name: "Updated Complex #{:rand.uniform(1000)}",
+      array: Enum.map(1..50, &"Updated Item #{&1}"),
+      map: Enum.into(1..50, %{}, fn i -> {"updated_key_#{i}", "updated_value_#{i}"} end)
+    }
+
+    resource
+    |> Changeset.cast(attrs, [:name, :array, :map])
+    |> TestRepo.update_and_log(actor_id)
+  end
+
+  # 5. Delete operation
+  def delete_resource(actor_id) do
+    resource = TestRepo.get(Resource, 3)
+    TestRepo.delete_and_log(resource, actor_id)
+  end
+
+  # 6. Bulk operations (10 items)
+  def bulk_operations(actor_id) do
+    resources = TestRepo.all(Resource, limit: 10)
+    changes = Enum.map(resources, fn _ -> %{updated_at: DateTime.utc_now()} end)
+    TestRepo.log_bulk(resources, changes, actor_id, :update)
+  end
+
+  # 7. Insert with redacted fields
+  def insert_with_redaction(actor_id) do
+    %Resource{}
+    |> Changeset.change(%{
+      name: "Redaction Test",
+      password: "secret_password_#{:rand.uniform(1000)}"
+    })
+    |> TestRepo.insert_and_log(actor_id)
+  end
+
+  # 8. Test with different data types for actor_id
+  def insert_with_atom_actor(actor_id) when is_atom(actor_id) do
+    %Resource{}
+    |> Changeset.change(%{name: "Atom Actor Test"})
+    |> TestRepo.insert_and_log(actor_id)
+  end
+
+  def insert_with_integer_actor(actor_id) when is_integer(actor_id) do
+    %Resource{}
+    |> Changeset.change(%{name: "Integer Actor Test"})
+    |> TestRepo.insert_and_log(actor_id)
+  end
+end
+
+# Setup benchmark data
+IO.puts("Setting up benchmark data...")
+EctoTrailBench.setup()
+
+# Run the benchmarks
+IO.puts("Running EctoTrail performance benchmarks...")
+
+Benchee.run(
+  %{
+    "Simple insert" => fn -> EctoTrailBench.simple_insert("user_1") end,
+    "Complex insert" => fn -> EctoTrailBench.complex_insert("user_2") end,
+    "Simple update" => fn -> EctoTrailBench.simple_update("user_3") end,
+    "Complex update" => fn -> EctoTrailBench.complex_update("user_4") end,
+    "Delete operation" => fn -> EctoTrailBench.delete_resource("user_5") end,
+    "Bulk operations" => fn -> EctoTrailBench.bulk_operations("user_6") end,
+    "Insert with redaction" => fn -> EctoTrailBench.insert_with_redaction("user_7") end,
+    "Insert with atom actor" => fn -> EctoTrailBench.insert_with_atom_actor(:user_8) end,
+    "Insert with integer actor" => fn -> EctoTrailBench.insert_with_integer_actor(9) end
+  },
+  time: 5,
+  memory_time: 2,
+  warmup: 1,
+  formatters: [
+    Benchee.Formatters.Console,
+    {Benchee.Formatters.HTML, file: "benchmark_results.html", auto_open: false}
+  ],
+  print: [
+    benchmarking: true,
+    configuration: true,
+    fast_warning: true
+  ]
+)
+
+# Clean up after benchmarks
+IO.puts("Cleaning up benchmark data...")
+EctoTrailBench.cleanup()

config/config.exs

@@ -1,3 +1,3 @@
-use Mix.Config
+import Config
 
 config :ecto_trail, table_name: "audit_log", redacted_fields: [:password]

lib/ecto_trail/changelog.ex

@@ -4,7 +4,8 @@ defmodule EctoTrail.Changelog do
   """
   use Ecto.Schema
 
-  schema Application.fetch_env!(:ecto_trail, :table_name) do
+  @table_name Application.compile_env(:ecto_trail, :table_name, "audit_log")
+  schema @table_name do
     field(:actor_id, :string)
     field(:resource, :string)
     field(:resource_id, :string)