Files
simstudioai--sim/apps/sim/lib/webhooks/polling/google-drive.ts
T
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

436 lines
14 KiB
TypeScript

import type { Logger } from '@sim/logger'
import { getErrorMessage } from '@sim/utils/errors'
import { pollingIdempotency } from '@/lib/core/idempotency/service'
import { readCanonicalTriggerValue } from '@/lib/webhooks/polling/canonical'
import {
getProviderConfig,
type PollingProviderHandler,
type PollWebhookContext,
} from '@/lib/webhooks/polling/types'
import {
markWebhookFailed,
markWebhookSuccess,
resolveOAuthCredential,
updateWebhookProviderConfig,
} from '@/lib/webhooks/polling/utils'
import { processPolledWebhookEvent } from '@/lib/webhooks/processor'
const MAX_FILES_PER_POLL = 50
const MAX_KNOWN_FILE_IDS = 1000
const MAX_PAGES = 10
const DRIVE_API_BASE = 'https://www.googleapis.com/drive/v3'
type DriveEventTypeFilter = '' | 'created' | 'modified' | 'deleted' | 'created_or_modified'
interface GoogleDriveWebhookConfig {
folderId?: string
manualFolderId?: string
mimeTypeFilter?: string
includeSharedDrives?: boolean
eventTypeFilter?: DriveEventTypeFilter
maxFilesPerPoll?: number
pageToken?: string
knownFileIds?: string[]
}
interface DriveChangeEntry {
kind: string
type: string
time: string
removed: boolean
fileId: string
file?: DriveFileMetadata
}
interface DriveFileMetadata {
id: string
name: string
mimeType: string
modifiedTime: string
createdTime?: string
size?: string
webViewLink?: string
parents?: string[]
lastModifyingUser?: { displayName?: string; emailAddress?: string }
shared?: boolean
starred?: boolean
trashed?: boolean
}
interface GoogleDriveWebhookPayload {
file: DriveFileMetadata | { id: string }
eventType: 'created' | 'modified' | 'deleted'
timestamp: string
}
const FILE_FIELDS = [
'id',
'name',
'mimeType',
'modifiedTime',
'createdTime',
'size',
'webViewLink',
'parents',
'lastModifyingUser',
'shared',
'starred',
'trashed',
].join(',')
export const googleDrivePollingHandler: PollingProviderHandler = {
provider: 'google-drive',
label: 'Google Drive',
async pollWebhook(ctx: PollWebhookContext): Promise<'success' | 'failure'> {
const { webhookData, workflowData, requestId, logger } = ctx
const webhookId = webhookData.id
try {
const accessToken = await resolveOAuthCredential(webhookData, 'google-drive', requestId)
const config = getProviderConfig<GoogleDriveWebhookConfig>(webhookData.providerConfig)
// First poll (or re-seed after 410): seed page token, preserve any existing known file IDs.
if (!config.pageToken) {
const startPageToken = await getStartPageToken(accessToken, config, requestId, logger)
await updateWebhookProviderConfig(
webhookId,
{ pageToken: startPageToken, knownFileIds: config.knownFileIds ?? [] },
logger
)
await markWebhookSuccess(webhookId, logger)
logger.info(
`[${requestId}] First poll for webhook ${webhookId}, seeded pageToken: ${startPageToken}`
)
return 'success'
}
const { changes, newStartPageToken } = await fetchChanges(
accessToken,
config,
requestId,
logger
)
if (!changes.length) {
await updateWebhookProviderConfig(webhookId, { pageToken: newStartPageToken }, logger)
await markWebhookSuccess(webhookId, logger)
logger.info(`[${requestId}] No changes found for webhook ${webhookId}`)
return 'success'
}
const filteredChanges = filterChanges(changes, config)
if (!filteredChanges.length) {
await updateWebhookProviderConfig(webhookId, { pageToken: newStartPageToken }, logger)
await markWebhookSuccess(webhookId, logger)
logger.info(
`[${requestId}] ${changes.length} changes found but none match filters for webhook ${webhookId}`
)
return 'success'
}
logger.info(
`[${requestId}] Found ${filteredChanges.length} matching changes for webhook ${webhookId}`
)
const { processedCount, failedCount, newKnownFileIds } = await processChanges(
filteredChanges,
config,
webhookData,
workflowData,
requestId,
logger
)
const existingKnownIds = config.knownFileIds || []
const mergedKnownIds = [...new Set([...newKnownFileIds, ...existingKnownIds])].slice(
0,
MAX_KNOWN_FILE_IDS
)
const anyFailed = failedCount > 0
await updateWebhookProviderConfig(
webhookId,
{
pageToken: anyFailed ? config.pageToken : newStartPageToken,
knownFileIds: anyFailed ? existingKnownIds : mergedKnownIds,
},
logger
)
if (failedCount > 0 && processedCount === 0) {
await markWebhookFailed(webhookId, logger)
logger.warn(
`[${requestId}] All ${failedCount} changes failed to process for webhook ${webhookId}`
)
return 'failure'
}
await markWebhookSuccess(webhookId, logger)
logger.info(
`[${requestId}] Successfully processed ${processedCount} changes for webhook ${webhookId}${failedCount > 0 ? ` (${failedCount} failed)` : ''}`
)
return 'success'
} catch (error) {
if (error instanceof Error && error.name === 'DrivePageTokenInvalidError') {
await updateWebhookProviderConfig(webhookId, { pageToken: undefined }, logger)
await markWebhookSuccess(webhookId, logger)
logger.warn(
`[${requestId}] Drive page token invalid for webhook ${webhookId}, re-seeding on next poll`
)
return 'success'
}
if (error instanceof Error && error.name === 'DriveRateLimitError') {
await markWebhookSuccess(webhookId, logger)
logger.warn(
`[${requestId}] Drive API rate limited for webhook ${webhookId}, skipping to retry next poll cycle`
)
return 'success'
}
logger.error(`[${requestId}] Error processing Google Drive webhook ${webhookId}:`, error)
await markWebhookFailed(webhookId, logger)
return 'failure'
}
},
}
const DRIVE_RATE_LIMIT_REASONS = new Set(['rateLimitExceeded', 'userRateLimitExceeded'])
/** Returns true only for quota/rate-limit 403s, not permission errors. */
function isDriveRateLimitError(status: number, errorData: Record<string, unknown>): boolean {
if (status !== 403) return false
const reason = (errorData as { error?: { errors?: { reason?: string }[] } })?.error?.errors?.[0]
?.reason
return reason !== undefined && DRIVE_RATE_LIMIT_REASONS.has(reason)
}
async function getStartPageToken(
accessToken: string,
config: GoogleDriveWebhookConfig,
requestId: string,
logger: Logger
): Promise<string> {
const params = new URLSearchParams()
if (config.includeSharedDrives) {
params.set('supportsAllDrives', 'true')
}
const url = `${DRIVE_API_BASE}/changes/startPageToken?${params.toString()}`
const response = await fetch(url, {
headers: { Authorization: `Bearer ${accessToken}` },
})
if (!response.ok) {
const status = response.status
const errorData = await response.json().catch(() => ({}))
if (status === 429 || isDriveRateLimitError(status, errorData)) {
const err = new Error(`Drive API rate limit (${status}): ${JSON.stringify(errorData)}`)
err.name = 'DriveRateLimitError'
throw err
}
throw new Error(
`Failed to get Drive start page token: ${status} - ${JSON.stringify(errorData)}`
)
}
const data = await response.json()
return data.startPageToken as string
}
async function fetchChanges(
accessToken: string,
config: GoogleDriveWebhookConfig,
requestId: string,
logger: Logger
): Promise<{ changes: DriveChangeEntry[]; newStartPageToken: string }> {
const allChanges: DriveChangeEntry[] = []
let currentPageToken = config.pageToken!
let newStartPageToken: string | undefined
let lastNextPageToken: string | undefined
const maxFiles = config.maxFilesPerPoll || MAX_FILES_PER_POLL
let pages = 0
while (true) {
pages++
const params = new URLSearchParams({
pageToken: currentPageToken,
pageSize: String(Math.min(maxFiles, 100)),
fields: `nextPageToken,newStartPageToken,changes(kind,type,time,removed,fileId,file(${FILE_FIELDS}))`,
restrictToMyDrive: config.includeSharedDrives ? 'false' : 'true',
})
if (config.includeSharedDrives) {
params.set('supportsAllDrives', 'true')
params.set('includeItemsFromAllDrives', 'true')
}
const url = `${DRIVE_API_BASE}/changes?${params.toString()}`
const response = await fetch(url, {
headers: { Authorization: `Bearer ${accessToken}` },
})
if (!response.ok) {
const status = response.status
const errorData = await response.json().catch(() => ({}))
if (status === 410) {
const err = new Error('Drive page token is no longer valid')
err.name = 'DrivePageTokenInvalidError'
throw err
}
if (status === 429 || isDriveRateLimitError(status, errorData)) {
const err = new Error(`Drive API rate limit (${status}): ${JSON.stringify(errorData)}`)
err.name = 'DriveRateLimitError'
throw err
}
throw new Error(`Failed to fetch Drive changes: ${status} - ${JSON.stringify(errorData)}`)
}
const data = await response.json()
const changes = (data.changes || []) as DriveChangeEntry[]
allChanges.push(...changes)
if (data.newStartPageToken) {
newStartPageToken = data.newStartPageToken as string
}
const hasMore = !!data.nextPageToken
const overLimit = allChanges.length >= maxFiles
if (!hasMore || overLimit || pages >= MAX_PAGES) {
if (hasMore) {
lastNextPageToken = data.nextPageToken as string
}
break
}
lastNextPageToken = data.nextPageToken as string
currentPageToken = data.nextPageToken as string
}
// When allChanges exceeds maxFiles (multi-page overshoot), resume mid-list via lastNextPageToken.
// Otherwise resume from newStartPageToken (end of change list) or lastNextPageToken (MAX_PAGES hit).
const slicingOccurs = allChanges.length > maxFiles
const resumeToken = slicingOccurs
? (lastNextPageToken ?? newStartPageToken!)
: (newStartPageToken ?? lastNextPageToken!)
return { changes: allChanges.slice(0, maxFiles), newStartPageToken: resumeToken }
}
function filterChanges(
changes: DriveChangeEntry[],
config: GoogleDriveWebhookConfig
): DriveChangeEntry[] {
return changes.filter((change) => {
if (change.removed) return true
const file = change.file
if (!file) return false
if (file.trashed) return false
// Canonical key `folderId` first; `manualFolderId` is a transitional basic-first fallback.
const folderId = readCanonicalTriggerValue(config.folderId, config.manualFolderId)
if (folderId) {
if (!file.parents || !file.parents.includes(folderId)) {
return false
}
}
if (config.mimeTypeFilter) {
if (config.mimeTypeFilter.endsWith('/')) {
if (!file.mimeType.startsWith(config.mimeTypeFilter)) {
return false
}
} else if (file.mimeType !== config.mimeTypeFilter) {
return false
}
}
return true
})
}
async function processChanges(
changes: DriveChangeEntry[],
config: GoogleDriveWebhookConfig,
webhookData: PollWebhookContext['webhookData'],
workflowData: PollWebhookContext['workflowData'],
requestId: string,
logger: Logger
): Promise<{ processedCount: number; failedCount: number; newKnownFileIds: string[] }> {
let processedCount = 0
let failedCount = 0
const newKnownFileIds: string[] = []
const knownFileIdsSet = new Set(config.knownFileIds || [])
for (const change of changes) {
let eventType: 'created' | 'modified' | 'deleted'
if (change.removed) {
eventType = 'deleted'
} else if (!knownFileIdsSet.has(change.fileId)) {
eventType = 'created'
} else {
eventType = 'modified'
}
// Track file as known regardless of filter so future changes are correctly classified
if (!change.removed) {
newKnownFileIds.push(change.fileId)
}
// Apply event type filter before idempotency so filtered events aren't cached
const filter = config.eventTypeFilter
if (filter) {
const skip = filter === 'created_or_modified' ? eventType === 'deleted' : eventType !== filter
if (skip) continue
}
try {
const idempotencyKey = `${webhookData.id}:${change.fileId}:${change.time || change.fileId}`
await pollingIdempotency.executeWithIdempotency('google-drive', idempotencyKey, async () => {
const payload: GoogleDriveWebhookPayload = {
file: change.file || { id: change.fileId },
eventType,
timestamp: new Date().toISOString(),
}
const result = await processPolledWebhookEvent(
webhookData,
workflowData,
payload,
requestId
)
if (!result.success) {
logger.error(
`[${requestId}] Failed to process webhook for file ${change.fileId}:`,
result.statusCode,
result.error
)
throw new Error(`Webhook processing failed (${result.statusCode}): ${result.error}`)
}
return { fileId: change.fileId, processed: true }
})
logger.info(
`[${requestId}] Successfully processed change for file ${change.fileId} for webhook ${webhookData.id}`
)
processedCount++
} catch (error) {
const errorMessage = getErrorMessage(error, 'Unknown error')
logger.error(
`[${requestId}] Error processing change for file ${change.fileId}:`,
errorMessage
)
failedCount++
}
}
return { processedCount, failedCount, newKnownFileIds }
}