feat(api): support /global/event streaming

Add normalization for /global/event envelopes (normalize_global_event) to
convert the new global event shape and sync events into the legacy event

This should fix #374

Author: sudo-tee

README.md

@@ -1,7 +1,3 @@
-⚠️ There is a blocking issue with the opencode CLI versions `1.14.42` and up that prevent opencode.nvim from rendering streaming events. Please downgrade to `1.14.41` or wait for a fix. Follow the issue here:
-
-https://github.com/anomalyco/opencode/issues/26697
-
 # 🤖 opencode.nvim
 
 > neovim frontend for opencode - a terminal-based AI coding agent

lua/opencode/api_client.lua

@@ -4,6 +4,7 @@ local url_encode = require('opencode.util').url_encode
 local apply_path_map = require('opencode.util').apply_path_map
 local reverse_transform_paths_recursive = require('opencode.util').reverse_transform_paths_recursive
 local transform_paths_recursive = require('opencode.util').transform_paths_recursive
+local is_version_greater_or_equal = require('opencode.util').is_version_greater_or_equal
 
 --- @class OpencodeApiClient
 --- @field base_url string The base URL of the opencode server
@@ -19,6 +20,51 @@ function OpencodeApiClient.new(base_url)
   }, OpencodeApiClient)
 end
 
+---Convert /global/event envelopes into the legacy event shape consumed by the
+---rest of the plugin.
+---@param event table|nil
+---@return table|nil
+local function normalize_global_event(event)
+  if type(event) ~= 'table' then
+    return nil
+  end
+
+  local payload = event.payload
+  if type(payload) ~= 'table' then
+    return nil
+  end
+
+  if payload.type == 'sync' then
+    local sync_event = payload.syncEvent
+    if type(sync_event) ~= 'table' then
+      return nil
+    end
+
+    local event_type = sync_event.type
+    if type(event_type) ~= 'string' then
+      return nil
+    end
+
+    event_type = event_type:gsub('%.%d+$', '')
+
+    return {
+      id = sync_event.id or payload.id,
+      type = event_type,
+      properties = sync_event.data,
+    }
+  end
+
+  if type(payload.type) ~= 'string' then
+    return nil
+  end
+
+  return {
+    id = payload.id,
+    type = payload.type,
+    properties = payload.properties,
+  }
+end
+
 ---Ensure that base_url is set. Even thought we're subscribed to
 ---state.opencode_server, we still need this check because
 ---it's possible someone will try to make an api call in their event
@@ -447,7 +493,17 @@ end
 --- @param on_event fun(event: table) Event callback
 --- @return table The streaming job handle
 function OpencodeApiClient:subscribe_to_events(directory, on_event)
-  self:_ensure_base_url()
+  -- Make sure we have a base URL before attempting to subscribe. If we
+  -- cannot determine a base URL (server not running), return nil so
+  -- callers can handle the absence of a subscription without an error.
+  if not self:_ensure_base_url() then
+    return nil
+  end
+
+  if is_version_greater_or_equal(state.opencode_cli_version, '1.14.42') then
+    return self:_subscribe_to_global_events(directory, on_event)
+  end
+
   local url = self.base_url .. '/event'
   if directory then
     local mapped_directory = apply_path_map(directory)
@@ -464,6 +520,39 @@ function OpencodeApiClient:subscribe_to_events(directory, on_event)
   end)
 end
 
+--- Subscribe to events (streaming)
+--- @param directory string|nil Directory path
+--- @param on_event fun(event: table) Event callback
+--- @return table The streaming job handle
+function OpencodeApiClient:_subscribe_to_global_events(directory, on_event)
+  -- Ensure base_url is available. If not, return nil instead of erroring.
+  if not self:_ensure_base_url() then
+    return nil
+  end
+
+  if not is_version_greater_or_equal(state.opencode_cli_version, '1.14.42') then
+    error('subscribe_to_global_events should not be called directly')
+  end
+
+  local url = self.base_url .. '/global/event'
+  if directory then
+    local mapped_directory = apply_path_map(directory)
+    url = url .. '?directory=' .. url_encode(mapped_directory)
+  end
+
+  return server_job.stream_api(url, 'GET', nil, function(chunk)
+    chunk = chunk:gsub('^data:%s*', '')
+    local ok, event = pcall(vim.json.decode, vim.trim(chunk))
+    if ok and event then
+      local normalized_event = normalize_global_event(event)
+      if normalized_event then
+        local transformed_event = reverse_transform_paths_recursive(normalized_event)
+        on_event(transformed_event --[[@as table]])
+      end
+    end
+  end)
+end
+
 -- Tool endpoints
 
 --- List all tool IDs (including built-in and dynamically registered)

tests/unit/api_client_spec.lua

@@ -2,6 +2,18 @@ local api_client = require('opencode.api_client')
 local assert = require('luassert')
 
 describe('api_client', function()
+  local original_cli_version
+  local state
+
+  before_each(function()
+    state = require('opencode.state')
+    original_cli_version = state.opencode_cli_version
+  end)
+
+  after_each(function()
+    state.jobs.set_opencode_cli_version(original_cli_version)
+  end)
+
   it('should create a new client instance', function()
     local client = api_client.new('http://localhost:8080')
     assert.is_not_nil(client)
@@ -104,4 +116,106 @@ describe('api_client', function()
     server_job.call_api = original_call_api
     vim.fn.getcwd = original_cwd
   end)
+
+  it('normalizes /global/event payloads into legacy event shape', function()
+    local server_job = require('opencode.server_job')
+    local original_stream_api = server_job.stream_api
+    state.jobs.set_opencode_cli_version('1.14.42')
+
+    local received = {}
+
+    server_job.stream_api = function(_, _, _, on_chunk)
+      on_chunk(
+        'data: ' .. vim.json.encode({
+          payload = {
+            id = 'evt_1',
+            type = 'session.status',
+            properties = {
+              sessionID = 'ses_1',
+              status = { type = 'busy' },
+            },
+          },
+        })
+      )
+
+      return { shutdown = function() end }
+    end
+
+    local client = api_client.new('http://localhost:8080')
+    client:subscribe_to_events('/some/directory', function(event)
+      table.insert(received, event)
+    end)
+
+    assert.same({
+      {
+        id = 'evt_1',
+        type = 'session.status',
+        properties = {
+          sessionID = 'ses_1',
+          status = { type = 'busy' },
+        },
+      },
+    }, received)
+
+    server_job.stream_api = original_stream_api
+  end)
+
+  it('normalizes /global/event sync payloads into legacy event shape', function()
+    local server_job = require('opencode.server_job')
+    local original_stream_api = server_job.stream_api
+    state.jobs.set_opencode_cli_version('1.14.42')
+
+    local received = {}
+
+    server_job.stream_api = function(_, _, _, on_chunk)
+      on_chunk(
+        'data: ' .. vim.json.encode({
+          payload = {
+            type = 'sync',
+            syncEvent = {
+              id = 'evt_2',
+              type = 'message.part.updated.1',
+              data = {
+                sessionID = 'ses_1',
+                part = {
+                  id = 'prt_1',
+                  type = 'text',
+                  text = 'hello',
+                  messageID = 'msg_1',
+                  sessionID = 'ses_1',
+                },
+              },
+            },
+            id = 'evt_2',
+          },
+        })
+      )
+
+      return { shutdown = function() end }
+    end
+
+    local client = api_client.new('http://localhost:8080')
+    client:subscribe_to_events('/some/directory', function(event)
+      table.insert(received, event)
+    end)
+
+    assert.same({
+      {
+        id = 'evt_2',
+        type = 'message.part.updated',
+        properties = {
+          sessionID = 'ses_1',
+          part = {
+            id = 'prt_1',
+            type = 'text',
+            text = 'hello',
+            messageID = 'msg_1',
+            sessionID = 'ses_1',
+          },
+        },
+      },
+    }, received)
+
+    server_job.stream_api = original_stream_api
+  end)
 end)