elixir-client: Add support for more Ecto field types

magnetised · magnetised · commit 1bdb1c58aa33 · 2025-06-12T15:53:58.000+01:00
including:

- {:array, type}
- :map
- :bitstring
- :binary
diff --git a/packages/elixir-client/lib/electric/client/ecto_adapter.ex b/packages/elixir-client/lib/electric/client/ecto_adapter.ex
@@ -3,6 +3,7 @@ if Code.ensure_loaded?(Ecto) do
     @moduledoc false
 
     alias Electric.Client.ShapeDefinition
+    alias Electric.Client.EctoAdapter.ArrayDecoder
 
     @behaviour Electric.Client.ValueMapper
 
@@ -164,7 +165,8 @@ if Code.ensure_loaded?(Ecto) do
       )
     end
 
-    defp cast_to(:boolean) do
+    @doc false
+    def cast_to(:boolean) do
       fn
         nil -> nil
         "t" -> true
@@ -173,7 +175,7 @@ if Code.ensure_loaded?(Ecto) do
       end
     end
 
-    defp cast_to({:parameterized, {_, _}} = type) do
+    def cast_to({:parameterized, {_, _}} = type) do
       fn
         nil ->
           nil
@@ -192,7 +194,14 @@ if Code.ensure_loaded?(Ecto) do
       end
     end
 
-    defp cast_to(type) when is_atom(type) do
+    def cast_to({:array, type}) do
+      fn
+        nil -> nil
+        value -> ArrayDecoder.decode!(value, type)
+      end
+    end
+
+    def cast_to(type) when is_atom(type) do
       with {:module, _} <- Code.ensure_loaded(type),
            true <- function_exported?(type, :type, 0),
            true <- function_exported?(type, :load, 1) do
@@ -207,6 +216,18 @@ if Code.ensure_loaded?(Ecto) do
 
     defp cast_ecto(_type, nil), do: nil
 
+    defp cast_ecto(:map, value) do
+      Jason.decode!(value)
+    end
+
+    defp cast_ecto(:bitstring, value) when is_binary(value) do
+      <<String.to_integer(value, 2)::size(byte_size(value))>>
+    end
+
+    defp cast_ecto(:binary, "\\x" <> value) when is_binary(value) do
+      Base.decode16!(value, case: :lower)
+    end
+
     defp cast_ecto(type, value) do
       Ecto.Type.cast!(type, value)
     end
diff --git a/packages/elixir-client/lib/electric/client/ecto_adapter/array_decoder.ex b/packages/elixir-client/lib/electric/client/ecto_adapter/array_decoder.ex
@@ -0,0 +1,94 @@
+defmodule Electric.Client.EctoAdapter.ArrayDecoder do
+  alias Electric.Client.EctoAdapter
+
+  def decode!("{}", _type), do: []
+
+  def decode!(encoded_array, type) when is_binary(encoded_array) do
+    {"", [result]} = decode_array(encoded_array, [], {EctoAdapter.cast_to(type), encoded_array})
+
+    result
+  end
+
+  ##############################
+
+  defp decode_array("", acc, _state) do
+    {"", :lists.reverse(acc)}
+  end
+
+  defp decode_array(<<"{}", rest::bitstring>>, acc, state) do
+    decode_array(rest, [[] | acc], state)
+  end
+
+  defp decode_array(<<"{", rest::bitstring>>, acc, state) do
+    {rest, array} = decode_array(rest, [], state)
+    decode_array(rest, [array | acc], state)
+  end
+
+  defp decode_array(<<"}", rest::bitstring>>, acc, _state) do
+    {rest, :lists.reverse(acc)}
+  end
+
+  defp decode_array(<<?,, rest::bitstring>>, acc, state) do
+    decode_array(rest, acc, state)
+  end
+
+  defp decode_array(<<?", rest::bitstring>>, acc, state) do
+    {rest, elem} = decode_quoted_elem(rest, [], state)
+    decode_array(rest, [elem | acc], state)
+  end
+
+  defp decode_array(rest, acc, state) do
+    {rest, elem} = decode_elem(rest, [], state)
+    decode_array(rest, [elem | acc], state)
+  end
+
+  ##############################
+
+  defp decode_elem(<<",", _::bitstring>> = rest, acc, state),
+    do: {rest, cast(acc, state)}
+
+  defp decode_elem(<<"{", rest::bitstring>>, [], state),
+    do: decode_array(rest, [], state)
+
+  defp decode_elem(<<"}", _::bitstring>> = rest, acc, state),
+    do: {rest, cast(acc, state)}
+
+  defp decode_elem(<<c::utf8, rest::bitstring>>, acc, state),
+    do: decode_elem(rest, [acc | <<c::utf8>>], state)
+
+  defp decode_elem("", _acc, {_cast_fun, source}) do
+    raise "malformed array #{inspect(source)}"
+  end
+
+  ##############################
+
+  defp decode_quoted_elem(<<?", rest::bitstring>>, acc, state),
+    do: {rest, cast_quoted(acc, state)}
+
+  defp decode_quoted_elem(<<"\\\"", rest::bitstring>>, acc, state),
+    do: decode_quoted_elem(rest, [acc | [?"]], state)
+
+  defp decode_quoted_elem(<<c::utf8, rest::bitstring>>, acc, state),
+    do: decode_quoted_elem(rest, [acc | <<c::utf8>>], state)
+
+  defp decode_quoted_elem("", _acc, {_cast_fun, source}) do
+    raise "malformed array #{inspect(source)}"
+  end
+
+  ##############################
+
+  defp cast(iodata, {cast_fun, _source}) do
+    iodata
+    |> IO.iodata_to_binary()
+    |> case do
+      "NULL" -> nil
+      value -> cast_fun.(value)
+    end
+  end
+
+  defp cast_quoted(iodata, {cast_fun, _source}) do
+    iodata
+    |> IO.iodata_to_binary()
+    |> cast_fun.()
+  end
+end
diff --git a/packages/elixir-client/test/electric/client/ecto_adapter/array_decoder_test.exs b/packages/elixir-client/test/electric/client/ecto_adapter/array_decoder_test.exs
@@ -0,0 +1,62 @@
+defmodule Electric.Client.EctoAdapter.ArrayDecoderTest do
+  use ExUnit.Case, async: true
+  alias Electric.Client.EctoAdapter.ArrayDecoder
+
+  test "simple string arrays" do
+    assert ArrayDecoder.decode!(~s[{}], :string) == []
+    assert ArrayDecoder.decode!(~s[{a,b,c}], :string) == ["a", "b", "c"]
+    assert ArrayDecoder.decode!(~s[{"a","b","c"}], :string) == ["a", "b", "c"]
+    assert ArrayDecoder.decode!(~s[{"a{}","b","c"}], :string) == ["a{}", "b", "c"]
+    assert ArrayDecoder.decode!(~S[{"a\"","b","c"}], :string) == ["a\"", "b", "c"]
+
+    assert ArrayDecoder.decode!(~S[{"this isn't here","b","c"}], :string) == [
+             "this isn't here",
+             "b",
+             "c"
+           ]
+
+    assert ArrayDecoder.decode!(~S[{NULL,NULL,"NULL"}], :string) == [nil, nil, "NULL"]
+  end
+
+  test "nested string arrays" do
+    assert ArrayDecoder.decode!(~s[{{},{}}], :string) == [[], []]
+
+    assert ArrayDecoder.decode!(~s[{{"a","b","c"},{},{c,d,e}], :string) == [
+             ["a", "b", "c"],
+             [],
+             ["c", "d", "e"]
+           ]
+  end
+
+  test "simple integer arrays" do
+    assert ArrayDecoder.decode!(~s[{}], :integer) == []
+    assert ArrayDecoder.decode!(~s[{1,2,3}], :integer) == [1, 2, 3]
+    assert ArrayDecoder.decode!(~S[{NULL,NULL,23}], :integer) == [nil, nil, 23]
+  end
+
+  test "nested integer arrays" do
+    assert ArrayDecoder.decode!(~s[{{},{}}], :integer) == [[], []]
+
+    assert ArrayDecoder.decode!(~s[{{1,2,3},{},{4,5,6}], :integer) == [
+             [1, 2, 3],
+             [],
+             [4, 5, 6]
+           ]
+
+    assert ArrayDecoder.decode!(~s[{{{1,{2,{7,8}},3},{},{4,5,6}}], :integer) == [
+             [
+               [1, [2, [7, 8]], 3],
+               [],
+               [4, 5, 6]
+             ]
+           ]
+  end
+
+  test "nested jsonb arrays" do
+    assert ArrayDecoder.decode!(~s[{{{"{\\\"this\\\":4}"},"{}"},{},{"{}","{}"}], :map) == [
+             [[%{"this" => 4}], %{}],
+             [],
+             [%{}, %{}]
+           ]
+  end
+end
diff --git a/packages/elixir-client/test/electric/client/ecto_adapter_test.exs b/packages/elixir-client/test/electric/client/ecto_adapter_test.exs
