Add known_error header

electric-sql · robacourt · Jun 19, 2025 · Jun 3, 2025 · Jun 3, 2025 · Jun 3, 2025
commit 9dad905eb26c93a6da1b02b80f5ebfb5faba6a79
diff --git a/packages/sync-service/lib/electric/shapes/api.ex b/packages/sync-service/lib/electric/shapes/api.ex
@@ -532,7 +532,10 @@ defmodule Electric.Shapes.Api do
       {:error, %SnapshotError{} = error} ->
         Logger.warning("Failed to create snapshot for #{shape_handle}: #{error.message}")
 
-        Response.error(request, error.message, status: error.status)
+        Response.error(request, error.message,
+          status: error.status,
+          known_error: error.type != :unknown
+        )
 
       {:error, error} ->
         # Errors will be logged further up the stack

diff --git a/packages/sync-service/lib/electric/shapes/api/response.ex b/packages/sync-service/lib/electric/shapes/api/response.ex
@@ -11,20 +11,23 @@ defmodule Electric.Shapes.Api.Response do
   @electric_offset_header "electric-offset"
   @electric_schema_header "electric-schema"
   @electric_up_to_date_header "electric-up-to-date"
+  @electric_known_error_header "electric-known-error"
 
   # List of all Electric-specific headers that may be included in API responses
   @electric_headers [
     @electric_cursor_header,
     @electric_handle_header,
     @electric_offset_header,
     @electric_schema_header,
-    @electric_up_to_date_header
+    @electric_up_to_date_header,
+    @electric_known_error_header
   ]
 
   defstruct [
     :handle,
     :offset,
     :shape_definition,
+    :known_error,
     api: %Api{},
     chunked: false,
     up_to_date: false,
@@ -211,6 +214,7 @@ defmodule Electric.Shapes.Api.Response do
     |> put_schema_header(response)
     |> put_up_to_date_header(response)
     |> put_offset_header(response)
+    |> put_known_error_header(response)
   end
 
   defp put_shape_handle_header(conn, %__MODULE__{handle: nil}) do
@@ -334,6 +338,14 @@ defmodule Electric.Shapes.Api.Response do
     Plug.Conn.put_resp_header(conn, @electric_offset_header, "#{offset}")
   end
 
+  defp put_known_error_header(conn, %__MODULE__{known_error: nil}) do
+    conn
+  end
+
+  defp put_known_error_header(conn, %__MODULE__{known_error: known_error}) do
+    Plug.Conn.put_resp_header(conn, @electric_known_error_header, "#{known_error}")
+  end
+
   defp validate_response_finalized!(%__MODULE__{finalized?: false} = _response) do
     raise "Send of un-finalized response"
   end