aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/lsp/rpc.lua
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim/lsp/rpc.lua')
-rw-r--r--runtime/lua/vim/lsp/rpc.lua135
1 files changed, 37 insertions, 98 deletions
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index d31d94cab7..637cda84d3 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -5,8 +5,8 @@ local validate, schedule_wrap = vim.validate, vim.schedule_wrap
--- Embeds the given string into a table and correctly computes `Content-Length`.
---
----@param message string
----@return string message with `Content-Length` attribute
+--- @param message string
+--- @return string message with `Content-Length` attribute
local function format_message_with_content_length(message)
return table.concat({
'Content-Length: ',
@@ -16,104 +16,21 @@ local function format_message_with_content_length(message)
})
end
----@class (private) vim.lsp.rpc.Headers: {string: any}
----@field content_length integer
-
---- Parses an LSP Message's header
+--- Extract content-length from the header
---
----@param header string The header to parse.
----@return vim.lsp.rpc.Headers#parsed headers
-local function parse_headers(header)
- assert(type(header) == 'string', 'header must be a string')
- --- @type vim.lsp.rpc.Headers
- local headers = {}
- for line in vim.gsplit(header, '\r\n', { plain = true }) do
+--- @param header string The header to parse
+--- @return integer
+local function get_content_length(header)
+ for line in header:gmatch('(.-)\r\n') do
if line == '' then
break
end
- --- @type string?, string?
- local key, value = line:match('^%s*(%S+)%s*:%s*(.+)%s*$')
- if key then
- key = key:lower():gsub('%-', '_') --- @type string
- headers[key] = value
- else
- log.error('invalid header line %q', line)
- error(string.format('invalid header line %q', line))
- end
- end
- headers.content_length = tonumber(headers.content_length)
- or error(string.format('Content-Length not found in headers. %q', header))
- return headers
-end
-
--- This is the start of any possible header patterns. The gsub converts it to a
--- case insensitive pattern.
-local header_start_pattern = ('content'):gsub('%w', function(c)
- return '[' .. c .. c:upper() .. ']'
-end)
-
---- The actual workhorse.
-local function request_parser_loop()
- local buffer = '' -- only for header part
- while true do
- -- A message can only be complete if it has a double CRLF and also the full
- -- payload, so first let's check for the CRLFs
- local start, finish = buffer:find('\r\n\r\n', 1, true)
- -- Start parsing the headers
- if start then
- -- This is a workaround for servers sending initial garbage before
- -- sending headers, such as if a bash script sends stdout. It assumes
- -- that we know all of the headers ahead of time. At this moment, the
- -- only valid headers start with "Content-*", so that's the thing we will
- -- be searching for.
- -- TODO(ashkan) I'd like to remove this, but it seems permanent :(
- local buffer_start = buffer:find(header_start_pattern)
- if not buffer_start then
- error(
- string.format(
- "Headers were expected, a different response was received. The server response was '%s'.",
- buffer
- )
- )
- end
- local headers = parse_headers(buffer:sub(buffer_start, start - 1))
- local content_length = headers.content_length
- -- Use table instead of just string to buffer the message. It prevents
- -- a ton of strings allocating.
- -- ref. http://www.lua.org/pil/11.6.html
- ---@type string[]
- local body_chunks = { buffer:sub(finish + 1) }
- local body_length = #body_chunks[1]
- -- Keep waiting for data until we have enough.
- while body_length < content_length do
- ---@type string
- local chunk = coroutine.yield()
- or error('Expected more data for the body. The server may have died.') -- TODO hmm.
- table.insert(body_chunks, chunk)
- body_length = body_length + #chunk
- end
- local last_chunk = body_chunks[#body_chunks]
-
- body_chunks[#body_chunks] = last_chunk:sub(1, content_length - body_length - 1)
- local rest = ''
- if body_length > content_length then
- rest = last_chunk:sub(content_length - body_length)
- end
- local body = table.concat(body_chunks)
- -- Yield our data.
-
- --- @type string
- local data = coroutine.yield(headers, body)
- or error('Expected more data for the body. The server may have died.')
- buffer = rest .. data
- else
- -- Get more data since we don't have enough.
- --- @type string
- local data = coroutine.yield()
- or error('Expected more data for the header. The server may have died.')
- buffer = buffer .. data
+ local key, value = line:match('^%s*(%S+)%s*:%s*(%d+)%s*$')
+ if key and key:lower() == 'content-length' then
+ return assert(tonumber(value))
end
end
+ error('Content-Length not found in header: ' .. header)
end
local M = {}
@@ -232,12 +149,34 @@ local default_dispatchers = {
end,
}
+local strbuffer = require('vim._stringbuffer')
+
+local function request_parser_loop()
+ local buf = strbuffer.new()
+ while true do
+ local msg = buf:tostring()
+ local header_end = msg:find('\r\n\r\n', 1, true)
+ if header_end then
+ local header = buf:get(header_end + 1)
+ buf:skip(2) -- skip past header boundary
+ local content_length = get_content_length(header)
+ while strbuffer.len(buf) < content_length do
+ buf:put(coroutine.yield())
+ end
+ local body = buf:get(content_length)
+ buf:put(coroutine.yield(body))
+ else
+ buf:put(coroutine.yield())
+ end
+ end
+end
+
--- @private
--- @param handle_body fun(body: string)
--- @param on_exit? fun()
--- @param on_error fun(err: any)
function M.create_read_loop(handle_body, on_exit, on_error)
- local parse_chunk = coroutine.wrap(request_parser_loop) --[[@as fun(chunk: string?): vim.lsp.rpc.Headers?, string?]]
+ local parse_chunk = coroutine.wrap(request_parser_loop) --[[@as fun(chunk: string?): string]]
parse_chunk()
return function(err, chunk)
if err then
@@ -253,9 +192,9 @@ function M.create_read_loop(handle_body, on_exit, on_error)
end
while true do
- local headers, body = parse_chunk(chunk)
- if headers then
- handle_body(assert(body))
+ local body = parse_chunk(chunk)
+ if body then
+ handle_body(body)
chunk = ''
else
break