@fluidframework/container-runtime 2.33.2 → 2.40.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @fluidframework/container-runtime
 
+## 2.40.0
+
+### Minor Changes
+
+- IFluidHandleInternal.bind has been deprecated ([#24553](https://github.com/microsoft/FluidFramework/pull/24553)) [8a4362a7ed](https://github.com/microsoft/FluidFramework/commit/8a4362a7edef3a97fee13c9d23bea49448ba2a6a)
+
+  Handle binding is an internal concept used to make sure objects attach to the Container graph when their handle is stored in a DDS which is itself attached.
+  The source of the "bind" operation has been assumed to be any handle, but only one implementation is actually supported (`SharedObjectHandle`, not exported itself).
+
+  So the `bind` function is now deprecated on the `IFluidHandleInterface`, moving instead to internal types supporting the one valid implementation.
+  It's also deprecated on the various exported handle implementations that don't support it (each is either no-op, pass-through, or throwing).
+
+  No replacement is offered, this API was never meant to be called from outside of the Fluid Framework.
+
 ## 2.33.0
 
 Dependency updates only.

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

@@ -338,6 +338,7 @@ export interface LoadContainerRuntimeParams {
     containerScope?: FluidObject;
     context: IContainerContext;
     existing: boolean;
+    minVersionForCollab?: MinimumVersionForCollab;
     provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;
     registryEntries: NamedFluidDataStoreRegistryEntries;
     // @deprecated
@@ -345,6 +346,9 @@ export interface LoadContainerRuntimeParams {
     runtimeOptions?: IContainerRuntimeOptions;
 }
 
+// @alpha @legacy
+export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
+
 // @alpha @deprecated @legacy (undocumented)
 export type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
 

package/dist/blobManager/blobManager.d.ts

@@ -2,9 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IContainerRuntime, IContainerRuntimeEvents } from "@fluidframework/container-runtime-definitions/internal";
-import type { IEvent, IEventProvider, IFluidHandleContext, IFluidHandleInternal, IFluidHandleInternalPayloadPending } from "@fluidframework/core-interfaces/internal";
+import type { IEventProvider, IFluidHandleContext, IFluidHandleInternal, IFluidHandleInternalPayloadPending, ILocalFluidHandle, ILocalFluidHandleEvents, Listenable, PayloadState } from "@fluidframework/core-interfaces/internal";
 import { IDocumentStorageService, ICreateBlobResponse } from "@fluidframework/driver-definitions/internal";
 import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext, type ISequencedMessageEnvelope } from "@fluidframework/runtime-definitions/internal";
 import { FluidHandleBase } from "@fluidframework/runtime-utils/internal";
@@ -16,7 +15,7 @@ import { type IBlobManagerLoadInfo } from "./blobManagerSnapSum.js";
  * DataObject.request() recognizes requests in the form of `/blobs/<id>`
  * and loads blob.
  */
-export declare class BlobHandle extends FluidHandleBase<ArrayBufferLike> implements IFluidHandleInternalPayloadPending<ArrayBufferLike> {
+export declare class BlobHandle extends FluidHandleBase<ArrayBufferLike> implements ILocalFluidHandle<ArrayBufferLike>, IFluidHandleInternalPayloadPending<ArrayBufferLike> {
     readonly path: string;
     readonly routeContext: IFluidHandleContext;
     get: () => Promise<ArrayBufferLike>;
@@ -24,12 +23,27 @@ export declare class BlobHandle extends FluidHandleBase<ArrayBufferLike> impleme
     private readonly onAttachGraph?;
     private attached;
     get isAttached(): boolean;
+    private _events;
+    get events(): Listenable<ILocalFluidHandleEvents>;
+    private _state;
+    get payloadState(): PayloadState;
+    /**
+     * The error property starts undefined, signalling that there has been no error yet.
+     * If an error occurs, the property will contain the error.
+     */
+    private _payloadShareError;
+    get payloadShareError(): unknown;
     readonly absolutePath: string;
     constructor(path: string, routeContext: IFluidHandleContext, get: () => Promise<ArrayBufferLike>, payloadPending: boolean, onAttachGraph?: (() => void) | undefined);
+    readonly notifyShared: () => void;
+    readonly notifyFailed: (error: unknown) => void;
     attachGraph(): void;
+    /**
+     * @deprecated No replacement provided. Arbitrary handles may not serve as a bind source.
+     */
     bind(handle: IFluidHandleInternal): void;
 }
-export type IBlobManagerRuntime = Pick<IContainerRuntime, "attachState" | "connected" | "baseLogger" | "clientDetails" | "disposed"> & TypedEventEmitter<IContainerRuntimeEvents>;
+export type IBlobManagerRuntime = Pick<IContainerRuntime, "attachState" | "connected" | "baseLogger" | "clientDetails" | "disposed"> & IEventProvider<IContainerRuntimeEvents>;
 export interface IPendingBlobs {
     [localId: string]: {
         blob: string;
@@ -39,14 +53,14 @@ export interface IPendingBlobs {
         acked?: boolean;
     };
 }
-export interface IBlobManagerEvents extends IEvent {
-    (event: "noPendingBlobs", listener: () => void): any;
+export interface IBlobManagerEvents {
+    noPendingBlobs: () => void;
 }
 export declare const blobManagerBasePath: "_blobs";
 export declare class BlobManager {
     private readonly mc;
     private readonly publicEvents;
-    get events(): IEventProvider<IBlobManagerEvents>;
+    get events(): Listenable<IBlobManagerEvents>;
     private readonly internalEvents;
     /**
      * Map of local IDs to storage IDs. Contains identity entries (storageId → storageId) for storage IDs. All requested IDs should
@@ -76,6 +90,7 @@ export declare class BlobManager {
     private readonly localBlobIdGenerator;
     private readonly pendingStashedBlobs;
     readonly stashedBlobsUploadP: Promise<(void | ICreateBlobResponse)[]>;
+    private readonly createBlobPayloadPending;
     constructor(props: {
         readonly routeContext: IFluidHandleContext;
         blobManagerLoadInfo: IBlobManagerLoadInfo;
@@ -103,10 +118,18 @@ export declare class BlobManager {
     private createAbortError;
     hasPendingStashedUploads(): boolean;
     hasBlob(blobId: string): boolean;
+    /**
+     * Retrieve the blob with the given local blob id.
+     * @param blobId - The local blob id.  Likely coming from a handle.
+     * @param payloadPending - Whether we suspect the payload may be pending and not available yet.
+     * @returns A promise which resolves to the blob contents
+     */
     getBlob(blobId: string, payloadPending: boolean): Promise<ArrayBufferLike>;
     private getBlobHandle;
     private createBlobDetached;
-    createBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternal<ArrayBufferLike>>;
+    createBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandleInternalPayloadPending<ArrayBufferLike>>;
+    private createBlobLegacy;
+    private createBlobWithPayloadPending;
     private uploadBlob;
     /**
      * Set up a mapping in the redirect table from fromId to toId. Also, notify the runtime that a reference is added

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

@@ -1 +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;AAEtC,OAAO,EACN,iBAAiB,EACjB,uBAAuB,EACvB,MAAM,wDAAwD,CAAC;AAChE,OAAO,KAAK,EACX,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,kCAAkC,EAClC,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,uBAAuB,EACvB,mBAAmB,EACnB,MAAM,6CAA6C,CAAC;AAErD,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,KAAK,yBAAyB,EAC9B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,eAAe,EAIf,MAAM,wCAAwC,CAAC;AAYhD,OAAO,EAIN,KAAK,oBAAoB,EACzB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;GAMG;AACH,qBAAa,UACZ,SAAQ,eAAe,CAAC,eAAe,CACvC,YAAW,kCAAkC,CAAC,eAAe,CAAC;aAW7C,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC;aAC1B,cAAc,EAAE,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAbhC,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,EAC1B,cAAc,EAAE,OAAO,EACtB,aAAa,CAAC,SAAQ,IAAI,aAAA;IAMrC,WAAW,IAAI,IAAI;IAOnB,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;CAG/C;AAID,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACrC,iBAAiB,EACjB,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,eAAe,GAAG,UAAU,CACzE,GACA,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAmB5C,MAAM,WAAW,aAAa;IAC7B,CAAC,OAAO,EAAE,MAAM,GAAG;QAClB,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,kBAAmB,SAAQ,MAAM;IACjD,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAChD;AAiBD,eAAO,MAAM,mBAAmB,UAAoB,CAAC;AAErD,qBAAa,WAAW;IACvB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA+C;IAC5E,IAAW,MAAM,IAAI,cAAc,CAAC,kBAAkB,CAAC,CAEtD;IACD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuD;IAEtF;;;;;;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,CAAuC;IAEnE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgD;IACjF,OAAO,CAAC,aAAa,CAAkB;IAEvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAGlD,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,oBAAoB,CAAe;IACpD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CACzB;IACX,SAAgB,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;gBAE1D,KAAK,EAAE;QACzB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;QAE3C,mBAAmB,EAAE,oBAAoB,CAAC;QAC1C,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;QAC1C;;;;;;;;;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,oBAAoB,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;QAC3D,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;KAC3C;IAwGD,IAAW,gBAAgB,IAAI,OAAO,CAOrC;IAED,IAAW,eAAe,IAAI,OAAO,CAKpC;IAED,OAAO,CAAC,gBAAgB;IAOjB,wBAAwB,IAAI,OAAO;IAInC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAI1B,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IA4DvF,OAAO,CAAC,aAAa;YAwBP,kBAAkB;IAUnB,UAAU,CACtB,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;YA4CnC,UAAU;IA+CxB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IAgEvB;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI;IAiB7D,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAqDlF,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;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,4BAA4B;IA8CpC;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAqBrB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAiBzD;;;;;;;;;OASG;IACU,wBAAwB,CACpC,uBAAuB,CAAC,EAAE,WAAW,GACnC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;CA+ErC;AAmBD;;GAEG;AACH,eAAO,MAAM,UAAU,SAAU,MAAM,gCACL,CAAC"}
+{"version":3,"file":"blobManager.d.ts","sourceRoot":"","sources":["../../src/blobManager/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,iBAAiB,EACjB,uBAAuB,EACvB,MAAM,wDAAwD,CAAC;AAChE,OAAO,KAAK,EAEX,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,kCAAkC,EAClC,iBAAiB,EACjB,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,uBAAuB,EACvB,mBAAmB,EACnB,MAAM,6CAA6C,CAAC;AAErD,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,KAAK,yBAAyB,EAC9B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,eAAe,EAIf,MAAM,wCAAwC,CAAC;AAYhD,OAAO,EAIN,KAAK,oBAAoB,EACzB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;GAMG;AACH,qBAAa,UACZ,SAAQ,eAAe,CAAC,eAAe,CACvC,YACC,iBAAiB,CAAC,eAAe,CAAC,EAClC,kCAAkC,CAAC,eAAe,CAAC;aAgCnC,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC;aAC1B,cAAc,EAAE,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAlChC,OAAO,CAAC,QAAQ,CAAkB;IAElC,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,OAAO,CAAC,OAAO,CAEF;IACb,IAAW,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,CAEvD;IAED,OAAO,CAAC,MAAM,CAA2B;IACzC,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAU;IACpC,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IAED,SAAgB,YAAY,EAAE,MAAM,CAAC;gBAGpB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB,EAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,EAC1B,cAAc,EAAE,OAAO,EACtB,aAAa,CAAC,SAAQ,IAAI,aAAA;IAM5C,SAAgB,YAAY,QAAO,IAAI,CAGrC;IAEF,SAAgB,YAAY,UAAW,OAAO,KAAG,IAAI,CAGnD;IAEK,WAAW,IAAI,IAAI;IAQ1B;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;CAG/C;AAID,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACrC,iBAAiB,EACjB,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,eAAe,GAAG,UAAU,CACzE,GACA,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAmBzC,MAAM,WAAW,aAAa;IAC7B,CAAC,OAAO,EAAE,MAAM,GAAG;QAClB,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,EAAE,MAAM,IAAI,CAAC;CAC3B;AAkBD,eAAO,MAAM,mBAAmB,UAAoB,CAAC;AAErD,qBAAa,WAAW;IACvB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuC;IACpE,IAAW,MAAM,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAElD;IACD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+C;IAE9E;;;;;;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,CAAuC;IAEnE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgD;IACjF,OAAO,CAAC,aAAa,CAAkB;IAEvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAGlD,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,oBAAoB,CAAe;IACpD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CACzB;IACX,SAAgB,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAE7E,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAU;gBAEhC,KAAK,EAAE;QACzB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;QAE3C,mBAAmB,EAAE,oBAAoB,CAAC;QAC1C,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;QAC1C;;;;;;;;;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,oBAAoB,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;QAC3D,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;KAC3C;IA0GD,IAAW,gBAAgB,IAAI,OAAO,CAOrC;IAED,IAAW,eAAe,IAAI,OAAO,CAKpC;IAED,OAAO,CAAC,gBAAgB;IAOjB,wBAAwB,IAAI,OAAO;IAInC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IA8DvF,OAAO,CAAC,aAAa;YAwBP,kBAAkB;IAUnB,UAAU,CACtB,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,kCAAkC,CAAC,eAAe,CAAC,CAAC;YAmBjD,gBAAgB;IAkC9B,OAAO,CAAC,4BAA4B;YA0CtB,UAAU;IAgDxB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IAkEvB;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,IAAI;IAiB7D,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAyDlF,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;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,4BAA4B;IA8CpC;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAqBrB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAiBzD;;;;;;;;;OASG;IACU,wBAAwB,CACpC,uBAAuB,CAAC,EAAE,WAAW,GACnC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;CA+ErC;AAmBD;;GAEG;AACH,eAAO,MAAM,UAAU,SAAU,MAAM,gCACL,CAAC"}

package/dist/blobManager/blobManager.js

@@ -24,6 +24,15 @@ class BlobHandle extends internal_3.FluidHandleBase {
     get isAttached() {
         return this.routeContext.isAttached && this.attached;
     }
+    get events() {
+        return (this._events ??= (0, client_utils_1.createEmitter)());
+    }
+    get payloadState() {
+        return this._state;
+    }
+    get payloadShareError() {
+        return this._payloadShareError;
+    }
     constructor(path, routeContext, get, payloadPending, onAttachGraph) {
         super();
         this.path = path;
@@ -32,6 +41,15 @@ class BlobHandle extends internal_3.FluidHandleBase {
         this.payloadPending = payloadPending;
         this.onAttachGraph = onAttachGraph;
         this.attached = false;
+        this._state = "pending";
+        this.notifyShared = () => {
+            this._state = "shared";
+            this._events?.emit("payloadShared");
+        };
+        this.notifyFailed = (error) => {
+            this._payloadShareError = error;
+            this._events?.emit("payloadShareFailed", error);
+        };
         this.absolutePath = (0, internal_3.generateHandleContextPath)(path, this.routeContext);
     }
     attachGraph() {
@@ -40,6 +58,10 @@ class BlobHandle extends internal_3.FluidHandleBase {
             this.onAttachGraph?.();
         }
     }
+    // eslint-disable-next-line jsdoc/require-description
+    /**
+     * @deprecated No replacement provided. Arbitrary handles may not serve as a bind source.
+     */
     bind(handle) {
         throw new Error("Cannot bind to blob handle");
     }
@@ -57,8 +79,8 @@ class BlobManager {
         return this.publicEvents;
     }
     constructor(props) {
-        this.publicEvents = new client_utils_1.TypedEventEmitter();
-        this.internalEvents = new client_utils_1.TypedEventEmitter();
+        this.publicEvents = (0, client_utils_1.createEmitter)();
+        this.internalEvents = (0, client_utils_1.createEmitter)();
         /**
          * Blobs which we have not yet seen a BlobAttach op round-trip and not yet attached to a DDS.
          */
@@ -71,13 +93,14 @@ class BlobManager {
         this.opsInFlight = new Map();
         this.stopAttaching = false;
         this.pendingStashedBlobs = new Map();
-        const { routeContext, blobManagerLoadInfo, storage, sendBlobAttachOp, blobRequested, isBlobDeleted, runtime, stashedBlobs, localBlobIdGenerator, } = props;
+        const { routeContext, blobManagerLoadInfo, storage, sendBlobAttachOp, blobRequested, isBlobDeleted, runtime, stashedBlobs, localBlobIdGenerator, createBlobPayloadPending, } = props;
         this.routeContext = routeContext;
         this.storage = storage;
         this.blobRequested = blobRequested;
         this.isBlobDeleted = isBlobDeleted;
         this.runtime = runtime;
         this.localBlobIdGenerator = localBlobIdGenerator ?? uuid_1.v4;
+        this.createBlobPayloadPending = createBlobPayloadPending;
         this.mc = (0, internal_4.createChildMonitoringContext)({
             logger: this.runtime.baseLogger,
             namespace: "BlobManager",
@@ -169,6 +192,12 @@ class BlobManager {
     hasBlob(blobId) {
         return this.redirectTable.get(blobId) !== undefined;
     }
+    /**
+     * Retrieve the blob with the given local blob id.
+     * @param blobId - The local blob id.  Likely coming from a handle.
+     * @param payloadPending - Whether we suspect the payload may be pending and not available yet.
+     * @returns A promise which resolves to the blob contents
+     */
     async getBlob(blobId, payloadPending) {
         // 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.
@@ -191,7 +220,9 @@ class BlobManager {
         else {
             const attachedStorageId = this.redirectTable.get(blobId);
             if (!payloadPending) {
-                (0, internal_1.assert)(!!attachedStorageId, 0x11f /* "requesting unknown blobs" */);
+                // Only blob handles explicitly marked with pending payload are permitted to exist without
+                // yet knowing their storage id. Otherwise they must already be associated with a storage id.
+                (0, internal_1.assert)(attachedStorageId !== undefined, 0x11f /* "requesting unknown blobs" */);
             }
             // If we didn't find it in the redirectTable, assume the attach op is coming eventually and wait.
             // We do this even if the local client doesn't have the blob payloadPending flag enabled, in case a
@@ -222,11 +253,11 @@ class BlobManager {
     getBlobHandle(localId) {
         (0, internal_1.assert)(this.redirectTable.has(localId) || this.pendingBlobs.has(localId), 0x384 /* requesting handle for unknown blob */);
         const pending = this.pendingBlobs.get(localId);
-        // Create a callback function for once the blob has been attached
+        // Create a callback function for once the handle has been attached
         const callback = pending
             ? () => {
                 pending.attached = true;
-                // Notify listeners (e.g. serialization process) that blob has been attached
+                // Notify listeners (e.g. serialization process) that handle has been attached
                 this.internalEvents.emit("handleAttached", pending);
                 this.deletePendingBlobMaybe(localId);
             }
@@ -251,6 +282,11 @@ class BlobManager {
             await new Promise((resolve) => this.runtime.once("attached", resolve));
         }
         (0, internal_1.assert)(this.runtime.attachState === container_definitions_1.AttachState.Attached, 0x385 /* For clarity and paranoid defense against adding future attachment states */);
+        return this.createBlobPayloadPending
+            ? this.createBlobWithPayloadPending(blob)
+            : this.createBlobLegacy(blob, signal);
+    }
+    async createBlobLegacy(blob, signal) {
         if (signal?.aborted) {
             throw this.createAbortError();
         }
@@ -277,6 +313,36 @@ class BlobManager {
             signal?.removeEventListener("abort", abortListener);
         });
     }
+    createBlobWithPayloadPending(blob) {
+        const localId = this.localBlobIdGenerator();
+        const blobHandle = new BlobHandle(getGCNodePathFromBlobId(localId), this.routeContext, async () => blob, true, // payloadPending
+        () => {
+            const pendingEntry = {
+                blob,
+                handleP: new internal_1.Deferred(),
+                uploadP: this.uploadBlob(localId, blob),
+                attached: true,
+                acked: false,
+                opsent: false,
+            };
+            this.pendingBlobs.set(localId, pendingEntry);
+        });
+        const onProcessedBlobAttach = (_localId, _storageId) => {
+            if (_localId === localId) {
+                this.internalEvents.off("processedBlobAttach", onProcessedBlobAttach);
+                blobHandle.notifyShared();
+            }
+        };
+        this.internalEvents.on("processedBlobAttach", onProcessedBlobAttach);
+        const onUploadFailed = (_localId, error) => {
+            if (_localId === localId) {
+                this.internalEvents.off("uploadFailed", onUploadFailed);
+                blobHandle.notifyFailed(error);
+            }
+        };
+        this.internalEvents.on("uploadFailed", onUploadFailed);
+        return blobHandle;
+    }
     async uploadBlob(localId, blob) {
         return (0, internal_2.runWithRetry)(async () => {
             try {
@@ -305,6 +371,7 @@ class BlobManager {
             // the promise but not throw any error outside.
             this.pendingBlobs.get(localId)?.handleP.reject(error);
             this.deletePendingBlob(localId);
+            this.internalEvents.emit("uploadFailed", localId, error);
         });
     }
     /**
@@ -366,7 +433,9 @@ class BlobManager {
             // 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.
             this.setRedirection(localId, response.id);
-            entry.handleP.resolve(this.getBlobHandle(localId));
+            const blobHandle = this.getBlobHandle(localId);
+            blobHandle.notifyShared();
+            entry.handleP.resolve(blobHandle);
             this.deletePendingBlobMaybe(localId);
         }
         else {
@@ -421,8 +490,8 @@ class BlobManager {
         }
         // set identity (id -> id) entry
         this.setRedirection(blobId, blobId);
+        (0, internal_1.assert)(localId !== undefined, 0x50e /* local ID not present in blob attach message */);
         if (local) {
-            (0, internal_1.assert)(localId !== undefined, 0x50e /* local ID not present in blob attach message */);
             const waitingBlobs = this.opsInFlight.get(blobId);
             if (waitingBlobs !== undefined) {
                 // For each op corresponding to this storage ID that we are waiting for, resolve the pending blob.
@@ -433,7 +502,9 @@ class BlobManager {
                     (0, internal_1.assert)(entry !== undefined, 0x38f /* local online BlobAttach op with no pending blob entry */);
                     this.setRedirection(pendingLocalId, blobId);
                     entry.acked = true;
-                    entry.handleP.resolve(this.getBlobHandle(pendingLocalId));
+                    const blobHandle = this.getBlobHandle(pendingLocalId);
+                    blobHandle.notifyShared();
+                    entry.handleP.resolve(blobHandle);
                     this.deletePendingBlobMaybe(pendingLocalId);
                 }
                 this.opsInFlight.delete(blobId);
@@ -441,7 +512,9 @@ class BlobManager {
             const localEntry = this.pendingBlobs.get(localId);
             if (localEntry) {
                 localEntry.acked = true;
-                localEntry.handleP.resolve(this.getBlobHandle(localId));
+                const blobHandle = this.getBlobHandle(localId);
+                blobHandle.notifyShared();
+                localEntry.handleP.resolve(blobHandle);
                 this.deletePendingBlobMaybe(localId);
             }
         }
@@ -583,7 +656,7 @@ class BlobManager {
             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 = [];
+                const attachHandlesP = [];
                 for (const [localId, entry] of this.pendingBlobs) {
                     if (!localBlobs.has(entry)) {
                         localBlobs.add(entry);
@@ -598,15 +671,15 @@ class BlobManager {
                         // 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(localId));
-                        // Array of promises that will resolve when blobs get attached.
-                        attachBlobsP.push(new Promise((resolve, reject) => {
+                        // Array of promises that will resolve when handles get attached.
+                        attachHandlesP.push(new Promise((resolve, reject) => {
                             stopBlobAttachingSignal?.addEventListener("abort", () => {
                                 this.stopAttaching = true;
                                 reject(new Error("Operation aborted"));
                             }, { once: true });
-                            const onBlobAttached = (attachedEntry) => {
+                            const onHandleAttached = (attachedEntry) => {
                                 if (attachedEntry === entry) {
-                                    this.internalEvents.off("handleAttached", onBlobAttached);
+                                    this.internalEvents.off("handleAttached", onHandleAttached);
                                     resolve();
                                 }
                             };
@@ -614,14 +687,14 @@ class BlobManager {
                                 resolve();
                             }
                             else {
-                                this.internalEvents.on("handleAttached", onBlobAttached);
+                                this.internalEvents.on("handleAttached", onHandleAttached);
                             }
                         }));
                     }
                 }
                 // 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);
+                await Promise.allSettled(attachHandlesP);
             }
             for (const [localId, entry] of this.pendingBlobs) {
                 if (stopBlobAttachingSignal?.aborted && !entry.attached) {