@remit/mailbox-service 2.0.3 → 2.1.0

package/dist/index.d.ts

@@ -41,7 +41,7 @@ export { denormalizeMessageCategory, type MessageCategoryDenormalizeDeps, type M
 export { type DeleteMessagesOutcome, type DeleteOptions, type MessageMoveConfig, type MessageMoveLogger, type MessageMoveQueueEvent, MessageMoveService, NoTrashMailboxError, requireTrashMailbox, StaleTrashAppointmentError, UnconfirmedTrashMailboxError, } from "./message-move.js";
 export { type ParsedMessageContent, parseMessageContent, } from "./message-parser.js";
 export { isMessageGoneFromOpenMailbox } from "./message-presence.js";
-export { type BodyPartMaterializer, type BodySyncCue, type MaterializeLogger, type MaterializeResult, materializeBodyParts, } from "./message-read.js";
+export { type BodyPartMaterializer, type BodyReadMiss, type BodyReadMissDeps, type BodyReadMissInput, type BodySyncCue, type MaterializeLogger, type MaterializeResult, materializeBodyParts, resolveBodyReadMiss, } from "./message-read.js";
 export { type ImapConnectionFactory, MessageSyncService, type SyncedMessage, type SyncMessagesResult, } from "./message-sync.js";
 export { type OrganizeJobDeps, type OrganizeJobLogger, type OrganizeJobOwner, type OrganizeJobPredicate, type OrganizeJobRequest, queueOrganizeJob, } from "./organize-job.js";
 export { type CompleteOutboxAttachmentInput, type CompleteOutboxAttachmentOutcome, type MintOutboxAttachmentInput, type MintOutboxAttachmentOutcome, OUTBOX_ATTACHMENT_MAX_COUNT, OUTBOX_ATTACHMENT_MAX_TOTAL_BYTES, type OutboxAttachmentConfig, type OutboxAttachmentRejectionDetail, type OutboxAttachmentRejectionReasonValue, type OutboxAttachmentReservation, OutboxAttachmentService, } from "./outbox-attachment.js";

package/dist/index.js

@@ -44,7 +44,7 @@ export { denormalizeMessageCategory, } from "./message-category.js";
 export { MessageMoveService, NoTrashMailboxError, requireTrashMailbox, StaleTrashAppointmentError, UnconfirmedTrashMailboxError, } from "./message-move.js";
 export { parseMessageContent, } from "./message-parser.js";
 export { isMessageGoneFromOpenMailbox } from "./message-presence.js";
-export { materializeBodyParts, } from "./message-read.js";
+export { materializeBodyParts, resolveBodyReadMiss, } from "./message-read.js";
 export { MessageSyncService, } from "./message-sync.js";
 export { queueOrganizeJob, } from "./organize-job.js";
 export { OUTBOX_ATTACHMENT_MAX_COUNT, OUTBOX_ATTACHMENT_MAX_TOTAL_BYTES, OutboxAttachmentService, } from "./outbox-attachment.js";

package/dist/message-read.d.ts

@@ -1,3 +1,5 @@
+import type { IEnvelopeRepository, IMailboxRepository, IMessageRepository } from "@remit/data-ports";
+import { type StorageService } from "@remit/storage-service";
 /**
  * The slice of `BodySyncService` the read path needs to lazily materialize
  * deferred per-part objects.
@@ -49,3 +51,33 @@ export declare const materializeBodyParts: (materializer: BodyPartMaterializer,
     cue: BodySyncCue;
     logger: MaterializeLogger;
 }) => Promise<MaterializeResult>;
+export type BodyReadMiss = "NotFound" | "Broken" | "Pending";
+export interface BodyReadMissDeps {
+    message: Pick<IMessageRepository, "get">;
+    mailbox: Pick<IMailboxRepository, "get">;
+    envelope: Pick<IEnvelopeRepository, "listBodyParts">;
+    storage: Pick<StorageService, "bodyPartExists" | "deleteKeys">;
+}
+export interface BodyReadMissInput {
+    accountConfigId: string;
+    accountId: string;
+    messageId: string;
+    partPath: string;
+}
+/**
+ * What a content read that found no object at a part key should answer. It
+ * never enqueues: the describe read path (`materializeBodyParts`) re-arms the
+ * body sync, and the client re-describes on every 202.
+ *
+ * - `NotFound` — the message, its mailbox under `accountId`, or a leaf at
+ *   `partPath` does not exist; no retry can produce the object.
+ * - `Broken` — the body sync exhausted its retries against a message the
+ *   server still holds (`isMessageBodySyncBroken`).
+ * - `Pending` — anything else; a retry after the next describe succeeds.
+ *
+ * A missing leaf under a present `.materialized` sentinel means the sentinel
+ * no longer vouches for its parts, and `ensureBodyPartsStored` would skip the
+ * message forever. The sentinel is dropped so the next describe materializes
+ * the parts again; that delete is the one write here.
+ */
+export declare const resolveBodyReadMiss: (deps: BodyReadMissDeps, { accountConfigId, accountId, messageId, partPath }: BodyReadMissInput) => Promise<BodyReadMiss>;

package/dist/message-read.js

@@ -1,4 +1,6 @@
-import { isStorageNotFoundError } from "@remit/storage-service";
+import { isEncapsulatedMessage } from "@remit/data-ports/message-parts";
+import { buildBodyPartKey, isStorageNotFoundError, MATERIALIZED_SENTINEL_PART_PATH, MATERIALIZED_SENTINEL_V2_PART_PATH, } from "@remit/storage-service";
+import { isMessageBodySyncBroken } from "./body-sync-terminal.js";
 /**
  * Materialize the deferred per-part storage objects for a message before any
  * part is read. Distinguishes the two failure modes the body contract cares
@@ -29,3 +31,45 @@ export const materializeBodyParts = async (materializer, args) => {
         return { ready: false };
     }
 };
+/**
+ * What a content read that found no object at a part key should answer. It
+ * never enqueues: the describe read path (`materializeBodyParts`) re-arms the
+ * body sync, and the client re-describes on every 202.
+ *
+ * - `NotFound` — the message, its mailbox under `accountId`, or a leaf at
+ *   `partPath` does not exist; no retry can produce the object.
+ * - `Broken` — the body sync exhausted its retries against a message the
+ *   server still holds (`isMessageBodySyncBroken`).
+ * - `Pending` — anything else; a retry after the next describe succeeds.
+ *
+ * A missing leaf under a present `.materialized` sentinel means the sentinel
+ * no longer vouches for its parts, and `ensureBodyPartsStored` would skip the
+ * message forever. The sentinel is dropped so the next describe materializes
+ * the parts again; that delete is the one write here.
+ */
+export const resolveBodyReadMiss = async (deps, { accountConfigId, accountId, messageId, partPath }) => {
+    const [message] = await deps.message.get([messageId]);
+    if (!message)
+        return "NotFound";
+    const [mailbox] = await deps.mailbox.get(accountId, [message.mailboxId]);
+    if (!mailbox)
+        return "NotFound";
+    if (await isMessageBodySyncBroken(deps.storage, accountConfigId, accountId, messageId)) {
+        return "Broken";
+    }
+    const bodyParts = await deps.envelope.listBodyParts(messageId);
+    const leaf = bodyParts.find((part) => part.partPath === partPath && !part.isMultipart);
+    if (!leaf)
+        return "NotFound";
+    if (!message.bodyStorageKey)
+        return "Pending";
+    const sentinel = bodyParts.some(isEncapsulatedMessage)
+        ? MATERIALIZED_SENTINEL_V2_PART_PATH
+        : MATERIALIZED_SENTINEL_PART_PATH;
+    if (await deps.storage.bodyPartExists(accountConfigId, accountId, messageId, sentinel)) {
+        await deps.storage.deleteKeys([
+            buildBodyPartKey(accountConfigId, accountId, messageId, sentinel),
+        ]);
+    }
+    return "Pending";
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/mailbox-service",
-	"version": "2.0.3",
+	"version": "2.1.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",