feat(sync): enhance Google Calendar sync process with forced restart option (#1425)

- Updated `restartGoogleCalendarSync` method to accept an options parameter for forced synchronization.
- Modified error handling in `SyncController` and `error.express.handler` to utilize the new forced restart functionality.
- Enhanced tests to cover scenarios for both forced and non-forced sync operations, ensuring correct behavior based on user import status.

This change improves the flexibility of the Google Calendar synchronization process, allowing for more robust handling of sync operations in various states.

Author: tyler-dane

packages/backend/src/common/errors/handlers/error.express.handler.ts

@@ -119,12 +119,14 @@ const handleGoogleError = async (
   }
 
   if (isFullSyncRequired(e)) {
-    userService.restartGoogleCalendarSync(userId).catch((err) => {
-      logger.error(
-        `Something went wrong with resyncing google calendars for user: ${userId}`,
-        err,
-      );
-    });
+    userService
+      .restartGoogleCalendarSync(userId, { force: true })
+      .catch((err) => {
+        logger.error(
+          `Something went wrong with resyncing google calendars for user: ${userId}`,
+          err,
+        );
+      });
 
     res.status(Status.BAD_REQUEST).send({ message: "Full sync in progress." });
 

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

@@ -105,12 +105,14 @@ export class SyncController {
           return;
         } else if (isFullSyncRequired(e as Error) && userId) {
           // do not await this call
-          userService.restartGoogleCalendarSync(userId).catch((err) => {
-            logger.error(
-              `Something went wrong with resyncing google calendars for user: ${userId}`,
-              err,
-            );
-          });
+          userService
+            .restartGoogleCalendarSync(userId, { force: true })
+            .catch((err) => {
+              logger.error(
+                `Something went wrong with resyncing google calendars for user: ${userId}`,
+                err,
+              );
+            });
 
           res.status(Status.OK).send({ message: "Full sync in progress." });
 

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

@@ -142,7 +142,7 @@ export const refreshWatch = async (
       };
     } catch (e) {
       if (isFullSyncRequired(e as Error)) {
-        userService.restartGoogleCalendarSync(r.user);
+        userService.restartGoogleCalendarSync(r.user, { force: true });
         resynced = true;
       } else {
         logger.error(

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

@@ -223,6 +223,58 @@ describe("UserService", () => {
       const calendars = await calendarService.getByUser(userId);
       expect(calendars.length).toBeGreaterThan(0);
     });
+
+    it("skips restart when import is completed and not forced", async () => {
+      const { user } = await UtilDriver.setupTestUser();
+      const userId = user._id.toString();
+
+      await userMetadataService.updateUserMetadata({
+        userId,
+        data: { sync: { importGCal: "completed" } },
+      });
+
+      const stopSpy = jest.spyOn(userService, "stopGoogleCalendarSync");
+      const startSpy = jest.spyOn(userService, "startGoogleCalendarSync");
+
+      await userService.restartGoogleCalendarSync(userId);
+
+      expect(stopSpy).not.toHaveBeenCalled();
+      expect(startSpy).not.toHaveBeenCalled();
+
+      const metadata = await userMetadataService.fetchUserMetadata(userId);
+      expect(metadata.sync?.importGCal).toBe("completed");
+
+      stopSpy.mockRestore();
+      startSpy.mockRestore();
+    });
+
+    it("forces restart when import is completed", async () => {
+      const { user } = await UtilDriver.setupTestUser();
+      const userId = user._id.toString();
+
+      await userMetadataService.updateUserMetadata({
+        userId,
+        data: { sync: { importGCal: "completed" } },
+      });
+
+      const stopSpy = jest
+        .spyOn(userService, "stopGoogleCalendarSync")
+        .mockResolvedValue();
+      const startSpy = jest
+        .spyOn(userService, "startGoogleCalendarSync")
+        .mockResolvedValue({ eventsCount: 0, calendarsCount: 0 });
+
+      await userService.restartGoogleCalendarSync(userId, { force: true });
+
+      expect(stopSpy).toHaveBeenCalledWith(userId);
+      expect(startSpy).toHaveBeenCalledWith(userId);
+
+      const metadata = await userMetadataService.fetchUserMetadata(userId);
+      expect(metadata.sync?.importGCal).toBe("completed");
+
+      stopSpy.mockRestore();
+      startSpy.mockRestore();
+    });
   });
 
   describe("updateUserMetadata", () => {

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

@@ -212,14 +212,23 @@ class UserService {
     };
   };
 
-  restartGoogleCalendarSync = async (userId: string) => {
-    logger.warn(`Restarting Google Calendar sync for user: ${userId}`);
+  restartGoogleCalendarSync = async (
+    userId: string,
+    options: { force?: boolean } = {},
+  ) => {
+    const isForce = options.force === true;
+
+    logger.warn(
+      `Restarting Google Calendar sync for user: ${userId}${isForce ? " (forced)" : ""}`,
+    );
 
     try {
       webSocketServer.handleImportGCalStart(userId);
 
       const userMeta = await userMetadataService.fetchUserMetadata(userId);
-      const proceed = shouldImportGCal(userMeta);
+      const importStatus = userMeta.sync?.importGCal;
+      const isImporting = importStatus === "importing";
+      const proceed = isForce ? !isImporting : shouldImportGCal(userMeta);
 
       if (!proceed) {
         webSocketServer.handleImportGCalEnd(