test: migrate api unit tests to vitest (#6177)

* Move api unit tests to vitest

* Fix unit tests

* Fix types

packages/api/package.json

@@ -65,7 +65,7 @@
     "lint:fix": "yarn run lint --fix",
     "pretest": "yarn run check-types",
     "test": "yarn test:unit && yarn test:e2e",
-    "test:unit": "nyc --cache-dir .nyc_output/.cache -e .ts mocha 'test/unit/**/*.test.ts'",
+    "test:unit": "vitest --run --dir test/unit/ --coverage",
     "check-readme": "typescript-docs-verifier"
   },
   "dependencies": {

packages/api/test/globalSetup.ts

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

packages/api/test/unit/beacon/genericServerTest/beacon.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {createChainForkConfig, defaultChainConfig} from "@lodestar/config";
 import {Api, ReqTypes} from "../../../../src/beacon/routes/beacon/index.js";
 import {getClient} from "../../../../src/beacon/client/beacon.js";

packages/api/test/unit/beacon/genericServerTest/config.test.ts

@@ -1,4 +1,4 @@
-import {expect} from "chai";
+import {describe, it, expect} from "vitest";
 import {config} from "@lodestar/config/default";
 import {Api, ReqTypes, getReturnTypes} from "../../../../src/beacon/routes/config.js";
 import {getClient} from "../../../../src/beacon/client/config.js";
@@ -27,6 +27,6 @@ describe("beacon / config", () => {
     const jsonRes = returnTypes.getSpec.toJson({data: partialJsonSpec});
     const specRes = returnTypes.getSpec.fromJson(jsonRes);
 
-    expect(specRes).to.deep.equal({data: partialJsonSpec}, "Wrong toJson -> fromJson");
+    expect(specRes).toEqual({data: partialJsonSpec});
   });
 });

packages/api/test/unit/beacon/genericServerTest/debug.test.ts

@@ -1,4 +1,4 @@
-import {expect} from "chai";
+import {describe, it, expect, MockInstance} from "vitest";
 import {toHexString} from "@chainsafe/ssz";
 import {ssz} from "@lodestar/types";
 import {config} from "@lodestar/config/default";
@@ -11,40 +11,42 @@ import {registerRoute} from "../../../../src/utils/server/registerRoute.js";
 import {HttpClient} from "../../../../src/utils/client/httpClient.js";
 import {testData} from "../testData/debug.js";
 
-describe("beacon / debug", function () {
+describe(
+  "beacon / debug",
+  function () {
+    describe("Run generic server test", () => {
+      runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
+    });
+
+    // Get state by SSZ
+
+    describe("getState() in SSZ format", () => {
+      const {baseUrl, server} = getTestServer();
+      const mockApi = getMockApi<Api>(routesData);
+      for (const route of Object.values(getRoutes(config, mockApi))) {
+        registerRoute(server, route);
+      }
+
+      for (const method of ["getState" as const, "getStateV2" as const]) {
+        it(method, async () => {
+          const state = ssz.phase0.BeaconState.defaultValue();
+          const stateSerialized = ssz.phase0.BeaconState.serialize(state);
+          (mockApi[method] as MockInstance).mockResolvedValue(stateSerialized);
+
+          const httpClient = new HttpClient({baseUrl});
+          const client = getClient(config, httpClient);
+
+          const res = await client[method]("head", "ssz");
+
+          expect(res.ok).toBe(true);
+
+          if (res.ok) {
+            expect(toHexString(res.response)).toBe(toHexString(stateSerialized));
+          }
+        });
+      }
+    });
+  },
   // Extend timeout since states are very big
-  this.timeout(30 * 1000);
-
-  describe("Run generic server test", () => {
-    runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
-  });
-
-  // Get state by SSZ
-
-  describe("getState() in SSZ format", () => {
-    const {baseUrl, server} = getTestServer();
-    const mockApi = getMockApi<Api>(routesData);
-    for (const route of Object.values(getRoutes(config, mockApi))) {
-      registerRoute(server, route);
-    }
-
-    for (const method of ["getState" as const, "getStateV2" as const]) {
-      it(method, async () => {
-        const state = ssz.phase0.BeaconState.defaultValue();
-        const stateSerialized = ssz.phase0.BeaconState.serialize(state);
-        mockApi[method].resolves(stateSerialized);
-
-        const httpClient = new HttpClient({baseUrl});
-        const client = getClient(config, httpClient);
-
-        const res = await client[method]("head", "ssz");
-
-        expect(res.ok).to.be.true;
-
-        if (res.ok) {
-          expect(toHexString(res.response)).to.equal(toHexString(stateSerialized), "returned state value is not equal");
-        }
-      });
-    }
-  });
-});
+  {timeout: 30 * 1000}
+);

packages/api/test/unit/beacon/genericServerTest/events.test.ts

@@ -1,4 +1,4 @@
-import {expect} from "chai";
+import {describe, it, expect, beforeEach, afterEach} from "vitest";
 import {sleep} from "@lodestar/utils";
 import {config} from "@lodestar/config/default";
 import {Api, routesData, EventType, BeaconEvent} from "../../../../src/beacon/routes/events.js";
@@ -16,7 +16,9 @@ describe("beacon / events", () => {
   }
 
   let controller: AbortController;
-  beforeEach(() => (controller = new AbortController()));
+  beforeEach(() => {
+    controller = new AbortController();
+  });
   afterEach(() => controller.abort());
 
   it("Receive events", async () => {
@@ -38,9 +40,9 @@ describe("beacon / events", () => {
     const eventsReceived: BeaconEvent[] = [];
 
     await new Promise<void>((resolve, reject) => {
-      mockApi.eventstream.callsFake(async (topics, signal, onEvent) => {
+      mockApi.eventstream.mockImplementation(async (topics, signal, onEvent) => {
         try {
-          expect(topics).to.deep.equal(topicsToRequest, "Wrong received topics");
+          expect(topics).toEqual(topicsToRequest);
           for (const event of eventsToSend) {
             onEvent(event);
             await sleep(5);
@@ -58,6 +60,6 @@ describe("beacon / events", () => {
       });
     });
 
-    expect(eventsReceived).to.deep.equal(eventsToSend, "Wrong received events");
+    expect(eventsReceived).toEqual(eventsToSend);
   });
 });

packages/api/test/unit/beacon/genericServerTest/lightclient.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {config} from "@lodestar/config/default";
 import {Api, ReqTypes} from "../../../../src/beacon/routes/lightclient.js";
 import {getClient} from "../../../../src/beacon/client/lightclient.js";

packages/api/test/unit/beacon/genericServerTest/node.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {config} from "@lodestar/config/default";
 import {Api, ReqTypes} from "../../../../src/beacon/routes/node.js";
 import {getClient} from "../../../../src/beacon/client/node.js";

packages/api/test/unit/beacon/genericServerTest/proofs.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {config} from "@lodestar/config/default";
 import {Api, ReqTypes} from "../../../../src/beacon/routes/proof.js";
 import {getClient} from "../../../../src/beacon/client/proof.js";

packages/api/test/unit/beacon/genericServerTest/validator.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {config} from "@lodestar/config/default";
 import {Api, ReqTypes} from "../../../../src/beacon/routes/validator.js";
 import {getClient} from "../../../../src/beacon/client/validator.js";

packages/api/test/unit/beacon/oapiSpec.test.ts

@@ -1,6 +1,6 @@
 import path from "node:path";
 import {fileURLToPath} from "node:url";
-import {expect} from "chai";
+import {describe, it, beforeAll, expect} from "vitest";
 import {createChainForkConfig, defaultChainConfig} from "@lodestar/config";
 import {OpenApiFile} from "../../utils/parseOpenApiSpec.js";
 import {routes} from "../../../src/beacon/index.js";
@@ -104,7 +104,7 @@ describe("eventstream event data", () => {
   const eventstreamExamples =
     openApiJson.paths["/eth/v1/events"]["get"].responses["200"].content?.["text/event-stream"].examples;
 
-  before("Check eventstreamExamples exists", () => {
+  beforeAll(() => {
     if (!eventstreamExamples) {
       throw Error(`eventstreamExamples not defined: ${eventstreamExamples}`);
     }
@@ -136,7 +136,7 @@ describe("eventstream event data", () => {
         message: testEvent,
       } as routes.events.BeaconEvent);
 
-      expect(testEventJson).deep.equals(exampleDataJson, `eventTestData[${topic}] does not match spec's example`);
+      expect(testEventJson).toEqual(exampleDataJson);
     });
   }
 });

packages/api/test/unit/beacon/testData/beacon.ts

@@ -9,8 +9,8 @@ import {
 } from "../../../../src/beacon/routes/beacon/index.js";
 import {GenericServerTestCases} from "../../../utils/genericServerTest.js";
 
-const root = Buffer.alloc(32, 1);
-const randao = Buffer.alloc(32, 1);
+const root = new Uint8Array(32).fill(1);
+const randao = new Uint8Array(32).fill(1);
 const balance = 32e9;
 const pubkeyHex = toHexString(Buffer.alloc(48, 1));
 

packages/api/test/unit/beacon/testData/config.ts

@@ -15,7 +15,7 @@ export const testData: GenericServerTestCases<Api> = {
     res: {
       data: {
         chainId: 1,
-        address: Buffer.alloc(20, 1),
+        address: new Uint8Array(20).fill(1),
       },
     },
   },

packages/api/test/unit/beacon/testData/events.ts

@@ -4,7 +4,7 @@ import {Api, EventData, EventType, blobSidecarSSE} from "../../../../src/beacon/
 import {GenericServerTestCases} from "../../../utils/genericServerTest.js";
 
 const abortController = new AbortController();
-const root = Buffer.alloc(32, 0);
+const root = new Uint8Array(32);
 
 /* eslint-disable @typescript-eslint/no-empty-function, @typescript-eslint/naming-convention */
 

packages/api/test/unit/beacon/testData/lightclient.ts

@@ -46,6 +46,6 @@ export const testData: GenericServerTestCases<Api> = {
   },
   getCommitteeRoot: {
     args: [1, 2],
-    res: {data: [Buffer.alloc(32, 0), Buffer.alloc(32, 1)]},
+    res: {data: [Uint8Array.from(Buffer.alloc(32, 0)), Uint8Array.from(Buffer.alloc(32, 1))]},
   },
 };

packages/api/test/unit/beacon/testData/validator.ts

@@ -3,10 +3,10 @@ import {ssz} from "@lodestar/types";
 import {Api} from "../../../../src/beacon/routes/validator.js";
 import {GenericServerTestCases} from "../../../utils/genericServerTest.js";
 
-const ZERO_HASH = Buffer.alloc(32, 0);
-const ZERO_HASH_HEX = "0x" + ZERO_HASH.toString("hex");
-const randaoReveal = Buffer.alloc(96, 1);
-const selectionProof = Buffer.alloc(96, 1);
+const ZERO_HASH = new Uint8Array(32);
+const ZERO_HASH_HEX = "0x" + Buffer.from(ZERO_HASH).toString("hex");
+const randaoReveal = new Uint8Array(96).fill(1);
+const selectionProof = new Uint8Array(96).fill(1);
 const graffiti = "a".repeat(32);
 const feeRecipient = "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
 
@@ -17,7 +17,7 @@ export const testData: GenericServerTestCases<Api> = {
       executionOptimistic: true,
       data: [
         {
-          pubkey: Buffer.alloc(48, 1),
+          pubkey: new Uint8Array(48).fill(1),
           validatorIndex: 2,
           committeeIndex: 3,
           committeeLength: 4,
@@ -33,23 +33,35 @@ export const testData: GenericServerTestCases<Api> = {
     args: [1000],
     res: {
       executionOptimistic: true,
-      data: [{slot: 1, validatorIndex: 2, pubkey: Buffer.alloc(48, 3)}],
+      data: [{slot: 1, validatorIndex: 2, pubkey: new Uint8Array(48).fill(3)}],
       dependentRoot: ZERO_HASH_HEX,
     },
   },
   getSyncCommitteeDuties: {
     args: [1000, [1, 2, 3]],
     res: {
       executionOptimistic: true,
-      data: [{pubkey: Buffer.alloc(48, 1), validatorIndex: 2, validatorSyncCommitteeIndices: [3]}],
+      data: [{pubkey: Uint8Array.from(Buffer.alloc(48, 1)), validatorIndex: 2, validatorSyncCommitteeIndices: [3]}],
     },
   },
   produceBlock: {
-    args: [32000, randaoReveal, graffiti],
+    args: [
+      32000,
+      randaoReveal,
+      graffiti,
+      undefined,
+      {feeRecipient: undefined, builderSelection: undefined, strictFeeRecipientCheck: undefined},
+    ] as unknown as GenericServerTestCases<Api>["produceBlock"]["args"],
     res: {data: ssz.phase0.BeaconBlock.defaultValue()},
   },
   produceBlockV2: {
-    args: [32000, randaoReveal, graffiti],
+    args: [
+      32000,
+      randaoReveal,
+      graffiti,
+      undefined,
+      {feeRecipient: undefined, builderSelection: undefined, strictFeeRecipientCheck: undefined},
+    ] as unknown as GenericServerTestCases<Api>["produceBlockV2"]["args"],
     res: {
       data: ssz.altair.BeaconBlock.defaultValue(),
       version: ForkName.altair,
@@ -74,7 +86,13 @@ export const testData: GenericServerTestCases<Api> = {
     },
   },
   produceBlindedBlock: {
-    args: [32000, randaoReveal, graffiti],
+    args: [
+      32000,
+      randaoReveal,
+      graffiti,
+      undefined,
+      {feeRecipient: undefined, builderSelection: undefined, strictFeeRecipientCheck: undefined},
+    ] as unknown as GenericServerTestCases<Api>["produceBlindedBlock"]["args"],
     res: {
       data: ssz.bellatrix.BlindedBeaconBlock.defaultValue(),
       version: ForkName.bellatrix,

packages/api/test/unit/builder/builder.test.ts

@@ -1,3 +1,4 @@
+import {describe} from "vitest";
 import {createChainForkConfig, defaultChainConfig} from "@lodestar/config";
 import {Api, ReqTypes} from "../../../src/builder/routes.js";
 import {getClient} from "../../../src/builder/client.js";

packages/api/test/unit/builder/testData.ts

@@ -7,7 +7,7 @@ import {GenericServerTestCases} from "../../utils/genericServerTest.js";
 
 // randomly pregenerated pubkey
 const pubkeyRand = "0x84105a985058fc8740a48bf1ede9d223ef09e8c6b1735ba0a55cf4a9ff2ff92376b778798365e488dab07a652eb04576";
-const root = Buffer.alloc(32, 1);
+const root = new Uint8Array(32).fill(1);
 
 export const testData: GenericServerTestCases<Api> = {
   status: {

packages/api/test/unit/client/fetch.test.ts

@@ -1,6 +1,6 @@
 import crypto from "node:crypto";
 import http from "node:http";
-import {expect} from "chai";
+import {describe, it, expect, afterEach} from "vitest";
 import {FetchError, FetchErrorType, fetch} from "../../../src/utils/client/fetch.js";
 
 describe("FetchError", function () {
@@ -116,12 +116,16 @@ describe("FetchError", function () {
         );
       }
 
-      await expect(fetch(url, {signal: signalHandler?.()})).to.be.rejected.then((error: FetchError) => {
-        expect(error.type).to.be.equal(testCase.errorType);
-        expect(error.code).to.be.equal(testCase.errorCode);
+      await expect(fetch(url, {signal: signalHandler?.()})).rejects.toSatisfy((err) => {
+        expect(err).toBeInstanceOf(FetchError);
+        expect((err as FetchError).code).toBe(testCase.errorCode);
+        expect((err as FetchError).type).toBe(testCase.errorType);
+
         if (testCase.expectCause) {
-          expect(error.cause).to.be.instanceof(Error);
+          expect((err as FetchError).cause).toBeInstanceOf(Error);
         }
+
+        return true;
       });
     });
   }

packages/api/test/unit/client/format.test.ts

@@ -1,9 +1,9 @@
-import {expect} from "chai";
+import {describe, expect, it} from "vitest";
 import {EventType} from "../../../src/beacon/routes/events.js";
 import {stringifyQuery} from "../../../src/utils/client/format.js";
 
 describe("client / utils / format", () => {
   it("Should repeat topic query", () => {
-    expect(stringifyQuery({topics: [EventType.finalizedCheckpoint]})).to.equal("topics=finalized_checkpoint");
+    expect(stringifyQuery({topics: [EventType.finalizedCheckpoint]})).toBe("topics=finalized_checkpoint");
   });
 });