Add Opencode::Instrumentation.notify; bump to 0.0.1.alpha2

Code review consensus from Tobi+Sandi: the empty-block call
'Opencode::Instrumentation.instrument(name, payload) { }' at fire-
and-forget call sites in opencode-rails is API smell. Tobi: 'two
named verbs are clearer than one verb with a vestigial block.'
Sandi: 'a method with a block parameter that's optional but expected
empty in some call sites is doing two things.'

Two emission shapes now:

  .instrument(name, payload) { ... }   # block; duration measured
  .notify(name, payload)                # fire-and-forget; no block

Both flow through the same adapter. The adapter still always
receives a block argument (some adapters key on it, e.g. AS::
Notifications.instrument requires a block) — .notify passes an
empty {}. Adapter return value is ignored for .notify (it returns
nil); .instrument continues to pass through the block's return.

Three new tests in smoke_test.rb:
  - no-op when no adapter set
  - forwards to adapter + verifies block presence + verifies that
    .notify returns nil (not the adapter's return)
  - works without a block at the call site

Also: switched gemspec metadata URLs from Gitea to GitHub. The gem
will eventually publish from github.com/ajaynomics/opencode-ruby —
the metadata now reflects that. (No actual GitHub remote push yet;
that's the user's manual step.)

15 tests pass, 32 assertions, 0 failures.
This commit is contained in:
2026-05-20 06:42:51 -07:00
parent ac0fe87940
commit abe69f1515
5 changed files with 93 additions and 3 deletions

View File

@@ -1,5 +1,23 @@
# Changelog
## 0.0.1.alpha2 — 2026-05-20
### Added
- `Opencode::Instrumentation.notify(name, payload)` — fire-and-forget
emission for point-in-time events that don't need duration measurement
(apply_patch.artifacts_dropped, session.recreated, etc.). Adapter
receives an empty block so AS::Notifications-shaped sinks see a
zero-duration event. Complements the existing block-form
`.instrument(name, payload) { ... }`.
### Why
The block-form `.instrument(name, payload) { }` with an empty block was
awkward at fire-and-forget call sites in opencode-rails. Two named
verbs (`instrument` for wrap-a-block, `notify` for fire-and-forget)
match the host-side mental model and read better at the call site.
## 0.0.1.alpha1 — Unreleased
First public alpha. HTTP + SSE client for OpenCode REST API.

View File

@@ -27,6 +27,20 @@ module Opencode
# If you wire a real adapter, the payload hash carries `:method` and
# `:path` for opencode.request. Other events may add fields in future
# versions; treat the payload as forward-compatible.
#
# Two emission shapes:
#
# .instrument(name, payload) { ... } — wrap a block; the duration
# of the block becomes part
# of the event (when the
# adapter is ActiveSupport::
# Notifications-shaped).
#
# .notify(name, payload) — fire-and-forget; no block,
# no duration. Use for
# point-in-time observations
# (e.g. "this artifact was
# dropped").
module Instrumentation
class << self
attr_accessor :adapter
@@ -40,5 +54,23 @@ module Opencode
adapter.call(name, payload) { yield }
end
# Fire-and-forget event. No block, no return value (the adapter's
# return is ignored). Use for point-in-time observations where
# duration doesn't apply — apply_patch.artifacts_dropped,
# session.recreated, etc.
#
# Implementation: invokes the same adapter as #instrument but with
# an empty block. Hosts that adapt to ActiveSupport::Notifications
# will see a zero-duration event; hosts that adapt to a structured-
# event API (Rails.event.notify, OpenTelemetry span events) can
# detect the empty-block convention if they need to. Most hosts
# don't need to care.
def self.notify(name, payload = {})
return unless adapter
adapter.call(name, payload) { }
nil
end
end
end

View File

@@ -1,5 +1,5 @@
# frozen_string_literal: true
module Opencode
VERSION = "0.0.1.alpha1"
VERSION = "0.0.1.alpha2"
end

View File

@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
OpenAPI) — pick this one if you want a small Ruby-idiomatic surface;
pick opencode_client if you want every endpoint with generated types.
DESC
spec.homepage = "https://gitea.krishnan.ca/ajaynomics/opencode-ruby"
spec.homepage = "https://github.com/ajaynomics/opencode-ruby"
spec.license = "MIT"
spec.required_ruby_version = ">= 3.2.0"
spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = spec.homepage
spec.metadata["changelog_uri"] = "#{spec.homepage}/src/branch/main/CHANGELOG.md"
spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
spec.files = Dir.glob("lib/**/*.rb") +

View File

@@ -166,4 +166,43 @@ class SmokeTest < Minitest::Test
Opencode::Instrumentation.adapter = nil
assert_equal 42, Opencode::Instrumentation.instrument("x") { 42 }
end
def test_Instrumentation_notify_no_op_without_adapter
Opencode::Instrumentation.adapter = nil
# Must not raise; must return nil.
assert_nil Opencode::Instrumentation.notify("x", foo: 1)
end
def test_Instrumentation_notify_forwards_to_adapter_fire_and_forget
events = []
Opencode::Instrumentation.adapter = ->(name, payload, &block) {
# block_given? is misleading inside a lambda — check the captured
# &block instead. AS::Notifications-shaped adapters always
# expect a block (it's what marks "event finished").
events << [ name, payload, !block.nil? ]
block.call if block
:adapter_return_ignored
}
result = Opencode::Instrumentation.notify("opencode.session.recreated", session_id: "ses_1")
# notify is fire-and-forget — it returns nil, NOT the adapter's
# return value (that's what .instrument does).
assert_nil result
assert_equal 1, events.size
name, payload, had_block = events.first
assert_equal "opencode.session.recreated", name
assert_equal({ session_id: "ses_1" }, payload)
assert had_block,
"notify must still pass an empty block — AS::Notifications-shaped " \
"adapters always expect one"
end
def test_Instrumentation_notify_does_not_require_block
Opencode::Instrumentation.adapter = ->(_name, _payload, &_block) { }
# Call site has no block — that's the whole point of notify.
Opencode::Instrumentation.notify("opencode.test", k: "v")
# If we got here without raising, the API is fire-and-forget as designed.
assert true
end
end