Always return result tuples from playwright channel functions

Author: ftes

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## tbd
+### Changed
+- Return result tuples from all playwright channel functions for consistency and to surface errors early.
+  - Most notably may affect callers of `Frame.evaluate/3`
+
 ## [0.8.0] 2025-09-17
 ### Removed
 - Config option `cli`. Use `assets_dir` instead. Commit [9e95e54]

lib/phoenix_test/playwright.ex

@@ -230,12 +230,8 @@ defmodule PhoenixTest.Playwright do
 
   defp assert_a11y(conn) do
     Frame.evaluate(conn.frame_id, A11yAudit.JS.axe_core())
-
-    results =
-      conn.frame_id
-      |> Frame.evaluate("axe.run()")
-      |> A11yAudit.Results.from_json()
-
+    {:ok, json} = Frame.evaluate(conn.frame_id, "axe.run()")
+    results = A11yAudit.Results.from_json(json)
     A11yAudit.Assertions.assert_no_violations(results)
 
     conn
@@ -403,7 +399,7 @@ defmodule PhoenixTest.Playwright do
         _ -> Application.fetch_env!(:phoenix_test, :base_url) <> path
       end
 
-    tap(conn, &Frame.goto(&1.frame_id, url))
+    tap(conn, &({:ok, _} = Frame.goto(&1.frame_id, url)))
   end
 
   @doc """
@@ -417,14 +413,14 @@ defmodule PhoenixTest.Playwright do
   """
   def add_cookies(conn, cookies) do
     cookies = Enum.map(cookies, &CookieArgs.from_cookie/1)
-    tap(conn, &BrowserContext.add_cookies(&1.context_id, cookies))
+    tap(conn, &({:ok, _} = BrowserContext.add_cookies(&1.context_id, cookies)))
   end
 
   @doc """
   Removes all cookies from the context
   """
   def clear_cookies(conn, opts \\ []) do
-    tap(conn, &BrowserContext.clear_cookies(&1.context_id, opts))
+    tap(conn, &({:ok, _} = BrowserContext.clear_cookies(&1.context_id, opts)))
   end
 
   @doc """
@@ -447,7 +443,7 @@ defmodule PhoenixTest.Playwright do
   """
   def add_session_cookie(conn, cookie, session_options) do
     cookie = CookieArgs.from_session_options(cookie, session_options)
-    tap(conn, &BrowserContext.add_cookies(&1.context_id, [cookie]))
+    tap(conn, &({:ok, _} = BrowserContext.add_cookies(&1.context_id, [cookie])))
   end
 
   @screenshot_opts_schema [

lib/phoenix_test/playwright/browser.ex

@@ -15,7 +15,9 @@ defmodule PhoenixTest.Playwright.Browser do
   """
   def new_context(browser_id, opts \\ []) do
     params = Map.new(opts)
-    resp = post(guid: browser_id, method: :new_context, params: params)
-    resp.result.context.guid
+
+    [guid: browser_id, method: :new_context, params: params]
+    |> post()
+    |> PhoenixTest.Playwright.Result.from_response(& &1.result.context.guid)
   end
 end

lib/phoenix_test/playwright/browser_context.ex

@@ -10,26 +10,35 @@ defmodule PhoenixTest.Playwright.BrowserContext do
 
   import PhoenixTest.Playwright.Connection, only: [post: 1, initializer: 1]
 
+  alias PhoenixTest.Playwright.Result
+
   @doc """
   Open a new browser page and return its `guid`.
   """
   def new_page(context_id, opts \\ []) do
     params = Map.new(opts)
-    resp = post(guid: context_id, method: :new_page, params: params)
-    resp.result.page.guid
+
+    [guid: context_id, method: :new_page, params: params]
+    |> post()
+    |> Result.from_response(& &1.result.page.guid)
   end
 
   @doc false
   def add_cookies(context_id, cookies) do
-    post(guid: context_id, method: :add_cookies, params: %{cookies: cookies})
+    [guid: context_id, method: :add_cookies, params: %{cookies: cookies}]
+    |> post()
+    |> Result.from_response(& &1)
   end
 
   @doc """
   Removes all cookies from the context
   """
   def clear_cookies(context_id, opts \\ []) do
     opts = Keyword.validate!(opts, ~w(domain name path)a)
-    post(guid: context_id, method: :clear_cookies, params: Map.new(opts))
+
+    [guid: context_id, method: :clear_cookies, params: Map.new(opts)]
+    |> post()
+    |> Result.from_response(& &1)
   end
 
   @doc """
@@ -39,8 +48,10 @@ defmodule PhoenixTest.Playwright.BrowserContext do
     opts = Keyword.validate!(opts, screenshots: true, snapshots: true, sources: true)
     tracing_id = initializer(context_id).tracing.guid
     post(method: :tracing_start, guid: tracing_id, params: Map.new(opts))
-    post(method: :tracing_start_chunk, guid: tracing_id)
-    :ok
+
+    [method: :tracing_start_chunk, guid: tracing_id]
+    |> post()
+    |> Result.from_response(& &1)
   end
 
   @doc """
@@ -56,7 +67,9 @@ defmodule PhoenixTest.Playwright.BrowserContext do
     zip_id = resp.result.artifact.guid
     zip_path = initializer(zip_id).absolute_path
     File.cp!(zip_path, output_path)
-    post(method: :tracing_stop, guid: tracing_id)
-    :ok
+
+    [method: :tracing_stop, guid: tracing_id]
+    |> post()
+    |> Result.from_response(& &1)
   end
 end

lib/phoenix_test/playwright/case.ex

@@ -85,11 +85,11 @@ defmodule PhoenixTest.Playwright.Case do
         user_agent: checkout_ecto_repos(context.async) || "No user agent"
       })
 
-    browser_context_id = Playwright.Browser.new_context(context.browser_id, browser_context_opts)
+    {:ok, browser_context_id} = Playwright.Browser.new_context(context.browser_id, browser_context_opts)
 
-    page_id = Playwright.BrowserContext.new_page(browser_context_id, config[:browser_page_opts])
-    Playwright.Page.update_subscription(page_id, event: :console, enabled: true)
-    Playwright.Page.update_subscription(page_id, event: :dialog, enabled: true)
+    {:ok, page_id} = Playwright.BrowserContext.new_page(browser_context_id, config[:browser_page_opts])
+    {:ok, _} = Playwright.Page.update_subscription(page_id, event: :console, enabled: true)
+    {:ok, _} = Playwright.Page.update_subscription(page_id, event: :dialog, enabled: true)
 
     frame_id = Connection.initializer(page_id).main_frame.guid
     on_exit(fn -> Connection.post(guid: browser_context_id, method: :close) end)
@@ -106,14 +106,14 @@ defmodule PhoenixTest.Playwright.Case do
   end
 
   defp trace(browser_context_id, config, context) do
-    Playwright.BrowserContext.start_tracing(browser_context_id)
+    {:ok, _} = Playwright.BrowserContext.start_tracing(browser_context_id)
 
     File.mkdir_p!(config[:trace_dir])
     file = file_name("_#{System.unique_integer([:positive, :monotonic])}.zip", context)
     path = Path.join(config[:trace_dir], file)
 
     on_exit(fn ->
-      Playwright.BrowserContext.stop_tracing(browser_context_id, path)
+      _ignore_error = Playwright.BrowserContext.stop_tracing(browser_context_id, path)
 
       if config[:trace] == :open do
         System.cmd(

lib/phoenix_test/playwright/dialog.ex

@@ -10,22 +10,17 @@ defmodule PhoenixTest.Playwright.Dialog do
 
   import PhoenixTest.Playwright.Connection, only: [post: 1]
 
+  alias PhoenixTest.Playwright.Result
+
   def accept(dialog_id, opts \\ []) do
     [guid: dialog_id, method: :accept, params: Map.new(opts)]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def dismiss(dialog_id, opts \\ []) do
     [guid: dialog_id, method: :dismiss, params: Map.new(opts)]
     |> post()
-    |> unwrap_response(& &1)
-  end
-
-  defp unwrap_response(response, fun) do
-    case response do
-      %{error: _} = error -> {:error, error}
-      _ -> {:ok, fun.(response)}
-    end
+    |> Result.from_response(& &1)
   end
 end

lib/phoenix_test/playwright/frame.ex

@@ -11,18 +11,21 @@ defmodule PhoenixTest.Playwright.Frame do
   import PhoenixTest.Playwright.Connection, only: [post: 1, post: 2]
 
   alias PhoenixTest.Playwright.Config
+  alias PhoenixTest.Playwright.Result
   alias PhoenixTest.Playwright.Serialization
 
   def goto(frame_id, url) do
     params = %{url: url}
-    post(guid: frame_id, method: :goto, params: params)
-    :ok
+
+    [guid: frame_id, method: :goto, params: params]
+    |> post()
+    |> Result.from_response(& &1)
   end
 
   def url(frame_id) do
     [guid: frame_id, method: :url, params: %{}]
     |> post()
-    |> unwrap_response(& &1.result.value)
+    |> Result.from_response(& &1.result.value)
   end
 
   def evaluate(frame_id, js, opts \\ []) do
@@ -33,8 +36,8 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :evaluate_expression, params: params]
     |> post()
-    |> unwrap_response(& &1.result.value)
-    |> Serialization.deserialize_arg()
+    |> Result.from_response(& &1.result.value)
+    |> Result.map(&Serialization.deserialize_arg/1)
   end
 
   def press(frame_id, selector, key, opts \\ []) do
@@ -45,7 +48,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :press, params: params]
     |> post(timeout)
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def type(frame_id, selector, text, opts \\ []) do
@@ -56,41 +59,41 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :type, params: params]
     |> post(timeout)
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def title(frame_id) do
     [guid: frame_id, method: :title]
     |> post()
-    |> unwrap_response(& &1.result.value)
+    |> Result.from_response(& &1.result.value)
   end
 
   def expect(frame_id, params) do
     params = Enum.into(params, %{is_not: false})
 
     [guid: frame_id, method: :expect, params: params]
     |> post()
-    |> unwrap_response(& &1.result.matches)
+    |> Result.from_response(& &1.result.matches)
   end
 
   def wait_for_selector(frame_id, params) do
     [guid: frame_id, method: :wait_for_selector, params: params]
     |> post()
-    |> unwrap_response(& &1.result.element)
+    |> Result.from_response(& &1.result.element)
   end
 
   def inner_html(frame_id, selector) do
     params = %{selector: selector}
 
     [guid: frame_id, method: "innerHTML", params: params]
     |> post()
-    |> unwrap_response(& &1.result.value)
+    |> Result.from_response(& &1.result.value)
   end
 
   def content(frame_id) do
     [guid: frame_id, method: :content]
     |> post()
-    |> unwrap_response(& &1.result.value)
+    |> Result.from_response(& &1.result.value)
   end
 
   def fill(frame_id, selector, value, opts \\ []) do
@@ -99,7 +102,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :fill, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def select_option(frame_id, selector, options, opts \\ []) do
@@ -108,7 +111,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :select_option, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def check(frame_id, selector, opts \\ []) do
@@ -117,7 +120,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :check, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def uncheck(frame_id, selector, opts \\ []) do
@@ -126,7 +129,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :uncheck, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def set_input_files(frame_id, selector, paths, opts \\ []) do
@@ -135,7 +138,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :set_input_files, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def click(frame_id, selector, opts \\ []) do
@@ -144,7 +147,7 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :click, params: params]
     |> post()
-    |> unwrap_response(& &1)
+    |> Result.from_response(& &1)
   end
 
   def blur(frame_id, selector, opts \\ []) do
@@ -153,13 +156,6 @@ defmodule PhoenixTest.Playwright.Frame do
 
     [guid: frame_id, method: :blur, params: params]
     |> post()
-    |> unwrap_response(& &1)
-  end
-
-  defp unwrap_response(response, fun) do
-    case response do
-      %{error: _} = error -> {:error, error}
-      _ -> {:ok, fun.(response)}
-    end
+    |> Result.from_response(& &1)
   end
 end

lib/phoenix_test/playwright/page.ex

@@ -10,8 +10,12 @@ defmodule PhoenixTest.Playwright.Page do
 
   import PhoenixTest.Playwright.Connection, only: [post: 1]
 
+  alias PhoenixTest.Playwright.Result
+
   def update_subscription(page_id, opts \\ []) do
-    post(guid: page_id, method: :update_subscription, params: Map.new(opts))
+    [guid: page_id, method: :update_subscription, params: Map.new(opts)]
+    |> post()
+    |> Result.from_response(& &1)
   end
 
   def screenshot(page_id, opts \\ []) do
@@ -23,13 +27,6 @@ defmodule PhoenixTest.Playwright.Page do
 
     [guid: page_id, method: :screenshot, params: params]
     |> post()
-    |> unwrap_response(& &1.result.binary)
-  end
-
-  defp unwrap_response(response, fun) do
-    case response do
-      %{error: _} = error -> {:error, error}
-      _ -> {:ok, fun.(response)}
-    end
+    |> Result.from_response(& &1.result.binary)
   end
 end

lib/phoenix_test/playwright/result.ex

@@ -0,0 +1,9 @@
+defmodule PhoenixTest.Playwright.Result do
+  @moduledoc false
+
+  def from_response(%{error: _} = error, _), do: {:error, error}
+  def from_response(value, fun) when is_function(fun, 1), do: {:ok, fun.(value)}
+
+  def map({:error, error}, _), do: {:error, error}
+  def map({:ok, value}, fun) when is_function(fun, 1), do: {:ok, fun.(value)}
+end