* refactor: replace shouldServeCache with mode parameter for calendar cache control Replace the boolean shouldServeCache parameter with a new CalendarFetchMode type that can have values 'slots', 'overlay', and 'booking'. This provides better control over when to serve cache vs relay on calendar providers. - 'slots' mode: Check feature flags and use cache when available (for getting actual calendar availability) - 'overlay' mode: Don't use cache (for overlay calendar availability) - 'booking' mode: Don't use cache (for booking confirmation) - undefined: Same as 'slots' for backwards compatibility The cache decision logic is now centralized in getCalendar.ts based on the mode parameter. Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: update CalendarService.test.ts to use mode parameter Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: use shared GetAvailabilityParams type across all calendar services - Import GetAvailabilityParams and GetAvailabilityWithTimeZonesParams from @calcom/types/Calendar - Replace inline type definitions with shared types in all calendar service implementations - Update BaseCalendarService, CalendarCacheWrapper, and CalendarTelemetryWrapper - Ensures consistent typing and follows DRY principles Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: add missing IntegrationCalendar import and update mock getAvailability signature - Add IntegrationCalendar back to sendgrid CalendarService imports - Update bookingScenario mock getAvailability to use typed params object - Add listCalendars method to mock Calendar object Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: update test files to use typed params object for getAvailability methods - Update CalendarCacheWrapper.test.ts to call getAvailability/getAvailabilityWithTimeZones with params object - Update getCalendarsEvents.test.ts toHaveBeenCalledWith assertions to expect params object - All 32 tests now pass Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: consolidate to single GetAvailabilityParams type for both getAvailability methods - Remove GetAvailabilityWithTimeZonesParams, use GetAvailabilityParams for both methods - Add mode parameter to getAvailabilityWithTimeZones calls - Update wrapper classes to pass mode through to underlying calendar - Update test files to include mode in getAvailabilityWithTimeZones calls and assertions Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: use EventBusyDate with optional timeZone for getAvailabilityWithTimeZones - Add optional timeZone field to EventBusyDate type - Update getAvailabilityWithTimeZones return type to use EventBusyDate[] - Update Google Calendar service and wrapper classes to use the new type Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: type errors and remove unused calendar watching methods - Fix type errors in CalendarCacheWrapper.ts (convert null to undefined for timeZone) - Fix type errors in getCalendarsEvents.ts (ensure timeZone is always present) - Remove unused watchCalendar/unwatchCalendar from Calendar interface - Remove unused startWatchingCalendarsInGoogle/stopWatchingCalendarsInGoogle from GoogleCalendarService - Remove unused imports (uuid, uniqueBy, GOOGLE_WEBHOOK_URL, ONE_MONTH_IN_MS) Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: remove watchCalendar/unwatchCalendar from CalendarTelemetryWrapper Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: remove verbose JSDoc param comments from wrapper classes Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: make mode parameter required in getCalendar Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: add required mode parameter to all getCalendar callers Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: provide default mode value in getBusyCalendarTimes Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: add mode parameter to remaining getCalendar callers Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: add mode parameter to vital and wipemycalother reschedule Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * fix: add mode parameter to credential-sync API endpoint Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * refactor: add 'none' mode to CalendarFetchMode and use as default Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * test: add mode parameter to getCalendarsEvents test calls Co-Authored-By: Volnei Munhoz <volnei.munhoz@gmail.com> * Update packages/app-store/delegationCredential.ts Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
120 lines
4.8 KiB
TypeScript
120 lines
4.8 KiB
TypeScript
import { CalendarSubscriptionService } from "@calcom/features/calendar-subscription/lib/CalendarSubscriptionService";
|
|
import { CalendarCacheEventRepository } from "@calcom/features/calendar-subscription/lib/cache/CalendarCacheEventRepository";
|
|
import { CalendarCacheEventService } from "@calcom/features/calendar-subscription/lib/cache/CalendarCacheEventService";
|
|
import { CalendarCacheWrapper } from "@calcom/features/calendar-subscription/lib/cache/CalendarCacheWrapper";
|
|
import { CalendarTelemetryWrapper } from "@calcom/features/calendar-subscription/lib/telemetry/CalendarTelemetryWrapper";
|
|
import { FeaturesRepository } from "@calcom/features/flags/features.repository";
|
|
import logger from "@calcom/lib/logger";
|
|
import { isTelemetryEnabled } from "@calcom/lib/sentryWrapper";
|
|
import { prisma } from "@calcom/prisma";
|
|
import type { Calendar, CalendarFetchMode } from "@calcom/types/Calendar";
|
|
import type { CredentialForCalendarService } from "@calcom/types/Credential";
|
|
|
|
import { CalendarServiceMap } from "../calendar.services.generated";
|
|
|
|
const log = logger.getSubLogger({ prefix: ["CalendarManager"] });
|
|
|
|
export const getCalendar = async (
|
|
credential: CredentialForCalendarService | null,
|
|
mode: CalendarFetchMode = "none"
|
|
): Promise<Calendar | null> => {
|
|
if (!credential || !credential.key) return null;
|
|
let { type: calendarType } = credential;
|
|
if (calendarType?.endsWith("_other_calendar")) {
|
|
calendarType = calendarType.split("_other_calendar")[0];
|
|
}
|
|
// Backwards compatibility until CRM manager is created
|
|
if (calendarType?.endsWith("_crm")) {
|
|
calendarType = calendarType.split("_crm")[0];
|
|
}
|
|
|
|
const calendarAppImportFn =
|
|
CalendarServiceMap[calendarType.split("_").join("") as keyof typeof CalendarServiceMap];
|
|
|
|
if (!calendarAppImportFn) {
|
|
log.warn(`calendar of type ${calendarType} is not implemented`);
|
|
return null;
|
|
}
|
|
|
|
const calendarApp = await calendarAppImportFn;
|
|
|
|
const CalendarService = calendarApp.default;
|
|
|
|
if (!CalendarService || typeof CalendarService !== "function") {
|
|
log.warn(`calendar of type ${calendarType} is not implemented`);
|
|
return null;
|
|
}
|
|
|
|
// Determine if we should use cache based on mode:
|
|
// - "slots": Check feature flags and use cache when available (for getting actual calendar availability)
|
|
// - "overlay": Don't use cache (for overlay calendar availability)
|
|
// - "booking": Don't use cache (for booking confirmation)
|
|
// - "none": Don't use cache (for operations that don't use getAvailability, e.g., deleteEvent, listCalendars)
|
|
let shouldServeCache = false;
|
|
if (mode === "slots") {
|
|
const featuresRepository = new FeaturesRepository(prisma);
|
|
const [isCalendarSubscriptionCacheEnabled, isCalendarSubscriptionCacheEnabledForUser] = await Promise.all(
|
|
[
|
|
featuresRepository.checkIfFeatureIsEnabledGlobally(
|
|
CalendarSubscriptionService.CALENDAR_SUBSCRIPTION_CACHE_FEATURE
|
|
),
|
|
featuresRepository.checkIfUserHasFeatureNonHierarchical(
|
|
credential.userId as number,
|
|
CalendarSubscriptionService.CALENDAR_SUBSCRIPTION_CACHE_FEATURE
|
|
),
|
|
]
|
|
);
|
|
shouldServeCache = isCalendarSubscriptionCacheEnabled && isCalendarSubscriptionCacheEnabledForUser;
|
|
log.debug("Cache feature flag check", {
|
|
credentialId: credential.id,
|
|
userId: credential.userId,
|
|
mode,
|
|
isCalendarSubscriptionCacheEnabled,
|
|
isCalendarSubscriptionCacheEnabledForUser,
|
|
shouldServeCache,
|
|
});
|
|
} else {
|
|
log.debug("Cache disabled for mode", {
|
|
credentialId: credential.id,
|
|
userId: credential.userId,
|
|
mode,
|
|
});
|
|
}
|
|
|
|
const isCacheSupported = CalendarCacheEventService.isCalendarTypeSupported(calendarType);
|
|
|
|
const originalCalendar = new CalendarService(credential as any);
|
|
|
|
// Determine if we should use cache
|
|
const useCache = isCacheSupported && shouldServeCache;
|
|
|
|
// Build the calendar chain: original -> cache (if enabled) -> telemetry (if enabled)
|
|
let calendar: Calendar = originalCalendar;
|
|
|
|
if (useCache) {
|
|
log.info(`Calendar Cache is enabled, using CalendarCacheWrapper for credential ${credential.id}`);
|
|
const calendarCacheEventRepository = new CalendarCacheEventRepository(prisma);
|
|
calendar = new CalendarCacheWrapper({
|
|
originalCalendar: calendar,
|
|
calendarCacheEventRepository,
|
|
});
|
|
}
|
|
|
|
// Wrap ALL calendars with telemetry when telemetry is enabled
|
|
// This provides consistent metrics for all calendar types
|
|
if (isTelemetryEnabled()) {
|
|
log.info(
|
|
`Using CalendarTelemetryWrapper for credential ${credential.id} (cacheSupported: ${isCacheSupported}, cacheEnabled: ${useCache})`
|
|
);
|
|
calendar = new CalendarTelemetryWrapper({
|
|
originalCalendar: calendar,
|
|
calendarType,
|
|
cacheSupported: isCacheSupported,
|
|
cacheEnabled: useCache,
|
|
credentialId: credential.id,
|
|
});
|
|
}
|
|
|
|
return calendar;
|
|
};
|