fix: pre-request script sets variable locally

Author: boltlessengineer

lua/rest-nvim/context.lua

@@ -5,7 +5,10 @@ local config = require("rest-nvim.config")
 local M = {}
 
 ---@class rest.Context
+---global variables
 ---@field vars table<string,string>
+---local variables
+---@field lv table<string,string>
 local Context = {}
 Context.__index = Context
 
@@ -43,6 +46,7 @@ function Context:new()
   local obj = {
     __index = self,
     vars = {},
+    lv = {},
   }
   setmetatable(obj, self)
   return obj
@@ -51,16 +55,30 @@ end
 ---@param filepath string
 function Context:load_file(filepath)
   dotenv.load_file(filepath, function (key, value)
-    self:set(key, value)
+    self:set_global(key, value)
   end)
 end
 
 ---@param key string
 ---@param value string
-function Context:set(key, value)
+function Context:set_global(key, value)
+  vim.validate("key", key, "string")
+  vim.validate("value", value, "string")
   self.vars[key] = value
 end
 
+---@param key string
+---@param value string
+function Context:set_local(key, value)
+  vim.validate("key", key, "string")
+  vim.validate("value", value, "string")
+  self.lv[key] = value
+end
+
+function Context:clear_local()
+  self.lv = {}
+end
+
 ---@param key string
 ---@return nil|fun():string
 local function get_dynamic_vars(key)
@@ -79,7 +97,7 @@ function Context:resolve(key)
   -- find from dynamic variables
   local var = get_dynamic_vars(key)
   -- find from local variable table or vim.env
-  return var and var() or self.vars[key] or vim.env[key] or ""
+  return var and var() or self.lv[key] or self.vars[key] or vim.env[key] or ""
 end
 
 M.Context = Context

lua/rest-nvim/parser/init.lua

@@ -246,7 +246,7 @@ function parser.parse_variable_declaration(vd_node, source, ctx)
   local name = assert(get_node_field_text(vd_node, "name", source))
   local value = vim.trim(assert(get_node_field_text(vd_node, "value", source)))
   value = expand_variables(value, ctx)
-  ctx:set(name, value)
+  ctx:set_global(name, value)
 end
 
 ---@param node TSNode
@@ -410,6 +410,7 @@ function parser.parse(node, source, ctx)
     body = body,
     handlers = handlers,
   }
+  ctx:clear_local()
   jar.load_cookies(req)
   return req
 end

lua/rest-nvim/script/lua.lua

@@ -24,7 +24,7 @@ local function create_prescript_env(ctx)
       variables = {
         ---Set request-local variable
         set = function (key, value)
-          ctx:set(key, value)
+          ctx:set_local(key, value)
         end,
         ---Retrieve variable in current request scope
         get = function (key)
@@ -65,7 +65,7 @@ local function create_handler_env(ctx, res)
       variables = {
         ---Set request-local variable
         set = function (key, value)
-          ctx:set(key, value)
+          ctx:set_local(key, value)
         end,
         ---Retrieve variable in current request scope
         get = function (key)

spec/examples/examples_spec.lua

@@ -82,9 +82,8 @@ describe("pre-request script", function ()
     local req1 = assert(parser.parse(req_nodes[1], source, ctx))
     assert.same("https://jsonplaceholder.typicode.com/posts/3", req1.url)
   end)
-  -- TODO:
-  -- it("local variables don't affect other requests", function ()
-  --   local req2 = assert(parser.parse(req_nodes[2], source, ctx))
-  --   assert.same("https://jsonplaceholder.typicode.com/posts/", req2.url)
-  -- end)
+  it("local variables don't affect other requests", function ()
+    local req2 = assert(parser.parse(req_nodes[2], source, ctx))
+    assert.same("https://jsonplaceholder.typicode.com/posts/", req2.url)
+  end)
 end)

spec/parser/http_parser_spec.lua

@@ -255,7 +255,7 @@ X-DATE: {{$date}}
     parser.parse_pre_request_script(script_node, source, c)
     assert.same({
       foo = "bar",
-    }, c.vars)
+    }, c.lv)
   end)
 
   it("create context from source", function()

spec/script_spec.lua

@@ -11,7 +11,7 @@ describe("handler script", function ()
     local ctx = Context:new()
     vim.env["foo"] = "old"
     vim.env["baz"] = "old"
-    ctx:set("bar", "old")
+    ctx:set_global("bar", "old")
     local script = [[
     client.global.set("foo", "new")
     request.variables.set("bar", "new")