feat: better progress handlers

Author: boltlessengineer

lua/rest-nvim/client/curl/cli.lua

@@ -313,7 +313,8 @@ end
 ---@return nio.control.Future future Future containing rest.Response
 function curl.request(request)
   local progress_handle = progress.handle.create({
-    title = "Fetching",
+    title = "Executing",
+    message = "Executing request...",
     lsp_client = { name = "rest.nvim" },
   })
   local future = nio.control.future()
@@ -328,14 +329,15 @@ function curl.request(request)
     end
     vim.schedule(function ()
       progress_handle:report({
-        message = "parsing response",
+        message = "Parsing response...",
       })
-    end)
-    local response = parser.parse_verbose(vim.split(sc.stderr, "\n"))
-    response.body = sc.stdout
-    future.set(response)
-    vim.schedule(function ()
-    progress_handle:finish()
+      local response = parser.parse_verbose(vim.split(sc.stderr, "\n"))
+      response.body = sc.stdout
+      future.set(response)
+      progress_handle:report({
+        message = "Success",
+      })
+      progress_handle:finish()
     end)
   end, {
     -- TODO(boltless): parse by chunk from here

lua/rest-nvim/parser/init.lua

@@ -179,6 +179,7 @@ function parser.create_context(source)
   local query = vim.treesitter.query.parse("http", IN_PLACE_VARIABLE_QUERY)
   local ctx = Context:new()
   local _, tree = utils.ts_parse_source(source)
+  -- TODO: capture variable_decalarations in section without request
   for _, node in query:iter_captures(tree:root(), source) do
     if node:type() == "variable_declaration" then
       parser.parse_variable_declaration(node, source, ctx)
@@ -192,7 +193,14 @@ function parser.get_cursor_request_node()
   local node = vim.treesitter.get_node()
   if node then
     node = utils.ts_find(node, "section")
-    if not node or #node:field("request") < 1 then
+    if not node then
+      logger.error("can't find request section node")
+      return
+    elseif node:has_error() then
+      logger.error(utils.ts_node_error_log(node))
+      return
+    elseif #node:field("request") < 1 then
+      logger.error("request section doesn't have request node")
       return
     end
   end
@@ -309,17 +317,11 @@ end
 ---@return rest.Request|nil
 function parser.parse(node, source, ctx)
   assert(node:type() == "section")
-  ctx = ctx or Context:new()
-  -- request should not include error
-  if node:has_error() then
-    logger.error(utils.ts_node_error_log(node))
-    return nil
-  end
+  assert(not node:has_error())
   local req_node = node:field("request")[1]
-  if not req_node then
-    logger.error("request section doesn't have request node")
-    return nil
-  end
+  assert(req_node)
+
+  ctx = ctx or Context:new()
   local method = get_node_field_text(req_node, "method", source)
   if not method then
     logger.info("no method provided, falling back to 'GET'")

lua/rest-nvim/request.lua

@@ -86,8 +86,8 @@ function M.run()
   logger.info("starting request")
   local req_node = parser.get_cursor_request_node()
   if not req_node then
-    logger.error("failed to find request at cursor position")
-    vim.notify("failed to find request at cursor position", vim.log.levels.ERROR, { title = "rest.nvim" })
+    logger.error("Failed to find request at cursor position")
+    vim.notify("Failed to find request at cursor position. See `:Rest logs` for more info.", vim.log.levels.ERROR, { title = "rest.nvim" })
     return
   end
   local ctx = parser.create_context(0)
@@ -111,8 +111,8 @@ end
 function M.run_by_name(name)
   local req_node = parser.get_request_node_by_name(name)
   if not req_node then
-    logger.error("failed to find request by name: " .. name)
-    vim.notify("failed to find request by name: " .. name, vim.log.levels.ERROR, { title = "rest.nvim" })
+    logger.error("Failed to find request by name: " .. name)
+    vim.notify("Failed to find request by name: " .. name .. ". See `:Rest logs` for more info.", vim.log.levels.ERROR, { title = "rest.nvim" })
     return
   end
   local ctx = parser.create_context(0)
@@ -144,7 +144,7 @@ end
 
 ---run all requests in current file with same context
 function M.run_all()
-  local reqs = parser.get_all_request_nodes()
+  local reqs = parser.get_all_request_nodes(0)
   local ctx = parser.create_context(0)
   for _, req_node in ipairs(reqs) do
     local req = parser.parse(req_node, 0, ctx)

spec/api_spec.lua

@@ -202,6 +202,7 @@ X-DATE: {{$date}}
     request.variables.set("baz", "new")
     ]]
     local h = require("rest-nvim.script.lua").load_post_req_hook(script, ctx)
+    ---@diagnostic disable-next-line: missing-parameter
     h()
     assert.same("new", vim.env["foo"])
     assert.same("new", ctx:resolve("bar"))