ref(script)!: modularize script runner client

Author: boltlessengineer

Makefile

@@ -15,6 +15,5 @@ docgen:
 	lemmy-help lua/rest-nvim/commands.lua > doc/rest-nvim-commands.txt
 	lemmy-help lua/rest-nvim/config/init.lua > doc/rest-nvim-config.txt
 	lemmy-help lua/rest-nvim/cookie_jar.lua > doc/rest-nvim-cookies.txt
-	lemmy-help lua/rest-nvim/script.lua > doc/rest-nvim-script.txt
-	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/client/init.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
+	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/client/init.lua lua/rest-nvim/script/init.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
 	lemmy-help lua/rest-nvim/client/curl/cli.lua lua/rest-nvim/client/curl/utils.lua > doc/rest-nvim-client-curl.txt

doc/rest-nvim-api.txt

@@ -66,6 +66,31 @@ client:request({req})                                           *client:request*
         (nio.control.Future)  Future containing `rest.Response`
 
 
+==============================================================================
+script runner client for rest.nvim                            *rest-nvim.script*
+
+
+ Script runner client for rest.nvim.
+ This can be external module like `rest.client`
+
+
+rest.ScriptClient                                            *rest.ScriptClient*
+
+
+script:load_pre_req_hook({str}, {ctx})                *script:load_pre_req_hook*
+
+    Parameters: ~
+        {str}  (string)
+        {ctx}  (rest.Context)
+
+
+script:load_post_req_hook({str}, {ctx})              *script:load_post_req_hook*
+
+    Parameters: ~
+        {str}  (string)
+        {ctx}  (rest.Context)
+
+
 ==============================================================================
 rest.nvim result UI module                                 *rest-nvim.ui.result*
 
@@ -181,6 +206,12 @@ utils.ts_find({node}, {type})                                    *utils.ts_find*
         {type}  (string)  @return TSNode?
 
 
+utils.ts_upper_node({node})                                *utils.ts_upper_node*
+
+    Parameters: ~
+        {node}  (TSNode)
+
+
                                                             *utils.ts_node_spec*
 utils.ts_node_spec({node}, {expected_type})
 

doc/rest-nvim-script.txt

@@ -1,67 +0,0 @@
-==============================================================================
-rest.nvim pre-request/request handler module                  *rest-nvim.script*
-
-rest.Env.Request.Variables                          *rest.Env.Request.Variables*
-
-    Fields: ~
-        {set}  (fun(key:string,value:string))  Set variable
-        {get}  (fun(key:string):string)        Retrieve variable
-
-
-script.create_prescript_env({ctx})                 *script.create_prescript_env*
-
-    Parameters: ~
-        {ctx}  (rest.Context)
-
-    Returns: ~
-        (rest.PreScriptEnv)
-
-
-rest.PreScriptEnv                                            *rest.PreScriptEnv*
-    Global Environment variables passed to pre-request scripts
-
-
-rest.PreScriptEnv.Request                            *rest.PreScriptEnv.Request*
-
-
-script.create_handler_env({ctx}, {res})              *script.create_handler_env*
-
-    Parameters: ~
-        {ctx}  (rest.Context)
-        {res}  (rest.Response)
-
-    Returns: ~
-        (rest.HandlerEnv)
-
-
-rest.HandlerEnv                                                *rest.HandlerEnv*
-    Global Environment variables passed to response handler scripts
-
-
-rest.HandlerEnv.Client                                  *rest.HandlerEnv.Client*
-
-
-rest.HandlerEnv.Request                                *rest.HandlerEnv.Request*
-
-
-script.load_prescript({s}, {ctx})                        *script.load_prescript*
-
-    Parameters: ~
-        {s}    (string)
-        {ctx}  (rest.Context)
-
-    Returns: ~
-        (function)
-
-
-script.load_handler({s}, {ctx})                            *script.load_handler*
-
-    Parameters: ~
-        {s}    (string)
-        {ctx}  (rest.Context)
-
-    Returns: ~
-        (function)
-
-
-vim:tw=78:ts=8:noet:ft=help:norl:

lua/rest-nvim/parser/init.lua

@@ -10,7 +10,6 @@
 local parser = {}
 
 local Context = require("rest-nvim.context").Context
-local script = require("rest-nvim.script")
 local utils   = require("rest-nvim.utils")
 local logger   = require("rest-nvim.logger")
 local jar = require("rest-nvim.cookie_jar")
@@ -195,29 +194,49 @@ end
 
 ---@param node TSNode
 ---@param source Source
+---@return string lang
 ---@return string str
 local function parse_script(node, source)
-  vim.validate({ node = utils.ts_node_spec(node, "script") })
-  local str = vim.treesitter.get_node_text(node, source):sub(3,-3)
-  return str
+  local lang = "javascript"
+  local prev_node = utils.ts_upper_node(node)
+  if prev_node and prev_node:type() == "comment" and get_node_field_text(prev_node, "name", source) == "lang" then
+    local value = get_node_field_text(prev_node, "value", source)
+    if value then
+      lang = value
+    end
+  end
+  local script_node = assert(node:named_child(0))
+  local str = vim.treesitter.get_node_text(script_node, source):sub(3,-3)
+  return lang, str
 end
 
----@param script_node TSNode
+---@param node TSNode
 ---@param source Source
 ---@param context rest.Context
-function parser.parse_pre_request_script(script_node, source, context)
-  local node = assert(script_node:named_child(0))
-  local str = parse_script(node, source)
-  script.load_prescript(str, context)()
+function parser.parse_pre_request_script(node, source, context)
+  local lang, str = parse_script(node, source)
+  local ok, script = pcall(require, "rest-nvim.script." .. lang)
+  if not ok then
+    logger.error(("failed to load script with language '%s'. Can't find script runner client."):format(lang))
+    return
+  end
+  ---@cast script rest.ScriptClient
+  script:load_pre_req_hook(str, context)()
 end
 
----@param handler_node TSNode
+---@param node TSNode
 ---@param source Source
 ---@param context rest.Context
-function parser.parse_request_handler(handler_node, source, context)
-  local node = assert(handler_node:named_child(0))
-  local str = parse_script(node, source)
-  return script.load_handler(str, context)
+---@return function?
+function parser.parse_request_handler(node, source, context)
+  local lang, str = parse_script(node, source)
+  local ok, script = pcall(require, "rest-nvim.script." .. lang)
+  if not ok then
+    logger.error(("failed to load script with language '%s'. Can't find script runner client."):format(lang))
+    return
+  end
+  ---@cast script rest.ScriptClient
+  return script:load_post_req_hook(str, context)
 end
 
 ---@param source Source
@@ -281,7 +300,10 @@ function parser.parse(node, source, ctx)
     if node_type == "pre_request_script" then
       parser.parse_pre_request_script(child, source, ctx)
     elseif node_type == "res_handler_script" then
-      table.insert(handlers, parser.parse_request_handler(child, source, ctx))
+      local handler = parser.parse_request_handler(child, source, ctx)
+      if handler then
+        table.insert(handlers, handler)
+      end
     elseif node_type == "request_separator" then
       name = get_node_field_text(child, "value", source)
     elseif node_type == "comment" and get_node_field_text(child, "name", source) == "name" then

lua/rest-nvim/script/init.lua

@@ -0,0 +1,30 @@
+---@mod rest-nvim.script script runner client for rest.nvim
+---
+---@brief [[
+---
+--- Script runner client for rest.nvim.
+--- This can be external module like `rest.client`
+---
+---@brief ]]
+
+---@class rest.ScriptClient
+local script = {}
+
+---@param str string
+---@param ctx rest.Context
+function script:load_pre_req_hook(str, ctx)
+  return function ()
+    vim.print(str, ctx)
+  end
+end
+
+---@param str string
+---@param ctx rest.Context
+function script:load_post_req_hook(str, ctx)
+  ---@param res rest.Response
+  return function (res)
+    vim.print(str, ctx, res)
+  end
+end
+
+return script

lua/rest-nvim/script.lua lua/rest-nvim/script/lua.lualua/rest-nvim/script.lua renamed to lua/rest-nvim/script/lua.lua

@@ -96,14 +96,14 @@ end
 ---@param s string
 ---@param ctx rest.Context
 ---@return function
-function script.load_prescript(s, ctx)
+function script:load_pre_req_hook(s, ctx)
   return script.load(s, script.create_prescript_env(ctx))
 end
 
 ---@param s string
 ---@param ctx rest.Context
 ---@return function
-function script.load_handler(s, ctx)
+function script:load_post_req_hook(s, ctx)
   return function (res)
     script.load(s, script.create_handler_env(ctx, res))()
   end

lua/rest-nvim/utils.lua

@@ -217,6 +217,19 @@ function utils.ts_find(node, type)
   return nil
 end
 
+---@param node TSNode
+function utils.ts_upper_node(node)
+  local start_row, _, _, _ = node:range()
+  local end_row = start_row
+  start_row = start_row - 1
+  local start_col = 0
+  local end_col = 0
+  -- HACK: root node type might not be "document"
+  local root_node = assert(utils.ts_find(node, "document"))
+  local min_node = root_node:named_descendant_for_range(start_row, start_col, end_row, end_col)
+  return min_node
+end
+
 ---@param node TSNode
 ---@param expected_type string
 ---@return table

spec/api_spec.lua

@@ -168,10 +168,10 @@ X-DATE: {{$date}}
     }, c.vars)
   end)
   it("parse pre-request script", function ()
-    local source = "< {%\nrequest.variables.set('foo', 'bar')\n%}\n"
+    local source = "# @lang=lua\n< {%\nrequest.variables.set('foo', 'bar')\n%}\n"
     local _, tree = utils.ts_parse_source(source)
     local c = context:new()
-    local script_node = tree:root():child(0):child(0)
+    local script_node = tree:root():child(0):child(1)
     assert(script_node)
     assert.same("pre_request_script", script_node:type())
     parser.parse_pre_request_script(script_node, source, c)
@@ -202,7 +202,7 @@ X-DATE: {{$date}}
     request.variables.set("bar", "new")
     request.variables.set("baz", "new")
     ]]
-    local h = require("rest-nvim.script.lua").load_handler(script, ctx)
+    local h = require("rest-nvim.script.lua"):load_post_req_hook(script, ctx)
     h()
     assert.same("new", vim.env["foo"])
     assert.same("new", ctx:resolve("bar"))

spec/script_spec.lua

@@ -4,14 +4,13 @@ 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
 
+# @lang=lua
 > {%
 local json = vim.json.decode(response.body)
 json.data = "overwritten"
@@ -33,6 +32,7 @@ response.body = vim.json.encode(json)
     local source = [[
 http://localhost:8000
 
+# @lang=lua
 > {%
 local json = vim.json.decode(response.body)
 client.global.set("MYVAR", json.var)

spec/utils_spec.lua

@@ -0,0 +1,21 @@
+---@module 'luassert'
+
+local utils = require("rest-nvim.utils")
+
+describe("tree-sitter utils", function ()
+  local source = [[
+http://localhost:8000
+
+# @lang=lua
+> {%
+local json = vim.json.decode(response.body)
+json.data = "overwritten"
+response.body = vim.json.encode(json)
+%}
+]]
+  local _, tree = utils.ts_parse_source(source)
+  local script_node = assert(tree:root():child(0):child(1))
+  assert.same("res_handler_script", script_node:type())
+  local comment_node = assert(utils.ts_upper_node(script_node))
+  assert.same("comment", comment_node:type())
+end)