@remit/mailbox-service 0.0.35 → 0.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/mailbox-service",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/mailbox-sync.test.ts

@@ -11,7 +11,10 @@ import {
 	MailboxSyncStatus,
 } from "@remit/domain-enums";
 import { parseImapAttributes } from "./attribute-mapper.js";
-import { MailboxSyncService } from "./mailbox-sync.js";
+import { type MailboxSyncLogger, MailboxSyncService } from "./mailbox-sync.js";
+
+const silentLogger: MailboxSyncLogger = { info: () => {}, debug: () => {} };
+
 import type { IImapConnection, ImapNamespaces } from "./types.js";
 
 describe("parseImapAttributes – locale invariance (#194)", () => {
@@ -121,7 +124,11 @@ describe("MailboxSyncService.syncMailboxes — UIDVALIDITY cursor detection (#12
 
 	it("trips cursor_invalid when the STATUS sweep observes a changed UIDVALIDITY", async () => {
 		const { mailboxService, specialUseService, updateCalls } = buildServices(1);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 		const connection = buildConnection(2);
 
 		await service.syncMailboxes({ accountId: "acc-1" }, connection);
@@ -136,7 +143,11 @@ describe("MailboxSyncService.syncMailboxes — UIDVALIDITY cursor detection (#12
 
 	it("does not write anything when UIDVALIDITY (and everything else) is unchanged", async () => {
 		const { mailboxService, specialUseService, updateCalls } = buildServices(1);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 		const connection = buildConnection(1);
 
 		await service.syncMailboxes({ accountId: "acc-1" }, connection);
@@ -150,7 +161,11 @@ describe("MailboxSyncService.syncMailboxes — UIDVALIDITY cursor detection (#12
 		// the server's current value would step it over every change message sync
 		// had not yet applied.
 		const { mailboxService, specialUseService, updateCalls } = buildServices(1);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 		const connection = buildConnection(2, "99999");
 
 		await service.syncMailboxes({ accountId: "acc-1" }, connection);
@@ -162,7 +177,11 @@ describe("MailboxSyncService.syncMailboxes — UIDVALIDITY cursor detection (#12
 
 	it("does not sweep-write a mailbox whose only difference is the server mod-sequence", async () => {
 		const { mailboxService, specialUseService, updateCalls } = buildServices(1);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 		const connection = buildConnection(1, "4242");
 
 		await service.syncMailboxes({ accountId: "acc-1" }, connection);
@@ -175,7 +194,11 @@ describe("MailboxSyncService.syncMailboxes — UIDVALIDITY cursor detection (#12
 			1,
 			MailboxCursorState.cursor_invalid,
 		);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 		const connection = buildConnection(2);
 
 		await service.syncMailboxes({ accountId: "acc-1" }, connection);
@@ -273,7 +296,11 @@ describe("MailboxSyncService.syncMailboxes — reconcile does not delete pending
 				syncStatus: MailboxSyncStatus.pending,
 			},
 		]);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 
 		const result = await service.syncMailboxes(
 			{ accountId: "acc-1" },
@@ -299,7 +326,11 @@ describe("MailboxSyncService.syncMailboxes — reconcile does not delete pending
 				syncStatus: MailboxSyncStatus.synced,
 			},
 		]);
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 
 		const result = await service.syncMailboxes(
 			{ accountId: "acc-1" },
@@ -419,7 +450,11 @@ describe("MailboxSyncService.syncMailboxes — a folder leaving mid-sweep (#339)
 				doomedSyncStatus: syncStatus,
 			});
 			const { connection, statusPaths } = buildConnection(async () => status());
-			const service = new MailboxSyncService(mailboxService, specialUseService);
+			const service = new MailboxSyncService(
+				mailboxService,
+				specialUseService,
+				silentLogger,
+			);
 
 			await service.syncMailboxes({ accountId: "acc-1" }, connection);
 
@@ -439,7 +474,11 @@ describe("MailboxSyncService.syncMailboxes — a folder leaving mid-sweep (#339)
 			if (path === "Doomed") throw new Error("Mailbox doesn't exist: Doomed");
 			return status();
 		});
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 
 		await assert.doesNotReject(
 			service.syncMailboxes({ accountId: "acc-1" }, connection),
@@ -460,7 +499,11 @@ describe("MailboxSyncService.syncMailboxes — a folder leaving mid-sweep (#339)
 			if (path === "Doomed") throw new Error("connection reset by peer");
 			return status();
 		});
-		const service = new MailboxSyncService(mailboxService, specialUseService);
+		const service = new MailboxSyncService(
+			mailboxService,
+			specialUseService,
+			silentLogger,
+		);
 
 		await assert.rejects(
 			service.syncMailboxes({ accountId: "acc-1" }, connection),

package/src/mailbox-sync.ts

@@ -77,19 +77,45 @@ export interface SyncAccountInfo {
 	accountId: string;
 }
 
+/**
+ * Logger interface for MailboxSyncService.
+ *
+ * `info` is reserved here for the three mailbox lifecycle events — created,
+ * updated, deleted — and is the argued exception to `plugins/no-logger-info.grit`
+ * that the rest of this repo writes as a suppression. (The plugin matches the
+ * bare `logger` identifier, so it does not see an injected logger; the reasoning
+ * is written out instead of being silently absent.) A folder disappearing from
+ * someone's mail is destructive and irreversible from this service's side, and
+ * the only record that this process did it is the line it writes. That must not
+ * sit below the default threshold.
+ *
+ * Everything else this service has to say — a special-use flag it synced, a
+ * duplicate folder it skipped — is a routine trace and goes to `debug`.
+ */
+export interface MailboxSyncLogger {
+	info(obj: Record<string, unknown>, msg: string): void;
+	debug(obj: Record<string, unknown>, msg: string): void;
+}
+
 /**
  * Service for synchronizing mailbox metadata between IMAP and the data backend.
  */
 export class MailboxSyncService {
 	private mailboxService: IMailboxRepository;
 	private specialUseService: IMailboxSpecialUseRepository;
+	private log: MailboxSyncLogger;
 
+	// Required, with no no-op default: the lines below are the only record that a
+	// mailbox was created or destroyed, and a default would let the next call site
+	// lose them with no error and no failing test.
 	constructor(
 		mailboxService: IMailboxRepository,
 		specialUseService: IMailboxSpecialUseRepository,
+		logger: MailboxSyncLogger,
 	) {
 		this.mailboxService = mailboxService;
 		this.specialUseService = specialUseService;
+		this.log = logger;
 	}
 
 	/**
@@ -146,8 +172,13 @@ export class MailboxSyncService {
 							account.accountId,
 							existing.mailboxId,
 						);
-						console.info(
-							`Deleted non-selectable mailbox: ${existing.mailboxId} (${existing.fullPath})`,
+						this.log.info(
+							{
+								mailboxId: existing.mailboxId,
+								fullPath: existing.fullPath,
+								reason: "non-selectable",
+							},
+							"Deleted mailbox",
 						);
 						result.deleted++;
 					}
@@ -164,8 +195,13 @@ export class MailboxSyncService {
 							account.accountId,
 							existing.mailboxId,
 						);
-						console.info(
-							`Deleted duplicate special-use mailbox: ${existing.mailboxId} (${existing.fullPath})`,
+						this.log.info(
+							{
+								mailboxId: existing.mailboxId,
+								fullPath: existing.fullPath,
+								reason: "duplicate-special-use",
+							},
+							"Deleted mailbox",
 						);
 						result.deleted++;
 					}
@@ -238,8 +274,13 @@ export class MailboxSyncService {
 			// pending rows to the create/rename flow that owns them.
 			if (existing.syncStatus === MailboxSyncStatus.pending) continue;
 			await this.mailboxService.delete(account.accountId, existing.mailboxId);
-			console.info(
-				`Deleted mailbox: ${existing.mailboxId} (${existing.fullPath})`,
+			this.log.info(
+				{
+					mailboxId: existing.mailboxId,
+					fullPath: existing.fullPath,
+					reason: "not-on-server",
+				},
+				"Deleted mailbox",
 			);
 			result.deleted++;
 		}
@@ -419,12 +460,18 @@ export class MailboxSyncService {
 				mailbox.mailboxId,
 				parsed.specialUse,
 			);
-			console.info(
-				`Created mailbox: ${mailbox.mailboxId} (${mailboxInfo.fullPath}) [special-use: ${parsed.specialUse.join(", ")}]`,
+			this.log.info(
+				{
+					mailboxId: mailbox.mailboxId,
+					fullPath: mailboxInfo.fullPath,
+					specialUse: parsed.specialUse,
+				},
+				"Created mailbox",
 			);
 		} else {
-			console.info(
-				`Created mailbox: ${mailbox.mailboxId} (${mailboxInfo.fullPath})`,
+			this.log.info(
+				{ mailboxId: mailbox.mailboxId, fullPath: mailboxInfo.fullPath },
+				"Created mailbox",
 			);
 		}
 
@@ -504,8 +551,13 @@ export class MailboxSyncService {
 				`specialUse: [${(existing.specialUse ?? []).join(",")}] -> [${parsed.specialUse.join(",")}]`,
 			);
 
-		console.info(
-			`Updating mailbox: ${existing.mailboxId} (${mailboxInfo.fullPath}) [${changes.join(", ")}]`,
+		this.log.info(
+			{
+				mailboxId: existing.mailboxId,
+				fullPath: mailboxInfo.fullPath,
+				changes,
+			},
+			"Updating mailbox",
 		);
 
 		// Update mailbox with fresh status. ElectroDB rejects empty sets, so we
@@ -557,8 +609,9 @@ export class MailboxSyncService {
 
 		if (parsed.specialUse.length > 0) {
 			await this.specialUseService.createMany(mailboxId, parsed.specialUse);
-			console.info(
-				`Synced special-use for ${mailboxInfo.fullPath}: ${parsed.specialUse.join(", ")}`,
+			this.log.debug(
+				{ fullPath: mailboxInfo.fullPath, specialUse: parsed.specialUse },
+				"Synced special-use",
 			);
 		}
 	};
@@ -619,8 +672,13 @@ export class MailboxSyncService {
 		}
 
 		// This is a duplicate - another folder has the attribute
-		console.info(
-			`Skipping duplicate folder "${mailbox.fullPath}" - "${claimedPath}" has \\${expectedSpecialUse} attribute`,
+		this.log.debug(
+			{
+				fullPath: mailbox.fullPath,
+				claimedPath,
+				specialUse: expectedSpecialUse,
+			},
+			"Skipping duplicate folder",
 		);
 		return true;
 	};