feat(client): improved start and attach

Author: MunifTanjim

lua/copilot/auth.lua

@@ -1,5 +1,5 @@
 local api = require("copilot.api")
-local u = require("copilot.util")
+local c = require("copilot.client")
 
 local M = {}
 
@@ -102,39 +102,33 @@ function M.setup(client)
 end
 
 function M.signin()
-  local client = u.get_copilot_client()
-  if not client then
-    return
-  end
-
-  M.setup(client)
+  c.use_client(function(client)
+    M.setup(client)
+  end)
 end
 
 function M.signout()
-  local client = u.get_copilot_client()
-  if not client then
-    return
-  end
-
-  api.check_status(
-    client,
-    { options = { localChecksOnly = true } },
-    ---@param status copilot_check_status_data
-    function(err, status)
-      if err then
-        echo(err)
-        return
+  c.use_client(function(client)
+    api.check_status(
+      client,
+      { options = { localChecksOnly = true } },
+      ---@param status copilot_check_status_data
+      function(err, status)
+        if err then
+          echo(err)
+          return
+        end
+
+        if status.user then
+          echo("Signed out as GitHub user " .. status.user)
+        else
+          echo("Not signed in")
+        end
+
+        api.sign_out(client, function() end)
       end
-
-      if status.user then
-        echo("Signed out as GitHub user " .. status.user)
-      else
-        echo("Not signed in")
-      end
-
-      api.sign_out(client, function() end)
-    end
-  )
+    )
+  end)
 end
 
 local function find_config_path()

lua/copilot/client.lua

@@ -2,43 +2,90 @@ local api = require("copilot.api")
 local config = require("copilot.config")
 local util = require("copilot.util")
 
-local M = {}
+local M = {
+  id = nil,
+}
+
+local function store_client_id(id)
+  if M.id and M.id ~= id then
+    if vim.lsp.get_client_by_id(M.id) then
+      error("unexpectedly started multiple copilot server")
+    end
+  end
+
+  M.id = id
+end
 
 local copilot_node_version = nil
 function M.get_node_version()
   if not copilot_node_version then
-    copilot_node_version = string.match(table.concat(vim.fn.systemlist(config.get("copilot_node_command") .. " --version", nil, false)), "v(%S+)")
+    copilot_node_version = string.match(
+      table.concat(vim.fn.systemlist(config.get("copilot_node_command") .. " --version", nil, false)),
+      "v(%S+)"
+    )
   end
   return copilot_node_version
 end
 
-local register_autocmd = function()
-  vim.api.nvim_create_autocmd({ "BufEnter" }, {
-    callback = vim.schedule_wrap(M.buf_attach_copilot),
-  })
+function M.buf_is_attached(bufnr)
+  return M.id and vim.lsp.buf_is_attached(bufnr or 0, M.id)
 end
 
 ---@param force? boolean
-function M.buf_attach(client, force)
+function M.buf_attach(force)
   if not force and not util.should_attach() then
     return
   end
 
-  client = client or util.get_copilot_client()
-  if client and not util.is_attached(client) then
-    vim.lsp.buf_attach_client(0, client.id)
+  local client_id = vim.lsp.start(M.config)
+  store_client_id(client_id)
+end
+
+function M.buf_detach()
+  if M.buf_is_attached(0) then
+    vim.lsp.buf_detach_client(0, M.id)
   end
 end
 
-function M.buf_detach(client)
-  client = client or util.get_copilot_client()
-  if client and util.is_attached(client) then
-    vim.lsp.buf_detach_client(0, client.id)
+---@param should_start? boolean
+function M.get(should_start)
+  if not M.config then
+    error("copilot.setup is not called yet")
+  end
+
+  local client = M.id and vim.lsp.get_client_by_id(M.id) or nil
+
+  if should_start and not (M.id and client) then
+    local client_id = vim.lsp.start_client(M.config)
+    store_client_id(client_id)
+
+    client = vim.lsp.get_client_by_id(M.id)
   end
+
+  return client
 end
 
-M.buf_attach_copilot = function()
-  M.buf_attach()
+---@param callback fun(client:table):nil
+function M.use_client(callback)
+  local client = M.get(true) --[[@as table]]
+
+  if client.initialized then
+    callback(client)
+    return
+  end
+
+  local timer = vim.loop.new_timer()
+  timer:start(
+    0,
+    100,
+    vim.schedule_wrap(function()
+      if client.initialized and not timer:is_closing() then
+        timer:stop()
+        timer:close()
+        callback(client)
+      end
+    end)
+  )
 end
 
 M.merge_server_opts = function(params)
@@ -47,22 +94,19 @@ M.merge_server_opts = function(params)
       params.copilot_node_command,
       require("copilot.util").get_copilot_path(),
     },
-    cmd_cwd = vim.fn.expand("~"),
     root_dir = vim.loop.cwd(),
     name = "copilot",
-    autostart = true,
-    single_file_support = true,
     on_init = function(client)
-      vim.schedule(function ()
+      vim.schedule(function()
         ---@type copilot_set_editor_info_params
         local set_editor_info_params = util.get_editor_info()
-        set_editor_info_params.editorInfo.version = set_editor_info_params.editorInfo.version .. ' + Node.js ' .. M.get_node_version()
+        set_editor_info_params.editorInfo.version = set_editor_info_params.editorInfo.version
+          .. " + Node.js "
+          .. M.get_node_version()
         set_editor_info_params.editorConfiguration = util.get_editor_configuration()
         set_editor_info_params.networkProxy = util.get_network_proxy()
         api.set_editor_info(client, set_editor_info_params)
       end)
-      vim.schedule(M.buf_attach_copilot)
-      vim.schedule(register_autocmd)
     end,
     handlers = {
       PanelSolution = api.handlers.PanelSolution,
@@ -72,9 +116,21 @@ M.merge_server_opts = function(params)
   }, params.server_opts_overrides or {})
 end
 
-M.start = function(params)
-  local client_config = M.merge_server_opts(params)
-  vim.lsp.start_client(client_config)
+M.setup = function(params)
+  M.config = M.merge_server_opts(params)
+
+  local augroup = vim.api.nvim_create_augroup("copilot.client", { clear = true })
+
+  vim.api.nvim_create_autocmd("FileType", {
+    group = augroup,
+    callback = vim.schedule_wrap(function()
+      M.buf_attach()
+    end),
+  })
+
+  vim.schedule(function()
+    M.buf_attach()
+  end)
 end
 
 return M

lua/copilot/command.lua

@@ -109,7 +109,7 @@ function mod.toggle(opts)
   end
 
   if u.is_attached(client) then
-    c.buf_detach(client)
+    c.buf_detach()
     return
   end
 
@@ -126,7 +126,7 @@ function mod.toggle(opts)
     opts.force = true
   end
 
-  c.buf_attach(client, opts.force)
+  c.buf_attach(opts.force)
 end
 
 return mod

lua/copilot/config.lua

@@ -43,7 +43,7 @@ local mod = {
 function mod.setup(opts)
   if mod.config then
     vim.notify("[copilot] config is already set", vim.log.levels.WARN)
-    return
+    return mod.config
   end
 
   local config = vim.tbl_deep_extend("force", default_config, opts or {})

lua/copilot/init.lua

@@ -37,18 +37,16 @@ M.setup = function(opts)
 
   local conf = config.setup(opts)
 
-  vim.schedule(function ()
-    client.start(conf)
-
-    if conf.panel.enabled then
-      panel.setup(conf.panel)
-      create_cmds(conf)
-    end
-
-    if conf.suggestion.enabled then
-      suggestion.setup(conf.suggestion)
-    end
-  end)
+  client.setup(conf)
+
+  if conf.panel.enabled then
+    panel.setup(conf.panel)
+    create_cmds(conf)
+  end
+
+  if conf.suggestion.enabled then
+    suggestion.setup(conf.suggestion)
+  end
 
   highlight.setup()