fix: multiple buffers opened cause incorrect should_attach logic

Take 2

Author: AntoineGS

lua/copilot/auth/init.lua

@@ -210,7 +210,7 @@ local function check_status(client, callback)
 
     if not err and status and status.user then
       auth_cache.authenticated = true
-    else
+    elseif not err then
       auth_cache.authenticated = false
     end
 
@@ -224,6 +224,10 @@ end
 function M.is_authenticated(callback)
   local current_time = vim.loop.now()
 
+  if not c.initialized then
+    return false
+  end
+
   if auth_cache.authenticated ~= nil then
     local ttl = get_cache_ttl(auth_cache.authenticated)
     if (current_time - auth_cache.timestamp) < ttl then
@@ -233,8 +237,6 @@ function M.is_authenticated(callback)
 
   local client = c.get()
   if not client then
-    auth_cache.authenticated = false
-    auth_cache.timestamp = current_time
     return false
   end
 

lua/copilot/client/config.lua

@@ -116,6 +116,12 @@ function M.prepare_client_config(overrides, client)
         for _, callback in ipairs(callbacks) do
           callback(lsp_client)
         end
+
+        local token_env_set = (os.getenv("GITHUB_COPILOT_TOKEN") ~= nil) or (os.getenv("GH_COPILOT_TOKEN") ~= nil)
+
+        if token_env_set then
+          require("copilot.auth").signin()
+        end
       end)
     end,
     on_exit = function(code, _, client_id)

lua/copilot/client/init.lua

@@ -39,6 +39,8 @@ end
 
 ---@param force? boolean
 function M.buf_attach(force)
+  local bufnr = vim.api.nvim_get_current_buf()
+
   if lsp.initialization_failed() then
     logger.error("copilot-language-server failed to initialize")
     M.startup_error = "initialization of copilot-language-server failed"
@@ -60,21 +62,14 @@ function M.buf_attach(force)
     return
   end
 
-  -- In case it has changed, we update it
-  M.config.root_dir = utils.get_root_dir(config.root_dir)
-
   logger.trace("attaching to buffer")
-  local ok, client_id_or_err = pcall(vim.lsp.start, M.config)
-  if not ok then
-    logger.error(string.format("failed to start LSP client: %s", client_id_or_err))
-    return
-  end
 
-  if client_id_or_err then
-    store_client_id(client_id_or_err)
-  else
-    logger.error("LSP client failed to start (no client ID returned)")
+  -- This could cause slowdowns when going into Insert mode
+  if not vim.lsp.buf_is_attached(bufnr, M.id) then
+    vim.lsp.buf_attach_client(bufnr, M.id)
+    logger.trace("explicitly attached client to buffer")
   end
+
   logger.trace("buffer attached")
 end
 
@@ -89,43 +84,45 @@ function M.get()
   return vim.lsp.get_client_by_id(M.id)
 end
 
+---@return boolean
 function M.is_disabled()
   return is_disabled
 end
 
----@param callback fun(client:table):nil
-function M.use_client(callback)
+function M.ensure_client_started()
+  if M.id then
+    return
+  end
+
   if is_disabled then
     logger.notify("copilot is offline")
     return
   end
 
-  local client = M.get()
-
-  if not client then
-    if not M.config then
-      logger.error("copilot.setup is not called yet")
-      return
-    end
+  if not M.config then
+    M.config = client_config.create(config)
+  end
 
-    client_config.add_callback(callback)
+  if not M.config then
+    logger.error("copilot.setup is not called yet")
+    return
+  end
 
-    if not util.should_attach() then
-      logger.debug("not attaching to buffer based on should_attach criteria")
-      return
-    end
+  M.config.root_dir = utils.get_root_dir(config.root_dir)
+  local client_id, err = vim.lsp.start(M.config)
 
-    local client_id, err = vim.lsp.start(M.config)
+  if not client_id then
+    logger.error(string.format("error starting LSP client: %s", err))
+    return
+  end
 
-    if not client_id then
-      logger.error(string.format("error starting LSP client: %s", err))
-      return
-    end
+  store_client_id(client_id)
+end
 
-    store_client_id(client_id)
-  elseif not client.initialized then
-    client_config.add_callback(callback)
-  else
+---@param callback fun(client:table):nil
+function M.use_client(callback)
+  local client = M.get()
+  if client then
     callback(client)
   end
 end
@@ -153,9 +150,7 @@ function M.setup()
     end),
   })
 
-  vim.schedule(function()
-    M.buf_attach()
-  end)
+  M.ensure_client_started()
 end
 
 function M.teardown()

lua/copilot/init.lua

@@ -20,12 +20,6 @@ M.setup = function(opts)
   -- logged here to ensure the logger is setup
   logger.debug("active LSP config (may change runtime):", client.config)
 
-  local token_env_set = (os.getenv("GITHUB_COPILOT_TOKEN") ~= nil) or (os.getenv("GH_COPILOT_TOKEN") ~= nil)
-
-  if token_env_set then
-    vim.schedule(auth.signin)
-  end
-
   M.setup_done = true
 end
 

lua/copilot/suggestion/init.lua

@@ -485,13 +485,14 @@ local function advance(count, ctx)
 end
 
 local function schedule(ctx)
-  -- in case we need to call the lsp API to know if we are authenticated,
-  -- we want to retry this method after the authentication check
-  local is_authenticated = auth.is_authenticated(function()
-    schedule(ctx)
-  end)
+  local function is_authenticated()
+    return auth.is_authenticated(function()
+      schedule(ctx)
+    end)
+  end
 
-  if not is_enabled() or not c.initialized or not is_authenticated then
+  -- We do not want to solve auth.is_authenticated() unless the others are true
+  if not is_enabled() or not c.initialized or not is_authenticated() then
     clear()
     return
   end
@@ -723,12 +724,14 @@ end
 local function on_insert_enter()
   if should_auto_trigger() then
     logger.trace("suggestion on insert enter")
+    c.buf_attach()
     schedule()
   end
 end
 
 local function on_buf_enter()
   if vim.fn.mode():match("^[iR]") then
+    logger.trace("suggestion on buf enter")
     on_insert_enter()
   end
 end

tests/child_helper.lua

@@ -72,15 +72,23 @@ function M.new_child_neovim(test_name)
     for k, v in pairs(child.config) do
       if v ~= "" and v ~= nil then
         if type(v) == "string" then
-          script = string.format(
-            [[%s%s = {
-          %s
-          },
-          ]],
-            script,
-            k,
-            v
-          )
+          if v:sub(1, 8) == "function" then
+            script = string.format(
+              [[%s
+%s = %s,]],
+              script,
+              k,
+              v
+            )
+          else
+            script = string.format(
+              [[%s
+%s = { %s },]],
+              script,
+              k,
+              v
+            )
+          end
         end
       end
     end
@@ -93,6 +101,16 @@ function M.new_child_neovim(test_name)
       script
     )
 
+    -- write to temporary file for debugging purposes
+    local tmpfile = string.format("./tests/logs/test_config.txt")
+    local file = io.open(tmpfile, "w")
+    if file then
+      file:write(script)
+      file:close()
+    else
+      error("Could not open temporary file for writing: " .. tmpfile)
+    end
+
     child.lua(script)
 
     child.lua([[
@@ -101,13 +119,13 @@ function M.new_child_neovim(test_name)
         return client.initialized
       end
 
-      vim.wait(30000, copilot_is_initialized, 10)
+      vim.wait(5000, copilot_is_initialized, 10)
     ]])
   end
 
   function child.wait_for_suggestion()
     child.lua([[
-      vim.wait(30000, function()
+      vim.wait(5000, function()
         return M.suggested
       end, 10)
     ]])
@@ -120,7 +138,7 @@ function M.new_child_neovim(test_name)
         return lines[1] and lines[1] ~= "" 
       end
 
-      vim.wait(30000, function()
+      vim.wait(5000, function()
         return suggestion_is_visible()
       end, 50)
     ]])

tests/files/file1.txt

@@ -0,0 +1,51 @@
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|123                                                                             
+02|456                                                                             
+03|7                                                                               
+04|~                                                                               
+05|~                                                                               
+06|~                                                                               
+07|~                                                                               
+08|~                                                                               
+09|~                                                                               
+10|~                                                                               
+11|~                                                                               
+12|~                                                                               
+13|~                                                                               
+14|~                                                                               
+15|~                                                                               
+16|~                                                                               
+17|~                                                                               
+18|~                                                                               
+19|~                                                                               
+20|~                                                                               
+21|~                                                                               
+22|~                                                                               
+23|tests/files/file2.txt [+]                                     3,2            All
+24|-- INSERT --                                                                    
+
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|00000000000000000000000000000000000000000000000000000000000000000000000000000000
+02|00000000000000000000000000000000000000000000000000000000000000000000000000000000
+03|00000000000000000000000000000000000000000000000000000000000000000000000000000000
+04|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+05|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+06|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+07|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+08|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+09|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+10|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+11|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+12|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+13|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+14|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+15|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+16|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+17|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+18|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+19|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+20|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+21|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+22|11111111111111111111111111111111111111111111111111111111111111111111111111111111
+23|22222222222222222222222222222222222222222222222222222222222222222222222222222222
+24|33333333333344444444444444444444444444444444444444444444444444444444444444444444