@remit/drizzle-service 0.0.88 → 0.0.90

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/drizzle-service",
-  "version": "0.0.88",
+  "version": "0.0.90",
   "description": "Drizzle ORM service over SQLite",
   "type": "module",
   "main": "src/index.ts",

package/src/account-granted-scopes-migration.sqlite.test.ts

@@ -0,0 +1,66 @@
+import assert from "node:assert/strict";
+import { describe, test } from "node:test";
+import Database from "better-sqlite3";
+import { drizzle } from "drizzle-orm/better-sqlite3";
+import { AccountRepo } from "./repos/i4-account.js";
+import { accountTable } from "./schema.js";
+import {
+	applyMigration,
+	migrationJournal,
+} from "./test-shipped-sqlite-schema.js";
+
+const MIGRATION = "0032_account_granted_scopes";
+
+const atPredecessor = (): Database.Database => {
+	const sqlite = new Database(":memory:");
+	for (const entry of migrationJournal()) {
+		if (entry.tag === MIGRATION) return sqlite;
+		applyMigration(sqlite, entry.tag);
+	}
+	throw new Error(`${MIGRATION} is not in the journal`);
+};
+
+const migrateOnward = (sqlite: Database.Database): void => {
+	const tags = migrationJournal().map((entry) => entry.tag);
+	for (const tag of tags.slice(tags.indexOf(MIGRATION))) {
+		applyMigration(sqlite, tag);
+	}
+};
+
+const insertAccount = (
+	sqlite: Database.Database,
+	accountId: string,
+	authType: string,
+): void => {
+	sqlite
+		.prepare(
+			`INSERT INTO account (
+				account_id, account_config_id, username, email, auth_type,
+				imap_host, imap_port, imap_tls, imap_start_tls, smtp_port,
+				is_active, connection_state, created_at, updated_at
+			) VALUES (?, 'config', 'person', 'person@example.com', ?,
+				'outlook.office365.com', 993, 1, 0, 587, 1,
+				'not_authenticated', 0, 0)`,
+		)
+		.run(accountId, authType);
+};
+
+describe("an account written before granted scopes were recorded", () => {
+	test("a Microsoft account holds the mail grant its consent always asked for", async () => {
+		const sqlite = atPredecessor();
+		insertAccount(sqlite, "microsoft", "oauthMicrosoft");
+		insertAccount(sqlite, "password", "password");
+
+		migrateOnward(sqlite);
+
+		const repo = new AccountRepo(
+			drizzle(sqlite, { schema: { accounts: accountTable } }) as never,
+		);
+		assert.deepEqual((await repo.get("microsoft")).grantedScopes, [
+			"https://outlook.office.com/IMAP.AccessAsUser.All",
+			"https://outlook.office.com/SMTP.Send",
+		]);
+		assert.deepEqual((await repo.get("password")).grantedScopes, []);
+		sqlite.close();
+	});
+});

package/src/account-synced-services-migration.sqlite.test.ts

@@ -21,6 +21,13 @@ const atPredecessor = (): Database.Database => {
 	throw new Error(`${MIGRATION} is not in the journal`);
 };
 
+const migrateOnward = (sqlite: Database.Database): void => {
+	const tags = migrationJournal().map((entry) => entry.tag);
+	for (const tag of tags.slice(tags.indexOf(MIGRATION))) {
+		applyMigration(sqlite, tag);
+	}
+};
+
 describe("an account written before the service selection existed", () => {
 	test("comes out of the migration syncing mail only", async () => {
 		const sqlite = atPredecessor();
@@ -36,7 +43,7 @@ describe("an account written before the service selection existed", () => {
 			)
 			.run();
 
-		applyMigration(sqlite, MIGRATION);
+		migrateOnward(sqlite);
 
 		const repo = new AccountRepo(
 			drizzle(sqlite, { schema: { accounts: accountTable } }) as never,

package/src/mailbox-path-dedupe.sqlite.test.ts

@@ -18,6 +18,7 @@ import {
 
 const DEDUPE = "0030_mailbox_path_dedupe";
 const UNIQUE = "0031_mailbox_path_unique";
+const MAILBOX_COLUMNS_ADDED_SINCE = ["0033_mailbox_sync_failure_reason"];
 const ACCOUNT = "acct";
 const CONFIG = "cfg";
 
@@ -27,6 +28,8 @@ const atPredecessor = (): Handle => {
 	const sqlite = new Database(":memory:");
 	for (const entry of migrationJournal()) {
 		if (entry.tag === DEDUPE) {
+			for (const tag of MAILBOX_COLUMNS_ADDED_SINCE)
+				applyMigration(sqlite, tag);
 			return {
 				sqlite,
 				db: drizzle(sqlite) as unknown as Db<Record<string, unknown>>,

package/src/repair/junk-only-address.sqlite.test.ts

@@ -203,6 +203,7 @@ describe("addresses standing only on mail in Junk", () => {
 		// `mailbox` is read through the repo, which selects every column the
 		// entity declares — including the rename target added after this DDL.
 		applyMigration(sqlite, "0028_mailbox_pending_path");
+		applyMigration(sqlite, "0033_mailbox_sync_failure_reason");
 		sqlite.exec(
 			readFileSync(
 				new URL(

package/src/repos/i4-account.ts

@@ -40,6 +40,7 @@ export function rowToAccount(
 		email: row.email,
 		authType: row.authType as AccountItem["authType"],
 		syncedServices: row.syncedServices as AccountItem["syncedServices"],
+		grantedScopes: row.grantedScopes as AccountItem["grantedScopes"],
 		passwordHash: row.passwordHash ?? undefined,
 		oauthRefreshTokenHash: row.oauthRefreshTokenHash ?? undefined,
 		oauthTokenUpdatedAt: row.oauthTokenUpdatedAt ?? undefined,
@@ -83,6 +84,7 @@ export class AccountRepo implements IAccountRepository {
 				email: input.email,
 				authType: input.authType ?? "password",
 				syncedServices: input.syncedServices ?? [AccountService.Mail],
+				grantedScopes: input.grantedScopes ?? [],
 				passwordHash: input.passwordHash,
 				oauthRefreshTokenHash: input.oauthRefreshTokenHash,
 				oauthTokenUpdatedAt: input.oauthTokenUpdatedAt,
@@ -148,6 +150,8 @@ export class AccountRepo implements IAccountRepository {
 		if (input.authType !== undefined) updates.authType = input.authType;
 		if (input.syncedServices !== undefined)
 			updates.syncedServices = input.syncedServices;
+		if (input.grantedScopes !== undefined)
+			updates.grantedScopes = input.grantedScopes;
 		if (input.passwordHash !== undefined)
 			updates.passwordHash = input.passwordHash;
 		if (input.oauthRefreshTokenHash !== undefined)

package/src/repos/i4-mailbox.sqlite.test.ts

@@ -154,6 +154,37 @@ describe("MailboxRepo (sqlite)", () => {
 			/UNIQUE constraint failed: mailbox\.account_id, mailbox\.full_path/,
 		);
 	});
+
+	test("syncFailureReason is written on failed and cleared by any other state", async () => {
+		const accountId = randomUUID();
+		const created = mailboxCreated(
+			await repo.create(makeMailboxInput(accountId, "Locked")),
+		);
+		assert.equal(created.syncFailureReason, "");
+
+		await repo.transition(accountId, created.mailboxId, {
+			from: [MailboxSyncStatus.synced],
+			to: MailboxSyncStatus.deleting,
+			set: { syncFailureReason: "ignored outside failed" },
+		});
+		assert.equal(
+			(await repo.get(accountId, created.mailboxId)).syncFailureReason,
+			"",
+		);
+
+		const failed = await repo.transition(accountId, created.mailboxId, {
+			from: [MailboxSyncStatus.deleting],
+			to: MailboxSyncStatus.failed,
+			set: { syncFailureReason: "Permission denied" },
+		});
+		assert.equal(failed?.syncFailureReason, "Permission denied");
+
+		const dismissed = await repo.transition(accountId, created.mailboxId, {
+			from: [MailboxSyncStatus.failed],
+			to: MailboxSyncStatus.synced,
+		});
+		assert.equal(dismissed?.syncFailureReason, "");
+	});
 });
 
 /**
@@ -179,6 +210,7 @@ describe("MailboxRepo (sqlite, shipped migrations)", () => {
 		applyMigration(sqlite, "0027_mailbox_sync_status_total");
 		applyMigration(sqlite, "0028_mailbox_pending_path");
 		applyMigration(sqlite, "0031_mailbox_path_unique");
+		applyMigration(sqlite, "0033_mailbox_sync_failure_reason");
 		const db = drizzle(sqlite, { schema: { mailbox: mailboxTable } });
 		repo = new MailboxRepo(db as never);
 		close = async () => {
@@ -254,6 +286,25 @@ describe("MailboxRepo (sqlite, shipped migrations)", () => {
 		assert.equal(cleared?.pendingPath, undefined);
 	});
 
+	test("syncFailureReason round-trips on the shipped shape", async () => {
+		const accountId = randomUUID();
+		const created = mailboxCreated(
+			await repo.create(makeMailboxInput(accountId, "Held")),
+		);
+		assert.equal(created.syncFailureReason, "");
+
+		await repo.transition(accountId, created.mailboxId, {
+			from: [MailboxSyncStatus.synced],
+			to: MailboxSyncStatus.deleting,
+		});
+		const failed = await repo.transition(accountId, created.mailboxId, {
+			from: [MailboxSyncStatus.deleting],
+			to: MailboxSyncStatus.failed,
+			set: { syncFailureReason: "Permission denied" },
+		});
+		assert.equal(failed?.syncFailureReason, "Permission denied");
+	});
+
 	test("round-trips a cursor above 2^53 with its exact digits", async () => {
 		const accountId = randomUUID();
 		const modseq = "18446744073709551615";

package/src/repos/i4-mailbox.ts

@@ -92,6 +92,7 @@ const transitionSet = (
 			? { pendingPath: write.pendingPath }
 			: {}
 		: { pendingPath: null }),
+	syncFailureReason: to === "failed" ? (write?.syncFailureReason ?? "") : "",
 	updatedAt: Date.now(),
 });
 
@@ -119,6 +120,7 @@ export function rowToMailbox(
 		parentMailboxId: row.parentMailboxId,
 		syncStatus: row.syncStatus as MailboxItem["syncStatus"],
 		...(row.pendingPath !== null ? { pendingPath: row.pendingPath } : {}),
+		syncFailureReason: row.syncFailureReason,
 		cursorState: (row.cursorState as MailboxItem["cursorState"]) ?? undefined,
 		specialUse: (row.specialUse as MailboxItem["specialUse"]) ?? undefined,
 		createdAt: row.createdAt,