🐛 fix(recurring-events): allow someday recurring instance creation

Author: victor-enogwe

packages/web/src/ducks/events/event.types.ts

@@ -4,6 +4,7 @@ import { Priorities } from "@core/constants/core.constants";
 import {
   RecurringEventUpdateScope,
   Schema_Event,
+  WithCompassId,
 } from "@core/types/event.types";
 import { SliceStateContext } from "@web/common/store/helpers";
 import {
@@ -68,7 +69,7 @@ export interface Entities_Event {
 }
 
 export interface Payload_ConvertEvent {
-  event: Schema_WebEvent;
+  event: WithCompassId<Omit<Schema_WebEvent, "_id">>;
 }
 
 interface Payload_DeleteEvent {

packages/web/src/ducks/events/sagas/event.sagas.ts

@@ -2,7 +2,11 @@ import { normalize } from "normalizr";
 import { call, put, select } from "@redux-saga/core/effects";
 import { ID_OPTIMISTIC_PREFIX } from "@core/constants/core.constants";
 import { YEAR_MONTH_DAY_FORMAT } from "@core/constants/date.constants";
-import { Params_Events, Schema_Event } from "@core/types/event.types";
+import {
+  Params_Events,
+  RecurringEventUpdateScope,
+  Schema_Event,
+} from "@core/types/event.types";
 import dayjs from "@core/util/date/dayjs";
 import { Response_HttpPaginatedSuccess } from "@web/common/types/api.types";
 import { Payload_NormalizedAsyncAction } from "@web/common/types/entity.types";
@@ -49,11 +53,14 @@ export function* convertCalendarToSomedayEvent({
 
   try {
     const gridEvent = yield* _assembleGridEvent(payload.event);
+    const isInstance = typeof gridEvent.recurrence?.eventId === "string";
+    const { ALL_EVENTS, THIS_EVENT } = RecurringEventUpdateScope;
+    const applyTo = isInstance ? ALL_EVENTS : THIS_EVENT;
 
     // optimistic event will have an entirely new ID that will not match that eventually saved
     optimisticEvent = yield* _createOptimisticGridEvent(gridEvent, true);
 
-    yield* _editEvent(gridEvent);
+    yield* _editEvent(gridEvent, { applyTo });
     yield* replaceOptimisticId(optimisticEvent._id, false);
     yield put(editEventSlice.actions.success());
   } catch (error) {

packages/web/src/ducks/events/sagas/someday.sagas.ts

@@ -33,6 +33,8 @@ export function* convertSomedayToCalendarEvent({
   try {
     const gridEvent = yield* _assembleGridEvent(payload.event);
 
+    delete gridEvent.recurrence;
+
     optimisticEvent = yield* _createOptimisticGridEvent(gridEvent);
 
     yield* _editEvent(gridEvent);

packages/web/src/views/Calendar/components/Draft/hooks/actions/useDraftActions.ts

@@ -12,6 +12,7 @@ import {
   Recurrence,
   RecurringEventUpdateScope,
   Schema_Event,
+  WithCompassId,
 } from "@core/types/event.types";
 import { devAlert } from "@core/util/app.util";
 import dayjs, { Dayjs } from "@core/util/date/dayjs";
@@ -161,7 +162,7 @@ export const useDraftActions = (
     reset();
 
     if (reduxDraft || reduxDraftType) {
-      dispatch(draftSlice.actions.discard());
+      dispatch(draftSlice.actions.discard(undefined));
     }
   }, [dispatch, reduxDraft, reduxDraftType, reset]);
 
@@ -193,26 +194,37 @@ export const useDraftActions = (
         return;
       }
 
-      dispatch(
-        getWeekEventsSlice.actions.convert({
-          event: {
-            ...draft,
-            _id: draft!._id!,
-            user: draft!.user!,
-            isAllDay: false,
-            isSomeday: true,
-            startDate: start,
-            endDate: end,
-            origin: draft!.origin!,
-            priority: draft?.priority ?? Priorities.UNASSIGNED,
-            order: somedayWeekCount,
-          },
-        }),
-      );
+      const event: WithCompassId<Omit<Schema_WebEvent, "_id">> = {
+        ...draft,
+        _id: draft!._id!,
+        user: draft!.user!,
+        isAllDay: false,
+        isSomeday: true,
+        startDate: start,
+        endDate: end,
+        origin: draft!.origin!,
+        priority: draft?.priority ?? Priorities.UNASSIGNED,
+        order: somedayWeekCount,
+      };
+
+      if (isRecurrence()) {
+        event.recurrence = {
+          ...event.recurrence,
+          rule: event.recurrence?.rule?.map((rule) => {
+            const isRRule = rule.startsWith("RRULE:");
+
+            if (!isRRule) return rule;
+
+            return rule.replace(/FREQ=\w+;/, "FREQ=WEEKLY;");
+          }) as string[],
+        };
+      }
+
+      dispatch(getWeekEventsSlice.actions.convert({ event }));
 
       discard();
     },
-    [discard, dispatch, draft, isAtWeeklyLimit, somedayWeekCount],
+    [discard, dispatch, draft, isAtWeeklyLimit, somedayWeekCount, isRecurrence],
   );
 
   const openForm = useCallback(() => {

packages/web/src/views/Forms/EventForm/DateControlsSection/RecurrenceSection/useRecurrence/useRecurrence.test.ts

@@ -1,21 +1,24 @@
 import { act } from "react";
 import { Frequency } from "rrule";
 import { renderHook } from "@testing-library/react";
-import { Priorities } from "@core/constants/core.constants";
-import { Schema_Event } from "@core/types/event.types";
+import { Origin, Priorities } from "@core/constants/core.constants";
+import { Schema_GridEvent } from "@web/common/types/web.event.types";
+import { assembleGridEvent } from "@web/common/utils/event/event.util";
 import { useRecurrence } from "./useRecurrence";
 
 describe("useRecurrence hook", () => {
-  const baseEvent = (): Schema_Event => ({
-    _id: "1",
-    title: "Test Event",
-    description: "desc",
-    startDate: new Date().toISOString(),
-    endDate: new Date(Date.now() + 3600000).toISOString(),
-    priority: Priorities.UNASSIGNED,
-    isSomeday: false,
-    user: "user1",
-  });
+  const baseEvent = (): Schema_GridEvent =>
+    assembleGridEvent({
+      _id: "1",
+      title: "Test Event",
+      description: "desc",
+      startDate: new Date().toISOString(),
+      endDate: new Date(Date.now() + 3600000).toISOString(),
+      priority: Priorities.UNASSIGNED,
+      origin: Origin.COMPASS,
+      isSomeday: false,
+      user: "user1",
+    });
 
   it("initializes with no recurrence", () => {
     const event = baseEvent();

packages/web/src/views/Forms/EventForm/DateControlsSection/RecurrenceSection/useRecurrence/useRecurrence.ts

@@ -9,15 +9,18 @@ import {
   useState,
 } from "react";
 import { Frequency, Options, RRule, Weekday } from "rrule";
-import { Schema_Event } from "@core/types/event.types";
 import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import { parseCompassEventDate } from "@core/util/event/event.util";
+import {
+  Schema_GridEvent,
+  Schema_WebEvent,
+} from "@web/common/types/web.event.types";
 import {
   FrequencyValues,
   WEEKDAYS,
   WEEKDAY_RRULE_MAP,
-} from "../constants/recurrence.constants";
-import { toWeekDays } from "../util/recurrence.util";
+} from "@web/views/Forms/EventForm/DateControlsSection/RecurrenceSection/constants/recurrence.constants";
+import { toWeekDays } from "@web/views/Forms/EventForm/DateControlsSection/RecurrenceSection/util/recurrence.util";
 
 const WEEKDAY_LABELS_MAP: Record<keyof typeof WEEKDAY_RRULE_MAP, string> = {
   sunday: RRule.SU.toString(),
@@ -57,10 +60,21 @@ const WEEKDAY_MAP: Record<
 );
 
 export const useRecurrence = (
-  event: Pick<Schema_Event, "startDate" | "endDate" | "recurrence">,
-  { setEvent }: { setEvent: Dispatch<SetStateAction<Schema_Event | null>> },
+  event: Partial<
+    Pick<
+      Schema_GridEvent | Schema_WebEvent,
+      "startDate" | "endDate" | "recurrence" | "isSomeday"
+    >
+  > | null,
+  {
+    setEvent,
+  }: {
+    setEvent: Dispatch<
+      SetStateAction<Schema_GridEvent | Schema_WebEvent | null>
+    >;
+  },
 ) => {
-  const { recurrence, endDate: _endDate } = event;
+  const { recurrence, endDate: _endDate, isSomeday } = event ?? {};
   const startDate = event?.startDate ?? dayjs().toRFC3339OffsetString();
   const endDate = _endDate ?? dayjs().add(1, "hour").toRFC3339OffsetString();
   const _startDate = parseCompassEventDate(startDate);
@@ -81,13 +95,23 @@ export const useRecurrence = (
       };
     }
 
-    return new CompassEventRRule({
-      _id: new ObjectId(), // we do not need the event's actual id here
-      startDate: startDate!,
-      endDate: endDate!,
-      recurrence: { rule: recurrence?.rule as string[] },
-    });
-  }, [_startDate, startDate, endDate, hasRecurrence, recurrence?.rule]);
+    return new CompassEventRRule(
+      {
+        _id: new ObjectId(), // we do not need the event's actual id here
+        startDate: startDate!,
+        endDate: endDate!,
+        recurrence: { rule: recurrence?.rule as string[] },
+      },
+      isSomeday ? { count: 6 } : {}, // default to 6 occurrences for someday events
+    );
+  }, [
+    _startDate,
+    startDate,
+    endDate,
+    hasRecurrence,
+    recurrence?.rule,
+    isSomeday,
+  ]);
 
   const defaultWeekDay: typeof WEEKDAYS = useMemo(
     () =>
@@ -141,7 +165,7 @@ export const useRecurrence = (
   const rule = useMemo(() => JSON.stringify(rrule.toRecurrence()), [rrule]);
 
   const toggleRecurrence = useCallback(() => {
-    setEvent((gridEvent): Schema_Event | null => {
+    setEvent((gridEvent): Schema_GridEvent | Schema_WebEvent | null => {
       if (!gridEvent) return gridEvent;
 
       const { recurrence, ...event } = gridEvent;
@@ -167,7 +191,7 @@ export const useRecurrence = (
   useEffect(() => {
     if (!hasRecurrence) return;
 
-    setEvent((gridEvent): Schema_Event | null => {
+    setEvent((gridEvent): Schema_GridEvent | Schema_WebEvent | null => {
       if (!gridEvent) return gridEvent;
 
       return {