Unique command names

[appilon]

This PR ensures the uniqueness of the exported commands across different language servers (with a terraform-ls. prefix, this is a common practice) and an additional <commandPrefix>., this latter ensures multiple instances of the language server can run side by side, it will become the clients responsibility to send requests with the correct command name, the commandPrefix is only enabled if specified in the initializationOptions for the server.

"executeCommandProvider": {
    "commands": ["1234.terraform-ls.rootmodules"]
}

Closes #278

[appilon]

Paul had suggested the unique ID (maybe even just an incrementing integer) be generated by the client and passed to the server to prefix/suffix, which I'm open to as an alternative, or perhaps we use the pid as the unique ID, the client would have to figure out that mapping though.

[aeschright]

For that second option to work, would the server then just keep track of what uuid was used to call it the first time, or is there some other way we'd register the setting?

[appilon]

Correct the value would be passed to the server during initialization, it would have the same effect, just maybe feel a little cleaner without the long root folder URI, the client would likely keep the ID as the key to it's map (which as of writing is the workspace folder URI).

[radeksimko]

Thank you for working on this and for discovering this issue early before the release! 😅

Besides my comments inline I would have one more question about the format - was there a particular reason behind <static-prefix>.<command>.<instance-specific-prefix>?
I don't have a strong opinion on the order, just genuinely curious if this was motivated by anything on the client side or in the LSP?

[appilon]

Thank you for working on this and for discovering this issue early before the release! 😅

Besides my comments inline I would have one more question about the format - was there a particular reason behind <static-prefix>.<command>.<instance-specific-prefix>?
I don't have a strong opinion on the order, just genuinely curious if this was motivated by anything on the client side or in the LSP?

@radeksimko the static prefix is a common pattern. I should maybe see if I can find some precedent with another popular langserver (I'll try python), but I felt that since the instance specific ID is optional, I felt making it a suffix felt more intuitive.

terraform-ls.rootmodules contrasted with terraform-ls.1234.rootmodules
VS
terraform-ls.rootmodules contrasted with `terraform-ls.rootmodules.1234

I liked that the first two pieces <static-prefix>.<command>. "lined up" and the last part can be dropped.

Similar to your other point though... I also now wonder if your suggestion is more intuitive in the world of namespacing like "please route request to terraform-ls instance 1234. Need to chat about it more..

FINAL DECISION:

going with an optional prefix for multi server uniqueness

1234.terraform-ls.rootmodules

[radeksimko]

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the context necessary to investigate further.