@fluidframework/datastore 2.0.0-internal.4.2.1 → 2.0.0-internal.4.3.0

package/src/remoteChannelContext.ts

@@ -4,16 +4,10 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { assert } from "@fluidframework/common-utils";
-import { DataCorruptionError } from "@fluidframework/container-utils";
+import { LazyPromise, assert } from "@fluidframework/common-utils";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
-import {
-	IChannel,
-	IChannelAttributes,
-	IFluidDataStoreRuntime,
-} from "@fluidframework/datastore-definitions";
+import { IChannel, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
-import { readAndParse } from "@fluidframework/driver-utils";
 import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import {
 	CreateChildSummarizerNodeFn,
@@ -25,52 +19,48 @@ import {
 	ISummarizerNodeWithGC,
 	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
-import { ChildLogger, TelemetryDataTag, ThresholdCounter } from "@fluidframework/telemetry-utils";
+import { ChildLogger, ThresholdCounter } from "@fluidframework/telemetry-utils";
 import {
-	attributesBlobKey,
-	createServiceEndpoints,
+	ChannelServiceEndpoints,
+	createChannelServiceEndpoints,
 	IChannelContext,
+	loadChannel,
+	loadChannelFactoryAndAttributes,
 	summarizeChannelAsync,
 } from "./channelContext";
-import { ChannelDeltaConnection } from "./channelDeltaConnection";
-import { ChannelStorageService } from "./channelStorageService";
 import { ISharedObjectRegistry } from "./dataStoreRuntime";
 
 export class RemoteChannelContext implements IChannelContext {
 	private isLoaded = false;
 	private pending: ISequencedDocumentMessage[] | undefined = [];
-	private channelP: Promise<IChannel> | undefined;
+	private readonly channelP: Promise<IChannel>;
 	private channel: IChannel | undefined;
-	private readonly services: {
-		readonly deltaConnection: ChannelDeltaConnection;
-		readonly objectStorage: ChannelStorageService;
-	};
+	private readonly services: ChannelServiceEndpoints;
 	private readonly summarizerNode: ISummarizerNodeWithGC;
 	private readonly subLogger: ITelemetryLogger;
 	private readonly thresholdOpsCounter: ThresholdCounter;
 	private static readonly pendingOpsCountThreshold = 1000;
 
 	constructor(
-		private readonly runtime: IFluidDataStoreRuntime,
-		private readonly dataStoreContext: IFluidDataStoreContext,
+		runtime: IFluidDataStoreRuntime,
+		dataStoreContext: IFluidDataStoreContext,
 		storageService: IDocumentStorageService,
 		submitFn: (content: any, localOpMetadata: unknown) => void,
 		dirtyFn: (address: string) => void,
 		addedGCOutboundReferenceFn: (srcHandle: IFluidHandle, outboundHandle: IFluidHandle) => void,
 		private readonly id: string,
 		baseSnapshot: ISnapshotTree,
-		private readonly registry: ISharedObjectRegistry,
+		registry: ISharedObjectRegistry,
 		extraBlobs: Map<string, ArrayBufferLike> | undefined,
 		createSummarizerNode: CreateChildSummarizerNodeFn,
-		private readonly attachMessageType?: string,
+		attachMessageType?: string,
 	) {
 		assert(!this.id.includes("/"), 0x310 /* Channel context ID cannot contain slashes */);
 
-		this.subLogger = ChildLogger.create(this.runtime.logger, "RemoteChannelContext");
+		this.subLogger = ChildLogger.create(runtime.logger, "RemoteChannelContext");
 
-		this.services = createServiceEndpoints(
-			this.id,
-			this.dataStoreContext.connected,
+		this.services = createChannelServiceEndpoints(
+			dataStoreContext.connected,
 			submitFn,
 			() => dirtyFn(this.id),
 			addedGCOutboundReferenceFn,
@@ -80,6 +70,46 @@ export class RemoteChannelContext implements IChannelContext {
 			extraBlobs,
 		);
 
+		this.channelP = new LazyPromise<IChannel>(async () => {
+			const { attributes, factory } = await loadChannelFactoryAndAttributes(
+				dataStoreContext,
+				this.services,
+				this.id,
+				registry,
+				attachMessageType,
+			);
+
+			const channel = await loadChannel(
+				runtime,
+				attributes,
+				factory,
+				this.services,
+				this.subLogger,
+				this.id,
+			);
+
+			// Send all pending messages to the channel
+			assert(this.pending !== undefined, 0x23f /* "pending undefined" */);
+			for (const message of this.pending) {
+				this.services.deltaConnection.process(
+					message,
+					false,
+					undefined /* localOpMetadata */,
+				);
+			}
+			this.thresholdOpsCounter.send("ProcessPendingOps", this.pending.length);
+
+			// Commit changes.
+			this.channel = channel;
+			this.pending = undefined;
+			this.isLoaded = true;
+
+			// Because have some await between we created the service and here, the connection state might have changed
+			// and we don't propagate the connection state when we are not loaded.  So we have to set it again here.
+			this.services.deltaConnection.setConnectionState(dataStoreContext.connected);
+			return this.channel;
+		});
+
 		const thisSummarizeInternal = async (
 			fullTree: boolean,
 			trackState: boolean,
@@ -106,10 +136,6 @@ export class RemoteChannelContext implements IChannelContext {
 
 	// eslint-disable-next-line @typescript-eslint/promise-function-async
 	public getChannel(): Promise<IChannel> {
-		if (this.channelP === undefined) {
-			this.channelP = this.loadChannel();
-		}
-
 		return this.channelP;
 	}
 
@@ -122,9 +148,9 @@ export class RemoteChannelContext implements IChannelContext {
 		this.services.deltaConnection.setConnectionState(connected);
 	}
 
-	public applyStashedOp(message: ISequencedDocumentMessage): unknown {
+	public applyStashedOp(content: any): unknown {
 		assert(this.isLoaded, 0x194 /* "Remote channel must be loaded when rebasing op" */);
-		return this.services.deltaConnection.applyStashedOp(message);
+		return this.services.deltaConnection.applyStashedOp(content);
 	}
 
 	public processOp(
@@ -187,99 +213,6 @@ export class RemoteChannelContext implements IChannelContext {
 		return { ...summarizeResult, id: this.id };
 	}
 
-	private async loadChannel(): Promise<IChannel> {
-		assert(
-			!this.isLoaded,
-			0x197 /* "Remote channel must not already be loaded when loading" */,
-		);
-
-		let attributes: IChannelAttributes | undefined;
-		if (await this.services.objectStorage.contains(attributesBlobKey)) {
-			attributes = await readAndParse<IChannelAttributes | undefined>(
-				this.services.objectStorage,
-				attributesBlobKey,
-			);
-		}
-
-		// This is a backward compatibility case where the attach message doesn't include attributes. They must
-		// include attach message type.
-		// Since old attach messages will not have attributes, we need to keep this as long as we support old attach
-		// messages.
-		const channelFactoryType = attributes ? attributes.type : this.attachMessageType;
-		if (channelFactoryType === undefined) {
-			throw new DataCorruptionError("channelTypeNotAvailable", {
-				channelId: {
-					value: this.id,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-				dataStoreId: {
-					value: this.dataStoreContext.id,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-				dataStorePackagePath: this.dataStoreContext.packagePath.join("/"),
-				channelFactoryType: this.attachMessageType,
-			});
-		}
-		const factory = this.registry.get(channelFactoryType);
-		if (factory === undefined) {
-			// TODO: dataStoreId may require a different tag from PackageData #7488
-			throw new DataCorruptionError("channelFactoryNotRegisteredForGivenType", {
-				channelId: {
-					value: this.id,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-				dataStoreId: {
-					value: this.dataStoreContext.id,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-				dataStorePackagePath: this.dataStoreContext.packagePath.join("/"),
-				channelFactoryType,
-			});
-		}
-
-		// This is a backward compatibility case where the attach message doesn't include attributes. Get the attributes
-		// from the factory.
-		attributes = attributes ?? factory.attributes;
-
-		// Compare snapshot version to collaborative object version
-		if (
-			attributes.snapshotFormatVersion !== undefined &&
-			attributes.snapshotFormatVersion !== factory.attributes.snapshotFormatVersion
-		) {
-			this.subLogger.sendTelemetryEvent({
-				eventName: "ChannelAttributesVersionMismatch",
-				channelType: { value: attributes.type, tag: TelemetryDataTag.CodeArtifact },
-				channelSnapshotVersion: {
-					value: `${attributes.snapshotFormatVersion}@${attributes.packageVersion}`,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-				channelCodeVersion: {
-					value: `${factory.attributes.snapshotFormatVersion}@${factory.attributes.packageVersion}`,
-					tag: TelemetryDataTag.CodeArtifact,
-				},
-			});
-		}
-
-		const channel = await factory.load(this.runtime, this.id, this.services, attributes);
-
-		// Send all pending messages to the channel
-		assert(this.pending !== undefined, 0x23f /* "pending undefined" */);
-		for (const message of this.pending) {
-			this.services.deltaConnection.process(message, false, undefined /* localOpMetadata */);
-		}
-		this.thresholdOpsCounter.send("ProcessPendingOps", this.pending.length);
-
-		// Commit changes.
-		this.channel = channel;
-		this.pending = undefined;
-		this.isLoaded = true;
-
-		// Because have some await between we created the service and here, the connection state might have changed
-		// and we don't propagate the connection state when we are not loaded.  So we have to set it again here.
-		this.services.deltaConnection.setConnectionState(this.dataStoreContext.connected);
-		return this.channel;
-	}
-
 	/**
 	 * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context.
 	 * Each node has a set of outbound routes to other GC nodes in the document.

package/dist/packageVersion.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export declare const pkgName = "@fluidframework/datastore";
-export declare const pkgVersion = "2.0.0-internal.4.2.1";
-//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,8BAA8B,CAAC;AACnD,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/dist/packageVersion.js

@@ -1,12 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pkgVersion = exports.pkgName = void 0;
-exports.pkgName = "@fluidframework/datastore";
-exports.pkgVersion = "2.0.0-internal.4.2.1";
-//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,2BAA2B,CAAC;AACtC,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/datastore\";\nexport const pkgVersion = \"2.0.0-internal.4.2.1\";\n"]}

package/lib/packageVersion.d.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export declare const pkgName = "@fluidframework/datastore";
-export declare const pkgVersion = "2.0.0-internal.4.2.1";
-//# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,8BAA8B,CAAC;AACnD,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/lib/packageVersion.js

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.0.0-internal.4.2.1";
-//# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,2BAA2B,CAAC;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/datastore\";\nexport const pkgVersion = \"2.0.0-internal.4.2.1\";\n"]}

package/src/packageVersion.ts

@@ -1,9 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- *
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
- */
-
-export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.0.0-internal.4.2.1";