Files
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

511 lines
15 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { fetchWithRetry, VALIDATE_RETRY_OPTIONS } from '@/lib/knowledge/documents/utils'
import { DEFAULT_MAX_EVENTS, googleCalendarConnectorMeta } from '@/connectors/google-calendar/meta'
import type { ConnectorConfig, ExternalDocument, ExternalDocumentList } from '@/connectors/types'
import { parseMultiValue, parseTagDate } from '@/connectors/utils'
const logger = createLogger('GoogleCalendarConnector')
const CALENDAR_API_BASE = 'https://www.googleapis.com/calendar/v3'
const DEFAULT_RANGE_DAYS = 30
const PAGE_SIZE = 250
interface CalendarEventTime {
date?: string
dateTime?: string
timeZone?: string
}
interface CalendarAttendee {
email?: string
displayName?: string
responseStatus?: string
self?: boolean
resource?: boolean
optional?: boolean
}
interface CalendarEvent {
id: string
status?: string
htmlLink?: string
created?: string
updated?: string
summary?: string
description?: string
location?: string
creator?: { email?: string; displayName?: string }
organizer?: { email?: string; displayName?: string; self?: boolean }
start?: CalendarEventTime
end?: CalendarEventTime
attendees?: CalendarAttendee[]
recurringEventId?: string
eventType?: string
}
/**
* Formats a CalendarEventTime into a human-readable string.
* All-day events use the date field; timed events use dateTime.
*/
function formatEventTime(eventTime?: CalendarEventTime): string {
if (!eventTime) return 'Unknown'
if (eventTime.dateTime) {
const date = new Date(eventTime.dateTime)
return date.toLocaleString('en-US', {
weekday: 'long',
year: 'numeric',
month: 'long',
day: 'numeric',
hour: 'numeric',
minute: '2-digit',
timeZoneName: 'short',
timeZone: eventTime.timeZone || undefined,
})
}
if (eventTime.date) {
const date = new Date(`${eventTime.date}T00:00:00`)
return date.toLocaleDateString('en-US', {
weekday: 'long',
year: 'numeric',
month: 'long',
day: 'numeric',
})
}
return 'Unknown'
}
/**
* Determines whether the event is all-day based on whether `date` (not `dateTime`) is used.
*/
function isAllDayEvent(event: CalendarEvent): boolean {
return Boolean(event.start?.date && !event.start?.dateTime)
}
/**
* Formats attendees into a comma-separated list of names/emails.
*/
function formatAttendees(attendees?: CalendarAttendee[]): string {
if (!attendees || attendees.length === 0) return ''
return attendees
.filter((a) => !a.resource)
.map((a) => a.displayName || a.email || 'Unknown')
.join(', ')
}
/**
* Formats an organizer into a display string.
*/
function formatOrganizer(organizer?: { email?: string; displayName?: string }): string {
if (!organizer) return ''
if (organizer.displayName && organizer.email) {
return `${organizer.displayName} (${organizer.email})`
}
return organizer.displayName || organizer.email || ''
}
/**
* Builds a readable content string from a calendar event.
*/
function eventToContent(event: CalendarEvent): string {
const parts: string[] = []
parts.push(`Event: ${event.summary || 'Untitled Event'}`)
if (isAllDayEvent(event)) {
parts.push(`Date: ${formatEventTime(event.start)} (All Day)`)
} else {
parts.push(`Date: ${formatEventTime(event.start)} - ${formatEventTime(event.end)}`)
}
if (event.location) {
parts.push(`Location: ${event.location}`)
}
const organizer = formatOrganizer(event.organizer)
if (organizer) {
parts.push(`Organizer: ${organizer}`)
}
const attendees = formatAttendees(event.attendees)
if (attendees) {
parts.push(`Attendees: ${attendees}`)
}
if (event.description) {
parts.push('')
parts.push('Description:')
parts.push(
event.description
.replace(/<[^>]*>/g, ' ')
.replace(/\s+/g, ' ')
.trim()
)
}
return parts.join('\n')
}
/**
* Computes the default time range boundaries: 30 days in the past to 30 days in the future.
*/
function getDefaultTimeRange(): { timeMin: string; timeMax: string } {
const now = new Date()
const past = new Date(now)
past.setDate(past.getDate() - DEFAULT_RANGE_DAYS)
const future = new Date(now)
future.setDate(future.getDate() + DEFAULT_RANGE_DAYS)
return {
timeMin: past.toISOString(),
timeMax: future.toISOString(),
}
}
/**
* Parses the date range config into timeMin/timeMax values.
*/
function getTimeRange(sourceConfig: Record<string, unknown>): { timeMin: string; timeMax: string } {
const dateRange = (sourceConfig.dateRange as string) || 'default'
const now = new Date()
switch (dateRange) {
case 'past_only': {
const past = new Date(now)
past.setDate(past.getDate() - DEFAULT_RANGE_DAYS)
return { timeMin: past.toISOString(), timeMax: now.toISOString() }
}
case 'future_only': {
const future = new Date(now)
future.setDate(future.getDate() + DEFAULT_RANGE_DAYS)
return { timeMin: now.toISOString(), timeMax: future.toISOString() }
}
case 'past_90': {
const past = new Date(now)
past.setDate(past.getDate() - 90)
const future = new Date(now)
future.setDate(future.getDate() + 90)
return { timeMin: past.toISOString(), timeMax: future.toISOString() }
}
default:
return getDefaultTimeRange()
}
}
/**
* Converts a CalendarEvent to an ExternalDocument.
*
* Backward compatibility: when only a single calendar is configured (the only
* code path that existed before multi-calendar support), externalId and
* contentHash use the legacy non-namespaced format so existing connectors see
* zero churn on re-sync. When 2+ calendars are configured, we namespace by
* calendarId because Google Calendar event IDs are only unique within a
* single calendar.
*/
function eventToDocument(
event: CalendarEvent,
calendarId: string,
isMultiCalendar: boolean
): ExternalDocument | null {
if (event.status === 'cancelled') return null
const content = eventToContent(event)
if (!content.trim()) return null
const startTime = event.start?.dateTime || event.start?.date || ''
const attendeeCount = event.attendees?.filter((a) => !a.resource).length || 0
const externalId = isMultiCalendar ? `${calendarId}:${event.id}` : event.id
const contentHash = isMultiCalendar
? `gcal:${calendarId}:${event.id}:${event.updated ?? ''}`
: `gcal:${event.id}:${event.updated ?? ''}`
return {
externalId,
title: event.summary || 'Untitled Event',
content,
mimeType: 'text/plain',
sourceUrl: event.htmlLink || `https://calendar.google.com/calendar/event?eid=${event.id}`,
contentHash,
metadata: {
calendarId,
startTime,
endTime: event.end?.dateTime || event.end?.date || '',
location: event.location || '',
organizer: formatOrganizer(event.organizer),
attendeeCount,
isAllDay: isAllDayEvent(event),
eventDate: startTime,
updatedTime: event.updated,
createdTime: event.created,
},
}
}
export const googleCalendarConnector: ConnectorConfig = {
...googleCalendarConnectorMeta,
listDocuments: async (
accessToken: string,
sourceConfig: Record<string, unknown>,
cursor?: string,
syncContext?: Record<string, unknown>
): Promise<ExternalDocumentList> => {
const parsedCalendarIds = parseMultiValue(sourceConfig.calendarId)
const calendarIds = parsedCalendarIds.length > 0 ? parsedCalendarIds : ['primary']
const { timeMin, timeMax } = getTimeRange(sourceConfig)
const searchQuery = (sourceConfig.searchQuery as string) || ''
/**
* Cursor format:
* - For a single calendar with legacy cursors: the raw pageToken string
* - For multi-calendar walking: JSON-encoded { calendarIndex, pageToken }
*/
let calendarIndex = 0
let pageToken: string | undefined
if (cursor) {
try {
const parsed = JSON.parse(cursor) as { calendarIndex: number; pageToken?: string }
if (typeof parsed.calendarIndex === 'number') {
calendarIndex = parsed.calendarIndex
pageToken = parsed.pageToken
} else {
pageToken = cursor
}
} catch {
pageToken = cursor
}
}
if (calendarIndex >= calendarIds.length) {
return { documents: [], hasMore: false }
}
const calendarId = calendarIds[calendarIndex]
const queryParams = new URLSearchParams({
singleEvents: 'true',
orderBy: 'startTime',
maxResults: String(PAGE_SIZE),
timeMin,
timeMax,
})
if (searchQuery.trim()) {
queryParams.set('q', searchQuery.trim())
}
if (pageToken) {
queryParams.set('pageToken', pageToken)
}
const url = `${CALENDAR_API_BASE}/calendars/${encodeURIComponent(calendarId)}/events?${queryParams.toString()}`
logger.info('Listing Google Calendar events', {
calendarId,
calendarIndex,
calendarCount: calendarIds.length,
timeMin,
timeMax,
hasPageToken: Boolean(pageToken),
})
const response = await fetchWithRetry(url, {
method: 'GET',
headers: {
Authorization: `Bearer ${accessToken}`,
Accept: 'application/json',
},
})
if (!response.ok) {
const errorText = await response.text()
logger.error('Failed to list Google Calendar events', {
status: response.status,
calendarId,
error: errorText,
})
throw new Error(`Failed to list Google Calendar events: ${response.status}`)
}
const data = await response.json()
const events = (data.items || []) as CalendarEvent[]
const isMultiCalendar = calendarIds.length > 1
const documents: ExternalDocument[] = []
for (const event of events) {
const doc = eventToDocument(event, calendarId, isMultiCalendar)
if (doc) documents.push(doc)
}
const totalFetched = ((syncContext?.totalDocsFetched as number) ?? 0) + documents.length
if (syncContext) syncContext.totalDocsFetched = totalFetched
const maxEvents = sourceConfig.maxEvents ? Number(sourceConfig.maxEvents) : DEFAULT_MAX_EVENTS
const hitLimit = maxEvents > 0 && totalFetched >= maxEvents
const nextPageToken = data.nextPageToken as string | undefined
if (hitLimit) {
return { documents, hasMore: false }
}
if (nextPageToken) {
return {
documents,
nextCursor: JSON.stringify({ calendarIndex, pageToken: nextPageToken }),
hasMore: true,
}
}
const nextCalendarIndex = calendarIndex + 1
if (nextCalendarIndex < calendarIds.length) {
return {
documents,
nextCursor: JSON.stringify({ calendarIndex: nextCalendarIndex }),
hasMore: true,
}
}
return { documents, hasMore: false }
},
getDocument: async (
accessToken: string,
sourceConfig: Record<string, unknown>,
externalId: string
): Promise<ExternalDocument | null> => {
/**
* externalId format depends on connector configuration:
* - Single-calendar (1 calendar configured): externalId = eventId (legacy
* and current single-calendar format).
* - Multi-calendar (2+ calendars configured): externalId =
* `calendarId:eventId`. The first `:` is the separator — event IDs never
* contain `:` while calendar IDs (e.g. `user@group.calendar.google.com`)
* may include URL-safe chars but not `:`.
*
* Legacy in-flight rows that lack a separator fall back to the configured
* calendar (or `primary`).
*/
const parsedCalendarIds = parseMultiValue(sourceConfig.calendarId)
const calendarIds = parsedCalendarIds.length > 0 ? parsedCalendarIds : ['primary']
/**
* Derive `isMultiCalendar` from the externalId itself, not from the current
* config. If a row was synced under a multi-calendar config and the user
* later removed calendars, the row's externalId still has the prefix —
* returning a doc without the prefix would mint a duplicate via the sync
* engine's externalId-keyed matching.
*/
const separatorIndex = externalId.indexOf(':')
const isMultiCalendar = separatorIndex !== -1
let calendarId: string
let eventId: string
if (separatorIndex === -1) {
calendarId = calendarIds[0] ?? 'primary'
eventId = externalId
} else {
calendarId = externalId.slice(0, separatorIndex)
eventId = externalId.slice(separatorIndex + 1)
}
const url = `${CALENDAR_API_BASE}/calendars/${encodeURIComponent(calendarId)}/events/${encodeURIComponent(eventId)}`
const response = await fetchWithRetry(url, {
method: 'GET',
headers: {
Authorization: `Bearer ${accessToken}`,
Accept: 'application/json',
},
})
if (!response.ok) {
if (response.status === 404) return null
throw new Error(`Failed to get Google Calendar event: ${response.status}`)
}
const event = (await response.json()) as CalendarEvent
if (event.status === 'cancelled') return null
return eventToDocument(event, calendarId, isMultiCalendar) ?? null
},
validateConfig: async (
accessToken: string,
sourceConfig: Record<string, unknown>
): Promise<{ valid: boolean; error?: string }> => {
const maxEvents = sourceConfig.maxEvents as string | undefined
if (maxEvents && (Number.isNaN(Number(maxEvents)) || Number(maxEvents) <= 0)) {
return { valid: false, error: 'Max events must be a positive number' }
}
const parsedCalendarIds = parseMultiValue(sourceConfig.calendarId)
const calendarIds = parsedCalendarIds.length > 0 ? parsedCalendarIds : ['primary']
try {
for (const calendarId of calendarIds) {
const url = `${CALENDAR_API_BASE}/calendars/${encodeURIComponent(calendarId)}/events?maxResults=1&singleEvents=true&orderBy=startTime&timeMin=${encodeURIComponent(new Date().toISOString())}`
const response = await fetchWithRetry(
url,
{
method: 'GET',
headers: {
Authorization: `Bearer ${accessToken}`,
Accept: 'application/json',
},
},
VALIDATE_RETRY_OPTIONS
)
if (!response.ok) {
if (response.status === 404) {
return {
valid: false,
error: `Calendar not found: ${calendarId}. Check the calendar ID.`,
}
}
return {
valid: false,
error: `Failed to access Google Calendar "${calendarId}": ${response.status}`,
}
}
}
return { valid: true }
} catch (error) {
const message = getErrorMessage(error, 'Failed to validate configuration')
return { valid: false, error: message }
}
},
mapTags: (metadata: Record<string, unknown>): Record<string, unknown> => {
const result: Record<string, unknown> = {}
if (typeof metadata.organizer === 'string' && metadata.organizer) {
result.organizer = metadata.organizer
}
if (typeof metadata.attendeeCount === 'number') {
result.attendeeCount = metadata.attendeeCount
}
if (typeof metadata.location === 'string' && metadata.location) {
result.location = metadata.location
}
const eventDate = parseTagDate(metadata.eventDate)
if (eventDate) result.eventDate = eventDate
const lastModified = parseTagDate(metadata.updatedTime)
if (lastModified) result.lastModified = lastModified
const createdAt = parseTagDate(metadata.createdTime)
if (createdAt) result.createdAt = createdAt
return result
},
}