@fluidframework/container-runtime 0.58.2002 → 0.58.3000-61081

package/lib/opTelemetry.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDeltaManager } from "@fluidframework/container-definitions";
+import { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+export declare class OpTracker {
+    /**
+     * Used for storing the message content size when
+     * the message is pushed onto the inbound queue.
+     */
+    private readonly messageSize;
+    private _nonSystemOpCount;
+    get nonSystemOpCount(): number;
+    private _opsSizeAccumulator;
+    get opsSizeAccumulator(): number;
+    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, disabled: boolean);
+    private static messageId;
+    private static messageHasData;
+    reset(): void;
+}
+//# sourceMappingURL=opTelemetry.d.ts.map

package/lib/opTelemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opTelemetry.d.ts","sourceRoot":"","sources":["../src/opTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAG9C,qBAAa,SAAS;IAClB;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IACzD,OAAO,CAAC,iBAAiB,CAAa;IACtC,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,OAAO,CAAC,mBAAmB,CAAa;IACxC,IAAW,kBAAkB,IAAI,MAAM,CAEtC;gBAGG,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,QAAQ,EAAE,OAAO;IA2BrB,OAAO,CAAC,MAAM,CAAC,SAAS;IAIxB,OAAO,CAAC,MAAM,CAAC,cAAc;IAItB,KAAK;CAIf"}

package/lib/opTelemetry.js

@@ -0,0 +1,55 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { isSystemMessage } from "@fluidframework/protocol-base";
+export class OpTracker {
+    constructor(deltaManager, disabled) {
+        /**
+         * Used for storing the message content size when
+         * the message is pushed onto the inbound queue.
+         */
+        this.messageSize = new Map();
+        this._nonSystemOpCount = 0;
+        this._opsSizeAccumulator = 0;
+        if (disabled) {
+            return;
+        }
+        // Record the message content size when we receive it.
+        // We should not log this value, as summarization can happen between the time the message
+        // is received and until it is processed (the 'op' event).
+        deltaManager.inbound.on("push", (message) => {
+            // Some messages my already have string contents at this point,
+            // so stringifying them again will add inaccurate overhead.
+            const messageContent = typeof message.contents === "string" ?
+                message.contents :
+                JSON.stringify(message.contents);
+            const messageData = OpTracker.messageHasData(message) ? message.data : "";
+            this.messageSize[OpTracker.messageId(message)] = messageContent.length + messageData.length;
+        });
+        deltaManager.on("op", (message) => {
+            var _a;
+            this._nonSystemOpCount += isSystemMessage(message) ? 0 : 1;
+            const id = OpTracker.messageId(message);
+            this._opsSizeAccumulator += (_a = this.messageSize[id]) !== null && _a !== void 0 ? _a : 0;
+            this.messageSize.delete(id);
+        });
+    }
+    get nonSystemOpCount() {
+        return this._nonSystemOpCount;
+    }
+    get opsSizeAccumulator() {
+        return this._opsSizeAccumulator;
+    }
+    static messageId(message) {
+        return message.sequenceNumber;
+    }
+    static messageHasData(message) {
+        return message.data !== undefined;
+    }
+    reset() {
+        this._nonSystemOpCount = 0;
+        this._opsSizeAccumulator = 0;
+    }
+}
+//# sourceMappingURL=opTelemetry.js.map

package/lib/opTelemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opTelemetry.js","sourceRoot":"","sources":["../src/opTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,OAAO,SAAS;IAgBlB,YACI,YAAwE,EACxE,QAAiB;QAjBrB;;;WAGG;QACc,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACjD,sBAAiB,GAAW,CAAC,CAAC;QAK9B,wBAAmB,GAAW,CAAC,CAAC;QASpC,IAAI,QAAQ,EAAE;YACV,OAAO;SACV;QAED,sDAAsD;QACtD,yFAAyF;QACzF,0DAA0D;QAC1D,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAkC,EAAE,EAAE;YACnE,+DAA+D;YAC/D,2DAA2D;YAC3D,MAAM,cAAc,GAAG,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;gBACzD,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAClB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrC,MAAM,WAAW,GAAG,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,EAAE;;YACzD,IAAI,CAAC,iBAAiB,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3D,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,mBAAmB,UAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,mCAAI,CAAC,CAAC;YACtD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC;IApCD,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAGD,IAAW,kBAAkB;QACzB,OAAO,IAAI,CAAC,mBAAmB,CAAC;IACpC,CAAC;IA+BO,MAAM,CAAC,SAAS,CAAC,OAAkC;QACvD,OAAO,OAAO,CAAC,cAAc,CAAC;IAClC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,OAAkC;QAC5D,OAAQ,OAA2C,CAAC,IAAI,KAAK,SAAS,CAAC;IAC3E,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;IACjC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISequencedDocumentSystemMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { isSystemMessage } from \"@fluidframework/protocol-base\";\n\nexport class OpTracker {\n    /**\n     * Used for storing the message content size when\n     * the message is pushed onto the inbound queue.\n     */\n    private readonly messageSize = new Map<number, number>();\n    private _nonSystemOpCount: number = 0;\n    public get nonSystemOpCount(): number {\n        return this._nonSystemOpCount;\n    }\n\n    private _opsSizeAccumulator: number = 0;\n    public get opsSizeAccumulator(): number {\n        return this._opsSizeAccumulator;\n    }\n\n    public constructor(\n        deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        disabled: boolean,\n    ) {\n        if (disabled) {\n            return;\n        }\n\n        // Record the message content size when we receive it.\n        // We should not log this value, as summarization can happen between the time the message\n        // is received and until it is processed (the 'op' event).\n        deltaManager.inbound.on(\"push\", (message: ISequencedDocumentMessage) => {\n            // Some messages my already have string contents at this point,\n            // so stringifying them again will add inaccurate overhead.\n            const messageContent = typeof message.contents === \"string\" ?\n                message.contents :\n                JSON.stringify(message.contents);\n            const messageData = OpTracker.messageHasData(message) ? message.data : \"\";\n            this.messageSize[OpTracker.messageId(message)] = messageContent.length + messageData.length;\n        });\n\n        deltaManager.on(\"op\", (message: ISequencedDocumentMessage) => {\n            this._nonSystemOpCount += isSystemMessage(message) ? 0 : 1;\n            const id = OpTracker.messageId(message);\n            this._opsSizeAccumulator += this.messageSize[id] ?? 0;\n            this.messageSize.delete(id);\n        });\n    }\n\n    private static messageId(message: ISequencedDocumentMessage): number {\n        return message.sequenceNumber;\n    }\n\n    private static messageHasData(message: ISequencedDocumentMessage): message is ISequencedDocumentSystemMessage {\n        return (message as ISequencedDocumentSystemMessage).data !== undefined;\n    }\n\n    public reset() {\n        this._nonSystemOpCount = 0;\n        this._opsSizeAccumulator = 0;\n    }\n}\n"]}

package/lib/orderedClientElection.d.ts

@@ -84,15 +84,25 @@ export interface IOrderedClientElectionEvents extends IEvent {
 export interface ISerializedElection {
     /** Sequence number at the time of the latest election. */
     readonly electionSequenceNumber: number;
-    /** Most recently elected client id. */
+    /** Most recently elected client id. This is either:
+     * 1. the interactive elected parent client, in which case electedClientId === electedParentId,
+     *  and the SummaryManager on the elected client will spawn a summarizer client, or
+     * 2. the non-interactive summarizer client itself. */
     readonly electedClientId: string | undefined;
+    /** 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. */
 export interface IOrderedClientElection extends IEventProvider<IOrderedClientElectionEvents> {
     /** Count of eligible clients in the collection. */
     readonly eligibleCount: number;
-    /** Currently elected client. */
+    /** Currently elected client. This is either:
+     * 1. the interactive elected parent client, in which case electedClientId === electedParentId,
+     *  and the SummaryManager on the elected client will spawn a summarizer client, or
+     * 2. the non-interactive summarizer client itself. */
     readonly electedClient: ITrackedClient | undefined;
+    /** Currently elected parent client. This is always an interactive client. */
+    readonly electedParent: ITrackedClient | undefined;
     /** Sequence number of most recent election. */
     readonly electionSequenceNumber: number;
     /** Marks the currently elected client as invalid, and elects the next eligible client. */
@@ -117,22 +127,57 @@ export declare class OrderedClientElection extends TypedEventEmitter<IOrderedCli
     private readonly isEligibleFn;
     private _eligibleCount;
     private _electedClient;
+    private _electedParent;
     private _electionSequenceNumber;
     get eligibleCount(): number;
-    get electedClient(): ILinkedClient | undefined;
     get electionSequenceNumber(): number;
+    /**
+     * OrderedClientCollection tracks electedClient and electedParent separately. This allows us to handle the case
+     * where a new interactive parent client has been elected, but the summarizer is still doing work, so
+     * a new summarizer should not yet be spawned. In this case, changing electedParent will cause SummaryManager
+     * to stop the current summarizer, but a new summarizer will not be spawned until the old summarizer client has
+     * left the quorum.
+     *
+     * Details:
+     *
+     * electedParent is the interactive client that has been elected to spawn a summarizer. It is typically the oldest
+     * eligible interactive client in the quorum. Only the electedParent is permitted to spawn a summarizer.
+     * Once elected, this client will remain the electedParent until it leaves the quorum or the summarizer that
+     * it spawned stops producing summaries, at which point a new electedParent will be chosen.
+     *
+     * electedClient is the non-interactive summarizer client if one exists. If not, then electedClient is equal to
+     * electedParent. If electedParent === electedClient, this is the signal for electedParent to spawn a new
+     * electedClient. Once a summarizer client becomes electedClient, a new summarizer will not be spawned until
+     * electedClient leaves the quorum.
+     *
+     * A typical sequence looks like this:
+     * i. Begin by electing A. electedParent === A, electedClient === A.
+     * ii. SummaryManager running on A spawns a summarizer client, A'. electedParent === A, electedClient === A'
+     * iii. A' stops producing summaries. A new parent client, B, is elected. electedParent === B, electedClient === A'
+     * iv. SummaryManager running on A detects the change to electedParent and tells the summarizer to stop, but A'
+     *      is in mid-summarization. No new summarizer is spawned, as electedParent !== electedClient.
+     * v. A' completes its summary, and the summarizer and backing client are torn down.
+     * vi. A' leaves the quorum, and B takes its place as electedClient. electedParent === B, electedClient === B
+     * vii. SummaryManager running on B spawns a summarizer client, B'. electedParent === B, electedClient === B'
+     */
+    get electedClient(): ILinkedClient | undefined;
+    get electedParent(): ILinkedClient | undefined;
     constructor(logger: ITelemetryLogger, orderedClientCollection: IOrderedClientCollection, 
     /** Serialized state from summary or current sequence number at time of load if new. */
     initialState: ISerializedElection | number, isEligibleFn: (c: ITrackedClient) => boolean);
-    /** Tries changing the elected client, raising an event if it is different. */
+    /** Tries changing the elected client, raising an event if it is different.
+     * Note that this function does no eligibility or suitability checks. If we get here, then
+     * we will set _electedClient, and we will set _electedParent if this is an interactive client.
+     */
     private tryElectingClient;
+    private tryElectingParent;
     /**
-     * Helper function to find the first eligible client starting with the passed in client,
+     * Helper function to find the first eligible parent client starting with the passed in client,
      * or undefined if none are eligible.
      * @param client - client to start checking
      * @returns oldest eligible client starting with passed in client or undefined if none.
      */
-    private findFirstEligibleClient;
+    private findFirstEligibleParent;
     /**
      * Updates tracking for when a new client is added to the collection.
      * Will automatically elect that new client if none is elected currently.
@@ -148,7 +193,13 @@ export declare class OrderedClientElection extends TypedEventEmitter<IOrderedCli
      */
     private removeClient;
     getAllEligibleClients(): ITrackedClient[];
+    /** Advance election to the next-oldest client. This is called if the current parent is leaving the quorum,
+     * or if the current summarizer is not responsive and we want to stop it and spawn a new one.
+     */
     incrementElectedClient(sequenceNumber: number): void;
+    /** (Re-)start election with the oldest client in the quorum. This is called if we need to summarize
+     * and no client has been elected.
+     */
     resetElectedClient(sequenceNumber: number): void;
     peekNextElectedClient(): ITrackedClient | undefined;
     serialize(): ISerializedElection;

package/lib/orderedClientElection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderedClientElection.d.ts","sourceRoot":"","sources":["../src/orderedClientElection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC9F,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAoB,MAAM,sCAAsC,CAAC;AAKjG,oBAAY,mBAAmB,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC1F,oBAAY,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAClD,CAAC,GACD,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACrB,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,GACvB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC/B,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,GACvC,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACtB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GACzB;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnD,2EAA2E;AAC3E,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;CACvC;AAED,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;CAC5C;AAED,4FAA4F;AAC5F,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC5C,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;CACnC;AAED,iGAAiG;AACjG,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,cAAc;IAC5D,WAAW,EAAE,QAAQ,CAAC;CACzB;AAED,wFAAwF;AACxF,oBAAY,QAAQ,GAAG,aAAa,GAAG,aAAa,CAAC;AAErD,mDAAmD;AACnD,MAAM,WAAW,8BAA+B,SAAQ,MAAM;IAC1D,8CAA8C;IAC9C,CAAC,KAAK,EAAE,WAAW,GAAG,cAAc,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5G;AAED,qEAAqE;AACrE,MAAM,WAAW,wBAAyB,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IAC5F,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,mEAAmE;IACnE,aAAa,IAAI,aAAa,EAAE,CAAC;CACpC;AAED;;;;;;GAMG;AACH,qBAAa,uBACT,SAAQ,iBAAiB,CAAC,8BAA8B,CACxD,YAAW,wBAAwB;IACnC,kFAAkF;IAClF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoC;IAC9D,0EAA0E;IAC1E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAIvB;IACF,gEAAgE;IAChE,OAAO,CAAC,eAAe,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,IAAW,KAAK,WAEf;IACD,IAAW,YAAY,8BAEtB;gBAGG,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EACzE,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;IAwBrD,OAAO,CAAC,SAAS;IAmCjB,OAAO,CAAC,YAAY;IAqBpB,oFAAoF;IAC7E,aAAa,IAAI,aAAa,EAAE;CAS1C;AAED,iDAAiD;AACjD,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,6DAA6D;IAC7D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE;IAC1B,4BAA4B;IAC5B,MAAM,EAAE,cAAc,GAAG,SAAS;IAClC,iDAAiD;IACjD,cAAc,EAAE,MAAM;IACtB,iCAAiC;IACjC,UAAU,EAAE,cAAc,GAAG,SAAS,KACrC,IAAI,OAAE;CACd;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,uCAAuC;IACvC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED,qFAAqF;AACrF,MAAM,WAAW,sBAAuB,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACxF,mDAAmD;IACnD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,gCAAgC;IAChC,QAAQ,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IACnD,+CAA+C;IAC/C,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,0FAA0F;IAC1F,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,8EAA8E;IAC9E,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACjD,4FAA4F;IAC5F,qBAAqB,IAAI,cAAc,GAAG,SAAS,CAAC;IACpD,4EAA4E;IAC5E,qBAAqB,IAAI,cAAc,EAAE,CAAC;IAC1C,8BAA8B;IAC9B,SAAS,IAAI,mBAAmB,CAAC;CACpC;AAED;;;;;GAKG;AACH,qBAAa,qBACT,SAAQ,iBAAiB,CAAC,4BAA4B,CACtD,YAAW,sBAAsB;IAiB7B,OAAO,CAAC,QAAQ,CAAC,uBAAuB;IAGxC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAnBjC,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,uBAAuB,CAAS;IAExC,IAAW,aAAa,WAEvB;IACD,IAAW,aAAa,8BAEvB;IACD,IAAW,sBAAsB,WAEhC;gBAGG,MAAM,EAAE,gBAAgB,EACP,uBAAuB,EAAE,wBAAwB;IAClE,uFAAuF;IACvF,YAAY,EAAE,mBAAmB,GAAG,MAAM,EACzB,YAAY,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,OAAO;IA2CjE,8EAA8E;IAC9E,OAAO,CAAC,iBAAiB;IAUzB;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAQ/B;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAUjB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAWb,qBAAqB,IAAI,cAAc,EAAE;IAIzC,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAKpD,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAKhD,qBAAqB,IAAI,cAAc,GAAG,SAAS;IAInD,SAAS,IAAI,mBAAmB;CAM1C"}
+{"version":3,"file":"orderedClientElection.d.ts","sourceRoot":"","sources":["../src/orderedClientElection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC9F,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAoB,MAAM,sCAAsC,CAAC;AAMjG,oBAAY,mBAAmB,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC1F,oBAAY,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAClD,CAAC,GACD,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACrB,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,GACvB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC/B,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,GACvC,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GACtB,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GACzB;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnD,2EAA2E;AAC3E,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;CACvC;AAED,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;CAC5C;AAED,4FAA4F;AAC5F,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC5C,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;CACnC;AAED,iGAAiG;AACjG,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,cAAc;IAC5D,WAAW,EAAE,QAAQ,CAAC;CACzB;AAED,wFAAwF;AACxF,oBAAY,QAAQ,GAAG,aAAa,GAAG,aAAa,CAAC;AAErD,mDAAmD;AACnD,MAAM,WAAW,8BAA+B,SAAQ,MAAM;IAC1D,8CAA8C;IAC9C,CAAC,KAAK,EAAE,WAAW,GAAG,cAAc,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;CAC5G;AAED,qEAAqE;AACrE,MAAM,WAAW,wBAAyB,SAAQ,cAAc,CAAC,8BAA8B,CAAC;IAC5F,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,sDAAsD;IACtD,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,mEAAmE;IACnE,aAAa,IAAI,aAAa,EAAE,CAAC;CACpC;AAED;;;;;;GAMG;AACH,qBAAa,uBACT,SAAQ,iBAAiB,CAAC,8BAA8B,CACxD,YAAW,wBAAwB;IACnC,kFAAkF;IAClF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoC;IAC9D,0EAA0E;IAC1E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAIvB;IACF,gEAAgE;IAChE,OAAO,CAAC,eAAe,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,IAAW,KAAK,WAEf;IACD,IAAW,YAAY,8BAEtB;gBAGG,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB,CAAC,EACzE,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;IAwBrD,OAAO,CAAC,SAAS;IAmCjB,OAAO,CAAC,YAAY;IAqBpB,oFAAoF;IAC7E,aAAa,IAAI,aAAa,EAAE;CAS1C;AAED,iDAAiD;AACjD,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,6DAA6D;IAC7D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE;IAC1B,4BAA4B;IAC5B,MAAM,EAAE,cAAc,GAAG,SAAS;IAClC,iDAAiD;IACjD,cAAc,EAAE,MAAM;IACtB,iCAAiC;IACjC,UAAU,EAAE,cAAc,GAAG,SAAS,KACrC,IAAI,OAAE;CACd;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC;;;0DAGsD;IACtD,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,oFAAoF;IACpF,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED,qFAAqF;AACrF,MAAM,WAAW,sBAAuB,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACxF,mDAAmD;IACnD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B;;;0DAGsD;IACtD,QAAQ,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IACnD,6EAA6E;IAC7E,QAAQ,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IACnD,+CAA+C;IAC/C,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,0FAA0F;IAC1F,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACrD,8EAA8E;IAC9E,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACjD,4FAA4F;IAC5F,qBAAqB,IAAI,cAAc,GAAG,SAAS,CAAC;IACpD,4EAA4E;IAC5E,qBAAqB,IAAI,cAAc,EAAE,CAAC;IAC1C,8BAA8B;IAC9B,SAAS,IAAI,mBAAmB,CAAC;CACpC;AAED;;;;;GAKG;AACH,qBAAa,qBACT,SAAQ,iBAAiB,CAAC,4BAA4B,CACtD,YAAW,sBAAsB;IAmD7B,OAAO,CAAC,QAAQ,CAAC,uBAAuB;IAGxC,OAAO,CAAC,QAAQ,CAAC,YAAY;IArDjC,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,cAAc,CAA4B;IAClD,OAAO,CAAC,uBAAuB,CAAS;IAExC,IAAW,aAAa,WAEvB;IACD,IAAW,sBAAsB,WAEhC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAW,aAAa,8BAEvB;IACD,IAAW,aAAa,8BAEvB;gBAGG,MAAM,EAAE,gBAAgB,EACP,uBAAuB,EAAE,wBAAwB;IAClE,uFAAuF;IACvF,YAAY,EAAE,mBAAmB,GAAG,MAAM,EACzB,YAAY,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,OAAO;IAqDjE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAoBzB,OAAO,CAAC,iBAAiB;IAOzB;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAS/B;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAgBjB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAmCb,qBAAqB,IAAI,cAAc,EAAE;IAIhD;;OAEG;IACI,sBAAsB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAa3D;;OAEG;IACI,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAYhD,qBAAqB,IAAI,cAAc,GAAG,SAAS;IAInD,SAAS,IAAI,mBAAmB;CAO1C"}

package/lib/orderedClientElection.js

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
+import { UsageError } from "@fluidframework/container-utils";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
+import { summarizerClientType } from "./summarizerClientElection";
 /**
  * Tracks clients in the Quorum. It maintains their order using their join op
  * sequence numbers.
@@ -125,11 +127,20 @@ export class OrderedClientElection extends TypedEventEmitter {
         this.isEligibleFn = isEligibleFn;
         this._eligibleCount = 0;
         let initialClient;
+        let initialParent;
         for (const client of orderedClientCollection.getAllClients()) {
             this.addClient(client, 0);
             if (typeof initialState !== "number") {
                 if (client.clientId === initialState.electedClientId) {
                     initialClient = client;
+                    if (initialState.electedParentId === undefined &&
+                        client.client.details.type !== summarizerClientType) {
+                        // If there was no elected parent in the serialized data, use this one.
+                        initialParent = client;
+                    }
+                }
+                if (client.clientId === initialState.electedParentId) {
+                    initialParent = client;
                 }
             }
         }
@@ -152,7 +163,7 @@ export class OrderedClientElection extends TypedEventEmitter {
             }
             else if (initialClient !== undefined && !isEligibleFn(initialClient)) {
                 // Initially elected client is ineligible, so elect next eligible client.
-                initialClient = this.findFirstEligibleClient(initialClient);
+                initialClient = initialParent = this.findFirstEligibleParent(initialParent);
                 logger.sendErrorEvent({
                     eventName: "InitialElectedClientIneligible",
                     electionSequenceNumber: initialState.electionSequenceNumber,
@@ -160,6 +171,7 @@ export class OrderedClientElection extends TypedEventEmitter {
                     electedClientId: initialClient === null || initialClient === void 0 ? void 0 : initialClient.clientId,
                 });
             }
+            this._electedParent = initialParent;
             this._electedClient = initialClient;
             this._electionSequenceNumber = initialState.electionSequenceNumber;
         }
@@ -167,31 +179,83 @@ export class OrderedClientElection extends TypedEventEmitter {
     get eligibleCount() {
         return this._eligibleCount;
     }
+    get electionSequenceNumber() {
+        return this._electionSequenceNumber;
+    }
+    /**
+     * OrderedClientCollection tracks electedClient and electedParent separately. This allows us to handle the case
+     * where a new interactive parent client has been elected, but the summarizer is still doing work, so
+     * a new summarizer should not yet be spawned. In this case, changing electedParent will cause SummaryManager
+     * to stop the current summarizer, but a new summarizer will not be spawned until the old summarizer client has
+     * left the quorum.
+     *
+     * Details:
+     *
+     * electedParent is the interactive client that has been elected to spawn a summarizer. It is typically the oldest
+     * eligible interactive client in the quorum. Only the electedParent is permitted to spawn a summarizer.
+     * Once elected, this client will remain the electedParent until it leaves the quorum or the summarizer that
+     * it spawned stops producing summaries, at which point a new electedParent will be chosen.
+     *
+     * electedClient is the non-interactive summarizer client if one exists. If not, then electedClient is equal to
+     * electedParent. If electedParent === electedClient, this is the signal for electedParent to spawn a new
+     * electedClient. Once a summarizer client becomes electedClient, a new summarizer will not be spawned until
+     * electedClient leaves the quorum.
+     *
+     * A typical sequence looks like this:
+     * i. Begin by electing A. electedParent === A, electedClient === A.
+     * ii. SummaryManager running on A spawns a summarizer client, A'. electedParent === A, electedClient === A'
+     * iii. A' stops producing summaries. A new parent client, B, is elected. electedParent === B, electedClient === A'
+     * iv. SummaryManager running on A detects the change to electedParent and tells the summarizer to stop, but A'
+     *      is in mid-summarization. No new summarizer is spawned, as electedParent !== electedClient.
+     * v. A' completes its summary, and the summarizer and backing client are torn down.
+     * vi. A' leaves the quorum, and B takes its place as electedClient. electedParent === B, electedClient === B
+     * vii. SummaryManager running on B spawns a summarizer client, B'. electedParent === B, electedClient === B'
+     */
     get electedClient() {
         return this._electedClient;
     }
-    get electionSequenceNumber() {
-        return this._electionSequenceNumber;
+    get electedParent() {
+        return this._electedParent;
     }
-    /** Tries changing the elected client, raising an event if it is different. */
+    /** Tries changing the elected client, raising an event if it is different.
+     * Note that this function does no eligibility or suitability checks. If we get here, then
+     * we will set _electedClient, and we will set _electedParent if this is an interactive client.
+     */
     tryElectingClient(client, sequenceNumber) {
-        this._electionSequenceNumber = sequenceNumber;
-        if (this._electedClient === client) {
-            return;
-        }
+        let change = false;
+        const isSummarizerClient = (client === null || client === void 0 ? void 0 : client.client.details.type) === summarizerClientType;
         const prevClient = this._electedClient;
-        this._electedClient = client;
-        this.emit("election", client, sequenceNumber, prevClient);
+        if (this._electedClient !== client) {
+            // Changing the elected client. Record the sequence number and note that we have to fire an event.
+            this._electionSequenceNumber = sequenceNumber;
+            this._electedClient = client;
+            change = true;
+        }
+        if (this._electedParent !== client && !isSummarizerClient) {
+            // Changing the elected parent as well.
+            this._electedParent = client;
+            change = true;
+        }
+        if (change) {
+            this.emit("election", client, sequenceNumber, prevClient);
+        }
+    }
+    tryElectingParent(client, sequenceNumber) {
+        if (this._electedParent !== client) {
+            this._electedParent = client;
+            this.emit("election", this._electedClient, sequenceNumber, this._electedClient);
+        }
     }
     /**
-     * Helper function to find the first eligible client starting with the passed in client,
+     * Helper function to find the first eligible parent client starting with the passed in client,
      * or undefined if none are eligible.
      * @param client - client to start checking
      * @returns oldest eligible client starting with passed in client or undefined if none.
      */
-    findFirstEligibleClient(client) {
+    findFirstEligibleParent(client) {
         let candidateClient = client;
-        while (candidateClient !== undefined && !this.isEligibleFn(candidateClient)) {
+        while (candidateClient !== undefined &&
+            (!this.isEligibleFn(candidateClient) || candidateClient.client.details.type === summarizerClientType)) {
             candidateClient = candidateClient.youngerClient;
         }
         return candidateClient;
@@ -203,12 +267,19 @@ export class OrderedClientElection extends TypedEventEmitter {
      * @param sequenceNumber - sequence number when client was added
      */
     addClient(client, sequenceNumber) {
+        var _a;
         if (this.isEligibleFn(client)) {
             this._eligibleCount++;
-            if (this._electedClient === undefined) {
-                // Automatically elect latest client
+            const newClientIsSummarizer = client.client.details.type === summarizerClientType;
+            const electedClientIsSummarizer = ((_a = this._electedClient) === null || _a === void 0 ? void 0 : _a.client.details.type) === summarizerClientType;
+            // Note that we allow a summarizer client to supercede an interactive client as elected client.
+            if (this._electedClient === undefined || (!electedClientIsSummarizer && newClientIsSummarizer)) {
                 this.tryElectingClient(client, sequenceNumber);
             }
+            else if (this._electedParent === undefined && !newClientIsSummarizer) {
+                // This is an odd case. If the _electedClient is set, the _electedParent should be as well.
+                this.tryElectingParent(client, sequenceNumber);
+            }
         }
     }
     /**
@@ -218,36 +289,80 @@ export class OrderedClientElection extends TypedEventEmitter {
      * @param sequenceNumber - sequence number when client was removed
      */
     removeClient(client, sequenceNumber) {
+        var _a, _b, _c, _d, _e;
         if (this.isEligibleFn(client)) {
             this._eligibleCount--;
             if (this._electedClient === client) {
-                // Automatically shift to next oldest client
-                const nextClient = this.findFirstEligibleClient(this._electedClient.youngerClient);
-                this.tryElectingClient(nextClient, sequenceNumber);
+                // 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.
+                    // 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");
+                    }
+                    this.tryElectingClient(this._electedParent, sequenceNumber);
+                }
+                else {
+                    // 2. The _electedClient is an interactive client that has left the quorum.
+                    // Automatically shift to next oldest client.
+                    const nextClient = (_b = this.findFirstEligibleParent((_a = this._electedParent) === null || _a === void 0 ? void 0 : _a.youngerClient)) !== null && _b !== void 0 ? _b : this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+                    this.tryElectingClient(nextClient, sequenceNumber);
+                }
+            }
+            else if (this._electedParent === client) {
+                // Removing the _electedParent (but not _electedClient).
+                // Shift to the next oldest parent, but do not replace the _electedClient,
+                // which is a summarizer that is still doing work.
+                if (((_c = this._electedClient) === null || _c === void 0 ? void 0 : _c.client.details.type) !== summarizerClientType) {
+                    throw new UsageError("Elected client should be a summarizer client 2");
+                }
+                const nextParent = (_e = this.findFirstEligibleParent((_d = this._electedParent) === null || _d === void 0 ? void 0 : _d.youngerClient)) !== null && _e !== void 0 ? _e : this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+                this.tryElectingParent(nextParent, sequenceNumber);
             }
         }
     }
     getAllEligibleClients() {
         return this.orderedClientCollection.getAllClients().filter(this.isEligibleFn);
     }
+    /** Advance election to the next-oldest client. This is called if the current parent is leaving the quorum,
+     * or if the current summarizer is not responsive and we want to stop it and spawn a new one.
+     */
     incrementElectedClient(sequenceNumber) {
-        var _a;
-        const nextClient = this.findFirstEligibleClient((_a = this._electedClient) === null || _a === void 0 ? void 0 : _a.youngerClient);
-        this.tryElectingClient(nextClient, sequenceNumber);
+        var _a, _b;
+        const nextClient = (_b = this.findFirstEligibleParent((_a = this._electedParent) === null || _a === void 0 ? void 0 : _a.youngerClient)) !== null && _b !== void 0 ? _b : this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+        if (this._electedClient === undefined || this._electedClient === this._electedParent) {
+            this.tryElectingClient(nextClient, sequenceNumber);
+        }
+        else {
+            // The _electedClient is a summarizer and should not be replaced until it leaves the quorum.
+            // Changing the _electedParent will stop the summarizer.
+            this.tryElectingParent(nextClient, sequenceNumber);
+        }
     }
+    /** (Re-)start election with the oldest client in the quorum. This is called if we need to summarize
+     * and no client has been elected.
+     */
     resetElectedClient(sequenceNumber) {
-        const firstClient = this.findFirstEligibleClient(this.orderedClientCollection.oldestClient);
-        this.tryElectingClient(firstClient, sequenceNumber);
+        const firstClient = this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);
+        if (this._electedClient === undefined || this._electedClient === this._electedParent) {
+            this.tryElectingClient(firstClient, sequenceNumber);
+        }
+        else {
+            // The _electedClient is a summarizer and should not be replaced until it leaves the quorum.
+            // Changing the _electedParent will stop the summarizer.
+            this.tryElectingParent(firstClient, sequenceNumber);
+        }
     }
     peekNextElectedClient() {
         var _a;
-        return this.findFirstEligibleClient((_a = this._electedClient) === null || _a === void 0 ? void 0 : _a.youngerClient);
+        return this.findFirstEligibleParent((_a = this._electedParent) === null || _a === void 0 ? void 0 : _a.youngerClient);
     }
     serialize() {
-        var _a;
+        var _a, _b;
         return {
             electionSequenceNumber: this.electionSequenceNumber,
             electedClientId: (_a = this.electedClient) === null || _a === void 0 ? void 0 : _a.clientId,
+            electedParentId: (_b = this.electedParent) === null || _b === void 0 ? void 0 : _b.clientId,
         };
     }
 }

package/lib/orderedClientElection.js.map

@@ -1 +1 @@
-{"version":3,"file":"orderedClientElection.js","sourceRoot":"","sources":["../src/orderedClientElection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGzE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AA0D9D;;;;;;GAMG;AACH,MAAM,OAAO,uBACT,SAAQ,iBAAiD;IAqBzD,YACI,MAAwB,EACxB,YAAyE,EACzE,MAAiD;QAEjD,KAAK,EAAE,CAAC;QAxBZ,kFAAkF;QACjE,cAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC9D,0EAA0E;QACzD,aAAQ,GAAkB;YACvC,cAAc,EAAE,CAAC,CAAC;YAClB,WAAW,EAAE,SAAS;YACtB,aAAa,EAAE,SAAS;SAC3B,CAAC;QACF,gEAAgE;QACxD,oBAAe,GAAa,IAAI,CAAC,QAAQ,CAAC;QAgB9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE;YACtC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACpC;QAED,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnC,MAAM,cAAc,GAAG,YAAY,CAAC,kBAAkB,CAAC;YACvD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACjD,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;aACzF;iBAAM;gBACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;aAC3D;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAhCD,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC/B,CAAC;IACD,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;IACvC,CAAC;IA6BO,SAAS,CAAC,QAAgB,EAAE,MAAwB;QACxD,mEAAmE;QACnE,yEAAyE;QACzE,MAAM,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAC9F,IAAI,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC;QACtC,OAAO,UAAU,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,EAAE;YACtD,MAAM,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACrG,gGAAgG;YAChG,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC;SACvC;QAED,+EAA+E;QAC/E,MAAM,SAAS,GAAkB;YAC7B,QAAQ;YACR,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,MAAM,oBAAO,MAAM,CAAC,MAAM,CAAE;YAC5B,WAAW,EAAE,UAAU;YACvB,aAAa,EAAE,UAAU,CAAC,aAAa;SAC1C,CAAC;QAEF,8CAA8C;QAC9C,SAAS,CAAC,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC;QAEhD,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;YACvC,qDAAqD;YACrD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SACpC;aAAM;YACH,mDAAmD;YACnD,SAAS,CAAC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC;SACnD;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACxC,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,YAAY,CAAC,QAAgB;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,OAAO;SACV;QAED,0CAA0C;QAC1C,YAAY,CAAC,WAAW,CAAC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC;QAEpE,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,EAAE;YAC1C,qDAAqD;YACrD,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,WAAW,CAAC;SACnD;aAAM;YACH,mDAAmD;YACnD,YAAY,CAAC,aAAa,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;SACrE;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,oFAAoF;IAC7E,aAAa;QAChB,MAAM,MAAM,GAAoB,EAAE,CAAC;QACnC,IAAI,UAAU,GAAa,IAAI,CAAC,QAAQ,CAAC;QACzC,OAAO,UAAU,CAAC,aAAa,KAAK,SAAS,EAAE;YAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACtC,UAAU,GAAG,UAAU,CAAC,aAAa,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AA2CD;;;;;GAKG;AACH,MAAM,OAAO,qBACT,SAAQ,iBAA+C;IAgBvD,YACI,MAAwB,EACP,uBAAiD;IAClE,uFAAuF;IACvF,YAA0C,EACzB,YAA4C;QAE7D,KAAK,EAAE,CAAC;QALS,4BAAuB,GAAvB,uBAAuB,CAA0B;QAGjD,iBAAY,GAAZ,YAAY,CAAgC;QAnBzD,mBAAc,GAAW,CAAC,CAAC;QAsB/B,IAAI,aAAwC,CAAC;QAC7C,KAAK,MAAM,MAAM,IAAI,uBAAuB,CAAC,aAAa,EAAE,EAAE;YAC1D,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC1B,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;gBAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,CAAC,eAAe,EAAE;oBAClD,aAAa,GAAG,MAAM,CAAC;iBAC1B;aACJ;SACJ;QACD,uBAAuB,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACtF,uBAAuB,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAE5F,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YAClC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CAAC;SAC/C;aAAM;YACH,gEAAgE;YAChE,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ,MAAK,YAAY,CAAC,eAAe,EAAE;gBAC1D,4DAA4D;gBAC5D,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,8BAA8B;oBACzC,sBAAsB,EAAE,YAAY,CAAC,sBAAsB;oBAC3D,gBAAgB,EAAE,YAAY,CAAC,eAAe;oBAC9C,eAAe,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ;oBACxC,WAAW,EAAE,uBAAuB,CAAC,KAAK;iBAC7C,CAAC,CAAC;aACN;iBAAM,IAAI,aAAa,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE;gBACpE,yEAAyE;gBACzE,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;gBAC5D,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,gCAAgC;oBAC3C,sBAAsB,EAAE,YAAY,CAAC,sBAAsB;oBAC3D,gBAAgB,EAAE,YAAY,CAAC,eAAe;oBAC9C,eAAe,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ;iBAC3C,CAAC,CAAC;aACN;YACD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CAAC,sBAAsB,CAAC;SACtE;IACL,CAAC;IAxDD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IACD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IACD,IAAW,sBAAsB;QAC7B,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACxC,CAAC;IAkDD,8EAA8E;IACtE,iBAAiB,CAAC,MAAiC,EAAE,cAAsB;QAC/E,IAAI,CAAC,uBAAuB,GAAG,cAAc,CAAC;QAC9C,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;YAChC,OAAO;SACV;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,MAAiC;QAC7D,IAAI,eAAe,GAAG,MAAM,CAAC;QAC7B,OAAO,eAAe,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,EAAE;YACzE,eAAe,GAAG,eAAe,CAAC,aAAa,CAAC;SACnD;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACK,SAAS,CAAC,MAAqB,EAAE,cAAsB;QAC3D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;gBACnC,oCAAoC;gBACpC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;aAClD;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,MAAqB,EAAE,cAAsB;QAC9D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;gBAChC,4CAA4C;gBAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;gBACnF,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;aACtD;SACJ;IACL,CAAC;IAEM,qBAAqB;QACxB,OAAO,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClF,CAAC;IAEM,sBAAsB,CAAC,cAAsB;;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,CAAC;QACpF,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC;IAEM,kBAAkB,CAAC,cAAsB;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;QAC5F,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IACxD,CAAC;IAEM,qBAAqB;;QACxB,OAAO,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IAEM,SAAS;;QACZ,OAAO;YACH,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,eAAe,QAAE,IAAI,CAAC,aAAa,0CAAE,QAAQ;SAChD,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport { IClient, IQuorumClients, ISequencedClient } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\n\n// helper types for recursive readonly.\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport type ImmutablePrimitives = undefined | null | boolean | string | number | Function;\nexport type Immutable<T> = T extends ImmutablePrimitives\n    ? T\n    : T extends (infer A)[]\n    ? readonly Immutable<A>[]\n    : T extends Map<infer K, infer V>\n    ? ReadonlyMap<Immutable<K>, Immutable<V>>\n    : T extends Set<infer V>\n    ? ReadonlySet<Immutable<V>>\n    : { readonly [K in keyof T]: Immutable<T[K]> };\n\n/** Minimum information for a client tracked for election consideration. */\nexport interface ITrackedClient {\n    readonly clientId: string;\n    readonly sequenceNumber: number;\n    readonly client: Immutable<IClient>;\n}\n\n/** Common contract for link nodes within an OrderedClientCollection. */\nexport interface ILinkNode {\n    readonly sequenceNumber: number;\n    youngerClient: ILinkedClient | undefined;\n}\n\n/** Placeholder root node within an OrderedClientCollection; does not represent a client. */\nexport interface IRootLinkNode extends ILinkNode {\n    readonly sequenceNumber: -1;\n    readonly olderClient: undefined;\n}\n\n/** Additional information required to keep track of the client within the doubly-linked list. */\nexport interface ILinkedClient extends ILinkNode, ITrackedClient {\n    olderClient: LinkNode;\n}\n\n/** Any link node within OrderedClientCollection including the placeholder root node. */\nexport type LinkNode = IRootLinkNode | ILinkedClient;\n\n/** Events raised by an OrderedClientCollection. */\nexport interface IOrderedClientCollectionEvents extends IEvent {\n    /** Event fires when client is being added. */\n    (event: \"addClient\" | \"removeClient\", listener: (client: ILinkedClient, sequenceNumber: number) => void);\n}\n\n/** Contract for a sorted collection of all clients in the quorum. */\nexport interface IOrderedClientCollection extends IEventProvider<IOrderedClientCollectionEvents> {\n    /** Count of clients in the collection. */\n    readonly count: number;\n    /** Pointer to the oldest client in the collection. */\n    readonly oldestClient: ILinkedClient | undefined;\n    /** Returns a sorted array of all the clients in the collection. */\n    getAllClients(): ILinkedClient[];\n}\n\n/**\n * Tracks clients in the Quorum. It maintains their order using their join op\n * sequence numbers.\n * Internally, the collection of clients is maintained in a doubly-linked list,\n * with pointers to both the first and last nodes.\n * The first (root) node is a placeholder to simplify logic and reduce null checking.\n */\nexport class OrderedClientCollection\n    extends TypedEventEmitter<IOrderedClientCollectionEvents>\n    implements IOrderedClientCollection {\n    /** Collection of ALL clients currently in the quorum, with client ids as keys. */\n    private readonly clientMap = new Map<string, ILinkedClient>();\n    /** Placeholder head node of linked list, for simplified null checking. */\n    private readonly rootNode: IRootLinkNode = {\n        sequenceNumber: -1,\n        olderClient: undefined,\n        youngerClient: undefined,\n    };\n    /** Pointer to end of linked list, for optimized client adds. */\n    private _youngestClient: LinkNode = this.rootNode;\n    private readonly logger: ITelemetryLogger;\n\n    public get count() {\n        return this.clientMap.size;\n    }\n    public get oldestClient() {\n        return this.rootNode.youngerClient;\n    }\n\n    constructor(\n        logger: ITelemetryLogger,\n        deltaManager: Pick<IDeltaManager<unknown, unknown>, \"lastSequenceNumber\">,\n        quorum: Pick<IQuorumClients, \"getMembers\" | \"on\">,\n    ) {\n        super();\n        this.logger = ChildLogger.create(logger, \"OrderedClientCollection\");\n        const members = quorum.getMembers();\n        for (const [clientId, client] of members) {\n            this.addClient(clientId, client);\n        }\n\n        quorum.on(\"addMember\", (clientId, client) => {\n            const newClient = this.addClient(clientId, client);\n            this.emit(\"addClient\", newClient, deltaManager.lastSequenceNumber);\n        });\n        quorum.on(\"removeMember\", (clientId) => {\n            const sequenceNumber = deltaManager.lastSequenceNumber;\n            const removeClient = this.removeClient(clientId);\n            if (removeClient === undefined) {\n                this.logger.sendErrorEvent({ eventName: \"ClientNotFound\", clientId, sequenceNumber });\n            } else {\n                this.emit(\"removeClient\", removeClient, sequenceNumber);\n            }\n        });\n    }\n\n    private addClient(clientId: string, client: ISequencedClient): ITrackedClient {\n        // Normal case is adding the latest client, which will bypass loop.\n        // Find where it belongs otherwise (maybe possible during initial load?).\n        assert(client.sequenceNumber > -1, 0x1f6 /* \"Negative client sequence number not allowed\" */);\n        let currClient = this._youngestClient;\n        while (currClient.sequenceNumber > client.sequenceNumber) {\n            assert(currClient.olderClient !== undefined, 0x1f7 /* \"Previous client should always be defined\" */);\n            // Note: If adding a client older than the elected client, it will not be automatically elected.\n            currClient = currClient.olderClient;\n        }\n\n        // Now currClient is the node right before where the new client node should be.\n        const newClient: ILinkedClient = {\n            clientId,\n            sequenceNumber: client.sequenceNumber,\n            client: { ...client.client }, // shallow clone\n            olderClient: currClient,\n            youngerClient: currClient.youngerClient,\n        };\n\n        // Update prev node to point to this new node.\n        newClient.olderClient.youngerClient = newClient;\n\n        if (newClient.youngerClient === undefined) {\n            // Update linked list end pointer to youngest client.\n            this._youngestClient = newClient;\n        } else {\n            // Update next node to point back to this new node.\n            newClient.youngerClient.olderClient = newClient;\n        }\n\n        this.clientMap.set(clientId, newClient);\n        return newClient;\n    }\n\n    private removeClient(clientId: string): ITrackedClient | undefined {\n        const removeClient = this.clientMap.get(clientId);\n        if (removeClient === undefined) {\n            return;\n        }\n\n        // Update prev node to point to next node.\n        removeClient.olderClient.youngerClient = removeClient.youngerClient;\n\n        if (removeClient.youngerClient === undefined) {\n            // Update linked list end pointer to youngest client.\n            this._youngestClient = removeClient.olderClient;\n        } else {\n            // Update next node to point back to previous node.\n            removeClient.youngerClient.olderClient = removeClient.olderClient;\n        }\n\n        this.clientMap.delete(clientId);\n        return removeClient;\n    }\n\n    /** Returns an array of all clients being tracked in order from oldest to newest. */\n    public getAllClients(): ILinkedClient[] {\n        const result: ILinkedClient[] = [];\n        let currClient: LinkNode = this.rootNode;\n        while (currClient.youngerClient !== undefined) {\n            result.push(currClient.youngerClient);\n            currClient = currClient.youngerClient;\n        }\n        return result;\n    }\n}\n\n/** Events raised by an OrderedClientElection. */\nexport interface IOrderedClientElectionEvents extends IEvent {\n    /** Event fires when the currently elected client changes. */\n    (event: \"election\", listener: (\n        /** Newly elected client. */\n        client: ITrackedClient | undefined,\n        /** Sequence number where election took place. */\n        sequenceNumber: number,\n        /** Previously elected client. */\n        prevClient: ITrackedClient | undefined,\n    ) => void);\n}\n\n/** Serialized state of IOrderedClientElection. */\nexport interface ISerializedElection {\n    /** Sequence number at the time of the latest election. */\n    readonly electionSequenceNumber: number;\n    /** Most recently elected client id. */\n    readonly electedClientId: string | undefined;\n}\n\n/** Contract for maintaining a deterministic client election based on eligibility. */\nexport interface IOrderedClientElection extends IEventProvider<IOrderedClientElectionEvents> {\n    /** Count of eligible clients in the collection. */\n    readonly eligibleCount: number;\n    /** Currently elected client. */\n    readonly electedClient: ITrackedClient | undefined;\n    /** Sequence number of most recent election. */\n    readonly electionSequenceNumber: number;\n    /** Marks the currently elected client as invalid, and elects the next eligible client. */\n    incrementElectedClient(sequenceNumber: number): void;\n    /** Resets the currently elected client back to the oldest eligible client. */\n    resetElectedClient(sequenceNumber: number): void;\n    /** Peeks at what the next elected client would be if incrementElectedClient were called. */\n    peekNextElectedClient(): ITrackedClient | undefined;\n    /** Returns a sorted array of all the eligible clients in the collection. */\n    getAllEligibleClients(): ITrackedClient[];\n    /** Serialize election data */\n    serialize(): ISerializedElection;\n}\n\n/**\n * Adapter for OrderedClientCollection, with the purpose of deterministically maintaining\n * a currently elected client, excluding ineligible clients, in a distributed fashion.\n * This can be true as long as incrementElectedClient and resetElectedClient calls\n * are called under the same conditions for all clients.\n */\nexport class OrderedClientElection\n    extends TypedEventEmitter<IOrderedClientElectionEvents>\n    implements IOrderedClientElection {\n    private _eligibleCount: number = 0;\n    private _electedClient: ILinkedClient | undefined;\n    private _electionSequenceNumber: number;\n\n    public get eligibleCount() {\n        return this._eligibleCount;\n    }\n    public get electedClient() {\n        return this._electedClient;\n    }\n    public get electionSequenceNumber() {\n        return this._electionSequenceNumber;\n    }\n\n    constructor(\n        logger: ITelemetryLogger,\n        private readonly orderedClientCollection: IOrderedClientCollection,\n        /** Serialized state from summary or current sequence number at time of load if new. */\n        initialState: ISerializedElection | number,\n        private readonly isEligibleFn: (c: ITrackedClient) => boolean,\n    ) {\n        super();\n        let initialClient: ILinkedClient | undefined;\n        for (const client of orderedClientCollection.getAllClients()) {\n            this.addClient(client, 0);\n            if (typeof initialState !== \"number\") {\n                if (client.clientId === initialState.electedClientId) {\n                    initialClient = client;\n                }\n            }\n        }\n        orderedClientCollection.on(\"addClient\", (client, seq) => this.addClient(client, seq));\n        orderedClientCollection.on(\"removeClient\", (client, seq) => this.removeClient(client, seq));\n\n        if (typeof initialState === \"number\") {\n            this._electionSequenceNumber = initialState;\n        } else {\n            // Override the initially elected client with the initial state.\n            if (initialClient?.clientId !== initialState.electedClientId) {\n                // Cannot find initially elected client, so elect undefined.\n                logger.sendErrorEvent({\n                    eventName: \"InitialElectedClientNotFound\",\n                    electionSequenceNumber: initialState.electionSequenceNumber,\n                    expectedClientId: initialState.electedClientId,\n                    electedClientId: initialClient?.clientId,\n                    clientCount: orderedClientCollection.count,\n                });\n            } else if (initialClient !== undefined && !isEligibleFn(initialClient)) {\n                // Initially elected client is ineligible, so elect next eligible client.\n                initialClient = this.findFirstEligibleClient(initialClient);\n                logger.sendErrorEvent({\n                    eventName: \"InitialElectedClientIneligible\",\n                    electionSequenceNumber: initialState.electionSequenceNumber,\n                    expectedClientId: initialState.electedClientId,\n                    electedClientId: initialClient?.clientId,\n                });\n            }\n            this._electedClient = initialClient;\n            this._electionSequenceNumber = initialState.electionSequenceNumber;\n        }\n    }\n\n    /** Tries changing the elected client, raising an event if it is different. */\n    private tryElectingClient(client: ILinkedClient | undefined, sequenceNumber: number): void {\n        this._electionSequenceNumber = sequenceNumber;\n        if (this._electedClient === client) {\n            return;\n        }\n        const prevClient = this._electedClient;\n        this._electedClient = client;\n        this.emit(\"election\", client, sequenceNumber, prevClient);\n    }\n\n    /**\n     * Helper function to find the first eligible client starting with the passed in client,\n     * or undefined if none are eligible.\n     * @param client - client to start checking\n     * @returns oldest eligible client starting with passed in client or undefined if none.\n     */\n    private findFirstEligibleClient(client: ILinkedClient | undefined): ILinkedClient | undefined {\n        let candidateClient = client;\n        while (candidateClient !== undefined && !this.isEligibleFn(candidateClient)) {\n            candidateClient = candidateClient.youngerClient;\n        }\n        return candidateClient;\n    }\n\n    /**\n     * Updates tracking for when a new client is added to the collection.\n     * Will automatically elect that new client if none is elected currently.\n     * @param client - client added to the collection\n     * @param sequenceNumber - sequence number when client was added\n     */\n    private addClient(client: ILinkedClient, sequenceNumber: number): void {\n        if (this.isEligibleFn(client)) {\n            this._eligibleCount++;\n            if (this._electedClient === undefined) {\n                // Automatically elect latest client\n                this.tryElectingClient(client, sequenceNumber);\n            }\n        }\n    }\n\n    /**\n     * Updates tracking for when an existing client is removed from the collection.\n     * Will automatically elect next oldest client if currently elected is removed.\n     * @param client - client removed from the collection\n     * @param sequenceNumber - sequence number when client was removed\n     */\n    private removeClient(client: ILinkedClient, sequenceNumber: number): void {\n        if (this.isEligibleFn(client)) {\n            this._eligibleCount--;\n            if (this._electedClient === client) {\n                // Automatically shift to next oldest client\n                const nextClient = this.findFirstEligibleClient(this._electedClient.youngerClient);\n                this.tryElectingClient(nextClient, sequenceNumber);\n            }\n        }\n    }\n\n    public getAllEligibleClients(): ITrackedClient[] {\n        return this.orderedClientCollection.getAllClients().filter(this.isEligibleFn);\n    }\n\n    public incrementElectedClient(sequenceNumber: number): void {\n        const nextClient = this.findFirstEligibleClient(this._electedClient?.youngerClient);\n        this.tryElectingClient(nextClient, sequenceNumber);\n    }\n\n    public resetElectedClient(sequenceNumber: number): void {\n        const firstClient = this.findFirstEligibleClient(this.orderedClientCollection.oldestClient);\n        this.tryElectingClient(firstClient, sequenceNumber);\n    }\n\n    public peekNextElectedClient(): ITrackedClient | undefined {\n        return this.findFirstEligibleClient(this._electedClient?.youngerClient);\n    }\n\n    public serialize(): ISerializedElection {\n        return {\n            electionSequenceNumber: this.electionSequenceNumber,\n            electedClientId: this.electedClient?.clientId,\n        };\n    }\n}\n"]}
+{"version":3,"file":"orderedClientElection.js","sourceRoot":"","sources":["../src/orderedClientElection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEzE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AA0DlE;;;;;;GAMG;AACH,MAAM,OAAO,uBACT,SAAQ,iBAAiD;IAqBzD,YACI,MAAwB,EACxB,YAAyE,EACzE,MAAiD;QAEjD,KAAK,EAAE,CAAC;QAxBZ,kFAAkF;QACjE,cAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC9D,0EAA0E;QACzD,aAAQ,GAAkB;YACvC,cAAc,EAAE,CAAC,CAAC;YAClB,WAAW,EAAE,SAAS;YACtB,aAAa,EAAE,SAAS;SAC3B,CAAC;QACF,gEAAgE;QACxD,oBAAe,GAAa,IAAI,CAAC,QAAQ,CAAC;QAgB9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE;YACtC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACpC;QAED,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnC,MAAM,cAAc,GAAG,YAAY,CAAC,kBAAkB,CAAC;YACvD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACjD,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC5B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;aACzF;iBAAM;gBACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;aAC3D;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAhCD,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC/B,CAAC;IACD,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;IACvC,CAAC;IA6BO,SAAS,CAAC,QAAgB,EAAE,MAAwB;QACxD,mEAAmE;QACnE,yEAAyE;QACzE,MAAM,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAC9F,IAAI,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC;QACtC,OAAO,UAAU,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,EAAE;YACtD,MAAM,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACrG,gGAAgG;YAChG,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC;SACvC;QAED,+EAA+E;QAC/E,MAAM,SAAS,GAAkB;YAC7B,QAAQ;YACR,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,MAAM,oBAAO,MAAM,CAAC,MAAM,CAAE;YAC5B,WAAW,EAAE,UAAU;YACvB,aAAa,EAAE,UAAU,CAAC,aAAa;SAC1C,CAAC;QAEF,8CAA8C;QAC9C,SAAS,CAAC,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC;QAEhD,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;YACvC,qDAAqD;YACrD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SACpC;aAAM;YACH,mDAAmD;YACnD,SAAS,CAAC,aAAa,CAAC,WAAW,GAAG,SAAS,CAAC;SACnD;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACxC,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,YAAY,CAAC,QAAgB;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,OAAO;SACV;QAED,0CAA0C;QAC1C,YAAY,CAAC,WAAW,CAAC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC;QAEpE,IAAI,YAAY,CAAC,aAAa,KAAK,SAAS,EAAE;YAC1C,qDAAqD;YACrD,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,WAAW,CAAC;SACnD;aAAM;YACH,mDAAmD;YACnD,YAAY,CAAC,aAAa,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;SACrE;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,oFAAoF;IAC7E,aAAa;QAChB,MAAM,MAAM,GAAoB,EAAE,CAAC;QACnC,IAAI,UAAU,GAAa,IAAI,CAAC,QAAQ,CAAC;QACzC,OAAO,UAAU,CAAC,aAAa,KAAK,SAAS,EAAE;YAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACtC,UAAU,GAAG,UAAU,CAAC,aAAa,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAqDD;;;;;GAKG;AACH,MAAM,OAAO,qBACT,SAAQ,iBAA+C;IAkDvD,YACI,MAAwB,EACP,uBAAiD;IAClE,uFAAuF;IACvF,YAA0C,EACzB,YAA4C;QAE7D,KAAK,EAAE,CAAC;QALS,4BAAuB,GAAvB,uBAAuB,CAA0B;QAGjD,iBAAY,GAAZ,YAAY,CAAgC;QArDzD,mBAAc,GAAW,CAAC,CAAC;QAwD/B,IAAI,aAAwC,CAAC;QAC7C,IAAI,aAAwC,CAAC;QAC7C,KAAK,MAAM,MAAM,IAAI,uBAAuB,CAAC,aAAa,EAAE,EAAE;YAC1D,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC1B,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;gBAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,CAAC,eAAe,EAAE;oBAClD,aAAa,GAAG,MAAM,CAAC;oBACvB,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;wBAC1C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE;wBACrD,uEAAuE;wBACvE,aAAa,GAAG,MAAM,CAAC;qBAC1B;iBACJ;gBACD,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,CAAC,eAAe,EAAE;oBAClD,aAAa,GAAG,MAAM,CAAC;iBAC1B;aACJ;SACJ;QACD,uBAAuB,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QACtF,uBAAuB,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAE5F,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YAClC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CAAC;SAC/C;aAAM;YACH,gEAAgE;YAChE,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ,MAAK,YAAY,CAAC,eAAe,EAAE;gBAC1D,4DAA4D;gBAC5D,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,8BAA8B;oBACzC,sBAAsB,EAAE,YAAY,CAAC,sBAAsB;oBAC3D,gBAAgB,EAAE,YAAY,CAAC,eAAe;oBAC9C,eAAe,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ;oBACxC,WAAW,EAAE,uBAAuB,CAAC,KAAK;iBAC7C,CAAC,CAAC;aACN;iBAAM,IAAI,aAAa,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE;gBACpE,yEAAyE;gBACzE,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;gBAC5E,MAAM,CAAC,cAAc,CAAC;oBAClB,SAAS,EAAE,gCAAgC;oBAC3C,sBAAsB,EAAE,YAAY,CAAC,sBAAsB;oBAC3D,gBAAgB,EAAE,YAAY,CAAC,eAAe;oBAC9C,eAAe,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,QAAQ;iBAC3C,CAAC,CAAC;aACN;YACD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CAAC,sBAAsB,CAAC;SACtE;IACL,CAAC;IAnGD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IACD,IAAW,sBAAsB;QAC7B,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IACD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IA4DD;;;OAGG;IACK,iBAAiB,CAAC,MAAiC,EAAE,cAAsB;QAC/E,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,kBAAkB,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,OAAO,CAAC,IAAI,MAAK,oBAAoB,CAAC;QAChF,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;QACvC,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;YAChC,kGAAkG;YAClG,IAAI,CAAC,uBAAuB,GAAG,cAAc,CAAC;YAC9C,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;YAC7B,MAAM,GAAG,IAAI,CAAC;SACjB;QACD,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,IAAI,CAAC,kBAAkB,EAAE;YACvD,uCAAuC;YACvC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;YAC7B,MAAM,GAAG,IAAI,CAAC;SACjB;QACD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;SAC7D;IACL,CAAC;IAEO,iBAAiB,CAAC,MAAiC,EAAE,cAAsB;QAC/E,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;YAChC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACnF;IACL,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,MAAiC;QAC7D,IAAI,eAAe,GAAG,MAAM,CAAC;QAC7B,OAAO,eAAe,KAAK,SAAS;YAChC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,EAAE;YACvG,eAAe,GAAG,eAAe,CAAC,aAAa,CAAC;SACnD;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACK,SAAS,CAAC,MAAqB,EAAE,cAAsB;;QAC3D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC;YAClF,MAAM,yBAAyB,GAAG,OAAA,IAAI,CAAC,cAAc,0CAAE,MAAM,CAAC,OAAO,CAAC,IAAI,MAAK,oBAAoB,CAAC;YACpG,+FAA+F;YAC/F,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,CAAC,CAAC,yBAAyB,IAAI,qBAAqB,CAAC,EAAE;gBAC5F,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;aAClD;iBACI,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,CAAC,qBAAqB,EAAE;gBAClE,2FAA2F;gBAC3F,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;aAClD;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,MAAqB,EAAE,cAAsB;;QAC9D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;gBAChC,2DAA2D;gBAC3D,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;oBAChC,qFAAqF;oBACrF,4FAA4F;oBAC5F,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE;wBAClE,MAAM,IAAI,UAAU,CAAC,gDAAgD,CAAC,CAAC;qBAC1E;oBACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;iBAC/D;qBACI;oBACD,2EAA2E;oBAC3E,6CAA6C;oBAC7C,MAAM,UAAU,SAAG,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,mCAC/E,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;oBAC5E,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;iBACtD;aACJ;iBACI,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE;gBACrC,wDAAwD;gBACxD,0EAA0E;gBAC1E,kDAAkD;gBAClD,IAAI,OAAA,IAAI,CAAC,cAAc,0CAAE,MAAM,CAAC,OAAO,CAAC,IAAI,MAAK,oBAAoB,EAAE;oBACnE,MAAM,IAAI,UAAU,CAAC,gDAAgD,CAAC,CAAC;iBAC1E;gBACD,MAAM,UAAU,SAAG,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,mCAC/E,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;gBAC5E,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;aACtD;SACJ;IACL,CAAC;IAEM,qBAAqB;QACxB,OAAO,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,cAAsB;;QAChD,MAAM,UAAU,SAAG,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,mCAC/E,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;QAC5E,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE;YAClF,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;SACtD;aACI;YACD,4FAA4F;YAC5F,wDAAwD;YACxD,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;SACtD;IACL,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,cAAsB;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE;YAClF,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;SACvD;aACI;YACD,4FAA4F;YAC5F,wDAAwD;YACxD,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;SACvD;IACL,CAAC;IAEM,qBAAqB;;QACxB,OAAO,IAAI,CAAC,uBAAuB,OAAC,IAAI,CAAC,cAAc,0CAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IAEM,SAAS;;QACZ,OAAO;YACH,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,eAAe,QAAE,IAAI,CAAC,aAAa,0CAAE,QAAQ;YAC7C,eAAe,QAAE,IAAI,CAAC,aAAa,0CAAE,QAAQ;SAChD,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport { IClient, IQuorumClients, ISequencedClient } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { summarizerClientType } from \"./summarizerClientElection\";\n\n// helper types for recursive readonly.\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport type ImmutablePrimitives = undefined | null | boolean | string | number | Function;\nexport type Immutable<T> = T extends ImmutablePrimitives\n    ? T\n    : T extends (infer A)[]\n    ? readonly Immutable<A>[]\n    : T extends Map<infer K, infer V>\n    ? ReadonlyMap<Immutable<K>, Immutable<V>>\n    : T extends Set<infer V>\n    ? ReadonlySet<Immutable<V>>\n    : { readonly [K in keyof T]: Immutable<T[K]> };\n\n/** Minimum information for a client tracked for election consideration. */\nexport interface ITrackedClient {\n    readonly clientId: string;\n    readonly sequenceNumber: number;\n    readonly client: Immutable<IClient>;\n}\n\n/** Common contract for link nodes within an OrderedClientCollection. */\nexport interface ILinkNode {\n    readonly sequenceNumber: number;\n    youngerClient: ILinkedClient | undefined;\n}\n\n/** Placeholder root node within an OrderedClientCollection; does not represent a client. */\nexport interface IRootLinkNode extends ILinkNode {\n    readonly sequenceNumber: -1;\n    readonly olderClient: undefined;\n}\n\n/** Additional information required to keep track of the client within the doubly-linked list. */\nexport interface ILinkedClient extends ILinkNode, ITrackedClient {\n    olderClient: LinkNode;\n}\n\n/** Any link node within OrderedClientCollection including the placeholder root node. */\nexport type LinkNode = IRootLinkNode | ILinkedClient;\n\n/** Events raised by an OrderedClientCollection. */\nexport interface IOrderedClientCollectionEvents extends IEvent {\n    /** Event fires when client is being added. */\n    (event: \"addClient\" | \"removeClient\", listener: (client: ILinkedClient, sequenceNumber: number) => void);\n}\n\n/** Contract for a sorted collection of all clients in the quorum. */\nexport interface IOrderedClientCollection extends IEventProvider<IOrderedClientCollectionEvents> {\n    /** Count of clients in the collection. */\n    readonly count: number;\n    /** Pointer to the oldest client in the collection. */\n    readonly oldestClient: ILinkedClient | undefined;\n    /** Returns a sorted array of all the clients in the collection. */\n    getAllClients(): ILinkedClient[];\n}\n\n/**\n * Tracks clients in the Quorum. It maintains their order using their join op\n * sequence numbers.\n * Internally, the collection of clients is maintained in a doubly-linked list,\n * with pointers to both the first and last nodes.\n * The first (root) node is a placeholder to simplify logic and reduce null checking.\n */\nexport class OrderedClientCollection\n    extends TypedEventEmitter<IOrderedClientCollectionEvents>\n    implements IOrderedClientCollection {\n    /** Collection of ALL clients currently in the quorum, with client ids as keys. */\n    private readonly clientMap = new Map<string, ILinkedClient>();\n    /** Placeholder head node of linked list, for simplified null checking. */\n    private readonly rootNode: IRootLinkNode = {\n        sequenceNumber: -1,\n        olderClient: undefined,\n        youngerClient: undefined,\n    };\n    /** Pointer to end of linked list, for optimized client adds. */\n    private _youngestClient: LinkNode = this.rootNode;\n    private readonly logger: ITelemetryLogger;\n\n    public get count() {\n        return this.clientMap.size;\n    }\n    public get oldestClient() {\n        return this.rootNode.youngerClient;\n    }\n\n    constructor(\n        logger: ITelemetryLogger,\n        deltaManager: Pick<IDeltaManager<unknown, unknown>, \"lastSequenceNumber\">,\n        quorum: Pick<IQuorumClients, \"getMembers\" | \"on\">,\n    ) {\n        super();\n        this.logger = ChildLogger.create(logger, \"OrderedClientCollection\");\n        const members = quorum.getMembers();\n        for (const [clientId, client] of members) {\n            this.addClient(clientId, client);\n        }\n\n        quorum.on(\"addMember\", (clientId, client) => {\n            const newClient = this.addClient(clientId, client);\n            this.emit(\"addClient\", newClient, deltaManager.lastSequenceNumber);\n        });\n        quorum.on(\"removeMember\", (clientId) => {\n            const sequenceNumber = deltaManager.lastSequenceNumber;\n            const removeClient = this.removeClient(clientId);\n            if (removeClient === undefined) {\n                this.logger.sendErrorEvent({ eventName: \"ClientNotFound\", clientId, sequenceNumber });\n            } else {\n                this.emit(\"removeClient\", removeClient, sequenceNumber);\n            }\n        });\n    }\n\n    private addClient(clientId: string, client: ISequencedClient): ITrackedClient {\n        // Normal case is adding the latest client, which will bypass loop.\n        // Find where it belongs otherwise (maybe possible during initial load?).\n        assert(client.sequenceNumber > -1, 0x1f6 /* \"Negative client sequence number not allowed\" */);\n        let currClient = this._youngestClient;\n        while (currClient.sequenceNumber > client.sequenceNumber) {\n            assert(currClient.olderClient !== undefined, 0x1f7 /* \"Previous client should always be defined\" */);\n            // Note: If adding a client older than the elected client, it will not be automatically elected.\n            currClient = currClient.olderClient;\n        }\n\n        // Now currClient is the node right before where the new client node should be.\n        const newClient: ILinkedClient = {\n            clientId,\n            sequenceNumber: client.sequenceNumber,\n            client: { ...client.client }, // shallow clone\n            olderClient: currClient,\n            youngerClient: currClient.youngerClient,\n        };\n\n        // Update prev node to point to this new node.\n        newClient.olderClient.youngerClient = newClient;\n\n        if (newClient.youngerClient === undefined) {\n            // Update linked list end pointer to youngest client.\n            this._youngestClient = newClient;\n        } else {\n            // Update next node to point back to this new node.\n            newClient.youngerClient.olderClient = newClient;\n        }\n\n        this.clientMap.set(clientId, newClient);\n        return newClient;\n    }\n\n    private removeClient(clientId: string): ITrackedClient | undefined {\n        const removeClient = this.clientMap.get(clientId);\n        if (removeClient === undefined) {\n            return;\n        }\n\n        // Update prev node to point to next node.\n        removeClient.olderClient.youngerClient = removeClient.youngerClient;\n\n        if (removeClient.youngerClient === undefined) {\n            // Update linked list end pointer to youngest client.\n            this._youngestClient = removeClient.olderClient;\n        } else {\n            // Update next node to point back to previous node.\n            removeClient.youngerClient.olderClient = removeClient.olderClient;\n        }\n\n        this.clientMap.delete(clientId);\n        return removeClient;\n    }\n\n    /** Returns an array of all clients being tracked in order from oldest to newest. */\n    public getAllClients(): ILinkedClient[] {\n        const result: ILinkedClient[] = [];\n        let currClient: LinkNode = this.rootNode;\n        while (currClient.youngerClient !== undefined) {\n            result.push(currClient.youngerClient);\n            currClient = currClient.youngerClient;\n        }\n        return result;\n    }\n}\n\n/** Events raised by an OrderedClientElection. */\nexport interface IOrderedClientElectionEvents extends IEvent {\n    /** Event fires when the currently elected client changes. */\n    (event: \"election\", listener: (\n        /** Newly elected client. */\n        client: ITrackedClient | undefined,\n        /** Sequence number where election took place. */\n        sequenceNumber: number,\n        /** Previously elected client. */\n        prevClient: ITrackedClient | undefined,\n    ) => void);\n}\n\n/** Serialized state of IOrderedClientElection. */\nexport interface ISerializedElection {\n    /** Sequence number at the time of the latest election. */\n    readonly electionSequenceNumber: number;\n    /** Most recently elected client id. This is either:\n     * 1. the interactive elected parent client, in which case electedClientId === electedParentId,\n     *  and the SummaryManager on the elected client will spawn a summarizer client, or\n     * 2. the non-interactive summarizer client itself. */\n    readonly electedClientId: string | undefined;\n    /** Most recently elected parent client id. This is always an interactive client. */\n    readonly electedParentId: string | undefined;\n}\n\n/** Contract for maintaining a deterministic client election based on eligibility. */\nexport interface IOrderedClientElection extends IEventProvider<IOrderedClientElectionEvents> {\n    /** Count of eligible clients in the collection. */\n    readonly eligibleCount: number;\n    /** Currently elected client. This is either:\n     * 1. the interactive elected parent client, in which case electedClientId === electedParentId,\n     *  and the SummaryManager on the elected client will spawn a summarizer client, or\n     * 2. the non-interactive summarizer client itself. */\n    readonly electedClient: ITrackedClient | undefined;\n    /** Currently elected parent client. This is always an interactive client. */\n    readonly electedParent: ITrackedClient | undefined;\n    /** Sequence number of most recent election. */\n    readonly electionSequenceNumber: number;\n    /** Marks the currently elected client as invalid, and elects the next eligible client. */\n    incrementElectedClient(sequenceNumber: number): void;\n    /** Resets the currently elected client back to the oldest eligible client. */\n    resetElectedClient(sequenceNumber: number): void;\n    /** Peeks at what the next elected client would be if incrementElectedClient were called. */\n    peekNextElectedClient(): ITrackedClient | undefined;\n    /** Returns a sorted array of all the eligible clients in the collection. */\n    getAllEligibleClients(): ITrackedClient[];\n    /** Serialize election data */\n    serialize(): ISerializedElection;\n}\n\n/**\n * Adapter for OrderedClientCollection, with the purpose of deterministically maintaining\n * a currently elected client, excluding ineligible clients, in a distributed fashion.\n * This can be true as long as incrementElectedClient and resetElectedClient calls\n * are called under the same conditions for all clients.\n */\nexport class OrderedClientElection\n    extends TypedEventEmitter<IOrderedClientElectionEvents>\n    implements IOrderedClientElection {\n    private _eligibleCount: number = 0;\n    private _electedClient: ILinkedClient | undefined;\n    private _electedParent: ILinkedClient | undefined;\n    private _electionSequenceNumber: number;\n\n    public get eligibleCount() {\n        return this._eligibleCount;\n    }\n    public get electionSequenceNumber() {\n        return this._electionSequenceNumber;\n    }\n\n    /**\n     * OrderedClientCollection tracks electedClient and electedParent separately. This allows us to handle the case\n     * where a new interactive parent client has been elected, but the summarizer is still doing work, so\n     * a new summarizer should not yet be spawned. In this case, changing electedParent will cause SummaryManager\n     * to stop the current summarizer, but a new summarizer will not be spawned until the old summarizer client has\n     * left the quorum.\n     *\n     * Details:\n     *\n     * electedParent is the interactive client that has been elected to spawn a summarizer. It is typically the oldest\n     * eligible interactive client in the quorum. Only the electedParent is permitted to spawn a summarizer.\n     * Once elected, this client will remain the electedParent until it leaves the quorum or the summarizer that\n     * it spawned stops producing summaries, at which point a new electedParent will be chosen.\n     *\n     * electedClient is the non-interactive summarizer client if one exists. If not, then electedClient is equal to\n     * electedParent. If electedParent === electedClient, this is the signal for electedParent to spawn a new\n     * electedClient. Once a summarizer client becomes electedClient, a new summarizer will not be spawned until\n     * electedClient leaves the quorum.\n     *\n     * A typical sequence looks like this:\n     * i. Begin by electing A. electedParent === A, electedClient === A.\n     * ii. SummaryManager running on A spawns a summarizer client, A'. electedParent === A, electedClient === A'\n     * iii. A' stops producing summaries. A new parent client, B, is elected. electedParent === B, electedClient === A'\n     * iv. SummaryManager running on A detects the change to electedParent and tells the summarizer to stop, but A'\n     *      is in mid-summarization. No new summarizer is spawned, as electedParent !== electedClient.\n     * v. A' completes its summary, and the summarizer and backing client are torn down.\n     * vi. A' leaves the quorum, and B takes its place as electedClient. electedParent === B, electedClient === B\n     * vii. SummaryManager running on B spawns a summarizer client, B'. electedParent === B, electedClient === B'\n     */\n    public get electedClient() {\n        return this._electedClient;\n    }\n    public get electedParent() {\n        return this._electedParent;\n    }\n\n    constructor(\n        logger: ITelemetryLogger,\n        private readonly orderedClientCollection: IOrderedClientCollection,\n        /** Serialized state from summary or current sequence number at time of load if new. */\n        initialState: ISerializedElection | number,\n        private readonly isEligibleFn: (c: ITrackedClient) => boolean,\n    ) {\n        super();\n        let initialClient: ILinkedClient | undefined;\n        let initialParent: ILinkedClient | undefined;\n        for (const client of orderedClientCollection.getAllClients()) {\n            this.addClient(client, 0);\n            if (typeof initialState !== \"number\") {\n                if (client.clientId === initialState.electedClientId) {\n                    initialClient = client;\n                    if (initialState.electedParentId === undefined &&\n                        client.client.details.type !== summarizerClientType) {\n                        // If there was no elected parent in the serialized data, use this one.\n                        initialParent = client;\n                    }\n                }\n                if (client.clientId === initialState.electedParentId) {\n                    initialParent = client;\n                }\n            }\n        }\n        orderedClientCollection.on(\"addClient\", (client, seq) => this.addClient(client, seq));\n        orderedClientCollection.on(\"removeClient\", (client, seq) => this.removeClient(client, seq));\n\n        if (typeof initialState === \"number\") {\n            this._electionSequenceNumber = initialState;\n        } else {\n            // Override the initially elected client with the initial state.\n            if (initialClient?.clientId !== initialState.electedClientId) {\n                // Cannot find initially elected client, so elect undefined.\n                logger.sendErrorEvent({\n                    eventName: \"InitialElectedClientNotFound\",\n                    electionSequenceNumber: initialState.electionSequenceNumber,\n                    expectedClientId: initialState.electedClientId,\n                    electedClientId: initialClient?.clientId,\n                    clientCount: orderedClientCollection.count,\n                });\n            } else if (initialClient !== undefined && !isEligibleFn(initialClient)) {\n                // Initially elected client is ineligible, so elect next eligible client.\n                initialClient = initialParent = this.findFirstEligibleParent(initialParent);\n                logger.sendErrorEvent({\n                    eventName: \"InitialElectedClientIneligible\",\n                    electionSequenceNumber: initialState.electionSequenceNumber,\n                    expectedClientId: initialState.electedClientId,\n                    electedClientId: initialClient?.clientId,\n                });\n            }\n            this._electedParent = initialParent;\n            this._electedClient = initialClient;\n            this._electionSequenceNumber = initialState.electionSequenceNumber;\n        }\n    }\n\n    /** Tries changing the elected client, raising an event if it is different.\n     * Note that this function does no eligibility or suitability checks. If we get here, then\n     * we will set _electedClient, and we will set _electedParent if this is an interactive client.\n     */\n    private tryElectingClient(client: ILinkedClient | undefined, sequenceNumber: number): void {\n        let change = false;\n        const isSummarizerClient = client?.client.details.type === summarizerClientType;\n        const prevClient = this._electedClient;\n        if (this._electedClient !== client) {\n            // Changing the elected client. Record the sequence number and note that we have to fire an event.\n            this._electionSequenceNumber = sequenceNumber;\n            this._electedClient = client;\n            change = true;\n        }\n        if (this._electedParent !== client && !isSummarizerClient) {\n            // Changing the elected parent as well.\n            this._electedParent = client;\n            change = true;\n        }\n        if (change) {\n            this.emit(\"election\", client, sequenceNumber, prevClient);\n        }\n    }\n\n    private tryElectingParent(client: ILinkedClient | undefined, sequenceNumber: number): void {\n        if (this._electedParent !== client) {\n            this._electedParent = client;\n            this.emit(\"election\", this._electedClient, sequenceNumber, this._electedClient);\n        }\n    }\n\n    /**\n     * Helper function to find the first eligible parent client starting with the passed in client,\n     * or undefined if none are eligible.\n     * @param client - client to start checking\n     * @returns oldest eligible client starting with passed in client or undefined if none.\n     */\n    private findFirstEligibleParent(client: ILinkedClient | undefined): ILinkedClient | undefined {\n        let candidateClient = client;\n        while (candidateClient !== undefined &&\n            (!this.isEligibleFn(candidateClient) || candidateClient.client.details.type === summarizerClientType)) {\n            candidateClient = candidateClient.youngerClient;\n        }\n        return candidateClient;\n    }\n\n    /**\n     * Updates tracking for when a new client is added to the collection.\n     * Will automatically elect that new client if none is elected currently.\n     * @param client - client added to the collection\n     * @param sequenceNumber - sequence number when client was added\n     */\n    private addClient(client: ILinkedClient, sequenceNumber: number): void {\n        if (this.isEligibleFn(client)) {\n            this._eligibleCount++;\n            const newClientIsSummarizer = client.client.details.type === summarizerClientType;\n            const electedClientIsSummarizer = this._electedClient?.client.details.type === summarizerClientType;\n            // Note that we allow a summarizer client to supercede an interactive client as elected client.\n            if (this._electedClient === undefined || (!electedClientIsSummarizer && newClientIsSummarizer)) {\n                this.tryElectingClient(client, sequenceNumber);\n            }\n            else if (this._electedParent === undefined && !newClientIsSummarizer) {\n                // This is an odd case. If the _electedClient is set, the _electedParent should be as well.\n                this.tryElectingParent(client, sequenceNumber);\n            }\n        }\n    }\n\n    /**\n     * Updates tracking for when an existing client is removed from the collection.\n     * Will automatically elect next oldest client if currently elected is removed.\n     * @param client - client removed from the collection\n     * @param sequenceNumber - sequence number when client was removed\n     */\n    private removeClient(client: ILinkedClient, sequenceNumber: number): void {\n        if (this.isEligibleFn(client)) {\n            this._eligibleCount--;\n            if (this._electedClient === client) {\n                // Removing the _electedClient. There are 2 possible cases:\n                if (this._electedParent !== client) {\n                    // 1. The _electedClient is a summarizer that we've been allowing to finish its work.\n                    // Let the _electedParent become the _electedClient so that it can start its own summarizer.\n                    if (this._electedClient.client.details.type !== summarizerClientType) {\n                        throw new UsageError(\"Elected client should be a summarizer client 1\");\n                    }\n                    this.tryElectingClient(this._electedParent, sequenceNumber);\n                }\n                else {\n                    // 2. The _electedClient is an interactive client that has left the quorum.\n                    // Automatically shift to next oldest client.\n                    const nextClient = this.findFirstEligibleParent(this._electedParent?.youngerClient) ??\n                        this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);\n                    this.tryElectingClient(nextClient, sequenceNumber);\n                }\n            }\n            else if (this._electedParent === client) {\n                // Removing the _electedParent (but not _electedClient).\n                // Shift to the next oldest parent, but do not replace the _electedClient,\n                // which is a summarizer that is still doing work.\n                if (this._electedClient?.client.details.type !== summarizerClientType) {\n                    throw new UsageError(\"Elected client should be a summarizer client 2\");\n                }\n                const nextParent = this.findFirstEligibleParent(this._electedParent?.youngerClient) ??\n                    this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);\n                this.tryElectingParent(nextParent, sequenceNumber);\n            }\n        }\n    }\n\n    public getAllEligibleClients(): ITrackedClient[] {\n        return this.orderedClientCollection.getAllClients().filter(this.isEligibleFn);\n    }\n\n    /** Advance election to the next-oldest client. This is called if the current parent is leaving the quorum,\n     * or if the current summarizer is not responsive and we want to stop it and spawn a new one.\n     */\n    public incrementElectedClient(sequenceNumber: number): void {\n        const nextClient = this.findFirstEligibleParent(this._electedParent?.youngerClient) ??\n            this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);\n        if (this._electedClient === undefined || this._electedClient === this._electedParent) {\n            this.tryElectingClient(nextClient, sequenceNumber);\n        }\n        else {\n            // The _electedClient is a summarizer and should not be replaced until it leaves the quorum.\n            // Changing the _electedParent will stop the summarizer.\n            this.tryElectingParent(nextClient, sequenceNumber);\n        }\n    }\n\n    /** (Re-)start election with the oldest client in the quorum. This is called if we need to summarize\n     * and no client has been elected.\n     */\n    public resetElectedClient(sequenceNumber: number): void {\n        const firstClient = this.findFirstEligibleParent(this.orderedClientCollection.oldestClient);\n        if (this._electedClient === undefined || this._electedClient === this._electedParent) {\n            this.tryElectingClient(firstClient, sequenceNumber);\n        }\n        else {\n            // The _electedClient is a summarizer and should not be replaced until it leaves the quorum.\n            // Changing the _electedParent will stop the summarizer.\n            this.tryElectingParent(firstClient, sequenceNumber);\n        }\n    }\n\n    public peekNextElectedClient(): ITrackedClient | undefined {\n        return this.findFirstEligibleParent(this._electedParent?.youngerClient);\n    }\n\n    public serialize(): ISerializedElection {\n        return {\n            electionSequenceNumber: this.electionSequenceNumber,\n            electedClientId: this.electedClient?.clientId,\n            electedParentId: this.electedParent?.clientId,\n        };\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-runtime";
-export declare const pkgVersion = "0.58.2002";
+export declare const pkgVersion = "0.58.3000-61081";
 //# sourceMappingURL=packageVersion.d.ts.map