ref!(ui): rewrite result pane UI

Author: boltlessengineer

lua/rest-nvim/autocmds.lua

@@ -8,51 +8,9 @@
 
 local autocmds = {}
 
-local result = require("rest-nvim.result")
-local config = require("rest-nvim.config")
-local result_help = require("rest-nvim.result.help")
-
 ---Set up Rest autocommands group
 function autocmds.setup()
-  local rest_nvim_augroup = vim.api.nvim_create_augroup("Rest", {})
-  local keybinds = config.result.keybinds
-
-  vim.api.nvim_create_autocmd({ "BufEnter", "BufWinEnter" }, {
-    group = rest_nvim_augroup,
-    pattern = "rest_nvim_results",
-    callback = function(args)
-      vim.keymap.set("n", keybinds.prev, function()
-        result.cycle_pane(-1)
-      end, {
-        desc = "Go to previous winbar pane",
-        buffer = args.buf,
-      })
-      vim.keymap.set("n", keybinds.next, function()
-        result.cycle_pane(1)
-      end, {
-        desc = "Go to next winbar pane",
-        buffer = args.buf,
-      })
-      vim.keymap.set("n", "?", result_help.open, {
-        desc = "Open rest.nvim request results help window",
-        buffer = args.buf,
-      })
-      vim.keymap.set("n", "q", function()
-        vim.api.nvim_buf_delete(args.buf, { unload = true })
-      end, { desc = "Close rest.nvim results buffer", buffer = args.buf })
-    end,
-    desc = "Set up rest.nvim results buffer keybinds",
-  })
-  vim.api.nvim_create_autocmd({ "BufEnter", "BufWinEnter" }, {
-    group = rest_nvim_augroup,
-    pattern = "rest_winbar_help",
-    callback = function(args)
-      vim.keymap.set("n", "q", result_help.close, {
-        desc = "Close rest.nvim request results help window",
-        buffer = args.buf,
-      })
-    end,
-  })
+  vim.api.nvim_create_augroup("Rest", { clear = true })
 end
 
 ---Register a new autocommand in the `Rest` augroup
@@ -71,7 +29,7 @@ function autocmds.register_autocmd(events, cb, description)
   })
 
   local autocmd_opts = {
-    group = "Rest",
+    group = vim.api.nvim_create_augroup("Rest", { clear = false }),
     pattern = "*.http",
     desc = description,
   }

lua/rest-nvim/config/init.lua

@@ -89,6 +89,10 @@ local default_config = {
       horizontal = false,
       ---@type boolean Change the focus to the results window or stay in the current window (HTTP file)
       enter = false,
+      ---@type boolean
+      headers = true,
+      ---@type boolean
+      cookies = true,
     },
     ---@class RestConfigResultBehavior
     behavior = {
@@ -102,8 +106,8 @@ local default_config = {
         ---@see https://curl.se/libcurl/c/curl_easy_getinfo.html
         ---@type table<string,RestOptsResultStatStyle>
         stats = {
-          total_time = { winbar = true, title = "Time taken" },
-          size_download_t = { winbar = true, title = "Download size" },
+          total_time = { winbar = "take", title = "Time taken" },
+          size_download_t = { winbar = "size", title = "Download size" },
         },
       },
       ---@type table<string,RestResultFormatters>

lua/rest-nvim/parser/init.lua

@@ -254,11 +254,12 @@ function M.parse(node, source, context)
     M.parse_pre_request_script(script_node, source, context)
   end
   local handler_nodes = collect_next_siblings(req_node, {"res_handler_script"})
-  local handlers = vim.iter(handler_nodes):map(function (node)
-    return M.parse_request_handler(node, source, context)
+  local handlers = vim.iter(handler_nodes):map(function (n)
+    return M.parse_request_handler(n, source, context)
   end):totable()
   local headers = parse_headers(req_node, source, context)
-  if headers["host"] then
+  -- HACK: check if url doesn't have host
+  if headers["host"] and url[1] == "/" then
     url = headers["host"]..url
     headers["host"] = nil
   end

lua/rest-nvim/request.lua

@@ -6,6 +6,8 @@ local parser = require("rest-nvim.parser")
 local utils  = require("rest-nvim.utils")
 local logger = require("rest-nvim.logger")
 local config = require("rest-nvim.config")
+local ui     = require("rest-nvim.ui.result")
+local nio    = require("nio")
 
 ---@class Request
 ---@field context Context
@@ -24,26 +26,41 @@ local rest_nvim_last_request = nil
 ---@return boolean ok
 local function run_request(req)
   logger.debug("run_request")
-  local client = require("rest-nvim.client.curl")
+  local client = require("rest-nvim.client.curl.cli")
   rest_nvim_last_request = req
 
-  logger.info("sending request to: " .. req.url)
-  local res = client.request_(req)
-  if not res then
-    logger.error("request failed")
-    return false
-  end
-  logger.debug("request success")
+  -- remove previous result
+  _G._rest_nvim_result = nil
+  -- clear the ui
+  ui.update()
+
+  -- open result UI
+  ui.open_ui()
+
+  -- TODO: set UI with request informations (e.g. method & get)
+
+  nio.run(function ()
+    local ok, res = pcall(client.request(req).wait)
+    if not ok then
+      logger.error("request failed")
+      -- TODO: should return here
+      return
+    end
+    logger.info("request success")
+    -- wrap with schedule to set global variable outside of lua callback loop
+    vim.schedule(function ()
+      _G._rest_nvim_result = res
 
-  -- run request handler scripts
-  vim.iter(req.handlers):each(function (f) f() end)
+      -- run request handler scripts
+      vim.iter(req.handlers):each(function (f) f() end)
 
-  logger.debug("handler end")
+      logger.info("handler done")
 
-  -- update result UI
-  local result = require("rest-nvim.result")
-  local result_buf = result.get_or_create_buf()
-  result.write_res(result_buf, res)
+      -- update result UI
+      ui.update()
+    end)
+  end)
+  -- FIXME: use future instead of returning true here
   return true
 end
 
@@ -91,12 +108,12 @@ function M.run_all()
   for _, req_node in ipairs(reqs) do
     local req = parser.parse(req_node, 0, ctx)
     if not req then
-      vim.notify("Parsing request failed. See `:Rest log` for more info", vim.log.levels.ERROR)
+      vim.notify("Parsing request failed. See `:Rest logs` for more info", vim.log.levels.ERROR)
       return false
     end
     local ok = run_request(req)
     if not ok then
-      vim.notify("Running request failed. See `:Rest log` for more info", vim.log.levels.ERROR)
+      vim.notify("Running request failed. See `:Rest logs` for more info", vim.log.levels.ERROR)
       return false
     end
   end

lua/rest-nvim/result/init.lua

@@ -228,12 +228,10 @@ local function format_body(bufnr, headers, res)
         if vim.v.shell_error == 0 then
           res.body = stdout
         else
-          ---@diagnostic disable-next-line need-check-nil
           logger.error("Error running formatter '" .. fmt .. "' on response body:\n" .. stdout)
         end
       end
     elseif res_type ~= nil then
-      ---@diagnostic disable-next-line need-check-nil
       logger.info(
         "Could not find a formatter for the body type "
           .. res_type

lua/rest-nvim/result/help.lua lua/rest-nvim/ui/help.lualua/rest-nvim/result/help.lua renamed to lua/rest-nvim/ui/help.lua

@@ -1,4 +1,4 @@
----@mod rest-nvim.result.help rest.nvim result buffer help
+---@mod rest-nvim.ui.help rest.nvim result buffer help
 ---
 ---@brief [[
 ---
@@ -32,6 +32,10 @@ local function get_or_create_buf()
     vim.api.nvim_buf_set_name(new_bufnr, tmp_name)
     vim.api.nvim_set_option_value("ft", "markdown", { buf = new_bufnr })
     vim.api.nvim_set_option_value("buftype", "nofile", { buf = new_bufnr })
+    vim.keymap.set("n", "q", help.close, {
+      desc = "Close rest.nvim request results help window",
+      buffer = new_bufnr,
+    })
 
     -- Write to buffer
     local buf_content = {
@@ -57,12 +61,7 @@ function help.open()
   local help_bufnr = get_or_create_buf()
 
   -- Get the results buffer window ID
-  local winnr
-  for _, id in ipairs(vim.api.nvim_list_wins()) do
-    if vim.api.nvim_buf_get_name(vim.api.nvim_win_get_buf(id)):find("rest_nvim_results") then
-      winnr = id
-    end
-  end
+  local winnr = vim.api.nvim_get_current_win()
 
   -- Help window sizing and positioning
   local width = math.floor(vim.api.nvim_win_get_width(winnr) / 2)

lua/rest-nvim/ui/panes.lua

@@ -0,0 +1,111 @@
+---@mod rest-nvim.ui.panes Small internal library to create pane style window
+
+---@class RestUIPane
+---@field name string
+---@field bufnr number
+---@field group RestUIPaneGroup
+---@field render fun(self:RestUIPane)
+
+---@class RestUIPaneOpts
+---@field name string
+---@field on_init? fun(self:RestUIPane)
+---@field render fun(self:RestUIPane):(modifiable:boolean?)
+
+---@class RestUIPaneGroup
+---@field name string
+---@field panes RestUIPane[]
+local RestUIPaneGroup = {}
+---@param direction number
+function RestUIPaneGroup:cycle(direction)
+  for index, pane in ipairs(self.panes) do
+    if pane.bufnr == vim.api.nvim_get_current_buf() then
+      local next_index = (index + direction - 1) % #self.panes + 1
+      vim.api.nvim_win_set_buf(0, self.panes[next_index].bufnr)
+      return
+    end
+  end
+  vim.notify("`cycle()` can only be called inside the pane buffer", vim.log.levels.WARN)
+end
+function RestUIPaneGroup:render()
+  for _, pane in ipairs(self.panes) do
+    pane:render()
+  end
+end
+function RestUIPaneGroup:enter(winnr)
+  if not self.panes[1].bufnr then
+    self:render()
+  end
+  vim.api.nvim_win_set_buf(winnr, self.panes[1].bufnr)
+end
+
+---@class RestUIPaneGroupOpts
+---@field on_init? fun(self:RestUIPane)
+
+local M = {}
+
+---@type table<string,RestUIPaneGroup>
+local groups = {}
+
+---@param name string
+---@param pane_opts RestUIPaneOpts[]
+---@param opts? RestUIPaneGroupOpts
+---@return RestUIPaneGroup
+function M.create_pane_group(name, pane_opts, opts)
+  ---@type RestUIPaneGroup
+  local group = { name = name, panes = {} }
+  setmetatable(group, { __index = RestUIPaneGroup })
+  -- TODO: validate name doesn't conflict
+  groups[name] = group
+  for _, pane_opt in ipairs(pane_opts) do
+    ---@type RestUIPane
+    ---@diagnostic disable-next-line: missing-fields
+    local pane = {
+      name = pane_opt.name,
+      group = group,
+      render = function (self)
+        if not self.bufnr then
+          self.bufnr = vim.api.nvim_create_buf(false, false)
+          vim.bo[self.bufnr].modifiable = false
+          vim.bo[self.bufnr].swapfile = false
+          vim.bo[self.bufnr].buftype = "nofile"
+          vim.b[self.bufnr].__pane_group = name
+          -- HACK: I can't set buffer name because it will allow `:edit` command
+          -- vim.api.nvim_buf_set_name(self.bufnr, name .. "#" .. self.name)
+          if opts and opts.on_init then
+            opts.on_init(self)
+          end
+          if pane_opt.on_init then
+            pane_opt.on_init(self)
+          end
+        end
+        vim.bo[self.bufnr].modifiable = true
+        local modifiable = pane_opt.render(self) or false
+        if not modifiable then
+          vim.bo[self.bufnr].undolevels = -1
+        end
+        vim.bo[self.bufnr].modifiable = modifiable
+      end
+    }
+    table.insert(group.panes, pane)
+  end
+  return group
+end
+
+---@return string
+function M.winbar()
+  local group = groups[vim.b.__pane_group]
+  if not group then
+    return "not a pane buffer"
+  end
+  local winbar = {}
+  for _, pane in ipairs(group.panes) do
+    if pane.bufnr == vim.api.nvim_get_current_buf() then
+      table.insert(winbar, "%#RestPaneTitle#" .. pane.name .. "%#Normal#")
+    else
+      table.insert(winbar, "%#RestPaneTitleNC#" .. pane.name .. "%#Normal#")
+    end
+  end
+  return table.concat(winbar, " %#RestText#|%#Normal# ")
+end
+
+return M