Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New API: Port code lenses #433

Merged
merged 1 commit into from
Feb 10, 2023
Merged

New API: Port code lenses #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/operations/codelens/LSPCodeMiningTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@
*******************************************************************************/
package org.eclipse.lsp4e.test.operations.codelens;

import static org.junit.Assert.*;
import static org.junit.Assert.assertEquals;

import java.util.Arrays;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;

import org.eclipse.core.commands.ExecutionEvent;
Expand All @@ -25,9 +24,10 @@
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.lsp4e.LanguageServerWrapper;
import org.eclipse.lsp4e.LanguageServersRegistry;
import org.eclipse.lsp4e.LanguageServiceAccessor;
import org.eclipse.lsp4e.command.LSPCommandHandler;
import org.eclipse.lsp4e.operations.codelens.CodeLensProvider;
import org.eclipse.lsp4e.operations.codelens.LSPCodeMining;
Expand All @@ -39,7 +39,6 @@
import org.eclipse.lsp4j.ExecuteCommandParams;
import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.Range;
import org.eclipse.lsp4j.services.LanguageServer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.widgets.Display;
Expand Down Expand Up @@ -71,7 +70,7 @@ public void setUp() throws CoreException {
}

@Test
public void testLSPCodeMiningActionClientSideHandling() throws BadLocationException, CoreException {
public void testLSPCodeMiningActionClientSideHandling() throws Exception {
String commandID = "test.command";
final CodeLens lens = createCodeLens(commandID);

Expand All @@ -94,10 +93,10 @@ public Object execute(ExecutionEvent event, Command command, IPath context) thro
IFile file = TestUtils.createUniqueTestFile(project, "lspt", "test content");
IDocument document = TestUtils.openTextViewer(file).getDocument();

LanguageServer languageServer = MockLanguageServer.INSTANCE;
CodeLensProvider provider = new CodeLensProvider();
LanguageServerWrapper wrapper = LanguageServiceAccessor.getLSWrapperForConnection(project, LanguageServersRegistry.getInstance().getDefinition(MOCK_SERVER_ID));

LSPCodeMining sut = new LSPCodeMining(lens, document, languageServer, LanguageServersRegistry.getInstance().getDefinition(MOCK_SERVER_ID), provider);
LSPCodeMining sut = new LSPCodeMining(lens, document, wrapper, provider);
MouseEvent mouseEvent = createMouseEvent();
sut.getAction().accept(mouseEvent);

Expand All @@ -107,8 +106,7 @@ public Object execute(ExecutionEvent event, Command command, IPath context) thro

@Test
public void testLSPCodeMiningActionServerSideHandling()
throws InterruptedException, java.util.concurrent.ExecutionException, TimeoutException,
BadLocationException, CoreException {
throws Exception {
final CodeLens lens = createCodeLens(MockLanguageServer.SUPPORTED_COMMAND_ID);
Command command = lens.getCommand();
JsonObject jsonObject = new JsonObject();
Expand All @@ -122,8 +120,9 @@ public void testLSPCodeMiningActionServerSideHandling()
MockLanguageServer languageServer = MockLanguageServer.INSTANCE;
CodeLensProvider provider = new CodeLensProvider();

LSPCodeMining sut = new LSPCodeMining(lens, document, languageServer, LanguageServersRegistry.getInstance().getDefinition(MOCK_SERVER_ID), provider);
MouseEvent mouseEvent = createMouseEvent();
LanguageServerWrapper wrapper = LanguageServiceAccessor.getLSWrapperForConnection(project, LanguageServersRegistry.getInstance().getDefinition(MOCK_SERVER_ID));

LSPCodeMining sut = new LSPCodeMining(lens, document, wrapper, provider); MouseEvent mouseEvent = createMouseEvent();
sut.getAction().accept(mouseEvent);

// We expect that the language server will be called to execute the command
Expand Down
37 changes: 16 additions & 21 deletions org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/codelens/CodeLensProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@
package org.eclipse.lsp4e.operations.codelens;

import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jdt.annotation.NonNull;
Expand All @@ -24,41 +23,37 @@
import org.eclipse.jface.text.codemining.ICodeMining;
import org.eclipse.lsp4e.LSPEclipseUtils;
import org.eclipse.lsp4e.LanguageServerPlugin;
import org.eclipse.lsp4e.LanguageServiceAccessor;
import org.eclipse.lsp4e.LanguageServerWrapper;
import org.eclipse.lsp4e.LanguageServers;
import org.eclipse.lsp4e.LanguageServers.LanguageServerDocumentExecutor;
import org.eclipse.lsp4j.CodeLens;
import org.eclipse.lsp4j.CodeLensParams;
import org.eclipse.lsp4j.services.LanguageServer;

public class CodeLensProvider extends AbstractCodeMiningProvider {

private CompletableFuture<List<? extends ICodeMining>> provideCodeMinings(@NonNull IDocument document) {
URI docURI = LSPEclipseUtils.toUri(document);
if (docURI != null) {
final var param = new CodeLensParams(LSPEclipseUtils.toTextDocumentIdentifier(docURI));
final var codeLensResults = Collections.synchronizedList(new ArrayList<LSPCodeMining>());
return LanguageServiceAccessor
.getLanguageServers(document, capabilities -> capabilities.getCodeLensProvider() != null)
.thenComposeAsync(languageServers -> CompletableFuture.allOf(languageServers.stream()
.map(languageServer -> languageServer.getTextDocumentService().codeLens(param)
.thenAcceptAsync(codeLenses -> {
// textDocument/codeLens may return null
if (codeLenses != null) {
codeLenses.stream().filter(Objects::nonNull)
.map(codeLens -> toCodeMining(document, languageServer, codeLens))
.filter(Objects::nonNull).forEach(codeLensResults::add);
}
}))
.toArray(CompletableFuture[]::new)))
.thenApplyAsync(theVoid -> codeLensResults);
LanguageServerDocumentExecutor executor = LanguageServers.forDocument(document)
.withFilter(sc -> sc.getCodeLensProvider() != null);
return executor.collectAll((w, ls) -> ls.getTextDocumentService().codeLens(param)
.thenApply(codeLenses -> LanguageServers.streamSafely(codeLenses)
.map(codeLens -> toCodeMining(document, w, codeLens))
.filter(Objects::nonNull)))
.thenApply(result -> result.stream().flatMap(s -> s).collect(Collectors.toList()));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we could just use toList()

}
else {
return null;
}
}

private LSPCodeMining toCodeMining(IDocument document, LanguageServer languageServer, CodeLens codeLens) {
private LSPCodeMining toCodeMining(IDocument document, LanguageServerWrapper languageServerWrapper, CodeLens codeLens) {
if (codeLens == null) {
return null;
}
try {
return new LSPCodeMining(codeLens, document, languageServer, LanguageServiceAccessor.resolveServerDefinition(languageServer).orElse(null), CodeLensProvider.this);
return new LSPCodeMining(codeLens, document, languageServerWrapper, CodeLensProvider.this);
} catch (BadLocationException e) {
LanguageServerPlugin.logError(e);
return null;
Expand Down
24 changes: 11 additions & 13 deletions org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/codelens/LSPCodeMining.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,26 @@
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.codemining.LineHeaderCodeMining;
import org.eclipse.lsp4e.LanguageServerWrapper;
import org.eclipse.lsp4e.LanguageServersRegistry.LanguageServerDefinition;
import org.eclipse.lsp4e.LanguageServiceAccessor;
import org.eclipse.lsp4e.command.CommandExecutor;
import org.eclipse.lsp4j.CodeLens;
import org.eclipse.lsp4j.Command;
import org.eclipse.lsp4j.services.LanguageServer;
import org.eclipse.swt.events.MouseEvent;

public class LSPCodeMining extends LineHeaderCodeMining {
private CodeLens codeLens;
private final LanguageServer languageServer;

private final LanguageServerWrapper languageServerWrapper;
private final LanguageServerDefinition languageServerDefinition;
private final @Nullable IDocument document;

public LSPCodeMining(CodeLens codeLens, IDocument document, LanguageServer languageServer, LanguageServerDefinition languageServerDefinition,
public LSPCodeMining(CodeLens codeLens, IDocument document, LanguageServerWrapper languageServerWrapper,
CodeLensProvider provider) throws BadLocationException {
super(codeLens.getRange().getStart().getLine(), document, provider, null);
this.codeLens = codeLens;
this.languageServer = languageServer;
this.languageServerDefinition = languageServerDefinition;
this.languageServerWrapper = languageServerWrapper;
this.languageServerDefinition = languageServerWrapper.serverDefinition;
this.document = document;
setLabel(getCodeLensString(codeLens));
}
Expand All @@ -52,15 +52,13 @@ public LSPCodeMining(CodeLens codeLens, IDocument document, LanguageServer langu

@Override
protected CompletableFuture<Void> doResolve(ITextViewer viewer, IProgressMonitor monitor) {
if (!LanguageServiceAccessor.checkCapability(languageServer,
capabilities -> {
Boolean resolveProvider = capabilities.getCodeLensProvider().getResolveProvider();
return resolveProvider != null && resolveProvider;
})) {
final Boolean resolveProvider = this.languageServerWrapper.getServerCapabilities().getCodeLensProvider().getResolveProvider();
if (resolveProvider == null || !resolveProvider) {
return CompletableFuture.completedFuture(null);
}
return languageServer.getTextDocumentService().resolveCodeLens(this.codeLens)
.thenAcceptAsync(resolvedCodeLens -> {

return this.languageServerWrapper.execute(languageServer -> languageServer.getTextDocumentService().resolveCodeLens(this.codeLens))
.thenAccept(resolvedCodeLens -> {
codeLens = resolvedCodeLens;
if (resolvedCodeLens != null) {
setLabel(getCodeLensString(resolvedCodeLens));
Expand Down