fix client configuration problem

Author: magnetised

README.md

@@ -3,7 +3,7 @@
   <a href="https://hexdocs.pm/phoenix_sync" target="_blank">
     <picture>
       <img alt="Phoenix sync illustration"
-          src="./docs/phoenix-sync.png"
+          src="https://github.com/electric-sql/phoenix_sync/raw/main/docs/phoenix-sync.png"
       />
     </picture>
   </a>
@@ -196,7 +196,7 @@ The available options are:
 
 - `table` (required). The Postgres table name. Be aware of casing and [Postgres's handling of unquoted upper-case names](https://wiki.postgresql.org/wiki/Don%27t_Do_This#Don.27t_use_upper_case_table_or_column_names).
 - `namespace` (optional). The Postgres namespace that the table belongs to. Defaults to `public`.
-- `where` (optional). Filter to apply to the synced data in SQL format, e.g. `where: "amount < 1.23 AND colour in ('red', 'green')`.
+- `where` (optional). Filter to apply to the synced data in SQL syntax, e.g. `where: "amount < 1.23 AND colour in ('red', 'green')`.
 - `columns` (optional). The columns to include in the synced data. By default Electric will include all columns in the table. The column list **must** include all primary keys. E.g. `columns: ["id", "title", "amount"]`.
 - `replica` (optional). By default Electric will only send primary keys + changed columns on updates. Set `replica: :full` to receive the full row, not just the changed columns.
 
@@ -225,6 +225,7 @@ end
 # config/config.exs
 config :phoenix_sync,
   mode: :embedded,
+  env: config_env(),
   repo: MyApp.Repo
 
 # application.ex
@@ -250,6 +251,7 @@ end
 # config/config.exs
 config :phoenix_sync,
   mode: :http,
+  env: config_env(),
   url: "https://api.electric-sql.cloud",
   credentials: [
     secret: "...",    # required
@@ -280,6 +282,7 @@ end
 # config/config.exs
 config :phoenix_sync,
   mode: :http,
+  env: config_env(),
   http: [
     port: 3000,
   ],
@@ -318,11 +321,13 @@ end
 # config/dev.exs
 config :phoenix_sync,
   mode: :embedded,
+  env: config_env(),
   repo: MyApp.Repo
 
 # config/test.esx
 config :phoenix_sync,
   mode: :http,
+  env: config_env(),
   http: [
     port: 3000,
   ],

lib/phoenix/sync/adapter.ex

@@ -3,5 +3,5 @@ defmodule Phoenix.Sync.Adapter do
 
   @callback children(atom(), keyword()) :: {:ok, [Supervisor.child_spec()]} | {:error, String.t()}
   @callback plug_opts(atom(), keyword()) :: keyword() | no_return()
-  @callback client(keyword()) :: {:ok, struct()} | {:error, String.t()}
+  @callback client(atom(), keyword()) :: {:ok, struct()} | {:error, String.t()}
 end

lib/phoenix/sync/application.ex

@@ -3,12 +3,11 @@ defmodule Phoenix.Sync.Application do
 
   require Logger
 
-  @env Mix.env()
   @default_adapter Phoenix.Sync.Electric
 
   @impl true
   def start(_type, _args) do
-    case children() do
+    case children() |> dbg do
       {:ok, children} ->
         Supervisor.start_link(children, strategy: :one_for_one, name: Phoenix.Sync.Supervisor)
 
@@ -40,14 +39,17 @@ defmodule Phoenix.Sync.Application do
 
   @doc false
   def children(opts) when is_list(opts) do
-    children(@env, opts)
+    {adapter, env} = adapter_env(opts)
+
+    apply(adapter, :children, [env, opts])
   end
 
   @doc false
-  def children(env, opts) do
-    adapter = adapter(opts)
-
-    apply(adapter, :children, [env, opts])
+  def adapter_env(opts) do
+    {
+      adapter(),
+      Keyword.get(opts, :env, :prod)
+    }
   end
 
   @doc """
@@ -102,14 +104,9 @@ defmodule Phoenix.Sync.Application do
 
   @doc false
   def plug_opts(opts) when is_list(opts) do
-    plug_opts(@env, opts)
-  end
-
-  @doc false
-  def plug_opts(env, opts) do
-    adapter = adapter(opts)
+    {adapter, env} = adapter_env(opts)
 
-    apply(adapter, :plug_opts, [env, opts])
+    apply(adapter, :plug_opts, [env, opts]) |> dbg
   end
 
   @doc false

lib/phoenix/sync/client.ex

@@ -35,9 +35,9 @@ defmodule Phoenix.Sync.Client do
   Alternatively use `stream/1` which wraps this functionality.
   """
   def new(opts) do
-    adapter = Phoenix.Sync.Application.adapter(opts)
+    {adapter, env} = Phoenix.Sync.Application.adapter_env(opts)
 
-    apply(adapter, :client, [opts])
+    apply(adapter, :client, [env, opts])
   end
 
   def new! do

lib/phoenix/sync/electric.ex

@@ -178,13 +178,13 @@ defmodule Phoenix.Sync.Electric do
 
   @doc false
   @impl Phoenix.Sync.Adapter
-  def client(opts) do
+  def client(env, opts) do
     {mode, electric_opts} = electric_opts(opts)
 
     case mode do
       mode when mode in @client_valid_modes ->
-        electric_opts
-        |> stack_id()
+        env
+        |> core_configuration(electric_opts)
         |> configure_client(mode)
 
       invalid_mode ->
@@ -304,10 +304,20 @@ defmodule Phoenix.Sync.Electric do
   end
 
   defp env_defaults(opts, :dev) do
+    # can't use new tmp dir for every run in dev because the storage
+    # path must remain consistent between invocations of children(), plug_opts()
+    # and client()...
+    # if we want to use emphemeral dir for dev storage then we have to persist
+    # the storage_dir into the application config.
     opts
+    # |> Keyword.put_new(
+    #   :storage_dir,
+    #   Path.join(System.tmp_dir!(), "electric/shape-data#{System.monotonic_time()}")
+    # )
     |> Keyword.put_new(
-      :storage_dir,
-      Path.join(System.tmp_dir!(), "electric/shape-data#{System.monotonic_time()}")
+      :storage,
+      {Electric.ShapeCache.InMemoryStorage,
+       table_base_name: :"electric-storage#{opts[:stack_id]}", stack_id: opts[:stack_id]}
     )
     |> Keyword.put_new(:send_cache_headers?, false)
   end

test/phoenix/sync/application_test.exs

@@ -22,18 +22,19 @@ defmodule Phoenix.Sync.ApplicationTest do
 
   describe "children/1" do
     test "invalid mode" do
-      assert {:error, _} = App.children(:prod, mode: :nonsense)
-      assert {:error, _} = App.children(:prod, [])
+      assert {:error, _} = App.children(mode: :nonsense)
+      assert {:error, _} = App.children([])
     end
 
     test "embedded mode" do
       config = [
         mode: :embedded,
+        env: :prod,
         repo: Support.ConfigTestRepo,
         storage_dir: "/something"
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:prod, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
 
       validate_repo_connection_opts!(opts)
 
@@ -44,20 +45,21 @@ defmodule Phoenix.Sync.ApplicationTest do
     end
 
     test "no configuration set" do
-      assert {:error, _} = App.children(:dev, [])
+      assert {:error, _} = App.children([])
     end
 
     test "disabled mode" do
-      assert {:ok, []} = App.children(:dev, mode: :disabled)
+      assert {:ok, []} = App.children(mode: :disabled)
     end
 
     test "embedded mode dev env" do
       config = [
         mode: :embedded,
+        env: :dev,
         repo: Support.ConfigTestRepo
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:dev, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
 
       validate_repo_connection_opts!(opts)
 
@@ -71,22 +73,24 @@ defmodule Phoenix.Sync.ApplicationTest do
 
     test "only repo config given and electric installed defaults to embedded" do
       config = [
+        env: :dev,
         repo: Support.ConfigTestRepo
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:dev, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
       validate_repo_connection_opts!(opts)
     end
 
     test "embedded mode dev env doesn't overwrite explicit storage_dir" do
       config = [
         mode: :embedded,
+        env: :dev,
         repo: Support.ConfigTestRepo,
         # don't overwrite this explict config
         storage_dir: "/something"
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:dev, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
 
       validate_repo_connection_opts!(opts)
 
@@ -99,11 +103,12 @@ defmodule Phoenix.Sync.ApplicationTest do
     test "embedded mode test env" do
       config = [
         mode: :embedded,
+        env: :test,
         repo: Support.ConfigTestRepo,
         storage_dir: "/something"
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:test, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
 
       validate_repo_connection_opts!(opts)
 
@@ -116,6 +121,7 @@ defmodule Phoenix.Sync.ApplicationTest do
     test "embedded mode with explict connection_opts" do
       config = [
         mode: :embedded,
+        env: :prod,
         connection_opts: [
           username: "postgres",
           hostname: "localhost",
@@ -125,7 +131,7 @@ defmodule Phoenix.Sync.ApplicationTest do
         storage_dir: "/something"
       ]
 
-      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(:prod, config)
+      assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
 
       assert {pass_fun, connection_opts} = Keyword.pop!(opts[:connection_opts], :password)
       assert pass_fun.() == "password"
@@ -145,19 +151,21 @@ defmodule Phoenix.Sync.ApplicationTest do
     test "remote http mode" do
       config = [
         mode: :http,
+        env: :prod,
         url: "https://api.electric-sql.cloud",
         credentials: [
           secret: "my-secret",
           source_id: "my-source-id"
         ]
       ]
 
-      assert {:ok, []} = App.children(:prod, config)
+      assert {:ok, []} = App.children(config)
     end
 
     test "embedded http mode" do
       config = [
         mode: :http,
+        env: :prod,
         repo: Support.ConfigTestRepo,
         url: "http://localhost:4001",
         http: [
@@ -167,7 +175,7 @@ defmodule Phoenix.Sync.ApplicationTest do
       ]
 
       assert {:ok, [{Electric.StackSupervisor, opts}, {Bandit, http_opts}]} =
-               App.children(:prod, config)
+               App.children(config)
 
       validate_repo_connection_opts!(opts)
 
@@ -180,11 +188,12 @@ defmodule Phoenix.Sync.ApplicationTest do
     test "embedded mode" do
       config = [
         mode: :embedded,
+        env: :dev,
         repo: Support.ConfigTestRepo,
         storage_dir: "/something"
       ]
 
-      api = App.plug_opts(:dev, config)
+      api = App.plug_opts(config)
 
       assert %Electric.Shapes.Api{
                storage: {Electric.ShapeCache.FileStorage, %{base_path: "/something" <> _}},
@@ -197,6 +206,7 @@ defmodule Phoenix.Sync.ApplicationTest do
 
       config = [
         mode: :http,
+        env: :prod,
         url: url,
         credentials: [
           secret: "my-secret",
@@ -209,7 +219,7 @@ defmodule Phoenix.Sync.ApplicationTest do
 
       endpoint = URI.new!(url) |> URI.append_path("/v1/shape")
 
-      assert api = App.plug_opts(:prod, config)
+      assert api = App.plug_opts(config)
 
       assert %Phoenix.Sync.Electric.ClientAdapter{
                client: %Electric.Client{
@@ -224,6 +234,7 @@ defmodule Phoenix.Sync.ApplicationTest do
 
       config = [
         mode: :http,
+        env: :prod,
         repo: Support.ConfigTestRepo,
         url: "http://localhost:4000",
         http: [
@@ -234,7 +245,7 @@ defmodule Phoenix.Sync.ApplicationTest do
 
       endpoint = URI.new!(url) |> URI.append_path("/v1/shape")
 
-      assert api = App.plug_opts(:prod, config)
+      assert api = App.plug_opts(config)
 
       assert %Phoenix.Sync.Electric.ClientAdapter{
                client: %Electric.Client{