fix: buffer attachment logic in various conditions

fixes 547

Author: AntoineGS

lua/copilot/client/init.lua

@@ -8,14 +8,12 @@ local client_config = require("copilot.client.config")
 local is_disabled = false
 
 ---@class CopilotClient
----@field augroup string|nil
 ---@field id integer|nil
 ---@field capabilities lsp.ClientCapabilities | nil
 ---@field config vim.lsp.ClientConfig | nil
 ---@field startup_error string | nil
 ---@field initialized boolean
 local M = {
-  augroup = nil,
   id = nil,
   capabilities = nil,
   config = nil,
@@ -42,6 +40,11 @@ end
 function M.buf_attach(force)
   local bufnr = vim.api.nvim_get_current_buf()
 
+  if M.buf_is_attached(bufnr) then
+    logger.trace("buffer already attached")
+    return
+  end
+
   if lsp.initialization_failed() then
     logger.error("copilot-language-server failed to initialize")
     M.startup_error = "initialization of copilot-language-server failed"
@@ -153,32 +156,13 @@ function M.setup()
   end
 
   is_disabled = false
-
   M.id = nil
-
-  -- nvim_clear_autocmds throws an error if the group does not exist
-  local augroup = "copilot.client"
-  vim.api.nvim_create_augroup(augroup, { clear = true })
-  M.augroup = augroup
-
-  vim.api.nvim_create_autocmd("FileType", {
-    group = M.augroup,
-    callback = vim.schedule_wrap(function()
-      M.buf_attach()
-    end),
-  })
-
   vim.schedule(M.ensure_client_started)
 end
 
 function M.teardown()
   is_disabled = true
 
-  -- nvim_clear_autocmds throws an error if the group does not exist
-  if M.augroup then
-    vim.api.nvim_clear_autocmds({ group = M.augroup })
-  end
-
   if M.id then
     vim.lsp.stop_client(M.id)
   end

lua/copilot/suggestion/init.lua

@@ -505,6 +505,20 @@ local function schedule(ctx)
   end)
 end
 
+---@param ctx copilot_suggestion_context
+---@param caller_context string
+---@return boolean
+function M.first_request_scheduled(ctx, caller_context)
+  if not ctx.first then
+    logger.trace("suggestion " .. caller_context .. ", no first request", ctx)
+    c.buf_attach()
+    schedule(ctx)
+    return true
+  end
+
+  return false
+end
+
 function M.next()
   local ctx = get_ctx()
   logger.trace("suggestion next", ctx)
@@ -513,10 +527,7 @@ function M.next()
     reset_ctx(ctx)
   end
 
-  -- no suggestion request yet
-  if not ctx.first then
-    logger.trace("suggestion next, no first request")
-    schedule(ctx)
+  if M.first_request_scheduled(ctx, "next") then
     return
   end
 
@@ -533,10 +544,7 @@ function M.prev()
     reset_ctx(ctx)
   end
 
-  -- no suggestion request yet
-  if not ctx.first then
-    logger.trace("suggestion prev, no first request", ctx)
-    schedule(ctx)
+  if M.first_request_scheduled(ctx, "prev") then
     return
   end
 
@@ -550,10 +558,7 @@ function M.accept(modifier)
   local ctx = get_ctx()
   logger.trace("suggestion accept", ctx)
 
-  -- no suggestion request yet
-  if (not ctx.first) and config.suggestion.trigger_on_accept then
-    logger.trace("suggestion accept, not first request", ctx)
-    schedule(ctx)
+  if config.suggestion.trigger_on_accept and M.first_request_scheduled(ctx, "suggestion accept") then
     return
   end
 
@@ -722,6 +727,11 @@ local function on_insert_enter()
   end
 end
 
+local function on_filetype()
+  logger.trace("suggestion on file type")
+  on_insert_enter()
+end
+
 local function on_buf_enter()
   if vim.fn.mode():match("^[iR]") then
     logger.trace("suggestion on buf enter")
@@ -738,6 +748,7 @@ local function on_cursor_moved_i()
   local ctx = get_ctx()
   if copilot._copilot_timer or ctx.params or should_auto_trigger() then
     logger.trace("suggestion on cursor moved insert")
+    c.buf_attach()
     schedule(ctx)
   end
 end
@@ -746,6 +757,7 @@ local function on_text_changed_p()
   local ctx = get_ctx()
   if not copilot.hide_during_completion and (copilot._copilot_timer or ctx.params or should_auto_trigger()) then
     logger.trace("suggestion on text changed pum")
+    c.buf_attach()
     schedule(ctx)
   end
 end
@@ -785,6 +797,12 @@ local function create_autocmds()
     desc = "[copilot] (suggestion) insert enter",
   })
 
+  vim.api.nvim_create_autocmd("FileType", {
+    group = M.augroup,
+    callback = on_filetype,
+    desc = "[copilot] (suggestion) file type",
+  })
+
   vim.api.nvim_create_autocmd("BufEnter", {
     group = copilot.augroup,
     callback = on_buf_enter,

tests/test_client.lua

@@ -208,4 +208,54 @@ T["client()"]["will not attach to buffer due to filetype exclusion"] = function(
   reference_screenshot(child.get_screenshot(), nil, { ignore_text = { 9, 10 }, ignore_attr = { 9, 10 } })
 end
 
+T["client()"]["auto_trigger off - will not attach automatically"] = function()
+  child.configure_copilot()
+  child.cmd("e test.txt")
+  child.type_keys("i", "<Esc>")
+  child.cmd("Copilot status")
+
+  local messages = child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      if messages:find(".*Online.*Enabled.*") then
+        return true
+      end
+    end
+
+    vim.wait(1000, function()
+      return has_passed()
+    end, 50)
+
+    return messages
+  ]])
+
+  u.expect_no_match(messages, ".*Online.*Enabled.*")
+end
+
+T["client()"]["auto_trigger off - will attach when requesting suggestion"] = function()
+  child.configure_copilot()
+  child.cmd("e test.txt")
+  child.type_keys("i", "<M-l>", "<Esc>")
+  child.cmd("Copilot status")
+
+  local messages = child.lua([[
+    local messages = ""
+    local function has_passed()
+      messages = vim.api.nvim_exec("messages", { output = true }) or ""
+      if messages:find(".*Online.*Enabled.*") then
+        return true
+      end
+    end
+
+    vim.wait(1000, function()
+      return has_passed()
+    end, 50)
+
+    return messages
+  ]])
+
+  u.expect_match(messages, ".*Online.*Enabled.*")
+end
+
 return T