Eglot not works correctly on macOS #1282

jessie-hu-95 · 2023-09-05T02:59:27Z

jessie-hu-95
Sep 5, 2023

Hi, everyone

I have used Eglot for about six mouths. It works well, and I enjoyed it. At that time I have run Emacs 28. After switching to Emacs 29, Eglot does work fine for several days. But recently, it cannot work. I'm sorry for no clues why things go wrong. Maybe some system or package updating?

Here is my environment:

OS: macOS Ventura 13.5.1
Emacs (from macports package emacs-mac-app): GNU Emacs 29.1 (build 1, aarch64-apple-darwin22.5.0, Carbon Version 169 AppKit 2299.6) of 2023-08-30
Eglot (built-in version): 1.12.29 (copy from its source file)

And I have no any configuration on Emacs.

Here is a simple python example which would reproduce the issue:

def foo(msg):
    print(msg)

I start Eglot by M-x eglot in the file buffer, and enter pylsp as the server program. The echo area prompts

[eglot] Connected! Server `pylsp' now managing `(python-mode python-ts-mode)' buffers in project `tmp'.

I open the eglot-events-buffer. Then I navigate to the second occurence of msg in the source file, M-. to find declaration. The echo area says

No definitions found for: LSP identifier at point

The Eglot event buffer shows (the source file location is /private/tmp/test.py):

[internal] Tue Sep  5 10:56:31 2023:
(:message "Running language server: /opt/local/bin/pylsp")
[client-request] (id:1) Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :id 1 :method "initialize" :params
	  (:processId 1470 :rootPath "/tmp/" :rootUri "file:///private/tmp" :initializationOptions #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
														 ())
		      :capabilities
		      (:workspace
		       (:applyEdit t :executeCommand
				   (:dynamicRegistration :json-false)
				   :workspaceEdit
				   (:documentChanges t)
				   :didChangeWatchedFiles
				   (:dynamicRegistration t)
				   :symbol
				   (:dynamicRegistration :json-false)
				   :configuration t :workspaceFolders t)
		       :textDocument
		       (:synchronization
			(:dynamicRegistration :json-false :willSave t :willSaveWaitUntil t :didSave t)
			:completion
			(:dynamicRegistration :json-false :completionItem
					      (:snippetSupport :json-false :deprecatedSupport t :resolveSupport
							       (:properties
								["documentation" "details" "additionalTextEdits"])
							       :tagSupport
							       (:valueSet
								[1]))
					      :contextSupport t)
			:hover
			(:dynamicRegistration :json-false :contentFormat
					      ["plaintext"])
			:signatureHelp
			(:dynamicRegistration :json-false :signatureInformation
					      (:parameterInformation
					       (:labelOffsetSupport t)
					       :activeParameterSupport t))
			:references
			(:dynamicRegistration :json-false)
			:definition
			(:dynamicRegistration :json-false :linkSupport t)
			:declaration
			(:dynamicRegistration :json-false :linkSupport t)
			:implementation
			(:dynamicRegistration :json-false :linkSupport t)
			:typeDefinition
			(:dynamicRegistration :json-false :linkSupport t)
			:documentSymbol
			(:dynamicRegistration :json-false :hierarchicalDocumentSymbolSupport t :symbolKind
					      (:valueSet
					       [1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26]))
			:documentHighlight
			(:dynamicRegistration :json-false)
			:codeAction
			(:dynamicRegistration :json-false :codeActionLiteralSupport
					      (:codeActionKind
					       (:valueSet
						["quickfix" "refactor" "refactor.extract" "refactor.inline" "refactor.rewrite" "source" "source.organizeImports"]))
					      :isPreferredSupport t)
			:formatting
			(:dynamicRegistration :json-false)
			:rangeFormatting
			(:dynamicRegistration :json-false)
			:rename
			(:dynamicRegistration :json-false)
			:inlayHint
			(:dynamicRegistration :json-false)
			:publishDiagnostics
			(:relatedInformation :json-false :codeDescriptionSupport :json-false :tagSupport
					     (:valueSet
					      [1 2])))
		       :window
		       (:workDoneProgress t)
		       :general
		       (:positionEncodings
			["utf-32" "utf-8" "utf-16"])
		       :experimental #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
						   ()))
		      :workspaceFolders
		      [(:uri "file:///private/tmp" :name "/tmp/")]))
[server-reply] (id:1) Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :id 1 :result
	  (:capabilities
	   (:codeActionProvider t :codeLensProvider
				(:resolveProvider :json-false)
				:completionProvider
				(:resolveProvider t :triggerCharacters
						  ["."])
				:documentFormattingProvider t :documentHighlightProvider t :documentRangeFormattingProvider t :documentSymbolProvider t :definitionProvider t :executeCommandProvider
				(:commands
				 [])
				:hoverProvider t :referencesProvider t :renameProvider t :foldingRangeProvider t :signatureHelpProvider
				(:triggerCharacters
				 ["(" "," "="])
				:textDocumentSync
				(:change 2 :save
					 (:includeText t)
					 :openClose t)
				:workspace
				(:workspaceFolders
				 (:supported t :changeNotifications t))
				:experimental nil)
	   :serverInfo
	   (:name "pylsp" :version "1.7.4")))
[client-notification] Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :method "initialized" :params #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
							    ()))
[client-notification] Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :method "textDocument/didOpen" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py" :version 0 :languageId "python" :text "def main(msg):\n    print(msg)\n")))
[client-notification] Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :method "workspace/didChangeConfiguration" :params
	  (:settings #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data
				   ())))
[server-notification] Tue Sep  5 10:56:31 2023:
(:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params
	  (:uri "file:///private/tmp/test.py" :diagnostics
		[]))
[client-request] (id:2) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 2 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 0)))
[client-request] (id:3) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 3 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 0)))
[client-request] (id:4) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 4 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 0)))
[server-reply] (id:2) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 2 :result nil)
[server-reply] (id:3) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 3 :result
	  (:contents ""))
[server-reply] (id:4) Tue Sep  5 10:56:40 2023:
(:jsonrpc "2.0" :id 4 :result nil)
[client-request] (id:5) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 5 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 14)))
[client-request] (id:6) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 6 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 14)))
[client-request] (id:7) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 7 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 14)))
[server-reply] (id:5) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 5 :result nil)
[server-reply] (id:6) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 6 :result
	  (:contents ""))
[server-reply] (id:7) Tue Sep  5 10:56:42 2023:
(:jsonrpc "2.0" :id 7 :result nil)
[client-request] (id:8) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 8 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 9)))
[client-request] (id:9) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 9 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 9)))
[client-request] (id:10) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 10 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 9)))
[server-reply] (id:8) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 8 :result nil)
[server-reply] (id:9) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 9 :result
	  (:contents ""))
[server-reply] (id:10) Tue Sep  5 10:56:43 2023:
(:jsonrpc "2.0" :id 10 :result nil)
[client-request] (id:11) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 11 :method "textDocument/signatureHelp" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 10)))
[client-request] (id:12) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 12 :method "textDocument/hover" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 10)))
[client-request] (id:13) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 13 :method "textDocument/documentHighlight" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 10)))
[server-reply] (id:11) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 11 :result nil)
[server-reply] (id:12) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 12 :result
	  (:contents ""))
[server-reply] (id:13) Tue Sep  5 10:56:44 2023:
(:jsonrpc "2.0" :id 13 :result nil)
[client-request] (id:14) Tue Sep  5 10:56:47 2023:
(:jsonrpc "2.0" :id 14 :method "textDocument/definition" :params
	  (:textDocument
	   (:uri "file:///private/tmp/test.py")
	   :position
	   (:line 1 :character 10)))
[server-reply] (id:14) Tue Sep  5 10:56:47 2023:
(:jsonrpc "2.0" :id 14 :result
	  [])

Thanks for your helps!

joaotavora · 2023-09-05T08:35:23Z

joaotavora
Sep 5, 2023
Maintainer

Then I navigate to the second occurence of msg in the source file, M-. to find declaration. T

So you want a M-. pressed on the msg symbol to go to the first line where the msg formal arg is located?

I would say that use of M-. is more exotic. But it can be used for that, sure, if the server wants to support it.

Maybe some system or package updating?

I can't say for sure, but it would seem that a previous version of pylsp you had installed in your system supported this use case for M-. and the one you have installed right now doesn't. I don't think Eglot has anything to do with this.

Have you tried other Python language servers (i.e. "pyright")

Can you say if a slightly more complicated example like:

def bar(): 
    pass

def foo()
    bar()

will allow a M-. on bar() to go to the first line of the definition def bar(): ?

6 replies

joaotavora Sep 6, 2023
Maintainer

I have tried clangd on many C++ projects. Eglot used to work correctly with these projects.

And now it doesn't? Is that what you mean.

I tried this and it gives the same result.

Which is... it doesn't go to the first definition of def bar():

I suspect this perhaps a network communication problem.

I don't think so, honestly. If it were a network communication problem, you wouldn't see much in the eglot events buffer, and you do.

By the way, could you tell me some common uses of M-., out of curiosity?

Jumping between functions is more common than jumping between local variable use and local variable definition. But, as I said, both are possible -- as long as the server supports them.

jessie-hu-95 Sep 6, 2023
Author

And now it doesn't? Is that what you mean.

Yes.

Which is... it doesn't go to the first definition of def bar():

Yes.

Sorry for my confusing expression. 🥲

joaotavora Sep 6, 2023
Maintainer

And now it doesn't? Is that what you mean.

Yes.

For C/C++ projects and clangd? This is very odd. Can you post a recipe for that, of a simple C or C++ program with two functions and a clangd invocation? Then share the events log again, please.

jessie-hu-95 Sep 6, 2023
Author

Yes, you are right. I tried a simple C++ example. Eglot works. And I tried to recompile one of my projects, it also works. There may be something wrong with the compile_commands.json file.

I tried to save logs of pylsp to see what happens. Here are logs when I press M-. on bar():

2023-09-06 18:08:33,591 CST - DEBUG - pylsp_jsonrpc.endpoint - Handling request from client {'jsonrpc': '2.0', 'id': 2, 'method': 'textDocument/definition', 'params': {'textDocument': {'uri': 'file:///private/tmp/test.py'}, 'position': {'line': 4, 'character': 4}}}
2023-09-06 18:08:33,592 CST - DEBUG - pylsp.config.config -   pylsp_definitions [hook]
      config: <pylsp.config.config.Config object at 0x1064eac90>
      workspace: <pylsp.workspace.Workspace object at 0x106569610>
      document: file:///private/tmp/test.py
      position: {'line': 4, 'character': 4}

2023-09-06 18:08:33,592 CST - DEBUG - pylsp.config.config -   finish pylsp_definitions --> [] [hook]

2023-09-06 18:08:33,592 CST - DEBUG - pylsp_jsonrpc.endpoint - Got result from synchronous request handler: []

I cannot find something strange... May I should create an issue on their repository.

I would try another language server (pyright) later.

Thanks very much! 😀

jessie-hu-95 Sep 7, 2023
Author

I tried pyright-langserver. It works perfectly!! I will create an issue on pylsp code repository.

Thank you very much!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eglot not works correctly on macOS #1282

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 6 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Eglot not works correctly on macOS #1282

Uh oh!

Uh oh!

jessie-hu-95 Sep 5, 2023

Replies: 1 comment · 6 replies

Uh oh!

joaotavora Sep 5, 2023 Maintainer

Uh oh!

joaotavora Sep 6, 2023 Maintainer

Uh oh!

jessie-hu-95 Sep 6, 2023 Author

Uh oh!

joaotavora Sep 6, 2023 Maintainer

Uh oh!

jessie-hu-95 Sep 6, 2023 Author

Uh oh!

jessie-hu-95 Sep 7, 2023 Author

jessie-hu-95
Sep 5, 2023

Replies: 1 comment 6 replies

joaotavora
Sep 5, 2023
Maintainer

joaotavora Sep 6, 2023
Maintainer

jessie-hu-95 Sep 6, 2023
Author

joaotavora Sep 6, 2023
Maintainer

jessie-hu-95 Sep 6, 2023
Author

jessie-hu-95 Sep 7, 2023
Author