12690-error-unknown-error-importing-calendar-events-reafcto-required (#12711)

Why : we had an issue impoting events du to CalendarEvents not yet
existing while inserting the CalendarChannelAssociation due to inverted
method in the service

This PR refactors the calendar event import logic by 
- renaming 
- splitting utility functions for better clarity and maintainability. 
- adding TSDoc comments to explain the purpose and uniqueness of the
`eventExternalId` field in calendar event associations


Fixes #12690

---------

Co-authored-by: Charles Bochet <[email protected]>

Author: 2 people

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/google-calendar/utils/__tests__/format-google-calendar-event.util.spec.ts

@@ -59,7 +59,7 @@ describe('formatGoogleCalendarEvents', () => {
     expect(formattedEvent.isFullDay).toBe(false);
     expect(formattedEvent.startsAt).toBe('2023-01-15T14:00:00Z');
     expect(formattedEvent.endsAt).toBe('2023-01-15T15:00:00Z');
-    expect(formattedEvent.externalId).toBe('event123');
+    expect(formattedEvent.id).toBe('event123');
     expect(formattedEvent.conferenceSolution).toBe('hangoutsMeet');
     expect(formattedEvent.conferenceLinkUrl).toBe(
       'https://meet.google.com/abc-defg-hij',

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/google-calendar/utils/format-google-calendar-event.util.ts

@@ -2,17 +2,17 @@ import { calendar_v3 as calendarV3 } from 'googleapis';
 
 import { sanitizeCalendarEvent } from 'src/modules/calendar/calendar-event-import-manager/drivers/utils/sanitizeCalendarEvent';
 import { CalendarEventParticipantResponseStatus } from 'src/modules/calendar/common/standard-objects/calendar-event-participant.workspace-entity';
-import { CalendarEventWithParticipants } from 'src/modules/calendar/common/types/calendar-event';
+import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
 
 export const formatGoogleCalendarEvents = (
   events: calendarV3.Schema$Event[],
-): CalendarEventWithParticipants[] => {
+): FetchedCalendarEvent[] => {
   return events.map(formatGoogleCalendarEvent);
 };
 
 const formatGoogleCalendarEvent = (
   event: calendarV3.Schema$Event,
-): CalendarEventWithParticipants => {
+): FetchedCalendarEvent => {
   const formatResponseStatus = (status: string | null | undefined) => {
     switch (status) {
       case 'accepted':
@@ -27,15 +27,15 @@ const formatGoogleCalendarEvent = (
   };
 
   // Create the event object
-  const calendarEvent: CalendarEventWithParticipants = {
+  const calendarEvent: FetchedCalendarEvent = {
     title: event.summary ?? '',
     isCanceled: event.status === 'cancelled',
     isFullDay: event.start?.dateTime == null,
-    startsAt: event.start?.dateTime ?? event.start?.date ?? null,
-    endsAt: event.end?.dateTime ?? event.end?.date ?? null,
-    externalId: event.id ?? '',
-    externalCreatedAt: event.created ?? null,
-    externalUpdatedAt: event.updated ?? null,
+    startsAt: event.start?.dateTime ?? event.start?.date ?? '',
+    endsAt: event.end?.dateTime ?? event.end?.date ?? '',
+    id: event.id ?? '',
+    externalCreatedAt: event.created ?? '',
+    externalUpdatedAt: event.updated ?? '',
     description: event.description ?? '',
     location: event.location ?? '',
     iCalUID: event.iCalUID ?? '',
@@ -54,11 +54,11 @@ const formatGoogleCalendarEvent = (
     status: event.status ?? '',
   };
 
-  const propertiesToSanitize: (keyof CalendarEventWithParticipants)[] = [
+  const propertiesToSanitize: (keyof FetchedCalendarEvent)[] = [
     'title',
     'startsAt',
     'endsAt',
-    'externalId',
+    'id',
     'externalCreatedAt',
     'externalUpdatedAt',
     'description',

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/services/microsoft-calendar-import-events.service.ts

@@ -4,7 +4,7 @@ import { Event } from '@microsoft/microsoft-graph-types';
 
 import { formatMicrosoftCalendarEvents } from 'src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/format-microsoft-calendar-event.util';
 import { parseMicrosoftCalendarError } from 'src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/parse-microsoft-calendar-error.util';
-import { CalendarEventWithParticipants } from 'src/modules/calendar/common/types/calendar-event';
+import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
 import { MicrosoftOAuth2ClientManagerService } from 'src/modules/connected-account/oauth2-client-manager/drivers/microsoft/microsoft-oauth2-client-manager.service';
 import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
 
@@ -20,7 +20,7 @@ export class MicrosoftCalendarImportEventsService {
       'provider' | 'refreshToken' | 'id'
     >,
     changedEventIds: string[],
-  ): Promise<CalendarEventWithParticipants[]> {
+  ): Promise<FetchedCalendarEvent[]> {
     try {
       const microsoftClient =
         await this.microsoftOAuth2ClientManagerService.getOAuth2Client(

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/__tests__/format-microsoft-calendar-event.util.spec.ts

@@ -66,7 +66,7 @@ describe('formatMicrosoftCalendarEvents', () => {
     expect(formattedEvent.isFullDay).toBe(false);
     expect(formattedEvent.startsAt).toBe('2023-01-15T14:00:00Z');
     expect(formattedEvent.endsAt).toBe('2023-01-15T15:00:00Z');
-    expect(formattedEvent.externalId).toBe('event123');
+    expect(formattedEvent.id).toBe('event123');
     expect(formattedEvent.conferenceSolution).toBe('teamsForBusiness');
     expect(formattedEvent.conferenceLinkUrl).toBe(
       'https://teams.microsoft.com/l/meetup-join/abc123',

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/format-microsoft-calendar-event.util.ts

@@ -6,17 +6,15 @@ import {
 
 import { sanitizeCalendarEvent } from 'src/modules/calendar/calendar-event-import-manager/drivers/utils/sanitizeCalendarEvent';
 import { CalendarEventParticipantResponseStatus } from 'src/modules/calendar/common/standard-objects/calendar-event-participant.workspace-entity';
-import { CalendarEventWithParticipants } from 'src/modules/calendar/common/types/calendar-event';
+import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
 
 export const formatMicrosoftCalendarEvents = (
   events: Event[],
-): CalendarEventWithParticipants[] => {
+): FetchedCalendarEvent[] => {
   return events.map(formatMicrosoftCalendarEvent);
 };
 
-const formatMicrosoftCalendarEvent = (
-  event: Event,
-): CalendarEventWithParticipants => {
+const formatMicrosoftCalendarEvent = (event: Event): FetchedCalendarEvent => {
   const formatResponseStatus = (
     status: NullableOption<ResponseType> | undefined,
   ) => {
@@ -33,15 +31,15 @@ const formatMicrosoftCalendarEvent = (
     }
   };
 
-  const calendarEvent: CalendarEventWithParticipants = {
+  const calendarEvent: FetchedCalendarEvent = {
     title: event.subject ?? '',
     isCanceled: !!event.isCancelled,
     isFullDay: !!event.isAllDay,
-    startsAt: event.start?.dateTime ?? null,
-    endsAt: event.end?.dateTime ?? null,
-    externalId: event.id ?? '',
-    externalCreatedAt: event.createdDateTime ?? null,
-    externalUpdatedAt: event.lastModifiedDateTime ?? null,
+    startsAt: event.start?.dateTime ?? '',
+    endsAt: event.end?.dateTime ?? '',
+    id: event.id ?? '',
+    externalCreatedAt: event.createdDateTime ?? '',
+    externalUpdatedAt: event.lastModifiedDateTime ?? '',
     description: event.body?.content ?? '',
     location: event.location?.displayName ?? '',
     iCalUID: event.iCalUId ?? '',
@@ -59,11 +57,11 @@ const formatMicrosoftCalendarEvent = (
     status: '',
   };
 
-  const propertiesToSanitize: (keyof CalendarEventWithParticipants)[] = [
+  const propertiesToSanitize: (keyof FetchedCalendarEvent)[] = [
     'title',
     'startsAt',
     'endsAt',
-    'externalId',
+    'id',
     'externalCreatedAt',
     'externalUpdatedAt',
     'description',

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/services/calendar-events-import.service.ts

@@ -21,7 +21,7 @@ import { filterEventsAndReturnCancelledEvents } from 'src/modules/calendar/calen
 import { CalendarChannelSyncStatusService } from 'src/modules/calendar/common/services/calendar-channel-sync-status.service';
 import { CalendarChannelEventAssociationWorkspaceEntity } from 'src/modules/calendar/common/standard-objects/calendar-channel-event-association.workspace-entity';
 import { CalendarChannelWorkspaceEntity } from 'src/modules/calendar/common/standard-objects/calendar-channel.workspace-entity';
-import { CalendarEventWithParticipants } from 'src/modules/calendar/common/types/calendar-event';
+import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
 import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
 
 @Injectable()
@@ -43,13 +43,13 @@ export class CalendarEventsImportService {
     calendarChannel: CalendarChannelWorkspaceEntity,
     connectedAccount: ConnectedAccountWorkspaceEntity,
     workspaceId: string,
-    fetchedCalendarEvents?: CalendarEventWithParticipants[],
+    fetchedCalendarEvents?: FetchedCalendarEvent[],
   ): Promise<void> {
     await this.calendarChannelSyncStatusService.markAsCalendarEventsImportOngoing(
       [calendarChannel.id],
     );
 
-    let calendarEvents: CalendarEventWithParticipants[] = [];
+    let calendarEvents: FetchedCalendarEvent[] = [];
 
     try {
       if (fetchedCalendarEvents) {
@@ -103,7 +103,7 @@ export class CalendarEventsImportService {
         );
 
       const cancelledEventExternalIds = cancelledEvents.map(
-        (event) => event.externalId,
+        (event) => event.id,
       );
 
       const BATCH_SIZE = 1000;

packages/twenty-server/src/modules/calendar/calendar-event-import-manager/services/calendar-get-events.service.ts

@@ -8,12 +8,12 @@ import {
   CalendarEventImportException,
   CalendarEventImportExceptionCode,
 } from 'src/modules/calendar/calendar-event-import-manager/exceptions/calendar-event-import.exception';
-import { CalendarEventWithParticipants } from 'src/modules/calendar/common/types/calendar-event';
+import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
 import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
 
 export type GetCalendarEventsResponse = {
   fullEvents: boolean;
-  calendarEvents?: CalendarEventWithParticipants[];
+  calendarEvents?: FetchedCalendarEvent[];
   calendarEventIds?: string[];
   nextSyncCursor: string;
 };