@fluidframework/datastore 2.0.0-dev.5.2.0.169897 → 2.0.0-dev.6.4.0.191258

package/src/dataStoreRuntime.ts

@@ -3,15 +3,17 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import {
+	DataProcessingError,
 	ITelemetryLoggerExt,
-	ChildLogger,
 	generateStack,
 	LoggingError,
-	loggerToMonitoringContext,
 	MonitoringContext,
 	raiseConnectedEvent,
-	TelemetryDataTag,
+	createChildMonitoringContext,
+	tagCodeArtifacts,
+	UsageError,
 } from "@fluidframework/telemetry-utils";
 import {
 	FluidObject,
@@ -20,20 +22,13 @@ import {
 	IRequest,
 	IResponse,
 } from "@fluidframework/core-interfaces";
+import { assert, Deferred, LazyPromise, unreachableCase } from "@fluidframework/core-utils";
 import {
 	IAudience,
 	IDeltaManager,
 	AttachState,
 	ILoaderOptions,
 } from "@fluidframework/container-definitions";
-import { DataProcessingError, UsageError } from "@fluidframework/container-utils";
-import {
-	assert,
-	Deferred,
-	LazyPromise,
-	TypedEventEmitter,
-	unreachableCase,
-} from "@fluidframework/common-utils";
 import { buildSnapshotTree } from "@fluidframework/driver-utils";
 import {
 	IClientDetails,
@@ -45,6 +40,7 @@ import {
 	IQuorumClients,
 } from "@fluidframework/protocol-definitions";
 import {
+	CreateChildSummarizerNodeParam,
 	CreateSummarizerNodeSource,
 	IAttachMessage,
 	IEnvelope,
@@ -68,7 +64,6 @@ import {
 	exceptionToResponse,
 	GCDataBuilder,
 	requestFluidObject,
-	packagePathToTelemetryProperty,
 	unpackChildNodesUsedRoutes,
 } from "@fluidframework/runtime-utils";
 import {
@@ -132,6 +127,9 @@ export class FluidDataStoreRuntime
 	 */
 	public readonly entryPoint?: IFluidHandle<FluidObject>;
 
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
 	public get IFluidRouter() {
 		return this;
 	}
@@ -188,8 +186,7 @@ export class FluidDataStoreRuntime
 	}
 
 	private readonly contexts = new Map<string, IChannelContext>();
-	private readonly contextsDeferred = new Map<string, Deferred<IChannelContext>>();
-	private readonly pendingAttach = new Map<string, IAttachMessage>();
+	private readonly pendingAttach = new Set<string>();
 
 	private readonly deferredAttached = new Deferred<void>();
 	private readonly localChannelContextQueue = new Map<string, LocalChannelContextBase>();
@@ -256,11 +253,13 @@ export class FluidDataStoreRuntime
 			0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */,
 		);
 
-		this.mc = loggerToMonitoringContext(
-			ChildLogger.create(dataStoreContext.logger, "FluidDataStoreRuntime", {
+		this.mc = createChildMonitoringContext({
+			logger: dataStoreContext.logger,
+			namespace: "FluidDataStoreRuntime",
+			properties: {
 				all: { dataStoreId: uuid() },
-			}),
-		);
+			},
+		});
 
 		this.id = dataStoreContext.id;
 		this.options = dataStoreContext.options;
@@ -325,11 +324,8 @@ export class FluidDataStoreRuntime
 						}),
 					);
 				}
-				const deferred = new Deferred<IChannelContext>();
-				deferred.resolve(channelContext);
 
 				this.contexts.set(path, channelContext);
-				this.contextsDeferred.set(path, deferred);
 			});
 		}
 
@@ -388,6 +384,9 @@ export class FluidDataStoreRuntime
 		return this.request(request);
 	}
 
+	/**
+	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
 	public async request(request: IRequest): Promise<IResponse> {
 		try {
 			const parser = RequestParser.create(request);
@@ -398,11 +397,10 @@ export class FluidDataStoreRuntime
 			}
 
 			// Check for a data type reference first
-			if (this.contextsDeferred.has(id) && parser.isLeaf(1)) {
+			const context = this.contexts.get(id);
+			if (context !== undefined && parser.isLeaf(1)) {
 				try {
-					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-					const value = await this.contextsDeferred.get(id)!.promise;
-					const channel = await value.getChannel();
+					const channel = await context.getChannel();
 
 					return { mimeType: "fluid/object", status: 200, value: channel };
 				} catch (error) {
@@ -425,18 +423,12 @@ export class FluidDataStoreRuntime
 	public async getChannel(id: string): Promise<IChannel> {
 		this.verifyNotClosed();
 
-		// TODO we don't assume any channels (even root) in the runtime. If you request a channel that doesn't exist
-		// we will never resolve the promise. May want a flag to getChannel that doesn't wait for the promise if
-		// it doesn't exist
-		if (!this.contextsDeferred.has(id)) {
-			this.contextsDeferred.set(id, new Deferred<IChannelContext>());
+		const context = this.contexts.get(id);
+		if (context === undefined) {
+			throw new LoggingError("Channel does not exist");
 		}
 
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const context = await this.contextsDeferred.get(id)!.promise;
-		const channel = await context.getChannel();
-
-		return channel;
+		return context.getChannel();
 	}
 
 	public createChannel(id: string = uuid(), type: string): IChannel {
@@ -463,15 +455,6 @@ export class FluidDataStoreRuntime
 		);
 		this.contexts.set(id, context);
 
-		if (this.contextsDeferred.has(id)) {
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			this.contextsDeferred.get(id)!.resolve(context);
-		} else {
-			const deferred = new Deferred<IChannelContext>();
-			deferred.resolve(context);
-			this.contextsDeferred.set(id, deferred);
-		}
-
 		// Channels (DDS) should not be created in summarizer client.
 		this.identifyLocalChangeInSummarizer("DDSCreatedInSummarizer", id, type);
 
@@ -583,10 +566,41 @@ export class FluidDataStoreRuntime
 		return this.audience;
 	}
 
-	public async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {
+	public async uploadBlob(
+		blob: ArrayBufferLike,
+		signal?: AbortSignal,
+	): Promise<IFluidHandle<ArrayBufferLike>> {
 		this.verifyNotClosed();
 
-		return this.dataStoreContext.uploadBlob(blob);
+		return this.dataStoreContext.uploadBlob(blob, signal);
+	}
+
+	private createRemoteChannelContext(
+		attachMessage: IAttachMessage,
+		summarizerNodeParams: CreateChildSummarizerNodeParam,
+	) {
+		const flatBlobs = new Map<string, ArrayBufferLike>();
+		const snapshotTree = buildSnapshotTree(attachMessage.snapshot.entries, flatBlobs);
+
+		return new RemoteChannelContext(
+			this,
+			this.dataStoreContext,
+			this.dataStoreContext.storage,
+			(content, localContentMetadata) =>
+				this.submitChannelOp(attachMessage.id, content, localContentMetadata),
+			(address: string) => this.setChannelDirty(address),
+			(srcHandle: IFluidHandle, outboundHandle: IFluidHandle) =>
+				this.addedGCOutboundReference(srcHandle, outboundHandle),
+			attachMessage.id,
+			snapshotTree,
+			this.sharedObjectRegistry,
+			flatBlobs,
+			this.dataStoreContext.getCreateChildSummarizerNodeFn(
+				attachMessage.id,
+				summarizerNodeParams,
+			),
+			attachMessage.type,
+		);
 	}
 
 	public process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {
@@ -603,49 +617,23 @@ export class FluidDataStoreRuntime
 					// Otherwise mark it as officially attached.
 					if (local) {
 						assert(
-							this.pendingAttach.has(id),
+							this.pendingAttach.delete(id),
 							0x17c /* "Unexpected attach (local) channel OP" */,
 						);
-						this.pendingAttach.delete(id);
 					} else {
 						assert(!this.contexts.has(id), 0x17d /* "Unexpected attach channel OP" */);
 
-						const flatBlobs = new Map<string, ArrayBufferLike>();
-						const snapshotTree = buildSnapshotTree(
-							attachMessage.snapshot.entries,
-							flatBlobs,
-						);
+						const summarizerNodeParams = {
+							type: CreateSummarizerNodeSource.FromAttach,
+							sequenceNumber: message.sequenceNumber,
+							snapshot: attachMessage.snapshot,
+						};
 
-						const remoteChannelContext = new RemoteChannelContext(
-							this,
-							this.dataStoreContext,
-							this.dataStoreContext.storage,
-							(content, localContentMetadata) =>
-								this.submitChannelOp(id, content, localContentMetadata),
-							(address: string) => this.setChannelDirty(address),
-							(srcHandle: IFluidHandle, outboundHandle: IFluidHandle) =>
-								this.addedGCOutboundReference(srcHandle, outboundHandle),
-							id,
-							snapshotTree,
-							this.sharedObjectRegistry,
-							flatBlobs,
-							this.dataStoreContext.getCreateChildSummarizerNodeFn(id, {
-								type: CreateSummarizerNodeSource.FromAttach,
-								sequenceNumber: message.sequenceNumber,
-								snapshot: attachMessage.snapshot,
-							}),
-							attachMessage.type,
+						const remoteChannelContext = this.createRemoteChannelContext(
+							attachMessage,
+							summarizerNodeParams,
 						);
-
 						this.contexts.set(id, remoteChannelContext);
-						if (this.contextsDeferred.has(id)) {
-							// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-							this.contextsDeferred.get(id)!.resolve(remoteChannelContext);
-						} else {
-							const deferred = new Deferred<IChannelContext>();
-							deferred.resolve(remoteChannelContext);
-							this.contextsDeferred.set(id, deferred);
-						}
 					}
 					break;
 				}
@@ -925,7 +913,7 @@ export class FluidDataStoreRuntime
 			snapshot,
 			type: channel.attributes.type,
 		};
-		this.pendingAttach.set(channel.id, message);
+		this.pendingAttach.add(channel.id);
 		this.submit(DataStoreMessageType.Attach, message);
 
 		const context = this.contexts.get(channel.id) as LocalChannelContextBase;
@@ -1003,11 +991,35 @@ export class FluidDataStoreRuntime
 	}
 
 	public async applyStashedOp(content: any): Promise<unknown> {
-		const envelope = content as IEnvelope;
-		const channelContext = this.contexts.get(envelope.address);
-		assert(!!channelContext, 0x184 /* "There should be a channel context for the op" */);
-		await channelContext.getChannel();
-		return channelContext.applyStashedOp(envelope.contents);
+		const type = content?.type as DataStoreMessageType;
+		switch (type) {
+			case DataStoreMessageType.Attach: {
+				const attachMessage = content.content as IAttachMessage;
+				// local means this node will throw if summarized; this is fine because only interactive clients will have stashed ops
+				const summarizerNodeParams: CreateChildSummarizerNodeParam = {
+					type: CreateSummarizerNodeSource.Local,
+				};
+				const context = this.createRemoteChannelContext(
+					attachMessage,
+					summarizerNodeParams,
+				);
+				this.pendingAttach.add(attachMessage.id);
+				this.contexts.set(attachMessage.id, context);
+				return;
+			}
+			case DataStoreMessageType.ChannelOp: {
+				const envelope = content.content as IEnvelope;
+				const channelContext = this.contexts.get(envelope.address);
+				assert(
+					!!channelContext,
+					0x184 /* "There should be a channel context for the op" */,
+				);
+				await channelContext.getChannel();
+				return channelContext.applyStashedOp(envelope.contents);
+			}
+			default:
+				unreachableCase(type);
+		}
 	}
 
 	private setChannelDirty(address: string): void {
@@ -1103,18 +1115,12 @@ export class FluidDataStoreRuntime
 		// in the summarizer and the data will help us plan this.
 		this.mc.logger.sendTelemetryEvent({
 			eventName,
-			channelType,
-			channelId: {
-				value: channelId,
-				tag: TelemetryDataTag.CodeArtifact,
-			},
-			fluidDataStoreId: {
-				value: this.id,
-				tag: TelemetryDataTag.CodeArtifact,
-			},
-			fluidDataStorePackagePath: packagePathToTelemetryProperty(
-				this.dataStoreContext.packagePath,
-			),
+			...tagCodeArtifacts({
+				channelType,
+				channelId,
+				fluidDataStoreId: this.id,
+				fluidDataStorePackagePath: this.dataStoreContext.packagePath.join("/"),
+			}),
 			stack: generateStack(),
 		});
 		this.localChangesTelemetryCount--;

package/src/localChannelContext.ts

@@ -5,7 +5,7 @@
 
 // eslint-disable-next-line import/no-internal-modules
 import cloneDeep from "lodash/cloneDeep";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { DataProcessingError, ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import { IChannel, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
@@ -15,8 +15,7 @@ import {
 	ISummarizeResult,
 	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
-import { DataProcessingError } from "@fluidframework/container-utils";
-import { assert, Lazy, LazyPromise } from "@fluidframework/common-utils";
+import { assert, Lazy, LazyPromise } from "@fluidframework/core-utils";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import {
 	ChannelServiceEndpoints,

package/src/localChannelStorageService.ts

@@ -4,7 +4,7 @@
  */
 
 import { IChannelStorageService } from "@fluidframework/datastore-definitions";
-import { stringToBuffer } from "@fluidframework/common-utils";
+import { stringToBuffer } from "@fluid-internal/client-utils";
 import { IBlob, ITree, TreeEntry } from "@fluidframework/protocol-definitions";
 import { listBlobsAtTreePath } from "@fluidframework/runtime-utils";
 

package/src/remoteChannelContext.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { LazyPromise, assert } from "@fluidframework/common-utils";
+import { assert, LazyPromise } from "@fluidframework/core-utils";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IChannel, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
@@ -19,7 +19,7 @@ import {
 	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 import {
-	ChildLogger,
+	createChildLogger,
 	ITelemetryLoggerExt,
 	ThresholdCounter,
 } from "@fluidframework/telemetry-utils";
@@ -60,7 +60,10 @@ export class RemoteChannelContext implements IChannelContext {
 	) {
 		assert(!this.id.includes("/"), 0x310 /* Channel context ID cannot contain slashes */);
 
-		this.subLogger = ChildLogger.create(runtime.logger, "RemoteChannelContext");
+		this.subLogger = createChildLogger({
+			logger: runtime.logger,
+			namespace: "RemoteChannelContext",
+		});
 
 		this.services = createChannelServiceEndpoints(
 			dataStoreContext.connected,