first version

mostly api-complete, but lacking docs and a bit rough around the edges

Author: magnetised

.formatter.exs

@@ -0,0 +1,13 @@
+locals_without_parens = [
+  # Electric.Phoenix.Router
+  sync: 1,
+  sync: 2,
+  sync: 3
+]
+
+[
+  locals_without_parens: locals_without_parens,
+  export: [locals_without_parens: locals_without_parens],
+  import_deps: [:plug, :phoenix, :ecto],
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.github/workflows/elixir_tests.yml

@@ -0,0 +1,80 @@
+name: Elixir CI
+
+on:
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - "**/README.md"
+  pull_request:
+    paths-ignore:
+      - "**/README.md"
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: mix test
+    runs-on: ubuntu-latest
+    env:
+      MIX_ENV: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: erlef/setup-beam@v1
+        with:
+          version-type: strict
+          version-file: ".tool-versions"
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: deps
+          key: ${{ runner.os }}-deps-${{ hashFiles('mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ hashFiles('mix.lock') }}
+            ${{ runner.os }}-deps-
+
+      - name: Cache build
+        uses: actions/cache@v4
+        with:
+          path: |
+            _build/*/lib
+            !_build/*/lib/electric_phoenix
+          key: ${{ runner.os }}-build-${{ env.MIX_ENV }}-[${{ github.ref_name }}]-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.MIX_ENV }}-[${{ github.ref_name }}]-${{ github.sha }}
+            ${{ runner.os }}-build-${{ env.MIX_ENV }}-[${{ github.ref_name }}]-
+            ${{ runner.os }}-build-${{ env.MIX_ENV }}-
+            ${{ runner.os }}-build-
+
+      - name: Install dependencies
+        run: mix deps.get && mix deps.compile
+
+      - name: Compiles without warnings
+        run: mix compile --force --all-warnings --warnings-as-errors
+
+      - name: Run tests
+        run: mix test --trace
+
+  formatting:
+    name: mix format --check-formatted
+    runs-on: ubuntu-latest
+    env:
+      MIX_ENV: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          version-type: strict
+          version-file: ".tool-versions"
+      - name: Restore dependencies cache
+        uses: actions/cache/restore@v4
+        with:
+          path: deps
+          key: ${{ runner.os }}-deps-${{ hashFiles('mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ hashFiles('mix.lock') }}
+            ${{ runner.os }}-deps-
+      - run: mix deps.get
+      - run: mix format --check-formatted

.gitignore

@@ -0,0 +1,26 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+electric_phoenix-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/

.tool-versions

@@ -0,0 +1,2 @@
+elixir 1.18.1-otp-27
+erlang 27.2

LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -174,28 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

README.md

@@ -0,0 +1,34 @@
+<p align="center">
+  <a href="https://electric-sql.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)"
+          srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-next.svg"
+      />
+      <source media="(prefers-color-scheme: light)"
+          srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
+      />
+      <img alt="ElectricSQL logo"
+          src="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
+      />
+    </picture>
+  </a>
+</p>
+
+# Phoenix.Sync
+
+An adapter to integrate [Electric SQL's sync engine](https://electric-sql.com)
+into [Phoenix web applications](https://www.phoenixframework.org/).
+
+Documentation available at <https://hexdocs.pm/phoenix_sync/>.
+
+## Installation
+
+Install by adding `phoenix_sync` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:phoenix_sync, "~> 0.1.0"}
+  ]
+end
+```

config/config.exs

@@ -0,0 +1,3 @@
+import Config
+
+import_config "#{config_env()}.exs"

config/dev.exs

@@ -0,0 +1 @@
+import Config

config/runtime.exs

@@ -0,0 +1,32 @@
+import Config
+
+config :logger, level: :warning
+
+if config_env() == :test do
+  # port = 3333
+  default_database_url = "postgresql://postgres:password@localhost:54321/electric?sslmode=disable"
+  database_url = System.get_env("DATABASE_URL", default_database_url)
+
+  connection_opts = Electric.Config.parse_postgresql_uri!(database_url)
+
+  # default_electric_url = "http://localhost:#{port}"
+
+  # config :electric_client,
+  #   database_config: connection_opts,
+  #   electric_url: electric_url
+
+  # config :electric_client, Support.Repo, url: database_url
+
+  config :electric,
+    start_in_library_mode: true,
+    connection_opts: Electric.Utils.obfuscate_password(connection_opts),
+    # enable the http api so that the client tests against a real endpoint can
+    # run against our embedded electric instance.
+    # enable_http_api: true,
+    # service_port: port,
+    allow_shape_deletion?: false,
+    # use a non-default replication stream id so we can run the client
+    # tests at the same time as an active electric instance
+    replication_stream_id: "phoenix_sync_tests",
+    storage_dir: Path.join(System.tmp_dir!(), "electric/client-tests#{System.monotonic_time()}")
+end

config/test.exs

@@ -0,0 +1,32 @@
+import Config
+
+config :logger, level: :critical
+
+config :phoenix_sync, mode: :disabled
+
+config :phoenix_sync, Phoenix.Sync.LiveViewTest.Endpoint, []
+
+config :phoenix_sync, Electric.Client, base_url: "http://localhost:3000"
+
+# configure the support repo with random options so we can validate them in Phoenix.Sync.ConfigTest
+config :phoenix_sync, Support.Repo,
+  username: "postgres",
+  password: "password",
+  hostname: "localhost",
+  database: "electric",
+  port: 54321,
+  stacktrace: true,
+  show_sensitive_data_on_connection_error: true,
+  pool_size: 10
+
+config :phoenix_sync, Support.ConfigTestRepo,
+  username: "postgres",
+  password: "password",
+  hostname: "localhost",
+  database: "electric",
+  port: 54321,
+  stacktrace: true,
+  show_sensitive_data_on_connection_error: true,
+  ssl: true,
+  socket_options: [:inet6],
+  pool_size: 10