fix: unable to accept panel suggestion (buffer was closed error)

Fixes #473

Author: AntoineGS

lua/copilot/panel/init.lua

@@ -4,12 +4,12 @@ local config = require("copilot.config")
 local hl_group = require("copilot.highlight").group
 local util = require("copilot.util")
 local logger = require("copilot.logger")
+local utils = require("copilot.panel.utils")
 
 local M = {
   handlers = require("copilot.panel.handlers"),
 }
 local marker_prefix = "[copilot] "
-local panel_uri_prefix = "copilot://"
 
 local panel = {
   ---@type vim.lsp.Client
@@ -66,23 +66,6 @@ local function get_display_lines(text)
   return lines
 end
 
----@return string panelUri
-local function panel_uri_from_doc_uri(doc_uri)
-  local uri = panel_uri_prefix .. vim.uri_to_fname(doc_uri)
-  return uri
-end
-
----@return string doc_uri
-local function panel_uri_to_doc_uri(panel_uri)
-  local uri = vim.uri_from_fname(vim.uri_to_fname(panel_uri))
-  return uri
-end
-
----@param bufname string
-local function is_panel_uri(bufname)
-  return bufname:sub(1, #panel_uri_prefix) == panel_uri_prefix
-end
-
 function panel:lock()
   vim.api.nvim_set_option_value("modifiable", false, { buf = self.bufnr })
   vim.api.nvim_set_option_value("readonly", true, { buf = self.bufnr })
@@ -217,7 +200,8 @@ function panel:accept()
     return
   end
 
-  local bufnr = vim.uri_to_bufnr(panel_uri_to_doc_uri(self.panel_uri))
+  local doc_uri = utils.panel_uri_to_doc_uri(self.panel_uri)
+  local bufnr = vim.uri_to_bufnr(doc_uri)
   local winid = vim.fn.bufwinid(bufnr)
 
   if not vim.api.nvim_buf_is_loaded(bufnr) or winid == -1 then
@@ -375,7 +359,7 @@ function panel:ensure_winid()
   if self.auto_refresh then
     vim.api.nvim_create_autocmd({ "TextChangedI", "TextChangedP" }, {
       group = self.augroup,
-      buffer = vim.uri_to_bufnr(panel_uri_to_doc_uri(self.panel_uri)),
+      buffer = vim.uri_to_bufnr(utils.panel_uri_to_doc_uri(self.panel_uri)),
       callback = function()
         self.state.auto_refreshing = true
         self:refresh()
@@ -502,7 +486,7 @@ end
 function panel:init()
   local doc = util.get_doc()
 
-  if is_panel_uri(doc.uri) then
+  if utils.is_panel_uri(doc.uri) then
     -- currently inside the panel itself
     M.refresh()
     return
@@ -514,15 +498,11 @@ function panel:init()
     return
   end
 
-  self.panel_uri = panel_uri_from_doc_uri(doc.uri)
+  self.panel_uri = utils.panel_uri_from_doc_uri(doc.uri)
   self.filetype = vim.bo.filetype
-
   self:ensure_bufnr()
-
   self:ensure_winid()
-
   self:refresh()
-
   vim.api.nvim_set_current_win(self.winid)
 end
 
@@ -547,7 +527,7 @@ function M.toggle()
 end
 
 function M.refresh()
-  vim.api.nvim_buf_call(vim.uri_to_bufnr(panel_uri_to_doc_uri(panel.panel_uri)), function()
+  vim.api.nvim_buf_call(vim.uri_to_bufnr(utils.panel_uri_to_doc_uri(panel.panel_uri)), function()
     panel:refresh()
   end)
 end

lua/copilot/panel/utils.lua

@@ -0,0 +1,20 @@
+local M = {}
+
+local panel_uri_prefix = "copilot:///"
+
+---@return string panelUri
+function M.panel_uri_from_doc_uri(doc_uri)
+  return panel_uri_prefix .. vim.fs.normalize(vim.uri_to_fname(doc_uri))
+end
+
+---@return string doc_uri
+function M.panel_uri_to_doc_uri(panel_uri)
+  return panel_uri:gsub("^" .. panel_uri_prefix, "file:///")
+end
+
+---@param bufname string
+function M.is_panel_uri(bufname)
+  return bufname:sub(1, #panel_uri_prefix) == panel_uri_prefix
+end
+
+return M

tests/child_helper.lua

@@ -113,6 +113,19 @@ function M.new_child_neovim(test_name)
     ]])
   end
 
+  function child.wait_for_panel_suggestion()
+    child.lua([[
+      local function suggestion_is_visible()
+        lines = vim.api.nvim_buf_get_lines(2, 4, 5, false)
+        return lines[1] and lines[1] ~= "" 
+      end
+
+      vim.wait(30000, function()
+        return suggestion_is_visible()
+      end, 50)
+    ]])
+  end
+
   return child
 end
 

tests/test_panel.lua

@@ -1,6 +1,8 @@
 local eq = MiniTest.expect.equality
 local child_helper = require("tests.child_helper")
-local child = child_helper.new_child_neovim("test_client")
+local child = child_helper.new_child_neovim("test_panel")
+local reference_screenshot = MiniTest.expect.reference_screenshot
+local utils = require("copilot.panel.utils")
 
 local T = MiniTest.new_set({
   hooks = {
@@ -23,19 +25,10 @@ T["panel()"]["panel suggestions works"] = function()
   child.configure_copilot()
   child.type_keys("i123", "<Esc>", "o456", "<Esc>", "o7")
   child.lua("p.toggle()")
+  child.wait_for_panel_suggestion()
 
   local lines = child.lua([[
-    local messages = ""
-    local function suggestion_is_visible()
-      lines = vim.api.nvim_buf_get_lines(2, 4, 5, false)
-      return lines[1] == "789" or lines[1] == "789\r"
-    end
-
-    vim.wait(30000, function()
-      return suggestion_is_visible()
-    end, 50)
-
-    return lines
+    return vim.api.nvim_buf_get_lines(2, 4, 5, false)
   ]])
 
   -- For Windows, on some shells not all
@@ -46,4 +39,34 @@ T["panel()"]["panel suggestions works"] = function()
   eq(lines[1], "789")
 end
 
+-- Disabled for now as unnamed buffers have issues with not having a URI
+-- T["panel()"]["panel suggestion accept works"] = function()
+--   child.o.lines, child.o.columns = 30, 100
+--   child.config.panel = child.config.panel .. "auto_refresh = true,"
+--   child.config.suggestion = child.config.suggestion .. "auto_trigger = true,"
+--   child.configure_copilot()
+--   child.type_keys("i123", "<Esc>", "o456", "<Esc>", "o7")
+--   child.lua("p.toggle()")
+--   child.wait_for_panel_suggestion()
+--   child.cmd("buffer 2")
+--   child.type_keys("4gg")
+--   child.lua("p.accept()")
+--   child.cmd("buffer 1")
+--   reference_screenshot(child.get_screenshot())
+-- end
+
+T["panel.utils()"] = MiniTest.new_set()
+
+T["panel.utils()"]["panel_uri_from_doc_uri works"] = function()
+  local panel_uri = "copilot:///C:/Users/antoi/AppData/Local/nvim-data/lazy/copilot.lua/lua/copilot/suggestion/init.lua"
+  local doc_uri = utils.panel_uri_to_doc_uri(panel_uri)
+  eq(doc_uri, "file:///C:/Users/antoi/AppData/Local/nvim-data/lazy/copilot.lua/lua/copilot/suggestion/init.lua")
+end
+
+T["panel.utils()"]["panel_uri_to_doc_uri"] = function()
+  local doc_uri = "file:///C:/Users/antoi/AppData/Local/nvim-data/lazy/copilot.lua/lua/copilot/suggestion/init.lua"
+  local panel_uri = utils.panel_uri_from_doc_uri(doc_uri)
+  eq(panel_uri, "copilot:///C:/Users/antoi/AppData/Local/nvim-data/lazy/copilot.lua/lua/copilot/suggestion/init.lua")
+end
+
 return T