@fluidframework/container-loader 2.0.0-dev.7.2.0.204906 → 2.0.0-dev.7.3.0.206769

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev.7.2.0.204906",
+  "version": "2.0.0-dev.7.3.0.206769",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,15 +35,15 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.7.2.0.204906",
-    "@fluidframework/container-definitions": "2.0.0-dev.7.2.0.204906",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.2.0.204906",
-    "@fluidframework/core-utils": "2.0.0-dev.7.2.0.204906",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.2.0.204906",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.2.0.204906",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/core-utils": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.3.0.206769",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.3.0.206769",
     "@fluidframework/protocol-base": "^2.0.1",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.3.0.206769",
     "debug": "^4.3.4",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -52,13 +52,13 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-internal/test-loader-utils": "2.0.0-dev.7.2.0.204906",
-    "@fluid-tools/build-cli": "0.26.0-203096",
-    "@fluidframework/build-common": "^2.0.2",
-    "@fluidframework/build-tools": "0.26.0-203096",
+    "@fluid-internal/test-loader-utils": "2.0.0-dev.7.3.0.206769",
+    "@fluid-tools/build-cli": "^0.26.1",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.26.1",
     "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.7.1.0",
     "@fluidframework/eslint-config-fluid": "^3.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.3.0.206769",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
@@ -90,7 +90,7 @@
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
+    "clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

package/src/connectionManager.ts

@@ -594,6 +594,14 @@ export class ConnectionManager implements IConnectionManager {
 					LogLevel.verbose,
 				);
 			} catch (origError: any) {
+				this.logger.sendTelemetryEvent(
+					{
+						eventName: "ConnectToDeltaStreamException",
+						connected: connection !== undefined && connection.disposed === false,
+					},
+					undefined,
+					LogLevel.verbose,
+				);
 				if (isDeltaStreamConnectionForbiddenError(origError)) {
 					connection = new NoDeltaStream(origError.storageOnlyReason, {
 						text: origError.message,
@@ -1059,9 +1067,9 @@ export class ConnectionManager implements IConnectionManager {
 		};
 	}
 
-	public submitSignal(content: any) {
+	public submitSignal(content: any, targetClientId?: string) {
 		if (this.connection !== undefined) {
-			this.connection.submitSignal(content);
+			this.connection.submitSignal(content, targetClientId);
 		} else {
 			this.logger.sendErrorEvent({ eventName: "submitSignalDisconnected" });
 		}

package/src/container.ts

@@ -40,6 +40,7 @@ import {
 	IRuntime,
 	ReadOnlyInfo,
 	isFluidCodeDetails,
+	IGetPendingLocalStateProps,
 } from "@fluidframework/container-definitions";
 import {
 	IDocumentService,
@@ -1112,12 +1113,17 @@ export class Container
 		}
 	}
 
-	public async closeAndGetPendingLocalState(): Promise<string> {
+	public async closeAndGetPendingLocalState(
+		stopBlobAttachingSignal?: AbortSignal,
+	): Promise<string> {
 		// runtime matches pending ops to successful ones by clientId and client seq num, so we need to close the
 		// container at the same time we get pending state, otherwise this container could reconnect and resubmit with
 		// a new clientId and a future container using stale pending state without the new clientId would resubmit them
 		this.disconnectInternal({ text: "closeAndGetPendingLocalState" }); // TODO https://dev.azure.com/fluidframework/internal/_workitems/edit/5127
-		const pendingState = await this.getPendingLocalStateCore({ notifyImminentClosure: true });
+		const pendingState = await this.getPendingLocalStateCore({
+			notifyImminentClosure: true,
+			stopBlobAttachingSignal,
+		});
 		this.close();
 		return pendingState;
 	}
@@ -1126,7 +1132,7 @@ export class Container
 		return this.getPendingLocalStateCore({ notifyImminentClosure: false });
 	}
 
-	private async getPendingLocalStateCore(props: { notifyImminentClosure: boolean }) {
+	private async getPendingLocalStateCore(props: IGetPendingLocalStateProps) {
 		return PerformanceEvent.timedExecAsync(
 			this.mc.logger,
 			{
@@ -2339,8 +2345,8 @@ export class Container
 		this.emit("op", message);
 	}
 
-	private submitSignal(message: any) {
-		this._deltaManager.submitSignal(JSON.stringify(message));
+	private submitSignal(content: any, targetClientId?: string) {
+		this._deltaManager.submitSignal(JSON.stringify(content), targetClientId);
 	}
 
 	private processSignal(message: ISignalMessage) {
@@ -2434,7 +2440,7 @@ export class Container
 				this.submitSummaryMessage(summaryOp, referenceSequenceNumber),
 			(batch: IBatchMessage[], referenceSequenceNumber?: number) =>
 				this.submitBatch(batch, referenceSequenceNumber),
-			(message) => this.submitSignal(message),
+			(content, targetClientId) => this.submitSignal(content, targetClientId),
 			(error?: ICriticalContainerError) => this.dispose(error),
 			(error?: ICriticalContainerError) => this.close(error),
 			this.updateDirtyContainerState,
@@ -2517,7 +2523,7 @@ export class Container
 
 /**
  * IContainer interface that includes experimental features still under development.
- * @experimental
+ * @alpha
  */
 export interface IContainerExperimental extends IContainer {
 	/**
@@ -2525,7 +2531,7 @@ export interface IContainerExperimental extends IContainer {
 	 * submission and potential document corruption. The blob returned MUST be deleted if and when this
 	 * container emits a "connected" event.
 	 * @returns serialized blob that can be passed to Loader.resolve()
-	 * @experimental misuse of this API can result in duplicate op submission and potential document corruption
+	 * @alpha misuse of this API can result in duplicate op submission and potential document corruption
 	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/closeAndGetPendingLocalState.md}
 	 */
 	getPendingLocalState?(): Promise<string>;
@@ -2533,8 +2539,8 @@ export interface IContainerExperimental extends IContainer {
 	/**
 	 * Closes the container and returns serialized local state intended to be
 	 * given to a newly loaded container.
-	 * @experimental
+	 * @alpha
 	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/closeAndGetPendingLocalState.md}
 	 */
-	closeAndGetPendingLocalState?(): Promise<string>;
+	closeAndGetPendingLocalState?(stopBlobAttachingSignal?: AbortSignal): Promise<string>;
 }

package/src/containerContext.ts

@@ -85,7 +85,7 @@ export class ContainerContext implements IContainerContext {
 			batch: IBatchMessage[],
 			referenceSequenceNumber?: number,
 		) => number,
-		public readonly submitSignalFn: (contents: any) => void,
+		public readonly submitSignalFn: (content: any, targetClientId?: string) => void,
 		public readonly disposeFn: (error?: ICriticalContainerError) => void,
 		public readonly closeFn: (error?: ICriticalContainerError) => void,
 		public readonly updateDirtyContainerState: (dirty: boolean) => void,

package/src/contracts.ts

@@ -100,7 +100,7 @@ export interface IConnectionManager {
 	 * Submits signal to relay service.
 	 * Called only when active connection is present.
 	 */
-	submitSignal(content: any): void;
+	submitSignal(content: any, targetClientId?: string): void;
 
 	/**
 	 * Submits messages to relay service.

package/src/deltaManager.ts

@@ -301,8 +301,8 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 		return message.clientSequenceNumber;
 	}
 
-	public submitSignal(content: any) {
-		return this.connectionManager.submitSignal(content);
+	public submitSignal(content: any, targetClientId?: string) {
+		return this.connectionManager.submitSignal(content, targetClientId);
 	}
 
 	public flush() {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-dev.7.2.0.204906";
+export const pkgVersion = "2.0.0-dev.7.3.0.206769";

package/dist/container-loader-alpha.d.ts

@@ -1,333 +0,0 @@
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudienceOwner } from '@fluidframework/container-definitions';
-import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IConfigProviderBase } from '@fluidframework/telemetry-utils';
-import { IContainer } from '@fluidframework/container-definitions';
-import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IFluidCodeDetails } from '@fluidframework/container-definitions';
-import { IFluidModule } from '@fluidframework/container-definitions';
-import { IFluidRouter } from '@fluidframework/core-interfaces';
-import { IHostLoader } from '@fluidframework/container-definitions';
-import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
-import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
-import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
-import { IQuorumSnapshot } from '@fluidframework/protocol-base';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { IUrlResolver } from '@fluidframework/driver-definitions';
-
-export declare enum ConnectionState {
-    /**
-     * The container is not connected to the ordering service
-     * Note - When in this state the container may be about to reconnect,
-     * or may remain disconnected until explicitly told to connect.
-     */
-    Disconnected = 0,
-    /**
-     * The container is disconnected but actively trying to establish a new connection
-     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state
-     */
-    EstablishingConnection = 3,
-    /**
-     * The container has an inbound connection only, and is catching up to the latest known state from the service.
-     */
-    CatchingUp = 1,
-    /**
-     * The container is fully connected and syncing
-     */
-    Connected = 2
-}
-
-/**
- * @deprecated ICodeDetailsLoader interface is moved to {@link @fluidframework/container-definition#ICodeDetailsLoader}
- * to have code loading modules in one package. #8193
- * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
- * a package name and package version range.
- */
-export declare interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    /**
-     * Load the code module (package) that is capable to interact with the document.
-     *
-     * @param source - Code proposal that articulates the current schema the document is written in.
-     * @returns Code module entry point along with the code details associated with it.
-     */
-    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
-}
-
-/**
- * IContainer interface that includes experimental features still under development.
- * @experimental
- */
-export declare interface IContainerExperimental extends IContainer {
-    /**
-     * Get pending state from container. WARNING: misuse of this API can result in duplicate op
-     * submission and potential document corruption. The blob returned MUST be deleted if and when this
-     * container emits a "connected" event.
-     * @returns serialized blob that can be passed to Loader.resolve()
-     * @experimental misuse of this API can result in duplicate op submission and potential document corruption
-     * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/closeAndGetPendingLocalState.md}
-     */
-    getPendingLocalState?(): Promise<string>;
-    /**
-     * Closes the container and returns serialized local state intended to be
-     * given to a newly loaded container.
-     * @experimental
-     * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/closeAndGetPendingLocalState.md}
-     */
-    closeAndGetPendingLocalState?(): Promise<string>;
-}
-
-/**
- * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
- * blobs in detached containers.
- */
-export declare type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
-    size: number;
-    /**
-     * Return an array of all blob IDs present in storage
-     */
-    getBlobIds(): string[];
-};
-
-/**
- * @deprecated IFluidModuleWithDetails interface is moved to
- * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
- * to have all the code loading modules in one package. #8193
- * Encapsulates a module entry point with corresponding code details.
- */
-export declare interface IFluidModuleWithDetails {
-    /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
-    module: IFluidModule;
-    /**
-     * Code details associated with the module. Represents a document schema this module supports.
-     * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
-     * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
-     */
-    details: IFluidCodeDetails;
-}
-
-export declare interface ILoaderOptions extends ILoaderOptions_2 {
-    summarizeProtocolTree?: boolean;
-}
-
-/**
- * Services and properties necessary for creating a loader
- */
-export declare interface ILoaderProps {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options?: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope?: FluidObject;
-    /**
-     * The logger that all telemetry should be pushed to.
-     */
-    readonly logger?: ITelemetryBaseLogger;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * The configuration provider which may be used to control features.
-     */
-    readonly configProvider?: IConfigProviderBase;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/**
- * Services and properties used by and exposed by the loader
- */
-export declare interface ILoaderServices {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope: FluidObject;
-    /**
-     * The logger downstream consumers should construct their loggers from
-     */
-    readonly subLogger: ITelemetryLoggerExt;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/**
- * Interface to represent the parsed parts of IResolvedUrl.url to help
- * in getting info about different parts of the url.
- * May not be compatible or relevant for any Url Resolver
- */
-export declare interface IParsedUrl {
-    /**
-     * It is combination of tenantid/docId part of the url.
-     */
-    id: string;
-    /**
-     * It is the deep link path in the url.
-     */
-    path: string;
-    /**
-     * Query string part of the url.
-     */
-    query: string;
-    /**
-     * Null means do not use snapshots, undefined means load latest snapshot
-     * otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.
-     * If needed, can add undefined which is treated by Container.load() as load latest snapshot.
-     */
-    version: string | null | undefined;
-}
-
-export declare interface IProtocolHandler extends IProtocolHandler_2 {
-    readonly audience: IAudienceOwner;
-    processSignal(message: ISignalMessage): any;
-}
-
-/**
- * Checks if the error is location redirection error.
- * @param error - error whose type is to be determined.
- * @returns `true` is the error is location redirection error, otherwise `false`.
- */
-export declare function isLocationRedirectionError(error: any): error is ILocationRedirectionError;
-
-/**
- * Manages Fluid resource loading
- */
-export declare class Loader implements IHostLoader {
-    readonly services: ILoaderServices;
-    private readonly mc;
-    constructor(loaderProps: ILoaderProps);
-    /**
-     * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
-     */
-    get IFluidRouter(): IFluidRouter;
-    createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
-    /**
-     * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the Container's IFluidRouter/request.
-     */
-    request(request: IRequest): Promise<IResponse>;
-    private resolveCore;
-    private loadContainer;
-}
-
-/**
- * Function to be used for creating a protocol handler.
- */
-export declare type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
-
-/**
- * With an already-resolved container, we can request a component directly, without loading the container again
- * @param container - a resolved container
- * @returns component on the container
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- */
-export declare function requestResolvedObjectFromContainer(container: IContainer, headers?: IRequestHeader): Promise<IResponse>;
-
-/**
- * Handles location redirection while fulfilling the loader request.
- * @param api - Callback in which user can wrap the loader.resolve or loader.request call.
- * @param request - request to be resolved.
- * @param urlResolver - resolver used to resolve the url.
- * @param logger - logger to send events.
- * @returns Response from the API call.
- */
-export declare function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
-
-/**
- * Utility api to parse the IResolvedUrl.url into specific parts like querystring, path to get
- * deep link info etc.
- * Warning - This function may not be compatible with any Url Resolver's resolved url. It works
- * with urls of type: protocol://<string>/.../..?<querystring>
- * @param url - This is the IResolvedUrl.url part of the resolved url.
- * @returns The IParsedUrl representing the input URL, or undefined if the format was not supported
- */
-export declare function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined;
-
-/**
- * Waits until container connects to delta storage and gets up-to-date.
- *
- * Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being
- * up to date. Host may chose to wait in such case and retry resolving URI.
- *
- * Warning: Will wait infinitely for connection to establish if there is no connection.
- * May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
- *
- * @returns `true`: container is up to date, it processed all the ops that were know at the time of first connection.
- *
- * `false`: storage does not provide indication of how far the client is. Container processed all the ops known to it,
- * but it maybe still behind.
- *
- * @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
- */
-export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
-
-export { }