Merge pull request #703 from usethesource/feature/587-log-output-channel

DavyLandman · web-flow · commit 23d0fbd94bfd · 2025-08-28T16:43:35.000+02:00
Rich VS Code logs
diff --git a/rascal-lsp/pom.xml b/rascal-lsp/pom.xml
@@ -98,6 +98,11 @@
       <artifactId>log4j-jul</artifactId>
       <version>${log4j2.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-layout-template-json</artifactId>
+      <version>${log4j2.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.eclipse.lsp4j</groupId>
       <artifactId>org.eclipse.lsp4j.debug</artifactId>
diff --git a/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseLanguageServer.java b/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseLanguageServer.java
@@ -66,6 +66,7 @@
 import org.rascalmpl.uri.URIResolverRegistry;
 import org.rascalmpl.uri.URIUtil;
 import org.rascalmpl.values.IRascalValueFactory;
+import org.rascalmpl.vscode.lsp.log.LogRedirectConfiguration;
 import org.rascalmpl.vscode.lsp.terminal.ITerminalIDEServer.LanguageParameter;
 import org.rascalmpl.vscode.lsp.uri.jsonrpc.impl.VSCodeVFSClient;
 import org.rascalmpl.vscode.lsp.uri.jsonrpc.messages.PathConfigParameter;
diff --git a/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/log/LogJsonConfiguration.java b/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/log/LogJsonConfiguration.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2018-2025, NWO-I CWI and Swat.engineering
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.rascalmpl.vscode.lsp.log;
+
+import java.net.URI;
+
+import org.apache.logging.log4j.Level;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.core.appender.ConsoleAppender;
+import org.apache.logging.log4j.core.config.Configuration;
+import org.apache.logging.log4j.core.config.ConfigurationFactory;
+import org.apache.logging.log4j.core.config.ConfigurationSource;
+import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder;
+import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory;
+import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration;
+
+public class LogJsonConfiguration extends ConfigurationFactory {
+
+    @Override
+    protected String[] getSupportedTypes() {
+        return new String[] {"*"};
+    }
+
+
+
+    @Override
+    public Configuration getConfiguration(LoggerContext loggerContext, String name, URI configLocation) {
+        return buildConfiguration();
+    }
+
+    @Override
+    public Configuration getConfiguration(LoggerContext loggerContext, String name, URI configLocation,
+            ClassLoader loader) {
+        return buildConfiguration();
+    }
+
+    @Override
+    public Configuration getConfiguration(LoggerContext loggerContext, ConfigurationSource source) {
+        return buildConfiguration();
+    }
+
+    private Configuration buildConfiguration() {
+        Level targetLevel = Level.getLevel(System.getProperty("log4j2.level", "INFO"));
+        if (targetLevel == null) {
+            targetLevel = Level.INFO;
+        }
+
+        ConfigurationBuilder<BuiltConfiguration> builder = ConfigurationBuilderFactory.newConfigurationBuilder();
+        builder.setConfigurationName("JsonLogger");
+        builder.setStatusLevel(targetLevel);
+
+        builder.add(builder
+            .newAppender("Console", ConsoleAppender.PLUGIN_NAME)
+            .addAttribute("target", ConsoleAppender.Target.SYSTEM_ERR)
+            .add(builder.newLayout("JsonTemplateLayout")
+                /* The JSON template has a max length (buffer size) of 8192 by default:
+                   https://logging.apache.org/log4j/2.x/manual/systemproperties.html#log4j2.encoderByteBufferSize
+                   If JSON documents are longer, the buffer will be flushed in between,
+                   and the JSON arrives truncated on the client side. To prevent his, we cap the max message length. */
+                .addAttribute("maxStringLength", 6000)
+                .addAttribute("eventTemplateUri", "classpath:JsonLogTemplate.json")
+            )
+        );
+
+        builder.add(builder
+            .newRootLogger(targetLevel)
+            .add(builder.newAppenderRef("Console"))
+        );
+
+        return builder.build();
+    }
+
+}
diff --git a/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/log/LogRedirectConfiguration.java b/rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/log/LogRedirectConfiguration.java
@@ -24,7 +24,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-package org.rascalmpl.vscode.lsp;
+package org.rascalmpl.vscode.lsp.log;
 
 import java.net.URI;
 
diff --git a/rascal-lsp/src/main/resources/JsonLogTemplate.json b/rascal-lsp/src/main/resources/JsonLogTemplate.json
@@ -0,0 +1,20 @@
+{
+    "timestamp": {
+        "$resolver": "timestamp"
+    },
+    "level": {
+        "$resolver": "level",
+        "field": "name"
+    },
+    "loggerName": {
+        "$resolver": "logger",
+        "field": "name"
+    },
+    "threadName": {
+        "$resolver": "thread",
+        "field": "name"
+    },
+    "message": {
+        "$resolver": "message"
+    }
+}
diff --git a/rascal-vscode-extension/.eslintrc.json b/rascal-vscode-extension/.eslintrc.json
@@ -28,6 +28,7 @@
         "eqeqeq": "warn",
         "no-throw-literal": "warn",
         "semi": "off",
-        "no-unused-vars": "off"
+        "no-unused-vars": "off",
+        "no-console": "error"
     }
 }
diff --git a/rascal-vscode-extension/src/RascalExtension.ts b/rascal-vscode-extension/src/RascalExtension.ts
@@ -43,9 +43,10 @@ export class RascalExtension implements vscode.Disposable {
     private readonly dsls:ParameterizedLanguageServer;
     private readonly rascal: RascalLanguageServer;
 
+    private readonly log: vscode.LogOutputChannel = vscode.window.createOutputChannel("Rascal Extension", {log: true});
 
     constructor(private readonly context: vscode.ExtensionContext, private readonly jarRootPath: string, private readonly icon: vscode.Uri, private readonly isDeploy = true) {
-        this.vfsServer = new VSCodeUriResolverServer(!isDeploy);
+        this.vfsServer = new VSCodeUriResolverServer(!isDeploy, this.log);
 
         this.dsls = new ParameterizedLanguageServer(context, this.vfsServer, jarRootPath, isDeploy);
         this.rascal = new RascalLanguageServer(context, this.vfsServer, jarRootPath, this.dsls, isDeploy);
@@ -56,15 +57,20 @@ export class RascalExtension implements vscode.Disposable {
         this.registerCopySourceLocationCommand();
         checkForJVMUpdate();
 
-        vscode.window.registerTreeDataProvider('rascalmpl-configuration-view', new RascalLibraryProvider(this.rascal.rascalClient));
+        vscode.window.registerTreeDataProvider('rascalmpl-configuration-view', new RascalLibraryProvider(this.rascal.rascalClient, this.log));
         vscode.window.registerTreeDataProvider('rascalmpl-debugger-view', new RascalDebugViewProvider(this.rascal.rascalDebugClient, context));
         vscode.window.registerTerminalLinkProvider(new RascalTerminalLinkProvider(this.rascal.rascalClient));
     }
 
+    logger(): vscode.LogOutputChannel {
+        return this.log;
+    }
+
     dispose() {
         this.vfsServer.dispose();
         this.dsls.dispose();
         this.rascal.dispose();
+        this.log.dispose();
     }
 
     externalLanguageRegistry() {
@@ -124,7 +130,7 @@ export class RascalExtension implements vscode.Disposable {
             }, async (progress) => {
                 progress.report({message: "Starting rascal-lsp"});
                 const rascal = await this.rascal.rascalClient;
-                console.log(`Starting Rascal REPL: on ${uri} and with command: ${command}`);
+                this.log.debug(`Starting Rascal REPL: on ${uri} and with command: ${command}`);
                 if (uri && !uri.path.endsWith(".rsc")) {
                     // do not try to figure out a rascal project path when the focus is not a rascal file
                     uri = undefined;
@@ -145,7 +151,7 @@ export class RascalExtension implements vscode.Disposable {
                 progress.report({increment: 25, message: "Creating terminal"});
                 const terminal = vscode.window.createTerminal({
                     iconPath: this.icon,
-                    shellPath: await getJavaExecutable(),
+                    shellPath: await getJavaExecutable(this.log),
                     shellArgs: this.buildShellArgs(compilationPath, serverConfig),
                     isTransient: false, // right now we don't support transient terminals yet
                     name: `Rascal terminal (${this.getTerminalOrigin(uri, command??"")})`,
@@ -192,7 +198,7 @@ export class RascalExtension implements vscode.Disposable {
                     return "no module";
                 }
                 default:
-                    console.log(`Unknown origin format: ${originFormat}`);
+                    this.log.warn(`Unknown origin format: ${originFormat}`);
             }
         }
         return 'no project or module';
diff --git a/rascal-vscode-extension/src/auto-jvm/JavaLookup.ts b/rascal-vscode-extension/src/auto-jvm/JavaLookup.ts
@@ -46,7 +46,7 @@ let lookupCompleted: Thenable<string> | undefined;
 
 const pexec = promisify(cp.exec);
 
-export async function getJavaExecutable(): Promise<string> {
+export async function getJavaExecutable(logger: vscode.LogOutputChannel): Promise<string> {
     if (lookupCompleted) {
         return lookupCompleted;
     }
@@ -72,7 +72,7 @@ export async function getJavaExecutable(): Promise<string> {
         // ignore success, this callback is only for failures
 
     }, e => {
-        console.log("Automatic download failed: ", e);
+        logger.error("Automatic download failed: ", e);
         lookupCompleted = undefined;
     });
     return lookupCompleted;
diff --git a/rascal-vscode-extension/src/extension.ts b/rascal-vscode-extension/src/extension.ts
@@ -41,7 +41,7 @@ export function activate(context: vscode.ExtensionContext) {
     const extension = new RascalExtension(context, jars, icon, (deployMode || testDeployMode));
     context.subscriptions.push(extension);
     context.subscriptions.push(new RascalMFValidator());
-    context.subscriptions.push(new RascalProjectValidator());
+    context.subscriptions.push(new RascalProjectValidator(extension.logger()));
     return extension.externalLanguageRegistry();
 }
 
diff --git a/rascal-vscode-extension/src/fs/RascalFileSystemProviders.ts b/rascal-vscode-extension/src/fs/RascalFileSystemProviders.ts
@@ -39,7 +39,7 @@ export class RascalFileSystemProvider implements vscode.FileSystemProvider {
      *
      * @param client to use as a server for the file system provider methods
      */
-    constructor (client:BaseLanguageClient) {
+    constructor (client:BaseLanguageClient, private readonly logger: vscode.LogOutputChannel) {
         this.client = client;
 
         client.onNotification("rascal/filesystem/onDidChangeFile", (event:vscode.FileChangeEvent) => {
@@ -53,7 +53,7 @@ export class RascalFileSystemProvider implements vscode.FileSystemProvider {
         return this.client.sendRequest<R>(method, param ?? { uri: uri.toString()} )
             .catch((r: ResponseError) => {
                 if (r !== undefined) {
-                    this.client.debug("Got response error from the file system: ", r);
+                    this.logger.debug("Got response error from the file system: ", r);
                     switch (r.code) {
                         case -1: throw vscode.FileSystemError.FileExists(uri);
                         case -2: throw vscode.FileSystemError.FileIsADirectory(uri);
@@ -83,13 +83,13 @@ export class RascalFileSystemProvider implements vscode.FileSystemProvider {
             .forEach(s => {
                 try {
                     vscode.workspace.registerFileSystemProvider(s, this);
-                    this.client.debug(`Rascal VFS registered scheme: ${s}`);
+                    this.logger.debug(`Rascal VFS registered scheme: ${s}`);
                 } catch (error) {
                     if (isUnknownFileSystem(s)) {
-                        this.client.error(`Unable to register scheme: ${s}\n${error}`);
+                        this.logger.error(`Unable to register scheme: ${s}\n${error}`);
                     }
                     else {
-                        this.client.debug(`Rascal VFS lost the race to register scheme: ${s}, which in most cases is fine`);
+                        this.logger.debug(`Rascal VFS lost the race to register scheme: ${s}, which in most cases is fine`);
                     }
                 }
             });
diff --git a/rascal-vscode-extension/src/fs/VSCodeURIResolver.ts b/rascal-vscode-extension/src/fs/VSCodeURIResolver.ts
@@ -217,16 +217,16 @@ export class VSCodeUriResolverServer implements Disposable {
     private readonly server: Server;
     private activeClients: ResolverClient[] = [];
     private rascalNativeSchemes: Set<string> = new Set();
-    constructor(debug: boolean) {
+    constructor(debug: boolean, private readonly logger: vscode.LogOutputChannel) {
         this.server = createServer(newClient => {
             if (debug) {
-                console.log("VFS: new connection: " + JSON.stringify(newClient));
+                this.logger.info("VFS: new connection: " + JSON.stringify(newClient));
             }
             newClient.setNoDelay(true);
             this.handleNewClient(newClient, debug);
         });
-        this.server.on('error', console.log);
-        this.server.listen(0, "localhost", () => console.log("VFS: started listening on " + JSON.stringify(this.server.address())));
+        this.server.on('error', this.logger.error);
+        this.server.listen(0, "localhost", () => this.logger.info("VFS: started listening on " + JSON.stringify(this.server.address())));
     }
 
     ignoreSchemes(toIgnore: string[]) {
@@ -239,23 +239,17 @@ export class VSCodeUriResolverServer implements Disposable {
     }
 
     private handleNewClient(newClient: Socket, debug: boolean) {
-        function makeLogger(prefix: string, onlyDebug: boolean): (m:string) => void {
-            if (onlyDebug && !debug) {
-                return (_s) => { return ; };
-            }
-            return (m) => console.log(prefix + ": " + m);
-        }
         const connection = rpc.createMessageConnection(newClient, newClient, {
-            log: makeLogger("VFS: [TRACE]", true),
-            error: makeLogger("VFS: [ERROR]", false),
-            warn: makeLogger("VFS: [WARN]", true),
-            info: makeLogger("VFS: [INFO]", true),
+            log: (msg) => this.logger.trace(`VFS: ${msg}`),
+            error: (msg) => this.logger.error(`VFS: ${msg}`),
+            warn: (msg) => this.logger.warn(`VFS: ${msg}`),
+            info: (msg) => this.logger.info(`VFS: ${msg}`),
         });
         newClient.on("error", e => {
-            console.log("VFS: [SOCKET-ERROR]: " + e);
+            this.logger.error(`VFS (socket): ${e}`);
         });
 
-        const client = new ResolverClient(connection, debug, this.rascalNativeSchemes);
+        const client = new ResolverClient(connection, debug, this.rascalNativeSchemes, this.logger);
         this.activeClients.push(client);
 
         newClient.on('end', () => {
@@ -327,14 +321,14 @@ class ResolverClient implements VSCodeResolverServer, Disposable  {
     private readonly fs: vscode.FileSystem;
     private readonly rascalNativeSchemes: Set<string>;
     private toClear: Disposable[] = [];
-    constructor(connection: rpc.MessageConnection, debug: boolean, rascalNativeSchemes: Set<string>){
+    constructor(connection: rpc.MessageConnection, debug: boolean, rascalNativeSchemes: Set<string>, private readonly logger: vscode.LogOutputChannel){
         this.rascalNativeSchemes = rascalNativeSchemes;
         this.fs = vscode.workspace.fs;
         this.connection = connection;
         if (debug) {
             connection.trace(rpc.Trace.Verbose, {
                 log: (a) => {
-                    console.log("[VFS]: " + a);
+                    this.logger.debug("[VFS]: " + a);
                 }
             });
         }
diff --git a/rascal-vscode-extension/src/lsp/JsonOutputChannel.ts b/rascal-vscode-extension/src/lsp/JsonOutputChannel.ts
diff --git a/rascal-vscode-extension/src/lsp/RascalLSPConnection.ts b/rascal-vscode-extension/src/lsp/RascalLSPConnection.ts
diff --git a/rascal-vscode-extension/src/test/.eslintrc.json b/rascal-vscode-extension/src/test/.eslintrc.json
diff --git a/rascal-vscode-extension/src/ux/LibraryNavigator.ts b/rascal-vscode-extension/src/ux/LibraryNavigator.ts
diff --git a/rascal-vscode-extension/src/ux/RascalProjectValidator.ts b/rascal-vscode-extension/src/ux/RascalProjectValidator.ts

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`"eqeqeq": "warn",`
`29`	`29`	`"no-throw-literal": "warn",`
`30`	`30`	`"semi": "off",`
`31`		`- "no-unused-vars": "off"`
	`31`	`+ "no-unused-vars": "off",`
	`32`	`+ "no-console": "error"`
`32`	`33`	`}`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export function activate(context: vscode.ExtensionContext) {`
`41`	`41`	`const extension = new RascalExtension(context, jars, icon, (deployMode \|\| testDeployMode));`
`42`	`42`	`context.subscriptions.push(extension);`
`43`	`43`	`context.subscriptions.push(new RascalMFValidator());`
`44`		`- context.subscriptions.push(new RascalProjectValidator());`
	`44`	`+ context.subscriptions.push(new RascalProjectValidator(extension.logger()));`
`45`	`45`	`return extension.externalLanguageRegistry();`
`46`	`46`	`}`
`47`	`47`