refactor: add types to Promise. finally() for more reliable cleanup

Author: nickjvandyke

lua/opencode/api/command.lua

@@ -25,7 +25,7 @@ local M = {}
 function M.command(command)
   require("opencode.cli.server")
     .get_port()
-    :next(function(port)
+    :next(function(port) ---@param port number
       -- No need to register SSE here - commands don't trigger any.
       -- (except maybe the `input_*` commands? but no reason for user to use those).
       require("opencode.cli.client").tui_execute_command(command, port)

lua/opencode/api/prompt.lua

@@ -25,7 +25,7 @@ function M.prompt(prompt, opts)
 
   require("opencode.cli.server")
     .get_port()
-    :next(function(port)
+    :next(function(port) ---@param port number
       if opts.clear then
         return require("opencode.promise").new(function(resolve)
           require("opencode.cli.client").tui_execute_command("prompt.clear", port, function()
@@ -35,7 +35,7 @@ function M.prompt(prompt, opts)
       end
       return port
     end)
-    :next(function(port)
+    :next(function(port) ---@param port number
       local rendered = opts.context:render(prompt)
       local plaintext = opts.context.plaintext(rendered.output)
       return require("opencode.promise").new(function(resolve)
@@ -44,7 +44,7 @@ function M.prompt(prompt, opts)
         end)
       end)
     end)
-    :next(function(port)
+    :next(function(port) ---@param port number
       require("opencode.events").subscribe()
 
       if opts.submit then
@@ -57,7 +57,7 @@ function M.prompt(prompt, opts)
       vim.notify(err, vim.log.levels.ERROR, { title = "opencode" })
       return true
     end)
-    :next(function()
+    :finally(function()
       opts.context:clear()
     end)
 end

lua/opencode/cli/client.lua

@@ -246,7 +246,7 @@ end
 ---Select session in `opencode`.
 ---
 ---@param port number
----@param session_id number
+---@param session_id string
 function M.select_session(port, session_id)
   M.call(port, "/tui/select-session", "POST", { sessionID = session_id }, nil)
 end

lua/opencode/cli/server.lua

@@ -202,6 +202,7 @@ end
 ---3. Calling `opts.provider.start` and polling for the port.
 ---
 ---@param launch boolean? Whether to launch a new server if none found. Defaults to true.
+---@return Promise<number>
 function M.get_port(launch)
   launch = launch ~= false
   return require("opencode.promise").new(function(resolve, reject)

lua/opencode/events.lua

@@ -22,27 +22,23 @@ function M.subscribe()
 
   require("opencode.cli.server")
     .get_port(false)
-    :next(function(port)
-      require("opencode.cli.client").sse_subscribe(
-        port,
-        ---@param response opencode.cli.client.Event
-        function(response)
-          heartbeat_timer:stop()
-          heartbeat_timer:start(
-            OPENCODE_HEARTBEAT_INTERVAL_MS + 5000,
-            0,
-            vim.schedule_wrap(require("opencode.events").unsubscribe)
-          )
-
-          vim.api.nvim_exec_autocmds("User", {
-            pattern = "OpencodeEvent:" .. response.type,
-            data = {
-              event = response,
-              port = port,
-            },
-          })
-        end
-      )
+    :next(function(port) ---@param port number
+      require("opencode.cli.client").sse_subscribe(port, function(response) ---@param response opencode.cli.client.Event
+        heartbeat_timer:stop()
+        heartbeat_timer:start(
+          OPENCODE_HEARTBEAT_INTERVAL_MS + 5000,
+          0,
+          vim.schedule_wrap(require("opencode.events").unsubscribe)
+        )
+
+        vim.api.nvim_exec_autocmds("User", {
+          pattern = "OpencodeEvent:" .. response.type,
+          data = {
+            event = response,
+            port = port,
+          },
+        })
+      end)
     end)
     :catch(function(err)
       vim.notify("Failed to subscribe to SSE: " .. err, vim.log.levels.WARN)