Add default port to pg config if none set (#8)

Fixes #1

Author: magnetised

.github/workflows/elixir_tests.yml

@@ -18,9 +18,29 @@ jobs:
     runs-on: ubuntu-latest
     env:
       MIX_ENV: test
+
+    services:
+      postgres:
+        image: "postgres:17-alpine"
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: electric
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 54321:5432
+
     steps:
       - uses: actions/checkout@v4
 
+      - name: "Set PG settings"
+        run: |
+          docker exec ${{ job.services.postgres.id }} sh -c 'echo "wal_level=logical" >> /var/lib/postgresql/data/postgresql.conf'
+          docker restart ${{ job.services.postgres.id }}
+
       - uses: erlef/setup-beam@v1
         with:
           version-type: strict

README.md

@@ -367,7 +367,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 format, 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.
 

config/test.exs

@@ -24,9 +24,8 @@ config :phoenix_sync, Support.ConfigTestRepo,
   password: "password",
   hostname: "localhost",
   database: "electric",
-  port: 54321,
+  # phoenix_sync should fill in default port
+  # port: 54321,
   stacktrace: true,
   show_sensitive_data_on_connection_error: true,
-  ssl: true,
-  socket_options: [:inet6],
   pool_size: 10

lib/phoenix/sync.ex

@@ -10,7 +10,7 @@ defmodule Phoenix.Sync do
   @type shape_definition ::
           String.t()
           | Ecto.Queryable.t()
-          | shape_definition()
+          | shape_specification()
   @type param_override ::
           {:namespace, String.t()}
           | {:table, String.t()}
@@ -19,6 +19,7 @@ defmodule Phoenix.Sync do
   @type param_overrides :: [param_override()]
 
   defdelegate plug_opts(), to: Phoenix.Sync.Application
+  defdelegate plug_opts(config), to: Phoenix.Sync.Application
 
   defdelegate client!(), to: Phoenix.Sync.Client, as: :new!
 

lib/phoenix/sync/electric.ex

@@ -408,6 +408,7 @@ defmodule Phoenix.Sync.Electric do
     |> Keyword.take(expected_keys)
     |> Keyword.merge(ssl_opts)
     |> Keyword.merge(tcp_opts)
+    |> Keyword.put_new(:port, 5432)
   end
 
   defp http_mode_plug_opts(electric_config) do

test/phoenix/sync/application_test.exs

@@ -5,19 +5,42 @@ defmodule Phoenix.Sync.ApplicationTest do
 
   Code.ensure_loaded!(Support.ConfigTestRepo)
 
-  defp validate_repo_connection_opts!(opts) do
+  defp validate_repo_connection_opts!(opts, overrides \\ []) do
     assert {pass_fun, connection_opts} = Keyword.pop!(opts[:connection_opts], :password)
 
     assert pass_fun.() == "password"
 
-    assert connection_opts == [
-             username: "postgres",
-             hostname: "localhost",
-             database: "electric",
-             port: 54321,
-             sslmode: :require,
-             ipv6: true
-           ]
+    base_opts = [
+      username: "postgres",
+      hostname: "localhost",
+      database: "electric",
+      port: 5432,
+      sslmode: :disable
+    ]
+
+    expected_opts = Keyword.merge(base_opts, overrides)
+
+    assert Enum.sort(connection_opts) == Enum.sort(expected_opts)
+  end
+
+  defp with_modified_config(repo_config_overrides, fun) do
+    original_config = Application.get_env(:phoenix_sync, Support.ConfigTestRepo, [])
+
+    try do
+      Application.put_env(
+        :phoenix_sync,
+        Support.ConfigTestRepo,
+        Keyword.merge(original_config, repo_config_overrides)
+      )
+
+      fun.()
+    after
+      Application.put_env(
+        :phoenix_sync,
+        Support.ConfigTestRepo,
+        original_config
+      )
+    end
   end
 
   describe "children/1" do
@@ -75,6 +98,42 @@ defmodule Phoenix.Sync.ApplicationTest do
              } = Map.new(opts)
     end
 
+    test "passes repo pg port to electric" do
+      config = [
+        env: :dev,
+        repo: Support.ConfigTestRepo
+      ]
+
+      repo_override = [port: 6543]
+
+      with_modified_config(repo_override, fn ->
+        assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
+
+        validate_repo_connection_opts!(opts, repo_override)
+      end)
+    end
+
+    test "maps repo ssl and ipv6 settings to electric" do
+      config = [
+        env: :dev,
+        repo: Support.ConfigTestRepo
+      ]
+
+      repo_override = [
+        ssl: true,
+        socket_options: [:inet6]
+      ]
+
+      with_modified_config(repo_override, fn ->
+        assert {:ok, [{Electric.StackSupervisor, opts}]} = App.children(config)
+
+        validate_repo_connection_opts!(opts,
+          sslmode: :require,
+          ipv6: true
+        )
+      end)
+    end
+
     test "only repo config given and electric installed defaults to embedded" do
       config = [
         env: :dev,

test/support/repo.ex

@@ -4,7 +4,6 @@ defmodule Support.Repo do
     adapter: Ecto.Adapters.Postgres
 end
 
-
 defmodule Support.ConfigTestRepo do
   use Ecto.Repo,
     otp_app: :phoenix_sync,