test: migrate logger tests to vitest (#6220)

* Migrate logger tests to vitest

* Remove lint comment

Author: nazarhussain

packages/logger/.mocharc.yml

@@ -56,9 +56,12 @@
     "lint": "eslint --color --ext .ts src/ test/",
     "lint:fix": "yarn run lint --fix",
     "pretest": "yarn run check-types",
-    "test:unit": "mocha 'test/unit/**/*.test.ts'",
-    "test:browsers": "yarn karma start karma.config.cjs",
-    "test:e2e": "LODESTAR_PRESET=minimal mocha 'test/e2e/**/*.test.ts'",
+    "test:unit": "vitest --run --dir test/unit/ --coverage",
+    "test:browsers": "yarn test:browsers:chrome && yarn test:browsers:firefox && yarn test:browsers:electron",
+    "test:browsers:chrome": "vitest --run --browser chrome --config ./vitest.browser.config.ts --dir test/unit",
+    "test:browsers:firefox": "vitest --run --browser firefox --config ./vitest.browser.config.ts --dir test/unit",
+    "test:browsers:electron": "echo 'Electron tests will be introduced back in the future as soon vitest supports electron.'",
+    "test:e2e": "LODESTAR_PRESET=minimal vitest --run --dir test/e2e",
     "check-readme": "typescript-docs-verifier"
   },
   "types": "lib/index.d.ts",
@@ -69,6 +72,7 @@
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
+    "@chainsafe/threads": "^1.11.1",
     "@lodestar/test-utils": "^1.13.0",
     "@types/triple-beam": "^1.3.2",
     "rimraf": "^4.4.1",

packages/logger/karma.config.cjs

@@ -3,7 +3,7 @@ import worker from "node:worker_threads";
 import {expose} from "@chainsafe/threads/worker";
 
 const parentPort = worker.parentPort;
-const workerData = worker.workerData as {logFilepath: string};
+const workerData = worker.workerData;
 if (!parentPort) throw Error("parentPort must be defined");
 
 const file = fs.createWriteStream(workerData.logFilepath, {flags: "a"});

packages/logger/package.json

@@ -9,7 +9,9 @@ export type LoggerWorker = {
 type WorkerData = {logFilepath: string};
 
 export async function getLoggerWorker(opts: WorkerData): Promise<LoggerWorker> {
-  const workerThreadjs = new Worker("./workerLogger.js", {workerData: opts});
+  const workerThreadjs = new Worker("./workerLogger.js", {
+    workerData: opts,
+  });
   const worker = workerThreadjs as unknown as worker_threads.Worker;
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

…s/logger/test/e2e/logger/workerLogger.ts …s/logger/test/e2e/logger/workerLogger.jspackages/logger/test/e2e/logger/workerLogger.ts renamed to packages/logger/test/e2e/logger/workerLogger.js packages/logger/test/e2e/logger/workerLogger.ts renamed to packages/logger/test/e2e/logger/workerLogger.js

@@ -1,7 +1,7 @@
 import path from "node:path";
 import fs from "node:fs";
 import {fileURLToPath} from "node:url";
-import {expect} from "chai";
+import {describe, it, expect, vi, beforeEach, afterEach} from "vitest";
 import {sleep} from "@lodestar/utils";
 import {LoggerWorker, getLoggerWorker} from "./workerLoggerHandler.js";
 
@@ -11,7 +11,7 @@ import {LoggerWorker, getLoggerWorker} from "./workerLoggerHandler.js";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 describe("worker logs", function () {
-  this.timeout(60_000);
+  vi.setConfig({testTimeout: 60_000});
 
   const logFilepath = path.join(__dirname, "../../../test-logs/test_worker_logs.log");
   let loggerWorker: LoggerWorker;
@@ -36,15 +36,15 @@ describe("worker logs", function () {
     fs.createWriteStream(logFilepath, {flags: "a"}).write(logTextMainThread);
 
     const data = await waitForFileSize(logFilepath, logTextMainThread.length);
-    expect(data).includes(logTextMainThread);
+    expect(data).toContain(logTextMainThread);
   });
 
   it("worker writes to file", async () => {
     const logTextWorker = "test-log-worker";
     loggerWorker.log(logTextWorker);
 
     const data = await waitForFileSize(logFilepath, logTextWorker.length);
-    expect(data).includes(logTextWorker);
+    expect(data).toContain(logTextWorker);
   });
 
   it("concurrent write from two write streams in different threads", async () => {
@@ -57,8 +57,8 @@ describe("worker logs", function () {
     file.write(logTextMainThread + "\n");
 
     const data = await waitForFileSize(logFilepath, logTextWorker.length + logTextMainThread.length);
-    expect(data).includes(logTextWorker);
-    expect(data).includes(logTextMainThread);
+    expect(data).toContain(logTextWorker);
+    expect(data).toContain(logTextMainThread);
   });
 });
 

packages/logger/test/e2e/logger/workerLoggerHandler.ts

@@ -0,0 +1,2 @@
+export async function setup(): Promise<void> {}
+export async function teardown(): Promise<void> {}

packages/logger/test/e2e/logger/workerLogs.test.ts

@@ -1,4 +1,4 @@
-import {expect} from "chai";
+import {describe, it, expect} from "vitest";
 import {LogLevel} from "@lodestar/utils";
 import {stubLoggerForConsole} from "@lodestar/test-utils/mocha";
 import {TimestampFormatCode, logFormats} from "../../src/index.js";
@@ -22,7 +22,7 @@ describe("browser logger", () => {
 
           logger.warn(message, context, error);
           logger.restoreStubs();
-          expect(logger.getLogs()).deep.equals([output[format]]);
+          expect(logger.getLogs()).toEqual([output[format]]);
         });
       }
     }

packages/logger/test/globalSetup.ts

@@ -1,4 +1,4 @@
-import {expect} from "chai";
+import {describe, it, expect} from "vitest";
 import {LogLevel} from "@lodestar/utils";
 import {stubLoggerForConsole} from "@lodestar/test-utils/mocha";
 import {TimestampFormatCode, logFormats} from "../../src/index.js";
@@ -20,7 +20,7 @@ describe("env logger", () => {
 
           logger.warn(message, context, error);
           logger.restoreStubs();
-          expect(logger.getLogs()).deep.equals([output[format]]);
+          expect(logger.getLogs()).toEqual([output[format]]);
         });
       }
     }