feat: handler script support

Now handler script can alter the response data

Author: boltlessengineer

lua/rest-nvim/context.lua

@@ -6,7 +6,6 @@ local M = {}
 
 ---@class rest.Context
 ---@field vars table<string,string>
----@field response? rest.Response
 local Context = {}
 Context.__index = Context
 

lua/rest-nvim/request.lua

@@ -40,14 +40,14 @@ local function run_request(req)
     local ok, res = pcall(client.request(req).wait)
     if not ok then
       logger.error("request failed")
-      -- TODO: should return here
+      vim.notify("request failed", vim.log.levels.ERROR)
       return
     end
     ---@cast res rest.Response
     logger.info("request success")
 
     -- run request handler scripts
-    vim.iter(req.handlers):each(function (f) f() end)
+    vim.iter(req.handlers):each(function (f) f(res) end)
     logger.info("handler done")
 
     -- update cookie jar

lua/rest-nvim/script.lua

@@ -33,14 +33,13 @@ function M.create_prescript_env(ctx)
 end
 
 ---@param ctx rest.Context
+---@param res rest.Response
 ---@return rest.HandlerEnv
-function M.create_handler_env(ctx)
+function M.create_handler_env(ctx, res)
   ---@class rest.HandlerEnv
   local env = {
     ---@class rest.HandlerEnv.Client
     client = {
-      test = function () end,
-      assert = function () end,
       ---@type rest.Env.Request.Variables
       global = {
         ---set global variable (this overwrites `vim.env`)
@@ -55,11 +54,6 @@ function M.create_handler_env(ctx)
     },
     ---@class rest.HandlerEnv.Request
     request = {
-      body = {},
-      environment = {},
-      headers = {},
-      method = "GET",
-      url = "",
       ---@type rest.Env.Request.Variables
       variables = {
         ---sets request-local variable
@@ -73,7 +67,7 @@ function M.create_handler_env(ctx)
       }
     },
     -- TODO: create wrapper class for response
-    response = ctx.response,
+    response = res,
     vim = vim
   }
   return env
@@ -101,7 +95,9 @@ end
 ---@param ctx rest.Context
 ---@return function
 function M.load_handler(script, ctx)
-  return M.load(script, M.create_handler_env(ctx))
+  return function (res)
+    M.load(script, M.create_handler_env(ctx, res))()
+  end
 end
 
 return M

spec/minimum_init.lua

@@ -15,6 +15,11 @@ vim.g.rest_nvim = {
   _log_level = vim.log.levels.INFO,
   cookies = {
     path = "/tmp/rest-nvim.cookies"
+  },
+  result = {
+    behavior = {
+      formatters = {}
+    },
   }
 }
 vim.uv.fs_unlink(vim.g.rest_nvim.cookies.path)

spec/script_spec.lua

@@ -0,0 +1,52 @@
+---@module 'luassert'
+
+require("spec.minimum_init")
+
+local parser = require("rest-nvim.parser")
+local utils = require("rest-nvim.utils")
+-- local context = require("rest-nvim.context").Context
+-- local logger = require("rest-nvim.logger")
+
+describe("handler script", function ()
+  it("alter response body", function ()
+    local source = [[
+http://localhost:8000
+
+> {%
+local json = vim.json.decode(response.body)
+json.data = "overwritten"
+response.body = vim.json.encode(json)
+%}
+]]
+    local _, tree = utils.ts_parse_source(source)
+    local req_node = assert(tree:root():child(0))
+    local req = assert(parser.parse(req_node, source))
+    ---@type rest.Response
+    ---@diagnostic disable-next-line: missing-fields
+    local res = {
+      body = [[{"data": "given"}]]
+    }
+    vim.iter(req.handlers):each(function (f) f(res) end)
+    assert.same([[{"data":"overwritten"}]], res.body)
+  end)
+  it("update context from response body", function ()
+    local source = [[
+http://localhost:8000
+
+> {%
+local json = vim.json.decode(response.body)
+client.global.set("MYVAR", json.var)
+%}
+]]
+    local _, tree = utils.ts_parse_source(source)
+    local req_node = assert(tree:root():child(0))
+    local req = assert(parser.parse(req_node, source))
+    ---@type rest.Response
+    ---@diagnostic disable-next-line: missing-fields
+    local res = {
+      body = [[{"var": "boo"}]]
+    }
+    vim.iter(req.handlers):each(function (f) f(res) end)
+    assert.same("boo", req.context:resolve("MYVAR"))
+  end)
+end)