Skip to content

Commit dfbe64a

Browse files
gselzerclaude
andcommitted
code-lsp: adapter and merging fixes for editors
The adapter serves languages with a completer of their own (so editors can tell which are served), can serve a single completer (e.g. in tests), and looks for problems a moment after the last change, as editors send every keystroke. Merging keeps overloads: completions are the same only if they insert the same name with the same parameters (label details). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent f66717e commit dfbe64a

4 files changed

Lines changed: 113 additions & 19 deletions

File tree

‎code-lsp/src/main/java/org/scijava/code/lsp/MergedLanguageServer.java‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,9 @@ private static CompletionList merge(final List<CompletionList> lists,
502502
final String uri, final String text)
503503
{
504504
final List<CompletionItem> out = new ArrayList<>();
505-
final Set<String> seen = new HashSet<>();
505+
// What each inserted name was seen with: its overloads' parameter lists
506+
// (label details), or null for an item without any.
507+
final Map<String, Set<String>> seen = new java.util.HashMap<>();
506508
boolean incomplete = false;
507509
for (int i = 0; i < lists.size(); i++) {
508510
final CompletionList list = lists.get(i);
@@ -514,7 +516,7 @@ private static CompletionList merge(final List<CompletionList> lists,
514516
.getSortText() : c.getLabel()));
515517
int j = 0;
516518
for (final CompletionItem item : items) {
517-
if (!seen.add(insertedLine(item, text))) continue;
519+
if (duplicate(seen, insertedLine(item, text), item)) continue;
518520
final CompletionItem c = copy(item);
519521
c.setData(new MergedData(uri, i, item.getData(), item.getSortText()));
520522
c.setSortText(String.format("%02d%06d", i, j++));
@@ -524,6 +526,30 @@ private static CompletionList merge(final List<CompletionList> lists,
524526
return new CompletionList(incomplete, out);
525527
}
526528

529+
/**
530+
* Whether a completion inserts what an earlier one does: the same name, and
531+
* the same parameters (overloads differ in their label details), or either
532+
* without any (e.g. a server knowing only names). Notes it as seen, if not.
533+
*/
534+
private static boolean duplicate(final Map<String, Set<String>> seen,
535+
final String name, final CompletionItem item)
536+
{
537+
final String params = item.getLabelDetails() == null ? null : item
538+
.getLabelDetails().getDetail();
539+
final Set<String> known = seen.get(name);
540+
if (known == null) {
541+
final Set<String> s = new HashSet<>();
542+
s.add(params);
543+
seen.put(name, s);
544+
return false;
545+
}
546+
if (params == null || known.contains(null) || known.contains(params)) {
547+
return true;
548+
}
549+
known.add(params);
550+
return false;
551+
}
552+
527553
/**
528554
* What a completion leaves on its line before the caret, roughly: the line
529555
* up to the edit, then the inserted name (without a parameter snippet). Two

‎code-lsp/src/main/java/org/scijava/code/lsp/compat/CodeCompleterLanguageServer.java‎

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@
3939
import java.util.Map;
4040
import java.util.concurrent.CompletableFuture;
4141
import java.util.concurrent.ConcurrentHashMap;
42+
import java.util.concurrent.Executors;
43+
import java.util.concurrent.ScheduledExecutorService;
44+
import java.util.concurrent.ScheduledFuture;
45+
import java.util.concurrent.TimeUnit;
4246
import java.util.concurrent.atomic.AtomicInteger;
4347

4448
import org.eclipse.lsp4j.CompletionItem;
@@ -112,9 +116,26 @@ public class CodeCompleterLanguageServer implements LanguageServer,
112116
/** How many completions to remember, for resolving their documentation. */
113117
private static final int REMEMBERED = 5000;
114118

119+
/**
120+
* How long a document must stay unchanged before its problems are looked
121+
* for, in milliseconds. (Editors send every keystroke.)
122+
*/
123+
private static final long PAUSE = Long.getLong("scijava.lsp.pause", 300);
124+
125+
private static final ScheduledExecutorService TIMER = Executors
126+
.newSingleThreadScheduledExecutor(r -> {
127+
final Thread t = new Thread(r, "scijava-completer-pause");
128+
t.setDaemon(true);
129+
return t;
130+
});
131+
115132
private final CodeCompletionService completion;
116133
private final ScriptService scripts;
117134
private final Environment environment;
135+
136+
/** A completer for all documents, if given (instead of each language's). */
137+
private final CodeCompleter fixed;
138+
private final ScriptLanguage fixedLanguage;
118139
private volatile LanguageClient client;
119140

120141
private final Map<String, Doc> docs = new ConcurrentHashMap<>();
@@ -127,6 +148,25 @@ public CodeCompleterLanguageServer(final CodeCompletionService completion,
127148
this.completion = completion;
128149
this.scripts = scripts;
129150
this.environment = environment;
151+
fixed = null;
152+
fixedLanguage = null;
153+
}
154+
155+
/**
156+
* Offers one completer, for documents of any language identifier, e.g. in
157+
* tests.
158+
*
159+
* @param completer The completer.
160+
* @param language The language of the documents (may be null).
161+
*/
162+
public CodeCompleterLanguageServer(final CodeCompleter completer,
163+
final ScriptLanguage language)
164+
{
165+
completion = null;
166+
scripts = null;
167+
environment = Environment.NONE;
168+
fixed = completer;
169+
fixedLanguage = language;
130170
}
131171

132172
@Override
@@ -174,10 +214,11 @@ public WorkspaceService getWorkspaceService() {
174214
@Override
175215
public void didOpen(final DidOpenTextDocumentParams params) {
176216
final TextDocumentItem item = params.getTextDocument();
177-
final Doc doc = new Doc(item.getUri(), scripts.getLanguageByName(item
178-
.getLanguageId()), item.getText(), item.getVersion());
217+
final Doc doc = new Doc(item.getUri(), fixed != null ? fixedLanguage
218+
: scripts.getLanguageByName(item.getLanguageId()), item.getText(), item
219+
.getVersion());
179220
docs.put(item.getUri(), doc);
180-
if (doc.language == null) return;
221+
if (!served(doc)) return;
181222
final CompletionRequest request = request(doc, doc.text.length());
182223
completer(doc).prepare(request);
183224
diagnose(doc);
@@ -190,15 +231,13 @@ public void didChange(final DidChangeTextDocumentParams params) {
190231
doc.text = params.getContentChanges().get(params.getContentChanges()
191232
.size() - 1).getText();
192233
doc.version = params.getTextDocument().getVersion();
193-
if (doc.language != null) diagnose(doc);
234+
if (served(doc)) diagnose(doc);
194235
}
195236

196237
@Override
197238
public void didClose(final DidCloseTextDocumentParams params) {
198239
final Doc doc = docs.remove(params.getTextDocument().getUri());
199-
if (doc != null && doc.language != null) {
200-
completer(doc).closed(request(doc, 0));
201-
}
240+
if (doc != null && served(doc)) completer(doc).closed(request(doc, 0));
202241
}
203242

204243
@Override
@@ -211,7 +250,7 @@ public void didSave(final DidSaveTextDocumentParams params) {}
211250
completion(final CompletionParams params)
212251
{
213252
final Doc doc = docs.get(params.getTextDocument().getUri());
214-
if (doc == null || doc.language == null) {
253+
if (doc == null || !served(doc)) {
215254
return CompletableFuture.completedFuture(Either.forRight(
216255
new CompletionList()));
217256
}
@@ -250,7 +289,7 @@ public CompletableFuture<SignatureHelp> signatureHelp(
250289
final SignatureHelpParams params)
251290
{
252291
final Doc doc = docs.get(params.getTextDocument().getUri());
253-
if (doc == null || doc.language == null) {
292+
if (doc == null || !served(doc)) {
254293
return CompletableFuture.completedFuture(null);
255294
}
256295
final org.scijava.code.api.SignatureHelp h = completer(doc).signatureHelp(
@@ -265,7 +304,7 @@ public CompletableFuture<SignatureHelp> signatureHelp(
265304
@Override
266305
public CompletableFuture<Hover> hover(final HoverParams params) {
267306
final Doc doc = docs.get(params.getTextDocument().getUri());
268-
if (doc == null || doc.language == null) {
307+
if (doc == null || !served(doc)) {
269308
return CompletableFuture.completedFuture(null);
270309
}
271310
final String text = doc.text;
@@ -300,15 +339,28 @@ public void didChangeWatchedFiles(final DidChangeWatchedFilesParams p) {}
300339
// -- Helper methods --
301340

302341
private CodeCompleter completer(final Doc doc) {
303-
return completion.getCompleter(doc.language);
342+
return fixed != null ? fixed : completion.getCompleter(doc.language);
343+
}
344+
345+
private boolean served(final Doc doc) {
346+
return fixed != null || doc.language != null;
304347
}
305348

306349
private CompletionRequest request(final Doc doc, final int offset) {
307350
return new CompletionRequest(doc.text, Math.min(offset, doc.text.length()),
308351
doc.language, null, environment.live(), path(doc.uri));
309352
}
310353

354+
/** Looks for a document's problems a moment after it last changed. */
311355
private void diagnose(final Doc doc) {
356+
synchronized (doc) {
357+
if (doc.pending != null) doc.pending.cancel(false);
358+
doc.pending = TIMER.schedule(() -> diagnoseNow(doc), PAUSE,
359+
TimeUnit.MILLISECONDS);
360+
}
361+
}
362+
363+
private void diagnoseNow(final Doc doc) {
312364
final String text = doc.text;
313365
final int version = doc.version;
314366
completer(doc).diagnose(request(doc, text.length())).thenAccept(found -> {
@@ -502,6 +554,7 @@ private static final class Doc {
502554
private final ScriptLanguage language;
503555
private volatile String text;
504556
private volatile int version;
557+
private ScheduledFuture<?> pending;
505558

506559
private Doc(final String uri, final ScriptLanguage language,
507560
final String text, final int version)

‎code-lsp/src/main/java/org/scijava/code/lsp/compat/CodeCompleterServerPlugin.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ public class CodeCompleterServerPlugin implements LanguageServerPlugin {
5757

5858
@Override
5959
public boolean supports(final ScriptLanguage language) {
60-
// NB: Every language has a completer: its own, or the default one.
61-
return true;
60+
// NB: Languages with a completer of their own: editors fall back to other
61+
// support for the others.
62+
return completion.getCompleterPlugin(language) != null;
6263
}
6364

6465
@Override

‎code-lsp/src/test/java/org/scijava/code/lsp/LanguageServersTest.java‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,19 +144,21 @@ public void testCompletionsMerged() throws Exception {
144144
// The fast server's at once (by label, having no sortText); the slow
145145
// one's to come.
146146
assertTrue(first instanceof UpdatingCompletionList);
147-
assertEquals(Arrays.asList("mass", "max"), labels(first));
147+
assertEquals(Arrays.asList("mass", "max", "maz", "maz"), labels(first));
148148
final CompletionList all = ((UpdatingCompletionList) first).update().get(10,
149149
TimeUnit.SECONDS);
150-
// In priority order; "max" once (the same text after inserting).
151-
assertEquals(Arrays.asList("mass", "max", "map"), labels(all));
150+
// In priority order; "max" once (the same text after inserting); both
151+
// overloads of "maz" (different parameters).
152+
assertEquals(Arrays.asList("mass", "max", "maz", "maz", "map"), labels(
153+
all));
152154
final List<String> sorted = all.getItems().stream().map(
153155
CompletionItem::getSortText).collect(Collectors.toList());
154156
final List<String> resorted = new ArrayList<>(sorted);
155157
Collections.sort(resorted);
156158
assertEquals(sorted, resorted);
157159

158160
// Resolving asks the server the completion came from, with its own data.
159-
final CompletionItem map = all.getItems().get(2);
161+
final CompletionItem map = all.getItems().get(4);
160162
final CompletionItem resolved = server.resolveCompletionItem(map).get(10,
161163
TimeUnit.SECONDS);
162164
assertEquals("slow resolved map (data 3)", resolved.getDetail());
@@ -615,6 +617,18 @@ void publish(final String uri, final int version, final String message,
615617
item.setData(label.length());
616618
items.add(item);
617619
}
620+
if (!slow && name.equals("fast")) {
621+
// Overloads: the same name, different parameters.
622+
for (final String params : new String[] { "(int a)", "(double a)" }) {
623+
final CompletionItem item = new CompletionItem("maz");
624+
item.setTextEdit(Either.forLeft(new TextEdit(word, "maz")));
625+
final org.eclipse.lsp4j.CompletionItemLabelDetails details =
626+
new org.eclipse.lsp4j.CompletionItemLabelDetails();
627+
details.setDetail(params);
628+
item.setLabelDetails(details);
629+
items.add(item);
630+
}
631+
}
618632
final Either<List<CompletionItem>, CompletionList> answer = Either
619633
.forRight(new CompletionList(items));
620634
if (!slow) return CompletableFuture.completedFuture(answer);

0 commit comments

Comments
 (0)