Godot GDScript problems

[mnewt]

lsp with GDScript mostly works fine but has two visible issues:

Problem 1

It repeatedly logs warnings and pops open the *Warnings* buffer. If I close the *Warnings* buffer, it just opens it up again. I presume there is a capability mismatch between Godot and lsp. Example *Warnings* entries:

Warning (lsp-mode): Unknown notification: gdscript/capabilities
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil

lsp-log: https://gist.github.com/mnewt/20339c243dba4a5138c1354e3a0c78fa

The first warning will pop up when lsp is started and the subsequent warnings will pop up from time to time while editing.

Problem 2

company completion doesn't work when company-box-mode is enabled. I think I've narrowed down the problem to what happens in lsp-completion--exit-fn. It goes something like this:

1. The lsp-completion-item plist entry has inside it :label and :insert-text?
2. When company-mode is enabled but company-box-mode is not, :insert-text? is nil.
3. When company-mode and company-box-mode are enabled, :insert-text? is "", so lsp-completion--exit-fn inserts that blank string.

I've confirmed that inserting this in lsp-completion--exit-fn does indeed cause the candidate to be inserted as expected:

(when (string-empty-p insert-text?) (setq insert-text? nil))

Questions

1. What can we do to fix the warnings?
2. If it's a lot of work to fix them, is there a way to silence them for now, or at least cause the *Warnings*buffer to not pop up every time one occurs?
3. Is the completion bug a problem in lsp or company-box? Can you clarify what is going on there?

Reproduction Steps:

emacs -Q

(custom-set-variables
 '(straight-use-package-by-default t)
 '(straight-vc-git-default-clone-depth 1))

(defvar bootstrap-version)
(let ((bootstrap-file
       (expand-file-name "straight/repos/straight.el/bootstrap.el" user-emacs-directory))
      (bootstrap-version 5))
  (unless (file-exists-p bootstrap-file)
    (with-current-buffer
        (url-retrieve-synchronously
         "https://raw.githubusercontent.com/raxod502/straight.el/develop/install.el"
         'silent 'inhibit-cookies)
      (goto-char (point-max))
      (eval-print-last-sexp)))
  (load bootstrap-file nil 'nomessage))

(straight-use-package 'use-package)

(use-package company
  :hook
  (prog-mode . company-mode))

(use-package company-box
  :hook
  (company-mode . company-box-mode))

(use-package lsp-mode)

(use-package gdscript-mode
  :straight ( :type git :host github :repo "godotengine/emacs-gdscript-mode")
  :hook
  (gdscript-mode . lsp))

Now, open a GDScript file and try to insert a completion using company, e.g.:

func _re

And do M-x company-complete, then M-x company-complete-selection

Versions

lsp: 7.0.1 (commit 1185a48)

GNU Emacs 28.0.50 (build 1, x86_64-apple-darwin19.6.0, NS appkit-1894.60 Version 10.15.6 (Build 19G2021)) of 2020-08-29

Godot 3.2.2

[yyoncho]

It repeatedly logs warnings and pops open the *Warnings* buffer. If I close
the *Warnings* buffer, it just opens it up again. I presume there is a
capability mismatch between Godot and lsp.

The issue is that servers from time to time introduce new notifications and we have to adjust lsp-mode accordingly.

company completion doesn't work when company-box-mode is enabled. I think
I've narrowed down the problem to what happens in lsp-completion--exit-fn. It
goes something like this:

@kiennq is using company-box - maybe we will need logs from the server to figure out
this issue. In is in general strange issue, because company-box should be
compatible with other frontends.

1. What can we do to fix the warnings?

The easy fix is to bind this notifications to nil - see https://github.com/yyoncho/lsp-mode/blob/master/clients/lsp-hack.el#L47

[kiennq]

Warning (lsp-mode): Unknown notification: nil

This indicates more serious issues, mostly due to lsp-mode is being wrongly compiled and installed.
You should probably reinstall lsp-mode for this.

company completion doesn't work when company-box-mode is enabled. I think
I've narrowed down the problem to what happens in lsp-completion--exit-fn. It
goes something like this:

I'm using a fork of company-box and haven't experience thing like that.
Can you narrow down the log to right before and after problem happens (maybe before/after a few key strokes is also fine)?
Well, if it not happens without company-box, I suspect that this is problem of company-box, it does check the candidate item to get completion kind, and may be setting insert-text? to wrong value accidentally.

[mnewt]

This indicates more serious issues, mostly due to lsp-mode is being wrongly compiled and installed.
You should probably reinstall lsp-mode for this.

I'm a bit stymied by that. I've reproduced the issue with emacs -Q and a fresh installation of lsp-mode. I've never seen an error like that from any other major mode while running lsp. However, if no one else sees this issue then I guess we should table it.

Can you narrow down the log to right before and after problem happens

That gist was narrowed down to a few keystrokes. I just did another one. Here were my steps

1. Load the gdscript file
2. Move to the end of the file
3. (setq lsp-log-io t)
4. Type vel into the buffer and wait for the counsel-box to appear (multiple second pause--the pause only happens when lsp-log-io is t)
5. (setq lsp-log-io nil)

Result: at least 50,000 lines. 100,000 if I cancel the counsel-box by pressing C-g.

Is there something I could do differently to narrow this down? Most of that appears to be happening as a direct result of company-capf.

Editing to add gist link: https://gist.github.com/mnewt/20339c243dba4a5138c1354e3a0c78fa#file-lsp-log-2

[kiennq]

I've taken a look at this, indeed no insertText is set.
Did this problem only happen with company-box? If you disable company-box will it still happens?

The insert-text can be intentionally to be "" to indicate deleting, so blindly assign it back to nil is not good, IMO.

[mnewt]

Did this problem only happen with company-box? If you disable company-box will it still happens?

Correct. Invoking company-complete-selection with normal company-mode completes and fills in the selection. Invoking it with company-box-mode enabled erases the selection, including the part I typed before the company completion popped up. It does seem that in my setup insertText gets set to "" only when company-box-mode AND gdscript-mode are enabled.

[hnmurz]

I'm also seeing this lsp warning issue.

Is there a way to disable the warning buffer from popping up everytime?

[kiennq]

@sebastiencs for company-box support. It seems that company-box somehow alternates selected completion item's properties?

[sebastiencs]

@kiennq @mnewt company-box doesn't alter the candidates properties. I will take a look

[yyoncho]

I'm also seeing this lsp warning issue.

Is there a way to disable the warning buffer from popping up everytime?

@hnmurz

Someone should bind the missing notification handlers to no-op like this - https://github.com/yyoncho/lsp-mode/blob/master/clients/lsp-hack.el#L47

[mnewt]

@yyoncho Thanks, I did try to add a notification handler:

(lsp-register-client
   (make-lsp-client :new-connection (lsp-gdscript-tcp-connect-to-port)
                    :major-modes '(gdscript-mode)
                    :server-id 'gdscript
                    ;; Ignore unsupported messages.
                    :notification-handlers (lsp-ht ("executeCommand" 'ignore))))

But I still get this in *Messages*:

(error "Method not found: executeCommand")

And this in *Warnings*:

Warning (lsp-mode): Unknown notification: gdscript/capabilities
Warning (lsp-mode): Unknown notification: nil
Warning (lsp-mode): Unknown notification: nil

Did I do what you had in mind?

[yyoncho]

You have to use "gdscript/capabilities" as a key to get rid of that notification. For the one with nil name, I will need the input of lsp--on-notification which you can get when you do M-x trace-function RET lsp--on-notification RET