Merge branch 'main' into refactor-randomize-test-users-and-db

Author: victor-enogwe

packages/backend/.env.example

@@ -28,6 +28,7 @@ TOKEN_GCAL_NOTIFICATION=ANOTHER_UNIQUE_STRING
 ####################################################
 # 2. Database                                      #
 ####################################################
+MONGOMS_VERSION=8.0.9 # pins the test mongo server binary version
 MONGO_URI=mongodb+srv://admin:YOUR_ADMIN_PW@cluster0.m99yy.mongodb.net/dev_calendar?authSource=admin&retryWrites=true&w=majority&tls=true
 
 

packages/backend/src/__tests__/backend.test.start.ts

@@ -1,5 +1,19 @@
 import { mockNodeModules } from "@backend/__tests__/helpers/mock.setup";
 
+jest.mock("@core/logger/winston.logger", () => {
+  const mockLogger = {
+    debug: jest.fn(),
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+    verbose: jest.fn(),
+  };
+
+  return {
+    Logger: jest.fn().mockImplementation(() => mockLogger),
+  };
+});
+
 mockNodeModules();
 
 afterAll(() => jest.clearAllMocks());

packages/backend/src/__tests__/helpers/mock.db.setup.ts

@@ -7,8 +7,6 @@ import mongoService from "@backend/common/services/mongo.service";
 export async function setupTestDb(): Promise<void> {
   try {
     await mongoService.start(true);
-
-    console.log(mongoService.db.databaseName, "database started");
   } catch (err) {
     const error = err as Error;
 
@@ -35,10 +33,10 @@ export async function cleanupCollections(): Promise<void> {
   );
 }
 
-export async function cleanupTestMongo(): Promise<void> {
+export async function cleanupTestDb(): Promise<void> {
   try {
     await mongoService.stop();
   } catch (err) {
-    console.error("Error during cleanup:", err);
+    console.error("Error during test db cleanup:", err);
   }
 }

packages/backend/src/event/services/event.delete.test.ts

@@ -1,23 +1,24 @@
 import dayjs from "dayjs";
 import { Collection, ObjectId } from "mongodb";
-import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
-import { Schema_Event } from "@core/types/event.types";
 import {
   mockSomedayRecurrences,
   newsletterId,
-} from "../../../../core/src/__mocks__/v1/events/events.someday.recur";
+} from "@core/__mocks__/v1/events/events.someday.recur";
+import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
+import { Schema_Event } from "@core/types/event.types";
 import {
-  cleanupTestMongo,
+  cleanupTestDb,
   setupTestDb,
-} from "../../__tests__/helpers/mock.db.setup";
-import mongoService from "../../common/services/mongo.service";
-import { getDeleteByIdFilter } from "./event.service.util";
+} from "@backend/__tests__/helpers/mock.db.setup";
+import mongoService from "@backend/common/services/mongo.service";
+import { getDeleteByIdFilter } from "@backend/event/services/event.service.util";
 
 describe("Delete Events", () => {
   let eventCollection: Collection<Schema_Event>;
 
   beforeAll(async () => {
     await setupTestDb();
+
     eventCollection = mongoService.db.collection("event.delete.test");
   });
 
@@ -26,7 +27,7 @@ describe("Delete Events", () => {
     await eventCollection.insertMany([...mockSomedayRecurrences]);
   });
 
-  afterAll(cleanupTestMongo);
+  afterAll(cleanupTestDb);
 
   describe("Recurring events: someday", () => {
     it("only deletes future instances", async () => {

packages/backend/src/event/services/event.find.allday.test.ts

@@ -1,34 +1,31 @@
-import { Collection, Filter } from "mongodb";
+import { Filter } from "mongodb";
+import { mockEventSetMar22 } from "@core/__mocks__/v1/events/events.22mar";
 import { Schema_Event } from "@core/types/event.types";
-import { mockEventSetMar22 } from "../../../../core/src/__mocks__/v1/events/events.22mar";
 import {
-  cleanupTestMongo,
+  cleanupTestDb,
   setupTestDb,
-} from "../../__tests__/helpers/mock.db.setup";
-import mongoService from "../../common/services/mongo.service";
-import { getReadAllFilter } from "./event.service.util";
+} from "@backend/__tests__/helpers/mock.db.setup";
+import mongoService from "@backend/common/services/mongo.service";
+import { getReadAllFilter } from "@backend/event/services/event.service.util";
 
 describe("Mar 6 - 12, 2022: All-Day Events", () => {
-  let eventCollection: Collection<Schema_Event>;
   let filter: Filter<Schema_Event>;
   let titles: string[];
 
   beforeAll(async () => {
     await setupTestDb();
 
-    eventCollection = mongoService.event;
-
-    await eventCollection.insertMany(mockEventSetMar22);
+    await mongoService.event.insertMany(mockEventSetMar22);
 
     filter = getReadAllFilter("user1", {
       start: "2022-03-06T00:00:00-07:00",
       end: "2022-03-12T23:59:59-07:00",
     });
-    const result = await eventCollection.find(filter).toArray();
+    const result = await mongoService.event.find(filter).toArray();
     titles = result.map((e) => e.title);
   });
 
-  afterAll(cleanupTestMongo);
+  afterAll(cleanupTestDb);
 
   it("finds overlapping multi-week event", async () => {
     expect(titles.includes("Feb 14 - Mar 8")).toBe(true);

packages/backend/src/event/services/event.find.test.ts

@@ -1,19 +1,19 @@
 import { Collection, Filter } from "mongodb";
+import { mockEventSetJan22 } from "@core/__mocks__/v1/events/events.22jan";
+import { mockEventSetSomeday1 } from "@core/__mocks__/v1/events/events.someday.1";
 import { MapEvent } from "@core/mappers/map.event";
 import { Schema_Event } from "@core/types/event.types";
 import { isBase, isExistingInstance } from "@core/util/event/event.util";
+import {
+  cleanupTestDb,
+  setupTestDb,
+} from "@backend/__tests__/helpers/mock.db.setup";
 import {
   mockRecurringGcalBaseEvent,
   mockRecurringGcalInstances,
 } from "@backend/__tests__/mocks.gcal/factories/gcal.event.factory";
-import { mockEventSetJan22 } from "../../../../core/src/__mocks__/v1/events/events.22jan";
-import { mockEventSetSomeday1 } from "../../../../core/src/__mocks__/v1/events/events.someday.1";
-import {
-  cleanupTestMongo,
-  setupTestDb,
-} from "../../__tests__/helpers/mock.db.setup";
-import mongoService from "../../common/services/mongo.service";
-import { getReadAllFilter } from "./event.service.util";
+import mongoService from "@backend/common/services/mongo.service";
+import { getReadAllFilter } from "@backend/event/services/event.service.util";
 
 const gBase = mockRecurringGcalBaseEvent();
 const gInstances = mockRecurringGcalInstances(gBase, 10, 7);
@@ -43,7 +43,7 @@ describe("Jan 2022: Many Formats", () => {
     await eventCollection.insertMany(allEvents);
   });
 
-  afterAll(cleanupTestMongo);
+  afterAll(cleanupTestDb);
 
   it("returns events by provided user only", async () => {
     const filter = getReadAllFilter("user1", {

packages/backend/src/servers/websocket/websocket.server.test.ts

@@ -1,3 +1,8 @@
+/**
+ * @jest-environment node
+ *
+ * we do not need the database for this test
+ */
 import { randomUUID } from "node:crypto";
 import { updateUserMetadata } from "supertokens-node/recipe/usermetadata";
 import {
@@ -9,9 +14,9 @@ import {
 } from "@core/constants/websocket.constants";
 import { UserMetadata } from "@core/types/user.types";
 import { BaseDriver } from "@backend/__tests__/drivers/base.driver";
+import { GenericError } from "@backend/common/errors/generic/generic.errors";
+import { error } from "@backend/common/errors/handlers/error.handler";
 import { webSocketServer } from "@backend/servers/websocket/websocket.server";
-import { GenericError } from "../../common/errors/generic/generic.errors";
-import { error } from "../../common/errors/handlers/error.handler";
 
 describe("WebSocket Server", () => {
   const baseDriver = new BaseDriver();

packages/backend/src/sync/controllers/sync.controller.test.ts

@@ -16,7 +16,7 @@ import {
 } from "@backend/__tests__/helpers/mock.db.queries";
 import {
   cleanupCollections,
-  cleanupTestMongo,
+  cleanupTestDb,
   setupTestDb,
 } from "@backend/__tests__/helpers/mock.db.setup";
 import { waitUntilEvent } from "@backend/common/helpers/common.util";
@@ -59,8 +59,6 @@ describe("SyncController", () => {
 
     if (waitForEventChanged) expect(eventChanged?.status).toEqual("fulfilled");
 
-    console.log(eventChanged);
-
     return { user, websocketClient };
   }
 
@@ -74,7 +72,7 @@ describe("SyncController", () => {
 
   afterAll(async () => {
     await baseDriver.teardown();
-    await cleanupTestMongo();
+    await cleanupTestDb();
     jest.clearAllMocks();
   });
 
@@ -394,7 +392,7 @@ describe("SyncController", () => {
     });
 
     describe("Frontend Notifications", () => {
-      beforeEach(() => cleanupCollections());
+      beforeEach(cleanupCollections);
 
       it("should notify the frontend that the import has started", async () => {
         const user = await UserDriver.createUser();

packages/backend/src/sync/services/import/sync.import.full.test.ts

@@ -1,22 +1,22 @@
 import { isBase, isExistingInstance } from "@core/util/event/event.util";
+import { UtilDriver } from "@backend/__tests__/drivers/util.driver";
 import {
   getCategorizedEventsInDb,
   getEventsInDb,
 } from "@backend/__tests__/helpers/mock.db.queries";
 import {
   cleanupCollections,
-  cleanupTestMongo,
+  cleanupTestDb,
   setupTestDb,
 } from "@backend/__tests__/helpers/mock.db.setup";
-import { UtilDriver } from "../../../__tests__/drivers/util.driver";
-import { createSyncImport } from "./sync.import";
+import { createSyncImport } from "@backend/sync/services/import/sync.import";
 
 describe("SyncImport: Full", () => {
   beforeAll(setupTestDb);
 
   beforeEach(cleanupCollections);
 
-  afterAll(cleanupTestMongo);
+  afterAll(cleanupTestDb);
 
   it("should import the first instance of a recurring event (and the base)", async () => {
     const { user } = await UtilDriver.setupTestUser();

packages/backend/src/sync/services/import/sync.import.series.test.ts

@@ -5,7 +5,7 @@ import {
 } from "@core/util/event/event.util";
 import {
   cleanupCollections,
-  cleanupTestMongo,
+  cleanupTestDb,
   setupTestDb,
 } from "@backend/__tests__/helpers/mock.db.setup";
 import { mockRecurringGcalBaseEvent } from "@backend/__tests__/mocks.gcal/factories/gcal.event.factory";
@@ -18,7 +18,7 @@ describe("SyncImport: Series", () => {
 
   beforeEach(cleanupCollections);
 
-  afterAll(cleanupTestMongo);
+  afterAll(cleanupTestDb);
 
   it("should import a series when provided a gcal base event", async () => {
     /* Assemble */