✨ feat(edit-recurrence): add ability to edit recurrence (#894)

* ✨ feat(edit-recurrence): add ability to edit recurrence

* ✨ feat(edit-recurrence): add bson pkg to core

* ✨ feat(edit-recurrence): parse ui payload with CompassCoreEventSchema

* ✨ feat(edit-recurrence): enable recurrence edit

* ✨ feat(edit-recurrence): add recurrence section tests

* ✨ feat(edit-recurrence): add recurrence hook tests

* ✨ feat(edit-recurrence): keep recurring someday events hidden

* Update packages/web/src/views/Forms/EventForm/DateControlsSection/RecurrenceSection/utils.test.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: victor-enogwe

packages/backend/src/event/classes/compass.event.generator.ts

@@ -14,9 +14,9 @@ import {
   Schema_Event_Recur_Base,
   Schema_Event_Recur_Instance,
 } from "@core/types/event.types";
+import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import { isAllDay, parseCompassEventDate } from "@core/util/event/event.util";
 import mongoService from "@backend/common/services/mongo.service";
-import { CompassEventRRule } from "@backend/event/classes/compass.event.rrule";
 
 export class CompassEventFactory {
   private static async findCompassEvent(

packages/backend/src/event/classes/compass.event.parser.ts

@@ -12,6 +12,7 @@ import {
   TransitionStatus,
   WithCompassId,
 } from "@core/types/event.types";
+import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import {
   isBase,
   isInstance,
@@ -20,7 +21,6 @@ import {
 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";
-import { CompassEventRRule } from "@backend/event/classes/compass.event.rrule";
 import {
   _createCompassEvent,
   _createGcal,

packages/backend/src/event/controllers/event.controller.ts

@@ -3,6 +3,7 @@ import { SessionRequest } from "supertokens-node/framework/express";
 import { Status } from "@core/errors/status.codes";
 import { Logger } from "@core/logger/winston.logger";
 import {
+  CompassCoreEventSchema,
   CompassEvent,
   CompassEventStatus,
   CompassCoreEventSchema as EventSchema,
@@ -11,7 +12,6 @@ import {
   RecurringEventUpdateScope,
   Schema_Event,
 } from "@core/types/event.types";
-import { validateEvent } from "@core/validators/event.validator";
 import { Res_Promise, SReqBody } from "@backend/common/types/express.types";
 import eventService from "@backend/event/services/event.service";
 import { CompassSyncProcessor } from "@backend/sync/services/sync/compass.sync.processor";
@@ -24,7 +24,7 @@ class EventController {
     status?: CompassEventStatus,
     applyTo: RecurringEventUpdateScope = RecurringEventUpdateScope.THIS_EVENT,
   ) {
-    const payload = validateEvent(_payload as Schema_Event);
+    const payload = CompassCoreEventSchema.parse(_payload as Schema_Event);
 
     const event = {
       status: status ?? CompassEventStatus.CONFIRMED,
@@ -134,10 +134,9 @@ class EventController {
       const { body, query, params, session } = req;
       const user = session?.getUserId() as string;
       const _id = params["id"] as string;
-      const data = EventSchema.parse({ ...body, user, _id });
 
       await this.processEvent(
-        data as CompassEvent["payload"],
+        { ...body, user, _id } as CompassEvent["payload"],
         CompassEventStatus.CONFIRMED,
         (query["applyTo"] as RecurringEventUpdateScope) ??
           RecurringEventUpdateScope.THIS_EVENT,

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

@@ -28,6 +28,7 @@ import {
 } from "@core/types/event.types";
 import { gSchema$Event } from "@core/types/gcal";
 import { getCurrentRangeDates } from "@core/util/date/date.util";
+import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import {
   isExistingInstance,
   parseCompassEventDate,
@@ -39,7 +40,6 @@ import { GenericError } from "@backend/common/errors/generic/generic.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
 import gcalService from "@backend/common/services/gcal/gcal.service";
 import mongoService from "@backend/common/services/mongo.service";
-import { CompassEventRRule } from "@backend/event/classes/compass.event.rrule";
 import { reorderEvents } from "@backend/event/queries/event.queries";
 import { getReadAllFilter } from "@backend/event/services/event.service.util";
 import { CompassSyncProcessor } from "@backend/sync/services/sync/compass.sync.processor";

packages/core/package.json

@@ -11,6 +11,7 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
+    "bson": "^6.10.4",
     "tinycolor2": "^1.6.0",
     "winston": "^3.8.1"
   }

packages/core/src/types/event.types.ts

@@ -1,6 +1,11 @@
-import { Query } from "express-serve-static-core";
+import type { ObjectId } from "bson";
+import type { Query } from "express-serve-static-core";
 import { z } from "zod";
-import { Origin, Priorities, Priority } from "@core/constants/core.constants";
+import {
+  Origin,
+  Priorities,
+  type Priority,
+} from "@core/constants/core.constants";
 
 /**
  * Event category, based on its display type
@@ -167,7 +172,7 @@ export const CoreEventSchema = z.object({
   user: z.string(),
 });
 
-const CompassEventRecurrence = z.object({
+export const CompassEventRecurrence = z.object({
   rule: z.array(z.string()),
   eventId: z.string().optional(),
 });
@@ -187,8 +192,15 @@ export const EventUpdateSchema = z.object({
   isSomeday: z.boolean().optional(),
 });
 
-export const CompassCoreEventSchema = CoreEventSchema.extend({
+export const CompassCoreEventSchema = CoreEventSchema.omit({
+  recurrence: true,
+}).extend({
   _id: z.string(),
+  recurrence: CompassEventRecurrence.omit({ rule: true })
+    .extend({
+      rule: z.union([z.null(), z.array(z.string())]),
+    })
+    .optional(),
 });
 
 const BaseCompassEventSchema = z.object({
@@ -260,6 +272,7 @@ export type CompassEvent = z.infer<typeof CompassEventSchema>;
 export type EventUpdatePayload = z.infer<typeof EventUpdateSchema>;
 
 export type WithCompassId<T> = T & { _id: string };
+export type WithMongoId<T> = T & { _id: ObjectId }; // same as WithId from the 'mongodb' package - but for ui use
 export type WithoutCompassId<T> = Omit<T, "_id">;
 export enum CalendarProvider {
   GOOGLE = "google",

…vent/classes/compass.event.rrule.test.ts …c/util/event/compass.event.rrule.test.tspackages/backend/src/event/classes/compass.event.rrule.test.ts renamed to packages/core/src/util/event/compass.event.rrule.test.ts packages/backend/src/event/classes/compass.event.rrule.test.ts renamed to packages/core/src/util/event/compass.event.rrule.test.ts

@@ -9,6 +9,7 @@ import {
   type Schema_Event_Recur_Base,
 } from "@core/types/event.types";
 import dayjs from "@core/util/date/dayjs";
+import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import {
   isBase,
   isInstance,
@@ -19,7 +20,6 @@ import {
   createMockBaseEvent,
   generateCompassEventDates,
 } from "@core/util/test/ccal.event.factory";
-import { CompassEventRRule } from "@backend/event/classes/compass.event.rrule";
 
 describe("CompassEventRRule: ", () => {
   it(`should return the correct number of events based on rrule count`, () => {

…src/event/classes/compass.event.rrule.ts …re/src/util/event/compass.event.rrule.tspackages/backend/src/event/classes/compass.event.rrule.ts renamed to packages/core/src/util/event/compass.event.rrule.ts packages/backend/src/event/classes/compass.event.rrule.ts renamed to packages/core/src/util/event/compass.event.rrule.ts

@@ -1,4 +1,5 @@
-import { ObjectId, WithId } from "mongodb";
+import { ObjectId } from "bson";
+import type { WithId } from "mongodb";
 import type { Options, RRuleStrOptions } from "rrule";
 import { RRule, rrulestr } from "rrule";
 import type { ParsedOptions } from "rrule/dist/esm/types";
@@ -22,7 +23,10 @@ export class CompassEventRRule extends RRule {
   #durationMs!: number;
 
   constructor(
-    event: WithId<Omit<Schema_Event_Recur_Base, "_id">>,
+    event: Pick<
+      WithId<Omit<Schema_Event_Recur_Base, "_id">>,
+      "startDate" | "endDate" | "_id" | "recurrence"
+    >,
     options: Partial<Options> = {},
   ) {
     super(CompassEventRRule.#initOptions(event, options));

packages/web/src/__tests__/utils/test.util.ts

@@ -3,7 +3,7 @@ interface Spies {
 }
 const spies: Spies = {};
 
-export const arraysAreEqual = (a: any[], b: any[]) => {
+export const arraysAreEqual = (a: unknown[], b: unknown[]) => {
   return (
     Array.isArray(a) &&
     Array.isArray(b) &&
@@ -34,3 +34,13 @@ export const mockResizeObserver = () => {
 export const mockScroll = () => {
   window.HTMLElement.prototype.scroll = jest.fn();
 };
+
+export const mockBSON = () => {
+  jest.mock("bson", () => ({
+    ObjectId: class ObjectId {
+      toString() {
+        return crypto.randomUUID();
+      }
+    },
+  }));
+};

packages/web/src/__tests__/web.test.start.js

@@ -1,10 +1,13 @@
 import { server } from "@web/__tests__/__mocks__/server/mock.server";
 import {
   clearLocalStorageMock,
+  mockBSON,
   mockResizeObserver,
   mockScroll,
 } from "@web/__tests__/utils/test.util";
 
+mockBSON();
+
 beforeAll(() => {
   mockScroll();
   mockResizeObserver();