Provide JSON-RPC service for Language Service Communications #7840
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Copyright (c) 2012-2017 Red Hat, Inc. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.che.api.languageserver.remote; | ||
|
|
||
| import java.util.Map; | ||
| import javax.inject.Singleton; | ||
|
|
||
| /** Detects if machine server attributes indicates that we are dealing with language server. */ | ||
| @Singleton | ||
| class LsConfigurationDetector { | ||
| /** | ||
| * Tests attributes for a language server indicator | ||
| * | ||
| * @param attributes map with machine server attributes | ||
| * @return true if language server is detected, false otherwise | ||
| */ | ||
| boolean isDetected(Map<String, String> attributes) { | ||
| return "ls".equals(attributes.get("type")); | ||
|
There was a problem hiding this comment. Do we have this "magic" constant described anywhere in our javadocs? There was a problem hiding this comment. No, we don't have it, I'd say it's an internal implementation and it is not as important as, for example, the fact that this constant is not described in the documentation, because as far as I know the documentation is under construction at the moment, so I guess we'll have to wait a bit until it is ready. Could you satisfy my curiosity, tell me please why are you taking into account "ls" constant and not "type" that stands next, or others, is it somehow special for you? There was a problem hiding this comment. Just pointed out that value. And yes, just |
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Copyright (c) 2012-2017 Red Hat, Inc. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.che.api.languageserver.remote; | ||
|
|
||
| import static java.util.Collections.emptyList; | ||
| import static java.util.Collections.unmodifiableList; | ||
|
|
||
| import com.google.gson.JsonArray; | ||
| import com.google.gson.JsonObject; | ||
| import com.google.gson.JsonParser; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import javax.inject.Inject; | ||
| import javax.inject.Singleton; | ||
| import org.eclipse.che.api.languageserver.registry.DocumentFilter; | ||
| import org.eclipse.che.api.languageserver.registry.LanguageServerDescription; | ||
|
|
||
| /** | ||
| * This class is responsible for language server description extraction out of server attributes | ||
| * map. It is expected that there will be specific attribute named <code>config</code> that will | ||
| * contain serialized json data that represents all language server configuration data. Structure of | ||
| * json corresponds to {@link LanguageServerDescription} class with all aggregated classes | ||
| */ | ||
| @Singleton | ||
| class LsConfigurationExtractor { | ||
|
There was a problem hiding this comment. This looks much more complex than parsing to an object. Have you considered creating a model object? There was a problem hiding this comment. Yes, I had some consideration for creating a model object. |
||
| private final JsonParser jsonParser; | ||
|
|
||
| @Inject | ||
| LsConfigurationExtractor(JsonParser jsonParser) { | ||
| this.jsonParser = jsonParser; | ||
| } | ||
|
|
||
| LanguageServerDescription extract(Map<String, String> attributes) { | ||
| String config = attributes.get("config"); | ||
|
There was a problem hiding this comment. As we discussed before I would opt for a more FQN like name because the current one is not very descriptive. There was a problem hiding this comment. If we look at configuration fragment: {
"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"
}
}
}
}
}
}we see that There was a problem hiding this comment. I was concerned about attributes only since they do not have a fixed structure. And yes, I was thinking the same about |
||
| JsonObject configJsonObject = jsonParser.parse(config).getAsJsonObject(); | ||
| String id = getId(configJsonObject); | ||
| List<String> languageIds = getLanguageIds(configJsonObject); | ||
| List<String> fileWatchPatterns = getFileWatchPatterns(configJsonObject); | ||
| List<DocumentFilter> documentFilters = getDocumentFilters(configJsonObject); | ||
|
|
||
| return new LanguageServerDescription(id, languageIds, documentFilters, fileWatchPatterns); | ||
| } | ||
|
|
||
| private String getId(JsonObject jsonObject) { | ||
| return !jsonObject.has("id") ? null : jsonObject.get("id").getAsString(); | ||
| } | ||
|
|
||
| private List<String> getLanguageIds(JsonObject jsonObject) { | ||
| if (!jsonObject.has("languageIds")) { | ||
| return emptyList(); | ||
| } | ||
|
|
||
| JsonArray languageIdsJsonArray = jsonObject.get("languageIds").getAsJsonArray(); | ||
| int size = languageIdsJsonArray.size(); | ||
| List<String> languageIds = new ArrayList<>(size); | ||
| for (int i = 0; i < size; i++) { | ||
| String languageId = languageIdsJsonArray.get(i).getAsString(); | ||
| languageIds.add(languageId); | ||
| } | ||
|
|
||
| return unmodifiableList(languageIds); | ||
| } | ||
|
|
||
| private List<String> getFileWatchPatterns(JsonObject jsonObject) { | ||
| if (!jsonObject.has("fileWatchPatterns")) { | ||
| return emptyList(); | ||
| } | ||
|
|
||
| JsonArray fileWatchPatternsJsonArray = jsonObject.get("fileWatchPatterns").getAsJsonArray(); | ||
| int size = fileWatchPatternsJsonArray.size(); | ||
| List<String> fileWatchPatterns = new ArrayList<>(size); | ||
| for (int i = 0; i < size; i++) { | ||
| String fileWatchPattern = fileWatchPatternsJsonArray.get(i).getAsString(); | ||
| fileWatchPatterns.add(fileWatchPattern); | ||
| } | ||
|
|
||
| return unmodifiableList(fileWatchPatterns); | ||
| } | ||
|
|
||
| private List<DocumentFilter> getDocumentFilters(JsonObject jsonObject) { | ||
| if (!jsonObject.has("documentFilters")) { | ||
| return emptyList(); | ||
| } | ||
| JsonArray documentFiltersJsonArray = jsonObject.get("documentFilters").getAsJsonArray(); | ||
|
|
||
| int size = documentFiltersJsonArray.size(); | ||
| List<DocumentFilter> documentFilters = new ArrayList<>(size); | ||
| for (int i = 0; i < size; i++) { | ||
| JsonObject documentFilterJsonObject = documentFiltersJsonArray.get(i).getAsJsonObject(); | ||
|
|
||
| String pathRegex; | ||
| if (documentFilterJsonObject.has("pathRegex")) { | ||
| pathRegex = documentFilterJsonObject.get("pathRegex").getAsString(); | ||
| } else { | ||
| pathRegex = null; | ||
| } | ||
|
|
||
| String languageId; | ||
| if (documentFilterJsonObject.has("languageId")) { | ||
| languageId = documentFilterJsonObject.get("languageId").getAsString(); | ||
| } else { | ||
| languageId = null; | ||
| } | ||
|
|
||
| String schema; | ||
| if (documentFilterJsonObject.has("scheme")) { | ||
| schema = documentFilterJsonObject.get("scheme").getAsString(); | ||
| } else { | ||
| schema = null; | ||
| } | ||
|
|
||
| DocumentFilter documentFilter = new DocumentFilter(languageId, pathRegex, schema); | ||
| documentFilters.add(documentFilter); | ||
| } | ||
|
|
||
| return unmodifiableList(documentFilters); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Copyright (c) 2012-2017 Red Hat, Inc. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.che.api.languageserver.remote; | ||
|
|
||
| import com.google.inject.AbstractModule; | ||
| import com.google.inject.multibindings.Multibinder; | ||
|
|
||
| public class LsRemoteModule extends AbstractModule { | ||
|
|
||
| @Override | ||
| protected void configure() { | ||
| Multibinder.newSetBinder(binder(), RemoteLsLauncherProvider.class) | ||
| .addBinding() | ||
| .to(SocketLsLauncherProvider.class); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not an expert in this area of Che, but by looking at a method argument
fileUriI suppose that this method can be called a lot of times because of different files. If this is true then looks like this code might call Workspace API a lot of times. Wouldn't it be better to cache GET WS API calls results?