feat: evaluate context sequentially

Author: boltlessengineer

lua/rest-nvim/context.lua

@@ -9,6 +9,8 @@ local M = {}
 ---@field vars table<string,string>
 ---local variables
 ---@field lv table<string,string>
+---current line number (to evaluate variable declaration sequentially)
+---@field linenr number
 local Context = {}
 Context.__index = Context
 
@@ -45,6 +47,7 @@ function Context:new()
   ---@type rest.Context
   local obj = {
     __index = self,
+    linenr = 0,
     vars = {},
     lv = {},
   }

lua/rest-nvim/parser/init.lua

@@ -29,12 +29,6 @@ local NAMED_REQUEST_QUERY = vim.treesitter.query.parse("http", [[
   request: (_)) @request
 ]])
 
-local IN_PLACE_VARIABLE_QUERY = vim.treesitter.query.parse("http", [[
-(section
-  !request
-  (variable_declaration)+ @inplace_variable)
-]])
-
 ---@param node TSNode
 ---@param field string
 ---@param source Source
@@ -178,19 +172,22 @@ function parser.parse_body(content_type, body_node, source, context)
   return body
 end
 
----parse all in-place variables from source
----@param source Source
----@return rest.Context ctx
-function parser.create_context(source)
-  local query = IN_PLACE_VARIABLE_QUERY
-  local ctx = Context:new()
-  local _, tree = utils.ts_parse_source(source)
-  for _, node in query:iter_captures(tree:root(), source) do
-    if node:type() == "variable_declaration" then
-      parser.parse_variable_declaration(node, source, ctx)
+---In-place variables can be evaluated in loaded buffers due to treesitter limitations
+---@param source integer
+---@param ctx rest.Context
+---@param endline number zero-based line number
+function parser.eval_context(source, ctx, endline)
+  vim.validate("source", source, "number")
+  local startline = ctx.linenr
+  for ln = startline, endline do
+    local start_node = vim.treesitter.get_node({ pos = { ln, 0 }})
+    if start_node then
+      local node = utils.ts_find(start_node, "variable_declaration", true)
+      if node then
+        parser.parse_variable_declaration(node, source, ctx)
+      end
     end
   end
-  return ctx
 end
 
 ---@return TSNode? node TSNode with type `section`
@@ -327,6 +324,12 @@ function parser.parse(node, source, ctx)
   assert(req_node)
 
   ctx = ctx or Context:new()
+  -- TODO: note that in-place variables won't be evaluated due to treesitter limitations
+  -- when source is given as raw string
+  if type(source) == "number" then
+    local start_row = node:range()
+    parser.eval_context(source, ctx, start_row)
+  end
   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

@@ -10,6 +10,7 @@ local ui     = require("rest-nvim.ui.result")
 local nio    = require("nio")
 local jar    = require("rest-nvim.cookie_jar")
 local clients = require("rest-nvim.client")
+local Context = require("rest-nvim.context").Context
 
 ---@class rest.Request.Body
 ---@field __TYPE "json"|"xml"|"raw"|"graphql"|"multipart_form_data"|"external"
@@ -35,6 +36,7 @@ local function run_request(req)
   if not client then
     logger.error("can't find registered client available for request:\n" .. vim.inspect(req))
     vim.notify("Can't find registered client available for request", vim.log.levels.ERROR, { title = "rest.nvim" })
+    return
   end
   rest_nvim_last_request = req
 
@@ -90,7 +92,7 @@ function M.run()
     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)
+  local ctx = Context:new()
   if config.env.enable and vim.b._rest_nvim_env_file then
     ctx:load_file(vim.b._rest_nvim_env_file)
   end
@@ -115,7 +117,7 @@ function M.run_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)
+  local ctx = Context:new()
   if config.env.enable and vim.b._rest_nvim_env_file then
     ctx:load_file(vim.b._rest_nvim_env_file)
   end
@@ -145,7 +147,7 @@ end
 ---run all requests in current file with same context
 function M.run_all()
   local reqs = parser.get_all_request_nodes(0)
-  local ctx = parser.create_context(0)
+  local ctx = Context:new()
   for _, req_node in ipairs(reqs) do
     local req = parser.parse(req_node, 0, ctx)
     if not req then

lua/rest-nvim/utils.lua

@@ -194,21 +194,34 @@ end
 
 ---@param source string|integer
 ---@return vim.treesitter.LanguageTree
----@return TSTree
-function utils.ts_parse_source(source)
-  local ts_parser
+function utils.ts_get_parser(source)
   if type(source) == "string" then
-    ts_parser = vim.treesitter.get_string_parser(source, "http")
+    return vim.treesitter.get_string_parser(source, "http")
   else
-    ts_parser = vim.treesitter.get_parser(source, "http")
+    return vim.treesitter.get_parser(source, "http")
   end
+end
+
+---@param source string|integer
+---@return vim.treesitter.LanguageTree
+---@return TSTree
+function utils.ts_parse_source(source)
+  local ts_parser = utils.ts_get_parser(source)
   return ts_parser, assert(ts_parser:parse(false)[1])
 end
 
 ---@param node TSNode
 ---@param type string
+---@param oneline boolean?
 ---@return TSNode?
-function utils.ts_find(node, type)
+function utils.ts_find(node, type, oneline)
+  if oneline then
+    local sr, _, er, ec = node:range()
+    local is_oneline = (sr == er) or (er - sr == 1 and ec == 0)
+    if not is_oneline then
+      return nil
+    end
+  end
   if node:type() == type then
     return node
   end

spec/examples/examples_spec.lua

@@ -4,9 +4,11 @@ require("spec.minimum_init")
 
 local parser = require("rest-nvim.parser")
 local utils = require("rest-nvim.utils")
+local Context = require("rest-nvim.context").Context
 
 local function open(path)
   vim.cmd.edit(path)
+  vim.bo.filetype = "http"
   vim.cmd.source("ftplugin/http.lua")
   return 0
 end
@@ -54,30 +56,46 @@ describe("url without host", function ()
 end)
 
 describe("in-place variables", function ()
-  local source = open("spec/examples/variables/in_place_variables.http")
-  local req_nodes = parser.get_all_request_nodes(source)
-  assert.same(3, #req_nodes)
-  local ctx = parser.create_context(source)
-  it("example 1", function ()
-    local req1 = assert(parser.parse(req_nodes[1], source, ctx))
-    ---@cast req1 rest.Request
-    assert.same("example.org/users", req1.url)
-  end)
-  it("example 2", function ()
-    local req2 = assert(parser.parse(req_nodes[2], source, ctx))
-    assert.same("example.net/users", req2.url)
+  it("parse context sequentially", function ()
+    local source = open("spec/examples/variables/in_place_variables.http")
+    local ctx = Context:new()
+    parser.eval_context(source, ctx, -1)
+    assert.same("", ctx:resolve("myhost"))
+    parser.eval_context(source, ctx, 0)
+    assert.same("", ctx:resolve("myhost"))
+    parser.eval_context(source, ctx, 1)
+    assert.same("example.org", ctx:resolve("myhost"))
+    parser.eval_context(source, ctx, 2)
+    assert.same("example.org", ctx:resolve("myhost"))
+    parser.eval_context(source, ctx, 12)
+    assert.same("example.net", ctx:resolve("myhost"))
   end)
-  it("example 3", function ()
-    local req3 = assert(parser.parse(req_nodes[3], source, ctx))
-    assert.same("example.net/stats", req3.url)
+  describe("evaluate context across multiple requests", function ()
+    local source = open("spec/examples/variables/in_place_variables.http")
+    local req_nodes = parser.get_all_request_nodes(source)
+    assert.same(3, #req_nodes)
+    local ctx = Context:new()
+    it("example 1", function ()
+      local req1 = assert(parser.parse(req_nodes[1], source, ctx))
+      ---@cast req1 rest.Request
+      assert.same("example.org/users", req1.url)
+    end)
+    it("example 2", function ()
+      local req2 = assert(parser.parse(req_nodes[2], source, ctx))
+      assert.same("example.net/users", req2.url)
+    end)
+    it("example 3", function ()
+      local req3 = assert(parser.parse(req_nodes[3], source, ctx))
+      assert.same("example.net/stats", req3.url)
+    end)
   end)
 end)
 
 describe("pre-request script", function ()
   local source = open("spec/examples/script/pre_request_script.http")
   local req_nodes = parser.get_all_request_nodes(source)
   assert.same(2, #req_nodes)
-  local ctx = parser.create_context(source)
+  local ctx = Context:new()
   it("set local variable from pre-request script", function ()
     local req1 = assert(parser.parse(req_nodes[1], source, ctx))
     assert.same("https://jsonplaceholder.typicode.com/posts/3", req1.url)

spec/parser/http_parser_spec.lua

@@ -278,17 +278,18 @@ X-DATE: {{$date}}
     }, c.lv)
   end)
 
-  it("create context from source", function()
-    local source = [[
-@foo=bar
-@bar=1234
-@baz={{foo}} adsf
-]]
-    local ctx = parser.create_context(source)
-    assert.same({
-      foo = "bar",
-      bar = "1234",
-      baz = "bar adsf",
-    }, ctx.vars)
-  end)
+-- TODO: update this testcase
+--   it("create context from source", function()
+--     local source = [[
+-- @foo=bar
+-- @bar=1234
+-- @baz={{foo}} adsf
+-- ]]
+--     local ctx = parser.create_context(source)
+--     assert.same({
+--       foo = "bar",
+--       bar = "1234",
+--       baz = "bar adsf",
+--     }, ctx.vars)
+--   end)
 end)