Rename config option, slight refactoring, improve sandbox tests

Author: ftes

CHANGELOG.md

@@ -9,7 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 ### Changed
 - Ecto sandbox ownership: Use a separate sandbox owner process instead of the test process. This reduces ownership errors when LiveViews continue to use database connections after the test terminates. Commit [7577d5e]
 ### Added
-- Config option `sandbox_shutdown_delay`: Delay in milliseconds before shutting down the Ecto sandbox owner. Use when LiveViews or other processes need time to stop using the connections. Commit [7577d5e]
+- Config option `ecto_sandbox_stop_owner_delay`: Delay in milliseconds before shutting down the Ecto sandbox owner. Use when LiveViews or other processes need time to stop using the connections. Commit [7577d5e]
 
 ## [0.9.1] 2025-10-29
 ### Added

lib/phoenix_test/playwright.ex

@@ -189,7 +189,7 @@ defmodule PhoenixTest.Playwright do
   ** (DBConnection.OwnershipError) cannot find owner for ...
   ```
 
-  To prevent this, the `sandbox_shutdown_delay` option allows you to delay the
+  To prevent this, the `ecto_sandbox_stop_owner_delay` option allows you to delay the
   sandbox owner's shutdown, giving LiveViews and other processes time to close
   their database connections. The delay happens during
   `ExUnit.Callbacks.on_exit/1`, which blocks the running of the next test, so
@@ -200,7 +200,7 @@ defmodule PhoenixTest.Playwright do
   tests that need it, using `@tag` (or `@describetag` or `@moduletag`) like:
 
   ```
-  @tag sandbox_shutdown_delay: 100 # 100ms
+  @tag ecto_sandbox_stop_owner_delay: 100 # 100ms
   test "does something" do
     # ...
   end
@@ -212,7 +212,7 @@ defmodule PhoenixTest.Playwright do
   ```elixir
   # config/test.exs
   config :phoenix_test, playwright: [
-    sandbox_shutdown_delay: 50  # 50ms
+    ecto_sandbox_stop_owner_delay: 50  # 50ms
   ]
   ```
 

lib/phoenix_test/playwright/case.ex

@@ -171,15 +171,15 @@ defmodule PhoenixTest.Playwright.Case do
       repos = Application.get_env(otp_app, :ecto_repos, [])
 
       repos
-      |> Enum.map(&maybe_start_sandbox_owner(&1, context, config))
+      |> Enum.map(&maybe_start_sandbox_owner(&1, config, context))
       |> Phoenix.Ecto.SQL.Sandbox.metadata_for(self())
       |> Phoenix.Ecto.SQL.Sandbox.encode_metadata()
     end
 
-    defp maybe_start_sandbox_owner(repo, context, config) do
+    defp maybe_start_sandbox_owner(repo, config, context) do
       case start_sandbox_owner(repo, context) do
         {:ok, pid} ->
-          on_exit(fn -> stop_sandbox_owner(pid, config[:sandbox_shutdown_delay], context.async) end)
+          on_exit(fn -> stop_sandbox_owner(pid, config, context) end)
 
         _ ->
           :ok
@@ -189,21 +189,22 @@ defmodule PhoenixTest.Playwright.Case do
     end
 
     defp start_sandbox_owner(repo, context) do
-      pid = Sandbox.start_owner!(repo, shared: !context.async)
+      pid = Sandbox.start_owner!(repo, shared: not context.async)
       {:ok, pid}
     rescue
       _ -> {:error, :probably_already_started}
     end
 
-    defp stop_sandbox_owner(checkout_pid, delay, async?) do
-      if async? do
-        spawn(fn -> do_stop_sandbox_owner(checkout_pid, delay) end)
+    defp stop_sandbox_owner(checkout_pid, config, context) do
+      if context.async do
+        spawn(fn -> do_stop_sandbox_owner(checkout_pid, config) end)
       else
-        do_stop_sandbox_owner(checkout_pid, delay)
+        do_stop_sandbox_owner(checkout_pid, config)
       end
     end
 
-    defp do_stop_sandbox_owner(checkout_pid, delay) do
+    defp do_stop_sandbox_owner(checkout_pid, config) do
+      delay = Keyword.fetch!(config, :ecto_sandbox_stop_owner_delay)
       if delay > 0, do: Process.sleep(delay)
       Sandbox.stop_owner(checkout_pid)
     end

lib/phoenix_test/playwright/config.ex

@@ -101,6 +101,16 @@ schema_opts = [
     type: {:custom, PhoenixTest.Playwright.Config, :__validate_cli__, []},
     deprecated: "Use `assets_dir` instead."
   ],
+  ecto_sandbox_stop_owner_delay: [
+    default: 0,
+    type: :non_neg_integer,
+    doc: """
+    Delay in milliseconds before shutting down the Ecto sandbox owner after a
+    test ends. Use this to allow LiveViews and other processes in your app
+    time to stop using database connections before the sandbox owner is
+    terminated.
+    """
+  ],
   executable_path: browser_opts[:executable_path],
   headless: browser_opts[:headless],
   js_logger: [
@@ -119,16 +129,6 @@ schema_opts = [
     Accepts either a binary executable exposed in PATH or the absolute path to it.
     """
   ],
-  sandbox_shutdown_delay: [
-    default: 0,
-    type: :non_neg_integer,
-    doc: """
-    Delay in milliseconds before shutting down the Ecto sandbox owner after a
-    test ends. Use this to allow LiveViews and other processes in your app
-    time to stop using database connections before the sandbox owner is
-    terminated. Default is 0 (immediate shutdown).
-    """
-  ],
   screenshot: [
     default: false,
     type: {:or, [:boolean, non_empty_keyword_list: screenshot_opts_schema]},
@@ -169,7 +169,7 @@ schema_opts = [
 schema = NimbleOptions.new!(schema_opts)
 
 setup_all_keys = ~w(browser_pool browser browser_launch_timeout executable_path headless slow_mo)a
-setup_keys = ~w(accept_dialogs sandbox_shutdown_delay screenshot trace browser_context_opts browser_page_opts)a
+setup_keys = ~w(accept_dialogs ecto_sandbox_stop_owner_delay screenshot trace browser_context_opts browser_page_opts)a
 
 defmodule PhoenixTest.Playwright.Config do
   @moduledoc """

test/phoenix_test/playwright/ecto_sandbox_async_false_test.exs

@@ -0,0 +1,27 @@
+defmodule PhoenixTest.Playwright.EctoSandboxAsyncFalseTest do
+  use PhoenixTest.Playwright.Case, async: false
+
+  for delay_ms <- [0, 100] do
+    @delay_ms delay_ms
+
+    describe "delay: #{delay_ms}ms requires ecto_sandbox_stop_owner_delay to prevent 'is still using a connection from owner' errors" do
+      @describetag ecto_sandbox_stop_owner_delay: delay_ms + 100
+
+      setup %{conn: conn} do
+        [conn: visit(conn, "/pw/live/ecto?delay_ms=#{@delay_ms}")]
+      end
+
+      test "shows version", %{conn: conn} do
+        assert_has(conn, "div", text: "Version: PostgreSQL")
+      end
+
+      test "shows long running query result", %{conn: conn} do
+        assert_has(conn, "div", text: "Long running: void")
+      end
+
+      test "shows delayed version", %{conn: conn} do
+        assert_has(conn, "div", text: "Delayed version: PostgreSQL")
+      end
+    end
+  end
+end

test/phoenix_test/playwright/ecto_sandbox_test.exs

@@ -3,7 +3,7 @@ defmodule PhoenixTest.Playwright.EctoSandboxTest do
 
   for delay_ms <- [0, 100] do
     @delay_ms delay_ms
-    describe "delay: #{delay_ms}ms" do
+    describe "delay: #{delay_ms}ms does not require ecto_sandbox_stop_owner_delay" do
       setup %{conn: conn} do
         [conn: visit(conn, "/pw/live/ecto?delay_ms=#{@delay_ms}")]
       end