fix: ensure right buffers are attached/queried with async model

Fixes zbirenbaum#536

Author: AntoineGS

lua/copilot/auth/init.lua

@@ -221,6 +221,7 @@ local function check_status(client, callback)
 end
 
 ---@param callback? fun()
+---@return boolean
 function M.is_authenticated(callback)
   local current_time = vim.loop.now()
 

lua/copilot/client/init.lua

@@ -14,16 +14,13 @@ local is_disabled = false
 ---@field config vim.lsp.ClientConfig | nil
 ---@field startup_error string | nil
 ---@field initialized boolean
--- Only for informational purposes, use Vim API to check actual status
----@field buffer_statuses table<integer, string>
 local M = {
   augroup = nil,
   id = nil,
   capabilities = nil,
   config = nil,
   startup_error = nil,
   initialized = false,
-  buffer_statuses = {},
 }
 
 ---@param id integer
@@ -42,8 +39,21 @@ function M.buf_is_attached(bufnr)
 end
 
 ---@param force? boolean
-function M.buf_attach(force)
-  local bufnr = vim.api.nvim_get_current_buf()
+---@param bufnr? integer The buffer number of which will be attached. 0 or nil for current buffer
+function M.buf_attach(force, bufnr)
+  if bufnr then
+    logger.trace("request to attach buffer #" .. tostring(bufnr))
+  end
+
+  bufnr = bufnr or vim.api.nvim_get_current_buf()
+  if bufnr == 0 then
+    bufnr = vim.api.nvim_get_current_buf()
+  end
+
+  if not vim.api.nvim_buf_is_valid(bufnr) then
+    logger.trace("buffer is invalid")
+    return
+  end
 
   if M.buf_is_attached(bufnr) then
     logger.trace("buffer already attached")
@@ -61,11 +71,11 @@ function M.buf_attach(force)
     return
   end
 
-  local should_attach, reason = util.should_attach()
+  local should_attach, reason = util.should_attach(bufnr)
 
   if not (force or should_attach) then
     logger.debug("not attaching to buffer based should_attach criteria: " .. reason)
-    M.buffer_statuses[bufnr] = "not attached based on " .. reason
+    util.set_buffer_attach_status(bufnr, ATTACH_STATUS_NOT_ATTACHED_PREFIX .. reason)
     return
   end
 
@@ -88,18 +98,18 @@ function M.buf_attach(force)
   vim.lsp.buf_attach_client(bufnr, M.id)
   if force then
     logger.debug("force attached to buffer")
-    M.buffer_statuses[bufnr] = "force attached"
+    util.set_buffer_attach_status(bufnr, ATTACH_STATUS_FORCE_ATTACHED)
   else
     logger.trace("buffer attached")
-    M.buffer_statuses[bufnr] = "attached"
+    util.set_buffer_attach_status(bufnr, ATTACH_STATUS_ATTACHED)
   end
 end
 
 function M.buf_detach()
   if M.buf_is_attached(0) then
     vim.lsp.buf_detach_client(0, M.id)
-    logger.trace("buffer detached")
-    M.buffer_statuses[vim.api.nvim_get_current_buf()] = "manually detached"
+    logger.trace("buffer manuall detached")
+    util.set_buffer_attach_status(vim.api.nvim_get_current_buf(), ATTACH_STATUS_MANUALLY_DETACHED)
   end
 end
 
@@ -176,19 +186,23 @@ function M.setup()
 
   vim.api.nvim_create_autocmd("FileType", {
     group = M.augroup,
-    callback = function()
+    callback = function(args)
+      local bufnr = (args and args.buf) or nil
       logger.trace("filetype autocmd called")
       vim.schedule(function()
         -- todo: when we do lazy/late attaching this needs changing
-        M.buf_attach()
+        M.buf_attach(false, bufnr)
       end)
     end,
     desc = "[copilot] (suggestion) file type",
   })
 
   vim.schedule(M.ensure_client_started)
-  -- FileType is likely already triggered for shown buffer
-  vim.schedule(M.buf_attach)
+  -- FileType is likely already triggered for shown buffer, so we trigger it manually
+  local bufnr = vim.api.nvim_get_current_buf()
+  vim.schedule(function()
+    M.buf_attach(false, bufnr)
+  end)
 end
 
 function M.teardown()

lua/copilot/command.lua

@@ -29,13 +29,13 @@ function M.version()
   end)()
 end
 
----@param opts? { force?: boolean }
+---@param opts? { force?: boolean, bufnr?: integer}
 function M.attach(opts)
   logger.trace("attaching to buffer")
   opts = opts or {}
 
   if not opts.force then
-    local should_attach, no_attach_reason = u.should_attach()
+    local should_attach, no_attach_reason = u.should_attach(opts.bufnr)
 
     if not should_attach then
       logger.notify(no_attach_reason .. "\nto force attach, run ':Copilot! attach'")
@@ -45,7 +45,7 @@ function M.attach(opts)
     opts.force = true
   end
 
-  c.buf_attach(opts.force)
+  c.buf_attach(opts.force, opts.bufnr)
 end
 
 function M.detach()

lua/copilot/status/init.lua

@@ -1,3 +1,4 @@
+local u = require("copilot.util")
 local logger = require("copilot.logger")
 ---@alias copilot_status_notification_data { status: ''|'Normal'|'InProgress'|'Warning', message: string }
 
@@ -97,12 +98,8 @@ function M.status()
       return
     end
 
-    local buffer_status = c.buffer_statuses[vim.api.nvim_get_current_buf()]
-    if buffer_status then
-      add_line("Buffer status: " .. c.buffer_statuses[vim.api.nvim_get_current_buf()])
-    else
-      add_line("Buffer status: Attach not yet requested")
-    end
+    local buffer_status = u.get_buffer_attach_status(vim.api.nvim_get_current_buf())
+    add_line("Buffer status: " .. buffer_status)
 
     if string.lower(M.data.status) == "error" then
       add_line(M.data.message)

lua/copilot/suggestion/init.lua

@@ -236,7 +236,7 @@ local function clear_preview()
 end
 
 ---@param ctx? copilot_suggestion_context
----@return copilot_get_completions_data_completion|nil
+---@return copilot_get_completions_data_completion?
 local function get_current_suggestion(ctx)
   logger.trace("suggestion get current suggestion", ctx)
   ctx = ctx or get_ctx()
@@ -454,10 +454,11 @@ local function get_suggestions_cycling(callback, ctx)
   end
 end
 
-local function schedule(ctx)
+---@param bufnr? integer
+local function schedule(bufnr)
   local function is_authenticated()
     return auth.is_authenticated(function()
-      schedule(ctx)
+      schedule(bufnr)
     end)
   end
 
@@ -467,36 +468,35 @@ local function schedule(ctx)
     return
   end
 
-  logger.trace("suggestion schedule", ctx)
+  logger.trace("suggestion schedule")
 
   if copilot._copilot_timer then
-    cancel_inflight_requests(ctx)
+    cancel_inflight_requests()
     stop_timer()
   end
 
-  update_preview(ctx)
-  local bufnr = vim.api.nvim_get_current_buf()
+  update_preview()
+  bufnr = bufnr or vim.api.nvim_get_current_buf()
   copilot._copilot_timer = vim.fn.timer_start(copilot.debounce, function(timer)
     logger.trace("suggestion schedule timer", bufnr)
     trigger(bufnr, timer)
   end)
 end
 
----@param context string
-local function request_suggestion(context)
-  logger.trace("suggestion on " .. context)
-  schedule()
+---@param bufnr? integer
+local function request_suggestion(bufnr)
+  logger.trace("suggestion request")
+  c.buf_attach(false, bufnr)
+  schedule(bufnr)
 end
 
----@param context string
-local function request_suggestion_when_auto_trigger(context)
-  c.buf_attach()
-
+---@param bufnr? integer
+local function request_suggestion_when_auto_trigger(bufnr)
   if not should_auto_trigger() then
     return
   end
 
-  request_suggestion(context)
+  request_suggestion(bufnr)
 end
 
 function M.has_next()
@@ -524,12 +524,11 @@ local function advance(count, ctx)
 end
 
 ---@param ctx copilot_suggestion_context
----@param caller_context string
 ---@return boolean
-function M.first_request_scheduled(ctx, caller_context)
+function M.first_request_scheduled(ctx)
   if not ctx.first then
-    logger.trace("suggestion " .. caller_context .. ", no first request")
-    request_suggestion(caller_context)
+    logger.trace("suggestion, no first request")
+    request_suggestion()
     return true
   end
 
@@ -544,7 +543,7 @@ function M.next()
     reset_ctx(ctx)
   end
 
-  if M.first_request_scheduled(ctx, "next") then
+  if M.first_request_scheduled(ctx) then
     return
   end
 
@@ -561,7 +560,7 @@ function M.prev()
     reset_ctx(ctx)
   end
 
-  if M.first_request_scheduled(ctx, "prev") then
+  if M.first_request_scheduled(ctx) then
     return
   end
 
@@ -575,7 +574,7 @@ function M.accept(modifier)
   local ctx = get_ctx()
   logger.trace("suggestion accept", ctx)
 
-  if config.suggestion.trigger_on_accept and M.first_request_scheduled(ctx, "suggestion accept") then
+  if config.suggestion.trigger_on_accept and M.first_request_scheduled(ctx) then
     return
   end
 
@@ -736,33 +735,41 @@ local function on_buf_leave()
   end
 end
 
-local function on_insert_enter()
-  request_suggestion_when_auto_trigger("insert enter")
+local function on_insert_enter(args)
+  logger.trace("insert enter")
+  local bufnr = (args and args.buf) or nil
+  request_suggestion_when_auto_trigger(bufnr)
 end
 
-local function on_buf_enter()
+local function on_buf_enter(args)
   if vim.fn.mode():match("^[iR]") then
-    request_suggestion_when_auto_trigger("buf enter")
+    logger.trace("buf enter")
+    local bufnr = (args and args.buf) or nil
+    request_suggestion_when_auto_trigger(bufnr)
   end
 end
 
-local function on_cursor_moved_i()
+local function on_cursor_moved_i(args)
   if ignore_next_cursor_moved then
     ignore_next_cursor_moved = false
     return
   end
 
   local ctx = get_ctx()
   if copilot._copilot_timer or ctx.params or should_auto_trigger() then
-    request_suggestion("cursor moved insert")
+    logger.trace("cursor moved insert")
+    local bufnr = (args and args.buf) or nil
+    request_suggestion(bufnr)
   end
 end
 
-local function on_text_changed_p()
+local function on_text_changed_p(args)
   local ctx = get_ctx()
 
   if not copilot.hide_during_completion and (copilot._copilot_timer or ctx.params or should_auto_trigger()) then
-    request_suggestion("text changed pum")
+    logger.trace("text changed pum")
+    local bufnr = (args and args.buf) or nil
+    request_suggestion(bufnr)
   end
 end
 
@@ -797,25 +804,33 @@ local function create_autocmds()
 
   vim.api.nvim_create_autocmd("InsertEnter", {
     group = copilot.augroup,
-    callback = on_insert_enter,
+    callback = function(args)
+      on_insert_enter(args)
+    end,
     desc = "[copilot] (suggestion) insert enter",
   })
 
   vim.api.nvim_create_autocmd("BufEnter", {
     group = copilot.augroup,
-    callback = on_buf_enter,
+    callback = function(args)
+      on_buf_enter(args)
+    end,
     desc = "[copilot] (suggestion) buf enter",
   })
 
   vim.api.nvim_create_autocmd("CursorMovedI", {
     group = copilot.augroup,
-    callback = on_cursor_moved_i,
+    callback = function(args)
+      on_cursor_moved_i(args)
+    end,
     desc = "[copilot] (suggestion) cursor moved insert",
   })
 
   vim.api.nvim_create_autocmd("TextChangedP", {
     group = copilot.augroup,
-    callback = on_text_changed_p,
+    callback = function(args)
+      on_text_changed_p(args)
+    end,
     desc = "[copilot] (suggestion) text changed pum",
   })
 
@@ -827,7 +842,9 @@ local function create_autocmds()
 
   vim.api.nvim_create_autocmd("BufUnload", {
     group = copilot.augroup,
-    callback = on_buf_unload,
+    callback = function(args)
+      on_buf_unload(args)
+    end,
     desc = "[copilot] (suggestion) buf unload",
   })