mirror of
https://github.com/neovim/neovim.git
synced 2026-04-14 19:46:10 +00:00
45f50d238a
Problem Cannot specify headers in vim.net.request() call. Solution Support opts.headers in vim.net.request opts.
144 lines
4.1 KiB
Lua
144 lines
4.1 KiB
Lua
local M = {}
|
|
|
|
---@class vim.net.request.Opts
|
|
---@inlinedoc
|
|
---
|
|
---Enables verbose output.
|
|
---@field verbose? boolean
|
|
---
|
|
---Number of retries on transient failures (default: 3).
|
|
---@field retry? integer
|
|
---
|
|
---File path to save the response body to.
|
|
---@field outpath? string
|
|
---
|
|
---Buffer to save the response body to.
|
|
---@field outbuf? integer
|
|
---
|
|
---Table of custom headers to send with the request.
|
|
---Supports basic key/value header formats and empty headers as supported by curl.
|
|
---Does not support @filename style, internal header deletion (e.g: 'Header:').
|
|
---@field headers? table<string, string>
|
|
|
|
---@class vim.net.request.Response
|
|
---
|
|
---The HTTP body of the request
|
|
---@field body string
|
|
|
|
--- Makes an HTTP GET request to the given URL, asynchronously passing the result to the specified
|
|
--- `on_response`, `outpath` or `outbuf`.
|
|
---
|
|
--- Examples:
|
|
--- ```lua
|
|
--- -- Write response body to file
|
|
--- vim.net.request('https://neovim.io/charter/', {
|
|
--- outpath = 'vision.html',
|
|
--- })
|
|
---
|
|
--- -- Process the response
|
|
--- vim.net.request(
|
|
--- 'https://api.github.com/repos/neovim/neovim',
|
|
--- {},
|
|
--- function (err, res)
|
|
--- if err then return end
|
|
--- local stars = vim.json.decode(res.body).stargazers_count
|
|
--- vim.print(('Neovim currently has %d stars'):format(stars))
|
|
--- end
|
|
--- )
|
|
---
|
|
--- -- Write to both file and current buffer, but cancel it
|
|
--- local job = vim.net.request('https://neovim.io/charter/', {
|
|
--- outpath = 'vision.html',
|
|
--- outbuf = 0,
|
|
--- })
|
|
--- job:close()
|
|
---
|
|
--- -- Add custom headers in the request
|
|
--- vim.net.request('https://neovim.io/charter/', {
|
|
--- headers = { Authorization = 'Bearer XYZ' },
|
|
--- })
|
|
--- ```
|
|
---
|
|
--- @param url string The URL for the request.
|
|
--- @param opts? vim.net.request.Opts
|
|
--- @param on_response? fun(err: string?, response: vim.net.request.Response?)
|
|
--- Callback invoked on request completion. The `body` field in the response
|
|
--- parameter contains the raw response data (text or binary).
|
|
--- @return { close: fun() } # Table with method to cancel, similar to [vim.SystemObj].
|
|
function M.request(url, opts, on_response)
|
|
vim.validate('url', url, 'string')
|
|
vim.validate('opts', opts, 'table', true)
|
|
vim.validate('on_response', on_response, 'function', true)
|
|
|
|
opts = opts or {}
|
|
local retry = opts.retry or 3
|
|
|
|
-- Build curl command
|
|
local args = { 'curl' }
|
|
if opts.verbose then
|
|
table.insert(args, '--verbose')
|
|
else
|
|
vim.list_extend(args, { '--silent', '--show-error', '--fail' })
|
|
end
|
|
vim.list_extend(args, { '--location', '--retry', tostring(retry) })
|
|
|
|
if opts.outpath then
|
|
vim.list_extend(args, { '--output', opts.outpath })
|
|
end
|
|
|
|
if opts.headers then
|
|
vim.validate('opts.headers', opts.headers, 'table', true)
|
|
for key, value in pairs(opts.headers) do
|
|
if type(key) ~= 'string' or type(value) ~= 'string' then
|
|
error('headers keys and values must be strings')
|
|
end
|
|
|
|
if key:match(':$') or key:match(';$') or key:match('^@') then
|
|
error('header keys must not start with @ or end with : and ;')
|
|
end
|
|
|
|
if value == '' then
|
|
vim.list_extend(args, { '-H', key .. ';' })
|
|
else
|
|
vim.list_extend(args, { '-H', key .. ': ' .. value })
|
|
end
|
|
end
|
|
end
|
|
|
|
table.insert(args, url)
|
|
|
|
local job = vim.system(args, {}, function(res)
|
|
---@type string?, vim.net.request.Response?
|
|
local err, response = nil, nil
|
|
if res.signal ~= 0 then
|
|
err = ('Request killed with signal %d'):format(res.signal)
|
|
elseif res.code ~= 0 then
|
|
err = res.stderr ~= '' and res.stderr or ('Request failed with exit code %d'):format(res.code)
|
|
else
|
|
if on_response then
|
|
response = { body = res.stdout or '' }
|
|
end
|
|
end
|
|
|
|
-- nvim_buf_is_loaded and nvim_buf_set_lines are not allowed in fast context
|
|
vim.schedule(function()
|
|
if res.code == 0 and opts.outbuf and vim.api.nvim_buf_is_loaded(opts.outbuf) then
|
|
local lines = vim.split(res.stdout, '\n', { plain = true })
|
|
vim.api.nvim_buf_set_lines(opts.outbuf, 0, -1, true, lines)
|
|
end
|
|
end)
|
|
|
|
if on_response then
|
|
on_response(err, response)
|
|
end
|
|
end)
|
|
|
|
return {
|
|
close = function()
|
|
job:kill('sigint')
|
|
end,
|
|
}
|
|
end
|
|
|
|
return M
|