Files
calendar/packages/features/calendar-subscription/lib/cache/CalendarCacheWrapper.ts
T
Volnei MunhozandGitHub b584f0a9de chore: reduce log spam on Calendars (#26927)
* Remove Vercel warnings on deploy

* reduce log noise
2026-01-16 10:41:00 +00:00

221 lines
7.5 KiB
TypeScript

import type { ICalendarCacheEventRepository } from "@calcom/features/calendar-subscription/lib/cache/CalendarCacheEventRepository.interface";
import logger from "@calcom/lib/logger";
import { metrics } from "@sentry/nextjs";
import type {
Calendar,
CalendarEvent,
CalendarServiceEvent,
EventBusyDate,
GetAvailabilityParams,
IntegrationCalendar,
NewCalendarEventType,
} from "@calcom/types/Calendar";
const log = logger.getSubLogger({ prefix: ["CachedCalendarWrapper"] });
export class CalendarCacheWrapper implements Calendar {
constructor(
private deps: {
originalCalendar: Calendar;
calendarCacheEventRepository: ICalendarCacheEventRepository;
}
) {}
getCredentialId?(): number {
return this.deps.originalCalendar.getCredentialId ? this.deps.originalCalendar.getCredentialId() : -1;
}
createEvent(
event: CalendarServiceEvent,
credentialId: number,
externalCalendarId?: string
): Promise<NewCalendarEventType> {
return this.deps.originalCalendar.createEvent(event, credentialId, externalCalendarId);
}
updateEvent(
uid: string,
event: CalendarServiceEvent,
externalCalendarId?: string | null
): Promise<NewCalendarEventType | NewCalendarEventType[]> {
return this.deps.originalCalendar.updateEvent(uid, event, externalCalendarId);
}
deleteEvent(uid: string, event: CalendarEvent, externalCalendarId?: string | null): Promise<unknown> {
return this.deps.originalCalendar.deleteEvent(uid, event, externalCalendarId);
}
/**
* Retrieves availability combining cache and live sources.
*
* - Calendars **with** both `syncToken` and `syncSubscribedAt` → fetched from cache.
* - Calendars **without** one of them → fetched directly from the original calendar.
* - Results are merged into a single array.
*/
async getAvailability(params: GetAvailabilityParams): Promise<EventBusyDate[]> {
const { dateFrom, dateTo, selectedCalendars } = params;
log.debug("getAvailability (mixed cache + original)", {
dateFrom,
dateTo,
calendarIds: selectedCalendars.map((c) => c.id),
calendarCount: selectedCalendars.length,
});
if (!selectedCalendars?.length) return [];
const withSync = selectedCalendars.filter((c) => c.syncToken && c.syncSubscribedAt);
const withoutSync = selectedCalendars.filter((c) => !c.syncToken || !c.syncSubscribedAt);
const results: EventBusyDate[] = [];
// ===== CACHE PATH =====
if (withSync.length) {
const cacheStartTime = performance.now();
const ids = withSync.map((c) => c.id).filter((id): id is string => Boolean(id));
const cached = await this.deps.calendarCacheEventRepository.findAllBySelectedCalendarIdsBetween(
ids,
new Date(dateFrom),
new Date(dateTo)
);
const cacheDurationMs = performance.now() - cacheStartTime;
results.push(
...cached.map((event) => ({
...event,
timeZone: event.timeZone ?? undefined,
}))
);
metrics.count("calendar.cache.hit.calls", 1);
metrics.distribution("calendar.cache.hit.duration_ms", cacheDurationMs);
metrics.distribution("calendar.cache.hit.events_count", cached.length);
log.debug("Calendar cache fetch completed", {
cachedCalendarCount: withSync.length,
cacheFetchDurationMs: cacheDurationMs,
cachedEventsCount: cached.length,
});
}
// ===== ORIGINAL PATH =====
if (withoutSync.length) {
const originalStartTime = performance.now();
const original = await this.deps.originalCalendar.getAvailability({
dateFrom,
dateTo,
selectedCalendars: withoutSync,
mode: params.mode,
fallbackToPrimary: params.fallbackToPrimary,
});
const originalDurationMs = performance.now() - originalStartTime;
results.push(...original);
metrics.count("calendar.cache.miss.calls", 1);
metrics.distribution("calendar.cache.miss.duration_ms", originalDurationMs);
metrics.distribution("calendar.cache.miss.events_count", original.length);
log.debug("Original calendar fetch completed", {
originalCalendarCount: withoutSync.length,
originalFetchDurationMs: originalDurationMs,
originalEventsCount: original.length,
});
}
metrics.distribution("calendar.getAvailability.total_events_count", results.length);
return results;
}
/**
* Retrieves availability with time zones, combining cache and live data.
*
* - Calendars **with** both `syncToken` and `syncSubscribedAt` → fetched from cache.
* - Calendars **without** one of them → fetched directly from the original calendar.
* - Results are merged into a single array with `{ start, end, timeZone }` format.
*/
async getAvailabilityWithTimeZones(params: GetAvailabilityParams): Promise<EventBusyDate[]> {
const { dateFrom, dateTo, selectedCalendars } = params;
log.debug("getAvailabilityWithTimeZones (mixed cache + original)", {
dateFrom,
dateTo,
calendarIds: selectedCalendars.map((c) => c.id),
calendarCount: selectedCalendars.length,
});
if (!selectedCalendars?.length) return [];
const withSync = selectedCalendars.filter((c) => c.syncToken && c.syncSubscribedAt);
const withoutSync = selectedCalendars.filter((c) => !c.syncToken || !c.syncSubscribedAt);
const results: EventBusyDate[] = [];
if (withSync.length) {
const cacheStartTime = performance.now();
const ids = withSync.map((c) => c.id).filter((id): id is string => Boolean(id));
const cached = await this.deps.calendarCacheEventRepository.findAllBySelectedCalendarIdsBetween(
ids,
new Date(dateFrom),
new Date(dateTo)
);
const cacheDurationMs = performance.now() - cacheStartTime;
results.push(
...cached.map(({ start, end, timeZone }) => ({
start,
end,
timeZone: timeZone || "UTC",
}))
);
metrics.count("calendar.cache.hit.timezone.calls", 1);
metrics.distribution("calendar.cache.hit.timezone.duration_ms", cacheDurationMs);
metrics.distribution("calendar.cache.hit.timezone.events_count", cached.length);
}
if (withoutSync.length) {
const originalStartTime = performance.now();
const original = await this.deps.originalCalendar.getAvailabilityWithTimeZones?.({
dateFrom,
dateTo,
selectedCalendars: withoutSync,
mode: params.mode,
fallbackToPrimary: params.fallbackToPrimary,
});
const originalDurationMs = performance.now() - originalStartTime;
if (original?.length) results.push(...original);
metrics.count("calendar.cache.miss.timezone.calls", 1);
metrics.distribution("calendar.cache.miss.timezone.duration_ms", originalDurationMs);
metrics.distribution("calendar.cache.miss.timezone.events_count", original?.length ?? 0);
}
metrics.distribution("calendar.getAvailabilityWithTimeZones.total_events_count", results.length);
return results;
}
fetchAvailabilityAndSetCache?(selectedCalendars: IntegrationCalendar[]): Promise<unknown> {
return this.deps.originalCalendar.fetchAvailabilityAndSetCache?.(selectedCalendars) || Promise.resolve();
}
listCalendars(event?: CalendarEvent): Promise<IntegrationCalendar[]> {
return this.deps.originalCalendar.listCalendars(event);
}
testDelegationCredentialSetup?(): Promise<boolean> {
return this.deps.originalCalendar.testDelegationCredentialSetup?.() || Promise.resolve(false);
}
}