add logging

Author: txchen

apps/api/src/scheduler.ts

@@ -1,4 +1,5 @@
 import type { ConfiguredMailAccount, SyncConfig } from "./config.js";
+import { logInfo } from "./logger.js";
 import type { SyncQueue } from "./sync-queue.js";
 
 export type SyncSchedulerOptions = {
@@ -23,6 +24,12 @@ export function createSyncScheduler({
   let recentReconciliationTimer: ReturnType<typeof setInterval> | undefined;
 
   function scheduleRegular() {
+    logInfo("sync.scheduler.poll", {
+      scope: "regular",
+      accountCount: accounts.length,
+      intervalMinutes: sync.regularSyncIntervalMinutes,
+    });
+
     for (const account of accounts) {
       syncQueue.schedule({
         accountId: account.id,
@@ -33,6 +40,13 @@ export function createSyncScheduler({
   }
 
   function scheduleRecentReconciliation() {
+    logInfo("sync.scheduler.poll", {
+      scope: "recentReconciliation",
+      accountCount: accounts.length,
+      days: sync.recentReconciliationWindowDays,
+      intervalMinutes: sync.recentReconciliationIntervalMinutes,
+    });
+
     for (const account of accounts) {
       syncQueue.schedule({
         accountId: account.id,

apps/api/src/sync-queue.ts

@@ -1,3 +1,5 @@
+import { logError, logInfo } from "./logger.js";
+
 export type SyncJobState =
   | "pending"
   | "running"
@@ -77,6 +79,7 @@ export function createSyncQueue({
     job.state = state;
     job.finishedAt = stamp();
     inactive.unshift(job);
+    logInfo("sync.queue.inactive", syncJobLogFields(job));
   }
 
   async function drain() {
@@ -93,14 +96,23 @@ export function createSyncQueue({
       running = job;
       job.state = "running";
       job.startedAt = stamp();
+      logInfo("sync.queue.start", syncJobLogFields(job));
 
       try {
         const result = await execute(job);
         job.state = "succeeded";
         job.result = result ?? {};
+        logInfo("sync.queue.finish", {
+          ...syncJobLogFields(job),
+          ...syncJobResultLogFields(job.result),
+        });
       } catch (error) {
         job.state = "failed";
         job.error = error instanceof Error ? error.message : String(error);
+        logError("sync.queue.error", {
+          ...syncJobLogFields(job),
+          error: job.error,
+        });
       } finally {
         job.finishedAt = stamp();
         running = undefined;
@@ -146,6 +158,11 @@ export function createSyncQueue({
     schedule(request) {
       const duplicate = findDuplicateAutomatic(request);
       if (duplicate) {
+        logInfo("sync.queue.coalesce", {
+          ...syncJobLogFields(duplicate),
+          requestedOrigin: request.origin,
+          requestedScope: syncScopeLabel(request.scope),
+        });
         return duplicate;
       }
 
@@ -177,6 +194,7 @@ export function createSyncQueue({
       }
 
       pending.push(job);
+      logInfo("sync.queue.schedule", syncJobLogFields(job));
       startDrain();
 
       return job;
@@ -211,6 +229,40 @@ function sameScope(left: SyncScope, right: SyncScope) {
   return "days" in left && "days" in right && left.days === right.days;
 }
 
+function syncJobLogFields(job: SyncJob) {
+  return {
+    jobId: job.id,
+    accountId: job.accountId,
+    origin: job.origin,
+    scope: syncScopeLabel(job.scope),
+    state: job.state,
+  };
+}
+
+function syncJobResultLogFields(result: SyncJobResult | undefined) {
+  if (!result) {
+    return {};
+  }
+
+  return {
+    mailboxCount: result.mailboxCount,
+    scannedMailboxCount: result.scannedMailboxCount,
+    skippedMailboxCount: result.skippedMailboxCount,
+    fetchedMessageCount: result.fetchedMessageCount,
+    storedMessageCount: result.storedMessageCount,
+    removedMailboxEntryCount: result.removedMailboxEntryCount,
+    durationMs: result.durationMs,
+  };
+}
+
+function syncScopeLabel(scope: SyncScope): string {
+  if (scope.type === "regular") {
+    return "regular";
+  }
+
+  return `${scope.type}:${scope.days}`;
+}
+
 function isSmallerCustomRange(left: SyncScope, right: Extract<SyncScope, { type: "customRange" }>) {
   return left.type === "customRange" && left.days < right.days;
 }