@fluidframework/container-loader 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev.7.4.0.217212",
+  "version": "2.0.0-dev.7.4.0.221926",
   "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.4.0.217212",
-    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.217212",
-    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/container-definitions": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.221926",
     "@fluidframework/protocol-base": "^2.0.1",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.4.0.221926",
     "debug": "^4.3.4",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -51,19 +51,20 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-private/test-loader-utils": "2.0.0-dev.7.4.0.217212",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-private/test-loader-utils": "2.0.0-dev.7.4.0.221926",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.7.2.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.217212",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.221926",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/debug": "^4.1.5",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^16.18.38",
+    "@types/node": "^18.19.0",
     "@types/sinon": "^7.0.13",
     "c8": "^7.7.1",
     "copyfiles": "^2.4.1",
@@ -105,6 +106,7 @@
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "build:genver": "gen-version",
     "build:test": "tsc-multi --config tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",

package/src/connectionStateHandler.ts

@@ -312,12 +312,25 @@ class ConnectionStateCatchup extends ConnectionStateHandlerPassThrough {
 class ConnectionStateHandler implements IConnectionStateHandler {
 	private _connectionState = ConnectionState.Disconnected;
 	private _pendingClientId: string | undefined;
+
+	/**
+	 * Tracks that we observe the "leave" op within the timeout for our previous clientId (see comment on ConnectionStateHandler class)
+	 * ! This ensures we do not switch to a new clientId until we process all potential messages from old clientId
+	 * ! i.e. We will always see the "leave" op for a client after we have seen all the ops it has sent
+	 * ! This check helps prevent the same op from being resubmitted by the PendingStateManager upon reconnecting
+	 */
 	private readonly prevClientLeftTimer: Timer;
+
+	/**
+	 * Tracks that we observe our own "join" op within the timeout after receiving a "connected" event from the DeltaManager
+	 */
 	private readonly joinOpTimer: Timer;
+
 	private protocol?: IProtocolHandler;
 	private connection?: IConnectionDetailsInternal;
 	private _clientId?: string;
 
+	/** Track how long we waited to see "leave" op for previous clientId */
 	private waitEvent: PerformanceEvent | undefined;
 
 	public get connectionState(): ConnectionState {
@@ -453,9 +466,9 @@ class ConnectionStateHandler implements IConnectionStateHandler {
 			0x2e2 /* "Must only wait for leave message when clientId in quorum" */,
 		);
 
-		// Move to connected state only if we are in Connecting state, we have seen our join op
-		// and there is no timer running which means we are not waiting for previous client to leave
-		// or timeout has occurred while doing so.
+		// Move to connected state only if:
+		// 1. We have seen our own "join" op (i.e. for this.pendingClientId)
+		// 2. There is no "leave" timer running, meaning this is our first connection or the previous client has left (via this.prevClientLeftTimer)
 		if (
 			this.pendingClientId !== this.clientId &&
 			this.hasMember(this.pendingClientId) &&

package/src/loader.ts

@@ -6,7 +6,6 @@
 import { v4 as uuid } from "uuid";
 import {
 	ITelemetryLoggerExt,
-	IConfigProviderBase,
 	mixinMonitoringContext,
 	MonitoringContext,
 	PerformanceEvent,
@@ -22,6 +21,7 @@ import {
 	IRequest,
 	IRequestHeader,
 	IResponse,
+	IConfigProviderBase,
 } from "@fluidframework/core-interfaces";
 import {
 	IContainer,
@@ -114,7 +114,7 @@ export class RelativeLoader implements ILoader {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export interface ILoaderOptions extends ILoaderOptions1 {
 	summarizeProtocolTree?: boolean;
@@ -125,7 +125,7 @@ export interface ILoaderOptions extends ILoaderOptions1 {
  * {@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.
- * @internal
+ * @alpha
  */
 export interface IFluidModuleWithDetails {
 	/** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
@@ -143,7 +143,7 @@ export interface IFluidModuleWithDetails {
  * 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.
- * @internal
+ * @alpha
  */
 export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
 	/**
@@ -157,7 +157,7 @@ export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComp
 
 /**
  * Services and properties necessary for creating a loader
- * @internal
+ * @alpha
  */
 export interface ILoaderProps {
 	/**
@@ -214,7 +214,7 @@ export interface ILoaderProps {
 
 /**
  * Services and properties used by and exposed by the loader
- * @internal
+ * @alpha
  */
 export interface ILoaderServices {
 	/**
@@ -267,7 +267,7 @@ export interface ILoaderServices {
 /**
  * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
  * blobs in detached containers.
- * @internal
+ * @alpha
  */
 export type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
 	size: number;
@@ -307,7 +307,7 @@ export async function requestResolvedObjectFromContainer(
 
 /**
  * Manages Fluid resource loading
- * @internal
+ * @alpha
  */
 export class Loader implements IHostLoader {
 	public readonly services: ILoaderServices;

package/src/packageVersion.ts

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

package/src/protocol.ts

@@ -28,7 +28,7 @@ export enum SignalType {
 
 /**
  * Function to be used for creating a protocol handler.
- * @internal
+ * @alpha
  */
 export type ProtocolHandlerBuilder = (
 	attributes: IDocumentAttributes,
@@ -37,7 +37,7 @@ export type ProtocolHandlerBuilder = (
 ) => IProtocolHandler;
 
 /**
- * @internal
+ * @alpha
  */
 export interface IProtocolHandler extends IBaseProtocolHandler {
 	readonly audience: IAudienceOwner;