@fluidframework/datastore 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.2.0.0.245554

package/lib/channelDeltaConnection.js

@@ -0,0 +1,92 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/core-utils";
+import { DataProcessingError } from "@fluidframework/telemetry-utils";
+const stashedOpMetadataMark = Symbol();
+function createStashedOpMetadata() {
+    const arr = [];
+    Object.defineProperty(arr, stashedOpMetadataMark, {
+        value: stashedOpMetadataMark,
+        writable: false,
+        enumerable: true,
+    });
+    return arr;
+}
+function isStashedOpMetadata(md) {
+    return (Array.isArray(md) &&
+        stashedOpMetadataMark in md &&
+        md[stashedOpMetadataMark] === stashedOpMetadataMark);
+}
+function processWithStashedOpMetadataHandling(content, localOpMetaData, func) {
+    if (isStashedOpMetadata(localOpMetaData)) {
+        localOpMetaData.forEach(({ contents, metadata }) => func(contents, metadata));
+    }
+    else {
+        func(content, localOpMetaData);
+    }
+}
+export class ChannelDeltaConnection {
+    get handler() {
+        assert(!!this._handler, 0x177 /* "Missing delta handler" */);
+        return this._handler;
+    }
+    get connected() {
+        return this._connected;
+    }
+    constructor(_connected, submitFn, dirty, 
+    /** @deprecated There is no replacement for this, its functionality is no longer needed at this layer. */
+    addedGCOutboundReference, isAttachedAndVisible) {
+        this._connected = _connected;
+        this.submitFn = submitFn;
+        this.dirty = dirty;
+        this.addedGCOutboundReference = addedGCOutboundReference;
+        this.isAttachedAndVisible = isAttachedAndVisible;
+    }
+    attach(handler) {
+        assert(this._handler === undefined, 0x178 /* "Missing delta handler on attach" */);
+        this._handler = handler;
+    }
+    setConnectionState(connected) {
+        this._connected = connected;
+        this.handler.setConnectionState(connected);
+    }
+    process(message, local, localOpMetadata) {
+        try {
+            // catches as data processing error whether or not they come from async pending queues
+            processWithStashedOpMetadataHandling(message.contents, localOpMetadata, (contents, metadata) => this.handler.process({ ...message, contents }, local, metadata));
+        }
+        catch (error) {
+            throw DataProcessingError.wrapIfUnrecognized(error, "channelDeltaConnectionFailedToProcessMessage", message);
+        }
+    }
+    reSubmit(content, localOpMetadata) {
+        processWithStashedOpMetadataHandling(content, localOpMetadata, this.handler.reSubmit.bind(this.handler));
+    }
+    rollback(content, localOpMetadata) {
+        if (this.handler.rollback === undefined) {
+            throw new Error("Handler doesn't support rollback");
+        }
+        processWithStashedOpMetadataHandling(content, localOpMetadata, this.handler.rollback.bind(this.handler));
+    }
+    applyStashedOp(content) {
+        try {
+            this.stashedOpMd = this.isAttachedAndVisible() ? createStashedOpMetadata() : undefined;
+            this.handler.applyStashedOp(content);
+            return this.stashedOpMd;
+        }
+        finally {
+            this.stashedOpMd = undefined;
+        }
+    }
+    submit(contents, metadata) {
+        if (this.stashedOpMd !== undefined) {
+            this.stashedOpMd.push({ contents, metadata });
+        }
+        else {
+            this.submitFn(contents, metadata);
+        }
+    }
+}
+//# sourceMappingURL=channelDeltaConnection.js.map

package/lib/channelDeltaConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channelDeltaConnection.js","sourceRoot":"","sources":["../src/channelDeltaConnection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAGtE,MAAM,qBAAqB,GAAG,MAAM,EAAE,CAAC;AAKvC,SAAS,uBAAuB;IAC/B,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;QACjD,KAAK,EAAE,qBAAqB;QAC5B,QAAQ,EAAE,KAAK;QACf,UAAU,EAAE,IAAI;KAChB,CAAC,CAAC;IACH,OAAO,GAA+B,CAAC;AACxC,CAAC;AAED,SAAS,mBAAmB,CAAC,EAAW;IACvC,OAAO,CACN,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACjB,qBAAqB,IAAI,EAAE;QAC3B,EAAE,CAAC,qBAAqB,CAAC,KAAK,qBAAqB,CACnD,CAAC;AACH,CAAC;AAED,SAAS,oCAAoC,CAC5C,OAAY,EACZ,eAAwB,EACxB,IAAgD;IAEhD,IAAI,mBAAmB,CAAC,eAAe,CAAC,EAAE;QACzC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;KAC9E;SAAM;QACN,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;KAC/B;AACF,CAAC;AAED,MAAM,OAAO,sBAAsB;IAIlC,IAAY,OAAO;QAClB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IACD,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED,YACS,UAAmB,EACV,QAA0D,EAC3D,KAAiB;IACjC,yGAAyG;IACzF,wBAGP,EACQ,oBAAmC;QAR5C,eAAU,GAAV,UAAU,CAAS;QACV,aAAQ,GAAR,QAAQ,CAAkD;QAC3D,UAAK,GAAL,KAAK,CAAY;QAEjB,6BAAwB,GAAxB,wBAAwB,CAG/B;QACQ,yBAAoB,GAApB,oBAAoB,CAAe;IAClD,CAAC;IAEG,MAAM,CAAC,OAAsB;QACnC,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACnF,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,kBAAkB,CAAC,SAAkB;QAC3C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAEM,OAAO,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC1F,IAAI;YACH,sFAAsF;YACtF,oCAAoC,CACnC,OAAO,CAAC,QAAQ,EAChB,eAAe,EACf,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CACtB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,CAChE,CAAC;SACF;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,mBAAmB,CAAC,kBAAkB,CAC3C,KAAK,EACL,8CAA8C,EAC9C,OAAO,CACP,CAAC;SACF;IACF,CAAC;IAEM,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,oCAAoC,CACnC,OAAO,EACP,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CACxC,CAAC;IACH,CAAC;IAEM,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACpD;QACD,oCAAoC,CACnC,OAAO,EACP,eAAe,EACf,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CACxC,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,OAAY;QACjC,IAAI;YACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACvF,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACrC,OAAO,IAAI,CAAC,WAAW,CAAC;SACxB;gBAAS;YACT,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC7B;IACF,CAAC;IAEM,MAAM,CAAC,QAAa,EAAE,QAAiB;QAC7C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACnC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;SAC9C;aAAM;YACN,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SAClC;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { IDeltaConnection, IDeltaHandler } from \"@fluidframework/datastore-definitions\";\nimport { DataProcessingError } from \"@fluidframework/telemetry-utils\";\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\n\nconst stashedOpMetadataMark = Symbol();\n\ntype StashedOpMetadata = { contents: any; metadata: unknown }[] &\n\tRecord<typeof stashedOpMetadataMark, typeof stashedOpMetadataMark>;\n\nfunction createStashedOpMetadata(): StashedOpMetadata {\n\tconst arr = [];\n\tObject.defineProperty(arr, stashedOpMetadataMark, {\n\t\tvalue: stashedOpMetadataMark,\n\t\twritable: false,\n\t\tenumerable: true,\n\t});\n\treturn arr as any as StashedOpMetadata;\n}\n\nfunction isStashedOpMetadata(md: unknown): md is StashedOpMetadata {\n\treturn (\n\t\tArray.isArray(md) &&\n\t\tstashedOpMetadataMark in md &&\n\t\tmd[stashedOpMetadataMark] === stashedOpMetadataMark\n\t);\n}\n\nfunction processWithStashedOpMetadataHandling(\n\tcontent: any,\n\tlocalOpMetaData: unknown,\n\tfunc: (contents: any, metadata: unknown) => void,\n) {\n\tif (isStashedOpMetadata(localOpMetaData)) {\n\t\tlocalOpMetaData.forEach(({ contents, metadata }) => func(contents, metadata));\n\t} else {\n\t\tfunc(content, localOpMetaData);\n\t}\n}\n\nexport class ChannelDeltaConnection implements IDeltaConnection {\n\tprivate _handler: IDeltaHandler | undefined;\n\tprivate stashedOpMd: StashedOpMetadata | undefined;\n\n\tprivate get handler(): IDeltaHandler {\n\t\tassert(!!this._handler, 0x177 /* \"Missing delta handler\" */);\n\t\treturn this._handler;\n\t}\n\tpublic get connected(): boolean {\n\t\treturn this._connected;\n\t}\n\n\tconstructor(\n\t\tprivate _connected: boolean,\n\t\tprivate readonly submitFn: (content: any, localOpMetadata: unknown) => void,\n\t\tpublic readonly dirty: () => void,\n\t\t/** @deprecated There is no replacement for this, its functionality is no longer needed at this layer. */\n\t\tpublic readonly addedGCOutboundReference: (\n\t\t\tsrcHandle: IFluidHandle,\n\t\t\toutboundHandle: IFluidHandle,\n\t\t) => void,\n\t\tprivate readonly isAttachedAndVisible: () => boolean,\n\t) {}\n\n\tpublic attach(handler: IDeltaHandler) {\n\t\tassert(this._handler === undefined, 0x178 /* \"Missing delta handler on attach\" */);\n\t\tthis._handler = handler;\n\t}\n\n\tpublic setConnectionState(connected: boolean) {\n\t\tthis._connected = connected;\n\t\tthis.handler.setConnectionState(connected);\n\t}\n\n\tpublic process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n\t\ttry {\n\t\t\t// catches as data processing error whether or not they come from async pending queues\n\t\t\tprocessWithStashedOpMetadataHandling(\n\t\t\t\tmessage.contents,\n\t\t\t\tlocalOpMetadata,\n\t\t\t\t(contents, metadata) =>\n\t\t\t\t\tthis.handler.process({ ...message, contents }, local, metadata),\n\t\t\t);\n\t\t} catch (error) {\n\t\t\tthrow DataProcessingError.wrapIfUnrecognized(\n\t\t\t\terror,\n\t\t\t\t\"channelDeltaConnectionFailedToProcessMessage\",\n\t\t\t\tmessage,\n\t\t\t);\n\t\t}\n\t}\n\n\tpublic reSubmit(content: any, localOpMetadata: unknown) {\n\t\tprocessWithStashedOpMetadataHandling(\n\t\t\tcontent,\n\t\t\tlocalOpMetadata,\n\t\t\tthis.handler.reSubmit.bind(this.handler),\n\t\t);\n\t}\n\n\tpublic rollback(content: any, localOpMetadata: unknown) {\n\t\tif (this.handler.rollback === undefined) {\n\t\t\tthrow new Error(\"Handler doesn't support rollback\");\n\t\t}\n\t\tprocessWithStashedOpMetadataHandling(\n\t\t\tcontent,\n\t\t\tlocalOpMetadata,\n\t\t\tthis.handler.rollback.bind(this.handler),\n\t\t);\n\t}\n\n\tpublic applyStashedOp(content: any): unknown {\n\t\ttry {\n\t\t\tthis.stashedOpMd = this.isAttachedAndVisible() ? createStashedOpMetadata() : undefined;\n\t\t\tthis.handler.applyStashedOp(content);\n\t\t\treturn this.stashedOpMd;\n\t\t} finally {\n\t\t\tthis.stashedOpMd = undefined;\n\t\t}\n\t}\n\n\tpublic submit(contents: any, metadata: unknown): void {\n\t\tif (this.stashedOpMd !== undefined) {\n\t\t\tthis.stashedOpMd.push({ contents, metadata });\n\t\t} else {\n\t\t\tthis.submitFn(contents, metadata);\n\t\t}\n\t}\n}\n"]}

package/lib/{channelStorageService.d.mts → channelStorageService.d.ts}

@@ -19,4 +19,4 @@ export declare class ChannelStorageService implements IChannelStorageService {
     list(path: string): Promise<string[]>;
     private getIdForPath;
 }
-//# sourceMappingURL=channelStorageService.d.mts.map
+//# sourceMappingURL=channelStorageService.d.ts.map

package/lib/channelStorageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channelStorageService.d.ts","sourceRoot":"","sources":["../src/channelStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,qBAAa,qBAAsB,YAAW,sBAAsB;IAoBlE,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IAtB7B,OAAO,CAAC,MAAM,CAAC,WAAW;IAgB1B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;gBAGzC,IAAI,EAAE,aAAa,GAAG,SAAS,EAC/B,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,EAClD,MAAM,EAAE,mBAAmB,EAC3B,UAAU,CAAC,0CAA8B;IAS9C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAehD,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAepC,YAAY;CAG1B"}

package/lib/{channelStorageService.mjs → channelStorageService.js}

@@ -55,4 +55,4 @@ export class ChannelStorageService {
         return this.flattenedTree[path];
     }
 }
-//# sourceMappingURL=channelStorageService.mjs.map
+//# sourceMappingURL=channelStorageService.js.map

package/lib/channelStorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channelStorageService.js","sourceRoot":"","sources":["../src/channelStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,mCAAmC,EAAE,MAAM,+BAA+B,CAAC;AAGpF,MAAM,OAAO,qBAAqB;IACzB,MAAM,CAAC,WAAW,CACzB,IAAY,EACZ,IAAmB,EACnB,OAAmC;QAEnC,8DAA8D;QAC9D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YAC9B,qBAAqB,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;SAChF;QAED,8DAA8D;QAC9D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YAC9B,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7C;IACF,CAAC;IAID,YACkB,IAA+B,EAC/B,OAAkD,EAClD,MAA2B,EAC3B,UAAyC;QAHzC,SAAI,GAAJ,IAAI,CAA2B;QAC/B,YAAO,GAAP,OAAO,CAA2C;QAClD,WAAM,GAAN,MAAM,CAAqB;QAC3B,eAAU,GAAV,UAAU,CAA+B;QAE1D,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,mCAAmC;QACnC,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,qBAAqB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;SAChE;IACF,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAY;QACjC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjF,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,OAAO,IAAI,CAAC;SACZ;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CACrB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,yBAAyB,EAAE,EAAE,KAAK,CAAC,CAC3E,CAAC;QAEF,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,IAAY;QAC7B,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,MAAM,SAAS,GAAG,mCAAmC,CAAC,IAAI,CAAC,CAAC;QAC5D,OAAO,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YAClD,oEAAoE;YACpE,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAG,CAAC;YAChC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACxB;QACD,IAAI,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACvC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { IChannelStorageService } from \"@fluidframework/datastore-definitions\";\nimport { getNormalizedObjectStoragePathParts } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils\";\n\nexport class ChannelStorageService implements IChannelStorageService {\n\tprivate static flattenTree(\n\t\tbase: string,\n\t\ttree: ISnapshotTree,\n\t\tresults: { [path: string]: string },\n\t) {\n\t\t// eslint-disable-next-line guard-for-in, no-restricted-syntax\n\t\tfor (const path in tree.trees) {\n\t\t\tChannelStorageService.flattenTree(`${base}${path}/`, tree.trees[path], results);\n\t\t}\n\n\t\t// eslint-disable-next-line guard-for-in, no-restricted-syntax\n\t\tfor (const blob in tree.blobs) {\n\t\t\tresults[`${base}${blob}`] = tree.blobs[blob];\n\t\t}\n\t}\n\n\tprivate readonly flattenedTree: { [path: string]: string };\n\n\tconstructor(\n\t\tprivate readonly tree: ISnapshotTree | undefined,\n\t\tprivate readonly storage: Pick<IDocumentStorageService, \"readBlob\">,\n\t\tprivate readonly logger: ITelemetryLoggerExt,\n\t\tprivate readonly extraBlobs?: Map<string, ArrayBufferLike>,\n\t) {\n\t\tthis.flattenedTree = {};\n\t\t// Create a map from paths to blobs\n\t\tif (tree !== undefined) {\n\t\t\tChannelStorageService.flattenTree(\"\", tree, this.flattenedTree);\n\t\t}\n\t}\n\n\tpublic async contains(path: string): Promise<boolean> {\n\t\treturn this.flattenedTree[path] !== undefined;\n\t}\n\n\tpublic async readBlob(path: string): Promise<ArrayBufferLike> {\n\t\tconst id = await this.getIdForPath(path);\n\t\tconst blob = this.extraBlobs !== undefined ? this.extraBlobs.get(id) : undefined;\n\n\t\tif (blob !== undefined) {\n\t\t\treturn blob;\n\t\t}\n\t\tconst blobP = this.storage.readBlob(id);\n\t\tblobP.catch((error) =>\n\t\t\tthis.logger.sendErrorEvent({ eventName: \"ChannelStorageBlobError\" }, error),\n\t\t);\n\n\t\treturn blobP;\n\t}\n\n\tpublic async list(path: string): Promise<string[]> {\n\t\tlet tree = this.tree;\n\t\tconst pathParts = getNormalizedObjectStoragePathParts(path);\n\t\twhile (tree !== undefined && pathParts.length > 0) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tconst part = pathParts.shift()!;\n\t\t\ttree = tree.trees[part];\n\t\t}\n\t\tif (tree === undefined || pathParts.length !== 0) {\n\t\t\tthrow new Error(\"path does not exist\");\n\t\t}\n\n\t\treturn Object.keys(tree?.blobs ?? {});\n\t}\n\n\tprivate async getIdForPath(path: string): Promise<string> {\n\t\treturn this.flattenedTree[path];\n\t}\n}\n"]}

package/lib/{dataStoreRuntime.d.mts → dataStoreRuntime.d.ts}

@@ -5,10 +5,11 @@
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { FluidObject, IFluidHandle, IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
-import { IAudience, IDeltaManager, AttachState, ILoaderOptions } from "@fluidframework/container-definitions";
+import { IAudience, IDeltaManager, AttachState } from "@fluidframework/container-definitions";
 import { IClientDetails, IDocumentMessage, ISequencedDocumentMessage, IQuorumClients } from "@fluidframework/protocol-definitions";
-import { IFluidDataStoreContext, IFluidDataStoreChannel, IGarbageCollectionData, IInboundSignalMessage, ISummaryTreeWithStats, VisibilityState, ITelemetryContext, IIdCompressor } from "@fluidframework/runtime-definitions";
+import { IFluidDataStoreContext, IFluidDataStoreChannel, IGarbageCollectionData, IInboundSignalMessage, ISummaryTreeWithStats, VisibilityState, ITelemetryContext } from "@fluidframework/runtime-definitions";
 import { IChannel, IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents, IChannelFactory } from "@fluidframework/datastore-definitions";
+import { IIdCompressor } from "@fluidframework/id-compressor";
 /**
  * @alpha
  */
@@ -56,7 +57,7 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
     visibilityState: VisibilityState;
     private readonly pendingHandlesToMakeVisible;
     readonly id: string;
-    readonly options: ILoaderOptions;
+    readonly options: Record<string | number, any>;
     readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
     private readonly quorum;
     private readonly audience;
@@ -93,6 +94,13 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
     resolveHandle(request: IRequest): Promise<IResponse>;
     request(request: IRequest): Promise<IResponse>;
     getChannel(id: string): Promise<IChannel>;
+    /**
+     * Validate user provided channel ID
+     * Channel ID has limitations. "/" is not allowed as IDs in storage can not have slashes - we parse tree paths and use "/" as separator.
+     * IDs cannot start with "_" as it could result in collision of IDs with auto-assigned (by FF) short IDs.
+     * @param id - channel ID.
+     */
+    protected validateChannelId(id: string): void;
     /**
      * Api which allows caller to create the channel first and then add it to the runtime.
      * The channel type should be present in the registry, otherwise the runtime would reject
@@ -101,7 +109,7 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
      * @param channel - channel which needs to be added to the runtime.
      */
     addChannel(channel: IChannel): void;
-    createChannel(id: string | undefined, type: string): IChannel;
+    createChannel(idArg: string | undefined, type: string): IChannel;
     private createChannelContext;
     /**
      * Binds a channel with the runtime. If the runtime is attached we will attach the channel right away.
@@ -184,6 +192,15 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
      */
     summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * Get the GC Data for the initial state being attached so remote clients can learn of this DataStore's outbound routes
+     */
+    getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
+    /**
+     * Helper method for preparing to attach this dataStore.
+     * Runs the callback for each bound context to incorporate its data however the caller specifies
+     */
+    private visitLocalBoundContextsDuringAttach;
     submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
     /**
      * Submits the signal to be sent to other clients.
@@ -197,9 +214,10 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
      */
     waitAttached(): Promise<void>;
     /**
-     * Attach channel should only be called after the data store has been attached
+     * Assuming this DataStore is already attached, this will make the given channel locally visible
+     * by submitting its attach op.
      */
-    private attachChannel;
+    private makeChannelLocallyVisible;
     private submitChannelOp;
     private submit;
     /**
@@ -227,6 +245,7 @@ export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataS
      * other clients that are up-to-date till seq# 100 may not have them yet.
      */
     private identifyLocalChangeInSummarizer;
+    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
 }
 /**
  * Mixin class that adds request handler to FluidDataStoreRuntime
@@ -247,4 +266,4 @@ export declare const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRunt
     path: string[];
     content: string;
 } | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
-//# sourceMappingURL=dataStoreRuntime.d.mts.map
+//# sourceMappingURL=dataStoreRuntime.d.ts.map

package/lib/dataStoreRuntime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAEN,mBAAmB,EAQnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAE9F,OAAO,EACN,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EAIzB,cAAc,EACd,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAKN,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,iBAAiB,EAEjB,MAAM,qCAAqC,CAAC;AAgB7C,OAAO,EACN,QAAQ,EACR,sBAAsB,EACtB,4BAA4B,EAC5B,eAAe,EACf,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAU9D;;GAEG;AACH,oBAAY,oBAAoB;IAE/B,MAAM,WAAW;IACjB,SAAS,OAAO;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAGrC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CAC/C;AAED;;;GAGG;AACH,qBAAa,qBACZ,SAAQ,iBAAiB,CAAC,4BAA4B,CACtD,YAAW,sBAAsB,EAAE,sBAAsB,EAAE,mBAAmB;IAmH7E,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAlHtC;;OAEG;IACH,SAAgB,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IAEtD,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,aAAa,IAAI,cAAc,CAEzC;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,IAAW,YAAY,IAAI,mBAAmB,CAE7C;IAED,IAAW,YAAY,IAAI,aAAa,GAAG,SAAS,CAEnD;IAED,IAAW,mBAAmB,SAE7B;IAED,IAAW,kBAAkB,SAE5B;IACD,IAAW,sBAAsB,SAEhC;IACD,IAAW,qBAAqB,SAE/B;IAED,OAAO,CAAC,SAAS,CAAS;IAC1B,IAAW,QAAQ,YAElB;IAED,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsC;IAC/D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IAEnD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwB;IACzD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA8C;IACvF,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAqB;IACjE,OAAO,CAAC,YAAY,CAAc;IAC3B,eAAe,EAAE,eAAe,CAAC;IAGxC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAgC;IAE5E,SAAgB,EAAE,EAAE,MAAM,CAAC;IAE3B,SAAgB,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IACtD,SAAgB,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IACzF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IACvC,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED;;;;OAIG;IACH,OAAO,CAAC,0BAA0B,CAAS;IAE3C;;;;;;;OAOG;IACI,wBAAwB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;IAOxD;;;;;;;;;;OAUG;gBAEe,gBAAgB,EAAE,sBAAsB,EACxC,oBAAoB,EAAE,qBAAqB,EAC5D,QAAQ,EAAE,OAAO,EACjB,iBAAiB,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,WAAW,CAAC;IA2HtE,OAAO,IAAI,IAAI;IAUT,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAIpD,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAiC9C,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWtD;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM;IAStC;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;IAmBnC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ;IA0CvE,OAAO,CAAC,oBAAoB;IAiB5B;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI;IA+B3C;;;;;;;;;;OAUG;IACI,yBAAyB;IAahC;;OAEG;IACI,WAAW;IAIX,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAShC,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM;IAUxD,SAAS,IAAI,cAAc;IAI3B,WAAW,IAAI,SAAS;IAIlB,UAAU,CACtB,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAMzC,OAAO,CAAC,0BAA0B;IA4B3B,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IA0DpF,aAAa,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO;IAInE,OAAO,CAAC,iBAAiB;IAczB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IASrB;;;;;;;;;;;;;;OAcG;IACU,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAsBhF;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE;IAkB5C;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAQhC;;;;;OAKG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAc,EAC1B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IA8B1B,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB;IA+BpF;;OAEG;IACI,eAAe,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,sBAAsB;IAkBpF;;;OAGG;IACH,OAAO,CAAC,mCAAmC;IAkCpC,aAAa,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIvF;;;;;OAKG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM;IAKvE;;OAEG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IAwCjC,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,MAAM;IASd;;;;;;OAMG;IACI,QAAQ,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAwBlF;;;;OAIG;IACI,QAAQ,CAAC,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAoBtE,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAgC3D,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,eAAe;IAMvB;;;;OAIG;IACH,OAAO,CAAC,+BAA+B;IAyBhC,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI;CA4CtF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,6BACL,QAAQ,WAAW,qBAAqB,KAAK,QAAQ,SAAS,CAAC,SACnF,4BAA4B,iCAUD,CAAC;AAEnC;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,sBAErB,qBAAqB,KAC1B,QAAQ;IAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,SACvD,4BAA4B,iCAyCD,CAAC"}

package/lib/{dataStoreRuntime.mjs → dataStoreRuntime.js}

@@ -5,16 +5,16 @@
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { DataProcessingError, generateStack, LoggingError, raiseConnectedEvent, createChildMonitoringContext, tagCodeArtifacts, UsageError, } from "@fluidframework/telemetry-utils";
 import { assert, Deferred, LazyPromise, unreachableCase } from "@fluidframework/core-utils";
-import { AttachState, } from "@fluidframework/container-definitions";
+import { AttachState } from "@fluidframework/container-definitions";
 import { buildSnapshotTree } from "@fluidframework/driver-utils";
 import { SummaryType, } from "@fluidframework/protocol-definitions";
-import { CreateSummarizerNodeSource, VisibilityState, } from "@fluidframework/runtime-definitions";
-import { convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, generateHandleContextPath, RequestParser, SummaryTreeBuilder, create404Response, createResponseError, exceptionToResponse, GCDataBuilder, unpackChildNodesUsedRoutes, } from "@fluidframework/runtime-utils";
+import { CreateSummarizerNodeSource, VisibilityState, gcDataBlobKey, } from "@fluidframework/runtime-definitions";
+import { convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, generateHandleContextPath, RequestParser, SummaryTreeBuilder, create404Response, createResponseError, exceptionToResponse, GCDataBuilder, unpackChildNodesUsedRoutes, addBlobToSummary, processAttachMessageGCData, encodeCompactIdToString, } from "@fluidframework/runtime-utils";
 import { v4 as uuid } from "uuid";
-import { summarizeChannel } from "./channelContext.mjs";
-import { LocalChannelContext, LocalChannelContextBase, RehydratedLocalChannelContext, } from "./localChannelContext.mjs";
-import { RemoteChannelContext } from "./remoteChannelContext.mjs";
-import { FluidObjectHandle } from "./fluidHandle.mjs";
+import { summarizeChannel } from "./channelContext.js";
+import { LocalChannelContext, LocalChannelContextBase, RehydratedLocalChannelContext, } from "./localChannelContext.js";
+import { RemoteChannelContext } from "./remoteChannelContext.js";
+import { FluidObjectHandle } from "./fluidHandle.js";
 /**
  * @alpha
  */
@@ -230,6 +230,20 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         }
         return context.getChannel();
     }
+    /**
+     * Validate user provided channel ID
+     * Channel ID has limitations. "/" is not allowed as IDs in storage can not have slashes - we parse tree paths and use "/" as separator.
+     * IDs cannot start with "_" as it could result in collision of IDs with auto-assigned (by FF) short IDs.
+     * @param id - channel ID.
+     */
+    validateChannelId(id) {
+        if (id.includes("/")) {
+            throw new UsageError(`Id cannot contain slashes: ${id}`);
+        }
+        if (id.startsWith("_")) {
+            throw new UsageError(`Id cannot start with underscore: ${id}`);
+        }
+    }
     /**
      * Api which allows caller to create the channel first and then add it to the runtime.
      * The channel type should be present in the registry, otherwise the runtime would reject
@@ -239,9 +253,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
      */
     addChannel(channel) {
         const id = channel.id;
-        if (id.includes("/")) {
-            throw new UsageError(`Id cannot contain slashes: ${id}`);
-        }
+        this.validateChannelId(id);
         this.verifyNotClosed();
         assert(!this.contexts.has(id), 0x865 /* addChannel() with existing ID */);
         const type = channel.attributes.type;
@@ -253,9 +265,30 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         // Channels (DDS) should not be created in summarizer client.
         this.identifyLocalChangeInSummarizer("DDSCreatedInSummarizer", id, type);
     }
-    createChannel(id = uuid(), type) {
-        if (id.includes("/")) {
-            throw new UsageError(`Id cannot contain slashes: ${id}`);
+    createChannel(idArg, type) {
+        let id;
+        if (idArg !== undefined) {
+            id = idArg;
+            this.validateChannelId(id);
+        }
+        else {
+            // We use three non-overlapping namespaces:
+            // - detached state: even numbers
+            // - attached state: odd numbers
+            // - uuids
+            // In first two cases we will encode result as strings in more compact form, with leading underscore,
+            // to ensure no overlap with user-provided DDS names (see validateChannelId())
+            if (this.visibilityState !== VisibilityState.GloballyVisible) {
+                // container is detached, only one client observes content, no way to hit collisions with other clients.
+                id = encodeCompactIdToString(2 * this.contexts.size, "_");
+            }
+            else {
+                // Due to back-compat, we could not depend yet on generateDocumentUniqueId() being there.
+                // We can remove the need to leverage uuid() as fall-back in couple releases.
+                const res = this.dataStoreContext.containerRuntime.generateDocumentUniqueId?.() ?? uuid();
+                id = typeof res === "number" ? encodeCompactIdToString(2 * res + 1, "_") : res;
+            }
+            assert(!id.includes("/"), 0x8fc /* slash */);
         }
         this.verifyNotClosed();
         assert(!this.contexts.has(id), 0x179 /* "createChannel() with existing ID" */);
@@ -285,7 +318,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         this.notBoundedChannelContextSet.delete(channel.id);
         // If our data store is attached, then attach the channel.
         if (this.isAttached) {
-            this.attachChannel(channel);
+            this.makeChannelLocallyVisible(channel);
             return;
         }
         /**
@@ -367,6 +400,12 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
                 case DataStoreMessageType.Attach: {
                     const attachMessage = message.contents;
                     const id = attachMessage.id;
+                    // We need to process the GC Data for both local and remote attach messages
+                    processAttachMessageGCData(attachMessage.snapshot, (nodeId, toPath) => {
+                        // Note: nodeId will be "/" unless and until we support sub-DDS GC Nodes
+                        const fromPath = `/${this.id}/${id}${nodeId === "/" ? "" : nodeId}`;
+                        this.dataStoreContext.addedGCOutboundRoute?.(fromPath, toPath);
+                    });
                     // If a non-local operation then go and create the object
                     // Otherwise mark it as officially attached.
                     if (local) {
@@ -523,6 +562,45 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         return summaryBuilder.getSummaryTree();
     }
     getAttachSummary(telemetryContext) {
+        const summaryBuilder = new SummaryTreeBuilder();
+        this.visitLocalBoundContextsDuringAttach((contextId, context) => {
+            let summaryTree;
+            if (context.isLoaded) {
+                const contextSummary = context.getAttachSummary(telemetryContext);
+                assert(contextSummary.summary.type === SummaryType.Tree, 0x180 /* "getAttachSummary should always return a tree" */);
+                summaryTree = { stats: contextSummary.stats, summary: contextSummary.summary };
+            }
+            else {
+                // If this channel is not yet loaded, then there should be no changes in the snapshot from which
+                // it was created as it is detached container. So just use the previous snapshot.
+                assert(!!this.dataStoreContext.baseSnapshot, 0x181 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
+                summaryTree = convertSnapshotTreeToSummaryTree(this.dataStoreContext.baseSnapshot.trees[contextId]);
+            }
+            summaryBuilder.addWithStats(contextId, summaryTree);
+        });
+        return summaryBuilder.getSummaryTree();
+    }
+    /**
+     * Get the GC Data for the initial state being attached so remote clients can learn of this DataStore's outbound routes
+     */
+    getAttachGCData(telemetryContext) {
+        const gcDataBuilder = new GCDataBuilder();
+        this.visitLocalBoundContextsDuringAttach((contextId, context) => {
+            if (context.isLoaded) {
+                const contextGCData = context.getAttachGCData(telemetryContext);
+                // Incorporate the GC Data for this context
+                gcDataBuilder.prefixAndAddNodes(contextId, contextGCData.gcNodes);
+            }
+            // else: Rehydrating detached container case. GC doesn't run until the container is attached, so nothing to do here.
+        });
+        this.updateGCNodes(gcDataBuilder);
+        return gcDataBuilder.getGCData();
+    }
+    /**
+     * Helper method for preparing to attach this dataStore.
+     * Runs the callback for each bound context to incorporate its data however the caller specifies
+     */
+    visitLocalBoundContextsDuringAttach(visitor) {
         /**
          * back-compat 0.59.1000 - getAttachSummary() is called when making a data store globally visible (previously
          * attaching state). Ideally, attachGraph() should have already be called making it locally visible. However,
@@ -541,29 +619,14 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         // assert(this.visibilityState === VisibilityState.LocallyVisible,
         //  "The data store should be locally visible when generating attach summary",
         // );
-        const summaryBuilder = new SummaryTreeBuilder();
-        // Craft the .attributes file for each shared object
         for (const [contextId, context] of this.contexts) {
             if (!(context instanceof LocalChannelContextBase)) {
                 throw new LoggingError("Should only be called with local channel handles");
             }
             if (!this.notBoundedChannelContextSet.has(contextId)) {
-                let summaryTree;
-                if (context.isLoaded) {
-                    const contextSummary = context.getAttachSummary(telemetryContext);
-                    assert(contextSummary.summary.type === SummaryType.Tree, 0x180 /* "getAttachSummary should always return a tree" */);
-                    summaryTree = { stats: contextSummary.stats, summary: contextSummary.summary };
-                }
-                else {
-                    // If this channel is not yet loaded, then there should be no changes in the snapshot from which
-                    // it was created as it is detached container. So just use the previous snapshot.
-                    assert(!!this.dataStoreContext.baseSnapshot, 0x181 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
-                    summaryTree = convertSnapshotTreeToSummaryTree(this.dataStoreContext.baseSnapshot.trees[contextId]);
-                }
-                summaryBuilder.addWithStats(contextId, summaryTree);
+                visitor(contextId, context);
             }
         }
-        return summaryBuilder.getSummaryTree();
     }
     submitMessage(type, content, localOpMetadata) {
         this.submit(type, content, localOpMetadata);
@@ -585,9 +648,10 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         return this.deferredAttached.promise;
     }
     /**
-     * Attach channel should only be called after the data store has been attached
+     * Assuming this DataStore is already attached, this will make the given channel locally visible
+     * by submitting its attach op.
      */
-    attachChannel(channel) {
+    makeChannelLocallyVisible(channel) {
         this.verifyNotClosed();
         // If this handle is already attached no need to attach again.
         if (channel.handle.isAttached) {
@@ -597,6 +661,9 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         assert(this.isAttached, 0x182 /* "Data store should be attached to attach the channel." */);
         assert(this.visibilityState === VisibilityState.GloballyVisible, 0x2d0 /* "Data store should be globally visible to attach channels." */);
         const summarizeResult = summarizeChannel(channel, true /* fullTree */, false /* trackState */);
+        // We need to include the channel's GC Data so remote clients can learn of this channel's outbound routes
+        const gcData = channel.getGCData(/* fullGC: */ true);
+        addBlobToSummary(summarizeResult, gcDataBlobKey, JSON.stringify(gcData));
         // Attach message needs the summary in ITree format. Convert the ISummaryTree into an ITree.
         const snapshot = convertSummaryTreeToITree(summarizeResult.summary);
         const message = {
@@ -706,33 +773,15 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
     }
     attachListener() {
         this.setMaxListeners(Number.MAX_SAFE_INTEGER);
-        this.dataStoreContext.once("attaching", () => {
-            /**
-             * back-compat 0.59.1000 - Ideally, attachGraph() should have already been called making the data store
-             * locally visible. However, before visibility state was added, this may not have been the case and data
-             * store can move to "attaching" state in 2 scenarios:
-             * 1) Before attachGraph() is called - When a data store is created and bound in an attached container.
-             * 2) After attachGraph() is called - When a detached container is attached.
-             *
-             * The basic idea is that all local object should become locally visible before they are globally visible.
-             */
-            this.attachGraph();
-            this._attachState = AttachState.Attaching;
-            assert(this.visibilityState === VisibilityState.LocallyVisible, 0x2d1 /* "Data store should be locally visible before it can become globally visible." */);
-            // Mark the data store globally visible and make its child channels visible as well.
-            this.visibilityState = VisibilityState.GloballyVisible;
-            this.localChannelContextQueue.forEach((channel) => {
-                channel.makeVisible();
-            });
-            this.localChannelContextQueue.clear();
-            // This promise resolution will be moved to attached event once we fix the scheduler.
-            this.deferredAttached.resolve();
-            this.emit("attaching");
+        // back-compat, to be removed in the future.
+        // Added in "2.0.0-rc.2.0.0" timeframe.
+        this.dataStoreContext.once?.("attaching", () => {
+            this.setAttachState(AttachState.Attaching);
         });
-        this.dataStoreContext.once("attached", () => {
-            assert(this.visibilityState === VisibilityState.GloballyVisible, 0x2d2 /* "Data store should be globally visible when its attached." */);
-            this._attachState = AttachState.Attached;
-            this.emit("attached");
+        // back-compat, to be removed in the future.
+        // Added in "2.0.0-rc.2.0.0" timeframe.
+        this.dataStoreContext.once?.("attached", () => {
+            this.setAttachState(AttachState.Attached);
         });
     }
     verifyNotClosed() {
@@ -764,6 +813,40 @@ export class FluidDataStoreRuntime extends TypedEventEmitter {
         });
         this.localChangesTelemetryCount--;
     }
+    setAttachState(attachState) {
+        switch (attachState) {
+            case AttachState.Attaching:
+                /**
+                 * back-compat 0.59.1000 - Ideally, attachGraph() should have already been called making the data store
+                 * locally visible. However, before visibility state was added, this may not have been the case and data
+                 * store can move to "attaching" state in 2 scenarios:
+                 * 1) Before attachGraph() is called - When a data store is created and bound in an attached container.
+                 * 2) After attachGraph() is called - When a detached container is attached.
+                 *
+                 * The basic idea is that all local object should become locally visible before they are globally visible.
+                 */
+                this.attachGraph();
+                this._attachState = AttachState.Attaching;
+                assert(this.visibilityState === VisibilityState.LocallyVisible, 0x2d1 /* "Data store should be locally visible before it can become globally visible." */);
+                // Mark the data store globally visible and make its child channels visible as well.
+                this.visibilityState = VisibilityState.GloballyVisible;
+                this.localChannelContextQueue.forEach((channel) => {
+                    channel.makeVisible();
+                });
+                this.localChannelContextQueue.clear();
+                // This promise resolution will be moved to attached event once we fix the scheduler.
+                this.deferredAttached.resolve();
+                this.emit("attaching");
+                break;
+            case AttachState.Attached:
+                assert(this.visibilityState === VisibilityState.GloballyVisible, 0x2d2 /* "Data store should be globally visible when its attached." */);
+                this._attachState = AttachState.Attached;
+                this.emit("attached");
+                break;
+            default:
+                unreachableCase(attachState, "unreached");
+        }
+    }
 }
 /**
  * Mixin class that adds request handler to FluidDataStoreRuntime
@@ -824,4 +907,4 @@ export const mixinSummaryHandler = (handler, Base = FluidDataStoreRuntime) => cl
         return summary;
     }
 };
-//# sourceMappingURL=dataStoreRuntime.mjs.map
+//# sourceMappingURL=dataStoreRuntime.js.map