Compare commits
6 Commits
v0.0.1.alp
...
v0.0.1.alp
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a116b2708c | ||
| b16292723e | |||
| 8adc95985a | |||
| 5113a953db | |||
| de14d57634 | |||
| 2e866a618b |
23
.github/workflows/release.yml
vendored
Normal file
23
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
name: Push gem
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
|
||||
jobs:
|
||||
push:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
id-token: write
|
||||
environment: release
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
with:
|
||||
persist-credentials: false
|
||||
- uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: ruby
|
||||
bundler-cache: true
|
||||
- uses: rubygems/release-gem@v1
|
||||
4
.github/workflows/test.yml
vendored
4
.github/workflows/test.yml
vendored
@@ -14,7 +14,7 @@ jobs:
|
||||
matrix:
|
||||
ruby: ["3.2", "3.3", "3.4"]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Ruby ${{ matrix.ruby }}
|
||||
uses: ruby/setup-ruby@v1
|
||||
@@ -30,5 +30,5 @@ jobs:
|
||||
|
||||
- name: Verify gem loads after install
|
||||
run: |
|
||||
gem install --local opencode-ruby-*.gem
|
||||
gem install opencode-ruby-*.gem --no-document
|
||||
ruby -ropencode-ruby -e 'puts Opencode::VERSION'
|
||||
|
||||
33
CHANGELOG.md
33
CHANGELOG.md
@@ -1,5 +1,38 @@
|
||||
# Changelog
|
||||
|
||||
## 0.0.1.alpha6 - 2026-07-18
|
||||
|
||||
### Fixed
|
||||
|
||||
- Make `Opencode::Client#stream` wait for OpenCode's initial
|
||||
`server.connected` SSE readiness frame before submitting `prompt_async`,
|
||||
closing the fast-response window where a turn could emit events before the
|
||||
client was listening.
|
||||
- Keep prompt submission at-most-once across automatic SSE reconnects. A
|
||||
reconnect now reopens only the event stream; it never posts the user prompt
|
||||
again, and prompt transport failures remain visible to the caller.
|
||||
|
||||
## 0.0.1.alpha5 - 2026-07-15
|
||||
|
||||
### Added
|
||||
|
||||
- Extend `Opencode::Client#create_session` with OpenCode's native parent,
|
||||
agent, model, metadata, and workspace fields while preserving the existing
|
||||
title and permission call shape. Session model strings are encoded with the
|
||||
session endpoint's `{ providerID, id }` shape rather than the message
|
||||
endpoint's `{ providerID, modelID }` shape.
|
||||
|
||||
## 0.0.1.alpha4 - 2026-07-12
|
||||
|
||||
### Fixed
|
||||
|
||||
- End SSE streams on current OpenCode `session.status` idle events while
|
||||
retaining compatibility with legacy `session.idle` events.
|
||||
- Reconcile every assistant message in the current user turn after multi-step
|
||||
tool loops, preserving stream-only parts without duplicating final text.
|
||||
- Parse terminal tool parts in standalone Ruby clients without relying on the
|
||||
Rails-loaded `Object#in?` extension.
|
||||
|
||||
## 0.0.1.alpha3 - 2026-07-10
|
||||
|
||||
### Added
|
||||
|
||||
39
README.md
39
README.md
@@ -48,6 +48,27 @@ Multi-tenant apps construct multiple clients with different `base_url`s — each
|
||||
|
||||
## Core API
|
||||
|
||||
### Configured and parent-linked sessions
|
||||
|
||||
OpenCode can create a session under an existing parent and select its agent,
|
||||
model, metadata, workspace, and permission policy in the same request:
|
||||
|
||||
```ruby
|
||||
child = client.create_session(
|
||||
title: "Destination curator",
|
||||
parent_id: parent_session_id,
|
||||
agent: "destination-list-curator",
|
||||
model: "openai/gpt-5.5",
|
||||
metadata: { run_id: "9" },
|
||||
workspace_id: workspace_id,
|
||||
permissions: permission_rules
|
||||
)
|
||||
```
|
||||
|
||||
Model strings use OpenCode's `provider/model` form; a preformatted model hash
|
||||
with `providerID` and `id` keys is also accepted. These configured-session
|
||||
fields require OpenCode 1.16.1 or newer.
|
||||
|
||||
### Streaming (the headline)
|
||||
|
||||
```ruby
|
||||
@@ -65,6 +86,11 @@ reply.reasoning_text # => the model's hidden reasoning, if any
|
||||
reply.parts_json # => the full ordered parts array, ready for persistence
|
||||
```
|
||||
|
||||
`stream` waits for OpenCode's initial `server.connected` SSE readiness frame
|
||||
before it submits the asynchronous prompt. If the event connection drops
|
||||
afterward, the client reconnects only the subscription; it never reposts the
|
||||
prompt. This prevents both missed fast responses and duplicate turns.
|
||||
|
||||
### Synchronous send (no streaming)
|
||||
|
||||
```ruby
|
||||
@@ -89,7 +115,7 @@ If you need raw SSE events (every server tick, todo update, prompt asked/replied
|
||||
|
||||
```ruby
|
||||
client.stream_events(session_id: session_id) do |event|
|
||||
puts event[:type] # "message.part.delta", "todo.updated", "session.idle", ...
|
||||
puts event[:type] # "message.part.delta", "todo.updated", "session.status", ...
|
||||
end
|
||||
```
|
||||
|
||||
@@ -112,7 +138,7 @@ begin
|
||||
rescue Opencode::ConnectionError # server unreachable
|
||||
rescue Opencode::TimeoutError # client-side timeout
|
||||
rescue Opencode::SessionNotFoundError # 404 on a session
|
||||
rescue Opencode::StaleSessionError # session.idle never arrived
|
||||
rescue Opencode::StaleSessionError # no session event arrived after the prompt
|
||||
rescue Opencode::IdleStreamError # mid-turn SSE wedge
|
||||
rescue Opencode::ServerError # 5xx
|
||||
rescue Opencode::BadRequestError # 4xx other than 404
|
||||
@@ -166,7 +192,14 @@ bundle install
|
||||
bundle exec rake test
|
||||
```
|
||||
|
||||
16-test smoke covers Client end-to-end against WebMock-stubbed OpenCode endpoints.
|
||||
The smoke suite covers Client end-to-end against WebMock-stubbed OpenCode
|
||||
endpoints, including subscription-before-prompt ordering and
|
||||
reconnect-without-repost.
|
||||
|
||||
Releases use RubyGems trusted publishing. After the repository's
|
||||
`release.yml` workflow is registered as a trusted publisher with the `release`
|
||||
environment, pushing a `v*` tag builds, attests, and publishes the gem without
|
||||
a long-lived RubyGems API key.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -25,8 +25,24 @@ module Opencode
|
||||
@workspace = workspace
|
||||
end
|
||||
|
||||
def create_session(title: nil, permissions: nil)
|
||||
body = { title: title, permission: permissions }.compact
|
||||
def create_session(
|
||||
title: nil,
|
||||
permissions: nil,
|
||||
parent_id: nil,
|
||||
agent: nil,
|
||||
model: nil,
|
||||
metadata: nil,
|
||||
workspace_id: nil
|
||||
)
|
||||
body = {
|
||||
title: title,
|
||||
permission: permissions,
|
||||
parentID: parent_id,
|
||||
agent: agent,
|
||||
model: format_session_model(model),
|
||||
metadata: metadata,
|
||||
workspaceID: workspace_id
|
||||
}.compact
|
||||
post("/session", body)
|
||||
end
|
||||
|
||||
@@ -115,21 +131,35 @@ module Opencode
|
||||
on_activity_tick: nil,
|
||||
&block
|
||||
)
|
||||
send_message_async(
|
||||
session_id, text,
|
||||
model: model, agent: agent, system: system, message_id: message_id
|
||||
)
|
||||
|
||||
reply = Opencode::Reply.new
|
||||
reply.add_observer(StreamBlockObserver.new(&block)) if block_given?
|
||||
|
||||
stream_events(
|
||||
# Opening the event stream after prompt_async leaves a race where a fast
|
||||
# turn can emit (and finish) before the client is subscribed. Wait for
|
||||
# OpenCode's initial server.connected SSE frame, then submit the prompt
|
||||
# exactly once. Reconnects invoke on_subscribed again, so mark the attempt
|
||||
# before the POST: an ambiguous prompt response must never cause the same
|
||||
# turn to be submitted twice.
|
||||
prompt_attempted = false
|
||||
on_subscribed = lambda do
|
||||
next false if prompt_attempted
|
||||
|
||||
prompt_attempted = true
|
||||
send_message_async(
|
||||
session_id, text,
|
||||
model: model, agent: agent, system: system, message_id: message_id
|
||||
)
|
||||
true
|
||||
end
|
||||
|
||||
consume_event_stream(
|
||||
session_id: session_id,
|
||||
timeout: stream_timeout,
|
||||
first_event_timeout: first_event_timeout,
|
||||
idle_stream_timeout: idle_stream_timeout,
|
||||
reply: reply,
|
||||
on_activity_tick: on_activity_tick
|
||||
on_activity_tick: on_activity_tick,
|
||||
on_subscribed: on_subscribed
|
||||
) do |event|
|
||||
reply.apply(event)
|
||||
end
|
||||
@@ -237,8 +267,10 @@ module Opencode
|
||||
].freeze
|
||||
|
||||
# Opens SSE connection to GET /event, yields parsed events filtered by session_id.
|
||||
# Blocks until session goes idle or timeout, reconnecting across dropped
|
||||
# event-stream connections.
|
||||
# Blocks until the session reports idle or timeout, reconnecting across
|
||||
# dropped event-stream connections. Current OpenCode emits
|
||||
# `session.status` with `status.type == "idle"`; older versions emitted the
|
||||
# standalone `session.idle` event, so both remain terminal.
|
||||
#
|
||||
# first_event_timeout: seconds to wait for a session-specific event before
|
||||
# declaring the session stale. Server heartbeats don't count — they're global
|
||||
@@ -267,6 +299,20 @@ module Opencode
|
||||
def stream_events(session_id:, timeout: 600, first_event_timeout: 120,
|
||||
idle_stream_timeout: nil,
|
||||
reply: nil, on_activity_tick: nil, &block)
|
||||
consume_event_stream(
|
||||
session_id: session_id,
|
||||
timeout: timeout,
|
||||
first_event_timeout: first_event_timeout,
|
||||
idle_stream_timeout: idle_stream_timeout,
|
||||
reply: reply,
|
||||
on_activity_tick: on_activity_tick,
|
||||
&block
|
||||
)
|
||||
end
|
||||
|
||||
private def consume_event_stream(session_id:, timeout:, first_event_timeout:,
|
||||
idle_stream_timeout:, reply:, on_activity_tick:,
|
||||
on_subscribed: nil, &block)
|
||||
uri = build_uri("/event")
|
||||
deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout
|
||||
first_event_deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + first_event_timeout
|
||||
@@ -301,6 +347,8 @@ module Opencode
|
||||
http.open_timeout = 10
|
||||
http.read_timeout = 30
|
||||
|
||||
subscription_callback_error = nil
|
||||
subscription_ready = on_subscribed.nil?
|
||||
begin
|
||||
buffer = String.new
|
||||
|
||||
@@ -334,6 +382,36 @@ module Opencode
|
||||
event = parse_sse_event(raw_event, session_id)
|
||||
next unless event
|
||||
|
||||
unless subscription_ready
|
||||
# Every supported OpenCode server starts /event with this
|
||||
# frame. Receiving it proves the stream body is flowing; on
|
||||
# current servers the bus listener is registered eagerly,
|
||||
# and on older lazy-stream servers it is the strongest
|
||||
# available readiness handshake before prompting.
|
||||
next unless event[:type] == "server.connected"
|
||||
|
||||
begin
|
||||
turn_started = on_subscribed.call
|
||||
rescue StandardError => error
|
||||
# Prompt submission happens inside the open SSE response.
|
||||
# Do not mistake its transport failure for an SSE disconnect
|
||||
# and hide it behind a reconnect/first-event timeout.
|
||||
subscription_callback_error = error
|
||||
raise
|
||||
end
|
||||
if turn_started
|
||||
# Before this fix stream_events began only after the prompt
|
||||
# POST returned. Preserve those timeout semantics: the turn
|
||||
# and first-session-event windows begin after prompt_async
|
||||
# succeeds, not while establishing the readiness handshake.
|
||||
started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
|
||||
deadline = started_at + timeout
|
||||
first_event_deadline = started_at + first_event_timeout
|
||||
last_meaningful_event_at = started_at
|
||||
end
|
||||
subscription_ready = true
|
||||
end
|
||||
|
||||
unless event[:type]&.start_with?("server.")
|
||||
received_session_event = true
|
||||
last_meaningful_event_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
|
||||
@@ -345,13 +423,16 @@ module Opencode
|
||||
# the reaper doesn't kill it mid-wait.
|
||||
on_activity_tick&.call(event)
|
||||
block.call(event)
|
||||
return if event[:type] == "session.idle"
|
||||
return if terminal_session_event?(event)
|
||||
end
|
||||
end
|
||||
end
|
||||
rescue *TRANSIENT_SSE_ERRORS
|
||||
raise if subscription_callback_error
|
||||
|
||||
# Treat transport-level SSE disconnects like clean EOF: reconnect
|
||||
# until session.idle, the overall timeout, or first-event timeout.
|
||||
# until an idle session event, the overall timeout, or first-event
|
||||
# timeout.
|
||||
ensure
|
||||
begin
|
||||
http&.finish if http&.started?
|
||||
@@ -385,13 +466,16 @@ module Opencode
|
||||
# the caller's reply is still a usable Result either way.
|
||||
def merge_final_exchange(session_id, reply)
|
||||
exchange = get_messages(session_id)
|
||||
last_assistant = Array(exchange).reverse_each.find do |message|
|
||||
message.dig(:info, :role) == "assistant"
|
||||
end
|
||||
return unless last_assistant
|
||||
polled = current_turn_parts(exchange)
|
||||
return if polled.empty?
|
||||
|
||||
polled = Opencode::ResponseParser.extract_interleaved_parts(last_assistant)
|
||||
reply.sync_recovered_parts(polled) if polled.any?
|
||||
merged = merge_stream_only_parts(reply.result.parts_json, polled)
|
||||
reply.sync_recovered_parts(merged)
|
||||
# sync_recovered_parts intentionally never deletes live parts because it
|
||||
# is also used during mid-stream recovery. This is the terminal poll, so
|
||||
# the wire snapshot is authoritative: remove any replayed trailing wire
|
||||
# part after observers have seen recovered additions/updates.
|
||||
reply.replace_parts(merged) unless reply.result.parts_json == merged
|
||||
rescue Opencode::Error
|
||||
# Stream's result is still complete; the merge was a polish, not a
|
||||
# requirement.
|
||||
@@ -408,6 +492,45 @@ module Opencode
|
||||
deadline
|
||||
end
|
||||
|
||||
def terminal_session_event?(event)
|
||||
return true if event[:type] == "session.idle"
|
||||
return false unless event[:type] == "session.status"
|
||||
|
||||
status = event.dig(:properties, :status)
|
||||
status = status[:type] || status["type"] if status.is_a?(Hash)
|
||||
status == "idle"
|
||||
end
|
||||
|
||||
# OpenCode persists one assistant message per model step. A tool loop can
|
||||
# therefore produce several assistant messages for one user turn (for
|
||||
# example skill -> task -> final text). Reconcile the complete current turn
|
||||
# instead of aligning the live parts array with only the last assistant
|
||||
# message, which corrupts tool parts and duplicates final text.
|
||||
def current_turn_parts(exchange)
|
||||
messages = Array(exchange)
|
||||
last_user_index = messages.rindex { |message| message.dig(:info, :role) == "user" }
|
||||
current_turn = last_user_index ? messages.drop(last_user_index + 1) : messages
|
||||
|
||||
current_turn
|
||||
.select { |message| message.dig(:info, :role) == "assistant" }
|
||||
.flat_map { |message| Opencode::ResponseParser.extract_interleaved_parts(message) }
|
||||
end
|
||||
|
||||
def merge_stream_only_parts(stream_parts, wire_parts)
|
||||
remaining_wire = Array(wire_parts).dup
|
||||
merged = []
|
||||
|
||||
Array(stream_parts).each do |part|
|
||||
if Opencode::PartSource.stream_only?(part)
|
||||
merged << part
|
||||
elsif remaining_wire.any?
|
||||
merged << remaining_wire.shift
|
||||
end
|
||||
end
|
||||
|
||||
merged.concat(remaining_wire)
|
||||
end
|
||||
|
||||
def prompt_payload(text, parts:, model:, agent:, system:, message_id:, no_reply:, tools:, format:, variant:)
|
||||
message_parts = parts || [ { type: "text", text: text } ]
|
||||
{
|
||||
@@ -431,6 +554,14 @@ module Opencode
|
||||
{ providerID: provider, modelID: model_id }
|
||||
end
|
||||
|
||||
def format_session_model(model)
|
||||
return nil unless model
|
||||
return model if model.is_a?(Hash)
|
||||
|
||||
provider, model_id = model.split("/", 2)
|
||||
{ providerID: provider, id: model_id }
|
||||
end
|
||||
|
||||
def post(path, body)
|
||||
uri = build_uri(path)
|
||||
request = Net::HTTP::Post.new(uri)
|
||||
|
||||
@@ -27,7 +27,7 @@ module Opencode
|
||||
def self.extract_tool_summary(response_body)
|
||||
parts = response_body[:parts] || []
|
||||
parts
|
||||
.select { |p| p[:type] == "tool" && p.dig(:state, :status).in?(TERMINAL_STATUSES) }
|
||||
.select { |p| p[:type] == "tool" && TERMINAL_STATUSES.include?(p.dig(:state, :status)) }
|
||||
.map { |p| build_tool_summary(p) }
|
||||
end
|
||||
|
||||
@@ -42,7 +42,7 @@ module Opencode
|
||||
{ "type" => "reasoning", "content" => part[:text] }
|
||||
when "tool"
|
||||
status = part.dig(:state, :status)
|
||||
next unless status.in?(TERMINAL_STATUSES)
|
||||
next unless TERMINAL_STATUSES.include?(status)
|
||||
|
||||
build_tool_summary(part)
|
||||
else
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Opencode
|
||||
VERSION = "0.0.1.alpha3"
|
||||
VERSION = "0.0.1.alpha6"
|
||||
end
|
||||
|
||||
@@ -11,6 +11,7 @@ class SmokeTest < Minitest::Test
|
||||
BASE = "http://opencode.test"
|
||||
PASSWORD = "test-secret"
|
||||
SESSION_ID = "ses_smoke_1"
|
||||
CONNECTED_EVENT = { type: "server.connected", properties: {} }.freeze
|
||||
|
||||
def setup
|
||||
@client = Opencode::Client.new(
|
||||
@@ -46,6 +47,7 @@ class SmokeTest < Minitest::Test
|
||||
|
||||
def test_create_session_returns_session_id
|
||||
stub_request(:post, "#{BASE}/session")
|
||||
.with(body: { title: "smoke", permission: [] }.to_json)
|
||||
.to_return(status: 200, body: { id: SESSION_ID, title: "smoke" }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
@@ -53,6 +55,51 @@ class SmokeTest < Minitest::Test
|
||||
assert_equal SESSION_ID, response[:id]
|
||||
end
|
||||
|
||||
def test_create_session_sends_native_child_and_configuration_fields
|
||||
permissions = [ { permission: "skill", pattern: "*", action: "deny" } ]
|
||||
expected_body = {
|
||||
title: "curator",
|
||||
permission: permissions,
|
||||
parentID: "ses_parent",
|
||||
agent: "destination-list-curator",
|
||||
model: { providerID: "openrouter", id: "anthropic/claude-sonnet-4" },
|
||||
metadata: { run: "9" },
|
||||
workspaceID: "wrk_1"
|
||||
}
|
||||
|
||||
stub_request(:post, "#{BASE}/session")
|
||||
.with(body: expected_body.to_json)
|
||||
.to_return(status: 200, body: { id: SESSION_ID }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
response = @client.create_session(
|
||||
title: "curator",
|
||||
permissions: permissions,
|
||||
parent_id: "ses_parent",
|
||||
agent: "destination-list-curator",
|
||||
model: "openrouter/anthropic/claude-sonnet-4",
|
||||
metadata: { run: "9" },
|
||||
workspace_id: "wrk_1"
|
||||
)
|
||||
|
||||
assert_equal SESSION_ID, response[:id]
|
||||
assert_requested :post, "#{BASE}/session", body: expected_body.to_json, times: 1
|
||||
end
|
||||
|
||||
def test_create_session_preserves_a_preformatted_model
|
||||
model = { providerID: "openai", id: "gpt-5.5", variant: "high" }
|
||||
|
||||
stub_request(:post, "#{BASE}/session")
|
||||
.with(body: { model: model }.to_json)
|
||||
.to_return(status: 200, body: { id: SESSION_ID }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
response = @client.create_session(model: model)
|
||||
|
||||
assert_equal SESSION_ID, response[:id]
|
||||
assert_requested :post, "#{BASE}/session", body: { model: model }.to_json, times: 1
|
||||
end
|
||||
|
||||
def test_update_session_patches_permissions_and_returns_the_updated_session
|
||||
permissions = [
|
||||
{ permission: "skill", pattern: "*", action: "deny" },
|
||||
@@ -84,11 +131,12 @@ class SmokeTest < Minitest::Test
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
sse = [
|
||||
CONNECTED_EVENT,
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p1", field: "text", delta: "hello " } },
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p1", field: "text", delta: "world" } },
|
||||
{ type: "session.idle", properties: { sessionID: SESSION_ID } }
|
||||
{ type: "session.status", properties: { sessionID: SESSION_ID, status: { type: "idle" } } }
|
||||
].map { |e| "data: #{e.to_json}\n\n" }.join
|
||||
|
||||
stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
@@ -111,11 +159,164 @@ class SmokeTest < Minitest::Test
|
||||
refute_empty parts_yielded
|
||||
end
|
||||
|
||||
def test_stream_waits_for_server_connected_before_posting_the_prompt
|
||||
request_order = []
|
||||
connection_count = 0
|
||||
terminal_event = {
|
||||
type: "session.status",
|
||||
properties: { sessionID: SESSION_ID, status: { type: "idle" } }
|
||||
}
|
||||
|
||||
stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return do
|
||||
connection_count += 1
|
||||
request_order << :sse_accepted
|
||||
events = if connection_count == 1
|
||||
[ { type: "server.heartbeat", properties: {} } ]
|
||||
else
|
||||
[ CONNECTED_EVENT, terminal_event ]
|
||||
end
|
||||
{
|
||||
status: 200,
|
||||
body: events.map { |event| "data: #{event.to_json}\n\n" }.join,
|
||||
headers: { "Content-Type" => "text/event-stream" }
|
||||
}
|
||||
end
|
||||
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return do
|
||||
request_order << :prompt
|
||||
{ status: 204, body: "" }
|
||||
end
|
||||
|
||||
stub_request(:get, "#{BASE}/session/#{SESSION_ID}/message")
|
||||
.to_return(status: 200, body: [].to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
@client.stream(SESSION_ID, "ping", stream_timeout: 1, first_event_timeout: 1)
|
||||
|
||||
assert_equal [ :sse_accepted, :sse_accepted, :prompt ], request_order
|
||||
end
|
||||
|
||||
def test_stream_does_not_post_when_sse_subscription_is_rejected
|
||||
stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return(status: 503, body: "unavailable")
|
||||
prompt = stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
error = assert_raises(Opencode::ServerError) do
|
||||
@client.stream(SESSION_ID, "ping", stream_timeout: 1, first_event_timeout: 1)
|
||||
end
|
||||
|
||||
assert_match "SSE connection failed: HTTP 503", error.message
|
||||
assert_not_requested prompt
|
||||
end
|
||||
|
||||
def test_stream_surfaces_prompt_timeout_without_reconnecting
|
||||
event_stream = stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return(status: 200, body: "data: #{CONNECTED_EVENT.to_json}\n\n",
|
||||
headers: { "Content-Type" => "text/event-stream" })
|
||||
prompt = stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_raise(Net::ReadTimeout.new("prompt timed out"))
|
||||
|
||||
error = assert_raises(Opencode::TimeoutError) do
|
||||
@client.stream(SESSION_ID, "ping", stream_timeout: 1, first_event_timeout: 1)
|
||||
end
|
||||
|
||||
assert_match "OpenCode timeout after 5s", error.message
|
||||
assert_requested event_stream, times: 1
|
||||
assert_requested prompt, times: 1
|
||||
end
|
||||
|
||||
def test_stream_reconnects_without_reposting_the_prompt
|
||||
first_connection = [
|
||||
CONNECTED_EVENT,
|
||||
{ type: "server.heartbeat", properties: {} }
|
||||
]
|
||||
second_connection = [
|
||||
CONNECTED_EVENT,
|
||||
{
|
||||
type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p1", field: "text", delta: "once" }
|
||||
},
|
||||
{
|
||||
type: "session.status",
|
||||
properties: { sessionID: SESSION_ID, status: { type: "idle" } }
|
||||
}
|
||||
]
|
||||
|
||||
event_stream = stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return(
|
||||
{
|
||||
status: 200,
|
||||
body: first_connection.map { |event| "data: #{event.to_json}\n\n" }.join,
|
||||
headers: { "Content-Type" => "text/event-stream" }
|
||||
},
|
||||
{
|
||||
status: 200,
|
||||
body: second_connection.map { |event| "data: #{event.to_json}\n\n" }.join,
|
||||
headers: { "Content-Type" => "text/event-stream" }
|
||||
}
|
||||
)
|
||||
prompt = stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
stub_request(:get, "#{BASE}/session/#{SESSION_ID}/message")
|
||||
.to_return(status: 200, body: [].to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
reply = @client.stream(SESSION_ID, "ping", stream_timeout: 1, first_event_timeout: 1)
|
||||
|
||||
assert_equal "once", reply.full_text
|
||||
assert_requested event_stream, times: 2
|
||||
assert_requested prompt, times: 1
|
||||
end
|
||||
|
||||
def test_stream_events_preserves_question_and_permission_wait_state
|
||||
events = [
|
||||
{
|
||||
type: "question.asked",
|
||||
properties: { id: "que_1", sessionID: SESSION_ID, questions: [] }
|
||||
},
|
||||
{
|
||||
type: "question.replied",
|
||||
properties: { requestID: "que_1", sessionID: SESSION_ID, answers: [ [ "yes" ] ] }
|
||||
},
|
||||
{
|
||||
type: "permission.asked",
|
||||
properties: { id: "per_1", sessionID: SESSION_ID, permission: "bash" }
|
||||
},
|
||||
{
|
||||
type: "permission.replied",
|
||||
properties: { requestID: "per_1", sessionID: SESSION_ID, reply: "once" }
|
||||
},
|
||||
{
|
||||
type: "session.status",
|
||||
properties: { sessionID: SESSION_ID, status: { type: "idle" } }
|
||||
}
|
||||
]
|
||||
stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return(
|
||||
status: 200,
|
||||
body: events.map { |event| "data: #{event.to_json}\n\n" }.join,
|
||||
headers: { "Content-Type" => "text/event-stream" }
|
||||
)
|
||||
|
||||
reply = Opencode::Reply.new
|
||||
wait_states = []
|
||||
@client.stream_events(session_id: SESSION_ID, reply: reply) do |event|
|
||||
reply.apply(event)
|
||||
wait_states << reply.prompt_blocked?
|
||||
end
|
||||
|
||||
assert_equal [ true, false, true, false, false ], wait_states
|
||||
end
|
||||
|
||||
def test_stream_block_is_optional
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
sse = [
|
||||
CONNECTED_EVENT,
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p1", field: "text", delta: "ack" } },
|
||||
{ type: "session.idle", properties: { sessionID: SESSION_ID } }
|
||||
@@ -133,6 +334,60 @@ class SmokeTest < Minitest::Test
|
||||
assert_equal "ack", reply.full_text
|
||||
end
|
||||
|
||||
def test_stream_merges_a_multi_assistant_tool_loop_without_duplicate_text
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
skill_part = {
|
||||
id: "p_skill", sessionID: SESSION_ID, messageID: "m_skill",
|
||||
type: "tool", tool: "skill", callID: "call_skill",
|
||||
state: { status: "completed", input: { name: "travelwolf-itinerary" }, output: "loaded" }
|
||||
}
|
||||
task_part = {
|
||||
id: "p_task", sessionID: SESSION_ID, messageID: "m_task",
|
||||
type: "tool", tool: "task", callID: "call_task",
|
||||
state: {
|
||||
status: "completed",
|
||||
input: { subagent_type: "itinerary-planner" },
|
||||
output: "{\"days\":[]}",
|
||||
metadata: { sessionId: "ses_child" }
|
||||
}
|
||||
}
|
||||
sse = [
|
||||
CONNECTED_EVENT,
|
||||
{ type: "todo.updated", properties: { sessionID: SESSION_ID, todos: [] } },
|
||||
{ type: "message.part.updated", properties: { sessionID: SESSION_ID, part: skill_part } },
|
||||
{ type: "message.part.updated", properties: { sessionID: SESSION_ID, part: task_part } },
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p_text", field: "text", delta: "SUBAGENT_OK" } },
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p_text_replay", field: "text", delta: "SUBAGENT_OK" } },
|
||||
{ type: "session.status", properties: { sessionID: SESSION_ID, status: { type: "idle" } } }
|
||||
].map { |event| "data: #{event.to_json}\n\n" }.join
|
||||
|
||||
stub_request(:get, %r{#{Regexp.escape(BASE)}/event(\?.*)?\z})
|
||||
.to_return(status: 200, body: sse,
|
||||
headers: { "Content-Type" => "text/event-stream" })
|
||||
|
||||
exchange = [
|
||||
{ info: { role: "user" }, parts: [ { type: "text", text: "previous" } ] },
|
||||
{ info: { role: "assistant" }, parts: [ { type: "text", text: "previous answer" } ] },
|
||||
{ info: { role: "user" }, parts: [ { type: "text", text: "plan" } ] },
|
||||
{ info: { role: "assistant" }, parts: [ skill_part ] },
|
||||
{ info: { role: "assistant" }, parts: [ task_part ] },
|
||||
{ info: { role: "assistant" }, parts: [ { type: "text", text: "SUBAGENT_OK" } ] }
|
||||
]
|
||||
stub_request(:get, "#{BASE}/session/#{SESSION_ID}/message")
|
||||
.to_return(status: 200, body: exchange.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
reply = @client.stream(SESSION_ID, "plan", stream_timeout: 1)
|
||||
|
||||
assert_equal "SUBAGENT_OK", reply.full_text
|
||||
assert_equal %w[todowrite skill task], reply.tool_parts.map { |part| part.fetch("tool") }
|
||||
assert_equal "ses_child", reply.tool_parts.last.dig("metadata", "sessionId")
|
||||
end
|
||||
|
||||
def test_connection_refused_raises_ConnectionError
|
||||
stub_request(:get, "http://opencode.dead/global/health")
|
||||
.to_raise(Errno::ECONNREFUSED)
|
||||
|
||||
Reference in New Issue
Block a user