@fluidframework/container-runtime 2.13.0 → 2.21.0

package/src/summary/orderedClientElection.ts

@@ -31,50 +31,72 @@ export type Immutable<T> = T extends ImmutablePrimitives
 				? ReadonlySet<Immutable<V>>
 				: { readonly [K in keyof T]: Immutable<T[K]> };
 
-/** Minimum information for a client tracked for election consideration. */
+/**
+ * Minimum information for a client tracked for election consideration.
+ */
 export interface ITrackedClient {
 	readonly clientId: string;
 	readonly sequenceNumber: number;
 	readonly client: Immutable<IClient>;
 }
 
-/** Common contract for link nodes within an OrderedClientCollection. */
+/**
+ * Common contract for link nodes within an OrderedClientCollection.
+ */
 export interface ILinkNode {
 	readonly sequenceNumber: number;
 	youngerClient: ILinkedClient | undefined;
 }
 
-/** Placeholder root node within an OrderedClientCollection; does not represent a client. */
+/**
+ * Placeholder root node within an OrderedClientCollection; does not represent a client.
+ */
 export interface IRootLinkNode extends ILinkNode {
 	readonly sequenceNumber: -1;
 	readonly olderClient: undefined;
 }
 
-/** Additional information required to keep track of the client within the doubly-linked list. */
+/**
+ * Additional information required to keep track of the client within the doubly-linked list.
+ */
 export interface ILinkedClient extends ILinkNode, ITrackedClient {
 	olderClient: LinkNode;
 }
 
-/** Any link node within OrderedClientCollection including the placeholder root node. */
+/**
+ * Any link node within OrderedClientCollection including the placeholder root node.
+ */
 export type LinkNode = IRootLinkNode | ILinkedClient;
 
-/** Events raised by an OrderedClientCollection. */
+/**
+ * Events raised by an OrderedClientCollection.
+ */
 export interface IOrderedClientCollectionEvents extends IEvent {
-	/** Event fires when client is being added. */
+	/**
+	 * Event fires when client is being added.
+	 */
 	(
 		event: "addClient" | "removeClient",
 		listener: (client: ILinkedClient, sequenceNumber: number) => void,
 	);
 }
 
-/** Contract for a sorted collection of all clients in the quorum. */
+/**
+ * Contract for a sorted collection of all clients in the quorum.
+ */
 export interface IOrderedClientCollection
 	extends IEventProvider<IOrderedClientCollectionEvents> {
-	/** Count of clients in the collection. */
+	/**
+	 * Count of clients in the collection.
+	 */
 	readonly count: number;
-	/** Pointer to the oldest client in the collection. */
+	/**
+	 * Pointer to the oldest client in the collection.
+	 */
 	readonly oldestClient: ILinkedClient | undefined;
-	/** Returns a sorted array of all the clients in the collection. */
+	/**
+	 * Returns a sorted array of all the clients in the collection.
+	 */
 	getAllClients(): ILinkedClient[];
 }
 
@@ -89,22 +111,28 @@ export class OrderedClientCollection
 	extends TypedEventEmitter<IOrderedClientCollectionEvents>
 	implements IOrderedClientCollection
 {
-	/** Collection of ALL clients currently in the quorum, with client ids as keys. */
+	/**
+	 * Collection of ALL clients currently in the quorum, with client ids as keys.
+	 */
 	private readonly clientMap = new Map<string, ILinkedClient>();
-	/** Placeholder head node of linked list, for simplified null checking. */
+	/**
+	 * Placeholder head node of linked list, for simplified null checking.
+	 */
 	private readonly rootNode: IRootLinkNode = {
 		sequenceNumber: -1,
 		olderClient: undefined,
 		youngerClient: undefined,
 	};
-	/** Pointer to end of linked list, for optimized client adds. */
+	/**
+	 * Pointer to end of linked list, for optimized client adds.
+	 */
 	private _youngestClient: LinkNode = this.rootNode;
 	private readonly logger: ITelemetryLoggerExt;
 
-	public get count() {
+	public get count(): number {
 		return this.clientMap.size;
 	}
-	public get oldestClient() {
+	public get oldestClient(): ILinkedClient | undefined {
 		return this.rootNode.youngerClient;
 	}
 
@@ -201,7 +229,9 @@ export class OrderedClientCollection
 		return removeClient;
 	}
 
-	/** Returns an array of all clients being tracked in order from oldest to newest. */
+	/**
+	 * Returns an array of all clients being tracked in order from oldest to newest.
+	 */
 	public getAllClients(): ILinkedClient[] {
 		const result: ILinkedClient[] = [];
 		let currClient: LinkNode = this.rootNode;
@@ -213,17 +243,27 @@ export class OrderedClientCollection
 	}
 }
 
-/** Events raised by an OrderedClientElection. */
+/**
+ * Events raised by an OrderedClientElection.
+ */
 export interface IOrderedClientElectionEvents extends IEvent {
-	/** Event fires when the currently elected client changes. */
+	/**
+	 * Event fires when the currently elected client changes.
+	 */
 	(
 		event: "election",
 		listener: (
-			/** Newly elected client. */
+			/**
+			 * Newly elected client.
+			 */
 			client: ITrackedClient | undefined,
-			/** Sequence number where election took place. */
+			/**
+			 * Sequence number where election took place.
+			 */
 			sequenceNumber: number,
-			/** Previously elected client. */
+			/**
+			 * Previously elected client.
+			 */
 			prevClient: ITrackedClient | undefined,
 		) => void,
 	);
@@ -233,9 +273,12 @@ export interface IOrderedClientElectionEvents extends IEvent {
  * Serialized state of IOrderedClientElection.
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
 export interface ISerializedElection {
-	/** Sequence number at the time of the latest election. */
+	/**
+	 * Sequence number at the time of the latest election.
+	 */
 	readonly electionSequenceNumber: number;
 
 	/**
@@ -248,13 +291,19 @@ export interface ISerializedElection {
 	 */
 	readonly electedClientId: string | undefined;
 
-	/** Most recently elected parent client id. This is always an interactive client. */
+	/**
+	 * Most recently elected parent client id. This is always an interactive client.
+	 */
 	readonly electedParentId: string | undefined;
 }
 
-/** Contract for maintaining a deterministic client election based on eligibility. */
+/**
+ * Contract for maintaining a deterministic client election based on eligibility.
+ */
 export interface IOrderedClientElection extends IEventProvider<IOrderedClientElectionEvents> {
-	/** Count of eligible clients in the collection. */
+	/**
+	 * Count of eligible clients in the collection.
+	 */
 	readonly eligibleCount: number;
 
 	/**
@@ -266,17 +315,29 @@ export interface IOrderedClientElection extends IEventProvider<IOrderedClientEle
 	 * 2. the non-interactive summarizer client itself.
 	 */
 	readonly electedClient: ITrackedClient | undefined;
-	/** Currently elected parent client. This is always an interactive client. */
+	/**
+	 * Currently elected parent client. This is always an interactive client.
+	 */
 	readonly electedParent: ITrackedClient | undefined;
-	/** Sequence number of most recent election. */
+	/**
+	 * Sequence number of most recent election.
+	 */
 	readonly electionSequenceNumber: number;
-	/** Resets the currently elected client back to the oldest eligible client. */
+	/**
+	 * Resets the currently elected client back to the oldest eligible client.
+	 */
 	resetElectedClient(sequenceNumber: number): void;
-	/** Peeks at what the next elected client would be if incrementElectedClient were called. */
+	/**
+	 * Peeks at what the next elected client would be if incrementElectedClient were called.
+	 */
 	peekNextElectedClient(): ITrackedClient | undefined;
-	/** Returns a sorted array of all the eligible clients in the collection. */
+	/**
+	 * Returns a sorted array of all the eligible clients in the collection.
+	 */
 	getAllEligibleClients(): ITrackedClient[];
-	/** Serialize election data */
+	/**
+	 * Serialize election data
+	 */
 	serialize(): ISerializedElection;
 }
 
@@ -295,10 +356,10 @@ export class OrderedClientElection
 	private _electedParent: ILinkedClient | undefined;
 	private _electionSequenceNumber: number;
 
-	public get eligibleCount() {
+	public get eligibleCount(): number {
 		return this._eligibleCount;
 	}
-	public get electionSequenceNumber() {
+	public get electionSequenceNumber(): number {
 		return this._electionSequenceNumber;
 	}
 
@@ -338,17 +399,19 @@ export class OrderedClientElection
 	 *
 	 * vii. SummaryManager running on B spawns a summarizer client, B'. electedParent === B, electedClient === B'
 	 */
-	public get electedClient() {
+	public get electedClient(): ILinkedClient | undefined {
 		return this._electedClient;
 	}
-	public get electedParent() {
+	public get electedParent(): ILinkedClient | undefined {
 		return this._electedParent;
 	}
 
 	constructor(
 		private readonly logger: ITelemetryLoggerExt,
 		private readonly orderedClientCollection: IOrderedClientCollection,
-		/** Serialized state from summary or current sequence number at time of load if new. */
+		/**
+		 * Serialized state from summary or current sequence number at time of load if new.
+		 */
 		initialState: ISerializedElection | number,
 		private readonly isEligibleFn: (c: ITrackedClient) => boolean,
 		private readonly recordPerformanceEvents: boolean = false,
@@ -541,8 +604,15 @@ export class OrderedClientElection
 			this._eligibleCount--;
 			if (this._electedClient === client) {
 				// Removing the _electedClient. There are 2 possible cases:
-				if (this._electedParent !== client) {
-					// 1. The _electedClient is a summarizer that we've been allowing to finish its work.
+				if (this._electedParent === client) {
+					// 1. The _electedClient is an interactive client that has left the quorum.
+					// Automatically shift to next oldest client.
+					const nextClient =
+						this.findFirstEligibleParent(this._electedParent?.youngerClient) ??
+						this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+					this.tryElectingClient(nextClient, sequenceNumber, "RemoveClient");
+				} else {
+					// 2. The _electedClient is a summarizer that we've been allowing to finish its work.
 					// Let the _electedParent become the _electedClient so that it can start its own summarizer.
 					if (this._electedClient.client.details.type !== summarizerClientType) {
 						throw new UsageError("Elected client should be a summarizer client 1");
@@ -552,13 +622,6 @@ export class OrderedClientElection
 						sequenceNumber,
 						"RemoveSummarizerClient",
 					);
-				} else {
-					// 2. The _electedClient is an interactive client that has left the quorum.
-					// Automatically shift to next oldest client.
-					const nextClient =
-						this.findFirstEligibleParent(this._electedParent?.youngerClient) ??
-						this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
-					this.tryElectingClient(nextClient, sequenceNumber, "RemoveClient");
 				}
 			} else if (this._electedParent === client) {
 				// Removing the _electedParent (but not _electedClient).
@@ -576,7 +639,9 @@ export class OrderedClientElection
 	}
 
 	public getAllEligibleClients(): ITrackedClient[] {
-		return this.orderedClientCollection.getAllClients().filter(this.isEligibleFn);
+		return this.orderedClientCollection
+			.getAllClients()
+			.filter((client) => this.isEligibleFn(client));
 	}
 
 	/**
@@ -617,7 +682,7 @@ export class OrderedClientElection
 		sequenceNumber: number,
 		forceSend: boolean = false,
 		reason?: string,
-	) {
+	): void {
 		if (this.recordPerformanceEvents || forceSend) {
 			this.logger.sendPerformanceEvent({
 				eventName,
@@ -625,7 +690,7 @@ export class OrderedClientElection
 				sequenceNumber,
 				electedClientId: this.electedClient?.clientId,
 				electedParentId: this.electedParent?.clientId,
-				isEligible: client !== undefined ? this.isEligibleFn(client) : false,
+				isEligible: client === undefined ? false : this.isEligibleFn(client),
 				isSummarizerClient: client?.client.details.type === summarizerClientType,
 				reason,
 			});

package/src/summary/runWhileConnectedCoordinator.ts

@@ -6,13 +6,16 @@
 import type { SummarizerStopReason } from "@fluidframework/container-runtime-definitions/internal";
 import { assert, Deferred } from "@fluidframework/core-utils/internal";
 
+// eslint-disable-next-line import/no-deprecated
 import { IConnectableRuntime, ISummaryCancellationToken } from "./summarizerTypes.js";
 
 /**
  * Similar to AbortController, but using promise instead of events
  * @legacy
  * @alpha
+ * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
  */
+// eslint-disable-next-line import/no-deprecated
 export interface ICancellableSummarizerController extends ISummaryCancellationToken {
 	stop(reason: SummarizerStopReason): void;
 }
@@ -22,6 +25,7 @@ export interface ICancellableSummarizerController extends ISummaryCancellationTo
  * This object implements ISummaryCancellationToken interface but cancellation is never leveraged.
  * @internal
  */
+// eslint-disable-next-line import/no-deprecated
 export const neverCancelledSummaryToken: ISummaryCancellationToken = {
 	cancelled: false,
 	waitCancelled: new Promise(() => {}),
@@ -36,7 +40,7 @@ export class RunWhileConnectedCoordinator implements ICancellableSummarizerContr
 	private _cancelled = false;
 	private readonly stopDeferred = new Deferred<SummarizerStopReason>();
 
-	public get cancelled() {
+	public get cancelled(): boolean {
 		if (!this._cancelled) {
 			assert(this.active(), 0x25d /* "We should never connect as 'read'" */);
 
@@ -63,13 +67,18 @@ export class RunWhileConnectedCoordinator implements ICancellableSummarizerContr
 		return this.stopDeferred.promise;
 	}
 
-	public static async create(runtime: IConnectableRuntime, active: () => boolean) {
+	public static async create(
+		// eslint-disable-next-line import/no-deprecated
+		runtime: IConnectableRuntime,
+		active: () => boolean,
+	): Promise<RunWhileConnectedCoordinator> {
 		const obj = new RunWhileConnectedCoordinator(runtime, active);
 		await obj.waitStart();
 		return obj;
 	}
 
 	protected constructor(
+		// eslint-disable-next-line import/no-deprecated
 		private readonly runtime: IConnectableRuntime,
 		private readonly active: () => boolean,
 	) {}
@@ -87,7 +96,7 @@ export class RunWhileConnectedCoordinator implements ICancellableSummarizerContr
 	 * of non-summarized ops, where can make determination to continue with summary even if main
 	 * client is disconnected.
 	 */
-	protected async waitStart() {
+	protected async waitStart(): Promise<void> {
 		if (this.runtime.disposed) {
 			this.stop("summarizerClientDisconnected");
 			return;