chore: add tests for new operator overload features

Author: zachdaniel

config/config.exs

@@ -36,10 +36,15 @@ if Mix.env() == :test do
   config :ash_postgres, :ash_domains, [AshPostgres.Test.Domain]
 
   config :ash, :custom_expressions, [
-    AshPostgres.Expressions.TrigramWordSimilarity
+    AshPostgres.Expressions.TrigramWordSimilarity,
+    AshPostgres.Test.OperatorExpression.IntListContains
   ]
 
-  config :ash, :known_types, [AshPostgres.Timestamptz, AshPostgres.TimestamptzUsec]
+  config :ash, :known_types, [
+    AshPostgres.Timestamptz,
+    AshPostgres.TimestamptzUsec,
+    AshPostgres.Test.OperatorExpression.IntListType
+  ]
 
   config :ash_postgres, AshPostgres.TestRepo,
     username: "postgres",

mix.lock

@@ -1,5 +1,5 @@
 %{
-  "ash": {:hex, :ash, "3.21.3", "4cb8b05655664fe65daf6862285f0a6f91991f1a73ff6554b4609a484c1ceb8b", [:mix], [{:crux, ">= 0.1.2 and < 1.0.0-0", [hex: :crux, repo: "hexpm", optional: false]}, {:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.7", [hex: :ecto, repo: "hexpm", optional: false]}, {:ets, "~> 0.8", [hex: :ets, repo: "hexpm", optional: false]}, {:igniter, ">= 0.6.29 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: false]}, {:picosat_elixir, "~> 0.2", [hex: :picosat_elixir, repo: "hexpm", optional: true]}, {:plug, ">= 0.0.0", [hex: :plug, repo: "hexpm", optional: true]}, {:reactor, "~> 1.0", [hex: :reactor, repo: "hexpm", optional: false]}, {:simple_sat, ">= 0.1.1 and < 1.0.0-0", [hex: :simple_sat, repo: "hexpm", optional: true]}, {:spark, ">= 2.6.0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, "~> 0.3", [hex: :splode, repo: "hexpm", optional: false]}, {:stream_data, "~> 1.0", [hex: :stream_data, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.1", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "deec4223f11c7cbf3b35cb14b3c8df50b58b06a5c9f64de539a93469fa249b04"},
+  "ash": {:hex, :ash, "3.23.0", "745a98c8e1f877fd90757637bbf9f1895d01a58516c4dffe634b71b29f86e8ad", [:mix], [{:crux, ">= 0.1.2 and < 1.0.0-0", [hex: :crux, repo: "hexpm", optional: false]}, {:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.7", [hex: :ecto, repo: "hexpm", optional: false]}, {:ets, "~> 0.8", [hex: :ets, repo: "hexpm", optional: false]}, {:igniter, ">= 0.6.29 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: false]}, {:picosat_elixir, "~> 0.2", [hex: :picosat_elixir, repo: "hexpm", optional: true]}, {:plug, ">= 0.0.0", [hex: :plug, repo: "hexpm", optional: true]}, {:reactor, "~> 1.0", [hex: :reactor, repo: "hexpm", optional: false]}, {:simple_sat, ">= 0.1.1 and < 1.0.0-0", [hex: :simple_sat, repo: "hexpm", optional: true]}, {:spark, ">= 2.6.0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, "~> 0.3", [hex: :splode, repo: "hexpm", optional: false]}, {:stream_data, "~> 1.0", [hex: :stream_data, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.1", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "174bc85aa6b4023b39b89dc635011e4fc79dca4d945cf1e079c17b286c1863b7"},
   "ash_sql": {:hex, :ash_sql, "0.5.3", "0151ade6153b5d6ec152dea5c03743d8e468fa4696f3d9796d4d1e0209d200d4", [:mix], [{:ash, "~> 3.7", [hex: :ash, repo: "hexpm", optional: false]}, {:ecto, ">= 3.13.4 and < 4.0.0-0", [hex: :ecto, repo: "hexpm", optional: false]}, {:ecto_sql, "~> 3.9", [hex: :ecto_sql, repo: "hexpm", optional: false]}], "hexpm", "6022d9ae5edfab0b4a5220546200aa5112fff897c980c9f46e49e5e939e5c085"},
   "benchee": {:hex, :benchee, "1.5.0", "4d812c31d54b0ec0167e91278e7de3f596324a78a096fd3d0bea68bb0c513b10", [:mix], [{:deep_merge, "~> 1.0", [hex: :deep_merge, repo: "hexpm", optional: false]}, {:statistex, "~> 1.1", [hex: :statistex, repo: "hexpm", optional: false]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "5b075393aea81b8ae74eadd1c28b1d87e8a63696c649d8293db7c4df3eb67535"},
   "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},

priv/test_repo/migrations/20260405000000_add_custom_any_function.exs

@@ -0,0 +1,16 @@
+defmodule AshPostgres.TestRepo.Migrations.AddCustomAnyFunction do
+  use Ecto.Migration
+
+  def up do
+    execute """
+    CREATE OR REPLACE FUNCTION custom_any(value bigint, arr bigint[])
+    RETURNS boolean AS $$
+      SELECT value = ANY(arr);
+    $$ LANGUAGE SQL IMMUTABLE;
+    """
+  end
+
+  def down do
+    execute "DROP FUNCTION IF EXISTS custom_any(bigint, bigint[]);"
+  end
+end

test/support/operator_expression/int_list_contains.ex

@@ -0,0 +1,28 @@
+defmodule AshPostgres.Test.OperatorExpression.IntListContains do
+  @moduledoc """
+  Custom expression that replaces `value in list` with `value = ANY(array)` in postgres.
+
+  This demonstrates operator_expression/1 rewriting an operator to a custom expression
+  that compiles to a different (potentially more efficient) SQL form.
+  """
+  use Ash.CustomExpression,
+    name: :int_list_contains,
+    arguments: [
+      [:integer, AshPostgres.Test.OperatorExpression.IntListType]
+    ]
+
+  def expression(AshPostgres.DataLayer, [value, list]) do
+    {:ok, expr(fragment("custom_any(?, ?)", ^value, ^list))}
+  end
+
+  def expression(data_layer, [value, list])
+      when data_layer in [Ash.DataLayer.Ets, Ash.DataLayer.Simple] do
+    {:ok, expr(fragment(&__MODULE__.contains/2, ^value, ^list))}
+  end
+
+  def expression(_data_layer, _args), do: :unknown
+
+  def contains(value, list) when is_list(list) do
+    value in list
+  end
+end

test/support/operator_expression/int_list_type.ex

@@ -0,0 +1,52 @@
+defmodule AshPostgres.Test.OperatorExpression.IntListType do
+  @moduledoc """
+  Custom type that overloads the `in` operator and rewrites it to a custom expression
+  via operator_expression/1.
+  """
+  use Ash.Type
+
+  @impl true
+  def storage_type(_), do: {:array, :integer}
+
+  @impl true
+  def cast_input(%MapSet{} = set, constraints), do: cast_input(MapSet.to_list(set), constraints)
+
+  def cast_input(list, _) when is_list(list) do
+    if Enum.all?(list, &is_integer/1), do: {:ok, list}, else: :error
+  end
+
+  def cast_input(nil, _), do: {:ok, nil}
+  def cast_input(_, _), do: :error
+
+  @impl true
+  def cast_stored(value, constraints), do: cast_input(value, constraints)
+
+  @impl true
+  def dump_to_native(value, _) when is_list(value), do: {:ok, value}
+  def dump_to_native(nil, _), do: {:ok, nil}
+  def dump_to_native(_, _), do: :error
+
+  @impl true
+  def operator_overloads do
+    %{
+      in: %{
+        [:integer, __MODULE__] => __MODULE__
+      }
+    }
+  end
+
+  @impl true
+  def evaluate_operator(%Ash.Query.Operator.In{left: left, right: right})
+      when is_list(right) do
+    {:known, left in right}
+  end
+
+  def evaluate_operator(_), do: :unknown
+
+  @impl true
+  def operator_expression(%Ash.Query.Operator.In{}) do
+    {:ok, AshPostgres.Test.OperatorExpression.IntListContains}
+  end
+
+  def operator_expression(_), do: :unknown
+end

test/type_test.exs

@@ -120,4 +120,43 @@ defmodule AshPostgres.Test.TypeTest do
 
     assert updated.response == :awaiting
   end
+
+  test "operator_expression rewrites operator to custom expression" do
+    import ExUnit.CaptureLog
+    import Ash.Expr
+
+    prev = Application.get_env(:ash_postgres, AshPostgres.TestRepo)
+    Application.put_env(:ash_postgres, AshPostgres.TestRepo, Keyword.put(prev, :log, :info))
+
+    try do
+      Post
+      |> Ash.Changeset.for_create(:create, %{title: "low", score: 5})
+      |> Ash.create!()
+
+      Post
+      |> Ash.Changeset.for_create(:create, %{title: "mid", score: 25})
+      |> Ash.create!()
+
+      Post
+      |> Ash.Changeset.for_create(:create, %{title: "high", score: 50})
+      |> Ash.create!()
+
+      range = Enum.to_list(20..30)
+
+      log =
+        capture_log(fn ->
+          results =
+            Post
+            |> Ash.Query.filter(expr(score in ^range))
+            |> Ash.read!()
+
+          assert length(results) == 1
+          assert hd(results).title == "mid"
+        end)
+
+      assert log =~ "custom_any("
+    after
+      Application.put_env(:ash_postgres, AshPostgres.TestRepo, prev)
+    end
+  end
 end