test: ensure notify when request failed

Author: boltlessengineer

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

@@ -32,6 +32,7 @@ function curl.cli(args, on_exit, opts)
     curl_cmd = vim.list_extend(curl_cmd, args)
     log.info(curl_cmd)
     opts.detach = false
+    on_exit = vim.schedule_wrap(on_exit)
     local ok, e = pcall(vim.system, curl_cmd, opts, on_exit)
     if not ok then
         ---@type vim.SystemCompleted

lua/rest-nvim/request.lua

@@ -60,41 +60,39 @@ local function run_request(req)
 
     ui.update({ request = req })
 
+    -- NOTE: wrap with schedule to do vim stuffs outside of lua callback loop (`on_exit`
+    -- callback from `vim.system()` call)
     nio.run(function()
         local ok, res = pcall(client.request(req).wait)
         if not ok then
             logger.error("request failed")
-            vim.notify("request failed", vim.log.levels.ERROR, { title = "rest.nvim" })
+            vim.notify("request failed. See `:Rest logs` for more info", vim.log.levels.ERROR, { title = "rest.nvim" })
             return
         end
         ---@cast res rest.Response
         logger.info("request success")
 
-        -- NOTE: wrap with schedule to do vim stuffs outside of lua callback loop (`on_exit`
-        -- callback from `vim.system()` call)
-        vim.schedule(function()
-            -- run request handler scripts
-            vim.iter(req.handlers):each(function(f)
-                f(res)
-            end)
-            logger.info("handler done")
-
-            _G.rest_request = req
-            _G.rest_response = res
-            vim.api.nvim_exec_autocmds("User", {
-                pattern = { "RestResponse", "RestResponsePre" },
-            })
-            _G.rest_request = nil
-            _G.rest_response = nil
-
-            -- update cookie jar
-            jar.update_jar(req.url, res)
-
-            -- update result UI
-            ui.update({ response = res })
+        -- run request handler scripts
+        vim.iter(req.handlers):each(function(f)
+            f(res)
         end)
+        logger.info("handler done")
+
+        _G.rest_request = req
+        _G.rest_response = res
+        vim.api.nvim_exec_autocmds("User", {
+            pattern = { "RestResponse", "RestResponsePre" },
+        })
+        _G.rest_request = nil
+        _G.rest_response = nil
+
+        -- update cookie jar
+        jar.update_jar(req.url, res)
+
+        -- update result UI
+        ui.update({ response = res })
     end)
-    -- FIXME: return future to pass the command state
+    -- FIXME(boltless): return future to pass the command state
 end
 
 ---Run request in current file.

spec/client/curl/command_spec.lua

@@ -2,6 +2,9 @@
 
 require("spec.minimal_init")
 
+local nio = require("nio")
+local spy = require("luassert.spy")
+
 local function open(path)
     vim.cmd.edit(path)
     return 0
@@ -21,3 +24,17 @@ describe(":Rest curl", function()
         )
     end)
 end)
+
+describe(":Rest run", function ()
+    nio.tests.it("notify on request failed", function ()
+        open("spec/examples/basic_get.http")
+        -- go to line number 6
+        vim.cmd("6")
+        local spy_notify = spy.on(vim, "notify")
+        -- run request
+        vim.cmd(":Rest run")
+        nio.sleep(100)
+        ---@diagnostic disable-next-line: undefined-field
+        assert.spy(spy_notify).called_with("request failed. See `:Rest logs` for more info", vim.log.levels.ERROR, { title = "rest.nvim" })
+    end)
+end)

spec/examples/basic_get.http

@@ -1,3 +1,6 @@
 ### basic get statement
 GET https://api.github.com/users/boltlessengineer
 user-agent: neovim
+
+### get statement for localhost
+GET localhost:9999

spec/ui/panes_spec.lua

@@ -57,6 +57,8 @@ describe("ui.panes", function()
         assert.not_same("this-is-a-winbar", vim.api.nvim_get_option_value("winbar", { scope = "local" }))
     end)
     it("initialize the buffer back after unloaded", function()
+        -- ensure there is only one window
+        vim.cmd("wincmd o")
         assert.same(1, vim.api.nvim_get_current_buf())
         group:enter(0)
         local pane_buf = vim.api.nvim_get_current_buf()