Initial opencode-ruby v0.0.1.alpha1 — hand-rolled HTTP+SSE client for OpenCode
Headline API:
reply = client.stream(session_id, "Explain monads") do |part|
print part["content"] if part["type"] == "text"
end
reply.full_text # final accumulated text
Sources ported from ajaynomics/ajent-rails lib/opencode/client/ after
the Phase-1+2 tier carve + Phase-2.5 boundary cleanup (see ajent-rails
PRs #840 and #843). Rails-runtime coupling stripped:
- Defaults read from ENV[OPENCODE_BASE_URL/SERVER_PASSWORD/TIMEOUT]
instead of Rails.application.config.x.opencode_blackline.*
- EventTraceable.timed_event(...) calls swapped for
Opencode::Instrumentation.instrument(...) — pluggable adapter
(default no-op) that callers wire to ActiveSupport::Notifications,
OpenTelemetry, stdout, etc.
Runtime dependency: activesupport (>= 6.1, < 9.0) for the small
core_ext surface (blank?/present?/presence/truncate/duplicable?/
megabytes). ActiveSupport is NOT Rails — it's a standalone helpers
gem that most Ruby apps already have transitively.
What's in the gem:
Opencode::Client HTTP + SSE client; #stream block-form API
Opencode::Reply SSE-event accumulator with observer protocol
Opencode::Reply::Result typed Struct value object
Opencode::ReplyObserver observer protocol module (no-op defaults)
Opencode::Prompts per-Reply pending question/permission registry
Opencode::Tracer callable that prefixes event names
Opencode::Instrumentation pluggable adapter
Opencode::ResponseParser wire-format extractors
Opencode::ToolPart canonical tool-part hash shape
Opencode::PartSource wire-vs-stream-only discriminator
Opencode::Todo todo status canonicalization
Opencode::Error (+ 7 subclasses)
What's out (per design D18 — wait for demand signal):
- acts_as_opencode_session concern
- ActiveRecord-backed session lifecycle
- rails generators
- opencode-rails as a separate gem
Instead, examples/conversation_recipe.rb ships as a ~140-line
plain-ActiveRecord blueprint demonstrating session lifecycle,
with_lock, update_columns mid-stream pattern, and CAS-safe finalize.
Tests: 12 runs, 25 assertions, 0 failures (smoke test against
WebMock-stubbed OpenCode endpoints — covers the postcard, error
model, Instrumentation, and Reply::Result shape).
Authored against ajent-rails commit 02954eeb (opencode-gem/phase-3-prep).
This commit is contained in:
169
test/opencode/smoke_test.rb
Normal file
169
test/opencode/smoke_test.rb
Normal file
@@ -0,0 +1,169 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "test_helper"
|
||||
|
||||
# End-to-end smoke test of the gem's public surface. Validates that the
|
||||
# headline `client.stream(...)` API + Reply::Result + error model + the
|
||||
# pluggable Instrumentation adapter all work against a fully mocked
|
||||
# OpenCode server. This is the test we'd point at in the README to
|
||||
# prove the postcard works.
|
||||
class SmokeTest < Minitest::Test
|
||||
BASE = "http://opencode.test"
|
||||
PASSWORD = "test-secret"
|
||||
SESSION_ID = "ses_smoke_1"
|
||||
|
||||
def setup
|
||||
@client = Opencode::Client.new(
|
||||
base_url: BASE,
|
||||
password: PASSWORD,
|
||||
timeout: 5
|
||||
)
|
||||
Opencode::Instrumentation.adapter = nil
|
||||
end
|
||||
|
||||
def test_VERSION_is_a_string
|
||||
assert_kind_of String, Opencode::VERSION
|
||||
assert_match(/\A\d+\.\d+\.\d+/, Opencode::VERSION)
|
||||
end
|
||||
|
||||
def test_constants_are_loaded
|
||||
assert_equal "Opencode::Client", Opencode::Client.name
|
||||
assert_equal "Opencode::Reply", Opencode::Reply.name
|
||||
assert_equal "Opencode::Reply::Result", Opencode::Reply::Result.name
|
||||
assert_equal "Opencode::Error", Opencode::Error.name
|
||||
assert Opencode::ConnectionError < Opencode::Error
|
||||
end
|
||||
|
||||
def test_health_endpoint_round_trip
|
||||
stub_request(:get, "#{BASE}/global/health")
|
||||
.to_return(status: 200, body: { healthy: true, version: "1.15.5" }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
response = @client.health
|
||||
assert_equal true, response[:healthy]
|
||||
assert_equal "1.15.5", response[:version]
|
||||
end
|
||||
|
||||
def test_create_session_returns_session_id
|
||||
stub_request(:post, "#{BASE}/session")
|
||||
.to_return(status: 200, body: { id: SESSION_ID, title: "smoke" }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
response = @client.create_session(title: "smoke", permissions: [])
|
||||
assert_equal SESSION_ID, response[:id]
|
||||
end
|
||||
|
||||
def test_send_message_async_returns_empty_body
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
response = @client.send_message_async(SESSION_ID, "ping")
|
||||
assert_equal({}, response)
|
||||
end
|
||||
|
||||
def test_stream_returns_typed_Reply_Result_with_full_text
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
sse = [
|
||||
{ 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 } }
|
||||
].map { |e| "data: #{e.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" })
|
||||
|
||||
stub_request(:get, "#{BASE}/session/#{SESSION_ID}/message")
|
||||
.to_return(status: 200, body: [].to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
parts_yielded = []
|
||||
reply = @client.stream(SESSION_ID, "ping") do |part|
|
||||
parts_yielded << part.dup
|
||||
end
|
||||
|
||||
assert_kind_of Opencode::Reply::Result, reply
|
||||
assert_equal "hello world", reply.full_text
|
||||
# Struct value object supports both message and hash style access.
|
||||
assert_equal "hello world", reply[:full_text]
|
||||
refute_empty parts_yielded
|
||||
end
|
||||
|
||||
def test_stream_block_is_optional
|
||||
stub_request(:post, "#{BASE}/session/#{SESSION_ID}/prompt_async")
|
||||
.to_return(status: 204, body: "")
|
||||
|
||||
sse = [
|
||||
{ type: "message.part.delta",
|
||||
properties: { sessionID: SESSION_ID, partID: "p1", field: "text", delta: "ack" } },
|
||||
{ type: "session.idle", properties: { sessionID: SESSION_ID } }
|
||||
].map { |e| "data: #{e.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" })
|
||||
|
||||
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")
|
||||
assert_equal "ack", reply.full_text
|
||||
end
|
||||
|
||||
def test_connection_refused_raises_ConnectionError
|
||||
stub_request(:get, "http://opencode.dead/global/health")
|
||||
.to_raise(Errno::ECONNREFUSED)
|
||||
|
||||
bad = Opencode::Client.new(base_url: "http://opencode.dead", timeout: 1)
|
||||
assert_raises(Opencode::ConnectionError) { bad.health }
|
||||
end
|
||||
|
||||
def test_404_on_session_endpoint_raises_SessionNotFoundError
|
||||
stub_request(:get, "#{BASE}/session/missing/message")
|
||||
.to_return(status: 404, body: { error: "not found" }.to_json,
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
assert_raises(Opencode::SessionNotFoundError) do
|
||||
@client.get_messages("missing")
|
||||
end
|
||||
end
|
||||
|
||||
def test_instrumentation_adapter_receives_request_events
|
||||
events = []
|
||||
Opencode::Instrumentation.adapter = ->(name, payload, &block) {
|
||||
events << [ name, payload ]
|
||||
block.call
|
||||
}
|
||||
|
||||
stub_request(:get, "#{BASE}/global/health")
|
||||
.to_return(status: 200, body: "{}",
|
||||
headers: { "Content-Type" => "application/json" })
|
||||
|
||||
@client.health
|
||||
assert events.any? { |name, _| name == "opencode.request" },
|
||||
"instrumentation adapter must receive opencode.request events"
|
||||
end
|
||||
|
||||
def test_Reply_distill_returns_typed_Result
|
||||
parts = [
|
||||
{ "type" => "text", "content" => "hi" },
|
||||
{ "type" => "text", "content" => "there" },
|
||||
{ "type" => "tool", "tool" => "read", "status" => "completed" }
|
||||
]
|
||||
result = Opencode::Reply.distill(parts)
|
||||
|
||||
assert_kind_of Opencode::Reply::Result, result
|
||||
assert_equal "hi\n\nthere", result.full_text
|
||||
assert_equal 1, result.tool_parts.size
|
||||
end
|
||||
|
||||
def test_Instrumentation_no_op_default_yields_block_value
|
||||
Opencode::Instrumentation.adapter = nil
|
||||
assert_equal 42, Opencode::Instrumentation.instrument("x") { 42 }
|
||||
end
|
||||
end
|
||||
10
test/test_helper.rb
Normal file
10
test/test_helper.rb
Normal file
@@ -0,0 +1,10 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
|
||||
|
||||
require "opencode-ruby"
|
||||
require "minitest/autorun"
|
||||
require "webmock/minitest"
|
||||
|
||||
# Tests run against WebMock-stubbed endpoints; never hit the network.
|
||||
WebMock.disable_net_connect!
|
||||
Reference in New Issue
Block a user