Skip to content

Commit a626099

Browse files
gselzerclaude
andcommitted
code-lsp: make sessions with the service only
ScriptSession's constructor taking functions (to launch servers, and to make documents) is private: sessions are made with a LanguageServerService. Tests of servers now go through the service too, with a test-only script language and dialect (and, for Groovy and Jython, a plugin serving the dialect's test language). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 8cbf10b commit a626099

5 files changed

Lines changed: 198 additions & 22 deletions

File tree

‎code-lsp-groovy/src/test/java/org/scijava/code/lsp/groovy/GroovyLanguageServerTest.java‎

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,31 @@
3737
import java.util.ArrayList;
3838
import java.util.Collections;
3939
import java.util.List;
40+
import java.util.Map;
4041
import java.util.concurrent.TimeUnit;
4142
import java.util.stream.Collectors;
4243

4344
import javax.script.ScriptContext;
45+
import javax.script.ScriptEngine;
4446
import javax.script.SimpleScriptContext;
4547

4648
import org.eclipse.lsp4j.CompletionItem;
4749
import org.eclipse.lsp4j.Diagnostic;
4850
import org.eclipse.lsp4j.SignatureHelp;
51+
import org.eclipse.lsp4j.services.LanguageServer;
52+
import org.junit.jupiter.api.AfterAll;
53+
import org.junit.jupiter.api.BeforeAll;
4954
import org.junit.jupiter.api.Test;
55+
import org.scijava.Context;
5056
import org.scijava.code.lsp.Environment;
51-
import org.scijava.code.lsp.ScriptDocument;
57+
import org.scijava.code.lsp.LanguageServerPlugin;
58+
import org.scijava.code.lsp.LanguageServerService;
59+
import org.scijava.code.lsp.ScriptDialect;
5260
import org.scijava.code.lsp.ScriptSession;
5361
import org.scijava.code.lsp.jvm.ClassIndex;
62+
import org.scijava.plugin.Plugin;
63+
import org.scijava.script.AbstractScriptLanguage;
64+
import org.scijava.script.ScriptLanguage;
5465

5566
/**
5667
* Tests {@link GroovyLanguageServer}
@@ -59,6 +70,29 @@
5970
*/
6071
public class GroovyLanguageServerTest {
6172

73+
/** A test fixture: a script language whose scripts are plain Groovy. */
74+
private static final ScriptLanguage TEST_LANGUAGE =
75+
new AbstractScriptLanguage()
76+
{
77+
78+
@Override
79+
public ScriptEngine getScriptEngine() {
80+
return null;
81+
}
82+
};
83+
84+
private static Context context;
85+
86+
@BeforeAll
87+
public static void startContext() {
88+
context = new Context(LanguageServerService.class);
89+
}
90+
91+
@AfterAll
92+
public static void disposeContext() {
93+
context.dispose();
94+
}
95+
6296
@Test
6397
public void testMembersOfInferredTypes() {
6498
assertTrue(complete("def s = 'hello'\ns.toUpp").contains("toUpperCase"));
@@ -314,8 +348,8 @@ public void testImportOffset() {
314348

315349
/** A session about plain Groovy, with a server of its own. */
316350
private static ScriptSession session(final Environment env) {
317-
return new ScriptSession(e -> new GroovyLanguageServer(env),
318-
ScriptDocument::of);
351+
return new ScriptSession(context.service(LanguageServerService.class),
352+
TEST_LANGUAGE, env.live());
319353
}
320354

321355
/** The problems found in a script, e.g. {@code Error@0:4-6 message}. */
@@ -377,4 +411,39 @@ private static List<String> labels(final List<CompletionItem> items) {
377411
return items.stream().map(CompletionItem::getLabel).collect(Collectors
378412
.toList());
379413
}
414+
415+
@Plugin(type = ScriptDialect.class)
416+
public static class TestDialect implements ScriptDialect {
417+
418+
@Override
419+
public boolean supports(final ScriptLanguage language) {
420+
return language == TEST_LANGUAGE;
421+
}
422+
423+
@Override
424+
public String languageId() {
425+
return "test";
426+
}
427+
428+
@Override
429+
public Header header(final Map<String, Class<?>> parameters) {
430+
return new Header("", Collections.emptySet());
431+
}
432+
}
433+
434+
@Plugin(type = LanguageServerPlugin.class)
435+
public static class TestServers implements LanguageServerPlugin {
436+
437+
@Override
438+
public boolean supports(final String languageId) {
439+
return "test".equals(languageId);
440+
}
441+
442+
@Override
443+
public LanguageServer create(final String languageId,
444+
final Environment environment)
445+
{
446+
return new GroovyLanguageServer(environment);
447+
}
448+
}
380449
}

‎code-lsp-jedi/src/test/java/org/scijava/code/lsp/jedi/PythonLanguageServerIntegrationTest.java‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,11 @@
3636

3737
import java.util.Collections;
3838
import java.util.List;
39+
import java.util.Map;
3940
import java.util.concurrent.TimeUnit;
4041

42+
import javax.script.ScriptEngine;
43+
4144
import org.eclipse.lsp4j.CompletionItem;
4245
import org.eclipse.lsp4j.CompletionList;
4346
import org.eclipse.lsp4j.Diagnostic;
@@ -47,11 +50,13 @@
4750
import org.junit.jupiter.api.BeforeAll;
4851
import org.junit.jupiter.api.Test;
4952
import org.scijava.Context;
50-
import org.scijava.code.lsp.Environment;
5153
import org.scijava.code.lsp.LanguageServerService;
5254
import org.scijava.code.lsp.Positions;
53-
import org.scijava.code.lsp.ScriptDocument;
55+
import org.scijava.code.lsp.ScriptDialect;
5456
import org.scijava.code.lsp.ScriptSession;
57+
import org.scijava.plugin.Plugin;
58+
import org.scijava.script.AbstractScriptLanguage;
59+
import org.scijava.script.ScriptLanguage;
5560

5661
/**
5762
* End-to-end tests of the {@code python} server (see
@@ -69,6 +74,17 @@ public class PythonLanguageServerIntegrationTest {
6974
/** How long to wait for environments to build. */
7075
private static final long BUILD_TIMEOUT = TimeUnit.MINUTES.toMillis(15);
7176

77+
/** A test fixture: a script language whose scripts are plain Python. */
78+
private static final ScriptLanguage TEST_LANGUAGE =
79+
new AbstractScriptLanguage()
80+
{
81+
82+
@Override
83+
public ScriptEngine getScriptEngine() {
84+
return null;
85+
}
86+
};
87+
7288
private static Context context;
7389
private static LanguageServerService servers;
7490
private static ScriptSession session;
@@ -153,8 +169,26 @@ public void testDiagnostics() throws Exception {
153169

154170
/** A session about plain Python, with a server of its own. */
155171
private static ScriptSession session() {
156-
return new ScriptSession(env -> servers.launch("python", env),
157-
ScriptDocument::of);
172+
return new ScriptSession(servers, TEST_LANGUAGE);
173+
}
174+
175+
@Plugin(type = ScriptDialect.class)
176+
public static class TestDialect implements ScriptDialect {
177+
178+
@Override
179+
public boolean supports(final ScriptLanguage language) {
180+
return language == TEST_LANGUAGE;
181+
}
182+
183+
@Override
184+
public String languageId() {
185+
return "python";
186+
}
187+
188+
@Override
189+
public Header header(final Map<String, Class<?>> parameters) {
190+
return new Header("", Collections.emptySet());
191+
}
158192
}
159193

160194
/** The problems found in a script, in a session of its own. */

‎code-lsp-jython/src/test/java/org/scijava/code/lsp/jython/JythonLanguageServerTest.java‎

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
import java.util.Collections;
3838
import java.util.List;
39+
import java.util.Map;
3940
import java.util.function.Supplier;
4041
import java.util.concurrent.TimeUnit;
4142
import java.util.stream.Collectors;
@@ -44,12 +45,21 @@
4445

4546
import org.eclipse.lsp4j.CompletionItem;
4647
import org.eclipse.lsp4j.SignatureHelp;
48+
import org.eclipse.lsp4j.services.LanguageServer;
49+
import org.junit.jupiter.api.AfterAll;
50+
import org.junit.jupiter.api.BeforeAll;
4751
import org.junit.jupiter.api.Test;
4852
import org.python.jsr223.PyScriptEngineFactory;
53+
import org.scijava.Context;
4954
import org.scijava.code.lsp.Environment;
50-
import org.scijava.code.lsp.ScriptDocument;
55+
import org.scijava.code.lsp.LanguageServerPlugin;
56+
import org.scijava.code.lsp.LanguageServerService;
57+
import org.scijava.code.lsp.ScriptDialect;
5158
import org.scijava.code.lsp.ScriptSession;
5259
import org.scijava.code.lsp.jvm.ClassIndex;
60+
import org.scijava.plugin.Plugin;
61+
import org.scijava.script.AbstractScriptLanguage;
62+
import org.scijava.script.ScriptLanguage;
5363

5464
/**
5565
* Tests {@link JythonLanguageServer}: what it makes of plain Jython, as its
@@ -59,6 +69,29 @@
5969
*/
6070
public class JythonLanguageServerTest {
6171

72+
/** A test fixture: a script language whose scripts are plain Jython. */
73+
private static final ScriptLanguage TEST_LANGUAGE =
74+
new AbstractScriptLanguage()
75+
{
76+
77+
@Override
78+
public ScriptEngine getScriptEngine() {
79+
return null;
80+
}
81+
};
82+
83+
private static Context context;
84+
85+
@BeforeAll
86+
public static void startContext() {
87+
context = new Context(LanguageServerService.class);
88+
}
89+
90+
@AfterAll
91+
public static void disposeContext() {
92+
context.dispose();
93+
}
94+
6295
@Test
6396
public void testMemberCompletion() {
6497
// Static analysis: 's' is a String, so 's.' completes to String members.
@@ -195,8 +228,43 @@ public void testSignatureHelp() {
195228

196229
/** A session about plain Jython, with a server of its own. */
197230
private static ScriptSession session(final Environment env) {
198-
return new ScriptSession(e -> new JythonLanguageServer(env),
199-
ScriptDocument::of);
231+
return new ScriptSession(context.service(LanguageServerService.class),
232+
TEST_LANGUAGE, env.live());
233+
}
234+
235+
@Plugin(type = ScriptDialect.class)
236+
public static class TestDialect implements ScriptDialect {
237+
238+
@Override
239+
public boolean supports(final ScriptLanguage language) {
240+
return language == TEST_LANGUAGE;
241+
}
242+
243+
@Override
244+
public String languageId() {
245+
return "test";
246+
}
247+
248+
@Override
249+
public Header header(final Map<String, Class<?>> parameters) {
250+
return new Header("", Collections.emptySet());
251+
}
252+
}
253+
254+
@Plugin(type = LanguageServerPlugin.class)
255+
public static class TestServers implements LanguageServerPlugin {
256+
257+
@Override
258+
public boolean supports(final String languageId) {
259+
return "test".equals(languageId);
260+
}
261+
262+
@Override
263+
public LanguageServer create(final String languageId,
264+
final Environment environment)
265+
{
266+
return new JythonLanguageServer(environment);
267+
}
200268
}
201269

202270
private static SignatureHelp help(final String code) {

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -171,18 +171,16 @@ public ScriptSession(final LanguageServerService servers,
171171
}
172172

173173
/**
174-
* Starts a session about a script, with servers of its own (e.g. fake ones,
175-
* in tests): the session becomes each server's client, so they must not be
176-
* shared. A server is launched, and initialized, when first needed; and
177-
* shut down when the session moves to another, or is closed.
174+
* Starts a session about a script, with servers of its own: the session
175+
* becomes each server's client, so they must not be shared. A server is
176+
* launched, and initialized, when first needed; and shut down when the
177+
* session moves to another, or is closed.
178178
*
179179
* @param launch Gets a new server, for the script running in an
180180
* environment.
181-
* @param transform Makes scripts what the servers see: e.g. plain code of
182-
* their language; or {@link ScriptDocument#of(String)}, to show
183-
* them as they are.
181+
* @param transform Makes scripts what the servers see.
184182
*/
185-
public ScriptSession(final Function<Environment, LanguageServer> launch,
183+
private ScriptSession(final Function<Environment, LanguageServer> launch,
186184
final Function<String, ScriptDocument> transform)
187185
{
188186
this.launch = launch;

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,11 +191,13 @@ public CompletableFuture<InitializeResult> initialize(
191191
});
192192
}
193193
};
194-
try (ScriptSession session = new ScriptSession(env -> late,
195-
ScriptDocument::of))
196-
{
194+
HighPlugin.next = late;
195+
try (ScriptSession session = new ScriptSession(service, fake)) {
197196
session.update("x");
198197
}
198+
finally {
199+
HighPlugin.next = null;
200+
}
199201
// Told nothing before it answered.
200202
assertEquals(Arrays.asList("answered", "initialized", "open 1 x"),
201203
late.events.subList(0, 3));
@@ -560,6 +562,9 @@ public Header header(final Map<String, Class<?>> parameters) {
560562
@Plugin(type = LanguageServerPlugin.class, priority = Priority.HIGH)
561563
public static class HighPlugin implements LanguageServerPlugin {
562564

565+
/** The server to create next, if not a new one (e.g. a special one). */
566+
static volatile FakeServer next;
567+
563568
@Override
564569
public boolean supports(final String languageId) {
565570
return "fake".equals(languageId);
@@ -570,7 +575,9 @@ public boolean supports(final String languageId) {
570575
public LanguageServer create(final String languageId,
571576
final Environment environment)
572577
{
573-
return register(new FakeServer("high", languageId, environment));
578+
final FakeServer special = next;
579+
return register(special != null ? special : new FakeServer("high",
580+
languageId, environment));
574581
}
575582
}
576583

0 commit comments

Comments
 (0)