sandbox: Test for both EctoSQL and Electric for Sandbox compatibility (#86)

Author: magnetised

lib/phoenix/sync.ex

@@ -338,4 +338,9 @@ defmodule Phoenix.Sync do
   def shape!(shape, shape_opts \\ []) do
     PredefinedShape.new!(shape, shape_opts)
   end
+
+  @doc false
+  def sandbox_enabled? do
+    Code.ensure_loaded?(Electric) && Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox)
+  end
 end

lib/phoenix/sync/electric.ex

@@ -150,7 +150,12 @@ defmodule Phoenix.Sync.Electric do
         {:ok, []}
 
       :sandbox ->
-        {:ok, [Phoenix.Sync.Sandbox]}
+        if Phoenix.Sync.sandbox_enabled?() do
+          {:ok, [Phoenix.Sync.Sandbox]}
+        else
+          {:error,
+           "Sandbox mode is only available if `:ecto_sql` and `:electric` are listed as dependencies"}
+        end
 
       mode when mode in @valid_modes ->
         embedded_children(env, mode, electric_opts)
@@ -289,7 +294,7 @@ defmodule Phoenix.Sync.Electric do
       |> Keyword.fetch!(:api)
     end
 
-    if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+    if Phoenix.Sync.sandbox_enabled?() do
       defp plug_opts(_env, :sandbox, _electric_opts) do
         %Phoenix.Sync.Sandbox.APIAdapter{}
       end
@@ -537,7 +542,7 @@ defmodule Phoenix.Sync.Electric do
     # to a real instance -- I think that's reasonable. The overhead of a real
     # electric consuming a real replication stream is way too high for a simple
     # consumer of streams
-    if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+    if Phoenix.Sync.sandbox_enabled?() do
       defp configure_client(_opts, :sandbox) do
         Phoenix.Sync.Sandbox.client()
       end

lib/phoenix/sync/sandbox.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox do
     @moduledoc """
     Integration between `Ecto.Adapters.SQL.Sandbox` and `Electric` that produces

lib/phoenix/sync/sandbox/api_adapter.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.APIAdapter do
     @moduledoc false
 

lib/phoenix/sync/sandbox/fetch.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.Fetch do
     @moduledoc false
 

lib/phoenix/sync/sandbox/inspector.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.Inspector do
     @moduledoc false
 

lib/phoenix/sync/sandbox/postgres.ex

@@ -1,52 +1,54 @@
-defmodule Phoenix.Sync.Sandbox.Postgres do
-  defmacro __using__(_opts) do
-    quote do
-      require Phoenix.Sync.Sandbox.Postgres
+if Phoenix.Sync.sandbox_enabled?() do
+  defmodule Phoenix.Sync.Sandbox.Postgres do
+    defmacro __using__(_opts) do
+      quote do
+        require Phoenix.Sync.Sandbox.Postgres
+      end
     end
-  end
 
-  @doc """
-  Replace hard-coded references to `Ecto.Adapters.Postgres` with this macro to
-  enable the `Phoenix.Sync.Sandbox` in test mode.
+    @doc """
+    Replace hard-coded references to `Ecto.Adapters.Postgres` with this macro to
+    enable the `Phoenix.Sync.Sandbox` in test mode.
 
-  In development or production environments the repo will use the standard
-  Postgres adapter directly, only if `Mix.env() == :test` (see below) will it
-  use the sandbox adapter shim.
+    In development or production environments the repo will use the standard
+    Postgres adapter directly, only if `Mix.env() == :test` (see below) will it
+    use the sandbox adapter shim.
 
-  Example:
+    Example:
 
-      defmodule MyApp.Repo do
-        use Phoenix.Sync.Sandbox.Postgres
+        defmodule MyApp.Repo do
+          use Phoenix.Sync.Sandbox.Postgres
 
-        use Ecto.Repo,
-          otp_app: :my_app,
-          adapter: Phoenix.Sync.Sandbox.Postgres.adapter()
-      end
+          use Ecto.Repo,
+            otp_app: :my_app,
+            adapter: Phoenix.Sync.Sandbox.Postgres.adapter()
+        end
 
-  ### Custom environments
+    ### Custom environments
 
-  If you want to enable the sandbox adapter in different environments, you can
-  use your own evaluation logic:
+    If you want to enable the sandbox adapter in different environments, you can
+    use your own evaluation logic:
 
-      defmodule MyApp.Repo do
-        use Phoenix.Sync.Sandbox.Postgres
+        defmodule MyApp.Repo do
+          use Phoenix.Sync.Sandbox.Postgres
 
-        use Ecto.Repo,
-          otp_app: :my_app,
-          adapter: Phoenix.Sync.Sandbox.Postgres.adapter(Mix.env() in [:test, :special])
-      end
+          use Ecto.Repo,
+            otp_app: :my_app,
+            adapter: Phoenix.Sync.Sandbox.Postgres.adapter(Mix.env() in [:test, :special])
+        end
+
+    > #### Warning {: .warning}
+    >
+    > The expression passed to `adapter/1` will be evaluated at **compile time**,
+    > not run-time so only use expressions that can be evaluated at then (this
+    > includes the various `Mix` functions).
+    """
+    defmacro adapter(expr \\ Mix.env() == :test) do
+      {enable_sandbox?, _binding} = Code.eval_quoted(expr, binding())
 
-  > #### Warning {: .warning}
-  >
-  > The expression passed to `adapter/1` will be evaluated at **compile time**,
-  > not run-time so only use expressions that can be evaluated at then (this
-  > includes the various `Mix` functions).
-  """
-  defmacro adapter(expr \\ Mix.env() == :test) do
-    {enable_sandbox?, _binding} = Code.eval_quoted(expr, binding())
-
-    if enable_sandbox?,
-      do: Phoenix.Sync.Sandbox.Postgres.Adapter,
-      else: Ecto.Adapters.Postgres
+      if enable_sandbox?,
+        do: Phoenix.Sync.Sandbox.Postgres.Adapter,
+        else: Ecto.Adapters.Postgres
+    end
   end
 end

lib/phoenix/sync/sandbox/postgres/adapter.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.Postgres) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.Postgres.Adapter do
     @moduledoc false
 

lib/phoenix/sync/sandbox/producer.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.Producer do
     @moduledoc false
 

lib/phoenix/sync/sandbox/publication_manager.ex

@@ -1,4 +1,4 @@
-if Code.ensure_loaded?(Ecto.Adapters.SQL.Sandbox) do
+if Phoenix.Sync.sandbox_enabled?() do
   defmodule Phoenix.Sync.Sandbox.PublicationManager do
     @moduledoc false