feat(pbs): resolve editorial chains and expose read-only external sources
Intrepid/Prometeu/Studio/pipeline/head Build started...
Test / Build skipped: 16, passed: 838
Intrepid/Prometeu/Studio/pipeline/pr-master This commit looks good

This commit is contained in:
2026-10-07 09:00:31 +01:00
parent d0737df0ac
commit 967b9ec598
38 changed files with 1856 additions and 42 deletions
@@ -20,6 +20,7 @@ public final class TcpLspServerHost {
private final LspServerConfiguration serverConfiguration;
private final LspProjectContext context;
private final CompilerLanguageServiceBridge compilerBridge;
private final p.studio.lsp.services.compiler.ExternalSourceRegistry externalSources = new p.studio.lsp.services.compiler.ExternalSourceRegistry();
private final ExecutorService clientExecutor;
private volatile boolean closed;
private volatile ServerSocket serverSocket;
@@ -72,8 +73,8 @@ public final class TcpLspServerHost {
}
private void handleClient(final Socket socket) {
final var server = new PrometeuLanguageServer(context, compilerBridge, externalSources);
try (socket) {
final var server = new PrometeuLanguageServer(context, compilerBridge);
final Launcher<LanguageClient> launcher = LSPLauncher.createServerLauncher(
server,
socket.getInputStream(),
@@ -82,7 +83,7 @@ public final class TcpLspServerHost {
launcher.startListening().get();
} catch (Exception exception) {
if (!closed && !socket.isClosed()) throw new IllegalStateException("LSP client failed", exception);
} finally { clients.remove(socket); }
} finally { server.disconnected(); clients.remove(socket); }
}
public synchronized java.util.Optional<p.studio.lsp.messages.LspServerEndpoint> endpoint() {
@@ -97,6 +98,7 @@ public final class TcpLspServerHost {
return;
}
closed = true;
externalSources.close();
if (serverSocket != null) {
serverSocket.close();
}
@@ -42,6 +42,79 @@ import java.util.*;
import java.util.function.Function;
public final class CompilerLanguageServiceBridge implements LanguageServiceBridge {
public boolean supportsExternalSources(final LspProjectContext context) {
return frontendProvider(context).languageService()
.map(p.studio.compiler.services.FrontendLanguageService::supportsExternalSources).orElse(false);
}
public Optional<p.studio.compiler.services.FrontendSourceDocument> currentSource(
final LspProjectContext context, final Path path) {
return editorialDocument(context, path.toUri().toString(), null).flatMap(document ->
frontendProvider(context).languageService().orElseThrow().sourceDocument(
new FrontendDocumentRequest(context.projectRoot(), path, document.text()),
document.editorialContext(), path));
}
public BaselineHover externalHover(final LspProjectContext context, final String uri,
final int line, final int character, final ExternalSourceRegistry registry, final String consumer) {
final var source = registry.source(consumer, uri);
return frontendProvider(context).languageService().orElseThrow().hover(
new FrontendDocumentRequest(context.projectRoot(), source.path(), source.text()), source.context(),
new DocumentPositionMapper(source.text()).byteOffsetOf(line, character))
.map(symbol -> new BaselineHover(formatHoverMarkdown(symbol)))
.orElseGet(() -> new BaselineHover("No symbol information."));
}
public BaselineSemanticTokens externalSemanticTokens(final LspProjectContext context, final String uri,
final ExternalSourceRegistry registry, final String consumer) {
final var source = registry.source(consumer, uri);
final var provider = frontendProvider(context);
final var tokens = provider.languageService().orElseThrow().semanticTokens(
new FrontendDocumentRequest(context.projectRoot(), source.path(), source.text()), source.context());
final var mapper = new DocumentPositionMapper(source.text());
final var mapped = new ArrayList<BaselineSemanticToken>();
for (var token : tokens) {
final var start = mapper.positionOf(token.startOffset());
final var end = mapper.positionOf(token.endOffset());
if (start.line() == end.line()) mapped.add(new BaselineSemanticToken(start.line(), start.character(),
Math.max(1, end.character() - start.character()), token.semanticKey()));
}
return new BaselineSemanticTokens(provider.specification().getSemanticPresentation().semanticKeys(), mapped);
}
public BaselineDefinition navigation(final LspProjectContext context, final String uri, final String text,
final int line, final int character, final ExternalSourceRegistry registry, final String consumer) {
final var service = frontendProvider(context).languageService().orElseThrow();
final EditorialDocument document;
final Path path;
if (uri.startsWith("prometeu-source:")) {
final var source = registry.source(consumer, uri);
document = new EditorialDocument(source.text(), source.context());
path = source.path();
} else {
final var result = editorialDocument(context, uri, text);
if (result.isEmpty()) return BaselineDefinition.empty();
document = result.orElseThrow();
path = normalizeDocumentPath(uri);
}
final var request = new FrontendDocumentRequest(context.projectRoot(), path, document.text());
final var locations = service.definition(request, document.editorialContext(),
new DocumentPositionMapper(document.text()).byteOffsetOf(line, character));
final var mapped = new ArrayList<BaselineDefinitionLocation>();
for (var location : locations) {
final var source = location.source();
if (source == null) {
mapped.addAll(mapDefinitionLocations(List.of(location), path, document.text()));
continue;
}
final String targetUri = source.readOnly() ? registry.register(consumer, source) : source.path().toUri().toString();
final var mapper = new DocumentPositionMapper(source.text());
final var start = mapper.positionOf(location.startOffset());
final var end = mapper.positionOf(location.endOffset());
mapped.add(new BaselineDefinitionLocation(targetUri, start.line(), start.character(), end.line(), end.character()));
}
return new BaselineDefinition(List.copyOf(mapped));
}
private final AssetSurfaceContextLoader assetSurfaceContextLoader = new AssetSurfaceContextLoader();
private final Function<String, FrontendProvider> frontendProviderResolver;
@@ -203,7 +276,7 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
document.editorialContext(),
offset);
return new BaselineDefinition(mapDefinitionLocations(
locations,
locations.stream().filter(location -> location.source() == null || !location.source().readOnly()).toList(),
request.documentPath(),
document.text()));
})
@@ -1197,7 +1270,11 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
}
final ArrayList<BaselineDefinitionLocation> mapped = new ArrayList<>();
for (final FrontendDefinitionLocation location : locations) {
final String targetText = textForDefinitionTarget(location.path(), currentDocumentPath, currentDocumentText);
// Legacy physical-only surfaces (references/symbols) do not inherit
// external-document coverage from the enriched definition DTO.
if (location.source() != null && !Files.isRegularFile(location.path())) continue;
final String targetText = location.source() != null ? location.source().text()
: textForDefinitionTarget(location.path(), currentDocumentPath, currentDocumentText);
if (targetText == null) {
continue;
}
@@ -0,0 +1,165 @@
package p.studio.lsp.services.compiler;
import p.studio.compiler.services.FrontendSourceDocument;
import java.nio.file.Path;
import java.util.*;
import java.util.function.Function;
/** Owned by one project host, never by the shared compiler bridge. */
public final class ExternalSourceRegistry implements AutoCloseable {
public record Descriptor(String uri, String revision, String origin, String name,
String languageId, boolean readOnly) {}
public record Content(Descriptor descriptor, String text) {}
private static final class Entry {
final Descriptor descriptor;
final Path path;
FrontendSourceDocument source;
final Set<String> readers = new HashSet<>();
Entry(Descriptor descriptor, FrontendSourceDocument source) {
this.descriptor = descriptor;
this.path = source.path();
this.source = source;
}
}
private static final class Consumer {
final boolean persistent;
final Set<String> grants = new HashSet<>();
final Set<String> retained = new HashSet<>();
final Set<String> validated = new HashSet<>();
boolean connected = true;
Consumer(boolean persistent) { this.persistent = persistent; }
}
private final String session = UUID.randomUUID().toString();
private final Map<String, Consumer> consumers = new HashMap<>();
private final Map<String, Entry> entries = new HashMap<>();
private boolean closed;
public synchronized String connect(String existing, boolean persistent) {
if (closed) throw unavailable();
if (existing != null && !existing.isBlank()) {
consumer(existing).connected = true;
return existing;
}
final String id = UUID.randomUUID().toString();
consumers.put(id, new Consumer(persistent));
return id;
}
public synchronized String register(String consumerId, FrontendSourceDocument source) {
final var consumer = activeConsumer(consumerId);
if (!source.readOnly()) throw new IllegalArgumentException("external source must be read-only");
Entry entry = entries.values().stream().filter(e -> sameSnapshot(e.source, source)).findFirst().orElse(null);
if (entry == null) {
// Only unreserved URI characters: VS Code and LSP URI serializers
// must not change the opaque identity by normalizing escaped slashes.
final String uri = "prometeu-source://" + session + "/" + UUID.randomUUID() + "/"
+ source.revision() + "/" + source.name().replaceAll("[^A-Za-z0-9._-]", "-");
entry = new Entry(new Descriptor(uri, source.revision(), source.origin(), source.name(), source.languageId(), true), source);
entries.put(uri, entry);
}
consumer.grants.add(entry.descriptor.uri());
consumer.validated.add(entry.descriptor.uri());
entry.readers.add(consumerId);
return entry.descriptor.uri();
}
private static boolean sameSnapshot(FrontendSourceDocument left, FrontendSourceDocument right) {
return left == right || left != null && left.path().equals(right.path())
&& left.context().projectSurface() != null
&& left.context().projectSurface() == right.context().projectSurface()
&& left.text().equals(right.text());
}
public synchronized FrontendSourceDocument source(String consumerId, String uri) {
final Entry entry = admitted(consumerId, uri);
if (entry.source == null || !entry.readers.contains(consumerId)
|| !activeConsumer(consumerId).validated.contains(uri)) throw unavailable();
return entry.source;
}
public synchronized Content read(String consumerId, String uri) {
final var source = source(consumerId, uri);
activeConsumer(consumerId).retained.add(uri);
return new Content(entries.get(uri).descriptor, source.text());
}
public synchronized Content retain(String consumerId, String uri) {
return read(consumerId, uri); // Navigation already grants a coalesced consumer use.
}
public synchronized void release(String consumerId, String uri) {
final Consumer consumer = activeConsumer(consumerId);
if (uri == null) {
for (String granted : List.copyOf(consumer.grants)) release(consumerId, granted);
consumers.remove(consumerId);
return;
}
if (!consumer.grants.remove(uri)) return;
consumer.retained.remove(uri);
consumer.validated.remove(uri);
final Entry entry = entries.get(uri);
if (entry != null) {
entry.readers.remove(consumerId);
if (entry.readers.isEmpty()) entry.source = null;
if (consumers.values().stream().noneMatch(c -> c.grants.contains(uri))) entries.remove(uri);
}
}
public synchronized void disconnect(String consumerId) {
final Consumer consumer = consumers.get(consumerId);
if (consumer == null) return;
consumer.connected = false;
consumer.validated.clear();
for (String uri : List.copyOf(consumer.grants)) {
final Entry entry = entries.get(uri);
if (consumer.persistent && consumer.retained.contains(uri)) continue;
if (!consumer.retained.contains(uri)) consumer.grants.remove(uri);
if (entry != null) {
entry.readers.remove(consumerId);
if (entry.readers.isEmpty()) entry.source = null;
if (consumers.values().stream().noneMatch(c -> c.grants.contains(uri))) entries.remove(uri);
}
}
}
public synchronized Content revalidate(String consumerId, String uri,
Function<Path, Optional<FrontendSourceDocument>> resolve) {
final Entry entry = admitted(consumerId, uri);
activeConsumer(consumerId).validated.remove(uri);
final var current = resolve.apply(entry.path).orElseThrow(ExternalSourceRegistry::unavailable);
if (!current.readOnly() || !current.revision().equals(entry.descriptor.revision())
|| !current.origin().equals(entry.descriptor.origin())) throw unavailable();
// Existing readers keep their original semantic snapshot. Otherwise bind a
// newly validated snapshot of identical content, never replacement text.
if (entry.source == null) entry.source = current;
entry.readers.add(consumerId);
activeConsumer(consumerId).validated.add(uri);
return read(consumerId, uri);
}
private Entry admitted(String consumerId, String uri) {
if (!activeConsumer(consumerId).grants.contains(uri)) throw unavailable();
final Entry entry = entries.get(uri);
if (entry == null) throw unavailable();
return entry;
}
private Consumer consumer(String id) {
final Consumer result = consumers.get(id);
if (closed || result == null) throw unavailable();
return result;
}
private Consumer activeConsumer(String id) {
final Consumer result = consumer(id);
if (!result.connected) throw unavailable();
return result;
}
public static IllegalStateException unavailable() {
return new IllegalStateException("External source unavailable; navigate again after reconnecting.");
}
@Override public synchronized void close() {
closed = true;
entries.clear();
consumers.clear();
}
}
@@ -0,0 +1,14 @@
package p.studio.lsp.services.protocol;
import org.eclipse.lsp4j.jsonrpc.services.JsonRequest;
import org.eclipse.lsp4j.services.LanguageServer;
import p.studio.lsp.services.compiler.ExternalSourceRegistry.Content;
import java.util.concurrent.CompletableFuture;
public interface ExternalSourceLanguageServer extends LanguageServer {
record Request(String consumerId, String uri) {}
@JsonRequest("prometeu/readExternalSource") CompletableFuture<Content> readExternalSource(Request request);
@JsonRequest("prometeu/retainExternalSource") CompletableFuture<Content> retainExternalSource(Request request);
@JsonRequest("prometeu/releaseExternalSource") CompletableFuture<Void> releaseExternalSource(Request request);
@JsonRequest("prometeu/revalidateExternalSource") CompletableFuture<Content> revalidateExternalSource(Request request);
}
@@ -13,7 +13,9 @@ import p.studio.lsp.services.protocol.mapping.ProtocolMessageMapper;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
public final class PrometeuLanguageServer implements LanguageServer, LanguageClientAware {
public final class PrometeuLanguageServer implements ExternalSourceLanguageServer, LanguageClientAware {
private p.studio.lsp.services.compiler.ExternalSourceRegistry externalSources;
private String consumerId;
private final LspProjectContext project;
private final LanguageServiceBridge languageServiceBridge;
private final ProtocolMessageMapper protocolMessageMapper;
@@ -32,6 +34,47 @@ public final class PrometeuLanguageServer implements LanguageServer, LanguageCli
null);
}
public PrometeuLanguageServer(final LspProjectContext project,
final CompilerLanguageServiceBridge bridge,
final p.studio.lsp.services.compiler.ExternalSourceRegistry registry) {
this(project, bridge);
this.externalSources = registry;
}
public void disconnected() {
if (externalSources != null && consumerId != null) externalSources.disconnect(consumerId);
}
private void requireConsumer(Request request) {
if (consumerId == null || request == null || !consumerId.equals(request.consumerId()))
throw p.studio.lsp.services.compiler.ExternalSourceRegistry.unavailable();
}
private <T> CompletableFuture<T> external(Request request, java.util.function.Supplier<T> operation) {
try {
requireConsumer(request);
return CompletableFuture.completedFuture(operation.get());
} catch (RuntimeException failure) {
return CompletableFuture.failedFuture(new org.eclipse.lsp4j.jsonrpc.ResponseErrorException(
new org.eclipse.lsp4j.jsonrpc.messages.ResponseError(
org.eclipse.lsp4j.jsonrpc.messages.ResponseErrorCode.InvalidRequest,
failure.getMessage(), null)));
}
}
@Override public CompletableFuture<p.studio.lsp.services.compiler.ExternalSourceRegistry.Content> readExternalSource(Request request) {
return external(request, () -> externalSources.read(consumerId, request.uri()));
}
@Override public CompletableFuture<p.studio.lsp.services.compiler.ExternalSourceRegistry.Content> retainExternalSource(Request request) {
return external(request, () -> externalSources.retain(consumerId, request.uri()));
}
@Override public CompletableFuture<Void> releaseExternalSource(Request request) {
return external(request, () -> { externalSources.release(consumerId, request.uri()); return null; });
}
@Override public CompletableFuture<p.studio.lsp.services.compiler.ExternalSourceRegistry.Content> revalidateExternalSource(Request request) {
return external(request, () -> externalSources.revalidate(consumerId, request.uri(),
path -> ((CompilerLanguageServiceBridge) languageServiceBridge).currentSource(project, path)));
}
PrometeuLanguageServer(
final LspProjectContext project,
final LanguageServiceBridge languageServiceBridge,
@@ -69,8 +112,25 @@ public final class PrometeuLanguageServer implements LanguageServer, LanguageCli
}
return CompletableFuture.failedFuture(runtimeException);
}
return CompletableFuture.completedFuture(protocolMessageMapper
.mapInitializeResult(languageServiceBridge.describeServer(project)));
final var result = protocolMessageMapper.mapInitializeResult(languageServiceBridge.describeServer(project));
final var gson = new com.google.gson.Gson();
final var capability = gson.toJsonTree(params.getCapabilities() == null ? null : params.getCapabilities().getExperimental());
if (externalSources != null && languageServiceBridge instanceof CompilerLanguageServiceBridge bridge
&& bridge.supportsExternalSources(project) && capability.isJsonObject()
&& capability.getAsJsonObject().has("prometeuExternalSources")
&& capability.getAsJsonObject().get("prometeuExternalSources").getAsBoolean()) {
final var rawOptions = gson.toJsonTree(params.getInitializationOptions());
final var options = rawOptions.isJsonObject() ? rawOptions.getAsJsonObject() : new com.google.gson.JsonObject();
final String previous = options.has("prometeuExternalConsumerId") ? options.get("prometeuExternalConsumerId").getAsString() : null;
final boolean persistent = options.has("prometeuExternalPersistentConsumer") && options.get("prometeuExternalPersistentConsumer").getAsBoolean();
consumerId = externalSources.connect(previous, persistent);
final var experimental = gson.toJsonTree(result.getCapabilities().getExperimental()).getAsJsonObject();
experimental.addProperty("prometeuExternalSources", true);
experimental.addProperty("prometeuExternalConsumerId", consumerId);
result.getCapabilities().setExperimental(experimental);
((PrometeuTextDocumentService) textDocumentService).externalSources(externalSources, consumerId);
}
return CompletableFuture.completedFuture(result);
}
@Override
@@ -29,6 +29,43 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
private final ProtocolMessageMapper protocolMessageMapper;
private final ConcurrentMap<String, String> documentTextByUri = new ConcurrentHashMap<>();
private volatile LanguageClient client;
private p.studio.lsp.services.compiler.ExternalSourceRegistry externalSources;
private String externalConsumer;
void externalSources(p.studio.lsp.services.compiler.ExternalSourceRegistry registry, String consumer) {
externalSources = registry;
externalConsumer = consumer;
}
private static boolean external(String uri) { return uri.startsWith("prometeu-source:"); }
private p.studio.lsp.services.compiler.CompilerLanguageServiceBridge compiler() {
return (p.studio.lsp.services.compiler.CompilerLanguageServiceBridge) languageServiceBridge;
}
private static ResponseErrorException refused(String message) {
return new ResponseErrorException(new ResponseError(ResponseErrorCode.InvalidRequest, message, null));
}
private void requireExternal(String uri) {
if (externalSources == null || externalConsumer == null) throw refused("External source support was not negotiated.");
try { externalSources.source(externalConsumer, uri); }
catch (IllegalStateException unavailable) { throw refused(unavailable.getMessage()); }
}
private void requireEditable(String uri) {
if (external(uri)) throw readOnly();
if (languageServiceBridge instanceof p.studio.lsp.services.compiler.CompilerLanguageServiceBridge bridge) {
final var source = bridge.currentSource(project, java.nio.file.Path.of(java.net.URI.create(uri)));
if (source.isEmpty() || source.orElseThrow().readOnly()) throw readOnly();
}
}
private static ResponseErrorException readOnly() {
return new ResponseErrorException(new ResponseError(-32010, "Source is not an editable project document.", null));
}
private void validateEdit(WorkspaceEdit edit) {
if (edit == null) return;
if (edit.getChanges() != null) edit.getChanges().keySet().forEach(this::requireEditable);
if (edit.getDocumentChanges() != null) for (var change : edit.getDocumentChanges()) {
if (!change.isLeft()) throw refused("File operations are not supported.");
requireEditable(change.getLeft().getTextDocument().getUri());
}
}
public PrometeuTextDocumentService(
final LspProjectContext project,
@@ -46,7 +83,12 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public void didOpen(final DidOpenTextDocumentParams params) {
final String uri = params.getTextDocument().getUri();
final String text = params.getTextDocument().getText();
if (external(uri)) { requireExternal(uri); externalSources.retain(externalConsumer, uri); return; }
String text = params.getTextDocument().getText();
if (languageServiceBridge instanceof p.studio.lsp.services.compiler.CompilerLanguageServiceBridge bridge) {
final var known = bridge.currentSource(project, java.nio.file.Path.of(java.net.URI.create(uri)));
if (known.isPresent() && known.orElseThrow().readOnly()) text = known.orElseThrow().text();
}
documentTextByUri.put(uri, text);
publishAnalysis(uri, text);
}
@@ -54,6 +96,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public void didChange(final DidChangeTextDocumentParams params) {
final String uri = params.getTextDocument().getUri();
requireEditable(uri);
final String text = params.getContentChanges().isEmpty()
? ""
: params.getContentChanges().getFirst().getText();
@@ -63,6 +106,9 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public void didClose(final DidCloseTextDocumentParams params) {
if (external(params.getTextDocument().getUri())) {
if (externalSources != null) externalSources.release(externalConsumer, params.getTextDocument().getUri()); return;
}
documentTextByUri.remove(params.getTextDocument().getUri());
final LanguageClient currentClient = client;
if (currentClient == null) {
@@ -73,6 +119,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public void didSave(final DidSaveTextDocumentParams params) {
requireEditable(params.getTextDocument().getUri());
final LanguageClient currentClient = client;
if (currentClient == null) {
return;
@@ -84,6 +131,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<Either<List<CompletionItem>, CompletionList>> completion(final CompletionParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(Either.forLeft(List.of()));
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(Either.forRight(protocolMessageMapper.mapCompletion(
languageServiceBridge.completion(
@@ -97,6 +145,9 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<Hover> hover(final HoverParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) requireExternal(uri);
if (external(uri)) return CompletableFuture.completedFuture(protocolMessageMapper.mapHover(
compiler().externalHover(project, uri, params.getPosition().getLine(), params.getPosition().getCharacter(), externalSources, externalConsumer)));
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapHover(languageServiceBridge.hover(
project,
@@ -110,6 +161,9 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
public CompletableFuture<Either<List<? extends Location>, List<? extends LocationLink>>> definition(
final DefinitionParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) requireExternal(uri);
if (externalSources != null) return CompletableFuture.completedFuture(Either.forLeft(protocolMessageMapper.mapDefinition(
compiler().navigation(project, uri, documentTextByUri.get(uri), params.getPosition().getLine(), params.getPosition().getCharacter(), externalSources, externalConsumer))));
final String text = documentTextByUri.get(uri);
final List<Location> locations = protocolMessageMapper.mapDefinition(languageServiceBridge.definition(
project,
@@ -123,6 +177,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<? extends Location>> references(final ReferenceParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
final boolean includeDeclaration = params.getContext() != null
&& Boolean.TRUE.equals(params.getContext().isIncludeDeclaration());
@@ -140,6 +195,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
public CompletableFuture<Either3<Range, PrepareRenameResult, PrepareRenameDefaultBehavior>> prepareRename(
final PrepareRenameParams params) {
final String uri = params.getTextDocument().getUri();
requireEditable(uri);
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapPrepareRename(
languageServiceBridge.prepareRename(
@@ -153,6 +209,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<WorkspaceEdit> rename(final RenameParams params) {
final String uri = params.getTextDocument().getUri();
requireEditable(uri);
final String text = documentTextByUri.get(uri);
final var result = languageServiceBridge.rename(
project,
@@ -168,12 +225,15 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
null);
return CompletableFuture.failedFuture(new ResponseErrorException(error));
}
return CompletableFuture.completedFuture(protocolMessageMapper.mapRename(result));
final var edit = protocolMessageMapper.mapRename(result);
validateEdit(edit);
return CompletableFuture.completedFuture(edit);
}
@Override
public CompletableFuture<List<CallHierarchyItem>> prepareCallHierarchy(final CallHierarchyPrepareParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapCallHierarchyItems(
languageServiceBridge.prepareCallHierarchy(
@@ -199,7 +259,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
}
private List<BaselineCallSite> directedCallSites(final CallHierarchyItem item, final boolean incoming) {
if (item == null || item.getUri() == null || item.getSelectionRange() == null) {
if (item == null || item.getUri() == null || external(item.getUri()) || item.getSelectionRange() == null) {
return List.of();
}
final String text = documentTextByUri.get(item.getUri());
@@ -219,6 +279,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<? extends TextEdit>> formatting(final DocumentFormattingParams params) {
final String uri = params.getTextDocument().getUri();
requireEditable(uri);
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapFormatting(
languageServiceBridge.formatDocument(project, uri, text)));
@@ -227,6 +288,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<FoldingRange>> foldingRange(final FoldingRangeRequestParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapFoldingRanges(
languageServiceBridge.foldingRanges(project, uri, text)));
@@ -235,6 +297,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<SelectionRange>> selectionRange(final SelectionRangeParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
final ArrayList<DocumentPosition> positions = new ArrayList<>();
if (params.getPositions() != null) {
@@ -252,6 +315,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<DocumentLink>> documentLink(final DocumentLinkParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapDocumentLinks(
languageServiceBridge.documentLinks(project, uri, text)));
@@ -259,6 +323,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<List<Either<Command, CodeAction>>> codeAction(final CodeActionParams params) {
requireEditable(params.getTextDocument().getUri());
if (!quickFixRequested(params.getContext())) {
return CompletableFuture.completedFuture(List.of());
}
@@ -268,15 +333,21 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
|| params.getContext().getDiagnostics() == null
? List.of()
: params.getContext().getDiagnostics();
return CompletableFuture.completedFuture(protocolMessageMapper.mapCodeActions(
final var actions = protocolMessageMapper.mapCodeActions(
languageServiceBridge.codeActions(project, uri, text, baselineDiagnostics(contextDiagnostics)),
contextDiagnostics));
contextDiagnostics);
for (var action : actions) {
if (action.isLeft()) throw refused("Executable actions are not supported.");
validateEdit(action.getRight().getEdit());
}
return CompletableFuture.completedFuture(actions);
}
@Override
public CompletableFuture<List<Either<SymbolInformation, DocumentSymbol>>> documentSymbol(
final DocumentSymbolParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(List.of());
final String text = documentTextByUri.get(uri);
final List<Either<SymbolInformation, DocumentSymbol>> symbols = new ArrayList<>();
for (final DocumentSymbol symbol : protocolMessageMapper.mapDocumentSymbols(
@@ -289,6 +360,7 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<SignatureHelp> signatureHelp(final SignatureHelpParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) return CompletableFuture.completedFuture(null);
final String text = documentTextByUri.get(uri);
return CompletableFuture.completedFuture(protocolMessageMapper.mapSignatureHelp(
languageServiceBridge.signatureHelp(
@@ -302,6 +374,9 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
@Override
public CompletableFuture<SemanticTokens> semanticTokensFull(final SemanticTokensParams params) {
final String uri = params.getTextDocument().getUri();
if (external(uri)) requireExternal(uri);
if (external(uri)) return CompletableFuture.completedFuture(protocolMessageMapper.mapSemanticTokens(
compiler().externalSemanticTokens(project, uri, externalSources, externalConsumer)));
final String text = documentTextByUri.getOrDefault(uri, "");
return CompletableFuture.completedFuture(protocolMessageMapper.mapSemanticTokens(
languageServiceBridge.semanticTokens(project, uri, text)));
@@ -0,0 +1,63 @@
package p.studio.lsp.services;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import org.junit.jupiter.api.io.TempDir;
import p.studio.lsp.messages.*;
import p.studio.lsp.services.compiler.CompilerLanguageServiceBridge;
import java.nio.file.*;
import java.util.concurrent.TimeUnit;
import static org.junit.jupiter.api.Assertions.*;
/** Opt-in actual VS Code test against the development classpath (never installDist). */
@EnabledIfEnvironmentVariable(named = "PROMETEU_VSCODE_DEV_TEST", matches = "1")
class ExternalSourceDevelopmentHostTest {
@TempDir Path temporary;
@Test void realEditorReadsBundledSourceWithoutMaterializingIt() throws Exception {
Path repository = Path.of("").toAbsolutePath();
while (!Files.isDirectory(repository.resolve("tools/vscode-extension"))) repository = repository.getParent();
final Path root = Files.createDirectories(temporary.resolve("project")).toRealPath();
Files.createDirectories(root.resolve("src"));
Files.createDirectories(root.resolve(".vscode"));
Files.writeString(root.resolve("prometeu.json"), """
{"name":"app","version":"1.0.0","language":"pbs","stdlib":"1","target":"Game","dependencies":[{"path":".workspace/repos/lib"}]}
""");
Files.writeString(root.resolve("src/main.pbs"), "import { Gfx } from @sdk:gfx;\nimport { answer } from @lib:shared;\nfn main() -> void { Gfx.clear(0); answer(); }\n");
Files.writeString(root.resolve("src/mod.barrel"), "pub fn main() -> void;\n");
final Path library = Files.createDirectories(root.resolve(".workspace/repos/lib/src")).getParent();
Files.createDirectories(library.resolve("src/shared"));
Files.writeString(library.resolve("prometeu.json"), """
{"name":"lib","version":"1.0.0","language":"pbs","stdlib":"1","target":"Game","dependencies":[]}
""");
Files.writeString(root.resolve(".workspace/repos/registry.json"), "{}");
final String libraryText = "// á 😀\r\nfn answer() -> int { return helper(); }\r\nfn helper() -> int { return 42; }\r\n";
Files.writeString(library.resolve("src/shared/main.pbs"), libraryText);
Files.writeString(library.resolve("src/shared/mod.barrel"), "pub fn answer() -> int;\n");
final var host = new TcpLspServerHost(LspServerConfiguration.builder()
.endpoint(new LspServerEndpoint("127.0.0.1", 0)).build(), new LspProjectContext("dev", "pbs", root),
new CompilerLanguageServiceBridge());
host.start();
try {
Files.writeString(root.resolve(".vscode/settings.json"), "{\"prometeu.studio.port\":" + host.endpoint().orElseThrow().port() + "}");
final String executable = System.getenv().getOrDefault("PROMETEU_VSCODE_EXECUTABLE", "/Applications/Visual Studio Code.app/Contents/MacOS/Code");
final Path extension = repository.resolve("tools/vscode-extension");
final var builder = new ProcessBuilder(executable, "--no-sandbox", "--disable-extensions", "--disable-workspace-trust",
"--skip-welcome", "--skip-release-notes", "--user-data-dir=" + temporary.resolve("vscode-user"),
"--extensions-dir=" + temporary.resolve("vscode-extensions"), "--extensionDevelopmentPath=" + extension,
"--extensionTestsPath=" + extension.resolve("out/test/externalSources.js"), root.toString());
builder.environment().remove("ELECTRON_RUN_AS_NODE");
final Path log = Path.of("/tmp/pln141-vscode-development.log");
final var process = builder.redirectErrorStream(true).redirectOutput(log.toFile()).start();
try {
assertTrue(process.waitFor(90, TimeUnit.SECONDS), "VS Code test timed out: " + log);
assertEquals(0, process.exitValue(), () -> read(log));
} finally { process.destroyForcibly(); }
assertEquals(libraryText, Files.readString(library.resolve("src/shared/main.pbs")));
try (var directories = Files.list(root.resolve(".workspace"))) {
assertEquals(java.util.List.of("repos"), directories.map(p -> p.getFileName().toString()).toList(), "No editorial SDK cache");
}
} finally { host.close(); }
}
private static String read(Path path) { try { return Files.readString(path); } catch (Exception e) { return e.toString(); } }
}
@@ -28,6 +28,82 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
class CompilerLanguageServiceBridgeTest {
@Test
void retainedDependencyUsesOriginalSemanticSnapshotAfterDiskChanges(@TempDir Path temporary) throws Exception {
final Path root = temporary.toRealPath();
final Path library = Files.createDirectories(root.resolve(".workspace/repos/lib/src")).getParent();
Files.createDirectories(root.resolve("src"));
Files.writeString(root.resolve("prometeu.json"), """
{"name":"app","version":"1.0.0","language":"pbs","stdlib":"1","target":"Game",
"dependencies":[{"path":".workspace/repos/lib"}]}
""");
Files.createDirectories(library.resolve("src/shared"));
Files.writeString(library.resolve("prometeu.json"), """
{"name":"lib","version":"1.0.0","language":"pbs","stdlib":"1","target":"Game","dependencies":[]}
""");
Files.writeString(root.resolve(".workspace/repos/registry.json"), "{}");
final String projectText = "import { answer } from @lib:shared;\nfn main() -> int { return answer(); }\n";
final Path projectFile = Files.writeString(root.resolve("src/main.pbs"), projectText);
final String old = "// á 😀\r\nfn answer() -> int { return original(); }\r\nfn original() -> int { return 1; }\r\n";
final Path libraryFile = Files.writeString(library.resolve("src/shared/main.pbs"), old);
Files.writeString(library.resolve("src/shared/mod.barrel"), "pub fn answer() -> int;\n");
final var bridge = new CompilerLanguageServiceBridge();
final var context = new LspProjectContext("snapshot", "pbs", root);
try (var registry = new ExternalSourceRegistry()) {
final String consumer = registry.connect(null, false);
final String uri = bridge.navigation(context, projectFile.toUri().toString(), projectText, 1, 26, registry, consumer)
.locations().getFirst().uri();
final var retained = registry.source(consumer, uri);
assertEquals(old, registry.read(consumer, uri).text());
Files.writeString(libraryFile, "// different revision\n" + old.replace("original", "replacement"));
final var target = bridge.navigation(context, uri, null, 1, 28, registry, consumer).locations().getFirst();
assertEquals(2, target.startLine());
assertEquals(old, registry.read(consumer, target.uri()).text());
assertTrue(bridge.externalHover(context, uri, 1, 28, registry, consumer).markdown().contains("original"));
assertTrue(retained.context() == registry.source(consumer, uri).context());
registry.disconnect(consumer);
registry.connect(consumer, false);
org.junit.jupiter.api.Assertions.assertThrows(IllegalStateException.class,
() -> registry.revalidate(consumer, uri, path -> bridge.currentSource(context, path)));
org.junit.jupiter.api.Assertions.assertThrows(IllegalStateException.class, () -> registry.source(consumer, uri));
}
}
@Test
void externalNavigationRetainsBundledTextAndContinuesIntoHostDeclarations() {
final Path root = findRepoRoot(Path.of("").toAbsolutePath()).resolve("test-projects/main");
final var context = new LspProjectContext("main", "pbs", root);
final var bridge = new CompilerLanguageServiceBridge();
final String source = "import { Gfx } from @sdk:gfx;\nfn frame() -> void { Gfx.clear(0); }\n";
final var position = new DocumentPositionMapper(source).positionOf(source.indexOf("clear"));
try (var registry = new ExternalSourceRegistry()) {
final String consumer = registry.connect(null, false);
final var locations = bridge.navigation(context, root.resolve("src/main.pbs").toUri().toString(), source,
position.line(), position.character(), registry, consumer).locations();
assertEquals(1, locations.size());
final String uri = locations.getFirst().uri();
assertTrue(uri.startsWith("prometeu-source:"));
final var content = registry.read(consumer, uri);
assertEquals("bundled", content.descriptor().origin());
assertTrue(content.descriptor().readOnly());
assertTrue(content.text().contains("LowGfx.clear"));
final int call = content.text().indexOf("LowGfx.clear") + "LowGfx.".length();
final var hostUse = new DocumentPositionMapper(content.text()).positionOf(call);
assertTrue(bridge.externalHover(context, uri, hostUse.line(), hostUse.character(), registry, consumer)
.markdown().contains("clear"));
final var host = bridge.navigation(context, uri, null, hostUse.line(), hostUse.character(), registry, consumer)
.locations().getFirst();
final var hostContent = registry.read(consumer, host.uri());
final String[] lines = hostContent.text().split("\n");
assertTrue(lines[host.startLine()].contains("clear"), lines[host.startLine()]);
assertFalse(bridge.externalSemanticTokens(context, uri, registry, consumer).tokens().isEmpty());
final var colorUse = new DocumentPositionMapper(content.text()).positionOf(content.text().indexOf("color: Color") + 7);
final String coreUri = bridge.navigation(context, uri, null, colorUse.line(), colorUse.character(), registry, consumer)
.locations().getFirst().uri();
assertTrue(registry.read(consumer, coreUri).descriptor().name().replace('\\', '/').contains("core/color"));
}
}
@Test
void editorialEndpointsReturnNeutralResponsesWhenLanguageServiceIsAbsent() {
final var provider = new CompileOnlyFrontendProvider();
@@ -0,0 +1,77 @@
package p.studio.lsp.services.compiler;
import org.junit.jupiter.api.Test;
import p.studio.compiler.services.FrontendEditorialContext;
import p.studio.compiler.services.FrontendSourceDocument;
import java.nio.file.Path;
import java.util.Optional;
import static org.junit.jupiter.api.Assertions.*;
class ExternalSourceRegistryTest {
private FrontendSourceDocument source(String text) {
return new FrontendSourceDocument(Path.of("/virtual/stdlib/sdk/main.pbs"), text, "bundled", "sdk/main.pbs", "pbs", true,
new FrontendEditorialContext(new Object(), null, new Object()));
}
@Test void readersShareRevisionWithoutSharingReleaseAndUnknownIdentitiesAreRejected() {
try (var registry = new ExternalSourceRegistry(); var otherProject = new ExternalSourceRegistry()) {
final var source = source("// á 😀\r\nfn f() {}\r\n");
final String one = registry.connect(null, false), two = registry.connect(null, false);
final String uri = registry.register(one, source);
assertEquals(uri, registry.register(two, source));
registry.retain(one, uri);
registry.release(one, uri);
assertThrows(IllegalStateException.class, () -> registry.read(one, uri));
assertSame(source.context(), registry.source(two, uri).context());
assertEquals(source.text(), registry.read(two, uri).text());
assertThrows(IllegalStateException.class, () -> otherProject.read(otherProject.connect(null, false), uri));
assertThrows(IllegalStateException.class, () -> registry.read(two, "file:///etc/passwd"));
registry.release(two, uri);
assertThrows(IllegalStateException.class, () -> registry.read(two, uri));
}
}
@Test void disconnectedDocumentsRequireRevalidationAndChangedRevisionCannotReplaceText() {
try (var registry = new ExternalSourceRegistry()) {
final String consumer = registry.connect(null, false);
final var old = source("old");
final String uri = registry.register(consumer, old);
registry.retain(consumer, uri);
registry.disconnect(consumer);
assertThrows(IllegalStateException.class, () -> registry.read(consumer, uri));
registry.connect(consumer, false);
assertThrows(IllegalStateException.class, () -> registry.read(consumer, uri));
assertThrows(IllegalStateException.class, () -> registry.revalidate(consumer, uri, p -> Optional.of(source("new"))));
assertEquals("old", registry.revalidate(consumer, uri, p -> Optional.of(source("old"))).text());
}
}
@Test void taskConsumerOutlivesTransportButNotTaskOrProject() {
final var registry = new ExternalSourceRegistry();
final String consumer = registry.connect(null, true);
final var snapshot = source("source");
final String uri = registry.register(consumer, snapshot);
registry.retain(consumer, uri);
registry.disconnect(consumer);
registry.connect(consumer, true);
assertThrows(IllegalStateException.class, () -> registry.source(consumer, uri));
registry.revalidate(consumer, uri, p -> Optional.of(source("source")));
assertSame(snapshot, registry.source(consumer, uri));
registry.release(consumer, null);
assertThrows(IllegalStateException.class, () -> registry.connect(consumer, true));
final String next = registry.connect(null, true);
registry.register(next, snapshot);
registry.close();
assertThrows(IllegalStateException.class, () -> registry.read(next, uri));
}
@Test void cancelledOrUnopenedNavigationDoesNotRetainASnapshot() {
try (var registry = new ExternalSourceRegistry()) {
final String consumer = registry.connect(null, true);
final String uri = registry.register(consumer, source("unused"));
registry.disconnect(consumer);
registry.connect(consumer, true);
assertThrows(IllegalStateException.class, () -> registry.revalidate(consumer, uri, p -> Optional.of(source("unused"))));
}
}
}
@@ -0,0 +1,33 @@
package p.studio.lsp.services.protocol;
import org.eclipse.lsp4j.*;
import org.eclipse.lsp4j.jsonrpc.ResponseErrorException;
import org.junit.jupiter.api.Test;
import p.studio.lsp.messages.LspProjectContext;
import p.studio.lsp.services.compiler.CompilerLanguageServiceBridge;
import p.studio.lsp.services.protocol.mapping.Lsp4jProtocolMessageMapper;
import java.nio.file.Path;
import java.util.List;
import static org.junit.jupiter.api.Assertions.*;
class ExternalWriteBoundaryTest {
@Test void externalEditsAreRefusedEvenWithoutARegisteredConsumer() {
final var service = new PrometeuTextDocumentService(new LspProjectContext("test", "pbs", Path.of(".")),
new CompilerLanguageServiceBridge(), new Lsp4jProtocolMessageMapper());
final String uri = "prometeu-source://session/revision/main.pbs";
final var id = new TextDocumentIdentifier(uri);
final var versioned = new VersionedTextDocumentIdentifier(uri, 2);
final var position = new Position(0, 0);
final List<org.junit.jupiter.api.function.Executable> attempts = List.of(
() -> service.didChange(new DidChangeTextDocumentParams(versioned, List.of(new TextDocumentContentChangeEvent("changed")))),
() -> service.didSave(new DidSaveTextDocumentParams(id)),
() -> service.formatting(new DocumentFormattingParams(id, new FormattingOptions(4, true))),
() -> service.rename(new RenameParams(id, position, "changed")),
() -> service.prepareRename(new PrepareRenameParams(id, position)),
() -> service.codeAction(new CodeActionParams(id, new Range(position, position), new CodeActionContext(List.of()))));
for (var attempt : attempts) assertEquals(-32010, assertThrows(ResponseErrorException.class, attempt).getResponseError().getCode());
assertTrue(service.references(new ReferenceParams(id, position, new ReferenceContext(true))).join().isEmpty());
assertTrue(service.documentLink(new DocumentLinkParams(id)).join().isEmpty());
assertTrue(service.prepareCallHierarchy(new CallHierarchyPrepareParams(id, position)).join().isEmpty());
}
}