✨ feat(dates): update modules to use custom dayjs module (#1029)

* ✨ feat(dates): update modules to use custom dayjs module

* ✨ feat(dates): use supplied end param in computeSomedayEventsRequestFilter

Author: victor-enogwe

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

@@ -1,11 +1,12 @@
-import dayjs from "dayjs";
-import { Collection, ObjectId } from "mongodb";
+import { ObjectId } from "mongodb";
 import {
   mockSomedayRecurrences,
   newsletterId,
+  userId,
 } from "@core/__mocks__/v1/events/events.someday.recur";
+import { Origin, Priorities } from "@core/constants/core.constants";
 import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
-import { Schema_Event } from "@core/types/event.types";
+import dayjs from "@core/util/date/dayjs";
 import {
   cleanupTestDb,
   setupTestDb,
@@ -14,17 +15,16 @@ 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");
-  });
+  beforeAll(setupTestDb);
 
   beforeEach(async () => {
-    await eventCollection.deleteMany({});
-    await eventCollection.insertMany([...mockSomedayRecurrences]);
+    await mongoService.event.deleteMany({});
+    await mongoService.event.insertMany(
+      mockSomedayRecurrences.map((event) => ({
+        ...event,
+        _id: new ObjectId(event._id),
+      })),
+    );
   });
 
   afterAll(cleanupTestDb);
@@ -35,17 +35,19 @@ describe("Delete Events", () => {
       const instanceId = new ObjectId();
 
       const filter = getDeleteByIdFilter({
-        _id: instanceId,
-        user: "user1",
+        _id: instanceId.toString(),
+        user: userId,
         recurrence: { rule: ["foo"], eventId: newsletterId },
         startDate: today.format(YEAR_MONTH_DAY_FORMAT),
         endDate: today.add(6, "days").format(YEAR_MONTH_DAY_FORMAT),
+        origin: Origin.COMPASS,
+        priority: Priorities.SELF,
       });
 
-      const { deletedCount } = await eventCollection.deleteMany(filter);
+      const { deletedCount } = await mongoService.event.deleteMany(filter);
       expect(deletedCount).not.toBe(0);
 
-      const _events = await eventCollection.find({ user: "user1" }).toArray();
+      const _events = await mongoService.event.find({ user: userId }).toArray();
       const events = _events.map((e) => e.title);
 
       expect(events.includes("Send Newsletter | Base | Past")).toBe(true);

packages/backend/src/event/services/event.service.util.ts

@@ -1,4 +1,4 @@
-import { Filter, ObjectId } from "mongodb";
+import { Filter, ObjectId, WithId } from "mongodb";
 import {
   Query_Event,
   Schema_Event,
@@ -7,11 +7,10 @@ import {
 import { isSameMonth } from "@core/util/date/date.util";
 import { GenericError } from "@backend/common/errors/generic/generic.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
-import mongoService from "@backend/common/services/mongo.service";
 
 export const getDeleteByIdFilter = (
   event: Schema_Event_Core,
-): Parameters<typeof mongoService.event.find>[0] => {
+): Filter<WithId<Omit<Schema_Event, "_id">>> => {
   if (!event._id) {
     throw error(
       GenericError.BadRequest,

packages/backend/src/event/services/recur/recur.week.test.ts

@@ -1,6 +1,6 @@
-import dayjs from "dayjs";
+import { RRULE } from "@core/constants/core.constants";
 import { Schema_Event_Core } from "@core/types/event.types";
-import { RRULE } from "../../../../../core/src/constants/core.constants";
+import dayjs from "@core/util/date/dayjs";
 import { areDatesUnique, haveSharedValues } from "./recur.test.util";
 import { assembleInstances } from "./util/recur.util";
 

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

@@ -1,19 +1,19 @@
-import dayjs from "dayjs";
 import { ObjectId } from "mongodb";
 import { gcalEvents } from "@core/__mocks__/v1/events/gcal/gcal.event";
 import { Event_Core } from "@core/types/event.types";
+import { gSchema$Event } from "@core/types/gcal";
+import dayjs from "@core/util/date/dayjs";
 import {
   createMockBaseEvent,
   createMockInstance,
 } from "@core/util/test/ccal.event.factory";
 import { generateGcalId } from "@backend/__tests__/mocks.gcal/factories/gcal.event.factory";
 import { cancelledEventsIds } from "@backend/common/services/gcal/gcal.utils";
-import { syncExpired, syncExpiresSoon } from "@backend/sync/util/sync.util";
-import { gSchema$Event } from "../../../../../core/src/types/gcal";
 import {
   assignIdsToEvents,
   organizeGcalEventsByType,
-} from "./sync.import.util";
+} from "@backend/sync/services/import/sync.import.util";
+import { syncExpired, syncExpiresSoon } from "@backend/sync/util/sync.util";
 
 describe("categorizeGcalEvents", () => {
   const { toDelete, toUpdate } = organizeGcalEventsByType(gcalEvents.items);

packages/backend/src/sync/services/log/sync.logger.ts

@@ -1,8 +1,8 @@
-import dayjs from "dayjs";
 import fs from "fs";
 import path from "path";
 import { Schema_Event_Core } from "@core/types/event.types";
 import { gSchema$Event } from "@core/types/gcal";
+import dayjs from "@core/util/date/dayjs";
 
 interface SyncLogData {
   updatedEvents: gSchema$Event[];

packages/backend/src/sync/services/maintain/sync.maintenance.ts

@@ -1,18 +1,19 @@
-import dayjs from "dayjs";
 import { Logger } from "@core/logger/winston.logger";
 import {
   Payload_Sync_Events,
   Payload_Sync_Refresh,
   Result_Watch_Stop,
   Schema_Sync,
 } from "@core/types/sync.types";
+import dayjs from "@core/util/date/dayjs";
 import compassAuthService from "@backend/auth/services/compass.auth.service";
 import { getGcalClient } from "@backend/auth/services/google.auth.service";
 import {
   isFullSyncRequired,
   isInvalidGoogleToken,
 } from "@backend/common/services/gcal/gcal.utils";
 import mongoService from "@backend/common/services/mongo.service";
+import syncService from "@backend/sync/services/sync.service";
 import {
   getSync,
   hasUpdatedCompassEventRecently,
@@ -23,7 +24,6 @@ import {
   syncExpiresSoon,
 } from "@backend/sync/util/sync.util";
 import userService from "@backend/user/services/user.service";
-import syncService from "../sync.service";
 
 const logger = Logger("app:sync.maintenance");
 

packages/backend/src/sync/services/sync/__tests__/gcal.sync.processor.test.util.ts

@@ -1,5 +1,3 @@
-import dayjs from "dayjs";
-import timezone from "dayjs/plugin/timezone";
 import { Filter, ObjectId, WithId } from "mongodb";
 import {
   Event_Core,
@@ -9,6 +7,7 @@ import {
 } from "@core/types/event.types";
 import { gSchema$EventBase, gSchema$EventInstance } from "@core/types/gcal";
 import { Schema_User } from "@core/types/user.types";
+import dayjs from "@core/util/date/dayjs";
 import {
   categorizeEvents,
   isBase,
@@ -21,8 +20,6 @@ import { mockRecurringGcalInstances } from "@backend/__tests__/mocks.gcal/factor
 import { Event_API } from "@backend/common/types/backend.event.types";
 import { validateEventSafely } from "@backend/common/validators/validate.event";
 
-dayjs.extend(timezone);
-
 /** Utility assertions for the gcal sync processor tests */
 export const baseHasRecurrenceRule = async (
   events: Event_Core[],

packages/core/src/__mocks__/v1/events/events.someday.recur.ts

@@ -1,10 +1,11 @@
-import dayjs from "dayjs";
+import { ObjectId } from "bson";
 import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
 import { Schema_Event } from "@core/types/event.types";
+import dayjs from "@core/util/date/dayjs";
 
-const userId = "user1";
-export const newsletterId = "64c266a87866ebd0a2bda49b";
-const walkDogId = "77c777a87866ebd0a2bda49b";
+export const userId = new ObjectId().toString();
+export const newsletterId = new ObjectId().toString();
+const walkDogId = new ObjectId().toString();
 
 const today = dayjs();
 
@@ -18,7 +19,7 @@ export const newsletterRecurrences: Schema_Event[] = [
     endDate: today.add(-13, "days").format(YEAR_MONTH_DAY_FORMAT),
   },
   {
-    _id: "instance1",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance | Past",
     isSomeday: true,
@@ -30,7 +31,7 @@ export const newsletterRecurrences: Schema_Event[] = [
     },
   },
   {
-    _id: "instance2a",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance2 | Starts Today",
     isSomeday: true,
@@ -42,7 +43,7 @@ export const newsletterRecurrences: Schema_Event[] = [
     },
   },
   {
-    _id: "instance2b",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance2 | Ends Today",
     isSomeday: true,
@@ -54,7 +55,7 @@ export const newsletterRecurrences: Schema_Event[] = [
     },
   },
   {
-    _id: "instance3",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance3 | Future1",
     isSomeday: true,
@@ -66,7 +67,7 @@ export const newsletterRecurrences: Schema_Event[] = [
     },
   },
   {
-    _id: "instance4",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance4 | Future2",
     isSomeday: true,
@@ -89,7 +90,7 @@ const walkDogRecurrences: Schema_Event[] = [
     endDate: today.add(-13, "days").format(YEAR_MONTH_DAY_FORMAT),
   },
   {
-    _id: "walkdog-instance1",
+    _id: new ObjectId().toString(),
     user: userId,
     title: "Send Newsletter | Instance | Past",
     isSomeday: true,

packages/core/src/util/date/date.util.ts

@@ -1,12 +1,5 @@
-import dayjs from "dayjs";
-import customParseFormat from "dayjs/plugin/customParseFormat";
-import utc from "dayjs/plugin/utc";
-import weekOfYear from "dayjs/plugin/weekOfYear";
 import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
-
-dayjs.extend(utc);
-dayjs.extend(weekOfYear);
-dayjs.extend(customParseFormat); // for RFC formatting
+import dayjs from "@core/util/date/dayjs";
 
 export const FORMAT = {
   RFC5545: {

packages/scripts/src/commands/seed.ts

@@ -1,9 +1,9 @@
 import axios from "axios";
-import dayjs from "dayjs";
 import pkg from "inquirer";
 import { ObjectId } from "mongodb";
 import { getApiBaseUrl, log } from "@scripts/common/cli.utils";
 import { Schema_Event } from "@core/types/event.types";
+import dayjs from "@core/util/date/dayjs";
 import { createMockStandaloneEvent } from "@core/util/test/ccal.event.factory";
 import compassAuthService from "@backend/auth/services/compass.auth.service";
 import mongoService from "@backend/common/services/mongo.service";