feat(web): seed demo data (#1466)

* feat(storage): add demo data seed migration and related tests

- Introduced a new migration for seeding demo data for first-time users, including events and tasks with sensible defaults.
- Updated storage migration tests to accommodate new localStorage keys and ensure proper handling of migration flags.
- Added comprehensive tests for the demo data seed migration to verify correct data population and behavior under various conditions.
- Refactored existing migration tests to improve clarity and maintainability.

* refactor(event): remove default somedays creation from EventService

- Eliminated the createDefaultSomedays method from EventService to streamline event management.
- Updated UserService to remove calls to createDefaultSomedays during user initialization, focusing on priority creation instead.
- Adjusted related tests to reflect the removal of default someday events, ensuring consistency in user data setup.

* feat(tests): implement prepareEmptyStorageForTests utility for test setup

- Added a new utility function, prepareEmptyStorageForTests, to streamline the test setup process by clearing localStorage and IndexedDB, and setting a migration flag to prevent demo data seeding.
- Updated multiple test files to utilize this new utility, enhancing consistency and reducing redundancy in test initialization.
- Refactored existing tests to ensure they correctly prepare the storage state before each test, improving reliability and maintainability.

* feat(demo-data): update demo data seed to include all-day event and adjust event counts

- Added an all-day event titled "Deep work day" to the demo data seed, enhancing the variety of events generated for testing.
- Updated the expected event count in tests to reflect the addition of the new all-day event, ensuring accurate verification of event creation.
- Adjusted documentation to clarify the changes in the demo data structure, including the new all-day event and updated counts for today’s events.

* refactor(demo-data): simplify demo data seed documentation

- Removed detailed descriptions of demo data contents from the migration documentation to streamline the information presented.
- Updated the demo data seed migration to maintain clarity while focusing on essential details for first-time users.

* feat(tests): enhance storage tests with mock adapter and migration flag updates

- Introduced a new utility function, createMockStorageAdapter, to streamline the creation of mock storage adapters for testing.
- Updated existing tests to utilize the new mock adapter, improving consistency and reducing redundancy in test setup.
- Refactored migration tests to replace hardcoded migration flag keys with the new DEMO_DATA_SEED_FLAG_KEY, ensuring clarity and maintainability.
- Enhanced the demo data seed migration to utilize the updated flag key, aligning with recent changes in the storage architecture.

* feat(demo-data): add timed events with RFC3339 offset format to demo data seed

- Introduced a new test case to verify the creation of timed events with 15-minute-aligned times in RFC3339 offset format, ensuring no seconds or milliseconds are included.
- Updated the demo data generation logic to align with the new event format, enhancing the consistency and accuracy of the demo data for testing purposes.
- Adjusted existing event creation functions to ensure proper handling of time formatting, improving overall data integrity.

* feat(demo-data): enhance demo data seed with additional event properties

- Added `isAllDay` and `isSomeday` properties to multiple events in the demo data seed, ensuring more accurate representation of event types.
- Renamed an event from "Catch up with a friend" to "Call a friend" and added a description for clarity.
- Updated the demo data generation logic to improve the variety and detail of events for testing purposes.

* feat(demo-data): enhance demo data seed with grid position data for timed events

- Added a new test case to verify that default grid position data is correctly added to seeded timed events, ensuring proper layout handling.
- Updated the demo data generation logic to include grid event assembly for timed events, improving the accuracy of event positioning in the demo data.
- Enhanced existing event descriptions to provide more context for testing scenarios.

* feat(demo-data): enhance demo data seed with event schema validation

- Added a new test case to ensure seeded events conform to their respective schemas, validating both grid and core event structures.
- Updated the demo data generation logic to include position data for timed events, improving layout accuracy in the demo data.
- Enhanced event descriptions for clarity in testing scenarios, ensuring better context for validation checks.

Author: tyler-dane

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

@@ -1,11 +1,6 @@
 import type { GaxiosError } from "gaxios";
 import { ClientSession, Document, Filter, ObjectId, WithId } from "mongodb";
 import {
-  Origin,
-  Priorities,
-  RRULE,
-  RRULE_COUNT_MONTHS,
-  RRULE_COUNT_WEEKS,
   SOMEDAY_MONTHLY_LIMIT,
   SOMEDAY_WEEKLY_LIMIT,
 } from "@core/constants/core.constants";
@@ -14,22 +9,18 @@ import { Status } from "@core/errors/status.codes";
 import { MapEvent } from "@core/mappers/map.event";
 import {
   CalendarProvider,
-  CompassEventStatus,
-  CompassThisEvent,
   EventUpdatePayload,
   EventUpdateSchema,
   Params_DeleteMany,
   Payload_Order,
   Query_Event,
-  RecurringEventUpdateScope,
   Result_DeleteMany,
   Schema_Event,
   Schema_Event_Core,
   WithCompassId,
 } from "@core/types/event.types";
 import { gSchema$Event } from "@core/types/gcal";
 import { IDSchema } from "@core/types/type.utils";
-import { getCurrentRangeDates } from "@core/util/date/date.util";
 import { CompassEventRRule } from "@core/util/event/compass.event.rrule";
 import { isInstance, parseCompassEventDate } from "@core/util/event/event.util";
 import { getGcalClient } from "@backend/auth/services/google.auth.service";
@@ -41,78 +32,8 @@ import gcalService from "@backend/common/services/gcal/gcal.service";
 import mongoService from "@backend/common/services/mongo.service";
 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";
 
 class EventService {
-  createDefaultSomedays = async (userId: string, session?: ClientSession) => {
-    const { week, month } = getCurrentRangeDates();
-
-    const defaultWeekly: Schema_Event_Core = {
-      title: "⭐ That one thing...",
-      isAllDay: false,
-      isSomeday: true,
-      startDate: week.startDate,
-      endDate: week.endDate,
-      priority: Priorities.UNASSIGNED,
-      origin: Origin.COMPASS,
-      description: `... that you wanna do this week, but aren't sure when.\
-      \nKeep it here for safekeeping, then drag it over to the calendar once you're ready to commit times.\
-      \n\nThese sidebar events are:\
-      \n-filtered by the calendar week you're on\
-      \n-limited to ${SOMEDAY_WEEKLY_LIMIT} per week`,
-      user: userId,
-    };
-
-    const weeklyRepeat: Schema_Event_Core = {
-      title: "🪴 Water plants",
-      isAllDay: false,
-      isSomeday: true,
-      startDate: week.startDate,
-      endDate: week.endDate,
-      origin: Origin.COMPASS,
-      priority: Priorities.SELF,
-      description: `This event happens every week.\
-        \n\nRather than repeating forever, however, it'll stop after ${
-          RRULE_COUNT_WEEKS / RRULE_COUNT_MONTHS
-        } months.\
-        \n\nThis encourages frequent re-prioritizing, rather than running on autopilot indefinitely.`,
-      recurrence: {
-        rule: [RRULE.WEEK],
-      },
-      user: userId,
-    };
-
-    const monthlyRepeat: Schema_Event_Core = {
-      isAllDay: false,
-      isSomeday: true,
-      origin: Origin.COMPASS,
-      priority: Priorities.RELATIONS,
-      startDate: month.startDate,
-      endDate: month.endDate,
-      title: "🎲 Schedule game night",
-      recurrence: {
-        rule: [RRULE.MONTH],
-      },
-      description: `This one repeats once a month for ${RRULE_COUNT_MONTHS} months`,
-      user: userId,
-    };
-
-    return CompassSyncProcessor.processEvents(
-      [weeklyRepeat, monthlyRepeat, defaultWeekly].map((e) => {
-        const eventId = new ObjectId().toString();
-
-        return {
-          eventId,
-          userId,
-          payload: { ...e, _id: eventId } as CompassThisEvent["payload"],
-          status: CompassEventStatus.CONFIRMED,
-          applyTo: RecurringEventUpdateScope.THIS_EVENT,
-        };
-      }),
-      session,
-    );
-  };
-
   /*
   Deletes all of a user's events
   REMINDER: this should only delete a user's *Compass* events --

packages/backend/src/user/services/user.service.test.ts

@@ -14,7 +14,6 @@ import calendarService from "@backend/calendar/services/calendar.service";
 import { UserError } from "@backend/common/errors/user/user.errors";
 import { initSupertokens } from "@backend/common/middleware/supertokens.middleware";
 import mongoService from "@backend/common/services/mongo.service";
-import eventService from "@backend/event/services/event.service";
 import priorityService from "@backend/priority/services/priority.service";
 import userMetadataService from "@backend/user/services/user-metadata.service";
 import userService from "@backend/user/services/user.service";
@@ -85,7 +84,6 @@ describe("UserService", () => {
       expect(storedUser).not.toBeNull();
 
       await priorityService.createDefaultPriorities(userId);
-      await eventService.createDefaultSomedays(userId);
       await SyncDriver.createSync(storedUser!, true);
       await userService.startGoogleCalendarSync(userId);
 
@@ -121,7 +119,7 @@ describe("UserService", () => {
   });
 
   describe("initUserData", () => {
-    it("creates the compass user with default resources", async () => {
+    it("creates the compass user with default priorities", async () => {
       const gUser = UserDriver.generateGoogleUser();
 
       EmailDriver.mockEmailServiceResponse();
@@ -141,11 +139,6 @@ describe("UserService", () => {
         .find({ user: userId })
         .toArray();
       expect(priorities.length).toBeGreaterThan(0);
-
-      const somedayEvents = await mongoService.event
-        .find({ user: userId, isSomeday: true })
-        .toArray();
-      expect(somedayEvents.length).toBeGreaterThan(0);
     });
   });
 

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

@@ -155,8 +155,6 @@ class UserService {
 
     await priorityService.createDefaultPriorities(cUser.userId, session);
 
-    await eventService.createDefaultSomedays(cUser.userId, session);
-
     return cUser;
   };
 

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

@@ -1,3 +1,5 @@
+import { DEMO_DATA_SEED_FLAG_KEY } from "@web/common/storage/migrations/external/demo-data-seed";
+
 const COMPASS_LOCAL_DB_NAME = "compass-local";
 
 export async function clearCompassLocalDb(): Promise<void> {
@@ -8,3 +10,14 @@ export async function clearCompassLocalDb(): Promise<void> {
     request.onblocked = () => resolve();
   });
 }
+
+/**
+ * Prepares empty storage for tests that expect no data.
+ * Clears localStorage and IndexedDB, then sets the demo-data-seed migration
+ * flag so it won't seed when storage initializes.
+ */
+export async function prepareEmptyStorageForTests(): Promise<void> {
+  localStorage.clear();
+  await clearCompassLocalDb();
+  localStorage.setItem(DEMO_DATA_SEED_FLAG_KEY, "completed");
+}

packages/web/src/__tests__/utils/storage/mock-storage-adapter.util.ts

@@ -0,0 +1,29 @@
+import { StorageAdapter } from "@web/common/storage/adapter/storage.adapter";
+
+/**
+ * Creates a mock StorageAdapter for tests.
+ *
+ * All methods default to empty results or no-op implementations.
+ * Override specific methods (e.g., getAllEvents, getAllTasks) as needed per test.
+ */
+export function createMockStorageAdapter(): jest.Mocked<StorageAdapter> {
+  return {
+    initialize: jest.fn().mockResolvedValue(undefined),
+    isReady: jest.fn().mockReturnValue(true),
+    getTasks: jest.fn().mockResolvedValue([]),
+    getAllTasks: jest.fn().mockResolvedValue([]),
+    putTasks: jest.fn().mockResolvedValue(undefined),
+    putTask: jest.fn().mockResolvedValue(undefined),
+    deleteTask: jest.fn().mockResolvedValue(undefined),
+    moveTask: jest.fn().mockResolvedValue(undefined),
+    clearAllTasks: jest.fn().mockResolvedValue(undefined),
+    getEvents: jest.fn().mockResolvedValue([]),
+    getAllEvents: jest.fn().mockResolvedValue([]),
+    putEvent: jest.fn().mockResolvedValue(undefined),
+    putEvents: jest.fn().mockResolvedValue(undefined),
+    deleteEvent: jest.fn().mockResolvedValue(undefined),
+    clearAllEvents: jest.fn().mockResolvedValue(undefined),
+    getMigrationRecords: jest.fn().mockResolvedValue([]),
+    setMigrationRecord: jest.fn().mockResolvedValue(undefined),
+  };
+}