Provide JSON-RPC service for Language Service Communications #7840

dkulieshov · 2017-12-12T14:01:23Z

Related issue: #7582

Overview

Added basic workspace agent functionality for interaction with language servers that are run in a separate container. In order to use remote language server instance it must support either TCP connection or stdio in conjunction with socat utility. The language server launchers are dynamically created and in general it is enough to make edits to workspace configuration and use a docker image with language server instance configured and running. However there is a limitation of supported languages: #7790.

Video of the use case is here: https://youtu.be/s0CCGfA8-1M

Workspace configuration

There are several basic things that you must do to use remote language server:

Configure the recipe with correct docker image
- it must run a preconfigured language server instance
- it must provide access to a langue server over network
Add corresponding machine to workspace - typescript-ls-machine in example
Add corresponding server to machine - ls in example
Set server attributes
- internal : true - we are running internal server that must not be accessible outside of the infrastructure
- type : ls - currently we support only ls type of servers
- config : serialized string
  Serialized string is a serialized stringified that represents a LanguageServerDescription class.

Workspace configuration example:

{
   "environments":{
      "default":{
         "warnings":[

         ],
         "machines":{
            "typescript-ls-machine":{
               "env":{

               },
               "installers":[
                  "org.eclipse.che.exec",
                  "org.eclipse.che.terminal"
               ],
               "servers":{
                  "ls":{
                     "attributes":{
                        "internal":"true",
                        "type":"ls",
                        "config":"{\"id\":\"org.eclipse.che.plugin.web.typescript\", \"documentFilters\":[  {  \"languageId\":\"typescript\",  \"pathRegex\":\".*\\\\.(ts|tsx)\"} ]}"
                     },
                     "protocol":"tcp",
                     "port":"4417"
                  }
               },
               "volumes":{
                  "projects":{
                     "path":"/projects"
                  }
               },
               "attributes":{
                  "memoryLimitBytes":"1073741824"
               }
            },
            "dev-machine":{
               "env":{

               },
               "installers":[
                  "org.eclipse.che.exec",
                  "org.eclipse.che.terminal",
                  "org.eclipse.che.ws-agent",
                  "org.eclipse.che.ssh"
               ],
               "servers":{
                  "tomcat8-debug":{
                     "attributes":{
                        "some":"attribute"
                     },
                     "protocol":"http",
                     "port":"8000"
                  },
                  "codeserver":{
                     "attributes":{

                     },
                     "protocol":"http",
                     "port":"9876"
                  },
                  "tomcat8":{
                     "attributes":{

                     },
                     "protocol":"http",
                     "port":"8080"
                  }
               },
               "volumes":{
                  "projects":{
                     "path":"/projects"
                  }
               },
               "attributes":{
                  "memoryLimitBytes":"2147483648"
               }
            }
         },
         "recipe":{
            "contentType":"application/x-yaml",
            "type":"compose",
            "content":"services:\n typescript-ls-machine:\n  image: eivantsov/tsls\n  environment:\n   MYSQL_ROOT_PASSWORD: password\n   MYSQL_DATABASE: petclinic\n   MYSQL_USER: petclinic\n   MYSQL_PASSWORD: password\n  mem_limit: 1073741824\n dev-machine:\n  image: eclipse/ubuntu_jdk8\n  mem_limit: 2147483648\n  depends_on:\n   - typescript-ls-machine\n"
         }
      }
   },
   "commands":[
      {
         "commandLine":"mysql -u $MYSQL_USER -p$MYSQL_PASSWORD -e 'show databases;'",
         "name":"show databases",
         "type":"custom",
         "attributes":{

         }
      }
   ],
   "projects":[

   ],
   "defaultEnv":"default",
   "name":"TypeScript_LS_Demo",
   "links":[

   ]
}

Language server config example:

{
   "id":"org.eclipse.che.plugin.web.typescript",
   "documentFilters":[
      {
         "languageId":"typescript",
         "pathRegex":".*\\.(ts|tsx)"
      }
   ]
}

Dockerfile example:

FROM eclipse/node
RUN sudo apt-get install socat -y &&     sudo npm install -g typescript@2.5.3 typescript-language-server@0.1.4
CMD socat TCP4-LISTEN:4417,reuseaddr,fork EXEC:"typescript-language-server --stdio"

Api changes

LanguageServerLauncher has new method isLocal() that returns true by default and indicates if language server will be launched locally or remotely.
Added new interface RemoteLsLauncherProvider that is to process workspace configuration and provide all configured remote language server launchers.
Currently we support only TCP based remote language server launchers.

Guice changes

Added new Guice module LsRemoteModule to aggregate all remote language server specific configuration classes and implementations.

Many thanks to @garagatyi and @eivantsov for assistance on docker related stuff! :-)

Signed-off-by: Dmytro Kulieshov <dkuliesh@redhat.com>

garagatyi

Nice feature!
Can you take a look at my comments?

garagatyi · 2017-12-12T15:49:38Z