No delegateCommandHandler for java.apply.workspaceEdit #376

idanarye · 2017-10-03T17:01:53Z

I'm using jdt.ls via LanguageClient-neovim, and I'm trying to use code actions. This is my file:

public class App {
    public static void main(String[] args) {
        JFrame frame = new JFrame();
    }
}

JFrame is linted because I did not import it, and the LS suggests some code actions(this is from the log of the client - I just formatted the JSON lines to make them readable):

17:06:19 INFO    [MainThread] Begin textDocument/codeAction
17:06:19 DEBUG   [MainThread] =>
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "textDocument/codeAction",
  "params": {
    "textDocument": {
      "uri": "file:///files/tests/java/45/src/main/java/App.java"
    },
    "range": {
      "start": {
        "line": 2,
        "character": 8
      },
      "end": {
        "line": 2,
        "character": 14
      }
    },
    "context": {
      "diagnostics": [
        {
          "range": {
            "start": {
              "line": 2,
              "character": 8
            },
            "end": {
              "line": 2,
              "character": 14
            }
          },
          "severity": 1,
          "code": "16777218",
          "source": "Java",
          "message": "JFrame cannot be resolved to a type"
        }
      ]
    }
  }
}
17:06:19 DEBUG   [RPC-java  ] <= {"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"Oct 3, 2017 5:05:52 PM \u003e\u003e document/codeAction"}}
17:06:19 DEBUG   [RPC-java  ] <=
{
  "jsonrpc": "2.0",
  "id": "1",
  "result": [
    {
      "title": "Change to 'JobName' (javax.print.attribute.standard)",
      "command": "java.apply.workspaceEdit",
      "arguments": [
        {
          "changes": {
            "file:///files/tests/java/45/src/main/java/App.java": [
              {
                "range": {
                  "start": {
                    "line": 0,
                    "character": 0
                  },
                  "end": {
                    "line": 0,
                    "character": 0
                  }
                },
                "newText": "import javax.print.attribute.standard.JobName;"
              },
              {
                "range": {
                  "start": {
                    "line": 0,
                    "character": 0
                  },
                  "end": {
                    "line": 0,
                    "character": 0
                  }
                },
                "newText": "\n\n"
              },
              {
                "range": {
                  "start": {
                    "line": 2,
                    "character": 8
                  },
                  "end": {
                    "line": 2,
                    "character": 8
                  }
                },
                "newText": "JobName"
              },
              {
                "range": {
                  "start": {
                    "line": 2,
                    "character": 8
                  },
                  "end": {
                    "line": 2,
                    "character": 14
                  }
                },
                "newText": ""
              }
            ]
          }
        }
      ]
    },
    {
      "title": "Import 'JFrame' (javax.swing)",
      "command": "java.apply.workspaceEdit",
      "arguments": [
        {
          "changes": {
            "file:///files/tests/java/45/src/main/java/App.java": [
              {
                "range": {
                  "start": {
                    "line": 0,
                    "character": 0
                  },
                  "end": {
                    "line": 0,
                    "character": 0
                  }
                },
                "newText": "import javax.swing.JFrame;"
              },
              {
                "range": {
                  "start": {
                    "line": 0,
                    "character": 0
                  },
                  "end": {
                    "line": 0,
                    "character": 0
                  }
                },
                "newText": "\n\n"
              }
            ]
          }
        }
      ]
    },
    {
      "title": "Add type parameter 'JFrame' to 'main(String[])'",
      "command": "java.apply.workspaceEdit",
      "arguments": [
        {
          "changes": {
            "file:///files/tests/java/45/src/main/java/App.java": [
              {
                "range": {
                  "start": {
                    "line": 1,
                    "character": 18
                  },
                  "end": {
                    "line": 1,
                    "character": 18
                  }
                },
                "newText": "<"
              },
              {
                "range": {
                  "start": {
                    "line": 1,
                    "character": 18
                  },
                  "end": {
                    "line": 1,
                    "character": 18
                  }
                },
                "newText": "JFrame"
              },
              {
                "range": {
                  "start": {
                    "line": 1,
                    "character": 18
                  },
                  "end": {
                    "line": 1,
                    "character": 18
                  }
                },
                "newText": "> "
              }
            ]
          }
        }
      ]
    }
  ]
}
17:06:19 DEBUG   [MainThread] state.codeActionCommands: [] =>
[
  {
    "title": "Change to 'JobName' (javax.print.attribute.standard)",
    "command": "java.apply.workspaceEdit",
    "arguments": [
      {
        "changes": {
          "file:///files/tests/java/45/src/main/java/App.java": [
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "import javax.print.attribute.standard.JobName;"
            },
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "\n\n"
            },
            {
              "range": {
                "start": {
                  "line": 2,
                  "character": 8
                },
                "end": {
                  "line": 2,
                  "character": 8
                }
              },
              "newText": "JobName"
            },
            {
              "range": {
                "start": {
                  "line": 2,
                  "character": 8
                },
                "end": {
                  "line": 2,
                  "character": 14
                }
              },
              "newText": ""
            }
          ]
        }
      }
    ]
  },
  {
    "title": "Import 'JFrame' (javax.swing)",
    "command": "java.apply.workspaceEdit",
    "arguments": [
      {
        "changes": {
          "file:///files/tests/java/45/src/main/java/App.java": [
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "import javax.swing.JFrame;"
            },
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "\n\n"
            }
          ]
        }
      }
    ]
  },
  {
    "title": "Add type parameter 'JFrame' to 'main(String[])'",
    "command": "java.apply.workspaceEdit",
    "arguments": [
      {
        "changes": {
          "file:///files/tests/java/45/src/main/java/App.java": [
            {
              "range": {
                "start": {
                  "line": 1,
                  "character": 18
                },
                "end": {
                  "line": 1,
                  "character": 18
                }
              },
              "newText": "<"
            },
            {
              "range": {
                "start": {
                  "line": 1,
                  "character": 18
                },
                "end": {
                  "line": 1,
                  "character": 18
                }
              },
              "newText": "JFrame"
            },
            {
              "range": {
                "start": {
                  "line": 1,
                  "character": 18
                },
                "end": {
                  "line": 1,
                  "character": 18
                }
              },
              "newText": "> "
            }
          ]
        }
      }
    ]
  }
]
17:06:19 INFO    [MainThread] End textDocument/codeAction

So I pick Import 'JFrame' (javax.swing):

17:06:44 INFO    [MainThread] Begin workspace/executeCommand
17:06:44 DEBUG   [MainThread] =>
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "workspace/executeCommand",
  "params": {
    "command": "java.apply.workspaceEdit",
    "arguments": [
      {
        "changes": {
          "file:///files/tests/java/45/src/main/java/App.java": [
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "import javax.print.attribute.standard.JobName;"
            },
            {
              "range": {
                "start": {
                  "line": 0,
                  "character": 0
                },
                "end": {
                  "line": 0,
                  "character": 0
                }
              },
              "newText": "\n\n"
            },
            {
              "range": {
                "start": {
                  "line": 2,
                  "character": 8
                },
                "end": {
                  "line": 2,
                  "character": 8
                }
              },
              "newText": "JobName"
            },
            {
              "range": {
                "start": {
                  "line": 2,
                  "character": 8
                },
                "end": {
                  "line": 2,
                  "character": 14
                }
              },
              "newText": ""
            }
          ]
        }
      }
    ]
  }
}
17:06:44 DEBUG   [RPC-java  ] <= {"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"Oct 3, 2017 5:05:52 PM \u003e\u003e workspace/executeCommand"}}
17:06:44 DEBUG   [RPC-java  ] <= {"jsonrpc":"2.0","id":"2","error":{"code":-32601,"message":"No delegateCommandHandler for java.apply.workspaceEdit"}}
17:06:44 ERROR   [MainThread] {"jsonrpc": "2.0", "id": "2", "error": {"code": -32601, "message": "No delegateCommandHandler for java.apply.workspaceEdit"}}
17:06:44 INFO    [MainThread] End workspace/executeCommand

And get the error message - No delegateCommandHandler for java.apply.workspaceEdit

The LSP specs does not seem to refer to delegateCommandHandlers, and from #346 it looks like it's jdt.ls' extension - but I don't see any instructions on how to use it.

So... what do I need to do to add support for it in a client?

The text was updated successfully, but these errors were encountered:

fbricon · 2017-10-03T17:46:08Z

Yeah documenting jdt.ls specific commands is in our backlog (#314), sorry about that.

java.apply.workspaceEdit is not related to delegateCommandHandlers actually (those are server side extensions). It's a command that needs to be implemented by clients. See how it's done in vscode-java:
https://github.com/redhat-developer/vscode-java/blob/9b0f0aca80cbefabad4c034fb5dd365d029f6170/src/extension.ts#L155-L160

Basically, the server sends workspace edits to the client, and the client is responsible for applying them.

idanarye · 2017-10-03T18:29:19Z

Isn't that how code actions work? Why do you need a special command for that?

autozimu · 2017-11-04T21:42:19Z

I think the issue is that protocol doesn't specify clearly how client is going to consume a Command(https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md#command) after user select one, which could have at least two cases here,

client sends the selected Command to server, server responds back with workspaceEdit, then client applies those edits
client itself figures out how to apply edits based on selected Command

sourcegraph/javascript-typescript-langserver chosen option 1 and LanguageClient-neovim followed the same pattern. And it looks here eclipse.jdt did option 2.

idanarye · 2017-11-04T23:12:27Z

So much for having a unified protocol that solves the matrix problem...

gorkem · 2018-02-13T22:04:47Z

The main difference between 1 and 2 is when the TextEdits are the calculated otherwise both require a custom command to be implemented by the client. 2nd way works well for jdt.ls at the moment because the way we determine code actions gets us very close to calculating TextEdits anyway hence more efficient.

amiramw · 2018-02-14T12:52:34Z

But option 2 doesn't conform with the protocol.
https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction

When the command is selected the server should be contacted again (via the workspace/executeCommand) request to execute the command.

If the need for option 2 is real shouldn't it be pushed to the protocol?

natebosch · 2018-06-05T04:17:09Z

There is a proposal to support returning an edit instead of a command: microsoft/language-server-protocol#178

tsmaeder · 2018-10-16T08:29:56Z

But option 2 doesn't conform with the protocol.
https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction

When the command is selected the server should be contacted again (via the workspace/executeCommand) request to execute the command.

If the need for option 2 is real shouldn't it be pushed to the protocol?

This provision was added AFTER jdt.ls implemented code actions this way. So "option 2" was at one time in the protocol, but was removed. We should probably move to using WorkspaceEdits, now that the can contain resource changes, but that would break existing clients.

gns26 · 2019-01-17T09:44:06Z

Hi guys - any update on this one? I see that lots of other clients are busy implementing custom commands (i.e. autozimu/LanguageClient-neovim#158) which as mentioned above is unnecessary.

Won't most clients be able to handle WorkspaceEdits now? If so then moving across should be fine?

Cheers

puremourning · 2019-01-17T11:57:11Z

Won't most clients be able to handle WorkspaceEdits now?

What makes you think that?

gns26 · 2019-01-17T12:30:10Z

Won't most clients be able to handle WorkspaceEdits now?

What makes you think that?

I saw the linked ticket had been closed back in August. But if most have not then it would have to wait, yes. (https://github.com/prabirshrestha/vim-lsp this one for instance does seem to)

AObuchow · 2019-09-25T15:04:08Z

Was testing JDT-LS integration with LSP4E and ran into this issue as well.
Would it be possible to replace usage of "java.apply.workspaceEdit" in codeAction with workspaceEdit?
It seems to be mentioned in CodeActionHandler.java:

if (preferenceManager.getClientPreferences().isSupportedCodeActionKind(proposal.getKind())) {
			// TODO: Should set WorkspaceEdit directly instead of Command
			CodeAction codeAction = new CodeAction(name);
			codeAction.setKind(proposal.getKind());
			codeAction.setCommand(command);
			codeAction.setDiagnostics(context.getDiagnostics());
			return Optional.of(Either.forRight(codeAction));
		} else {
			return Optional.of(Either.forLeft(command));
		}

Also, could we retitle this issue to something like Replace usage of java.apply.workspaceEdit in codeAction by workspaceEdit?

If client advertises `CodeActionLiteralSupport`, using that for `java.apply.workspaceEdit` would allow clients to use a generic algorithm, instead of being forced to provide a special case for jdt.ls. Fixes #376 Signed-off-by: Boris Staletic <boris.staletic@gmail.com>

fbricon · 2019-11-13T20:15:40Z

The fix was reverted because of a regression. See #1256 (comment)

nrabulinski · 2023-04-23T09:25:10Z

Are there any plans to fix this behavior?

theli-ua · 2023-06-21T17:12:01Z

@fbricon given that you looked at previous attempts at fixing this could you take a look at linked PR, it should leave this compatible with vscode while allowing compliant clients to work as well. It basically does what @bstaletic suggested above 3 years ago

- Fixes eclipse-jdtls#376 - This follows exactly same pattern as organizeImports was done. Signed-off-by: Anton Romanov <theli.ua@gmail.com>

If client advertises `CodeActionLiteralSupport`, using that for `java.apply.workspaceEdit` would allow clients to use a generic algorithm, instead of being forced to provide a special case for jdt.ls. Fixes eclipse-jdtls#376 Signed-off-by: Boris Staletic <boris.staletic@gmail.com> Signed-off-by: Anton Romanov <theli.ua@gmail.com>

schiegl mentioned this issue Nov 4, 2017

Importing does not work in Java autozimu/LanguageClient-neovim#158

Closed

fbricon mentioned this issue Feb 13, 2018

Implement organize imports using applyEdit #518

Closed

deankevorkian mentioned this issue Feb 21, 2018

Add organize imports atom/ide-java#58

Open

deankevorkian mentioned this issue Mar 21, 2018

Support for custom invocation of code actions' Commands atom/atom-languageclient#183

Open

tomv564 mentioned this issue May 20, 2018

JAVA Code Action Not Working sublimelsp/LSP#320

Closed

natebosch mentioned this issue Jun 5, 2018

Not showing actions from eclipse-jdt-ls natebosch/vim-lsc#88

Closed

This was referenced Aug 10, 2018

workspace path as lsp server command line option joaotavora/eglot#63

Closed

Add support for eclipse.jdt.ls server joaotavora/eglot#65

Merged

tbo mentioned this issue Oct 12, 2018

eclipse.jdt.ls support neoclide/coc.nvim#112

Closed

mikoto2000 mentioned this issue Jun 2, 2019

Modified to use WorkspaceEdit on OrganizeImports. #1059

Closed

bstaletic mentioned this issue Nov 9, 2019

Take advantage of CodeActionLiteral client capability #1256

Merged

fbricon closed this as completed in #1256 Nov 13, 2019

fbricon reopened this Nov 13, 2019

bstaletic mentioned this issue Nov 18, 2019

Take advantage of CodeActionLiteral client capability - Second attempt #1278

Merged

pwntester mentioned this issue Nov 21, 2019

Is it possible to intercept and modify requests/responses? neovim/nvim-lspconfig#45

Closed

fbricon closed this as completed in #1278 Nov 27, 2019

CsCherrYY added client/integration protocol client/communication and removed protocol labels Feb 13, 2023

cstich mentioned this issue Feb 18, 2023

import source actions for java (jdtls) don't work helix-editor/helix#5421

Closed

theli-ua mentioned this issue Jun 6, 2023

Support java.apply.workspaceEdit #2688

Closed

rgrunber added this to the End November 2023 milestone Nov 1, 2023

rgrunber self-assigned this Nov 8, 2023

rgrunber pushed a commit to theli-ua/eclipse.jdt.ls that referenced this issue Nov 9, 2023

Add java.apply.workspaceEdit delegate command.

da05656

- Fixes eclipse-jdtls#376 - This follows exactly same pattern as organizeImports was done. Signed-off-by: Anton Romanov <theli.ua@gmail.com>

theli-ua linked a pull request Nov 16, 2023 that will close this issue

Take advantage of CodeActionLiteral client capability #2962

Open

rgrunber modified the milestones: End November 2023, End December 2023, Early December 2023 Nov 30, 2023

rgrunber modified the milestones: Early January 2024, End January 2024 Jan 11, 2024

deathbeam mentioned this issue Jan 29, 2024

Calling vim.ui.select's on_choice after codeAction/resolve results in "-32603: Internal error." mfussenegger/nvim-jdtls#608

Closed

ibhagwan mentioned this issue Jan 29, 2024

Problems with code actions and jdtls language server ibhagwan/fzf-lua#1007

Closed

1 task

rgrunber modified the milestones: End January 2024, End February 2024 Feb 1, 2024

rgrunber modified the milestones: Mid February 2024, Mid March 2024 Feb 15, 2024

nabellows mentioned this issue Feb 28, 2024

fix(codeaction preview) update internal _items list with resolve results ibhagwan/fzf-lua#1057

Closed

rgrunber modified the milestones: Early April 2024, End April 2024 Apr 3, 2024

rgrunber modified the milestones: End April 2024, End May 2024 Apr 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

No delegateCommandHandler for java.apply.workspaceEdit #376

No delegateCommandHandler for java.apply.workspaceEdit #376

idanarye commented Oct 3, 2017 •

edited

fbricon commented Oct 3, 2017 •

edited

idanarye commented Oct 3, 2017

autozimu commented Nov 4, 2017

idanarye commented Nov 4, 2017

gorkem commented Feb 13, 2018

amiramw commented Feb 14, 2018

natebosch commented Jun 5, 2018

tsmaeder commented Oct 16, 2018

gns26 commented Jan 17, 2019

puremourning commented Jan 17, 2019

gns26 commented Jan 17, 2019

AObuchow commented Sep 25, 2019

fbricon commented Nov 13, 2019

nrabulinski commented Apr 23, 2023

theli-ua commented Jun 21, 2023

No delegateCommandHandler for java.apply.workspaceEdit #376

No delegateCommandHandler for java.apply.workspaceEdit #376

Comments

idanarye commented Oct 3, 2017 • edited

fbricon commented Oct 3, 2017 • edited

idanarye commented Oct 3, 2017

autozimu commented Nov 4, 2017

idanarye commented Nov 4, 2017

gorkem commented Feb 13, 2018

amiramw commented Feb 14, 2018

natebosch commented Jun 5, 2018

tsmaeder commented Oct 16, 2018

gns26 commented Jan 17, 2019

puremourning commented Jan 17, 2019

gns26 commented Jan 17, 2019

AObuchow commented Sep 25, 2019

fbricon commented Nov 13, 2019

nrabulinski commented Apr 23, 2023

theli-ua commented Jun 21, 2023

idanarye commented Oct 3, 2017 •

edited

fbricon commented Oct 3, 2017 •

edited