@remit/imap-worker 0.0.90 → 0.0.92

package/src/events.ts

@@ -1,252 +0,0 @@
-import type {
-	MUTATION_EVENT_SCHEMA_VERSION,
-	PATHLESS_MUTATION_EVENT_SCHEMA_VERSION,
-} from "@remit/data-ports/mutation-events";
-
-export interface BaseEvent {
-	accountId: string;
-	eventId: string; // Idempotency key
-	timestamp: number; // Unix timestamp
-}
-
-export interface SyncMailboxesEvent extends BaseEvent {
-	type: "SYNC_MAILBOXES";
-	/**
-	 * Set by POST /sync — the only trigger a person asks for by name. It makes
-	 * the fan-out sync every mailbox, skipping the freshness gate that keeps
-	 * incidental triggers (config load, OAuth connect, the scheduled tick) from
-	 * re-enumerating folders that were just enumerated.
-	 */
-	explicitRequest?: boolean;
-}
-
-export interface SyncMessagesEvent extends BaseEvent {
-	type: "SYNC_MESSAGES";
-	mailboxId: string;
-	fullSync?: boolean; // If true, ignore lastSyncUid
-}
-
-/**
- * A message to body-sync, carrying the UID resolved at envelope-sync time so
- * the consumer can issue one ranged FETCH without a per-message DDB lookup.
- */
-export interface SyncMessageBodyTarget {
-	messageId: string;
-	uid: number;
-}
-
-export interface SyncMessageBodyEvent extends BaseEvent {
-	type: "SYNC_MESSAGE_BODY";
-	mailboxId: string;
-	/**
-	 * Message ids to sync. Always present for backward compatibility; the
-	 * consumer falls back to this list (looking up each UID) when `messages`
-	 * is absent.
-	 */
-	messageIds: string[];
-	/**
-	 * Preferred shape: messageId+uid pairs. When present, the consumer skips the
-	 * per-message UID lookup and fetches the whole batch in one ranged FETCH.
-	 * Optional so older in-flight events (ids only) still process.
-	 */
-	messages?: SyncMessageBodyTarget[];
-	/**
-	 * Set only by the read-miss re-arm cue (`BodySyncQueueService.requestBodySync`,
-	 * called when a `/content` read finds `bodyStorageKey` set but the storage
-	 * object missing). Tells the consumer to bypass the "already stored" skip
-	 * guard and re-fetch + rewrite the body even though the DB row already
-	 * carries a `bodyStorageKey` — otherwise stale metadata (key set, object
-	 * gone) makes the read-miss retry loop forever, since the bulk skip guard
-	 * would keep treating the message as already synced. Optional so older
-	 * in-flight events (no force) keep the original skip behavior.
-	 */
-	force?: boolean;
-}
-
-export interface MailboxCreateEvent extends BaseEvent {
-	type: "MAILBOX_CREATE";
-	mailboxId: string;
-	path: string;
-	subscribe?: boolean;
-}
-
-export interface MailboxRenameEvent extends BaseEvent {
-	type: "MAILBOX_RENAME";
-	mailboxId: string;
-	oldPath: string;
-	newPath: string;
-}
-
-export interface MailboxDeleteEvent extends BaseEvent {
-	type: "MAILBOX_DELETE";
-	mailboxId: string;
-	path: string;
-}
-
-export type MailboxManagementEvent =
-	| MailboxCreateEvent
-	| MailboxRenameEvent
-	| MailboxDeleteEvent;
-
-/**
- * Event for deleting a message (move to trash or permanent delete).
- */
-interface MessageDeleteEventFields extends BaseEvent {
-	type: "MESSAGE_DELETE";
-	messageId: string;
-	mailboxId: string;
-	uid: number;
-	operation: "move_to_trash" | "permanent_delete";
-	destinationMailboxId?: string;
-}
-
-export interface MessageDeleteEventV2 extends MessageDeleteEventFields {
-	schemaVersion: typeof MUTATION_EVENT_SCHEMA_VERSION;
-	mailboxPath: string;
-	destinationMailboxPath?: string;
-}
-
-export interface MessageDeleteEventV3 extends MessageDeleteEventFields {
-	schemaVersion: typeof PATHLESS_MUTATION_EVENT_SCHEMA_VERSION;
-}
-
-export type MessageDeleteEvent = MessageDeleteEventV2 | MessageDeleteEventV3;
-
-/**
- * Event for moving a message to another mailbox.
- */
-interface MessageMoveEventFields extends BaseEvent {
-	type: "MESSAGE_MOVE";
-	messageId: string;
-	sourceMailboxId: string;
-	destinationMailboxId: string;
-	uid: number;
-}
-
-export interface MessageMoveEventV1 extends MessageMoveEventFields {
-	schemaVersion?: undefined;
-	sourceMailboxPath: string;
-	destinationMailboxPath: string;
-}
-
-export interface MessageMoveEventV3 extends MessageMoveEventFields {
-	schemaVersion: typeof PATHLESS_MUTATION_EVENT_SCHEMA_VERSION;
-}
-
-export type MessageMoveEvent = MessageMoveEventV1 | MessageMoveEventV3;
-
-/**
- * Event for emptying the Trash mailbox.
- */
-interface EmptyTrashEventFields extends BaseEvent {
-	type: "EMPTY_TRASH";
-	trashMailboxId: string;
-	/**
-	 * The Trash folder's UIDVALIDITY at the moment the user consented. The
-	 * handler compares it against what the SELECT serves: a path reused by a
-	 * different folder (rename plus recreate) answers with a different value,
-	 * and this is the only comparison the mutating connection cannot race.
-	 */
-	trashUidValidity: number;
-}
-
-export interface EmptyTrashEventV2 extends EmptyTrashEventFields {
-	schemaVersion: typeof MUTATION_EVENT_SCHEMA_VERSION;
-	trashMailboxPath: string;
-}
-
-export interface EmptyTrashEventV3 extends EmptyTrashEventFields {
-	schemaVersion: typeof PATHLESS_MUTATION_EVENT_SCHEMA_VERSION;
-}
-
-export type EmptyTrashEvent = EmptyTrashEventV2 | EmptyTrashEventV3;
-
-/**
- * Event for copying a message to another mailbox.
- */
-interface MessageCopyEventFields extends BaseEvent {
-	type: "MESSAGE_COPY";
-	sourceMessageId: string;
-	newMessageId: string;
-	sourceMailboxId: string;
-	destinationMailboxId: string;
-	uid: number;
-}
-
-export interface MessageCopyEventV1 extends MessageCopyEventFields {
-	schemaVersion?: undefined;
-	sourceMailboxPath: string;
-	destinationMailboxPath: string;
-}
-
-export interface MessageCopyEventV3 extends MessageCopyEventFields {
-	schemaVersion: typeof PATHLESS_MUTATION_EVENT_SCHEMA_VERSION;
-}
-
-export type MessageCopyEvent = MessageCopyEventV1 | MessageCopyEventV3;
-
-/**
- * Event for appending a sent message to the Sent mailbox via IMAP APPEND.
- */
-export interface AppendSentMessageEvent extends BaseEvent {
-	type: "APPEND_SENT_MESSAGE";
-	outboxMessageId: string;
-}
-
-/**
- * Drains one pending placement-move marker (issue #1271, epic #1281) to
- * IMAP. Deliberately carries no UID and no destination — both are resolved
- * fresh from the Message row and the `MessagePlacementMove` marker at push
- * time (epic invariant 1), so this event stays valid across any amount of
- * queue delay or an unrelated UIDVALIDITY rebuild (#1272). If the marker is
- * gone by the time this is processed (confirmed, superseded, or an external
- * delete already reconciled it), the handler is a no-op.
- */
-export interface PlacementMovePushEvent extends BaseEvent {
-	type: "PLACEMENT_MOVE_PUSH";
-	accountConfigId: string;
-	messageId: string;
-}
-
-/**
- * Wake-up hint for one pending flag-push marker (issue #1273, epic #1281).
- * Carries only our message id + the flag field — never a UID and never the
- * desired add/remove transition (both live on the `MessageFlagPush` marker,
- * resolved fresh at push time, epic invariant 1). Produced two ways: by
- * `FlagPushService` (remit-mailbox-service) right after a user's flag flip
- * commits locally, and by the periodic per-mailbox sync tick
- * (`sync-messages.ts`) re-arming any marker it finds still stuck `pending`
- * (a prior enqueue that never landed). If the marker is gone or has moved
- * past `pending` by the time this is processed, the handler is a no-op.
- */
-export interface FlagPushEvent extends BaseEvent {
-	type: "FLAG_PUSH";
-	accountConfigId: string;
-	messageId: string;
-	flagName: string;
-}
-
-export interface DeleteAccountObjectsEvent {
-	type: "DELETE_ACCOUNT_OBJECTS";
-	accountConfigId: string;
-	continuationToken?: string;
-}
-
-/** Union of all event types the worker can process (including non-IMAP ones). */
-export type WorkerEvent = ImapEvent | DeleteAccountObjectsEvent;
-
-export type MessageManagementEvent =
-	| MessageDeleteEvent
-	| MessageMoveEvent
-	| EmptyTrashEvent
-	| MessageCopyEvent;
-
-export type ImapEvent =
-	| SyncMailboxesEvent
-	| SyncMessagesEvent
-	| SyncMessageBodyEvent
-	| MailboxManagementEvent
-	| MessageManagementEvent
-	| AppendSentMessageEvent
-	| PlacementMovePushEvent
-	| FlagPushEvent;

package/src/failure-kind.test.ts

@@ -1,42 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { RefreshTokenError } from "@remit/mail-oauth-service";
-import { MailConnectionError } from "@remit/mailbox-service";
-import { imapFailureKind } from "./failure-kind.js";
-
-describe("imapFailureKind", () => {
-	it("counts an IMAP authentication rejection as auth", () => {
-		assert.equal(
-			imapFailureKind(
-				new MailConnectionError("auth", "IMAP authentication failed"),
-			),
-			"auth",
-		);
-	});
-
-	it("counts a token refresh that cannot mint credentials as auth", () => {
-		assert.equal(
-			imapFailureKind(
-				new RefreshTokenError({
-					kind: "reauth-required",
-					code: "invalid_grant",
-				}),
-			),
-			"auth",
-		);
-	});
-
-	it("keeps a network failure apart from an auth failure", () => {
-		assert.equal(
-			imapFailureKind(
-				new MailConnectionError("network", "IMAP connection failed: ETIMEDOUT"),
-			),
-			"network",
-		);
-	});
-
-	it("classifies anything else as other", () => {
-		assert.equal(imapFailureKind(new Error("bad cursor")), "other");
-		assert.equal(imapFailureKind(undefined), "other");
-	});
-});

package/src/handlers/append-sent-message.sqlite.test.ts

@@ -1,176 +0,0 @@
-import assert from "node:assert/strict";
-import { after, before, describe, it } from "node:test";
-import type { OutboxMessageItem } from "@remit/data-ports";
-import { MailboxSpecialUse, OutboxMessageStatus } from "@remit/domain-enums";
-import type { AppendSentMessageEvent } from "../events.js";
-import { openStore, type World } from "../test-helpers/test-world.js";
-import { handleAppendSentMessage } from "./append-sent-message.js";
-
-let store: Awaited<ReturnType<typeof openStore>>;
-
-before(async () => {
-	store = await openStore();
-});
-
-after(() => store.close());
-
-interface Arranged {
-	w: World;
-	outbox: OutboxMessageItem;
-	event: AppendSentMessageEvent;
-}
-
-/**
- * A message composed and sent through the service the API calls, then marked
- * sent the way the SMTP worker marks it once the relay accepted it.
- */
-const arrange = async (
-	options: { sentFolder?: boolean; attachment?: Buffer } = {},
-): Promise<Arranged> => {
-	const w = await store.world();
-	await w.folder("INBOX");
-	if (options.sentFolder !== false) {
-		await w.folder("Sent", { specialUse: MailboxSpecialUse.Sent });
-	}
-	const { outbox: draft } = await w.draft(options.attachment);
-	const outbox = await w.client.outboxQueue.send(
-		w.account.accountConfigId,
-		draft.outboxMessageId,
-	);
-	await w.client.outboxMessage.update(
-		w.account.accountConfigId,
-		outbox.outboxMessageId,
-		{ status: OutboxMessageStatus.sent, sentAt: Date.now() },
-	);
-	return {
-		w,
-		outbox,
-		event: {
-			type: "APPEND_SENT_MESSAGE",
-			eventId: `evt-${outbox.outboxMessageId}`,
-			timestamp: Date.now(),
-			accountId: w.account.accountId,
-			outboxMessageId: outbox.outboxMessageId,
-		} as AppendSentMessageEvent,
-	};
-};
-
-const run = (a: Arranged, receiveCount = 1) =>
-	handleAppendSentMessage(a.event, a.w.log, receiveCount, a.w.scope);
-
-const outboxRow = (a: Arranged) =>
-	a.w.client.outboxMessage
-		.get(a.w.account.accountConfigId, a.outbox.outboxMessageId)
-		.catch(() => undefined);
-
-describe("filing a sent message", () => {
-	it("stores a seen copy under its own Message-ID in Sent and drops the outbox row", async () => {
-		const a = await arrange();
-
-		await run(a);
-
-		const [copy] = a.w.imap.messages("Sent");
-		assert.equal(copy?.messageIdHeader, `<${a.outbox.messageIdValue}>`);
-		assert.ok(copy?.flags.includes("\\Seen"));
-		assert.match(
-			copy?.raw.toString("utf8") ?? "",
-			/Subject: Quarterly numbers/,
-		);
-		assert.equal(await outboxRow(a), undefined);
-	});
-
-	// #679: the Sent copy carries the files the wire copy carried, and the row
-	// was the only reference to them, so they go with it.
-	it("files the copy with its attachment and removes the stored file", async () => {
-		const a = await arrange({ attachment: Buffer.from("q1,q2\n1,2\n") });
-
-		await run(a);
-
-		const raw = a.w.imap.messages("Sent")[0]?.raw.toString("utf8") ?? "";
-		assert.match(raw, /^Content-Type: multipart\/mixed;/m);
-		assert.match(raw, /filename=numbers\.csv/);
-		assert.deepEqual(
-			await a.w.client.storage.listOutboxAttachments(
-				a.w.account.accountConfigId,
-				a.w.account.accountId,
-				a.outbox.outboxMessageId,
-			),
-			[],
-		);
-	});
-
-	it("settles the row as unfiled when the account has no Sent folder", async () => {
-		const a = await arrange({ sentFolder: false });
-
-		await run(a);
-
-		assert.equal(a.w.imap.connections, 0);
-		const row = await outboxRow(a);
-		assert.equal(row?.status, OutboxMessageStatus.unfiled);
-		assert.match(
-			String(row?.lastError),
-			/no folder appointed to the Sent role/,
-		);
-	});
-
-	it("files nothing while the message has not been sent yet", async () => {
-		const a = await arrange();
-		await a.w.client.outboxMessage.update(
-			a.w.account.accountConfigId,
-			a.outbox.outboxMessageId,
-			{ status: OutboxMessageStatus.queued },
-		);
-
-		await run(a);
-
-		assert.deepEqual(a.w.imap.commands("APPEND"), []);
-		assert.equal((await outboxRow(a))?.status, OutboxMessageStatus.queued);
-	});
-
-	it("keeps the row and redelivers a refused APPEND within the budget", async () => {
-		const a = await arrange();
-		a.w.imap.failNext.APPEND = new Error("Connection reset");
-
-		await assert.rejects(run(a), /Connection reset/);
-
-		assert.equal((await outboxRow(a))?.status, OutboxMessageStatus.sent);
-	});
-
-	it("settles the row as unfiled on the last attempt instead of dead-lettering it", async () => {
-		const a = await arrange();
-		a.w.imap.failNext.APPEND = new Error("Mailbox is full");
-
-		await run(a, 3);
-
-		const row = await outboxRow(a);
-		assert.equal(row?.status, OutboxMessageStatus.unfiled);
-		assert.match(String(row?.lastError), /Mailbox is full/);
-	});
-
-	// #858: a redelivery after the APPEND landed must not file a second copy.
-	it("files nothing a second time when the copy was already recorded", async () => {
-		const a = await arrange();
-		await a.w.client.outboxMessage.update(
-			a.w.account.accountConfigId,
-			a.outbox.outboxMessageId,
-			{ appendedUid: 41 },
-		);
-
-		await run(a);
-
-		assert.deepEqual(a.w.imap.commands("APPEND"), []);
-		assert.equal(await outboxRow(a), undefined);
-	});
-
-	it("acks an event whose outbox row is already gone", async () => {
-		const a = await arrange();
-		await a.w.client.outboxMessage.delete(
-			a.w.account.accountConfigId,
-			a.outbox.outboxMessageId,
-		);
-
-		await run(a);
-
-		assert.equal(a.w.imap.connections, 0);
-	});
-});