feat(config): more builtin request hooks

Author: boltlessengineer

lua/rest-nvim/autocmds.lua

@@ -18,9 +18,27 @@ function autocmds.setup()
       local config = require("rest-nvim.config")
       local utils = require("rest-nvim.utils")
       local req = _G.rest_request
-      if config.request.hooks.encode_url then
+      local hooks = config.request.hooks
+      if hooks.encode_url then
         req.url = utils.escape(req.url, true)
       end
+      if hooks.user_agent ~= "" then
+        local header_empty = not req.headers["user-agent"] or #req.headers["user-agent"] < 1
+        if header_empty then
+          req.headers["user-agent"] = { hooks.user_agent }
+        end
+      end
+      if hooks.set_content_type then
+        local header_empty = not req.headers["content-type"] or #req.headers["content-type"] < 1
+        if header_empty and req.body then
+          if req.body.__TYPE == "json" then
+            req.headers["content-type"] = { "application/json" }
+          elseif req.body.__TYPE == "xml" then
+            req.headers["content-type"] = { "application/xml" }
+            -- TODO: auto-set content-type header for external body
+          end
+        end
+      end
     end
   })
   vim.api.nvim_create_autocmd("User", {

lua/rest-nvim/config/check.lua

@@ -28,6 +28,8 @@ function check.validate(cfg)
     ["request.skip_ssl_verification"] = { cfg.request.skip_ssl_verification, "boolean" },
     ["request.hooks"] = { cfg.request.hooks, "table" },
     ["request.hooks.encode_url"] = { cfg.request.hooks.encode_url, "boolean" },
+    ["request.hooks.user_agent"] = { cfg.request.hooks.user_agent, "string" },
+    ["request.hooks.set_content_type"] = { cfg.request.hooks.set_content_type, "boolean" },
     response = { cfg.response, "table" },
     ["response.hooks"] = { cfg.response.hooks, "table" },
     clients = { cfg.clients, "table" },

lua/rest-nvim/config/default.lua

@@ -1,5 +1,7 @@
 ---@mod rest-nvim.config.default rest.nvim default configuration
 
+local api = require("rest-nvim.api")
+
 ---rest.nvim default configuration
 ---@class rest.Config
 local default_config = {
@@ -14,6 +16,10 @@ local default_config = {
     hooks = {
       ---@type boolean Encode URL before making request
       encode_url = true,
+      ---@type string Set `User-Agent` header when it is empty
+      user_agent = "rest.nvim v" .. api.VERSION,
+      ---@type boolean Set `Content-Type` header when it is empty and body is provided
+      set_content_type = true,
     },
   },
   ---@class rest.Config.Response

lua/rest-nvim/config/init.lua

@@ -38,6 +38,11 @@ local config
 ---@class rest.Opts.Request.Hooks
 --- Encode URL before making request (Default: `true`)
 ---@field encode_url? boolean
+--- Set `User-Agent` header when it is empty. Set as empty string to disable.
+--- (Default: `rest.nvim {version}`)
+---@field user_agent? string
+--- Set `Content-Type` header when it is empty but request body is provided
+---@field set_content_type? boolean
 
 ---@class rest.Opts.Response
 --- Default response hooks (aka. request handlers) configuration

spec/minimum_init.lua

@@ -13,6 +13,11 @@ end
 vim.opt.runtimepath:append(rest_nvim_dir)
 vim.g.rest_nvim = {
   _log_level = vim.log.levels.INFO,
+  request = {
+    hooks = {
+      set_user_agent = false,
+    }
+  },
   cookies = {
     path = "/tmp/rest-nvim.cookies"
   },