@fluidframework/container-runtime 2.1.0-276326 → 2.1.0-281041

package/README.md

@@ -1,5 +1,39 @@
 # @fluidframework/container-runtime
 
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
+
+## Installation
+
+To get started, install the package by running the following command:
+
+```bash
+npm i @fluidframework/container-runtime
+```
+
+## Importing from this package
+
+This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
+For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+
+To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/container-runtime` like normal.
+
+To access the `legacy` APIs, import via `@fluidframework/container-runtime/legacy`.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## Data Virtualization For DataStores (Work in Progress)
 
 It's a capability to exclude some content from initial snapshot (used when loading container) and thus improve boot
@@ -45,37 +79,58 @@ fetch snapshot for that group of datastores rather than one network call for eac
 can get fairly big in size content wise and which are not required to be loaded on boot, can be put under a non-default
 groupId.
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
 
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
-## Using Fluid Framework libraries
+## API Documentation
 
-When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
-While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
-library consumers should always prefer `^`.
+API documentation for **@fluidframework/container-runtime** is available at <https://fluidframework.com/docs/apis/container-runtime>.
 
-## Installation
+## Minimum Client Requirements
 
-To get started, install the package by running the following command:
+These are the platform requirements for the current version of Fluid Framework Client Packages.
+These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
+For Long Term Support (LTS) versions this can require supporting these platforms for several years.
 
-```bash
-npm i @fluidframework/container-runtime
-```
+It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
+If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
+When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.
 
-## Importing from this package
+### Supported Runtimes
 
-This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
-For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+-   NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
+-   Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).
 
-To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/container-runtime` like normal.
+### Supported Tools
 
-To access the `legacy` APIs, import via `@fluidframework/container-runtime/legacy`.
+-   TypeScript 5.4:
+    -   All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
+    -   [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
+    -   [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
+    -   `exactOptionalPropertyTypes` is currently not fully supported.
+        If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
+-   [webpack](https://webpack.js.org/) 5
+    -   We are not intending to be prescriptive about what bundler to use.
+        Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
 
-## API Documentation
+### Module Resolution
 
-API documentation for **@fluidframework/container-runtime** is available at <https://fluidframework.com/docs/apis/container-runtime>.
+[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
+Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.
+
+### Module Formats
+
+-   ES Modules:
+    ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
+-   CommonJs:
+    Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
+    This is done to accommodate some workflows without good ES Module support.
+    If you have a workflow you would like included in this list, file an issue.
+    Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
+
+    -   Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
 
 ## Contribution Guidelines
 
@@ -97,11 +152,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
 
 ## Help
 
-Not finding what you're looking for in this README? Check out our [GitHub
-Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
+Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
 
-Still not finding what you're looking for? Please [file an
-issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
 
 Thank you!
 

package/api-extractor/api-extractor.current.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+}

package/api-extractor/api-extractor.legacy.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-base.esm.legacy.json"
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
 }

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
+	"extends": "../../../common/build/build-common/api-extractor-model.esm.json"
 }

package/api-report/container-runtime.legacy.public.api.md

@@ -0,0 +1,9 @@
+## Public API Report File for "@fluidframework/container-runtime"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/{blobManager.d.ts → blobManager/blobManager.d.ts}

@@ -6,9 +6,10 @@ import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ICriticalContainerError } from "@fluidframework/container-definitions";
 import { IContainerRuntime, IContainerRuntimeEvents } from "@fluidframework/container-runtime-definitions/internal";
 import { IFluidHandleContext, type IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
-import { IDocumentStorageService, ISnapshotTree, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import { IDocumentStorageService, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions/internal";
 import { FluidHandleBase } from "@fluidframework/runtime-utils/internal";
+import { type IBlobManagerLoadInfo } from "./blobManagerSnapSum.js";
 /**
  * This class represents blob (long string)
  * This object is used only when creating (writing) new blob and serialization purposes.
@@ -28,15 +29,6 @@ export declare class BlobHandle extends FluidHandleBase<ArrayBufferLike> {
     attachGraph(): void;
     bind(handle: IFluidHandleInternal): void;
 }
-/**
- * Information from a snapshot needed to load BlobManager
- * @legacy
- * @alpha
- */
-export interface IBlobManagerLoadInfo {
-    ids?: string[];
-    redirectTable?: [string, string][];
-}
 export type IBlobManagerRuntime = Pick<IContainerRuntime, "attachState" | "connected" | "baseLogger" | "clientDetails"> & TypedEventEmitter<IContainerRuntimeEvents>;
 export interface IPendingBlobs {
     [id: string]: {
@@ -50,9 +42,8 @@ export interface IPendingBlobs {
 export interface IBlobManagerEvents {
     (event: "noPendingBlobs", listener: () => void): any;
 }
+export declare const blobManagerBasePath: "_blobs";
 export declare class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
-    static readonly basePath = "_blobs";
-    private static readonly redirectTableBlobName;
     private readonly mc;
     /**
      * Map of local IDs to storage IDs. Contains identity entries (id → id) for storage IDs. All requested IDs should
@@ -109,11 +100,6 @@ export declare class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
      * Upload blobs added while offline. This must be completed before connecting and resubmitting ops.
      */
     trackPendingStashedUploads(): Promise<void>;
-    /**
-     * Set of actual storage IDs (i.e., IDs that can be requested from storage). This will be empty if the container is
-     * detached or there are no (non-pending) attachment blobs in the document
-     */
-    private get storageIds();
     getBlob(blobId: string): Promise<ArrayBufferLike>;
     private getBlobHandle;
     private createBlobDetached;
@@ -134,17 +120,6 @@ export declare class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
      */
     reSubmit(metadata: Record<string, unknown> | undefined): void;
     processBlobAttachOp(message: ISequencedDocumentMessage, local: boolean): void;
-    /**
-     * Reads blobs needed to load BlobManager from storage.
-     * @param blobsTree - Tree containing IDs of previously attached blobs. We
-     * look for the IDs in the blob entries of the tree since the both the r11s
-     * and SPO drivers replace the attachment types returned in snapshot() with blobs.
-     */
-    static load(blobsTree: ISnapshotTree | undefined, tryFetchBlob: (id: string) => Promise<[string, string][]>): Promise<IBlobManagerLoadInfo>;
-    /**
-     * Load a set of previously attached blob IDs and redirect table from a previous snapshot.
-     */
-    private load;
     summarize(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be
@@ -162,7 +137,7 @@ export declare class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
     deleteSweepReadyNodes(sweepReadyBlobRoutes: readonly string[]): readonly string[];
     /**
      * Delete blobs with the given routes from the redirect table.
-     * The routes are GC nodes paths of format -`/<BlobManager.basePath>/<blobId>`. The blob ids are all local ids.
+     * The routes are GC nodes paths of format -`/<blobManagerBasePath>/<blobId>`. The blob ids are all local ids.
      * Deleting the blobs involves 2 steps:
      * 1. The redirect table entry for the local ids are deleted.
      * 2. If the storage ids corresponding to the deleted local ids are not in-use anymore, the redirect table entries
@@ -178,6 +153,21 @@ export declare class BlobManager extends TypedEventEmitter<IBlobManagerEvents> {
      */
     private verifyBlobNotDeleted;
     setRedirectTable(table: Map<string, string>): void;
+    /**
+     * Part of container serialization when imminent closure is enabled (Currently when calling closeAndGetPendingLocalState).
+     * This asynchronous function resolves all pending createBlob calls and waits for each blob
+     * to be attached. It will also send BlobAttach ops for each pending blob that hasn't sent it
+     * yet so that serialized container can resubmit them when rehydrated.
+     *
+     * @param stopBlobAttachingSignal - Optional signal to abort the blob attaching process.
+     * @returns - A promise that resolves with the details of the attached blobs,
+     * or undefined if no blobs were processed.
+     */
     attachAndGetPendingBlobs(stopBlobAttachingSignal?: AbortSignal): Promise<IPendingBlobs | undefined>;
 }
+/**
+ * Returns whether a given path is for attachment blobs that are in the format - "/blobManagerBasePath/...".
+ */
+export declare const isBlobPath: (path: string) => path is `/_blobs/${string}`;
+export declare const areBlobPathParts: (pathParts: string[]) => pathParts is ["", "_blobs", string];
 //# sourceMappingURL=blobManager.d.ts.map

package/dist/blobManager/blobManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobManager.d.ts","sourceRoot":"","sources":["../../src/blobManager/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,iBAAiB,EAGjB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAe,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EACN,iBAAiB,EACjB,uBAAuB,EACvB,MAAM,wDAAwD,CAAC;AAChE,OAAO,EACN,mBAAmB,EACnB,KAAK,oBAAoB,EACzB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,uBAAuB,EAEvB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AAErD,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,eAAe,EAIf,MAAM,wCAAwC,CAAC;AAahD,OAAO,EAIN,KAAK,oBAAoB,EACzB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,eAAe,CAAC,eAAe,CAAC;aAU9C,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAZhC,OAAO,CAAC,QAAQ,CAAkB;IAElC,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,SAAgB,YAAY,EAAE,MAAM,CAAC;gBAGpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB,EAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,EACzB,aAAa,CAAC,SAAQ,IAAI,aAAA;IAMrC,WAAW;IAOX,IAAI,CAAC,MAAM,EAAE,oBAAoB;CAGxC;AAID,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACrC,iBAAiB,EACjB,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,eAAe,CAC5D,GACA,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAmB5C,MAAM,WAAW,aAAa;IAC7B,CAAC,EAAE,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,KAAK,CAAC,EAAE,OAAO,CAAC;KAChB,CAAC;CACF;AAED,MAAM,WAAW,kBAAkB;IAClC,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAChD;AAYD,eAAO,MAAM,mBAAmB,UAAoB,CAAC;AAErD,qBAAa,WAAY,SAAQ,iBAAiB,CAAC,kBAAkB,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAEhE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuC;IAEpE;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoC;IAEhE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgD;IACjF,OAAO,CAAC,aAAa,CAAkB;IAEvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAG3D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAG3D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgC;IAC9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4C;gBAE/D,KAAK,EAAE;QAClB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;QAC3C,QAAQ,EAAE,oBAAoB,CAAC;QAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,uBAAuB,CAAC;QACnD;;;;;;;;;WASG;QACH,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;QAGhE,QAAQ,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;QAGnD,QAAQ,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;QACtD,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;QACtC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;QACxC,QAAQ,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;KACnE;IA0FD,IAAW,gBAAgB,IAAI,OAAO,CAOrC;IAED,IAAW,eAAe,IAAI,OAAO,CAKpC;IAED,OAAO,CAAC,gBAAgB;IAOjB,wBAAwB,IAAI,OAAO;IAG1C;;OAEG;IACU,0BAA0B,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB3C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAqC9D,OAAO,CAAC,aAAa;YAuBP,kBAAkB;IAUnB,UAAU,CACtB,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;YA4CnC,UAAU;IAwCxB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IA2CvB;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAiBtD,mBAAmB,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO;IAoDtE,SAAS,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB;IAI7E;;;;;OAKG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IAejE;;;;;OAKG;IACI,qBAAqB,CAAC,oBAAoB,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE;IAKxF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,4BAA4B;IA8CpC;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAqBrB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAiBlD;;;;;;;;;OASG;IACU,wBAAwB,CACpC,uBAAuB,CAAC,EAAE,WAAW,GACnC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;CA2ErC;AAkBD;;GAEG;AACH,eAAO,MAAM,UAAU,SAAU,MAAM,gCACL,CAAC;AAEnC,eAAO,MAAM,gBAAgB,cACjB,MAAM,EAAE,wCAE2C,CAAC"}

package/dist/{blobManager.js → blobManager/blobManager.js}

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlobManager = exports.BlobHandle = void 0;
+exports.areBlobPathParts = exports.isBlobPath = exports.BlobManager = exports.blobManagerBasePath = exports.BlobHandle = void 0;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/core-utils/internal");
@@ -12,6 +12,7 @@ const internal_2 = require("@fluidframework/driver-utils/internal");
 const internal_3 = require("@fluidframework/runtime-utils/internal");
 const internal_4 = require("@fluidframework/telemetry-utils/internal");
 const uuid_1 = require("uuid");
+const blobManagerSnapSum_js_1 = require("./blobManagerSnapSum.js");
 /**
  * This class represents blob (long string)
  * This object is used only when creating (writing) new blob and serialization purposes.
@@ -49,6 +50,7 @@ const stashedPendingBlobOverrides = {
     minTTLInSeconds: undefined,
     uploadTime: undefined,
 };
+exports.blobManagerBasePath = "_blobs";
 class BlobManager extends client_utils_1.TypedEventEmitter {
     constructor(props) {
         super();
@@ -74,7 +76,7 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
             logger: this.runtime.baseLogger,
             namespace: "BlobManager",
         });
-        this.redirectTable = this.load(snapshot);
+        this.redirectTable = (0, blobManagerSnapSum_js_1.toRedirectTable)(snapshot, this.mc.logger, this.runtime.attachState);
         // Begin uploading stashed blobs from previous container instance
         Object.entries(stashedBlobs ?? {}).forEach(([localId, entry]) => {
             const { acked, storageId, minTTLInSeconds, uploadTime } = entry;
@@ -165,20 +167,6 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
             count: pendingUploads.length,
         }, async () => Promise.all(pendingUploads), { start: true, end: true });
     }
-    /**
-     * Set of actual storage IDs (i.e., IDs that can be requested from storage). This will be empty if the container is
-     * detached or there are no (non-pending) attachment blobs in the document
-     */
-    get storageIds() {
-        const ids = new Set(this.redirectTable.values());
-        // If we are detached, we will not have storage IDs, only undefined
-        const undefinedValueInTable = ids.delete(undefined);
-        // For a detached container, entries are inserted into the redirect table with an undefined storage ID.
-        // For an attached container, entries are inserted w/storage ID after the BlobAttach op round-trips.
-        (0, internal_1.assert)(!undefinedValueInTable ||
-            (this.runtime.attachState === container_definitions_1.AttachState.Detached && ids.size === 0), 0x382 /* 'redirectTable' must contain only undefined while detached / defined values while attached */);
-        return ids;
-    }
     async getBlob(blobId) {
         // Verify that the blob is not deleted, i.e., it has not been garbage collected. If it is, this will throw
         // an error, failing the call.
@@ -210,14 +198,16 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
     getBlobHandle(id) {
         (0, internal_1.assert)(this.redirectTable.has(id) || this.pendingBlobs.has(id), 0x384 /* requesting handle for unknown blob */);
         const pending = this.pendingBlobs.get(id);
+        // Create a callback function for once the blob has been attached
         const callback = pending
             ? () => {
                 pending.attached = true;
+                // Notify listeners (e.g. serialization process) that blob has been attached
                 this.emit("blobAttached", pending);
                 this.deletePendingBlobMaybe(id);
             }
             : undefined;
-        return new BlobHandle(`${BlobManager.basePath}/${id}`, this.routeContext, async () => this.getBlob(id), callback);
+        return new BlobHandle(getGCNodePathFromBlobId(id), this.routeContext, async () => this.getBlob(id), callback);
     }
     async createBlobDetached(blob) {
         // Blobs created while the container is detached are stored in IDetachedBlobStorage.
@@ -325,7 +315,8 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
         if (!entry.opsent) {
             this.sendBlobAttachOp(localId, response.id);
         }
-        if (this.storageIds.has(response.id)) {
+        const storageIds = (0, blobManagerSnapSum_js_1.getStorageIds)(this.redirectTable, this.runtime.attachState);
+        if (storageIds.has(response.id)) {
             // The blob is de-duped. Set up a local ID to storage ID mapping and return the blob. Since this is
             // an existing blob, we don't have to wait for the op to be ack'd since this step has already
             // happened before and so, the server won't delete it.
@@ -403,60 +394,8 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
             }
         }
     }
-    /**
-     * Reads blobs needed to load BlobManager from storage.
-     * @param blobsTree - Tree containing IDs of previously attached blobs. We
-     * look for the IDs in the blob entries of the tree since the both the r11s
-     * and SPO drivers replace the attachment types returned in snapshot() with blobs.
-     */
-    static async load(blobsTree, tryFetchBlob) {
-        if (!blobsTree) {
-            return {};
-        }
-        let redirectTable;
-        const tableId = blobsTree.blobs[this.redirectTableBlobName];
-        if (tableId) {
-            redirectTable = await tryFetchBlob(tableId);
-        }
-        const ids = Object.entries(blobsTree.blobs)
-            .filter(([k, _]) => k !== this.redirectTableBlobName)
-            .map(([_, v]) => v);
-        return { ids, redirectTable };
-    }
-    /**
-     * Load a set of previously attached blob IDs and redirect table from a previous snapshot.
-     */
-    load(snapshot) {
-        this.mc.logger.sendTelemetryEvent({
-            eventName: "AttachmentBlobsLoaded",
-            count: snapshot.ids?.length ?? 0,
-            redirectTable: snapshot.redirectTable?.length,
-        });
-        const table = new Map(snapshot.redirectTable);
-        if (snapshot.ids) {
-            const detached = this.runtime.attachState === container_definitions_1.AttachState.Detached;
-            // If we are detached, we don't have storage IDs yet, so set to undefined
-            // Otherwise, set identity (id -> id) entries
-            snapshot.ids.forEach((entry) => table.set(entry, detached ? undefined : entry));
-        }
-        return table;
-    }
     summarize(telemetryContext) {
-        // if storageIds is empty, it means we are detached and have only local IDs, or that there are no blobs attached
-        const blobIds = this.storageIds.size > 0
-            ? Array.from(this.storageIds)
-            : Array.from(this.redirectTable.keys());
-        const builder = new internal_3.SummaryTreeBuilder();
-        blobIds.forEach((blobId) => {
-            builder.addAttachment(blobId);
-        });
-        // Any non-identity entries in the table need to be saved in the summary
-        if (this.redirectTable.size > blobIds.length) {
-            builder.addBlob(BlobManager.redirectTableBlobName, 
-            // filter out identity entries
-            JSON.stringify(Array.from(this.redirectTable.entries()).filter(([localId, storageId]) => localId !== storageId)));
-        }
-        return builder.getSummaryTree();
+        return (0, blobManagerSnapSum_js_1.summarizeBlobManagerState)(this.redirectTable, this.runtime.attachState);
     }
     /**
      * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be
@@ -490,7 +429,7 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
     }
     /**
      * Delete blobs with the given routes from the redirect table.
-     * The routes are GC nodes paths of format -`/<BlobManager.basePath>/<blobId>`. The blob ids are all local ids.
+     * The routes are GC nodes paths of format -`/<blobManagerBasePath>/<blobId>`. The blob ids are all local ids.
      * Deleting the blobs involves 2 steps:
      * 1. The redirect table entry for the local ids are deleted.
      * 2. If the storage ids corresponding to the deleted local ids are not in-use anymore, the redirect table entries
@@ -554,7 +493,7 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
         // Only log deleted events. Tombstone events are logged by garbage collector.
         this.mc.logger.sendErrorEvent({
             eventName: "GC_Deleted_Blob_Requested",
-            pkg: BlobManager.basePath,
+            pkg: exports.blobManagerBasePath,
         }, error);
         throw error;
     }
@@ -568,6 +507,16 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
             this.setRedirection(storageId, storageId);
         }
     }
+    /**
+     * Part of container serialization when imminent closure is enabled (Currently when calling closeAndGetPendingLocalState).
+     * This asynchronous function resolves all pending createBlob calls and waits for each blob
+     * to be attached. It will also send BlobAttach ops for each pending blob that hasn't sent it
+     * yet so that serialized container can resubmit them when rehydrated.
+     *
+     * @param stopBlobAttachingSignal - Optional signal to abort the blob attaching process.
+     * @returns - A promise that resolves with the details of the attached blobs,
+     * or undefined if no blobs were processed.
+     */
     async attachAndGetPendingBlobs(stopBlobAttachingSignal) {
         return internal_4.PerformanceEvent.timedExecAsync(this.mc.logger, { eventName: "GetPendingBlobs" }, async () => {
             if (this.pendingBlobs.size === 0) {
@@ -575,12 +524,17 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
             }
             const blobs = {};
             const localBlobs = new Set();
+            // This while is used to stash blobs created while attaching and getting blobs
             while (localBlobs.size < this.pendingBlobs.size) {
                 const attachBlobsP = [];
                 for (const [id, entry] of this.pendingBlobs) {
                     if (!localBlobs.has(entry)) {
                         localBlobs.add(entry);
+                        // Resolving the blob handle to let hosts continue with their operations (it will resolve
+                        // original createBlob call) and let them attach the blob. This is a lie we told since the upload
+                        // hasn't finished yet, but it's fine since we will retry on rehydration.
                         entry.handleP.resolve(this.getBlobHandle(id));
+                        // Array of promises that will resolve when blobs get attached.
                         attachBlobsP.push(new Promise((resolve, reject) => {
                             stopBlobAttachingSignal?.addEventListener("abort", () => {
                                 this.stopAttaching = true;
@@ -601,6 +555,8 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
                         }));
                     }
                 }
+                // Wait for all blobs to be attached. This is important, otherwise serialized container
+                // could send the blobAttach op without any op that references the blob, making it useless.
                 await Promise.allSettled(attachBlobsP).catch(() => { });
             }
             for (const [id, entry] of this.pendingBlobs) {
@@ -628,22 +584,25 @@ class BlobManager extends client_utils_1.TypedEventEmitter {
     }
 }
 exports.BlobManager = BlobManager;
-BlobManager.basePath = "_blobs";
-BlobManager.redirectTableBlobName = ".redirectTable";
 /**
- * For a blobId, returns its path in GC's graph. The node path is of the format `/<BlobManager.basePath>/<blobId>`.
+ * For a blobId, returns its path in GC's graph. The node path is of the format `/<blobManagerBasePath>/<blobId>`.
  * This path must match the path of the blob handle returned by the createBlob API because blobs are marked
  * referenced by storing these handles in a referenced DDS.
  */
-function getGCNodePathFromBlobId(blobId) {
-    return `/${BlobManager.basePath}/${blobId}`;
-}
+const getGCNodePathFromBlobId = (blobId) => `/${exports.blobManagerBasePath}/${blobId}`;
 /**
- * For a given GC node path, return the blobId. The node path is of the format `/<BlobManager.basePath>/<blobId>`.
+ * For a given GC node path, return the blobId. The node path is of the format `/<basePath>/<blobId>`.
  */
-function getBlobIdFromGCNodePath(nodePath) {
+const getBlobIdFromGCNodePath = (nodePath) => {
     const pathParts = nodePath.split("/");
-    (0, internal_1.assert)(pathParts.length === 3 && pathParts[1] === BlobManager.basePath, 0x5bd /* Invalid blob node path */);
+    (0, internal_1.assert)((0, exports.areBlobPathParts)(pathParts), 0x5bd /* Invalid blob node path */);
     return pathParts[2];
-}
+};
+/**
+ * Returns whether a given path is for attachment blobs that are in the format - "/blobManagerBasePath/...".
+ */
+const isBlobPath = (path) => (0, exports.areBlobPathParts)(path.split("/"));
+exports.isBlobPath = isBlobPath;
+const areBlobPathParts = (pathParts) => pathParts.length === 3 && pathParts[1] === exports.blobManagerBasePath;
+exports.areBlobPathParts = areBlobPathParts;
 //# sourceMappingURL=blobManager.js.map