Weekly updates (#659)

* feat(lsp): allow LSP in js buffers to complete request/response/client
* feat(cmd): add `before_request` hook
* fix(oauth): show error if Auth key is not found
* feat(ui): add highlight opts for status icons
* fix(bug_report): schedule in fast event
* fix(async): error reporting
* feat(cmd): add `# @env-stdin-cmd-pre` and `# @stdin-cmd-pre`
* fix(parser): allow spaces in Authorization header
* feat(cmd): add # #delay to delay request execution

---------

Author: YaroSpace

NEWS.md

@@ -2,6 +2,9 @@
 
 ## Version 5.3.3
 
+### Feature: add `# @delay` to delay request execution
+### Feature: add `# @env-stdin-cmd-pre` and `# @stdin-cmd-pre` to run shell commands before requests
+### Feature: support Kulala LSP auto completion in external scripts
 ### Feature: support variables in redirect response path
 ### Feature: do not display big responses + `max_response_size` config option
 ### Feature: format json response on redirect
@@ -19,7 +22,7 @@
 ### Feature: support `kulala_http` parser in markdown code blocks
 ### Enhancement: update syntax highlighting for `kulala_http` parser
 ### Enhancement: add sorting options to [Formatter](getting-started/configuration-options.mdx)
-### Enhancement: allow variables in curl and grpc flags
+### Enhancement: allow variables in Curl and GRPC flags
 ### Feature: add LSP diagnostics
 
 ## Version 5.3.1

docs/docs/getting-started/configuration-options.mdx

@@ -454,6 +454,17 @@ Format json response when redirecting to file
 
 Default: `true`
 
+### before_request
+
+Enable/disable/customize before_request hook.  Default hook is request highlight.
+
+```lua
+{
+  opts = {
+    before_request = true, ---@type boolean|fun(request: DocumentRequest):boolean - return true to continue request execution, false to stop
+  }
+}
+```
 ## Scripts
 
 ### scripts.node_path_resolver
@@ -926,15 +937,19 @@ pickers = {
 
 ### lsp.enable
 
-Enable/disable Kulala LSP server.
+Enable/disable Kulala LSP server
+
+### lsp.filetypes
+
+Filetypes to attach Kulala LSP to
 
 ### lsp.keymaps
 
 Enable/disable/customize Kulala LSP keymaps
 
 ### lsp.formatter
 
-Enable/disable/customize HTTP formatter.
+Enable/disable/customize HTTP formatter
 
 ### lsp.on_attach
 
@@ -944,6 +959,7 @@ Function called when Kulala LSP attaches to the buffer
 {
   lsp = {
     enable = true,
+    filetypes = { "http", "rest", "json", "yaml", "bruno" },
     keymaps = false, -- disabled by default, as Kulala relies on default Neovim LSP keymaps
     formatter = {
       sort = { -- enable/disable alphabetical sorting

docs/docs/scripts/overview.md

@@ -60,6 +60,22 @@ Mixing inline Lua scripts with JavaScript scripts in the same request is not sup
 
 :::
 
+### LSP support for auto completion
+
+For external scripts, you can use the `kulala` LSP to get auto completion for the `client`, `request`, `response`, `test` and `assert` objects.
+
+To do this, add `javascript`/`lua` to `lsp.filetypes` in your [Configuration options](../getting-started/configuration-options.mdx):
+
+```lua
+{
+  opts = {
+    lsp = {
+      filetypes = { "http", "rest", "json", "yaml", "bruno", "javascript" }
+    },
+  },
+}
+```
+
 ### Using node modules
 
 You can use any Node.js module in your scripts.

docs/docs/usage/basic-usage.md

@@ -57,6 +57,7 @@ Kulala includes a built-in in-process LSP server that provides the following fea
 - Hover information for requests: equivalent to Kulala's inspect command - `K`.
 - Code actions: a list of all available Kulala commands - `gra/<leader>ca`.
 - Formatting: format buffer/range - `gq/<leader>cf/<leader>lf`. 
+- Folding
 
 - In `json/yaml/bruno` files, code actions will be available to convert collections into HTTP format.
 
@@ -101,14 +102,17 @@ require("nvim-lightbulb").setup({
 - `# @accept chunked` allows you to accept Transfer-Encoding: chunked responses and streamed responses.
 - `# @curl-global-...` and `# @curl-...` allows you to set global and per-request flags for curl requests.
 - `# @grpc-global-...` and `# @grpc-...` allows you to set global and per-request flags for gRPC requests.
+- `# @stdin-cmd-pre` allows you to execute an external command before the request is sent.
 - `# @stdin-cmd` allows you to execute an external command
 - `# @jq` allows you to filter the response body using jq.
+- `# @delay` allows you to set a delay (in milliseconds) before sending the request.
 
 #### Variables
 
 - `@variable-name=variable-value` is used to define variables that can be used in request URL, headers and body.
 - `{{variable}}` allows you to use variables defined in `metadata`, `system environment` variables, `http-client.env.json` file or `.env` file.
 - `{{$dynamic-variable}}` allows you to use predefined dynamic, aka `magic` variables.
+- `# @env-stdin-cmd-pre` allows you to set environment variables using an external command, before the request is sent.
 - `# @env-stdin-cmd` allows you to set environment variables using an external command.
 - `# @env-json-key` allows you to set environment variables using a JSON path on the response body.
 - `# @env-header-key` allows you to set environment variables from the response headers.

docs/docs/usage/dynamically-setting-environment-variables-based-on-response-json.md

@@ -38,10 +38,12 @@ Authorization: Bearer {{REQUEST_ONE.response.body.$.json.token}}
 
 ## With external command
 
-If the response is a *complex* JSON object,
-you can use the `@env-stdin-cmd` directive to
+If the response is a *complex* JSON object, you can use the `@env-stdin-cmd` directive to
 set environment variables using an external command (e.g., `jq`).
 
+Response is passed to the command via standard input (stdin) and the result is assigned to a variable,
+which can be used in subsequent requests.
+
 JSON Web Tokens (JWT) are a common example where the response JSON is complex.
 
 In this example `jq` is used to extract the `ctx` string from a JWT token.

lua/kulala/cmd/init.lua

@@ -303,11 +303,35 @@ local function received_unbffured(request, response)
   return unbuffered and response:find("Connected") and FS.file_exists(GLOBALS.BODY_FILE)
 end
 
-local function parse_request(requests, request, variables)
+local function process_pre_request_commands(request)
   if not process_prompt_vars(request) then
     return Logger.warn("Prompt failed. Skipping this and all following requests.")
   end
 
+  local int_meta_processors = {
+    ["delay"] = "delay",
+  }
+
+  local ext_meta_processors = {
+    ["stdin-cmd-pre"] = "stdin_cmd",
+    ["env-stdin-cmd-pre"] = "env_stdin_cmd",
+  }
+
+  local processor
+  for _, metadata in ipairs(request.metadata) do
+    processor = int_meta_processors[metadata.name]
+    _ = processor and INT_PROCESSING[processor](metadata.value, response)
+  end
+
+  for _, metadata in ipairs(request.metadata) do
+    processor = ext_meta_processors[metadata.name]
+    _ = processor and EXT_PROCESSING[processor](metadata.value, response)
+  end
+end
+
+local function parse_request(requests, request, variables)
+  process_pre_request_commands(request)
+
   local parsed_request, status = REQUEST_PARSER.parse(requests, variables, request)
   if not parsed_request then
     status = status == "skipped" and "is skipped" or "could not be parsed"
@@ -386,6 +410,20 @@ function process_request(requests, request, variables, callback)
   end)
 end
 
+---@param request DocumentRequest
+---@return boolean
+local function execute_before_request(request)
+  local before_request = CONFIG.get().before_request
+  if not before_request then return true end
+
+  if type(before_request) == "function" then
+    return before_request(request)
+  else
+    UI_utils.highlight_request(request)
+    return true
+  end
+end
+
 ---Parses and executes DocumentRequest/s:
 ---if requests is nil then it parses the current document
 ---if line_nr is nil then runs the first request in the list
@@ -411,9 +449,10 @@ M.run_parser = function(requests, variables, line_nr, callback)
     INLAY.show(DB.current_buffer, "loading", request.show_icon_line_number)
 
     M.queue:add(function()
-      UI_utils.highlight_request(request)
-      initialize()
-      process_request(requests, request, variables, callback)
+      if execute_before_request(request) then
+        initialize()
+        process_request(requests, request, variables, callback)
+      end
     end)
   end
 

lua/kulala/cmd/lsp.lua

@@ -414,6 +414,8 @@ local function source_type(params)
     { ">", "snippets" },
   }
 
+  if state.current_ft == "javascript" then return { "scripts" } end
+
   for _, match in ipairs(matches) do
     if line:match(match[1]) then return match[2] end
   end
@@ -663,19 +665,13 @@ end
 
 local function initialize(params)
   local ft = params.rootPath:sub(2)
-  local server_info = {
-    name = "Kulala LSP",
-    version = Globals.VERSION,
-  }
-  if ft ~= "http" and ft ~= "rest" then
-    return {
-      serverInfo = server_info,
-      capabilities = { codeActionProvider = true },
-    }
-  end
+  local capabilities
 
-  return {
-    serverInfo = server_info,
+  if ft == "javascript" then
+    capabilities = { completionProvider = { triggerCharacters = trigger_chars } }
+  elseif ft ~= "http" and ft ~= "rest" then
+    capabilities = { codeActionProvider = true }
+  else
     capabilities = {
       codeActionProvider = true,
       documentSymbolProvider = true,
@@ -687,7 +683,12 @@ local function initialize(params)
         dynamicRegistration = false,
         lineFoldingOnly = true,
       },
-    },
+    }
+  end
+
+  return {
+    server_info = { name = "Kulala LSP", version = Globals.VERSION },
+    capabilities = capabilities,
   }
 end
 

lua/kulala/cmd/lsp_sources.lua

@@ -314,10 +314,13 @@ M.metadata = {
   { "grpc", "grpc", "Grpc flag" },
   { "grpc-global", "Grpc-global", "Grpc global flag" },
   { "accept", "accept chunked", "Accept chunked responses" },
+  { "env-stdin-cmd-pre", "env-stdin-cmd-pre ", "Set env variable with external cmd before request" },
   { "env-stdin-cmd", "env-stdin-cmd ", "Set env variable with external cmd" },
   { "env-json-key", "env-json-key ", "Set env variable with json key" },
-  { "stdin-cmd", "env-stdin-cmd ", "Run external command" },
+  { "stdin-cmd-pre", "stdin-cmd-pre ", "Run external command before request" },
+  { "stdin-cmd", "stdin-cmd ", "Run external command" },
   { "jq", "jq ", "Filter response body with jq" },
+  { "delay", "delay ", "Delay running request for .. ms" },
 }
 
 ---@type SourceTable

lua/kulala/cmd/oauth.lua

@@ -627,6 +627,8 @@ end
 ---Grant Type - all
 ---Entry point to get the token for the given config_id
 M.get_token = function(type, config_id)
+  if not config_id then return Logger.error("Auth config key not found.") end
+
   local config = get_auth_config(config_id)
 
   local token_type = (type == "idToken" or config["Use ID Token"]) and "id_token" or "access_token"

lua/kulala/config/defaults.lua

@@ -67,8 +67,11 @@ local M = {
   -- format json response when redirecting to file
   format_json_on_redirect = true,
 
+  -- enable/disable/customize before_request hook.  Default hook is request highlight.
+  before_request = true, ---@type boolean|fun(request: DocumentRequest):boolean - return true to continue request execution, false to stop
+
   scripts = {
-    -- Resolves "NODE_PATH" environment variable for node scripts. Defaults to the first "node_modules" directory found upwards from "script_file_dir".
+    -- resolves "NODE_PATH" environment variable for node scripts. Defaults to the first "node_modules" directory found upwards from "script_file_dir".
     node_path_resolver = nil, ---@type fun(http_file_dir: string, script_file_dir: string, script_data: ScriptData): string|nil
   },
 
@@ -101,6 +104,9 @@ local M = {
       },
       lualine = "🐼",
       textHighlight = "WarningMsg", -- highlight group for request elapsed time
+      loadingHighlight = "Normal",
+      doneHighlight = "String",
+      errorHighlight = "ErrorMsg",
     },
 
     -- highlight groups for http syntax highlighting
@@ -178,6 +184,9 @@ local M = {
     -- enable/disable built-in LSP server
     enable = true,
 
+    -- filetypes to attach Kulala LSP to
+    filetypes = { "http", "rest", "json", "yaml", "bruno" },
+
     --enable/disable/customize  LSP keymaps
     ---@type boolean|table
     keymaps = false, -- disabled by default, as Kulala relies on default Neovim LSP keymaps