Correctly generate logfile on windows (#256)

Author: kartikgupta-db

packages/databricks-vscode/src/logger/LoggerManager.test.ts

@@ -0,0 +1,49 @@
+import "@databricks/databricks-sdk/dist";
+import {Time, TimeUnits} from "@databricks/databricks-sdk/dist";
+import {NamedLogger} from "@databricks/databricks-sdk/dist/logging";
+import assert from "assert";
+import {mkdtemp, readFile} from "fs/promises";
+import {remove} from "fs-extra";
+import {tmpdir} from "os";
+import path from "path";
+import {instance, mock, when} from "ts-mockito";
+import {ExtensionContext, Uri} from "vscode";
+import {LoggerManager, Loggers} from "./LoggerManager";
+
+describe(__filename, function () {
+    let tempDir: string;
+
+    this.timeout(new Time(5, TimeUnits.seconds).toMillSeconds().value);
+
+    beforeEach(async () => {
+        tempDir = await mkdtemp(path.join(tmpdir(), "testdir-"));
+    });
+
+    it("should create log file and log data", async () => {
+        const mockContext = mock<ExtensionContext>();
+        when(mockContext.logUri).thenReturn(Uri.file(tempDir));
+
+        const manager = new LoggerManager(instance(mockContext));
+        await manager.initLoggers();
+        NamedLogger.getOrCreate(Loggers.Extension).debug("test message");
+
+        await new Promise((resolve) =>
+            setTimeout(
+                resolve,
+                new Time(0.5, TimeUnits.seconds).toMillSeconds().value
+            )
+        );
+
+        const rawLogs = await readFile(path.join(tempDir, "logs.json"), {
+            encoding: "utf-8",
+        });
+
+        const logs = rawLogs.split("\n");
+        assert.ok(logs.length !== 0);
+        assert.ok(logs[0].includes("test message"));
+    });
+
+    afterEach(async () => {
+        await new Promise((resolve) => remove(tempDir, resolve));
+    });
+});

packages/databricks-vscode/src/logger/LoggerManager.ts

@@ -5,7 +5,8 @@ import {
 import {env, ExtensionContext, window} from "vscode";
 import {loggers, format, transports} from "winston";
 import {getOutputConsoleTransport} from "./outputConsoleTransport";
-import {unlink, access} from "fs/promises";
+import {unlink, access, mkdir} from "fs/promises";
+import path from "path";
 
 export class LoggerManager {
     constructor(readonly context: ExtensionContext) {}
@@ -26,7 +27,8 @@ export class LoggerManager {
 
     async initLoggers() {
         const outputChannel = window.createOutputChannel("Databricks Logs");
-        const logFile = `${this.context.logUri.path}/logs.json`;
+        await mkdir(this.context.logUri.fsPath, {recursive: true});
+        const logFile = path.join(this.context.logUri.fsPath, "logs.json");
         try {
             await access(logFile);
             await unlink(logFile);
@@ -39,12 +41,11 @@ export class LoggerManager {
             {
                 factory: (name) => {
                     return loggers.add(name, {
-                        level: "debug",
                         transports: [
                             getOutputConsoleTransport(outputChannel, {
                                 level: "debug",
                             }),
-                            this.getFileTransport(logFile, {level: "all"}),
+                            this.getFileTransport(logFile, {level: "debug"}),
                         ],
                     });
                 },
@@ -60,12 +61,11 @@ export class LoggerManager {
             {
                 factory: (name) => {
                     return loggers.add(name, {
-                        level: "error",
                         transports: [
                             getOutputConsoleTransport(outputChannel, {
                                 level: "error",
                             }),
-                            this.getFileTransport(logFile, {level: "all"}),
+                            this.getFileTransport(logFile, {level: "debug"}),
                         ],
                     });
                 },