Skip to content

fix: implement rate limiting for Google Calendar API calls to avoid 403 errors #1537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lorite wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: implement rate limiting for Google Calendar API calls to avoid 403 errors #1537

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 69 additions & 30 deletions src/services/TaskCalendarSyncService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,18 @@ const SYNC_DEBOUNCE_MS = 500;
/** Max concurrent API calls during bulk sync to avoid rate limits */
const SYNC_CONCURRENCY_LIMIT = 5;

/** Minimum spacing between Google Calendar API calls (ms) to reduce 403 rate limits */
const GOOGLE_API_CALL_SPACING_MS = 25;

/**
* Service for syncing TaskNotes tasks to Google Calendar.
* Handles creating, updating, and deleting calendar events when tasks change.
*/
export class TaskCalendarSyncService {
private plugin: TaskNotesPlugin;
private googleCalendarService: GoogleCalendarService;
private rateLimitChain: Promise<unknown> = Promise.resolve();
private lastApiCallAt = 0;

/** Debounce timers for pending syncs, keyed by task path */
private pendingSyncs: Map<string, ReturnType<typeof setTimeout>> = new Map();
Expand Down Expand Up @@ -64,6 +69,26 @@ export class TaskCalendarSyncService {
await Promise.all(executing);
}

/**
* Ensure Google API calls are spaced out to avoid 403 rate limits.
* Calls are queued and executed with at least GOOGLE_API_CALL_SPACING_MS between them.
*/
private async withGoogleRateLimit<T>(fn: () => Promise<T>): Promise<T> {
const run = async () => {
const now = Date.now();
const wait = Math.max(0, GOOGLE_API_CALL_SPACING_MS - (now - this.lastApiCallAt));
if (wait > 0) {
await new Promise((resolve) => setTimeout(resolve, wait));
}
const result = await fn();
this.lastApiCallAt = Date.now();
return result;
};

this.rateLimitChain = this.rateLimitChain.then(run, run);
return this.rateLimitChain as Promise<T>;
}

/**
* Check if the sync service is enabled and properly configured
*/
Expand Down Expand Up @@ -470,21 +495,25 @@ export class TaskCalendarSyncService {

if (existingEventId) {
// Update existing event
await this.googleCalendarService.updateEvent(
settings.targetCalendarId,
existingEventId,
eventData
await this.withGoogleRateLimit(() =>
this.googleCalendarService.updateEvent(
settings.targetCalendarId,
existingEventId,
eventData
)
);
} else {
// Create new event
const createdEvent = await this.googleCalendarService.createEvent(
settings.targetCalendarId,
{
...eventData,
start: eventData.start.date || eventData.start.dateTime!,
end: eventData.end.date || eventData.end.dateTime!,
isAllDay: !!eventData.start.date,
}
const createdEvent = await this.withGoogleRateLimit(() =>
this.googleCalendarService.createEvent(
settings.targetCalendarId,
{
...eventData,
start: eventData.start.date || eventData.start.dateTime!,
end: eventData.end.date || eventData.end.dateTime!,
isAllDay: !!eventData.start.date,
}
)
);

// Extract the actual event ID from the ICSEvent ID format
Expand Down Expand Up @@ -611,13 +640,15 @@ export class TaskCalendarSyncService {
? this.buildEventDescription(task)
: undefined;

await this.googleCalendarService.updateEvent(
settings.targetCalendarId,
existingEventId,
{
summary: completedTitle,
description,
}
await this.withGoogleRateLimit(() =>
this.googleCalendarService.updateEvent(
settings.targetCalendarId,
existingEventId,
{
summary: completedTitle,
description,
}
)
);
} catch (error: any) {
if (error.status === 404) {
Expand Down Expand Up @@ -647,10 +678,12 @@ export class TaskCalendarSyncService {
});

if (recurrenceData) {
await this.googleCalendarService.updateEvent(
settings.targetCalendarId,
eventId,
{ recurrence: recurrenceData.recurrence }
await this.withGoogleRateLimit(() =>
this.googleCalendarService.updateEvent(
settings.targetCalendarId,
eventId,
{ recurrence: recurrenceData.recurrence }
)
);
}
} catch (error: any) {
Expand Down Expand Up @@ -680,9 +713,11 @@ export class TaskCalendarSyncService {
}

try {
await this.googleCalendarService.deleteEvent(
settings.targetCalendarId,
existingEventId
await this.withGoogleRateLimit(() =>
this.googleCalendarService.deleteEvent(
settings.targetCalendarId,
existingEventId
)
);
} catch (error: any) {
// 404 or 410 means event is already gone - that's fine
Expand All @@ -706,7 +741,9 @@ export class TaskCalendarSyncService {
const settings = this.plugin.settings.googleCalendarExport;

try {
await this.googleCalendarService.deleteEvent(settings.targetCalendarId, eventId);
await this.withGoogleRateLimit(() =>
this.googleCalendarService.deleteEvent(settings.targetCalendarId, eventId)
);
} catch (error: any) {
// 404 or 410 means event is already gone - that's fine
if (error.status !== 404 && error.status !== 410) {
Expand Down Expand Up @@ -783,9 +820,11 @@ export class TaskCalendarSyncService {

if (deleteEvents) {
try {
await this.googleCalendarService.deleteEvent(
settings.targetCalendarId,
task.googleCalendarEventId
await this.withGoogleRateLimit(() =>
this.googleCalendarService.deleteEvent(
settings.targetCalendarId,
task.googleCalendarEventId
)
);
} catch (error) {
console.warn(`[TaskCalendarSync] Failed to delete event for ${task.path}:`, error);
Expand Down