openui-rails 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd5862a42a9eaf7c669e6e94fa38d8aaac1784e4f7efe5340e9cec48756902a
-  data.tar.gz: f7ada4e9693c3de0c0d13b05a7cc7692a44b402b291721d430038a68c6047f4c
+  metadata.gz: 348e7ebd421344dd62f6f5449c09fa477de3374dc1803c51aa8bc1415ad0fcfc
+  data.tar.gz: 6b82e02f137a9bff26b5b8c9dfd3e6a6053593e5a75f66b87825486e2d667c67
 SHA512:
-  metadata.gz: 0dc08e62c9508a13e11fa3d4995717d6b88be85458d505da3c363bccbfa1b57a1017bc59d72d667ed3d8043eb68f1005cd18b77bc87bae3ac9df0d2fe4683017
-  data.tar.gz: 524eb2239e400a15e6e0dee14d98b5d71e0a6f94866e4bfafda48917ea17f55a18a9eda9126cb13d7a7e4e149bd3ecfaa4f755ebac32f4ba2ca99d9b18db1d01
+  metadata.gz: 6f82e650f49c1b59912959c2e7d3d59d7b0c17088b0fb9dbcc9c97b235910645a5b026834cf509aa4b1915e55e9a2fafe20db57850b3a038dda144f2ce8572f2
+  data.tar.gz: 59e46f83487ce218dcd0780d89fc1bbe5a86dd6483d239cffd572effa327b17f130375761cea02ab472865ebd4fa5f8cc6c8587f58dad0e0266bc2a467cec25a

data/CHANGELOG.md

@@ -6,6 +6,61 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.9.0] - 2026-10-21
+
+### Added
+
+- A Supported API reference page that names the Ruby methods, settings, tasks,
+  events, wire contracts, and runtime pin policy covered by 1.x compatibility.
+
+### Deprecated
+
+- `config.library_name` and `config.surface_id_param` have no effect and report
+  a deprecation through the new `OpenUI::Rails.deprecator`, registered in
+  `Rails.application.deprecators`. They will be removed in 1.0.
+
+### Changed
+
+- The action endpoint returns HTTP 500 with code `error` and the fixed message
+  `action failed` for server-side gem errors, such as an unserializable result.
+  It previously returned 422 with the internal message. Details go to the log.
+- `OpenUI::Rails::RuntimeAsset` is marked internal. Configure runtime assets
+  through `Configuration`.
+
+### Fixed
+
+- A response that exceeds `stream_byte_limit` no longer drains the provider.
+  `Bridge#envelopes`, `Broadcaster.broadcast`, and the RubyLLM adapter stop
+  reading after the `stream_too_large` frame. `Writer#terminated?` lets
+  callback-based providers do the same.
+- A surface that reconnects while paused for a snapshot, including a Turbo
+  cache restoration, emits `openui:snapshot-required` again. It previously
+  dropped every later delta without telling the host.
+- An exception raised by the `on_error` hook no longer suppresses the stream's
+  error frame or replaces the provider error, which left the surface busy.
+- A surface without a stored `library_version` now checks stream frames against
+  the configured library fingerprint instead of accepting any library.
+
+## [0.5.0] - 2026-10-21
+
+### Added
+
+- Content-free `action.openui_rails` and `stream.openui_rails` notifications with
+  monotonic duration, fixed outcomes, replay status, and stream watermarks.
+- Browser `openui:ready` and `openui:snapshot-applied` events for host-owned
+  fallback and recovery, plus stable runtime and network failure codes.
+- Ordinary HTML fallback and explicit reload, scoped snapshot, and fresh sign-in
+  controls in the reference host, with keyboard and Turbo restoration checks.
+
+### Fixed
+
+- Late action responses cannot report into a reconnected surface. Failed
+  runtime scripts are removed so later mounts can retry loading.
+- Unmounted renderer callbacks cannot send actions, tool requests, state, or
+  errors through a new connection. A late snapshot cannot dismiss a host's
+  authentication or permission failure.
+- Browser failures use events without automatically logging raw error objects.
+
 ## [0.4.0] - 2026-10-20
 
 ### Added
@@ -133,7 +188,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Gem-scoped RubyGems Trusted Publishing through GitHub OIDC, with a protected
   release environment and verified artifact handoff.
 
-[Unreleased]: https://github.com/yorzi/openui-rails/compare/v0.4.0...main
+[Unreleased]: https://github.com/yorzi/openui-rails/compare/v0.9.0...main
+[0.9.0]: https://github.com/yorzi/openui-rails/releases/tag/v0.9.0
+[0.5.0]: https://github.com/yorzi/openui-rails/releases/tag/v0.5.0
 [0.4.0]: https://github.com/yorzi/openui-rails/releases/tag/v0.4.0
 [0.3.0]: https://github.com/yorzi/openui-rails/releases/tag/v0.3.0
 [0.2.0]: https://github.com/yorzi/openui-rails/releases/tag/v0.2.0

data/CONTRIBUTING.md

@@ -25,7 +25,7 @@ bundle exec bin/rails test        # unit + integration tests
 bundle exec bin/rails test:system # browser (system) tests, needs Chrome
 bundle exec rubocop               # style (rubocop-rails-omakase)
 bundle exec gem build openui-rails.gemspec
-bundle exec ruby bin/smoke-package openui-rails-0.4.0.gem
+bundle exec ruby bin/smoke-package openui-rails-0.9.0.gem
 bundle exec bundler-audit check --update
 bundle exec ruby -Itest test/compatibility/ruby_llm_smoke.rb
 ```

data/DEVELOPMENT.md

@@ -17,7 +17,7 @@ authorizes a live call. Follow this loop for each feature:
 ```sh
 bin/check-reference
 bin/check-reference --runtime tmp/real-runtime
-bin/check-reference --gem tmp/package/openui-rails-0.4.0.gem --runtime tmp/real-runtime
+bin/check-reference --gem tmp/package/openui-rails-0.9.0.gem --runtime tmp/real-runtime
 # Focus one browser scenario:
 bin/check-reference --runtime tmp/real-runtime --name test_a_lost_turbo_envelope_recovers_from_the_scoped_snapshot
 ```

data/README.md

@@ -32,7 +32,7 @@ The runtime-fetch task also needs npm. RubyLLM is optional.
 
 ```ruby
 # Gemfile
-gem "openui-rails", "~> 0.4.0"
+gem "openui-rails", "~> 0.9.0"
 ```
 
 ```sh
@@ -65,15 +65,16 @@ The documentation site contains the full guides and API reference:
 - [RubyLLM](https://openui-rails.wangyaodi.com/ruby-llm/) and [production setup](https://openui-rails.wangyaodi.com/production/)
 - [Upgrading](https://openui-rails.wangyaodi.com/upgrading/) and [API reference](https://openui-rails.wangyaodi.com/api-reference/)
 
-Version `0.4.0` adds optional shared replay storage for Rails workers.
-See [What's New](https://openui-rails.wangyaodi.com/whats-new-in-0-4/) for the upgrade.
+Version `0.9.0` freezes the candidate API for 1.0 and fixes stream and recovery defects.
+See [What's New](https://openui-rails.wangyaodi.com/whats-new-in-0-9/) for the upgrade and
+[Supported API](https://openui-rails.wangyaodi.com/supported-api/) for the compatibility boundary.
 The API may change during `0.x`; see the
 [changelog](CHANGELOG.md) and the proposed [path to 1.0](ROADMAP.md).
 The site's stable channel follows the latest release; [/next/](https://openui-rails.wangyaodi.com/next/)
 follows `main`.
 
 For repository work, use [Contributing](CONTRIBUTING.md),
-[Releasing](RELEASING.md), and the [0.3.0 release record](RELEASE_0_3.md).
+[Releasing](RELEASING.md), and the [0.5.0 release record](RELEASE_0_5.md).
 Report vulnerabilities through the [security policy](SECURITY.md).
 
 ## License

data/app/controllers/openui/rails/actions_controller.rb

@@ -48,20 +48,21 @@ module OpenUI
                status: :unprocessable_content
       end
 
+      # Request errors return their own message. Any other gem error is a
+      # server-side fault, possibly after the handler ran: log it and return a
+      # generic message so configuration details never reach the browser.
       def render_domain_error(error)
-        render json: { error: { code: error_code(error), message: error.message } },
-               status: error_status(error)
+        code = error_code(error)
+        if code == "error"
+          logger&.error("[openui-rails] action failed: #{error.class}: #{error.message}")
+          render json: { error: { code: code, message: "action failed" } }, status: :internal_server_error
+        else
+          render json: { error: { code: code, message: error.message } }, status: error_status(error)
+        end
       end
 
       def error_code(error)
-        case error
-        when UnknownActionError then "unknown_action"
-        when UnauthorizedActionError then "unauthorized"
-        when StaleSurfaceError then "stale_surface"
-        when ReplayError then "replay"
-        when InvalidActionError then "invalid_action"
-        else "error"
-        end
+        Instrumentation.action_error_code(error)
       end
 
       def error_status(error)
@@ -69,7 +70,8 @@ module OpenUI
         when UnknownActionError then :not_found
         when UnauthorizedActionError then :forbidden
         when StaleSurfaceError, ReplayError then :conflict
-        else :unprocessable_content
+        when InvalidActionError then :unprocessable_content
+        else :internal_server_error
         end
       end
     end

data/app/javascript/openui/rails/openui_controller.js

@@ -12,16 +12,18 @@ function loadRuntime(url, integrity) {
       script.async = true
       script.crossOrigin = "anonymous"
       if (integrity) script.integrity = integrity
+      const failed = (message) => {
+        script.remove()
+        reject(Object.assign(new Error(message), { code: "runtime_load_failed" }))
+      }
       script.addEventListener("load", () => {
         if (!window.__OpenUI) {
-          reject(new Error(`OpenUI runtime at ${url} did not expose window.__OpenUI`))
+          failed("OpenUI runtime did not expose window.__OpenUI")
           return
         }
         resolve(window.__OpenUI)
       })
-      script.addEventListener("error", () =>
-        reject(new Error(`Failed to load the OpenUI runtime from ${url}`))
-      )
+      script.addEventListener("error", () => failed("Failed to load the OpenUI runtime"))
       document.head.appendChild(script)
     })
     promise.catch(() => runtimePromises.delete(url))
@@ -71,6 +73,12 @@ export default class extends Controller {
 
     this.syncBusy()
     this.renderRuntime(connection)
+    // A surface restored from the Turbo cache or reattached while paused for a
+    // snapshot would otherwise wait forever: the host abandoned the earlier
+    // request on disconnect. Announce it again once sibling controllers connect.
+    if (this.state.needsSnapshot) {
+      queueMicrotask(() => { if (this.isCurrent(connection)) this.announceSnapshotRequired() })
+    }
   }
 
   disconnect() {
@@ -80,6 +88,8 @@ export default class extends Controller {
     this.abortController?.abort()
     this.root?.unmount()
     this.root = null
+    this.runtime = null
+    this.tools = null
     this.mountPoint?.remove()
     this.mountPoint = null
   }
@@ -88,11 +98,11 @@ export default class extends Controller {
     try {
       const runtime = await loadRuntime(this.runtimeUrl, this.runtimeIntegrity)
       await this.verifyLibrary(runtime.openuiChatLibrary)
-      if (connection !== this.connection || !this.element.isConnected || !this.mountPoint) return
+      if (!this.isCurrent(connection) || !this.mountPoint) return
       this.runtime = runtime
-      this.render()
+      if (this.render()) this.dispatch("ready", { surfaceId: this.surfaceId })
     } catch (error) {
-      if (connection !== this.connection) return
+      if (!this.isCurrent(connection)) return
       this.state.streaming = false
       this.syncBusy()
       this.handleError(error)
@@ -104,6 +114,7 @@ export default class extends Controller {
     if (!this.runtime || !this.mountPoint || !this.connection) return
     if (!this.withinByteLimit(this.state.source)) return
     const { React, createRoot, Renderer, openuiChatLibrary } = this.runtime
+    const connection = this.connection
     if (!this.root) this.root = createRoot(this.mountPoint)
     this.root.render(
       React.createElement(Renderer, {
@@ -115,12 +126,13 @@ export default class extends Controller {
         initialState: this.initialState,
         // The official runtime emits { type, params }. It does not await this
         // void callback; dispatchAction already emits a structured error.
-        onAction: (action) => { this.dispatchAction(action).catch(() => {}) },
-        onStateUpdate: (formState) => this.persistState(formState),
+        onAction: (action) => { if (this.isCurrent(connection)) this.dispatchAction(action).catch(() => {}) },
+        onStateUpdate: (formState) => { if (this.isCurrent(connection)) this.persistState(formState) },
         toolProvider: this.toolProvider(),
-        onError: (error) => this.handleError(error),
+        onError: (error) => { if (this.isCurrent(connection)) this.handleError(error) },
       })
     )
+    return true
   }
 
   async verifyLibrary(library) {
@@ -153,7 +165,10 @@ export default class extends Controller {
         (envelope.type === "openui.snapshot" && typeof envelope.response !== "string")) {
       return this.handleError(Object.assign(new Error("Malformed stream envelope"), { code: "invalid_envelope" }))
     }
-    if (envelope.library_version && this.libraryVersion && envelope.library_version !== this.libraryVersion) {
+    // Without a stored library version, the verified runtime fingerprint is
+    // still the only library this mount can render.
+    const library = this.libraryVersion || this.element.dataset.openuiLibraryFingerprint
+    if (envelope.library_version && library && envelope.library_version !== library) {
       return this.handleError(Object.assign(new Error("OpenUI library version mismatch"), { code: "library_version_mismatch" }))
     }
     if (envelope.type !== "openui.snapshot") {
@@ -203,11 +218,16 @@ export default class extends Controller {
     this.state.streaming = envelope.streaming === true
     this.state.completed = !this.state.streaming
     this.render()
+    this.dispatch("snapshot-applied", { surfaceId: this.surfaceId, sequence: envelope.sequence })
   }
 
   requestSnapshot() {
     if (this.state.needsSnapshot) return
     this.state.needsSnapshot = true
+    this.announceSnapshotRequired()
+  }
+
+  announceSnapshotRequired() {
     this.dispatch("snapshot-required", { surfaceId: this.surfaceId, sequence: this.state.nextSequence })
   }
 
@@ -224,6 +244,8 @@ export default class extends Controller {
   // --- Actions -------------------------------------------------------------
 
   async dispatchAction(payload = {}) {
+    const connection = this.connection
+    if (!this.isCurrent(connection)) throw new DOMException("Surface disconnected", "AbortError")
     const body = {
       action: payload.action ?? payload.name ?? payload.type,
       args: this.actionArguments(payload),
@@ -241,6 +263,7 @@ export default class extends Controller {
         headers: this.headers(),
         body: JSON.stringify(body),
       })
+      if (!this.isCurrent(connection)) throw new DOMException("Surface disconnected", "AbortError")
       if (response.redirected) {
         throw Object.assign(new Error("Action request was redirected; authentication may have expired"), { code: "unauthorized" })
       }
@@ -253,8 +276,9 @@ export default class extends Controller {
       } catch {
         throw Object.assign(new Error("Action endpoint returned malformed JSON"), { code: "invalid_response" })
       }
+      if (!this.isCurrent(connection)) throw new DOMException("Surface disconnected", "AbortError")
       if (!response.ok) {
-        throw Object.assign(new Error(json?.error?.message || "action failed"), { code: json?.error?.code })
+        throw Object.assign(new Error(json?.error?.message || "action failed"), { code: json?.error?.code || "action_failed" })
       }
       const result = json?.result
       if (!result || result.action !== body.action || result.surface_id !== body.surface_id || result.version !== body.version) {
@@ -263,7 +287,7 @@ export default class extends Controller {
       this.dispatch("action", { surfaceId: this.surfaceId, result })
       return result
     } catch (error) {
-      if (error.name !== "AbortError" || this.connection) this.handleError(error)
+      if (this.isCurrent(connection)) this.handleError(error, error.name === "AbortError" ? "request_cancelled" : "network_error")
       throw error
     }
   }
@@ -284,6 +308,7 @@ export default class extends Controller {
   // Every browser `Query()`/`Mutation()` tool call is routed to the same
   // server endpoint; the host registry decides what is permitted.
   toolProvider() {
+    const connection = this.connection
     const reserved = new Set([ "callTool", "then", "__proto__", "constructor", "prototype", "toJSON" ])
     return this.tools ||= new Proxy(
       {},
@@ -291,7 +316,10 @@ export default class extends Controller {
         has: (_target, name) => typeof name === "string" && !reserved.has(name),
         get: (_target, name) => {
           if (typeof name !== "string" || reserved.has(name)) return undefined
-          return (args) => this.dispatchAction({ action: name, args: args ?? {} }).then((result) => result.value)
+          return (args) => {
+            if (!this.isCurrent(connection)) return Promise.reject(new DOMException("Surface disconnected", "AbortError"))
+            return this.dispatchAction({ action: name, args: args ?? {} }).then((result) => result.value)
+          }
         },
       }
     )
@@ -310,17 +338,19 @@ export default class extends Controller {
     this.element.setAttribute("aria-busy", this.state.streaming ? "true" : "false")
   }
 
-  handleError(error) {
+  handleError(error, fallbackCode = "renderer_error") {
     // Renderer#onError receives an array, including [] after successful parses.
     if (Array.isArray(error)) {
       if (error.length === 0) return
       error = Object.assign(new Error(error.map((entry) => entry.message || String(entry)).join("; ")),
         { code: "renderer_error" })
     }
-    console.error("[openui-rails]", error)
-    this.dispatch("error", { surfaceId: this.surfaceId, message: error?.message, code: error?.code })
+    this.dispatch("error", { surfaceId: this.surfaceId, message: error?.message,
+      code: typeof error?.code === "string" ? error.code : fallbackCode })
   }
 
+  isCurrent(connection) { return !!connection && connection === this.connection && this.element.isConnected }
+
   headers() {
     const token = document.querySelector("meta[name='csrf-token']")?.content
     const headers = { "Content-Type": "application/json", Accept: "application/json" }

data/examples/support_desk/README.md

@@ -6,12 +6,17 @@ OpenUI runtime, SQLite, importmap, and HTTP Turbo Streams. It opts into the
 Active Record idempotency store and retains a unique business receipt for closing
 a ticket. Shared claims do not replace that database constraint.
 
+The plain HTML fallback provides ticket details, an explicit reload, and a fresh
+sign-in. Snapshot recovery is scoped and single-flight. Unknown action outcomes
+are never retried automatically. Browser checks cover failure feedback, keyboard
+recovery, and Turbo restoration as well as the successful workflow.
+
 From the repository:
 
 ```sh
 mkdir -p tmp/package
-bundle exec gem build openui-rails.gemspec --output tmp/package/openui-rails-0.4.0.gem
-bin/check-reference --gem tmp/package/openui-rails-0.4.0.gem --runtime tmp/real-runtime
+bundle exec gem build openui-rails.gemspec --output tmp/package/openui-rails-0.9.0.gem
+bin/check-reference --gem tmp/package/openui-rails-0.9.0.gem --runtime tmp/real-runtime
 ```
 
 Fetch the runtime first. See the [complete guide](https://openui-rails.wangyaodi.com/reference-workflow/)

data/examples/support_desk/app/javascript/support_desk.js

@@ -5,37 +5,68 @@ import EnvelopeController from "openui/rails/openui_envelope_controller"
 
 class SupportDeskController extends Controller {
   connect() {
+    this.connection = Symbol("support-desk")
     this.abort = new AbortController()
     this.saves = Promise.resolve()
     this.lastState = null
-    if (this.surface.dataset.openuiStreaming === "true") this.stream().catch(error => this.failure(error))
+    this.runtimeReady = false
+    this.recovering = false
+    this.failureCode = this.element.dataset.supportDeskFailure || null
+    this.beforeCache = () => this.disconnect()
+    document.addEventListener("turbo:before-cache", this.beforeCache)
+    if (this.surface.dataset.openuiStreaming === "true" && !this.failureCode) {
+      const connection = this.connection
+      this.stream(connection).catch(error => { if (this.current(connection)) this.failure(error) })
+    }
   }
 
-  disconnect() { this.abort.abort() }
+  disconnect() {
+    this.connection = null
+    this.abort?.abort()
+    document.removeEventListener("turbo:before-cache", this.beforeCache)
+  }
+  current(connection) { return !!connection && connection === this.connection && this.element.isConnected }
   get surface() { return this.element.querySelector("[data-controller='openui']") }
   get status() { return this.element.querySelector("#desk-status") }
+  get fallback() { return this.element.querySelector("#desk-fallback") }
+  get recoverButton() { return this.element.querySelector("#desk-recover") }
 
   headers() {
     return { "Content-Type": "application/json", "X-CSRF-Token": document.querySelector("meta[name='csrf-token']").content }
   }
 
-  async checked(response) {
-    if (response.redirected || !response.ok) throw new Error(response.status === 401 || response.status === 403 ? "Session expired. Sign in again." : "Request rejected. Reload the conversation.")
+  checked(response) {
+    if (response.redirected || [401, 403].includes(response.status)) {
+      throw Object.assign(new Error("Session or permission rejected"), { code: "unauthorized" })
+    }
+    if (!response.ok) throw Object.assign(new Error("Request rejected"), {
+      code: response.status === 409 ? "stale_surface" : "request_failed"
+    })
     return response
   }
 
-  // Consume newline-delimited Turbo Stream elements as response chunks arrive.
-  // Authorization and canonical response persistence happen before delivery.
-  async stream() {
-    const response = await this.checked(await fetch(this.element.dataset.supportDeskStreamUrl, {
+  ready() {
+    this.runtimeReady = true
+    if (!this.failureCode) {
+      this.fallback.hidden = true
+      this.surface.inert = false
+    }
+  }
+
+  // Persisted canonical output is independent of this disposable connection.
+  async stream(connection) {
+    const response = await fetch(this.element.dataset.supportDeskStreamUrl, {
       method: "POST", headers: this.headers(), signal: this.abort.signal, credentials: "same-origin"
-    }))
+    })
+    if (!this.current(connection)) return
+    this.checked(response)
     const reader = response.body.getReader()
     const decoder = new TextDecoder()
     let pending = ""
     try {
       while (true) {
         const { value, done } = await reader.read()
+        if (!this.current(connection)) return
         pending += decoder.decode(value, { stream: !done })
         let end
         while ((end = pending.indexOf("\n")) >= 0) {
@@ -44,26 +75,54 @@ class SupportDeskController extends Controller {
         }
         if (done) break
       }
-      if (pending.trim()) throw new Error("Incomplete stream. Reload the conversation.")
-      this.status.textContent = "Response loaded"
+      if (pending.trim()) throw new Error("Incomplete stream")
+      if (!this.failureCode) this.status.textContent = "Response loaded"
     } finally {
       await reader.cancel().catch(() => {})
     }
   }
 
   async recover() {
-    if (this.recovering) return
+    if (!this.current(this.connection) || this.recovering || ["unauthorized", "csrf_failed"].includes(this.failureCode)) return
+    const connection = this.connection
     this.recovering = true
+    this.failure({ code: "sequence_gap" })
+    this.recoverButton.disabled = true
+    this.recoverButton.setAttribute("aria-busy", "true")
+    this.status.textContent = "Restoring saved response"
     try {
-      const response = await this.checked(await fetch(this.element.dataset.supportDeskSnapshotUrl, {
+      const response = await fetch(this.element.dataset.supportDeskSnapshotUrl, {
         headers: { Accept: "application/json" }, signal: this.abort.signal, credentials: "same-origin"
-      }))
-      const envelope = await response.json()
+      })
+      if (!this.current(connection)) return
+      const envelope = await this.checked(response).json()
+      if (!this.current(connection)) return
+      this.snapshotApplied = false
       this.surface.dispatchEvent(new CustomEvent("openui:envelope", { bubbles: true, detail: envelope }))
-      this.element.dataset.recovered = "true"
-      this.status.textContent = "Recovered from a missing update"
-    } catch (error) { this.failure(error) }
-    finally { this.recovering = false }
+      if (!this.snapshotApplied) throw Object.assign(new Error("Snapshot not accepted"), { code: "snapshot_unavailable" })
+    } catch (error) {
+      if (this.current(connection)) this.failure(error)
+    } finally {
+      if (this.current(connection)) {
+        this.recovering = false
+        this.recoverButton.disabled = this.failureCode !== "sequence_gap" && this.failureCode !== "request_failed"
+        this.recoverButton.setAttribute("aria-busy", "false")
+      }
+    }
+  }
+
+  restored() {
+    this.snapshotApplied = true
+    // A transport snapshot cannot restore identity or permission. Keep that
+    // failure visible until the host performs a fresh sign-in or reload.
+    if (this.failureCode && !["sequence_gap", "request_failed"].includes(this.failureCode)) return
+    this.failureCode = null
+    delete this.element.dataset.supportDeskFailure
+    this.element.dataset.recovered = "true"
+    this.element.querySelector("#desk-error").textContent = ""
+    this.status.textContent = "Recovered from a missing update"
+    this.surface.inert = false
+    if (this.runtimeReady) this.fallback.hidden = true
   }
 
   saveState(event) {
@@ -74,32 +133,58 @@ class SupportDeskController extends Controller {
     if (this.lastState === serialized) return
     this.lastState = serialized
     this.status.textContent = "Saving draft"
+    const connection = this.connection, signal = this.abort.signal
     const version = Number(this.surface.dataset.openuiVersion)
     this.saves = this.saves.then(async () => {
-      await this.checked(await fetch(this.element.dataset.supportDeskStateUrl, {
-        method: "PATCH", headers: this.headers(), credentials: "same-origin", signal: this.abort.signal,
+      if (!this.current(connection)) return
+      const response = await fetch(this.element.dataset.supportDeskStateUrl, {
+        method: "PATCH", headers: this.headers(), credentials: "same-origin", signal,
         body: JSON.stringify({ state, version })
-      }))
-      if (this.lastState === serialized) this.status.textContent = "Draft saved"
-    }).catch(error => this.failure(error))
+      })
+      if (!this.current(connection)) return
+      this.checked(response)
+      if (this.lastState === serialized && !this.failureCode) this.status.textContent = "Draft saved"
+    }).catch(error => { if (this.current(connection)) this.failure(error) })
   }
 
   async action(event) {
     if (!["continue_conversation", "close_ticket"].includes(event.detail.result.action)) return
+    const connection = this.connection
     await this.saves
-    window.location.reload()
+    if (this.current(connection)) window.location.reload()
   }
 
   error(event) {
-    if (["unauthorized", "csrf_failed"].includes(event.detail.code)) {
-      this.denied = true
-      this.failure(new Error("Action not permitted. Sign in again."))
-    } else if (!this.denied) {
-      this.failure(new Error(event.detail.message || "Unable to render this response."))
-    }
+    // The runtime can report a secondary parse failure after an action error.
+    // Keep the actionable server outcome instead of replacing it with that echo.
+    if (this.failureCode && event.detail.code === "renderer_error") return
+    this.failure(event.detail)
   }
+
   failure(error) {
-    if (error.name !== "AbortError") this.element.querySelector("#desk-error").textContent = error.message
+    if (error.name === "AbortError") return
+    this.failureCode = error.code || "request_failed"
+    this.element.dataset.supportDeskFailure = this.failureCode
+    const messages = {
+      runtime_load_failed: "Interactive view could not load. Review the ticket details or reload.",
+      library_version_mismatch: "The response uses a different library. Reload after correcting setup.",
+      provider_rejected: "Generation stopped. Reload the saved conversation before trying again.",
+      stream_failed: "Generation stopped. Reload the saved conversation before trying again.",
+      stream_cancelled: "Generation stopped. Reload the saved conversation before trying again.",
+      stream_too_large: "The response is too large. Reload the saved conversation.",
+      stale_surface: "Conversation changed. Reload before submitting another action.",
+      unauthorized: "Action not permitted. Sign in again.",
+      csrf_failed: "Action not permitted. Sign in again.",
+      sequence_gap: "An update is missing. Restore the saved response or reload.",
+      snapshot_unavailable: "Saved response cannot be applied. Reload the conversation.",
+      renderer_error: "Interactive response could not render. Reload the conversation."
+    }
+    this.element.querySelector("#desk-error").textContent = messages[this.failureCode] || "Request failed; its outcome may be unknown. Reload canonical state before trying again."
+    this.fallback.hidden = false
+    this.surface.inert = true
+    this.recoverButton.disabled = !["sequence_gap", "request_failed"].includes(this.failureCode)
+    this.element.querySelector("#desk-sign-in").hidden = !["unauthorized", "csrf_failed"].includes(this.failureCode)
+    this.status.textContent = "Recovery required"
   }
 }
 

data/examples/support_desk/app/views/support_desk/conversations/show.html.erb

@@ -1,6 +1,7 @@
 <header>
   <h1>Support Desk</h1>
   <span><%= current_actor.name %> · <%= current_actor.tenant_id %> tenant</span>
+  <%= link_to "Conversations", root_path %>
   <%= button_to "Sign out", session_path, method: :delete %>
 </header>
 <p class="notice">Recorded response, real OpenUI runtime. Your Rails host owns the ticket and conversation.</p>
@@ -8,9 +9,18 @@
          data-support-desk-stream-url="<%= stream_conversation_path(@conversation) %>"
          data-support-desk-snapshot-url="<%= snapshot_conversation_path(@conversation) %>"
          data-support-desk-state-url="<%= state_conversation_path(@conversation) %>"
-         data-action="openui:state->support-desk#saveState openui:snapshot-required->support-desk#recover openui:action->support-desk#action openui:error->support-desk#error">
+         data-action="openui:ready->support-desk#ready openui:snapshot-applied->support-desk#restored openui:state->support-desk#saveState openui:snapshot-required->support-desk#recover openui:action->support-desk#action openui:error->support-desk#error">
   <%= openui_surface(surface: @conversation.surface, label: "Support ticket") %>
   <div id="desk-envelopes" hidden></div>
   <p role="status" id="desk-status">Ready</p>
   <p role="alert" id="desk-error"></p>
+  <aside id="desk-fallback" class="notice" aria-labelledby="desk-fallback-title">
+    <h2 id="desk-fallback-title">Ticket details and recovery</h2>
+    <p><%= @conversation.ticket.title %> · <%= @conversation.ticket.status %></p>
+    <p>If the interactive view is unavailable, review these saved details. Reloading does not resubmit your last action.</p>
+    <%= link_to "Reload conversation", conversation_path(@conversation), data: { turbo: false } %>
+    <%= link_to "Sign in again", root_path, id: "desk-sign-in", data: { turbo: false }, hidden: true %>
+    <button id="desk-recover" type="button" disabled aria-busy="false" aria-describedby="desk-error"
+            data-action="support-desk#recover">Restore saved response</button>
+  </aside>
 </section>

data/lib/openui/rails/actions/dispatcher.rb

@@ -78,8 +78,16 @@ module OpenUI
         #
         # @return [Result]
         #
-        # @raise [OpenUI::Rails::Error] on any failed gate, before side effects
+        # Emits one content-free action.openui_rails outcome notification.
+        # Failed gates run before the handler. Handler and storage failures can
+        # occur after a business effect; hosts must reconcile that outcome.
+        #
+        # @raise [OpenUI::Rails::Error] on a failed gate or domain operation
         def call(payload, actor: nil, surface: nil, tenant: nil, context: {})
+          started = Instrumentation.now
+          outcome = "rejected"
+          replayed = false
+          code = nil
           submission = Submission.parse(payload)
           definition = @registry.fetch(submission.action)
 
@@ -102,11 +110,22 @@ module OpenUI
           authorize!(definition, invocation)
 
           replayed, stored, key, token = claim_idempotency(submission, invocation)
-          return result(submission, stored, replayed: true) if replayed
+          if replayed
+            outcome = "replayed"
+            return result(submission, stored, replayed: true)
+          end
 
+          outcome = "failed"
           value = definition.handler.call(invocation)
           @idempotency_store.record(key, value, claim_token: token)
+          outcome = "succeeded"
           result(submission, value, replayed: false)
+        rescue StandardError => error
+          code = Instrumentation.action_error_code(error)
+          outcome = "failed" unless error.is_a?(Error)
+          raise
+        ensure
+          Instrumentation.publish("action", started: started, outcome: outcome, code: code, replayed: replayed == true)
         end
 
         private

data/lib/openui/rails/adapters/ruby_llm.rb

@@ -17,6 +17,10 @@ module OpenUI
       module RubyLLM
         STRATEGIES = %i[complete ask].freeze
 
+        # Internal signal that aborts the provider stream after a terminal frame.
+        Halt = Class.new(StandardError)
+        private_constant :Halt
+
         class << self
           # Stream a RubyLLM completion, yielding ordered {Stream::Envelope}s.
           #
@@ -47,6 +51,7 @@ module OpenUI
 
             begin
               consumer_failed = false
+              halted = false
               deliver = lambda do |envelope|
                 begin
                   block.call(envelope)
@@ -60,10 +65,17 @@ module OpenUI
                 next if text.nil?
 
                 writer.push(text).each(&deliver)
+                # A terminal frame (the byte limit) has already been delivered.
+                # Raise out of the provider callback so it stops generating.
+                if writer.terminated?
+                  halted = true
+                  raise Halt
+                end
               end
               writer.finish.each(&deliver)
             rescue StandardError => e
               raise if consumer_failed
+              return writer if halted
 
               envelope = writer.error_for(e, code: error_code_for(e))
               block.call(envelope) if envelope

data/lib/openui/rails/configuration.rb

@@ -29,8 +29,8 @@ module OpenUI
       DEFAULT_ACTIONS_ENDPOINT = "/openui-rails/actions"
 
       attr_reader :transport, :runtime_assets
-      attr_accessor :library_spec_path, :prompt_path, :library_name,
-                    :actions_endpoint, :surface_id_param,
+      attr_accessor :library_spec_path, :prompt_path,
+                    :actions_endpoint,
                     :stream_byte_limit, :pending_byte_limit, :idempotency_ttl,
                     :authorize_action, :on_error, :action_registry, :surface_resolver, :actor_resolver,
                     :runtime_version, :runtime_url, :runtime_integrity, :local_runtime_path,
@@ -62,6 +62,32 @@ module OpenUI
         @local_runtime_path = "/openui"
       end
 
+      # @deprecated Has no effect: the runtime library comes from the loaded
+      #   bundle and its manifest. Removed in 1.0.
+      def library_name
+        deprecated_setting(:library_name)
+        @library_name
+      end
+
+      # @deprecated Has no effect. Removed in 1.0.
+      def library_name=(value)
+        deprecated_setting(:library_name)
+        @library_name = value
+      end
+
+      # @deprecated Has no effect: action requests always use the `surface_id`
+      #   key. Removed in 1.0.
+      def surface_id_param
+        deprecated_setting(:surface_id_param)
+        @surface_id_param
+      end
+
+      # @deprecated Has no effect. Removed in 1.0.
+      def surface_id_param=(value)
+        deprecated_setting(:surface_id_param)
+        @surface_id_param = value
+      end
+
       # Set the preferred host stream transport.
       #
       # @param value [Symbol] `:turbo`, `:action_cable`, or `:none`
@@ -243,6 +269,12 @@ module OpenUI
         PromptBuilder.load(self) if prompt_path
         true
       end
+
+      private
+
+      def deprecated_setting(name)
+        OpenUI::Rails.deprecator.warn("config.#{name} has no effect and will be removed; delete it from your initializer")
+      end
     end
 
     class << self

data/lib/openui/rails/engine.rb

@@ -27,6 +27,10 @@ module OpenUI
         ::Rails.autoloaders.main.inflector.inflect("openui" => "OpenUI")
       end
 
+      initializer "openui_rails.deprecator" do |app|
+        app.deprecators[:openui_rails] = OpenUI::Rails.deprecator
+      end
+
       # Expose the surface helper to every host view.
       initializer "openui_rails.view_helper" do
         ActiveSupport.on_load(:action_view) do

data/lib/openui/rails/instrumentation.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+module OpenUI
+  module Rails
+    # Internal publisher for the documented, content-free notification contract.
+    module Instrumentation # :nodoc:
+      def self.now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
+      def self.publish(name, started:, **metadata)
+        # Do not wrap application code in instrument's block: Active Support
+        # would attach the raw exception and its message if that code raised.
+        ActiveSupport::Notifications.instrument("#{name}.openui_rails",
+          **metadata, duration_ms: (now - started) * 1000)
+      rescue StandardError
+        # Observability must not change a business result or mask its exception.
+        nil
+      end
+
+      def self.action_error_code(error)
+        case error
+        when UnknownActionError then "unknown_action"
+        when UnauthorizedActionError then "unauthorized"
+        when StaleSurfaceError then "stale_surface"
+        when ReplayError then "replay"
+        when InvalidActionError then "invalid_action"
+        when Error then "error"
+        else "internal_error"
+        end
+      end
+    end
+  end
+end

data/lib/openui/rails/runtime_asset.rb

@@ -2,14 +2,15 @@
 
 module OpenUI
   module Rails
-    # Resolves the pinned OpenUI browser runtime and the integrity metadata the
-    # mount element advertises.
+    # Internal: resolves the pinned OpenUI browser runtime and the integrity
+    # metadata the mount element advertises. Configure assets through
+    # {Configuration}; this module is not part of the supported API.
     #
     # The runtime is version-pinned. Self-hosted (the default) points at a file
     # the install generator vendored into the host app; the external strategy
     # requires an explicit, exact-version URL so no floating CDN range is used
     # in production.
-    module RuntimeAsset
+    module RuntimeAsset # :nodoc:
       PINNED_VERSION = "0.2.1"
       FILE_PREFIX = "openui-browser-bundle"
 

data/lib/openui/rails/stream/accumulator.rb

@@ -20,8 +20,12 @@ module OpenUI
           @needs_snapshot = false
         end
 
-        # @return [Symbol] one of :applied, :duplicate, :snapshot, :completed,
-        #   :error, :ignored
+        # Apply one envelope for this message.
+        #
+        # @param envelope [Envelope]
+        #
+        # @return [Symbol] one of :applied, :duplicate, :gap, :snapshot,
+        #   :completed, :error, :ignored. After :gap, only a snapshot applies.
         def apply(envelope)
           return :ignored unless envelope.message_id == message_id
           unless envelope.snapshot?

data/lib/openui/rails/stream/bridge.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "openui/rails/instrumentation"
+
 module OpenUI
   module Rails
     module Stream
@@ -37,7 +39,8 @@ module OpenUI
 
         # Yield ordered envelopes for every chunk from a pull-based source.
         # Provider errors become a structured error envelope. Exceptions raised
-        # by the consumer block propagate to the caller.
+        # by the consumer block propagate to the caller. Pulling stops once the
+        # writer terminates, so an oversized response does not drain the source.
         #
         # @param source [#each] yields String chunks
         # @yieldparam envelope [Envelope]
@@ -58,6 +61,7 @@ module OpenUI
             # Transport/consumer failures are not provider failures. Let the
             # host retry or report them without recursively broadcasting errors.
             envelopes.each { |envelope| yield envelope }
+            return if writer.terminated?
           end
           writer.finish.each { |envelope| yield envelope }
         end
@@ -107,8 +111,15 @@ module OpenUI
             @total_bytes = 0
             @pending = +""
             @terminated = false
+            @started = Instrumentation.now
           end
 
+          # Whether a completion or error envelope has ended this stream. Stop
+          # reading the provider once it is true; later pushes are ignored.
+          #
+          # @return [Boolean]
+          def terminated? = @terminated
+
           # Append a chunk and return a delta once the pending threshold is reached.
           # A chunk that exceeds the total stream limit returns an error envelope.
           #
@@ -131,7 +142,8 @@ module OpenUI
             [ flush_delta ]
           end
 
-          # Flush pending text and emit the completion envelope once.
+          # Flush pending text and emit the completion envelope once. A terminal
+          # stream.openui_rails notification describes creation, not delivery.
           #
           # @return [Array<Envelope>] the final delta, if any, and completion
           def finish
@@ -144,10 +156,12 @@ module OpenUI
             )
             @sequence += 1
             @terminated = true
+            notify_termination("completed")
             envelopes
           end
 
           # Structured, PII-free error envelope for a provider/consumer failure.
+          # Calls `on_error` first; an exception raised by that hook is ignored.
           #
           # @param error [Exception]
           #
@@ -157,7 +171,7 @@ module OpenUI
           def error_for(error, code: "stream_failed")
             return nil if @terminated
 
-            @on_error&.call(error, message_id: @message_id)
+            notify_error(error)
 
             message = "stream failed (#{error.class})"
             message = "stream cancelled" if code == "stream_cancelled"
@@ -184,8 +198,22 @@ module OpenUI
             @sequence += 1
             @terminated = true
             @pending.clear
+            notify_termination(code == "stream_cancelled" ? "cancelled" : "failed", code)
             envelope
           end
+
+          # A failing host hook must not suppress the terminal frame or replace
+          # the provider error, matching notification subscriber isolation.
+          def notify_error(error)
+            @on_error&.call(error, message_id: @message_id)
+          rescue StandardError
+            nil
+          end
+
+          def notify_termination(outcome, code = nil)
+            Instrumentation.publish("stream", started: @started, outcome: outcome,
+              code: code, sequence: @sequence - 1, bytes: @total_bytes)
+          end
         end
       end
     end

data/lib/openui/rails/stream/broadcaster.rb

@@ -24,6 +24,7 @@ module OpenUI
         attr_reader :transport, :message_id, :library_version
 
         # Broadcast every envelope produced by an enumerable source of chunks.
+        # Iteration stops after a terminal envelope, such as a byte-limit error.
         #
         # @param source [#each] yields String chunks
         # @param options [Hash] arguments forwarded to the constructor
@@ -31,7 +32,10 @@ module OpenUI
         # @return [Broadcaster]
         def self.broadcast(source, **options)
           broadcaster = new(**options)
-          source.each { |chunk| broadcaster.push(chunk) }
+          source.each do |chunk|
+            broadcaster.push(chunk)
+            break if broadcaster.writer.terminated?
+          end
           broadcaster.finish
         end
 

data/lib/openui/rails/version.rb

@@ -1,5 +1,5 @@
 module OpenUI
   module Rails
-    VERSION = "0.4.0"
+    VERSION = "0.9.0"
   end
 end

data/lib/openui/rails.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_support/deprecation"
 require "openui/rails/version"
 
 module OpenUI
@@ -10,10 +11,18 @@ module OpenUI
   # into a Rails engine and keeps Rails authoritative for auth, tenancy and
   # persistence.
   module Rails
+    # Deprecator for APIs removed in openui-rails 1.0. The engine registers it
+    # in `Rails.application.deprecators`, so host deprecation settings apply.
+    #
+    # @return [ActiveSupport::Deprecation]
+    def self.deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("1.0", "openui-rails")
+    end
   end
 end
 
 require "openui/rails/errors"
+require "openui/rails/instrumentation"
 require "openui/rails/json_value"
 require "openui/rails/library_manifest"
 require "openui/rails/prompt_builder"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openui-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andy Wang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-20 00:00:00.000000000 Z
+date: 2026-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,7 @@ files:
 - lib/openui/rails/doctor.rb
 - lib/openui/rails/engine.rb
 - lib/openui/rails/errors.rb
+- lib/openui/rails/instrumentation.rb
 - lib/openui/rails/json_value.rb
 - lib/openui/rails/library_manifest.rb
 - lib/openui/rails/message.rb