chore: support LogOutputChannel in logger

Author: ashenBlade

src/entrypoint.ts

@@ -18,26 +18,32 @@ function createDebugFacade(context: vscode.ExtensionContext) {
     return debug;
 }
 
-function createOutputChannel() {
-    if (utils.Features.logOutputLanguageEnabled()) {
-        return vscode.window.createOutputChannel(config.ExtensionPrettyName, 'log');
+function createLogger(context: vscode.ExtensionContext): utils.ILogger {
+    let outputChannel;
+    let logger;
+    
+    if (utils.Features.hasLogOutputChannel()) {
+        outputChannel = vscode.window.createOutputChannel(config.ExtensionPrettyName, {log: true});
+        logger = new utils.VsCodeLogChannelLogger(outputChannel);
     } else {
-        return vscode.window.createOutputChannel(config.ExtensionPrettyName);
-    }
-}
-
-function createLogger(context: vscode.ExtensionContext): utils.VsCodeLogger {
-    const outputChannel = createOutputChannel();
-    const logger = new utils.VsCodeLogger(outputChannel, getCurrentLogLevel());
-    const logLevel = config.ConfigSections.LogLevel;
-    const fullConfigSectionName = config.getFullConfigSection(logLevel);
-    vscode.workspace.onDidChangeConfiguration(event => {
-        if (!event.affectsConfiguration(fullConfigSectionName)) {
-            return;
+        if (utils.Features.logOutputLanguageEnabled()) {
+            outputChannel = vscode.window.createOutputChannel(config.ExtensionPrettyName, 'log');
+        } else {
+            outputChannel = vscode.window.createOutputChannel(config.ExtensionPrettyName);
         }
-
-        logger.minLogLevel = getCurrentLogLevel();
-    }, undefined, context.subscriptions);
+        
+        const logLevelConfigSection = config.ConfigSections.LogLevel;
+        const fullConfigSectionName = config.getFullConfigSection(logLevelConfigSection);
+        const vsLogger = new utils.VsCodeLogger(outputChannel, getCurrentLogLevel());
+        context.subscriptions.push(vscode.workspace.onDidChangeConfiguration(event => {
+            if (!event.affectsConfiguration(fullConfigSectionName)) {
+                return;
+            }
+    
+            vsLogger.minLogLevel = getCurrentLogLevel();
+        }, undefined, context.subscriptions));
+        logger = vsLogger;
+    }
 
     context.subscriptions.push(outputChannel);
     return logger;

src/formatter.ts

@@ -492,7 +492,7 @@ class PgindentDocumentFormatterProvider implements vscode.DocumentFormattingEdit
     }
 }
 
-function registerDiffCommand(logger: utils.VsCodeLogger, 
+function registerDiffCommand(logger: utils.ILogger, 
                              formatter: PgindentDocumentFormatterProvider) {
     /* Preview formatter changes command */
     vscode.commands.registerCommand(Configuration.Commands.FormatterDiffView, async () => {
@@ -508,16 +508,16 @@ function registerDiffCommand(logger: utils.VsCodeLogger,
         } catch (err) {
             logger.error('failed to format file %s', document.uri.fsPath, err);
             vscode.window.showErrorMessage('Failed to format document. See error in logs');
-            logger.channel.show(true);
+            logger.focus();
             return;
         }
-
+        
         try {
             await vscode.commands.executeCommand('vscode.diff', document.uri, parsed, 'PostgreSQL formatting')
         } catch (err) {
             logger.error(`failed to show diff for document %s`, document.uri.fsPath, err);
             vscode.window.showErrorMessage('Failed to show diff. See error in logs');
-            logger.channel.show(true);
+            logger.focus();
         } finally {
             if (await utils.fileExists(parsed)) {
                 await utils.deleteFile(parsed);
@@ -526,7 +526,7 @@ function registerDiffCommand(logger: utils.VsCodeLogger,
     });
 }
 
-export async function registerFormatting(logger: utils.VsCodeLogger) {
+export async function registerFormatting(logger: utils.ILogger) {
     const formatter = new PgindentDocumentFormatterProvider(logger);
     for (const lang of ['c', 'h']) {
         languages.registerDocumentFormattingEditProvider({

src/utils.ts

@@ -116,6 +116,7 @@ export interface ILogger {
     info: (message: string, ...args: any[]) => void;
     warn: (message: string, ...args: any[]) => void;
     error: (message: string, ...args: any[]) => void;
+    focus: () => void;
 }
 
 export enum LogLevel {
@@ -164,6 +165,40 @@ export class VsCodeLogger implements ILogger {
     error(message: string, ...args: any[]) {
         this.logGeneric(LogLevel.Error, 'ERROR', message, ...args);
     }
+    focus() {
+        this.channel.show(true);
+    }
+}
+
+export class VsCodeLogChannelLogger implements ILogger {
+    constructor(
+        readonly channel: vscode.LogOutputChannel) {
+    }
+
+    debug(message: string, ...args: any[]) {
+        this.channel.debug(message, ...args);
+    }
+
+    info(message: string, ...args: any[]) {
+        this.channel.info(message, ...args);
+    }
+
+    warn(message: string, ...args: any[]) {
+        this.channel.warn(message, ...args);
+    }
+
+    error(message: string, ...args: any[]) {
+        let err = undefined;
+        if (args.length > 0 && args[args.length - 1] instanceof Error) {
+            err = args.pop();
+        }
+
+        this.channel.error(message, args);
+        this.channel.error(err);
+    }
+    focus() {
+        this.channel.show(true);
+    }
 }
 
 export interface IDebuggerFacade {
@@ -588,6 +623,7 @@ let hasArrayLengthFeature: boolean | undefined = undefined;
 let logOutputLanguageEnabled: boolean | undefined = undefined;
 let hasWorkspaceFs: boolean | undefined = undefined;
 let hasUriJoinPath: boolean | undefined = undefined;
+let hasLogOutputChannel: boolean | undefined = undefined;
 
 export class Features {
     static versionAtLeast(ver: string) {
@@ -635,6 +671,14 @@ export class Features {
         }
         return hasUriJoinPath;
     }
+
+    static hasLogOutputChannel() {
+        if (hasLogOutputChannel === undefined) {
+            hasLogOutputChannel = this.versionAtLeast('1.74.0');
+        }
+
+        return hasLogOutputChannel;
+    }
 }
 
 export function joinPath(base: vscode.Uri, ...paths: string[]) {