Improved LOGGER design

Achal1607 · Achal1607 · commit 2043e39146b8 · 2024-10-25T16:14:10.000+05:30
diff --git a/vscode/src/commands/buildOperations.ts b/vscode/src/commands/buildOperations.ts
@@ -13,7 +13,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */
-import { LOGGER } from "../extension";
+
+import { LOGGER } from "../logger";
 import { l10n } from "../localiser";
 import { extCommands, nbCommands } from "./commands";
 import { ICommand } from "./types";
diff --git a/vscode/src/commands/navigation.ts b/vscode/src/commands/navigation.ts
@@ -19,7 +19,8 @@ import { l10n } from "../localiser";
 import * as path from 'path';
 import { ICommand } from "./types";
 import { LanguageClient } from "vscode-languageclient/node";
-import { globalVars, LOGGER } from "../extension";
+import { globalVars } from "../extension";
+import { LOGGER } from '../logger';
 import { getContextUri, isNbCommandRegistered, wrapCommandWithProgress } from "./utils";
 
 const goToTest = async (ctx: any) => {
diff --git a/vscode/src/commands/utils.ts b/vscode/src/commands/utils.ts
@@ -17,9 +17,9 @@ import { commands, OutputChannel, ProgressLocation, Uri, window } from "vscode";
 import { nbCommands } from "./commands";
 import { ProjectActionParams } from "../lsp/protocol";
 import { LanguageClient } from "vscode-languageclient/node";
-import { globalVars, LOGGER } from "../extension";
+import { globalVars } from "../extension";
 import { l10n } from "../localiser";
-import { LogLevel } from "../logger";
+import { LOGGER } from "../logger";
 
 export const getContextUri = (ctx: any): Uri | undefined => {
     if (ctx?.fsPath) {
@@ -98,14 +98,14 @@ export const wrapCommandWithProgress = (lsCommand: string, title: string, log?:
                             resolve(res);
                         } else {
                             if (log) {
-                                LOGGER.log(`Command ${lsCommand} takes too long to start`, LogLevel.ERROR);
+                                LOGGER.error(`Command ${lsCommand} takes too long to start`);
                             }
                             reject(res);
                         }
                     }, humanVisibleDelay);
                 } catch (err: any) {
                     if (log) {
-                        LOGGER.log(`command ${lsCommand} executed with error: ${JSON.stringify(err)}`, LogLevel.ERROR);
+                        LOGGER.error(`command ${lsCommand} executed with error: ${JSON.stringify(err)}`);
                     }
                 }
             } else {
diff --git a/vscode/src/configurations/handlers.ts b/vscode/src/configurations/handlers.ts
@@ -17,8 +17,8 @@ import { extensions, workspace } from "vscode";
 import { builtInConfigKeys, configKeys } from "./configuration";
 import { extConstants, NODE_WINDOWS_LABEL } from "../constants";
 import * as os from 'os';
-import { globalVars, LOGGER } from "../extension";
-import { LogLevel } from "../logger";
+import { globalVars } from "../extension";
+import { LOGGER } from "../logger";
 import * as path from 'path';
 import * as fs from 'fs';
 
@@ -53,7 +53,7 @@ export const projectSearchRootsValueHandler = (): string => {
         try {
             projectSearchRoots = os.homedir() as string;
         } catch (err: any) {
-            LOGGER.log(`Failed to obtain the user home directory due to: ${err}`, LogLevel.ERROR);
+            LOGGER.error(`Failed to obtain the user home directory due to: ${err}`);
         }
         if (!projectSearchRoots) {
             projectSearchRoots = os.type() === NODE_WINDOWS_LABEL ? '%USERPROFILE%' : '$HOME';   // The launcher script may perform the env variable substitution
@@ -83,7 +83,7 @@ export const lspServerVmOptionsHandler = (): string[] => {
 }
 
 export const isDarkColorThemeHandler = (): boolean => {
-    const themeName: string = getBuiltinConfigurationValue(builtInConfigKeys.vscodeTheme);    
+    const themeName: string = getBuiltinConfigurationValue(builtInConfigKeys.vscodeTheme);
     if (!themeName) {
         return false;
     }
diff --git a/vscode/src/extension.ts b/vscode/src/extension.ts
@@ -33,7 +33,6 @@ import * as launchConfigurations from './launchConfigurations';
 import { extConstants } from './constants';
 import { ExtensionInfo } from './extensionInfo';
 import { ClientPromise } from './lsp/clientPromise';
-import { ExtensionLogger } from './logger';
 import { NbProcessManager } from './lsp/nbProcessManager';
 import { clientInit } from './lsp/initializer';
 import { subscribeCommands } from './commands/register';
@@ -43,7 +42,6 @@ import { registerConfigChangeListeners } from './configurations/listener';
 import { registerFileProviders } from './lsp/listeners/textDocumentContentProvider';
 import { createViews } from './views/initializer';
 
-export let LOGGER: ExtensionLogger;
 export namespace globalVars {
     export const listeners = new Map<string, string[]>();
     export let extensionInfo: ExtensionInfo;
@@ -61,7 +59,6 @@ export namespace globalVars {
 export function activate(context: ExtensionContext): VSNetBeansAPI {
     globalVars.clientPromise = new ClientPromise();
     globalVars.extensionInfo = new ExtensionInfo(context);
-    LOGGER = new ExtensionLogger(extConstants.SERVER_NAME);
 
     globalVars.clientPromise.initialize();
     registerConfigChangeListeners(context);
diff --git a/vscode/src/logger.ts b/vscode/src/logger.ts
@@ -14,8 +14,9 @@
   limitations under the License.
 */
 import { OutputChannel, window } from "vscode";
+import { extConstants } from "./constants";
 
-export enum LogLevel {
+enum LogLevel {
     INFO = 'INFO',
     WARN = 'WARN',
     ERROR = 'ERROR',
@@ -28,16 +29,16 @@ export class ExtensionLogger {
         this.outChannel = window.createOutputChannel(channelName);
     }
 
-    public log(message: string, level: LogLevel = LogLevel.INFO): void {
-        this.outChannel.appendLine(`[${level}]: ${message}`);
+    public log(message: string): void {
+        this.outChannel.appendLine(`[${LogLevel.INFO}]: ${message}`);
     }
 
     public warn(message: string): void {
-        this.log(message, LogLevel.WARN);
+        this.outChannel.appendLine(`[${LogLevel.WARN}]: ${message}`);
     }
 
     public error(message: string): void {
-        this.log(message, LogLevel.ERROR);
+        this.outChannel.appendLine(`[${LogLevel.ERROR}]: ${message}`);
     }
 
     public logNoNL(message: string): void {
@@ -55,4 +56,6 @@ export class ExtensionLogger {
     public dispose(): void {
         this.outChannel.dispose();
     }
-}
+}
+
+export const LOGGER = new ExtensionLogger(extConstants.SERVER_NAME);
diff --git a/vscode/src/lsp/clientPromise.ts b/vscode/src/lsp/clientPromise.ts
@@ -14,8 +14,8 @@
   limitations under the License.
 */
 import { commands } from "vscode";
-import { globalVars, LOGGER } from "../extension";
-import { LogLevel } from "../logger";
+import { globalVars } from "../extension";
+import { LOGGER } from "../logger";
 import { NbProcessManager } from "./nbProcessManager";
 import { clientInit } from "./initializer";
 import { NbLanguageClient } from "./nbLanguageClient";
@@ -60,11 +60,11 @@ export class ClientPromise {
 
     public restartExtension = async (nbProcessManager: NbProcessManager | null, notifyKill: boolean) => {
         if (this.activationPending) {
-            LOGGER.log("Server activation requested repeatedly, ignoring...", LogLevel.WARN);
+            LOGGER.warn("Server activation requested repeatedly, ignoring...");
             return;
         }
         if (!nbProcessManager) {
-            LOGGER.log("Nbcode Process is null", LogLevel.ERROR);
+            LOGGER.error("Nbcode Process is null");
             return;
         }
         try {
@@ -73,7 +73,7 @@ export class ClientPromise {
             this.initialize();
             clientInit();
         } catch (error) {
-            LOGGER.log(`Error during activation: ${error}`, LogLevel.ERROR);
+            LOGGER.error(`Error during activation: ${error}`);
             throw error;
         } finally {
             this.activationPending = false;
diff --git a/vscode/src/lsp/initializer.ts b/vscode/src/lsp/initializer.ts
@@ -15,7 +15,8 @@
 */
 import { StreamInfo } from "vscode-languageclient/node";
 import { getUserConfigLaunchOptionsDefaults } from "./launchOptions";
-import { globalVars, LOGGER } from "../extension";
+import { globalVars } from "../extension";
+import { LOGGER } from '../logger';
 import { configKeys } from "../configurations/configuration";
 import { enableDisableModules } from "./utils";
 import * as net from 'net';
diff --git a/vscode/src/lsp/listeners/notifications/handlers.ts b/vscode/src/lsp/listeners/notifications/handlers.ts
@@ -21,7 +21,8 @@ import { isNbJavacDisabledHandler, updateConfigurationValue } from "../../../con
 import { l10n } from "../../../localiser";
 import { configKeys } from "../../../configurations/configuration";
 import { builtInCommands } from "../../../commands/commands";
-import { globalVars, LOGGER } from "../../../extension";
+import { globalVars } from "../../../extension";
+import { LOGGER } from '../../../logger';
 
 const checkInstallNbJavac = (msg: string) => {
     const NO_JAVA_SUPPORT = "Cannot initialize Java support";
diff --git a/vscode/src/lsp/listeners/requests/handlers.ts b/vscode/src/lsp/listeners/requests/handlers.ts
@@ -14,14 +14,14 @@
   limitations under the License.
 */
 import { QuickPickItem, Uri, window, workspace, WorkspaceConfiguration } from "vscode";
-import { globalVars, LOGGER } from "../../../extension";
+import { globalVars } from "../../../extension";
 import { notificationOrRequestListenerType } from "../../types";
 import { ExecInHtmlPageRequest, HtmlPageRequest, InputBoxRequest, InputBoxStep, MutliStepInputRequest, QuickPickRequest, QuickPickStep, SaveDocumentRequestParams, SaveDocumentsRequest, TextEditorDecorationCreateRequest, UpdateConfigurationRequest } from "../../protocol";
 import { InputStep, MultiStepInput } from "../../../utils";
 import { runConfigurationUpdateAll } from "../../../views/runConfiguration";
 import { isError } from "../../../utils";
 import { isString } from "../../../utils";
-import { LogLevel } from "../../../logger";
+import { LOGGER } from "../../../logger";
 import { execInHtmlPage, showHtmlPage } from "../../../webviews/nbWebviewHandler";
 
 const textEditorDecorationCreateRequestHandler = (param: any) => {
@@ -104,7 +104,7 @@ const updateConfigRequestHandler = async (param: any) => {
                     runConfigurationUpdateAll();
                 });
         } catch (err) {
-            LOGGER.log("Failed to update configuration. Reason: " + (isString(err) ? err : isError(err) ? err.message : "error"), LogLevel.ERROR);
+            LOGGER.error("Failed to update configuration. Reason: " + (isString(err) ? err : isError(err) ? err.message : "error"));
         }
     }
 }
diff --git a/vscode/src/lsp/nbLanguageClient.ts b/vscode/src/lsp/nbLanguageClient.ts
@@ -20,7 +20,7 @@ import { OutputChannel, workspace } from "vscode";
 import { extConstants } from "../constants";
 import { userConfigsListenedByServer } from '../configurations/configuration';
 import { restartWithJDKLater } from './utils';
-import { ExtensionLogger, LogLevel } from '../logger';
+import { ExtensionLogger } from '../logger';
 import { globalVars } from '../extension';
 
 
@@ -71,7 +71,7 @@ export class NbLanguageClient extends LanguageClient {
                     return { action: ErrorAction.Continue, message: error.message };
                 },
                 closed: function (): CloseHandlerResult {
-                    logger.log(`Connection to ${extConstants.SERVER_NAME} closed.`, LogLevel.WARN);
+                    logger.warn(`Connection to ${extConstants.SERVER_NAME} closed.`);
                     if (!globalVars.clientPromise.activationPending) {
                         restartWithJDKLater(10000, false);
                     }
diff --git a/vscode/src/lsp/nbProcessManager.ts b/vscode/src/lsp/nbProcessManager.ts
@@ -13,13 +13,12 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */
-import { LOGGER } from "../extension";
 import { spawn, ChildProcessByStdio, ChildProcess } from 'child_process';
 import { Readable } from "stream";
 import { window } from "vscode";
 import { l10n } from "../localiser";
 import { extConstants } from "../constants";
-import { LogLevel } from "../logger";
+import { LOGGER } from "../logger";
 
 export class NbProcessManager {
     private process?: ChildProcess | null;
@@ -49,7 +48,7 @@ export class NbProcessManager {
         LOGGER.log("Request to kill LSP server.");
 
         if (!this.process) {
-            LOGGER.log("Cannot kill: No current process", LogLevel.ERROR);
+            LOGGER.error("Cannot kill: No current process");
             return Promise.resolve();
         }
         const processToKill = this.process;
@@ -99,7 +98,7 @@ export class NbProcessManager {
     getStdOut = () => {
         return this.stdOutText
     }
-    
+
     setStdOut = (stdOut: string | null) => {
         this.stdOutText = stdOut;
     }
diff --git a/vscode/src/lsp/nbcode.ts b/vscode/src/lsp/nbcode.ts
@@ -17,13 +17,13 @@
 import { window } from "vscode";
 import { configKeys } from "../configurations/configuration";
 import { extConstants, NODE_WINDOWS_LABEL } from "../constants";
-import { globalVars, LOGGER } from "../extension";
+import { globalVars } from "../extension";
 import { prepareNbcodeLaunchOptions, getUserConfigLaunchOptionsDefaults } from "./launchOptions";
 import { NbProcessManager } from "./nbProcessManager";
 import { findNbcode } from "./utils";
 import { l10n } from "../localiser";
 import { jdkDownloaderPrompt } from "../webviews/jdkDownloader/prompt";
-import { LogLevel } from "../logger";
+import { LOGGER } from "../logger";
 import * as os from 'os';
 
 export const launchNbcode = (): void => {
@@ -95,7 +95,7 @@ const processOnCloseHandler = (nbProcessManager: NbProcessManager, code: number)
         if (match?.length == 1) {
             LOGGER.log(match[0]);
         } else {
-            LOGGER.log("Cannot find org.netbeans.modules.java.lsp.server in the log!", LogLevel.ERROR);
+            LOGGER.error("Cannot find org.netbeans.modules.java.lsp.server in the log!");
         }
         LOGGER.log(`Please refer to troubleshooting section for more info: https://github.com/oracle/javavscode/blob/main/README.md#troubleshooting`);
         LOGGER.showOutputChannelUI(false);
diff --git a/vscode/src/lsp/utils.ts b/vscode/src/lsp/utils.ts
@@ -16,7 +16,8 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as os from 'os';
-import { globalVars, LOGGER } from '../extension';
+import { globalVars } from '../extension';
+import { LOGGER } from '../logger';
 import { extConstants } from '../constants';
 
 export const enableDisableModules = (
diff --git a/vscode/src/webviews/jdkDownloader/action.ts b/vscode/src/webviews/jdkDownloader/action.ts
@@ -23,8 +23,7 @@ import { calculateChecksum, downloadFileWithProgressBar, httpsGet } from "../../
 import * as cp from 'child_process';
 import { promisify } from "util";
 import { l10n } from "../../localiser";
-import { LOGGER } from "../../extension";
-import { LogLevel } from "../../logger";
+import { LOGGER } from "../../logger";
 
 export class JdkDownloaderAction {
     public static readonly MANUAL_INSTALLATION_TYPE = "manual";
@@ -101,7 +100,7 @@ export class JdkDownloaderAction {
             await this.jdkInstallationManager();
         } catch (err: any) {
             window.showErrorMessage(l10n.value("jdk.downloader.error_message.installingJDK", { error: err }));
-            LOGGER.log(err?.message || "No Error message received", LogLevel.ERROR);
+            LOGGER.error(err?.message || "No Error message received");
         }
     }
 
@@ -220,7 +219,7 @@ export class JdkDownloaderAction {
             await exec(extractCommand);
             LOGGER.log(`Extracting JDK successful`);
         } catch (err) {
-            LOGGER.log(`Error while extracting JDK: ${(err as Error).message}`, LogLevel.ERROR);
+            LOGGER.error(`Error while extracting JDK: ${(err as Error).message}`);
             throw new Error(l10n.value("jdk.downloader.error_message.extractionError", {
                 jdkType: this.jdkType,
                 jdkVersion: this.jdkVersion
@@ -271,7 +270,7 @@ export class JdkDownloaderAction {
     private installationCleanup = (tempDirPath: string, newDirPath: string) => {
         fs.unlink(this.downloadFilePath!, async (err) => {
             if (err) {
-                LOGGER.log(`Error while installation cleanup: ${err.message}`, LogLevel.ERROR);
+                LOGGER.error(`Error while installation cleanup: ${err.message}`);
                 window.showErrorMessage(l10n.value("jdk.downloader.error_message.installationCleanup"));
             } else {
                 if (tempDirPath && fs.existsSync(tempDirPath)) {
diff --git a/vscode/src/webviews/jdkDownloader/view.ts b/vscode/src/webviews/jdkDownloader/view.ts
@@ -20,8 +20,7 @@ import * as os from 'os';
 import { JdkDownloaderAction } from './action';
 import { downloaderCss } from './styles';
 import { l10n } from '../../localiser';
-import { LOGGER } from '../../extension';
-import { LogLevel } from '../../logger';
+import { LOGGER } from '../../logger';
 
 export class JdkDownloaderView {
     public static readonly OPEN_JDK_LABEL = "OpenJDK";
@@ -52,8 +51,8 @@ export class JdkDownloaderView {
             });
             LOGGER.log("JDK downloader webview created successfully");
         } catch (err: any) {
-            LOGGER.log("Error creating JDK downloader webview:", LogLevel.ERROR)
-            LOGGER.log(err?.message || "No Error message received", LogLevel.ERROR);
+            LOGGER.error("Error creating JDK downloader webview:");
+            LOGGER.error(err?.message || "No Error message received");
             window.showErrorMessage(l10n.value("jdk.downloader.error_message.errorLoadingPage"));
         }
     }
