@fluidframework/datastore 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/src/localChannelContext.ts

@@ -9,26 +9,26 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import {
-    IChannel,
-    IFluidDataStoreRuntime,
-    IChannelFactory,
-    IChannelAttributes,
+	IChannel,
+	IFluidDataStoreRuntime,
+	IChannelFactory,
+	IChannelAttributes,
 } from "@fluidframework/datastore-definitions";
 import {
-    IFluidDataStoreContext,
-    IGarbageCollectionData,
-    ISummarizeResult,
-    ITelemetryContext,
+	IFluidDataStoreContext,
+	IGarbageCollectionData,
+	ISummarizeResult,
+	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { DataProcessingError } from "@fluidframework/container-utils";
 import { assert, Lazy } from "@fluidframework/common-utils";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
 import {
-    createServiceEndpoints,
-    IChannelContext,
-    summarizeChannel,
-    summarizeChannelAsync,
+	createServiceEndpoints,
+	IChannelContext,
+	summarizeChannel,
+	summarizeChannelAsync,
 } from "./channelContext";
 import { ChannelDeltaConnection } from "./channelDeltaConnection";
 import { ISharedObjectRegistry } from "./dataStoreRuntime";
@@ -38,276 +38,323 @@ import { ChannelStorageService } from "./channelStorageService";
  * Channel context for a locally created channel
  */
 export abstract class LocalChannelContextBase implements IChannelContext {
-    public channel: IChannel | undefined;
-    private globallyVisible = false;
-    protected readonly pending: ISequencedDocumentMessage[] = [];
-    protected factory: IChannelFactory | undefined;
-    constructor(
-        protected readonly id: string,
-        protected readonly registry: ISharedObjectRegistry,
-        protected readonly runtime: IFluidDataStoreRuntime,
-        private readonly servicesGetter: () => Lazy<{
-                readonly deltaConnection: ChannelDeltaConnection;
-                readonly objectStorage: ChannelStorageService;
-            }>,
-    ) {
-        assert(!this.id.includes("/"), 0x30f /* Channel context ID cannot contain slashes */);
-    }
+	public channel: IChannel | undefined;
+	private globallyVisible = false;
+	protected readonly pending: ISequencedDocumentMessage[] = [];
+	protected factory: IChannelFactory | undefined;
+	constructor(
+		protected readonly id: string,
+		protected readonly registry: ISharedObjectRegistry,
+		protected readonly runtime: IFluidDataStoreRuntime,
+		private readonly servicesGetter: () => Lazy<{
+			readonly deltaConnection: ChannelDeltaConnection;
+			readonly objectStorage: ChannelStorageService;
+		}>,
+	) {
+		assert(!this.id.includes("/"), 0x30f /* Channel context ID cannot contain slashes */);
+	}
 
-    public async getChannel(): Promise<IChannel> {
-        assert(this.channel !== undefined, 0x207 /* "Channel should be defined" */);
-        return this.channel;
-    }
+	public async getChannel(): Promise<IChannel> {
+		assert(this.channel !== undefined, 0x207 /* "Channel should be defined" */);
+		return this.channel;
+	}
 
-    public get isLoaded(): boolean {
-        return this.channel !== undefined;
-    }
+	public get isLoaded(): boolean {
+		return this.channel !== undefined;
+	}
 
-    public setConnectionState(connected: boolean, clientId?: string) {
-        // Connection events are ignored if the data store is not yet globallyVisible or loaded
-        if (this.globallyVisible && this.isLoaded) {
-            this.servicesGetter().value.deltaConnection.setConnectionState(connected);
-        }
-    }
+	public setConnectionState(connected: boolean, clientId?: string) {
+		// Connection events are ignored if the data store is not yet globallyVisible or loaded
+		if (this.globallyVisible && this.isLoaded) {
+			this.servicesGetter().value.deltaConnection.setConnectionState(connected);
+		}
+	}
 
-    public processOp(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void {
-        assert(this.globallyVisible, 0x2d3 /* "Local channel must be globally visible when processing op" */);
+	public processOp(
+		message: ISequencedDocumentMessage,
+		local: boolean,
+		localOpMetadata: unknown,
+	): void {
+		assert(
+			this.globallyVisible,
+			0x2d3 /* "Local channel must be globally visible when processing op" */,
+		);
 
-        // A local channel may not be loaded in case where we rehydrate the container from a snapshot because of
-        // delay loading. So after the container is attached and some other client joins which start generating
-        // ops for this channel. So not loaded local channel can still receive ops and we store them to process later.
-        if (this.isLoaded) {
-            this.servicesGetter().value.deltaConnection.process(message, local, localOpMetadata);
-        } else {
-            assert(local === false,
-                0x189 /* "Should always be remote because a local dds shouldn't generate ops before loading" */);
-            this.pending.push(message);
-        }
-    }
+		// A local channel may not be loaded in case where we rehydrate the container from a snapshot because of
+		// delay loading. So after the container is attached and some other client joins which start generating
+		// ops for this channel. So not loaded local channel can still receive ops and we store them to process later.
+		if (this.isLoaded) {
+			this.servicesGetter().value.deltaConnection.process(message, local, localOpMetadata);
+		} else {
+			assert(
+				local === false,
+				0x189 /* "Should always be remote because a local dds shouldn't generate ops before loading" */,
+			);
+			this.pending.push(message);
+		}
+	}
 
-    public reSubmit(content: any, localOpMetadata: unknown) {
-        assert(this.isLoaded, 0x18a /* "Channel should be loaded to resubmit ops" */);
-        assert(this.globallyVisible, 0x2d4 /* "Local channel must be globally visible when resubmitting op" */);
-        this.servicesGetter().value.deltaConnection.reSubmit(content, localOpMetadata);
-    }
-    public rollback(content: any, localOpMetadata: unknown) {
-        assert(this.isLoaded, 0x2ee /* "Channel should be loaded to rollback ops" */);
-        assert(this.globallyVisible, 0x2ef /* "Local channel must be globally visible when rolling back op" */);
-        this.servicesGetter().value.deltaConnection.rollback(content, localOpMetadata);
-    }
+	public reSubmit(content: any, localOpMetadata: unknown) {
+		assert(this.isLoaded, 0x18a /* "Channel should be loaded to resubmit ops" */);
+		assert(
+			this.globallyVisible,
+			0x2d4 /* "Local channel must be globally visible when resubmitting op" */,
+		);
+		this.servicesGetter().value.deltaConnection.reSubmit(content, localOpMetadata);
+	}
+	public rollback(content: any, localOpMetadata: unknown) {
+		assert(this.isLoaded, 0x2ee /* "Channel should be loaded to rollback ops" */);
+		assert(
+			this.globallyVisible,
+			0x2ef /* "Local channel must be globally visible when rolling back op" */,
+		);
+		this.servicesGetter().value.deltaConnection.rollback(content, localOpMetadata);
+	}
 
-    public applyStashedOp() {
-        throw new Error("no stashed ops on local channel");
-    }
+	public applyStashedOp() {
+		throw new Error("no stashed ops on local channel");
+	}
 
-    /**
-     * Returns a summary at the current sequence number.
-     * @param fullTree - true to bypass optimizations and force a full summary tree
-     * @param trackState - This tells whether we should track state from this summary.
-     * @param telemetryContext - summary data passed through the layers for telemetry purposes
-     */
-    public async summarize(
-        fullTree: boolean = false,
-        trackState: boolean = false,
-        telemetryContext?: ITelemetryContext,
-    ): Promise<ISummarizeResult> {
-        assert(this.isLoaded && this.channel !== undefined, 0x18c /* "Channel should be loaded to summarize" */);
-        return summarizeChannelAsync(this.channel, fullTree, trackState, telemetryContext);
-    }
+	/**
+	 * Returns a summary at the current sequence number.
+	 * @param fullTree - true to bypass optimizations and force a full summary tree
+	 * @param trackState - This tells whether we should track state from this summary.
+	 * @param telemetryContext - summary data passed through the layers for telemetry purposes
+	 */
+	public async summarize(
+		fullTree: boolean = false,
+		trackState: boolean = false,
+		telemetryContext?: ITelemetryContext,
+	): Promise<ISummarizeResult> {
+		assert(
+			this.isLoaded && this.channel !== undefined,
+			0x18c /* "Channel should be loaded to summarize" */,
+		);
+		return summarizeChannelAsync(this.channel, fullTree, trackState, telemetryContext);
+	}
 
-    public getAttachSummary(telemetryContext?: ITelemetryContext): ISummarizeResult {
-        assert(this.isLoaded && this.channel !== undefined, 0x18d /* "Channel should be loaded to take snapshot" */);
-        return summarizeChannel(this.channel, true /* fullTree */, false /* trackState */, telemetryContext);
-    }
+	public getAttachSummary(telemetryContext?: ITelemetryContext): ISummarizeResult {
+		assert(
+			this.isLoaded && this.channel !== undefined,
+			0x18d /* "Channel should be loaded to take snapshot" */,
+		);
+		return summarizeChannel(
+			this.channel,
+			true /* fullTree */,
+			false /* trackState */,
+			telemetryContext,
+		);
+	}
 
-    public makeVisible(): void {
-        if (this.globallyVisible) {
-            throw new Error("Channel is already globally visible");
-        }
+	public makeVisible(): void {
+		if (this.globallyVisible) {
+			throw new Error("Channel is already globally visible");
+		}
 
-        if (this.isLoaded) {
-            assert(!!this.channel, 0x192 /* "Channel should be there if loaded!!" */);
-            this.channel.connect(this.servicesGetter().value);
-        }
-        this.globallyVisible = true;
-    }
+		if (this.isLoaded) {
+			assert(!!this.channel, 0x192 /* "Channel should be there if loaded!!" */);
+			this.channel.connect(this.servicesGetter().value);
+		}
+		this.globallyVisible = true;
+	}
 
-    /**
-     * 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. This should be called only after
-     * the context has loaded.
-     * @param fullGC - true to bypass optimizations and force full generation of GC data.
-     */
-    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {
-        assert(this.isLoaded && this.channel !== undefined, 0x193 /* "Channel should be loaded to run GC" */);
-        return this.channel.getGCData(fullGC);
-    }
+	/**
+	 * 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. This should be called only after
+	 * the context has loaded.
+	 * @param fullGC - true to bypass optimizations and force full generation of GC data.
+	 */
+	public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {
+		assert(
+			this.isLoaded && this.channel !== undefined,
+			0x193 /* "Channel should be loaded to run GC" */,
+		);
+		return this.channel.getGCData(fullGC);
+	}
 
-    public updateUsedRoutes(usedRoutes: string[]) {
-        /**
-         * Currently, DDSes are always considered referenced and are not garbage collected.
-         * Once we have GC at DDS level, this channel context's used routes will be updated as per the passed
-         * value. See - https://github.com/microsoft/FluidFramework/issues/4611
-         */
-    }
+	public updateUsedRoutes(usedRoutes: string[]) {
+		/**
+		 * Currently, DDSes are always considered referenced and are not garbage collected.
+		 * Once we have GC at DDS level, this channel context's used routes will be updated as per the passed
+		 * value. See - https://github.com/microsoft/FluidFramework/issues/4611
+		 */
+	}
 }
 
 export class RehydratedLocalChannelContext extends LocalChannelContextBase {
-    private readonly services: Lazy<{
-        readonly deltaConnection: ChannelDeltaConnection;
-        readonly objectStorage: ChannelStorageService;
-    }>;
+	private readonly services: Lazy<{
+		readonly deltaConnection: ChannelDeltaConnection;
+		readonly objectStorage: ChannelStorageService;
+	}>;
 
-    private readonly dirtyFn: () => void;
+	private readonly dirtyFn: () => void;
 
-    constructor(
-        id: string,
-        registry: ISharedObjectRegistry,
-        runtime: IFluidDataStoreRuntime,
-        dataStoreContext: IFluidDataStoreContext,
-        storageService: IDocumentStorageService,
-        logger: ITelemetryLogger,
-        submitFn: (content: any, localOpMetadata: unknown) => void,
-        dirtyFn: (address: string) => void,
-        addedGCOutboundReferenceFn: (srcHandle: IFluidHandle, outboundHandle: IFluidHandle) => void,
-        private readonly snapshotTree: ISnapshotTree,
-    ) {
-        super(id, registry, runtime, () => this.services);
-        const blobMap: Map<string, ArrayBufferLike> = new Map<string, ArrayBufferLike>();
-        const clonedSnapshotTree = cloneDeep(this.snapshotTree);
-        // 0.47 back-compat Need to sanitize if snapshotTree.blobs still contains blob contents too.
-        // This is for older snapshot which is generated by loader <=0.47 version which still contains
-        // the contents within blobs. After a couple of revisions we can remove it.
-        if (this.isSnapshotInOldFormatAndCollectBlobs(clonedSnapshotTree, blobMap)) {
-            this.sanitizeSnapshot(clonedSnapshotTree);
-        }
+	constructor(
+		id: string,
+		registry: ISharedObjectRegistry,
+		runtime: IFluidDataStoreRuntime,
+		dataStoreContext: IFluidDataStoreContext,
+		storageService: IDocumentStorageService,
+		logger: ITelemetryLogger,
+		submitFn: (content: any, localOpMetadata: unknown) => void,
+		dirtyFn: (address: string) => void,
+		addedGCOutboundReferenceFn: (srcHandle: IFluidHandle, outboundHandle: IFluidHandle) => void,
+		private readonly snapshotTree: ISnapshotTree,
+	) {
+		super(id, registry, runtime, () => this.services);
+		const blobMap: Map<string, ArrayBufferLike> = new Map<string, ArrayBufferLike>();
+		const clonedSnapshotTree = cloneDeep(this.snapshotTree);
+		// 0.47 back-compat Need to sanitize if snapshotTree.blobs still contains blob contents too.
+		// This is for older snapshot which is generated by loader <=0.47 version which still contains
+		// the contents within blobs. After a couple of revisions we can remove it.
+		if (this.isSnapshotInOldFormatAndCollectBlobs(clonedSnapshotTree, blobMap)) {
+			this.sanitizeSnapshot(clonedSnapshotTree);
+		}
 
-        this.services = new Lazy(() => {
-            return createServiceEndpoints(
-                this.id,
-                dataStoreContext.connected,
-                submitFn,
-                this.dirtyFn,
-                addedGCOutboundReferenceFn,
-                storageService,
-                logger,
-                clonedSnapshotTree,
-                blobMap,
-            );
-        });
-        this.dirtyFn = () => { dirtyFn(id); };
-    }
+		this.services = new Lazy(() => {
+			return createServiceEndpoints(
+				this.id,
+				dataStoreContext.connected,
+				submitFn,
+				this.dirtyFn,
+				addedGCOutboundReferenceFn,
+				storageService,
+				logger,
+				clonedSnapshotTree,
+				blobMap,
+			);
+		});
+		this.dirtyFn = () => {
+			dirtyFn(id);
+		};
+	}
 
-    public async getChannel(): Promise<IChannel> {
-        if (this.channel === undefined) {
-            this.channel = await this.loadChannel()
-                .catch((err) => {
-                    throw DataProcessingError.wrapIfUnrecognized(
-                        err, "rehydratedLocalChannelContextFailedToLoadChannel", undefined);
-                });
-        }
-        return this.channel;
-    }
+	public async getChannel(): Promise<IChannel> {
+		if (this.channel === undefined) {
+			this.channel = await this.loadChannel().catch((err) => {
+				throw DataProcessingError.wrapIfUnrecognized(
+					err,
+					"rehydratedLocalChannelContextFailedToLoadChannel",
+					undefined,
+				);
+			});
+		}
+		return this.channel;
+	}
 
-    private async loadChannel(): Promise<IChannel> {
-        assert(!this.isLoaded, 0x18e /* "Channel must not already be loaded when loading" */);
-        assert(await this.services.value.objectStorage.contains(".attributes"),
-            0x190 /* ".attributes blob should be present" */);
-        const attributes = await readAndParse<IChannelAttributes>(
-            this.services.value.objectStorage,
-            ".attributes");
+	private async loadChannel(): Promise<IChannel> {
+		assert(!this.isLoaded, 0x18e /* "Channel must not already be loaded when loading" */);
+		assert(
+			await this.services.value.objectStorage.contains(".attributes"),
+			0x190 /* ".attributes blob should be present" */,
+		);
+		const attributes = await readAndParse<IChannelAttributes>(
+			this.services.value.objectStorage,
+			".attributes",
+		);
 
-        assert(this.factory === undefined, 0x208 /* "Factory should be undefined before loading" */);
-        this.factory = this.registry.get(attributes.type);
-        if (this.factory === undefined) {
-            throw new Error(`Channel Factory ${attributes.type} not registered`);
-        }
-        // Services will be assigned during this load.
-        const channel = await this.factory.load(
-            this.runtime,
-            this.id,
-            this.services.value,
-            attributes);
+		assert(
+			this.factory === undefined,
+			0x208 /* "Factory should be undefined before loading" */,
+		);
+		this.factory = this.registry.get(attributes.type);
+		if (this.factory === undefined) {
+			throw new Error(`Channel Factory ${attributes.type} not registered`);
+		}
+		// Services will be assigned during this load.
+		const channel = await this.factory.load(
+			this.runtime,
+			this.id,
+			this.services.value,
+			attributes,
+		);
 
-        // Commit changes.
-        this.channel = channel;
+		// Commit changes.
+		this.channel = channel;
 
-        // Send all pending messages to the channel
-        for (const message of this.pending) {
-            this.services.value.deltaConnection.process(message, false, undefined /* localOpMetadata */);
-        }
-        return this.channel;
-    }
+		// Send all pending messages to the channel
+		for (const message of this.pending) {
+			this.services.value.deltaConnection.process(
+				message,
+				false,
+				undefined /* localOpMetadata */,
+			);
+		}
+		return this.channel;
+	}
 
-    private isSnapshotInOldFormatAndCollectBlobs(
-        snapshotTree: ISnapshotTree,
-        blobMap: Map<string, ArrayBufferLike>,
-    ): boolean {
-        let sanitize = false;
-        const blobsContents: { [path: string]: ArrayBufferLike; } = (snapshotTree as any).blobsContents;
-        Object.entries(blobsContents).forEach(([key, value]) => {
-            blobMap.set(key, value);
-            if (snapshotTree.blobs[key] !== undefined) {
-                sanitize = true;
-            }
-        });
-        for (const value of Object.values(snapshotTree.trees)) {
-            sanitize = sanitize || this.isSnapshotInOldFormatAndCollectBlobs(value, blobMap);
-        }
-        return sanitize;
-    }
+	private isSnapshotInOldFormatAndCollectBlobs(
+		snapshotTree: ISnapshotTree,
+		blobMap: Map<string, ArrayBufferLike>,
+	): boolean {
+		let sanitize = false;
+		const blobsContents: { [path: string]: ArrayBufferLike } = (snapshotTree as any)
+			.blobsContents;
+		Object.entries(blobsContents).forEach(([key, value]) => {
+			blobMap.set(key, value);
+			if (snapshotTree.blobs[key] !== undefined) {
+				sanitize = true;
+			}
+		});
+		for (const value of Object.values(snapshotTree.trees)) {
+			sanitize = sanitize || this.isSnapshotInOldFormatAndCollectBlobs(value, blobMap);
+		}
+		return sanitize;
+	}
 
-    private sanitizeSnapshot(snapshotTree: ISnapshotTree) {
-        const blobMapInitial = new Map(Object.entries(snapshotTree.blobs));
-        for (const [blobName, blobId] of blobMapInitial.entries()) {
-            const blobValue = blobMapInitial.get(blobId);
-            if (blobValue === undefined) {
-                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-                delete snapshotTree.blobs[blobName];
-            }
-        }
-        for (const value of Object.values(snapshotTree.trees)) {
-            this.sanitizeSnapshot(value);
-        }
-    }
+	private sanitizeSnapshot(snapshotTree: ISnapshotTree) {
+		const blobMapInitial = new Map(Object.entries(snapshotTree.blobs));
+		for (const [blobName, blobId] of blobMapInitial.entries()) {
+			const blobValue = blobMapInitial.get(blobId);
+			if (blobValue === undefined) {
+				// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+				delete snapshotTree.blobs[blobName];
+			}
+		}
+		for (const value of Object.values(snapshotTree.trees)) {
+			this.sanitizeSnapshot(value);
+		}
+	}
 }
 
 export class LocalChannelContext extends LocalChannelContextBase {
-    private readonly services: Lazy<{
-        readonly deltaConnection: ChannelDeltaConnection;
-        readonly objectStorage: ChannelStorageService;
-    }>;
-    private readonly dirtyFn: () => void;
-    constructor(
-        id: string,
-        registry: ISharedObjectRegistry,
-        type: string,
-        runtime: IFluidDataStoreRuntime,
-        dataStoreContext: IFluidDataStoreContext,
-        storageService: IDocumentStorageService,
-        logger: ITelemetryLogger,
-        submitFn: (content: any, localOpMetadata: unknown) => void,
-        dirtyFn: (address: string) => void,
-        addedGCOutboundReferenceFn: (srcHandle: IFluidHandle, outboundHandle: IFluidHandle) => void,
-    ) {
-        super(id, registry, runtime, () => this.services);
-        assert(type !== undefined, 0x209 /* "Factory Type should be defined" */);
-        this.factory = registry.get(type);
-        if (this.factory === undefined) {
-            throw new Error(`Channel Factory ${type} not registered`);
-        }
-        this.channel = this.factory.create(runtime, id);
-        this.services = new Lazy(() => {
-            return createServiceEndpoints(
-                this.id,
-                dataStoreContext.connected,
-                submitFn,
-                this.dirtyFn,
-                addedGCOutboundReferenceFn,
-                storageService,
-                logger,
-            );
-        });
-        this.dirtyFn = () => { dirtyFn(id); };
-    }
+	private readonly services: Lazy<{
+		readonly deltaConnection: ChannelDeltaConnection;
+		readonly objectStorage: ChannelStorageService;
+	}>;
+	private readonly dirtyFn: () => void;
+	constructor(
+		id: string,
+		registry: ISharedObjectRegistry,
+		type: string,
+		runtime: IFluidDataStoreRuntime,
+		dataStoreContext: IFluidDataStoreContext,
+		storageService: IDocumentStorageService,
+		logger: ITelemetryLogger,
+		submitFn: (content: any, localOpMetadata: unknown) => void,
+		dirtyFn: (address: string) => void,
+		addedGCOutboundReferenceFn: (srcHandle: IFluidHandle, outboundHandle: IFluidHandle) => void,
+	) {
+		super(id, registry, runtime, () => this.services);
+		assert(type !== undefined, 0x209 /* "Factory Type should be defined" */);
+		this.factory = registry.get(type);
+		if (this.factory === undefined) {
+			throw new Error(`Channel Factory ${type} not registered`);
+		}
+		this.channel = this.factory.create(runtime, id);
+		this.services = new Lazy(() => {
+			return createServiceEndpoints(
+				this.id,
+				dataStoreContext.connected,
+				submitFn,
+				this.dirtyFn,
+				addedGCOutboundReferenceFn,
+				storageService,
+				logger,
+			);
+		});
+		this.dirtyFn = () => {
+			dirtyFn(id);
+		};
+	}
 }