Emacs eglot gets `Internal error` when processing `workspace/configuration` server request

[buzztaiki]

Describe the bug

When using yaml-language-server with Emacs eglot, an error occurs while processing the workspace/configuration request. This is likely because scopeUri is set to the string "null".

[jsonrpc] e[17:12:40.142] --> workspace/didChangeConfiguration {"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{}}}
[jsonrpc] e[17:12:40.156] <-- workspace/configuration[0] {"jsonrpc":"2.0","id":0,"method":"workspace/configuration","params":{"items":[{"section":"yaml"},{"section":"http"},{"section":"[yaml]","scopeUri":"null"},{"section":"editor"},{"section":"files"}]}}
[jsonrpc] e[17:12:40.157] --> workspace/configuration[0] {"jsonrpc":"2.0","id":0,"error":{"code":-32603,"message":"Internal error"}}
[jsonrpc] e[17:12:40.157] <-- workspace/configuration[1] {"jsonrpc":"2.0","id":1,"method":"workspace/configuration","params":{"items":[{"section":"yaml"},{"section":"http"},{"section":"[yaml]","scopeUri":"null"},{"section":"editor"},{"section":"files"}]}}
[jsonrpc] e[17:12:40.158] --> workspace/configuration[1] {"jsonrpc":"2.0","id":1,"error":{"code":-32603,"message":"Internal error"}}
[jsonrpc] e[17:12:40.164] <-- window/logMessage {"jsonrpc":"2.0","method":"window/logMessage","params":{"type":1,"message":"Error: Internal error\n    at handleResponse (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:565:48)\n    at handleMessage (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:345:13)\n    at processMessageQueue (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:362:17)\n    at Immediate.<anonymous> (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:334:13)\n    at process.processImmediate (node:internal/timers:504:21)"}}
[jsonrpc] e[17:12:40.164] <-- window/logMessage {"jsonrpc":"2.0","method":"window/logMessage","params":{"type":1,"message":"Error: Internal error\n    at handleResponse (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:565:48)\n    at handleMessage (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:345:13)\n    at processMessageQueue (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:362:17)\n    at Immediate.<anonymous> (/usr/lib/node_modules/yaml-language-server/node_modules/vscode-jsonrpc/lib/common/connection.js:334:13)\n    at process.processImmediate (node:internal/timers:504:21)"}}

Expected Behavior

Opening a YAML file should not produce an Internal error, and yaml-language-server should work normally.

Current Behavior

An Internal error occurs when opening a YAML file, making yaml-language-server unusable.

Steps to Reproduce

1. Open a YAML file.
2. An Internal error is recorded in the event log, after which LSP features become unavailable.

Environment

• Windows
• Mac
• Linux
• other (please specify)

[buzztaiki]

I think this is caused by the fix in #1137. If eglot should handle the string "null" on its side, I will file a bug report to eglot instead.

[buzztaiki]

Backtrace of eglot

Details

Debugger entered--Lisp error: (wrong-type-argument stringp nil)
  file-remote-p(nil)
  hack-dir-local-variables()
  hack-dir-local-variables-non-file-buffer()
  (progn (setq default-directory (if path (if (file-directory-p path) (file-name-as-directory path) (file-name-directory path)) (project-root (eglot--project server)))) (setq major-mode (car (eglot--major-modes server))) (hack-dir-local-variables-non-file-buffer) (if (functionp eglot-workspace-configuration) (funcall eglot-workspace-configuration server) eglot-workspace-configuration))
  (unwind-protect (progn (setq default-directory (if path (if (file-directory-p path) (file-name-as-directory path) (file-name-directory path)) (project-root (eglot--project server)))) (setq major-mode (car (eglot--major-modes server))) (hack-dir-local-variables-non-file-buffer) (if (functionp eglot-workspace-configuration) (funcall eglot-workspace-configuration server) eglot-workspace-configuration)) (and (buffer-name temp-buffer) (kill-buffer temp-buffer)))
  (save-current-buffer (set-buffer temp-buffer) (unwind-protect (progn (setq default-directory (if path (if (file-directory-p path) (file-name-as-directory path) (file-name-directory path)) (project-root (eglot--project server)))) (setq major-mode (car (eglot--major-modes server))) (hack-dir-local-variables-non-file-buffer) (if (functionp eglot-workspace-configuration) (funcall eglot-workspace-configuration server) eglot-workspace-configuration)) (and (buffer-name temp-buffer) (kill-buffer temp-buffer))))
  (let ((temp-buffer (generate-new-buffer " *temp*" t))) (save-current-buffer (set-buffer temp-buffer) (unwind-protect (progn (setq default-directory (if path (if (file-directory-p path) (file-name-as-directory path) (file-name-directory path)) (project-root (eglot--project server)))) (setq major-mode (car (eglot--major-modes server))) (hack-dir-local-variables-non-file-buffer) (if (functionp eglot-workspace-configuration) (funcall eglot-workspace-configuration server) eglot-workspace-configuration)) (and (buffer-name temp-buffer) (kill-buffer temp-buffer)))))
  (let ((val (let ((temp-buffer (generate-new-buffer " *temp*" t))) (save-current-buffer (set-buffer temp-buffer) (unwind-protect (progn (setq default-directory ...) (setq major-mode ...) (hack-dir-local-variables-non-file-buffer) (if ... ... eglot-workspace-configuration)) (and (buffer-name temp-buffer) (kill-buffer temp-buffer))))))) (or (and (consp (car val)) (let* ((--cl-var-- val) (v nil) (section nil) (--cl-var-- nil)) (while (consp --cl-var--) (progn (setq v (car --cl-var--)) (setq section (car-safe ...))) (setq --cl-var-- (cons (if ... section ...) --cl-var--)) (setq --cl-var-- (cons v --cl-var--)) (setq --cl-var-- (cdr --cl-var--))) (nreverse --cl-var--))) val))
  eglot--workspace-configuration-plist(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> "null")
  (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn (setq --cl-var-- --cl-var--) (setq wsection (car-safe (prog1 --cl-var-- ...))) (setq o (car --cl-var--))) (if (string= (if (keywordp wsection) (substring ... 1) wsection) section) (progn (setq --cl-var-- o) (setq --cl-var-- nil)) t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--)
  (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn (setq --cl-var-- --cl-var--) (setq wsection (car-safe ...)) (setq o (car --cl-var--))) (if (string= (if ... ... wsection) section) (progn (setq --cl-var-- o) (setq --cl-var-- nil)) t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--))
  (let* ((--cl-rest-- object-once) (scopeUri (car (cdr (plist-member --cl-rest-- ':scopeUri)))) (section (car (cdr (plist-member --cl-rest-- ':section))))) (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn (setq --cl-var-- --cl-var--) (setq wsection ...) (setq o ...)) (if (string= ... section) (progn ... ...) t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--)))
  (let ((object-once jsonrpc-lambda-elem14)) (let* ((--cl-rest-- object-once) (scopeUri (car (cdr (plist-member --cl-rest-- ':scopeUri)))) (section (car (cdr (plist-member --cl-rest-- ':section))))) (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn ... ... ...) (if ... ... t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--))))
  #f(lambda (jsonrpc-lambda-elem14) [(server #<eglot-lsp-server eglot-lsp-server-102571d73dcd>)] (let ((object-once jsonrpc-lambda-elem14)) (let* ((--cl-rest-- object-once) (scopeUri (car (cdr (plist-member --cl-rest-- ':scopeUri)))) (section (car (cdr (plist-member --cl-rest-- ':section))))) (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn (setq --cl-var-- --cl-var--) (setq wsection (car-safe (prog1 --cl-var-- (setq --cl-var-- (cdr --cl-var--))))) (setq o (car --cl-var--))) (if (string= (if (keywordp wsection) (substring (symbol-name wsection) 1) wsection) section) (progn (setq --cl-var-- o) (setq --cl-var-- nil)) t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--)))))((:section "[yaml]" :scopeUri "null"))
  mapcar(#f(lambda (jsonrpc-lambda-elem14) [(server #<eglot-lsp-server eglot-lsp-server-102571d73dcd>)] (let ((object-once jsonrpc-lambda-elem14)) (let* ((--cl-rest-- object-once) (scopeUri (car (cdr ...))) (section (car (cdr ...)))) (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path ...) (--cl-var-- ...) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and ... ...) (setq --cl-var-- ...)) --cl-var--))))) [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")])
  (apply #'vector (mapcar #'(lambda (jsonrpc-lambda-elem14) (let ((object-once jsonrpc-lambda-elem14)) (let* ((--cl-rest-- object-once) (scopeUri ...) (section ...)) (progn (eglot--check-object ... object-once ... ... ...) (let* ... ... --cl-var--))))) items))
  (progn (let ((--cl-keys-- --cl-rest--)) (while --cl-keys-- (cond ((memq (car --cl-keys--) '(:items :allow-other-keys)) (if (cdr --cl-keys--) nil (error "Missing argument for %s" (car --cl-keys--))) (setq --cl-keys-- (cdr (cdr --cl-keys--)))) ((car (cdr (memq ... --cl-rest--))) (setq --cl-keys-- nil)) (t (error "Keyword argument %s not one of (:items)" (car --cl-keys--)))))) (apply #'vector (mapcar #'(lambda (jsonrpc-lambda-elem14) (let ((object-once jsonrpc-lambda-elem14)) (let* (... ... ...) (progn ... ...)))) items)))
  (let* ((items (car (cdr (plist-member --cl-rest-- ':items))))) (progn (let ((--cl-keys-- --cl-rest--)) (while --cl-keys-- (cond ((memq (car --cl-keys--) '...) (if (cdr --cl-keys--) nil (error "Missing argument for %s" ...)) (setq --cl-keys-- (cdr ...))) ((car (cdr ...)) (setq --cl-keys-- nil)) (t (error "Keyword argument %s not one of (:items)" (car --cl-keys--)))))) (apply #'vector (mapcar #'(lambda (jsonrpc-lambda-elem14) (let (...) (let* ... ...))) items))))
  (progn (let* ((items (car (cdr (plist-member --cl-rest-- ':items))))) (progn (let ((--cl-keys-- --cl-rest--)) (while --cl-keys-- (cond ((memq ... ...) (if ... nil ...) (setq --cl-keys-- ...)) ((car ...) (setq --cl-keys-- nil)) (t (error "Keyword argument %s not one of (:items)" ...))))) (apply #'vector (mapcar #'(lambda (jsonrpc-lambda-elem14) (let ... ...)) items)))))
  #f(lambda (server _method &rest --cl-rest--) [revert-buffer-preserve-modes tramp-use-ssh-controlmaster-options tramp-ssh-controlmaster-options company-tooltip-align-annotations company-backends markdown-fontify-code-blocks-natively t] "Handle server request workspace/configuration.\n\n(fn SERVER METHOD &key ITEMS)" (progn (let* ((items (car (cdr (plist-member --cl-rest-- ':items))))) (progn (let ((--cl-keys-- --cl-rest--)) (while --cl-keys-- (cond ((memq (car --cl-keys--) '(:items :allow-other-keys)) (if (cdr --cl-keys--) nil (error "Missing argument for %s" (car --cl-keys--))) (setq --cl-keys-- (cdr (cdr --cl-keys--)))) ((car (cdr (memq ':allow-other-keys --cl-rest--))) (setq --cl-keys-- nil)) (t (error "Keyword argument %s not one of (:items)" (car --cl-keys--)))))) (apply #'vector (mapcar #'(lambda (jsonrpc-lambda-elem14) (let ((object-once jsonrpc-lambda-elem14)) (let* ((--cl-rest-- object-once) (scopeUri (car (cdr (plist-member --cl-rest-- ':scopeUri)))) (section (car (cdr (plist-member --cl-rest-- ':section))))) (progn (eglot--check-object 'ConfigurationItem object-once (memq 'enforce-required-keys eglot-strict-mode) (memq 'disallow-non-standard-keys eglot-strict-mode) (memq 'check-types eglot-strict-mode)) (let* ((scope-uri-path (and scopeUri (eglot-uri-to-path scopeUri))) (--cl-var-- (eglot--workspace-configuration-plist server scope-uri-path)) (wsection nil) (o nil) (--cl-var--) (--cl-var-- t) --cl-var--) (while (and (consp --cl-var--) (progn (progn (setq --cl-var-- --cl-var--) (setq wsection (car-safe (prog1 --cl-var-- (setq --cl-var-- (cdr --cl-var--))))) (setq o (car --cl-var--))) (if (string= (if (keywordp wsection) (substring (symbol-name wsection) 1) wsection) section) (progn (setq --cl-var-- o) (setq --cl-var-- nil)) t))) (setq --cl-var-- (cdr (cdr --cl-var--)))) --cl-var--))))) items))))))(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> workspace/configuration :items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")])
  apply(#f(lambda (server _method &rest --cl-rest--) [revert-buffer-preserve-modes tramp-use-ssh-controlmaster-options tramp-ssh-controlmaster-options company-tooltip-align-annotations company-backends markdown-fontify-code-blocks-natively t] "Handle server request workspace/configuration.\n\n(fn SERVER METHOD &key ITEMS)" (progn (let* ((items (car (cdr ...)))) (progn (let ((--cl-keys-- --cl-rest--)) (while --cl-keys-- (cond ... ... ...))) (apply #'vector (mapcar #'... items)))))) #<eglot-lsp-server eglot-lsp-server-102571d73dcd> workspace/configuration (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")]))
  eglot-handle-request(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> workspace/configuration :items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")])
  apply(eglot-handle-request #<eglot-lsp-server eglot-lsp-server-102571d73dcd> workspace/configuration (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")]))
  (let ((eglot--cached-server server)) (apply fn server method (append params nil)))
  #f(lambda (server method params) [(fn eglot-handle-request)] (let ((eglot--cached-server server)) (apply fn server method (append params nil))))(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> workspace/configuration (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")]))
  jsonrpc-connection-receive(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> (:jsonrpc "2.0" :id 0 :method "workspace/configuration" :params (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")])))
  #f(compiled-function (conn msg) #<bytecode -0x407e530f39a2f2e>)(#<eglot-lsp-server eglot-lsp-server-102571d73dcd> (:jsonrpc "2.0" :id 0 :method "workspace/configuration" :params (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")])))
  apply(#f(compiled-function (conn msg) #<bytecode -0x407e530f39a2f2e>) (#<eglot-lsp-server eglot-lsp-server-102571d73dcd> (:jsonrpc "2.0" :id 0 :method "workspace/configuration" :params (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")]))))
  timer-event-handler([t 27044 53938 230488 nil #f(compiled-function (conn msg) #<bytecode -0x407e530f39a2f2e>) (#<eglot-lsp-server eglot-lsp-server-102571d73dcd> (:jsonrpc "2.0" :id 0 :method "workspace/configuration" :params (:items [(:section "yaml") (:section "http") (:section "[yaml]" :scopeUri "null") (:section "editor") (:section "files")]))) nil 670000 nil])

[datho7561]

It looks like "null" isn't valid according to the spec since it's not a valid URI, so it's a client specific thing for VS Code. Based on the warning we get when not providing a scope, we should be able to set that field to null (not a string) in order to silence the error, but in practice this doesn't work and only the string null silences it properly.

If eglot wants to emulate VS Code, then maybe it's worth implementing on their end, but it goes against the spec, so it might not be worth it.

[datho7561]

See #1202 ; Helix also doesn't understand "null". We only really test regularly in VS Code and sometimes neovim, and it looks like vim has replicated VS Code's behaviour, likely because other languages were failing to launch for the same reason.

[128keaton]

Seeing a similar issue in Zed, removing the 'scopeUri' option from the response fixes the issue.
zed-industries/zed#49568