@fluidframework/container-runtime 2.0.0-dev.2.2.0.111723 → 2.0.0-dev.3.1.0.125672

package/src/dataStore.ts

@@ -7,13 +7,12 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { assert, unreachableCase } from "@fluidframework/common-utils";
 import { AttachState } from "@fluidframework/container-definitions";
 import { UsageError } from "@fluidframework/container-utils";
+import { FluidObject, IFluidHandle, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import {
-    FluidObject,
-    IFluidHandle,
-    IRequest,
-    IResponse,
-} from "@fluidframework/core-interfaces";
-import { AliasResult, IDataStore, IFluidDataStoreChannel } from "@fluidframework/runtime-definitions";
+	AliasResult,
+	IDataStore,
+	IFluidDataStoreChannel,
+} from "@fluidframework/runtime-definitions";
 import { TelemetryDataTag } from "@fluidframework/telemetry-utils";
 import { ContainerRuntime } from "./containerRuntime";
 import { DataStores } from "./dataStores";
@@ -23,10 +22,10 @@ import { DataStores } from "./dataStores";
  * alias to a datastore
  */
 export interface IDataStoreAliasMessage {
-    /** The internal id of the datastore */
-    readonly internalId: string;
-    /** The alias name to be assigned to the datastore */
-    readonly alias: string;
+	/** The internal id of the datastore */
+	readonly internalId: string;
+	/** The alias name to be assigned to the datastore */
+	readonly alias: string;
 }
 
 /**
@@ -36,163 +35,177 @@ export interface IDataStoreAliasMessage {
  * @returns True if the {@link IDataStoreAliasMessage} is fully implemented, false otherwise
  */
 export const isDataStoreAliasMessage = (
-    maybeDataStoreAliasMessage: any,
+	maybeDataStoreAliasMessage: any,
 ): maybeDataStoreAliasMessage is IDataStoreAliasMessage => {
-    return typeof maybeDataStoreAliasMessage?.internalId === "string"
-        && typeof maybeDataStoreAliasMessage?.alias === "string";
+	return (
+		typeof maybeDataStoreAliasMessage?.internalId === "string" &&
+		typeof maybeDataStoreAliasMessage?.alias === "string"
+	);
 };
 
 export const channelToDataStore = (
-    fluidDataStoreChannel: IFluidDataStoreChannel,
-    internalId: string,
-    runtime: ContainerRuntime,
-    datastores: DataStores,
-    logger: ITelemetryLogger,
+	fluidDataStoreChannel: IFluidDataStoreChannel,
+	internalId: string,
+	runtime: ContainerRuntime,
+	datastores: DataStores,
+	logger: ITelemetryLogger,
 ): IDataStore => new DataStore(fluidDataStoreChannel, internalId, runtime, datastores, logger);
 
 enum AliasState {
-    Aliased = "Aliased",
-    Aliasing = "Aliasing",
-    None = "None",
+	Aliased = "Aliased",
+	Aliasing = "Aliasing",
+	None = "None",
 }
 
 class DataStore implements IDataStore {
-    private aliasState: AliasState = AliasState.None;
-    private alias: string | undefined;
-    private readonly pendingAliases: Map<string, Promise<AliasResult>>;
-    private aliasResult: Promise<AliasResult> | undefined;
-
-    async trySetAlias(alias: string): Promise<AliasResult> {
-        if (alias.includes("/")) {
-            throw new UsageError(`The alias cannot contain slashes: '${alias}'`);
-        }
-
-        switch (this.aliasState) {
-            // If we're already aliasing, check if it's for the same value and return
-            // the stored promise, otherwise return 'AlreadyAliased'
-            case AliasState.Aliasing:
-                assert(this.aliasResult !== undefined,
-                    0x316 /* There should be a cached promise of in-progress aliasing */);
-                await this.aliasResult;
-                return this.alias === alias ? "Success" : "AlreadyAliased";
-
-            // If this datastore is already aliased, return true only if this
-            // is a repeated call for the same alias
-            case AliasState.Aliased:
-                return this.alias === alias ? "Success" : "AlreadyAliased";
-
-            case AliasState.None: {
-                const existingAlias = this.pendingAliases.get(alias);
-                if (existingAlias !== undefined) {
-                    // There is already another datastore which will be aliased
-                    // to the same name
-                    return "Conflict";
-                }
-
-                // There is no current or past alias operation for this datastore,
-                // or for this alias, so it is safe to continue execution
-                break;
-            }
-
-            default: unreachableCase(this.aliasState);
-        }
-
-        this.aliasState = AliasState.Aliasing;
-        this.aliasResult = this.trySetAliasInternal(alias);
-        this.pendingAliases.set(alias, this.aliasResult);
-        return this.aliasResult;
-    }
-
-    async trySetAliasInternal(alias: string): Promise<AliasResult> {
-        const message: IDataStoreAliasMessage = {
-            internalId: this.internalId,
-            alias,
-        };
-
-        this.fluidDataStoreChannel.makeVisibleAndAttachGraph();
-
-        if (this.runtime.attachState === AttachState.Detached) {
-            const localResult = this.datastores.processAliasMessageCore(message);
-            // Explicitly lock-out future attempts of aliasing,
-            // regardless of result
-            this.aliasState = AliasState.Aliased;
-            return localResult ? "Success" : "Conflict";
-        }
-
-        const aliased = await this
-            .ackBasedPromise<boolean>((resolve) => {
-                this.runtime.submitDataStoreAliasOp(message, resolve);
-            })
-            .catch((error) => {
-                this.logger.sendErrorEvent({
-                    eventName: "AliasingException",
-                    alias: {
-                        value: alias,
-                        tag: TelemetryDataTag.UserData,
-                    },
-                    internalId: {
-                        value: this.internalId,
-                        tag: TelemetryDataTag.CodeArtifact,
-                    },
-                }, error);
-
-                return false;
-            }).finally(() => {
-                this.pendingAliases.delete(alias);
-            });
-
-        if (!aliased) {
-            this.aliasState = AliasState.None;
-            this.aliasResult = undefined;
-            return "Conflict";
-        }
-
-        this.alias = alias;
-        this.aliasState = AliasState.Aliased;
-        return "Success";
-    }
-
-    async request(request: IRequest): Promise<IResponse> {
-        return this.fluidDataStoreChannel.request(request);
-    }
-
-    /**
-     * {@inheritDoc @fluidframework/runtime-definitions#IDataStore.entryPoint}
-     */
-    get entryPoint(): IFluidHandle<FluidObject> | undefined {
-        return this.fluidDataStoreChannel.entryPoint;
-    }
-
-    constructor(
-        private readonly fluidDataStoreChannel: IFluidDataStoreChannel,
-        private readonly internalId: string,
-        private readonly runtime: ContainerRuntime,
-        private readonly datastores: DataStores,
-        private readonly logger: ITelemetryLogger,
-    ) {
-        this.pendingAliases = datastores.pendingAliases;
-    }
-
-    public get IFluidRouter() { return this.fluidDataStoreChannel; }
-
-    private async ackBasedPromise<T>(
-        executor: (resolve: (value: T | PromiseLike<T>) => void,
-            reject: (reason?: any) => void) => void,
-    ): Promise<T> {
-        let rejectBecauseDispose: () => void;
-        return new Promise<T>((resolve, reject) => {
-            rejectBecauseDispose =
-                () => reject(new Error("ContainerRuntime disposed while this ack-based Promise was pending"));
-
-            if (this.runtime.disposed) {
-                rejectBecauseDispose();
-                return;
-            }
-
-            this.runtime.on("dispose", rejectBecauseDispose);
-            executor(resolve, reject);
-        }).finally(() => {
-            this.runtime.off("dispose", rejectBecauseDispose);
-        });
-    }
+	private aliasState: AliasState = AliasState.None;
+	private alias: string | undefined;
+	private readonly pendingAliases: Map<string, Promise<AliasResult>>;
+	private aliasResult: Promise<AliasResult> | undefined;
+
+	async trySetAlias(alias: string): Promise<AliasResult> {
+		if (alias.includes("/")) {
+			throw new UsageError(`The alias cannot contain slashes: '${alias}'`);
+		}
+
+		switch (this.aliasState) {
+			// If we're already aliasing, check if it's for the same value and return
+			// the stored promise, otherwise return 'AlreadyAliased'
+			case AliasState.Aliasing:
+				assert(
+					this.aliasResult !== undefined,
+					0x316 /* There should be a cached promise of in-progress aliasing */,
+				);
+				await this.aliasResult;
+				return this.alias === alias ? "Success" : "AlreadyAliased";
+
+			// If this datastore is already aliased, return true only if this
+			// is a repeated call for the same alias
+			case AliasState.Aliased:
+				return this.alias === alias ? "Success" : "AlreadyAliased";
+
+			case AliasState.None: {
+				const existingAlias = this.pendingAliases.get(alias);
+				if (existingAlias !== undefined) {
+					// There is already another datastore which will be aliased
+					// to the same name
+					return "Conflict";
+				}
+
+				// There is no current or past alias operation for this datastore,
+				// or for this alias, so it is safe to continue execution
+				break;
+			}
+
+			default:
+				unreachableCase(this.aliasState);
+		}
+
+		this.aliasState = AliasState.Aliasing;
+		this.aliasResult = this.trySetAliasInternal(alias);
+		this.pendingAliases.set(alias, this.aliasResult);
+		return this.aliasResult;
+	}
+
+	async trySetAliasInternal(alias: string): Promise<AliasResult> {
+		const message: IDataStoreAliasMessage = {
+			internalId: this.internalId,
+			alias,
+		};
+
+		this.fluidDataStoreChannel.makeVisibleAndAttachGraph();
+
+		if (this.runtime.attachState === AttachState.Detached) {
+			const localResult = this.datastores.processAliasMessageCore(message);
+			// Explicitly lock-out future attempts of aliasing,
+			// regardless of result
+			this.aliasState = AliasState.Aliased;
+			return localResult ? "Success" : "Conflict";
+		}
+
+		const aliased = await this.ackBasedPromise<boolean>((resolve) => {
+			this.runtime.submitDataStoreAliasOp(message, resolve);
+		})
+			.catch((error) => {
+				this.logger.sendErrorEvent(
+					{
+						eventName: "AliasingException",
+						alias: {
+							value: alias,
+							tag: TelemetryDataTag.UserData,
+						},
+						internalId: {
+							value: this.internalId,
+							tag: TelemetryDataTag.CodeArtifact,
+						},
+					},
+					error,
+				);
+
+				return false;
+			})
+			.finally(() => {
+				this.pendingAliases.delete(alias);
+			});
+
+		if (!aliased) {
+			this.aliasState = AliasState.None;
+			this.aliasResult = undefined;
+			return "Conflict";
+		}
+
+		this.alias = alias;
+		this.aliasState = AliasState.Aliased;
+		return "Success";
+	}
+
+	async request(request: IRequest): Promise<IResponse> {
+		return this.fluidDataStoreChannel.request(request);
+	}
+
+	/**
+	 * {@inheritDoc @fluidframework/runtime-definitions#IDataStore.entryPoint}
+	 */
+	get entryPoint(): IFluidHandle<FluidObject> | undefined {
+		return this.fluidDataStoreChannel.entryPoint;
+	}
+
+	constructor(
+		private readonly fluidDataStoreChannel: IFluidDataStoreChannel,
+		private readonly internalId: string,
+		private readonly runtime: ContainerRuntime,
+		private readonly datastores: DataStores,
+		private readonly logger: ITelemetryLogger,
+	) {
+		this.pendingAliases = datastores.pendingAliases;
+	}
+
+	public get IFluidRouter() {
+		return this.fluidDataStoreChannel;
+	}
+
+	private async ackBasedPromise<T>(
+		executor: (
+			resolve: (value: T | PromiseLike<T>) => void,
+			reject: (reason?: any) => void,
+		) => void,
+	): Promise<T> {
+		let rejectBecauseDispose: () => void;
+		return new Promise<T>((resolve, reject) => {
+			rejectBecauseDispose = () =>
+				reject(
+					new Error("ContainerRuntime disposed while this ack-based Promise was pending"),
+				);
+
+			if (this.runtime.disposed) {
+				rejectBecauseDispose();
+				return;
+			}
+
+			this.runtime.on("dispose", rejectBecauseDispose);
+			executor(resolve, reject);
+		}).finally(() => {
+			this.runtime.off("dispose", rejectBecauseDispose);
+		});
+	}
 }