Revert "fix: multiple buffers opened cause incorrect should_attach logic (zbirenbaum#521)"

This reverts commit d921204.

Author: AntoineGS

lua/copilot/client/init.lua

@@ -39,8 +39,6 @@ end
 
 ---@param force? boolean
 function M.buf_attach(force)
-  local bufnr = vim.api.nvim_get_current_buf()
-  local filetype = vim.api.nvim_buf_get_option(bufnr, "filetype")
   if lsp.initialization_failed() then
     logger.error("copilot-language-server failed to initialize")
     M.startup_error = "initialization of copilot-language-server failed"
@@ -57,10 +55,6 @@ function M.buf_attach(force)
     return
   end
 
-  if not M.config then
-    logger.debug("initializing config for attachable buffer")
-    M.config = client_config.create(config)
-  end
   if not M.config then
     logger.error("cannot attach: configuration not initialized")
     return
@@ -70,20 +64,17 @@ function M.buf_attach(force)
   M.config.root_dir = utils.get_root_dir(config.root_dir)
 
   logger.trace("attaching to buffer")
-  -- Only attach client to buffer, do not start client here
-  local client = M.get()
-  if client and not vim.lsp.buf_is_attached(bufnr, client.id) then
-    vim.lsp.buf_attach_client(bufnr, client.id)
-    logger.trace("explicitly attached client to buffer", bufnr, client.id)
+  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)")
   end
-  logger.debug(
-    string.format(
-      "[buf_attach] After attach: bufnr=%s, filetype=%s, attached=%s",
-      tostring(bufnr),
-      tostring(filetype),
-      tostring(client and vim.lsp.buf_is_attached(bufnr, client.id) or false)
-    )
-  )
   logger.trace("buffer attached")
 end
 
@@ -102,36 +93,39 @@ function M.is_disabled()
   return is_disabled
 end
 
-function M.ensure_client_started()
+---@param callback fun(client:table):nil
+function M.use_client(callback)
   if is_disabled then
     logger.notify("copilot is offline")
     return
   end
 
-  if not M.config then
-    M.config = client_config.create(config)
-  end
+  local client = M.get()
 
-  if not M.config then
-    logger.error("copilot.setup is not called yet")
-    return
-  end
+  if not client then
+    if not M.config then
+      logger.error("copilot.setup is not called yet")
+      return
+    end
+
+    client_config.add_callback(callback)
+
+    if not util.should_attach() then
+      logger.debug("not attaching to buffer based on should_attach criteria")
+      return
+    end
 
-  if not M.id then
     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
-    store_client_id(client_id)
-  end
-end
 
----@param callback fun(client:table):nil
-function M.use_client(callback)
-  M.ensure_client_started()
-  local client = M.get()
-  if client then
+    store_client_id(client_id)
+  elseif not client.initialized then
+    client_config.add_callback(callback)
+  else
     callback(client)
   end
 end

lua/copilot/util.lua

@@ -45,9 +45,6 @@ function M.should_attach()
   local bufnr = vim.api.nvim_get_current_buf()
   local bufname = vim.api.nvim_buf_get_name(bufnr)
   local conf_attach = config.should_attach(bufnr, bufname)
-  logger.debug(
-    "should_attach: " .. tostring(conf_attach) .. " for buffer: " .. bufnr .. " and filetype:" .. vim.bo.filetype
-  )
 
   if not conf_attach then
     return false, "copilot is disabled"

tests/child_helper.lua

@@ -72,23 +72,15 @@ 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
-          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
+          script = string.format(
+            [[%s%s = {
+          %s
+          },
+          ]],
+            script,
+            k,
+            v
+          )
         end
       end
     end
@@ -101,16 +93,6 @@ 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([[
@@ -119,13 +101,13 @@ function M.new_child_neovim(test_name)
         return client.initialized
       end
 
-      vim.wait(5000, copilot_is_initialized, 10)
+      vim.wait(30000, copilot_is_initialized, 10)
     ]])
   end
 
   function child.wait_for_suggestion()
     child.lua([[
-      vim.wait(5000, function()
+      vim.wait(30000, function()
         return M.suggested
       end, 10)
     ]])
@@ -138,7 +120,7 @@ function M.new_child_neovim(test_name)
         return lines[1] and lines[1] ~= "" 
       end
 
-      vim.wait(5000, function()
+      vim.wait(30000, function()
         return suggestion_is_visible()
       end, 50)
     ]])