@fluid-experimental/oldest-client-observer 2.0.0-internal.2.0.0

package/.eslintrc.js

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    "extends": [
+        require.resolve("@fluidframework/eslint-config-fluid")
+    ],
+    "parserOptions": {
+        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
+    },
+}

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @fluid-experimental/oldest-client-observer
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./interfaces";
+export * from "./oldestClientObserver";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./oldestClientObserver"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,+CAA6B;AAC7B,yDAAuC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./interfaces\";\nexport * from \"./oldestClientObserver\";\n"]}

package/dist/interfaces.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
+import { AttachState } from "@fluidframework/container-definitions";
+import { IQuorumClients } from "@fluidframework/protocol-definitions";
+export interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void): any;
+    (event: "disconnected", listener: () => void): any;
+}
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ */
+export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+export interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+export interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,MAAM,WAAW,6BAA8B,SAAQ,MAAM;IACzD,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAI3C,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CACjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IAC1F,SAAS,IAAI,cAAc,CAAC;IAM5B,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IACvD,CAAC,KAAK,EAAE,cAAc,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAChE;AAED,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACtF,QAAQ,IAAI,OAAO,CAAC;CACvB"}

package/dist/interfaces.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IQuorumClients } from \"@fluidframework/protocol-definitions\";\n\nexport interface IOldestClientObservableEvents extends IEvent {\n    (event: \"connected\", listener: () => void);\n    // Typescript won't convert IFluidDataStoreRuntime and ContainerRuntime if we unify these,\n    // I believe this is because the \"connected\" event has a clientId arg in the runtimes.\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"disconnected\", listener: () => void);\n}\n\n/**\n * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime\n * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,\n * since neither is really the source of truth (they are just the only currently-available plumbing options).\n * It's information about the connection, so the real source of truth is lower (at the connection layer).\n */\nexport interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {\n    getQuorum(): IQuorumClients;\n    // Generic usage of attachState is a little unusual here.  We will treat ourselves as \"the oldest client that\n    // has information about this [container | data store]\", which in the case of detached data store may disagree\n    // with whether we're the oldest client on the connected container.  So in the data store case, it's only\n    // safe use this as an indicator about rights to tasks performed against this specific data store, and not\n    // more broadly.\n    attachState: AttachState;\n    connected: boolean;\n    clientId: string | undefined;\n}\n\nexport interface IOldestClientObserverEvents extends IEvent {\n    (event: \"becameOldest\" | \"lostOldest\", listener: () => void);\n}\n\nexport interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {\n    isOldest(): boolean;\n}\n"]}

package/dist/oldestClientObserver.d.ts

@@ -0,0 +1,71 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluidframework/common-utils";
+import { IOldestClientObservable, IOldestClientObserverEvents, IOldestClientObserver } from "./interfaces";
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ */
+export declare class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents> implements IOldestClientObserver {
+    private readonly observable;
+    private readonly quorum;
+    private currentIsOldest;
+    constructor(observable: IOldestClientObservable);
+    isOldest(): boolean;
+    private readonly updateOldest;
+    private computeIsOldest;
+}
+//# sourceMappingURL=oldestClientObserver.d.ts.map

package/dist/oldestClientObserver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oldestClientObserver.d.ts","sourceRoot":"","sources":["../src/oldestClientObserver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGzE,OAAO,EAAE,uBAAuB,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE3G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB,CAAC,2BAA2B,CACnF,YAAW,qBAAqB;IAGpB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAFvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,eAAe,CAAkB;gBACZ,UAAU,EAAE,uBAAuB;IAUzD,QAAQ,IAAI,OAAO;IAI1B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAU3B;IAEF,OAAO,CAAC,eAAe;CA6B1B"}

package/dist/oldestClientObserver.js

@@ -0,0 +1,118 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OldestClientObserver = void 0;
+const common_utils_1 = require("@fluidframework/common-utils");
+const container_definitions_1 = require("@fluidframework/container-definitions");
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ */
+class OldestClientObserver extends common_utils_1.TypedEventEmitter {
+    constructor(observable) {
+        super();
+        this.observable = observable;
+        this.currentIsOldest = false;
+        this.updateOldest = () => {
+            const oldest = this.computeIsOldest();
+            if (this.currentIsOldest !== oldest) {
+                this.currentIsOldest = oldest;
+                if (oldest) {
+                    this.emit("becameOldest");
+                }
+                else {
+                    this.emit("lostOldest");
+                }
+            }
+        };
+        this.quorum = this.observable.getQuorum();
+        this.currentIsOldest = this.computeIsOldest();
+        this.quorum.on("addMember", this.updateOldest);
+        this.quorum.on("removeMember", this.updateOldest);
+        observable.on("connected", this.updateOldest);
+        observable.on("disconnected", this.updateOldest);
+    }
+    isOldest() {
+        return this.currentIsOldest;
+    }
+    computeIsOldest() {
+        // If the container is detached, we are the only ones that know about it and are the oldest by default.
+        if (this.observable.attachState === container_definitions_1.AttachState.Detached) {
+            return true;
+        }
+        // If we're not connected we can't be the oldest connected client.
+        if (!this.observable.connected) {
+            return false;
+        }
+        (0, common_utils_1.assert)(this.observable.clientId !== undefined, 0x1da /* "Client id should be set if connected" */);
+        const selfSequencedClient = this.quorum.getMember(this.observable.clientId);
+        // When in readonly mode our clientId will not be present in the quorum.
+        if (selfSequencedClient === undefined) {
+            return false;
+        }
+        const members = this.quorum.getMembers();
+        for (const sequencedClient of members.values()) {
+            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {
+                return false;
+            }
+        }
+        // No member of the quorum was older
+        return true;
+    }
+}
+exports.OldestClientObserver = OldestClientObserver;
+//# sourceMappingURL=oldestClientObserver.js.map

package/dist/oldestClientObserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oldestClientObserver.js","sourceRoot":"","sources":["../src/oldestClientObserver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAyE;AACzE,iFAAoE;AAIpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAa,oBAAqB,SAAQ,gCAA8C;IAIpF,YAA6B,UAAmC;QAC5D,KAAK,EAAE,CAAC;QADiB,eAAU,GAAV,UAAU,CAAyB;QADxD,oBAAe,GAAY,KAAK,CAAC;QAexB,iBAAY,GAAG,GAAG,EAAE;YACjC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM,EAAE;gBACjC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC;gBAC9B,IAAI,MAAM,EAAE;oBACR,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBAC7B;qBAAM;oBACH,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAC3B;aACJ;QACL,CAAC,CAAC;QAtBE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAClD,UAAU,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACrD,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAcO,eAAe;QACnB,uGAAuG;QACvG,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,EAAE;YACtD,OAAO,IAAI,CAAC;SACf;QAED,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;YAC5B,OAAO,KAAK,CAAC;SAChB;QAED,IAAA,qBAAM,EAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAEnG,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC5E,wEAAwE;QACxE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACzC,KAAK,MAAM,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE;YAC5C,IAAI,eAAe,CAAC,cAAc,GAAG,mBAAmB,CAAC,cAAc,EAAE;gBACrE,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,oCAAoC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3DD,oDA2DC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { IOldestClientObservable, IOldestClientObserverEvents, IOldestClientObserver } from \"./interfaces\";\n\n/**\n * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in\n * terms of when they connected) and watch for changes.\n *\n * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.\n *\n * @remarks\n * ### Creation\n *\n * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with\n * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:\n *\n * ```typescript\n * // E.g. from within a BaseContainerRuntimeFactory:\n * protected async containerHasInitialized(runtime: IContainerRuntime) {\n *     const oldestClientObserver = new OldestClientObserver(runtime);\n *     // ...\n * }\n * ```\n *\n * ```typescript\n * // From within a DataObject\n * protected async hasInitialized() {\n *     const oldestClientObserver = new OldestClientObserver(this.runtime);\n *     // ...\n * }\n * ```\n *\n * ### Usage\n *\n * To check if the local client is the oldest, use the `isOldest()` method.\n *\n * ```typescript\n * if (oldestClientObserver.isOldest()) {\n *     console.log(\"I'm the oldest\");\n * } else {\n *     console.log(\"Someone else is older\");\n * }\n * ```\n *\n * ### Eventing\n *\n * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when\n * it is no longer the oldest.\n *\n * ```typescript\n * oldestClientObserver.on(\"becameOldest\", () => {\n *     console.log(\"I'm the oldest now\");\n * });\n *\n * oldestClientObserver.on(\"lostOldest\", () => {\n *     console.log(\"I'm not the oldest anymore\");\n * });\n * ```\n */\nexport class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents>\n    implements IOldestClientObserver {\n    private readonly quorum: IQuorumClients;\n    private currentIsOldest: boolean = false;\n    constructor(private readonly observable: IOldestClientObservable) {\n        super();\n        this.quorum = this.observable.getQuorum();\n        this.currentIsOldest = this.computeIsOldest();\n        this.quorum.on(\"addMember\", this.updateOldest);\n        this.quorum.on(\"removeMember\", this.updateOldest);\n        observable.on(\"connected\", this.updateOldest);\n        observable.on(\"disconnected\", this.updateOldest);\n    }\n\n    public isOldest(): boolean {\n        return this.currentIsOldest;\n    }\n\n    private readonly updateOldest = () => {\n        const oldest = this.computeIsOldest();\n        if (this.currentIsOldest !== oldest) {\n            this.currentIsOldest = oldest;\n            if (oldest) {\n                this.emit(\"becameOldest\");\n            } else {\n                this.emit(\"lostOldest\");\n            }\n        }\n    };\n\n    private computeIsOldest(): boolean {\n        // If the container is detached, we are the only ones that know about it and are the oldest by default.\n        if (this.observable.attachState === AttachState.Detached) {\n            return true;\n        }\n\n        // If we're not connected we can't be the oldest connected client.\n        if (!this.observable.connected) {\n            return false;\n        }\n\n        assert(this.observable.clientId !== undefined, 0x1da /* \"Client id should be set if connected\" */);\n\n        const selfSequencedClient = this.quorum.getMember(this.observable.clientId);\n        // When in readonly mode our clientId will not be present in the quorum.\n        if (selfSequencedClient === undefined) {\n            return false;\n        }\n\n        const members = this.quorum.getMembers();\n        for (const sequencedClient of members.values()) {\n            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {\n                return false;\n            }\n        }\n\n        // No member of the quorum was older\n        return true;\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export declare const pkgName = "@fluid-experimental/oldest-client-observer";
+export declare const pkgVersion = "2.0.0-internal.2.0.0";
+//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+CAA+C,CAAC;AACpE,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/dist/packageVersion.js

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pkgVersion = exports.pkgName = void 0;
+exports.pkgName = "@fluid-experimental/oldest-client-observer";
+exports.pkgVersion = "2.0.0-internal.2.0.0";
+//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,4CAA4C,CAAC;AACvD,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-experimental/oldest-client-observer\";\nexport const pkgVersion = \"2.0.0-internal.2.0.0\";\n"]}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./interfaces";
+export * from "./oldestClientObserver";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}

package/lib/index.js

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./interfaces";
+export * from "./oldestClientObserver";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./interfaces\";\nexport * from \"./oldestClientObserver\";\n"]}

package/lib/interfaces.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
+import { AttachState } from "@fluidframework/container-definitions";
+import { IQuorumClients } from "@fluidframework/protocol-definitions";
+export interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void): any;
+    (event: "disconnected", listener: () => void): any;
+}
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ */
+export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+export interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void): any;
+}
+export interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/lib/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,MAAM,WAAW,6BAA8B,SAAQ,MAAM;IACzD,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAI3C,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CACjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc,CAAC,6BAA6B,CAAC;IAC1F,SAAS,IAAI,cAAc,CAAC;IAM5B,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IACvD,CAAC,KAAK,EAAE,cAAc,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAChE;AAED,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACtF,QAAQ,IAAI,OAAO,CAAC;CACvB"}

package/lib/interfaces.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=interfaces.js.map

package/lib/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IQuorumClients } from \"@fluidframework/protocol-definitions\";\n\nexport interface IOldestClientObservableEvents extends IEvent {\n    (event: \"connected\", listener: () => void);\n    // Typescript won't convert IFluidDataStoreRuntime and ContainerRuntime if we unify these,\n    // I believe this is because the \"connected\" event has a clientId arg in the runtimes.\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"disconnected\", listener: () => void);\n}\n\n/**\n * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime\n * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,\n * since neither is really the source of truth (they are just the only currently-available plumbing options).\n * It's information about the connection, so the real source of truth is lower (at the connection layer).\n */\nexport interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {\n    getQuorum(): IQuorumClients;\n    // Generic usage of attachState is a little unusual here.  We will treat ourselves as \"the oldest client that\n    // has information about this [container | data store]\", which in the case of detached data store may disagree\n    // with whether we're the oldest client on the connected container.  So in the data store case, it's only\n    // safe use this as an indicator about rights to tasks performed against this specific data store, and not\n    // more broadly.\n    attachState: AttachState;\n    connected: boolean;\n    clientId: string | undefined;\n}\n\nexport interface IOldestClientObserverEvents extends IEvent {\n    (event: \"becameOldest\" | \"lostOldest\", listener: () => void);\n}\n\nexport interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {\n    isOldest(): boolean;\n}\n"]}

package/lib/oldestClientObserver.d.ts

@@ -0,0 +1,71 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluidframework/common-utils";
+import { IOldestClientObservable, IOldestClientObserverEvents, IOldestClientObserver } from "./interfaces";
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ */
+export declare class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents> implements IOldestClientObserver {
+    private readonly observable;
+    private readonly quorum;
+    private currentIsOldest;
+    constructor(observable: IOldestClientObservable);
+    isOldest(): boolean;
+    private readonly updateOldest;
+    private computeIsOldest;
+}
+//# sourceMappingURL=oldestClientObserver.d.ts.map

package/lib/oldestClientObserver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oldestClientObserver.d.ts","sourceRoot":"","sources":["../src/oldestClientObserver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGzE,OAAO,EAAE,uBAAuB,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE3G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB,CAAC,2BAA2B,CACnF,YAAW,qBAAqB;IAGpB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAFvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,eAAe,CAAkB;gBACZ,UAAU,EAAE,uBAAuB;IAUzD,QAAQ,IAAI,OAAO;IAI1B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAU3B;IAEF,OAAO,CAAC,eAAe;CA6B1B"}

package/lib/oldestClientObserver.js

@@ -0,0 +1,114 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
+import { AttachState } from "@fluidframework/container-definitions";
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ */
+export class OldestClientObserver extends TypedEventEmitter {
+    constructor(observable) {
+        super();
+        this.observable = observable;
+        this.currentIsOldest = false;
+        this.updateOldest = () => {
+            const oldest = this.computeIsOldest();
+            if (this.currentIsOldest !== oldest) {
+                this.currentIsOldest = oldest;
+                if (oldest) {
+                    this.emit("becameOldest");
+                }
+                else {
+                    this.emit("lostOldest");
+                }
+            }
+        };
+        this.quorum = this.observable.getQuorum();
+        this.currentIsOldest = this.computeIsOldest();
+        this.quorum.on("addMember", this.updateOldest);
+        this.quorum.on("removeMember", this.updateOldest);
+        observable.on("connected", this.updateOldest);
+        observable.on("disconnected", this.updateOldest);
+    }
+    isOldest() {
+        return this.currentIsOldest;
+    }
+    computeIsOldest() {
+        // If the container is detached, we are the only ones that know about it and are the oldest by default.
+        if (this.observable.attachState === AttachState.Detached) {
+            return true;
+        }
+        // If we're not connected we can't be the oldest connected client.
+        if (!this.observable.connected) {
+            return false;
+        }
+        assert(this.observable.clientId !== undefined, 0x1da /* "Client id should be set if connected" */);
+        const selfSequencedClient = this.quorum.getMember(this.observable.clientId);
+        // When in readonly mode our clientId will not be present in the quorum.
+        if (selfSequencedClient === undefined) {
+            return false;
+        }
+        const members = this.quorum.getMembers();
+        for (const sequencedClient of members.values()) {
+            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {
+                return false;
+            }
+        }
+        // No member of the quorum was older
+        return true;
+    }
+}
+//# sourceMappingURL=oldestClientObserver.js.map

package/lib/oldestClientObserver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oldestClientObserver.js","sourceRoot":"","sources":["../src/oldestClientObserver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAIpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,OAAO,oBAAqB,SAAQ,iBAA8C;IAIpF,YAA6B,UAAmC;QAC5D,KAAK,EAAE,CAAC;QADiB,eAAU,GAAV,UAAU,CAAyB;QADxD,oBAAe,GAAY,KAAK,CAAC;QAexB,iBAAY,GAAG,GAAG,EAAE;YACjC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,eAAe,KAAK,MAAM,EAAE;gBACjC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC;gBAC9B,IAAI,MAAM,EAAE;oBACR,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;iBAC7B;qBAAM;oBACH,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAC3B;aACJ;QACL,CAAC,CAAC;QAtBE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAClD,UAAU,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACrD,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAcO,eAAe;QACnB,uGAAuG;QACvG,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACtD,OAAO,IAAI,CAAC;SACf;QAED,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;YAC5B,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAEnG,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC5E,wEAAwE;QACxE,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACzC,KAAK,MAAM,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE;YAC5C,IAAI,eAAe,CAAC,cAAc,GAAG,mBAAmB,CAAC,cAAc,EAAE;gBACrE,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,oCAAoC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IQuorumClients } from \"@fluidframework/protocol-definitions\";\nimport { IOldestClientObservable, IOldestClientObserverEvents, IOldestClientObserver } from \"./interfaces\";\n\n/**\n * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in\n * terms of when they connected) and watch for changes.\n *\n * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.\n *\n * @remarks\n * ### Creation\n *\n * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with\n * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:\n *\n * ```typescript\n * // E.g. from within a BaseContainerRuntimeFactory:\n * protected async containerHasInitialized(runtime: IContainerRuntime) {\n *     const oldestClientObserver = new OldestClientObserver(runtime);\n *     // ...\n * }\n * ```\n *\n * ```typescript\n * // From within a DataObject\n * protected async hasInitialized() {\n *     const oldestClientObserver = new OldestClientObserver(this.runtime);\n *     // ...\n * }\n * ```\n *\n * ### Usage\n *\n * To check if the local client is the oldest, use the `isOldest()` method.\n *\n * ```typescript\n * if (oldestClientObserver.isOldest()) {\n *     console.log(\"I'm the oldest\");\n * } else {\n *     console.log(\"Someone else is older\");\n * }\n * ```\n *\n * ### Eventing\n *\n * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when\n * it is no longer the oldest.\n *\n * ```typescript\n * oldestClientObserver.on(\"becameOldest\", () => {\n *     console.log(\"I'm the oldest now\");\n * });\n *\n * oldestClientObserver.on(\"lostOldest\", () => {\n *     console.log(\"I'm not the oldest anymore\");\n * });\n * ```\n */\nexport class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents>\n    implements IOldestClientObserver {\n    private readonly quorum: IQuorumClients;\n    private currentIsOldest: boolean = false;\n    constructor(private readonly observable: IOldestClientObservable) {\n        super();\n        this.quorum = this.observable.getQuorum();\n        this.currentIsOldest = this.computeIsOldest();\n        this.quorum.on(\"addMember\", this.updateOldest);\n        this.quorum.on(\"removeMember\", this.updateOldest);\n        observable.on(\"connected\", this.updateOldest);\n        observable.on(\"disconnected\", this.updateOldest);\n    }\n\n    public isOldest(): boolean {\n        return this.currentIsOldest;\n    }\n\n    private readonly updateOldest = () => {\n        const oldest = this.computeIsOldest();\n        if (this.currentIsOldest !== oldest) {\n            this.currentIsOldest = oldest;\n            if (oldest) {\n                this.emit(\"becameOldest\");\n            } else {\n                this.emit(\"lostOldest\");\n            }\n        }\n    };\n\n    private computeIsOldest(): boolean {\n        // If the container is detached, we are the only ones that know about it and are the oldest by default.\n        if (this.observable.attachState === AttachState.Detached) {\n            return true;\n        }\n\n        // If we're not connected we can't be the oldest connected client.\n        if (!this.observable.connected) {\n            return false;\n        }\n\n        assert(this.observable.clientId !== undefined, 0x1da /* \"Client id should be set if connected\" */);\n\n        const selfSequencedClient = this.quorum.getMember(this.observable.clientId);\n        // When in readonly mode our clientId will not be present in the quorum.\n        if (selfSequencedClient === undefined) {\n            return false;\n        }\n\n        const members = this.quorum.getMembers();\n        for (const sequencedClient of members.values()) {\n            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {\n                return false;\n            }\n        }\n\n        // No member of the quorum was older\n        return true;\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export declare const pkgName = "@fluid-experimental/oldest-client-observer";
+export declare const pkgVersion = "2.0.0-internal.2.0.0";
+//# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,+CAA+C,CAAC;AACpE,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/lib/packageVersion.js

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export const pkgName = "@fluid-experimental/oldest-client-observer";
+export const pkgVersion = "2.0.0-internal.2.0.0";
+//# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,4CAA4C,CAAC;AACpE,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-experimental/oldest-client-observer\";\nexport const pkgVersion = \"2.0.0-internal.2.0.0\";\n"]}

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@fluid-experimental/oldest-client-observer",
+  "version": "2.0.0-internal.2.0.0",
+  "description": "Data object to determine if the local client is the oldest amongst connected clients",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/framework/oldest-client-observer"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "lint": "npm run eslint",
+    "lint:fix": "npm run eslint:fix",
+    "tsc": "tsc",
+    "tsfmt": "tsfmt --verify",
+    "tsfmt:fix": "tsfmt --replace",
+    "typetests:gen": "fluid-type-validator -g -d ."
+  },
+  "nyc": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.ts",
+      "dist/test/**/*.js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.ts",
+      "dist/**/*.js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/common-definitions": "^0.20.1",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-definitions": "^2.0.0-internal.2.0.0",
+    "@fluidframework/protocol-definitions": "^1.1.0"
+  },
+  "devDependencies": {
+    "@fluid-internal/test-dds-utils": "^2.0.0-internal.2.0.0",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.6000",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.2.0.0",
+    "@fluidframework/test-runtime-utils": "^2.0.0-internal.2.0.0",
+    "@microsoft/api-extractor": "^7.22.2",
+    "@rushstack/eslint-config": "^2.5.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^14.18.0",
+    "concurrently": "^6.2.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.2",
+    "eslint": "~8.6.0",
+    "mocha": "^10.0.0",
+    "mocha-junit-reporter": "^1.18.0",
+    "nyc": "^15.0.0",
+    "rimraf": "^2.6.2",
+    "typescript": "~4.5.5",
+    "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "2.0.0",
+    "broken": {}
+  }
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export * from "./interfaces";
+export * from "./oldestClientObserver";

package/src/interfaces.ts

@@ -0,0 +1,42 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
+import { AttachState } from "@fluidframework/container-definitions";
+import { IQuorumClients } from "@fluidframework/protocol-definitions";
+
+export interface IOldestClientObservableEvents extends IEvent {
+    (event: "connected", listener: () => void);
+    // Typescript won't convert IFluidDataStoreRuntime and ContainerRuntime if we unify these,
+    // I believe this is because the "connected" event has a clientId arg in the runtimes.
+    // eslint-disable-next-line @typescript-eslint/unified-signatures
+    (event: "disconnected", listener: () => void);
+}
+
+/**
+ * This is to make OldestClientObserver work with either a ContainerRuntime or an IFluidDataStoreRuntime
+ * (both expose the relevant API surface and eventing).  However, really this info probably shouldn't live on either,
+ * since neither is really the source of truth (they are just the only currently-available plumbing options).
+ * It's information about the connection, so the real source of truth is lower (at the connection layer).
+ */
+export interface IOldestClientObservable extends IEventProvider<IOldestClientObservableEvents> {
+    getQuorum(): IQuorumClients;
+    // Generic usage of attachState is a little unusual here.  We will treat ourselves as "the oldest client that
+    // has information about this [container | data store]", which in the case of detached data store may disagree
+    // with whether we're the oldest client on the connected container.  So in the data store case, it's only
+    // safe use this as an indicator about rights to tasks performed against this specific data store, and not
+    // more broadly.
+    attachState: AttachState;
+    connected: boolean;
+    clientId: string | undefined;
+}
+
+export interface IOldestClientObserverEvents extends IEvent {
+    (event: "becameOldest" | "lostOldest", listener: () => void);
+}
+
+export interface IOldestClientObserver extends IEventProvider<IOldestClientObserverEvents> {
+    isOldest(): boolean;
+}

package/src/oldestClientObserver.ts

@@ -0,0 +1,125 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
+import { AttachState } from "@fluidframework/container-definitions";
+import { IQuorumClients } from "@fluidframework/protocol-definitions";
+import { IOldestClientObservable, IOldestClientObserverEvents, IOldestClientObserver } from "./interfaces";
+
+/**
+ * The `OldestClientObserver` is a utility inspect if the local client is the oldest amongst connected clients (in
+ * terms of when they connected) and watch for changes.
+ *
+ * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
+ *
+ * @remarks
+ * ### Creation
+ *
+ * The `OldestClientObserver` constructor takes an `IOldestClientObservable`.  This is most easily satisfied with
+ * either an `IContainerRuntime` or an `IFluidDataStoreRuntime`:
+ *
+ * ```typescript
+ * // E.g. from within a BaseContainerRuntimeFactory:
+ * protected async containerHasInitialized(runtime: IContainerRuntime) {
+ *     const oldestClientObserver = new OldestClientObserver(runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ```typescript
+ * // From within a DataObject
+ * protected async hasInitialized() {
+ *     const oldestClientObserver = new OldestClientObserver(this.runtime);
+ *     // ...
+ * }
+ * ```
+ *
+ * ### Usage
+ *
+ * To check if the local client is the oldest, use the `isOldest()` method.
+ *
+ * ```typescript
+ * if (oldestClientObserver.isOldest()) {
+ *     console.log("I'm the oldest");
+ * } else {
+ *     console.log("Someone else is older");
+ * }
+ * ```
+ *
+ * ### Eventing
+ *
+ * `OldestClientObserver` is an `EventEmitter`, and will emit events when the local client becomes the oldest and when
+ * it is no longer the oldest.
+ *
+ * ```typescript
+ * oldestClientObserver.on("becameOldest", () => {
+ *     console.log("I'm the oldest now");
+ * });
+ *
+ * oldestClientObserver.on("lostOldest", () => {
+ *     console.log("I'm not the oldest anymore");
+ * });
+ * ```
+ */
+export class OldestClientObserver extends TypedEventEmitter<IOldestClientObserverEvents>
+    implements IOldestClientObserver {
+    private readonly quorum: IQuorumClients;
+    private currentIsOldest: boolean = false;
+    constructor(private readonly observable: IOldestClientObservable) {
+        super();
+        this.quorum = this.observable.getQuorum();
+        this.currentIsOldest = this.computeIsOldest();
+        this.quorum.on("addMember", this.updateOldest);
+        this.quorum.on("removeMember", this.updateOldest);
+        observable.on("connected", this.updateOldest);
+        observable.on("disconnected", this.updateOldest);
+    }
+
+    public isOldest(): boolean {
+        return this.currentIsOldest;
+    }
+
+    private readonly updateOldest = () => {
+        const oldest = this.computeIsOldest();
+        if (this.currentIsOldest !== oldest) {
+            this.currentIsOldest = oldest;
+            if (oldest) {
+                this.emit("becameOldest");
+            } else {
+                this.emit("lostOldest");
+            }
+        }
+    };
+
+    private computeIsOldest(): boolean {
+        // If the container is detached, we are the only ones that know about it and are the oldest by default.
+        if (this.observable.attachState === AttachState.Detached) {
+            return true;
+        }
+
+        // If we're not connected we can't be the oldest connected client.
+        if (!this.observable.connected) {
+            return false;
+        }
+
+        assert(this.observable.clientId !== undefined, 0x1da /* "Client id should be set if connected" */);
+
+        const selfSequencedClient = this.quorum.getMember(this.observable.clientId);
+        // When in readonly mode our clientId will not be present in the quorum.
+        if (selfSequencedClient === undefined) {
+            return false;
+        }
+
+        const members = this.quorum.getMembers();
+        for (const sequencedClient of members.values()) {
+            if (sequencedClient.sequenceNumber < selfSequencedClient.sequenceNumber) {
+                return false;
+            }
+        }
+
+        // No member of the quorum was older
+        return true;
+    }
+}

package/src/packageVersion.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+
+export const pkgName = "@fluid-experimental/oldest-client-observer";
+export const pkgVersion = "2.0.0-internal.2.0.0";

package/tsconfig.esnext.json

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "./lib",
+        "module": "esnext"
+    },
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "extends": "@fluidframework/build-common/ts-common-config.json",
+    "exclude": [
+        "src/test/**/*"
+    ],
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./dist",
+        "composite": true
+    },
+    "include": [
+        "src/**/*"
+    ]
+}