fix: remove params from importAllEvents that conflict with nextSyncToken

Although these params would've helped narrow down the events needed to import, they'd prevent us from receiving a nextSyncToken, which would break sync.

There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

See `syncToken` description here: https://developers.google.com/calendar/api/v3/reference/events/list

Author: tyler-dane

packages/backend/src/sync/services/sync.service.helpers.ts

@@ -1,4 +1,3 @@
-import dayjs from "dayjs";
 import { WithId } from "mongodb";
 import { Origin } from "@core/constants/core.constants";
 import { Logger } from "@core/logger/winston.logger";
@@ -7,7 +6,7 @@ import { MapEvent } from "@core/mappers/map.event";
 import { Schema_CalendarList } from "@core/types/calendar.types";
 import {
   gCalendar,
-  gParamsEventsList,
+  gParamsImportAllEvents,
   gSchema$CalendarList,
 } from "@core/types/gcal";
 import { gSchema$CalendarListEntry } from "@core/types/gcal";
@@ -29,7 +28,6 @@ import {
   SyncError,
 } from "@backend/common/constants/error.constants";
 import { error } from "@backend/common/errors/handlers/error.handler";
-import { yearsAgo } from "@backend/common/helpers/common.util";
 import gcalService from "@backend/common/services/gcal/gcal.service";
 import {
   isFullSyncRequired,
@@ -202,26 +200,20 @@ export const hasAnyActiveEventSync = (sync: Schema_Sync) => {
   return false;
 };
 
-export const importEvents = async (
+export const importAllEvents = async (
   userId: string,
   gcal: gCalendar,
   calendarId: string,
 ) => {
   let nextPageToken: string | undefined = undefined;
-  let nextSyncToken: string | null | undefined = undefined;
-  let total = 0;
+  let nextSyncToken: string | undefined = undefined;
 
-  const numYears = 1;
-  const timeMin = yearsAgo(numYears).toISOString();
-  const timeMax = dayjs().add(6, "months").toISOString();
+  let total = 0;
 
   do {
-    const params: gParamsEventsList = {
+    const params: gParamsImportAllEvents = {
       calendarId,
-      timeMin,
-      timeMax,
       singleEvents: true,
-      orderBy: "startTime",
       pageToken: nextPageToken,
     };
 
@@ -242,15 +234,19 @@ export const importEvents = async (
       await eventService.createMany(cEvents);
     }
 
-    nextPageToken = gEvents.data.nextPageToken as string;
-    nextSyncToken = gEvents.data.nextSyncToken;
+    nextPageToken = gEvents.data.nextPageToken ?? undefined;
+    nextSyncToken = gEvents.data.nextSyncToken ?? undefined;
   } while (nextPageToken !== undefined);
 
-  const summary = {
-    total: total,
-    nextSyncToken: nextSyncToken as string,
+  // nextSyncToken is defined when there are no more events
+  if (!nextSyncToken) {
+    throw error(GcalError.NoSyncToken, "Failed to get sync token");
+  }
+
+  return {
+    total,
+    nextSyncToken,
   };
-  return summary;
 };
 
 export const importEventsByCalendar = async (
@@ -276,7 +272,6 @@ export const importEventsByCalendar = async (
 
   do {
     const syncToken = getSyncToken(nextPageToken, nextSyncToken);
-
     const response = await getUpdatedEvents(gcal, gCalendarId, syncToken);
     const updatedEvents = response.items || [];
 
@@ -376,9 +371,11 @@ export const prepSyncMaintenance = async () => {
         ignored.push(userId);
       }
     } else {
-      hasAnyActiveEventSync(sync)
-        ? toPrune.push(sync.user)
-        : ignored.push(userId);
+      if (hasAnyActiveEventSync(sync)) {
+        toPrune.push(sync.user);
+      } else {
+        ignored.push(userId);
+      }
     }
   }
 

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

@@ -30,7 +30,7 @@ import { getChannelExpiration, isUsingHttps } from "../util/sync.utils";
 import {
   assembleEventImports,
   getCalendarInfo,
-  importEvents,
+  importAllEvents,
   importEventsByCalendar,
   prepIncrementalImport,
   prepSyncMaintenance,
@@ -104,7 +104,7 @@ class SyncService {
     userId: string,
   ) => {
     const eventImports = gCalendarIds.map(async (gCalId) => {
-      const { nextSyncToken } = await importEvents(userId, gcal, gCalId);
+      const { nextSyncToken } = await importAllEvents(userId, gcal, gCalId);
       if (isUsingHttps()) {
         await updateSyncTokenFor("events", userId, nextSyncToken, gCalId);
       } else {
@@ -273,6 +273,7 @@ class SyncService {
     watchParams: { gCalId: string; nextSyncToken?: string }[],
     gcal: gCalendar,
   ) => {
+    console.log("starting event watch for:", watchParams);
     const eventWatches = watchParams.map(async (gInfo) => {
       await this.startWatchingGcalEvents(
         userId,

packages/core/src/types/gcal.d.ts

@@ -14,3 +14,21 @@ export declare type gSchema$Events$Union = gSchema$Events | gSchema$Events[];
 
 export declare type gParamsEventsList =
   calendar.calendar_v3.Params$Resource$Events$List;
+
+/**
+ * Params for importing all events from a calendar, excluding those
+ * that would conflict with nextSyncToken
+ *
+ * @see https://developers.google.com/calendar/api/v3/reference/events/list
+ */
+export declare type gParamsImportAllEvents = Omit<
+  gParamsEventsList,
+  | "iCalUID"
+  | "orderBy"
+  | "privateExtendedProperty"
+  | "q"
+  | "sharedExtendedProperty"
+  | "timeMin"
+  | "timeMax"
+  | "updatedMin"
+>;