@fluidframework/container-runtime 2.23.0 → 2.31.0

package/lib/runCounter.js

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _RunCounter_runs;
+export class RunCounter {
+    constructor() {
+        _RunCounter_runs.set(this, 0);
+    }
+    get running() {
+        return __classPrivateFieldGet(this, _RunCounter_runs, "f") !== 0;
+    }
+    get runs() {
+        return __classPrivateFieldGet(this, _RunCounter_runs, "f");
+    }
+    run(act) {
+        var _a, _b;
+        __classPrivateFieldSet(this, _RunCounter_runs, (_a = __classPrivateFieldGet(this, _RunCounter_runs, "f"), _a++, _a), "f");
+        try {
+            return act();
+        }
+        finally {
+            __classPrivateFieldSet(this, _RunCounter_runs, (_b = __classPrivateFieldGet(this, _RunCounter_runs, "f"), _b--, _b), "f");
+        }
+    }
+}
+_RunCounter_runs = new WeakMap();
+//# sourceMappingURL=runCounter.js.map

package/lib/runCounter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCounter.js","sourceRoot":"","sources":["../src/runCounter.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,MAAM,OAAO,UAAU;IAAvB;QACC,2BAAQ,CAAC,EAAC;IAkBX,CAAC;IAhBA,IAAW,OAAO;QACjB,OAAO,uBAAA,IAAI,wBAAM,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,IAAW,IAAI;QACd,OAAO,uBAAA,IAAI,wBAAM,CAAC;IACnB,CAAC;IAEM,GAAG,CAAI,GAAY;;QACzB,+CAAA,CAAA,wDAAU,EAAV,IAAY,IAAA,CAAA,MAAA,CAAC;QACb,IAAI,CAAC;YACJ,OAAO,GAAG,EAAE,CAAC;QACd,CAAC;gBAAS,CAAC;YACV,+CAAA,CAAA,wDAAU,EAAV,IAAY,IAAA,CAAA,MAAA,CAAC;QACd,CAAC;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport class RunCounter {\n\t#runs = 0;\n\n\tpublic get running(): boolean {\n\t\treturn this.#runs !== 0;\n\t}\n\n\tpublic get runs(): number {\n\t\treturn this.#runs;\n\t}\n\n\tpublic run<T>(act: () => T): T {\n\t\tthis.#runs++;\n\t\ttry {\n\t\t\treturn act();\n\t\t} finally {\n\t\t\tthis.#runs--;\n\t\t}\n\t}\n}\n"]}

package/lib/runtimeLayerCompatState.d.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type ILayerCompatDetails, type ILayerCompatSupportRequirements } from "@fluid-internal/client-utils";
+import type { ICriticalContainerError } from "@fluidframework/container-definitions";
+/**
+ * The core compatibility details of the Runtime layer that is the same across all layer boundaries.
+ * @internal
+ */
+export declare const runtimeCoreCompatDetails: {
+    /**
+     * The package version of the Runtime layer.
+     */
+    pkgVersion: string;
+    /**
+     * The current generation of the Runtime layer.
+     */
+    generation: number;
+};
+/**
+ * Runtime's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export declare const runtimeCompatDetailsForLoader: ILayerCompatDetails;
+/**
+ * The requirements that the Loader layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export declare const loaderSupportRequirements: ILayerCompatSupportRequirements;
+/**
+ * Runtime's compatibility details that is exposed to the DataStore layer.
+ * @internal
+ */
+export declare const runtimeCompatDetailsForDataStore: ILayerCompatDetails;
+/**
+ * The requirements that the DataStore layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export declare const dataStoreSupportRequirements: ILayerCompatSupportRequirements;
+/**
+ * Validates that the Loader layer is compatible with this Runtime.
+ * @internal
+ */
+export declare function validateLoaderCompatibility(maybeloaderCompatDetailsForRuntime: ILayerCompatDetails | undefined, disposeFn: (error?: ICriticalContainerError) => void): void;
+/**
+ * Validates that the DataStore layer is compatible with this Runtime.
+ * @internal
+ */
+export declare function validateDatastoreCompatibility(maybeDataStoreCompatDetails: ILayerCompatDetails | undefined, disposeFn: () => void): void;
+//# sourceMappingURL=runtimeLayerCompatState.d.ts.map

package/lib/runtimeLayerCompatState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeLayerCompatState.d.ts","sourceRoot":"","sources":["../src/runtimeLayerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,KAAK,mBAAmB,EACxB,KAAK,+BAA+B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAKrF;;;GAGG;AACH,eAAO,MAAM,wBAAwB;IACpC;;OAEG;;IAEH;;OAEG;;CAEH,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,mBAM3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,+BAUvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gCAAgC,EAAE,mBAM9C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,EAAE,+BAU1C,CAAC;AAEF;;;GAGG;AACH,wBAAgB,2BAA2B,CAC1C,kCAAkC,EAAE,mBAAmB,GAAG,SAAS,EACnE,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,GAClD,IAAI,CAoBN;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAC7C,2BAA2B,EAAE,mBAAmB,GAAG,SAAS,EAC5D,SAAS,EAAE,MAAM,IAAI,GACnB,IAAI,CAoBN"}

package/lib/runtimeLayerCompatState.js

@@ -0,0 +1,118 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { checkLayerCompatibility, } from "@fluid-internal/client-utils";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import { pkgVersion } from "./packageVersion.js";
+/**
+ * The core compatibility details of the Runtime layer that is the same across all layer boundaries.
+ * @internal
+ */
+export const runtimeCoreCompatDetails = {
+    /**
+     * The package version of the Runtime layer.
+     */
+    pkgVersion,
+    /**
+     * The current generation of the Runtime layer.
+     */
+    generation: 1,
+};
+/**
+ * Runtime's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export const runtimeCompatDetailsForLoader = {
+    ...runtimeCoreCompatDetails,
+    /**
+     * The features supported by the Runtime layer across the Runtime / Loader boundary.
+     */
+    supportedFeatures: new Set(),
+};
+/**
+ * The requirements that the Loader layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export const loaderSupportRequirements = {
+    /**
+     * Minimum generation that Loader must be at to be compatible with Runtime. Note that 0 is used here so
+     * that Loader layers before the introduction of the layer compatibility enforcement are compatible.
+     */
+    minSupportedGeneration: 0,
+    /**
+     * The features that the Loader must support to be compatible with Runtime.
+     */
+    requiredFeatures: [],
+};
+/**
+ * Runtime's compatibility details that is exposed to the DataStore layer.
+ * @internal
+ */
+export const runtimeCompatDetailsForDataStore = {
+    ...runtimeCoreCompatDetails,
+    /**
+     * The features supported by the Runtime layer across the Runtime / Loader boundary.
+     */
+    supportedFeatures: new Set(),
+};
+/**
+ * The requirements that the DataStore layer must meet to be compatible with this Runtime.
+ * @internal
+ */
+export const dataStoreSupportRequirements = {
+    /**
+     * Minimum generation that DataStore must be at to be compatible with Runtime. Note that 0 is used here so
+     * that DataStore layers before the introduction of the layer compatibility enforcement are compatible.
+     */
+    minSupportedGeneration: 0,
+    /**
+     * The features that the DataStore must support to be compatible with Runtime.
+     */
+    requiredFeatures: [],
+};
+/**
+ * Validates that the Loader layer is compatible with this Runtime.
+ * @internal
+ */
+export function validateLoaderCompatibility(maybeloaderCompatDetailsForRuntime, disposeFn) {
+    const layerCheckResult = checkLayerCompatibility(loaderSupportRequirements, maybeloaderCompatDetailsForRuntime);
+    if (!layerCheckResult.isCompatible) {
+        const error = new UsageError("Runtime is not compatible with Loader", {
+            errorDetails: JSON.stringify({
+                runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
+                loaderVersion: maybeloaderCompatDetailsForRuntime?.pkgVersion,
+                runtimeGeneration: runtimeCoreCompatDetails.generation,
+                loaderGeneration: maybeloaderCompatDetailsForRuntime?.generation,
+                minSupportedGeneration: loaderSupportRequirements.minSupportedGeneration,
+                isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+                unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+            }),
+        });
+        disposeFn(error);
+        throw error;
+    }
+}
+/**
+ * Validates that the DataStore layer is compatible with this Runtime.
+ * @internal
+ */
+export function validateDatastoreCompatibility(maybeDataStoreCompatDetails, disposeFn) {
+    const layerCheckResult = checkLayerCompatibility(dataStoreSupportRequirements, maybeDataStoreCompatDetails);
+    if (!layerCheckResult.isCompatible) {
+        const error = new UsageError("Runtime is not compatible with DataStore", {
+            errorDetails: JSON.stringify({
+                runtimeVersion: runtimeCoreCompatDetails.pkgVersion,
+                dataStoreVersion: maybeDataStoreCompatDetails?.pkgVersion,
+                runtimeGeneration: runtimeCoreCompatDetails.generation,
+                dataStoreGeneration: maybeDataStoreCompatDetails?.generation,
+                minSupportedGeneration: dataStoreSupportRequirements.minSupportedGeneration,
+                isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+                unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+            }),
+        });
+        disposeFn();
+        throw error;
+    }
+}
+//# sourceMappingURL=runtimeLayerCompatState.js.map

package/lib/runtimeLayerCompatState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimeLayerCompatState.js","sourceRoot":"","sources":["../src/runtimeLayerCompatState.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,uBAAuB,GAGvB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEtE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU;IACV;;OAEG;IACH,UAAU,EAAE,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAwB;IACjE,GAAG,wBAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAoC;IACzE;;;OAGG;IACH,sBAAsB,EAAE,CAAC;IACzB;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAwB;IACpE,GAAG,wBAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAoC;IAC5E;;;OAGG;IACH,sBAAsB,EAAE,CAAC;IACzB;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAC1C,kCAAmE,EACnE,SAAoD;IAEpD,MAAM,gBAAgB,GAAG,uBAAuB,CAC/C,yBAAyB,EACzB,kCAAkC,CAClC,CAAC;IACF,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,uCAAuC,EAAE;YACrE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC5B,cAAc,EAAE,wBAAwB,CAAC,UAAU;gBACnD,aAAa,EAAE,kCAAkC,EAAE,UAAU;gBAC7D,iBAAiB,EAAE,wBAAwB,CAAC,UAAU;gBACtD,gBAAgB,EAAE,kCAAkC,EAAE,UAAU;gBAChE,sBAAsB,EAAE,yBAAyB,CAAC,sBAAsB;gBACxE,sBAAsB,EAAE,gBAAgB,CAAC,sBAAsB;gBAC/D,mBAAmB,EAAE,gBAAgB,CAAC,mBAAmB;aACzD,CAAC;SACF,CAAC,CAAC;QACH,SAAS,CAAC,KAAK,CAAC,CAAC;QACjB,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAC7C,2BAA4D,EAC5D,SAAqB;IAErB,MAAM,gBAAgB,GAAG,uBAAuB,CAC/C,4BAA4B,EAC5B,2BAA2B,CAC3B,CAAC;IACF,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,0CAA0C,EAAE;YACxE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC5B,cAAc,EAAE,wBAAwB,CAAC,UAAU;gBACnD,gBAAgB,EAAE,2BAA2B,EAAE,UAAU;gBACzD,iBAAiB,EAAE,wBAAwB,CAAC,UAAU;gBACtD,mBAAmB,EAAE,2BAA2B,EAAE,UAAU;gBAC5D,sBAAsB,EAAE,4BAA4B,CAAC,sBAAsB;gBAC3E,sBAAsB,EAAE,gBAAgB,CAAC,sBAAsB;gBAC/D,mBAAmB,EAAE,gBAAgB,CAAC,mBAAmB;aACzD,CAAC;SACF,CAAC,CAAC;QACH,SAAS,EAAE,CAAC;QACZ,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tcheckLayerCompatibility,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * The core compatibility details of the Runtime layer that is the same across all layer boundaries.\n * @internal\n */\nexport const runtimeCoreCompatDetails = {\n\t/**\n\t * The package version of the Runtime layer.\n\t */\n\tpkgVersion,\n\t/**\n\t * The current generation of the Runtime layer.\n\t */\n\tgeneration: 1,\n};\n\n/**\n * Runtime's compatibility details that is exposed to the Loader layer.\n * @internal\n */\nexport const runtimeCompatDetailsForLoader: ILayerCompatDetails = {\n\t...runtimeCoreCompatDetails,\n\t/**\n\t * The features supported by the Runtime layer across the Runtime / Loader boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * The requirements that the Loader layer must meet to be compatible with this Runtime.\n * @internal\n */\nexport const loaderSupportRequirements: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Loader must be at to be compatible with Runtime. Note that 0 is used here so\n\t * that Loader layers before the introduction of the layer compatibility enforcement are compatible.\n\t */\n\tminSupportedGeneration: 0,\n\t/**\n\t * The features that the Loader must support to be compatible with Runtime.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * Runtime's compatibility details that is exposed to the DataStore layer.\n * @internal\n */\nexport const runtimeCompatDetailsForDataStore: ILayerCompatDetails = {\n\t...runtimeCoreCompatDetails,\n\t/**\n\t * The features supported by the Runtime layer across the Runtime / Loader boundary.\n\t */\n\tsupportedFeatures: new Set<string>(),\n};\n\n/**\n * The requirements that the DataStore layer must meet to be compatible with this Runtime.\n * @internal\n */\nexport const dataStoreSupportRequirements: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that DataStore must be at to be compatible with Runtime. Note that 0 is used here so\n\t * that DataStore layers before the introduction of the layer compatibility enforcement are compatible.\n\t */\n\tminSupportedGeneration: 0,\n\t/**\n\t * The features that the DataStore must support to be compatible with Runtime.\n\t */\n\trequiredFeatures: [],\n};\n\n/**\n * Validates that the Loader layer is compatible with this Runtime.\n * @internal\n */\nexport function validateLoaderCompatibility(\n\tmaybeloaderCompatDetailsForRuntime: ILayerCompatDetails | undefined,\n\tdisposeFn: (error?: ICriticalContainerError) => void,\n): void {\n\tconst layerCheckResult = checkLayerCompatibility(\n\t\tloaderSupportRequirements,\n\t\tmaybeloaderCompatDetailsForRuntime,\n\t);\n\tif (!layerCheckResult.isCompatible) {\n\t\tconst error = new UsageError(\"Runtime is not compatible with Loader\", {\n\t\t\terrorDetails: JSON.stringify({\n\t\t\t\truntimeVersion: runtimeCoreCompatDetails.pkgVersion,\n\t\t\t\tloaderVersion: maybeloaderCompatDetailsForRuntime?.pkgVersion,\n\t\t\t\truntimeGeneration: runtimeCoreCompatDetails.generation,\n\t\t\t\tloaderGeneration: maybeloaderCompatDetailsForRuntime?.generation,\n\t\t\t\tminSupportedGeneration: loaderSupportRequirements.minSupportedGeneration,\n\t\t\t\tisGenerationCompatible: layerCheckResult.isGenerationCompatible,\n\t\t\t\tunsupportedFeatures: layerCheckResult.unsupportedFeatures,\n\t\t\t}),\n\t\t});\n\t\tdisposeFn(error);\n\t\tthrow error;\n\t}\n}\n\n/**\n * Validates that the DataStore layer is compatible with this Runtime.\n * @internal\n */\nexport function validateDatastoreCompatibility(\n\tmaybeDataStoreCompatDetails: ILayerCompatDetails | undefined,\n\tdisposeFn: () => void,\n): void {\n\tconst layerCheckResult = checkLayerCompatibility(\n\t\tdataStoreSupportRequirements,\n\t\tmaybeDataStoreCompatDetails,\n\t);\n\tif (!layerCheckResult.isCompatible) {\n\t\tconst error = new UsageError(\"Runtime is not compatible with DataStore\", {\n\t\t\terrorDetails: JSON.stringify({\n\t\t\t\truntimeVersion: runtimeCoreCompatDetails.pkgVersion,\n\t\t\t\tdataStoreVersion: maybeDataStoreCompatDetails?.pkgVersion,\n\t\t\t\truntimeGeneration: runtimeCoreCompatDetails.generation,\n\t\t\t\tdataStoreGeneration: maybeDataStoreCompatDetails?.generation,\n\t\t\t\tminSupportedGeneration: dataStoreSupportRequirements.minSupportedGeneration,\n\t\t\t\tisGenerationCompatible: layerCheckResult.isGenerationCompatible,\n\t\t\t\tunsupportedFeatures: layerCheckResult.unsupportedFeatures,\n\t\t\t}),\n\t\t});\n\t\tdisposeFn();\n\t\tthrow error;\n\t}\n}\n"]}

package/lib/signalTelemetryProcessing.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ISignalEnvelope } from "@fluidframework/core-interfaces/internal";
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+export declare class SignalTelemetryManager {
+    private readonly signalTracking;
+    /**
+     * Identifier to track broadcast signals being submitted in order to
+     * allow collection of data around the roundtrip of signal messages.
+     */
+    private broadcastSignalSequenceNumber;
+    /**
+     * Resets the signal tracking state in the {@link SignalTelemetryManager}.
+     */
+    resetTracking(): void;
+    /**
+     * Perform telemetry-related processing of incoming signals.
+     * @param envelope - The signal envelope to process.
+     * @param logger - The telemetry logger to use for emitting telemetry events.
+     * @param consecutiveReconnects - The number of consecutive reconnects that have occurred. Only used for logging.
+     */
+    trackReceivedSignal(envelope: ISignalEnvelope, logger: ITelemetryLoggerExt, consecutiveReconnects: number): void;
+    /**
+     * Updates tracking state for broadcast signals based on the provided signal envelope, and updates the
+     * envelope with additional information that the signal needs to have stamped on it.
+     * @remarks Do not call this for non-broadcast signals.
+     * @param envelope - The signal envelope to process.
+     */
+    applyTrackingToBroadcastSignalEnvelope(envelope: ISignalEnvelope): void;
+}
+//# sourceMappingURL=signalTelemetryProcessing.d.ts.map

package/lib/signalTelemetryProcessing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signalTelemetryProcessing.d.ts","sourceRoot":"","sources":["../src/signalTelemetryProcessing.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,KAAK,EACX,mBAAmB,EAEnB,MAAM,0CAA0C,CAAC;AAsDlD,qBAAa,sBAAsB;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAS7B;IAEF;;;OAGG;IACH,OAAO,CAAC,6BAA6B,CAAa;IAElD;;OAEG;IACI,aAAa,IAAI,IAAI;IAW5B;;;;;OAKG;IACI,mBAAmB,CACzB,QAAQ,EAAE,eAAe,EACzB,MAAM,EAAE,mBAAmB,EAC3B,qBAAqB,EAAE,MAAM,GAC3B,IAAI;IA2FP;;;;;OAKG;IACI,sCAAsC,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;CA8B9E"}

package/lib/signalTelemetryProcessing.js

@@ -0,0 +1,145 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const defaultTelemetrySignalSampleCount = 100;
+export class SignalTelemetryManager {
+    constructor() {
+        this.signalTracking = {
+            totalSignalsSentInLatencyWindow: 0,
+            signalsLost: 0,
+            signalsOutOfOrder: 0,
+            signalsSentSinceLastLatencyMeasurement: 0,
+            signalTimestamp: 0,
+            roundTripSignalSequenceNumber: undefined,
+            trackingSignalSequenceNumber: undefined,
+            minimumTrackingSignalSequenceNumber: undefined,
+        };
+        /**
+         * Identifier to track broadcast signals being submitted in order to
+         * allow collection of data around the roundtrip of signal messages.
+         */
+        this.broadcastSignalSequenceNumber = 0;
+    }
+    /**
+     * Resets the signal tracking state in the {@link SignalTelemetryManager}.
+     */
+    resetTracking() {
+        this.signalTracking.signalsLost = 0;
+        this.signalTracking.signalsOutOfOrder = 0;
+        this.signalTracking.signalTimestamp = 0;
+        this.signalTracking.signalsSentSinceLastLatencyMeasurement = 0;
+        this.signalTracking.totalSignalsSentInLatencyWindow = 0;
+        this.signalTracking.roundTripSignalSequenceNumber = undefined;
+        this.signalTracking.trackingSignalSequenceNumber = undefined;
+        this.signalTracking.minimumTrackingSignalSequenceNumber = undefined;
+    }
+    /**
+     * Perform telemetry-related processing of incoming signals.
+     * @param envelope - The signal envelope to process.
+     * @param logger - The telemetry logger to use for emitting telemetry events.
+     * @param consecutiveReconnects - The number of consecutive reconnects that have occurred. Only used for logging.
+     */
+    trackReceivedSignal(envelope, logger, consecutiveReconnects) {
+        const { clientBroadcastSignalSequenceNumber, contents: envelopeContents, address: envelopeAddress, } = envelope;
+        if (clientBroadcastSignalSequenceNumber === undefined) {
+            return undefined;
+        }
+        // If no tracking window has been set, nothing to do
+        if (this.signalTracking.trackingSignalSequenceNumber === undefined ||
+            this.signalTracking.minimumTrackingSignalSequenceNumber === undefined) {
+            return undefined;
+        }
+        if (clientBroadcastSignalSequenceNumber >= this.signalTracking.trackingSignalSequenceNumber) {
+            // Calculate the number of signals lost and log the event.
+            const signalsLost = clientBroadcastSignalSequenceNumber - this.signalTracking.trackingSignalSequenceNumber;
+            if (signalsLost > 0) {
+                this.signalTracking.signalsLost += signalsLost;
+                logger.sendErrorEvent({
+                    eventName: "SignalLost",
+                    details: {
+                        signalsLost, // Number of lost signals detected.
+                        expectedSequenceNumber: this.signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+                        clientBroadcastSignalSequenceNumber, // Actual signal sequence number received.
+                    },
+                });
+            }
+            // Update the tracking signal sequence number to the next expected signal in the sequence.
+            this.signalTracking.trackingSignalSequenceNumber =
+                clientBroadcastSignalSequenceNumber + 1;
+        }
+        else if (
+        // Check if this is a signal in range of interest.
+        clientBroadcastSignalSequenceNumber >=
+            this.signalTracking.minimumTrackingSignalSequenceNumber) {
+            this.signalTracking.signalsOutOfOrder++;
+            const details = {
+                expectedSequenceNumber: this.signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.
+                clientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.
+            };
+            // Only log `contents.type` when address is for container to avoid chance that contents type is customer data.
+            if (envelopeAddress === undefined) {
+                details.contentsType = envelopeContents.type; // Type of signal that was received out of order.
+            }
+            logger.sendTelemetryEvent({
+                eventName: "SignalOutOfOrder",
+                details,
+            });
+        }
+        if (this.signalTracking.roundTripSignalSequenceNumber !== undefined &&
+            clientBroadcastSignalSequenceNumber >= this.signalTracking.roundTripSignalSequenceNumber) {
+            if (clientBroadcastSignalSequenceNumber ===
+                this.signalTracking.roundTripSignalSequenceNumber) {
+                // Latency tracked signal has been received.
+                // We now emit telemetry with the roundtrip duration of the tracked signal.
+                // The telemetry event also includes metrics for broadcast signals (sent, lost, and out of order),
+                // and these metrics are reset after emitting the event.
+                const duration = Date.now() - this.signalTracking.signalTimestamp;
+                logger.sendPerformanceEvent({
+                    eventName: "SignalLatency",
+                    details: {
+                        duration, // Roundtrip duration of the tracked signal in milliseconds.
+                        sent: this.signalTracking.totalSignalsSentInLatencyWindow, // Signals sent since the last logged SignalLatency event.
+                        lost: this.signalTracking.signalsLost, // Signals lost since the last logged SignalLatency event.
+                        outOfOrder: this.signalTracking.signalsOutOfOrder, // Out of order signals since the last logged SignalLatency event.
+                        reconnectCount: consecutiveReconnects, // Container reconnect count.
+                    },
+                });
+                this.signalTracking.signalsLost = 0;
+                this.signalTracking.signalsOutOfOrder = 0;
+                this.signalTracking.signalTimestamp = 0;
+                this.signalTracking.totalSignalsSentInLatencyWindow = 0;
+            }
+            this.signalTracking.roundTripSignalSequenceNumber = undefined;
+        }
+    }
+    /**
+     * Updates tracking state for broadcast signals based on the provided signal envelope, and updates the
+     * envelope with additional information that the signal needs to have stamped on it.
+     * @remarks Do not call this for non-broadcast signals.
+     * @param envelope - The signal envelope to process.
+     */
+    applyTrackingToBroadcastSignalEnvelope(envelope) {
+        const broadcastSignalSequenceNumber = ++this.broadcastSignalSequenceNumber;
+        // Stamp with the broadcast signal sequence number.
+        envelope.clientBroadcastSignalSequenceNumber = broadcastSignalSequenceNumber;
+        this.signalTracking.signalsSentSinceLastLatencyMeasurement++;
+        // If we don't have a signal monitoring window yet,
+        // initialize tracking to expect the next signal sent by the connected client.
+        if (this.signalTracking.minimumTrackingSignalSequenceNumber === undefined ||
+            this.signalTracking.trackingSignalSequenceNumber === undefined) {
+            this.signalTracking.minimumTrackingSignalSequenceNumber = broadcastSignalSequenceNumber;
+            this.signalTracking.trackingSignalSequenceNumber = broadcastSignalSequenceNumber;
+        }
+        // Start tracking roundtrip for a new signal only if we are not tracking one already (and sampling logic is met)
+        if (this.signalTracking.roundTripSignalSequenceNumber === undefined &&
+            broadcastSignalSequenceNumber % defaultTelemetrySignalSampleCount === 1) {
+            this.signalTracking.signalTimestamp = Date.now();
+            this.signalTracking.roundTripSignalSequenceNumber = broadcastSignalSequenceNumber;
+            this.signalTracking.totalSignalsSentInLatencyWindow +=
+                this.signalTracking.signalsSentSinceLastLatencyMeasurement;
+            this.signalTracking.signalsSentSinceLastLatencyMeasurement = 0;
+        }
+    }
+}
+//# sourceMappingURL=signalTelemetryProcessing.js.map

package/lib/signalTelemetryProcessing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signalTelemetryProcessing.js","sourceRoot":"","sources":["../src/signalTelemetryProcessing.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,MAAM,iCAAiC,GAAG,GAAG,CAAC;AAoD9C,MAAM,OAAO,sBAAsB;IAAnC;QACkB,mBAAc,GAA6B;YAC3D,+BAA+B,EAAE,CAAC;YAClC,WAAW,EAAE,CAAC;YACd,iBAAiB,EAAE,CAAC;YACpB,sCAAsC,EAAE,CAAC;YACzC,eAAe,EAAE,CAAC;YAClB,6BAA6B,EAAE,SAAS;YACxC,4BAA4B,EAAE,SAAS;YACvC,mCAAmC,EAAE,SAAS;SAC9C,CAAC;QAEF;;;WAGG;QACK,kCAA6B,GAAW,CAAC,CAAC;IAyJnD,CAAC;IAvJA;;OAEG;IACI,aAAa;QACnB,IAAI,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,CAAC,iBAAiB,GAAG,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,CAAC,eAAe,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,cAAc,CAAC,sCAAsC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,CAAC,+BAA+B,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,CAAC,6BAA6B,GAAG,SAAS,CAAC;QAC9D,IAAI,CAAC,cAAc,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAC7D,IAAI,CAAC,cAAc,CAAC,mCAAmC,GAAG,SAAS,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,mBAAmB,CACzB,QAAyB,EACzB,MAA2B,EAC3B,qBAA6B;QAE7B,MAAM,EACL,mCAAmC,EACnC,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,eAAe,GACxB,GAAG,QAAQ,CAAC;QAEb,IAAI,mCAAmC,KAAK,SAAS,EAAE,CAAC;YACvD,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,oDAAoD;QACpD,IACC,IAAI,CAAC,cAAc,CAAC,4BAA4B,KAAK,SAAS;YAC9D,IAAI,CAAC,cAAc,CAAC,mCAAmC,KAAK,SAAS,EACpE,CAAC;YACF,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,IACC,mCAAmC,IAAI,IAAI,CAAC,cAAc,CAAC,4BAA4B,EACtF,CAAC;YACF,0DAA0D;YAC1D,MAAM,WAAW,GAChB,mCAAmC,GAAG,IAAI,CAAC,cAAc,CAAC,4BAA4B,CAAC;YACxF,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;gBACrB,IAAI,CAAC,cAAc,CAAC,WAAW,IAAI,WAAW,CAAC;gBAC/C,MAAM,CAAC,cAAc,CAAC;oBACrB,SAAS,EAAE,YAAY;oBACvB,OAAO,EAAE;wBACR,WAAW,EAAE,mCAAmC;wBAChD,sBAAsB,EAAE,IAAI,CAAC,cAAc,CAAC,4BAA4B,EAAE,4CAA4C;wBACtH,mCAAmC,EAAE,0CAA0C;qBAC/E;iBACD,CAAC,CAAC;YACJ,CAAC;YACD,0FAA0F;YAC1F,IAAI,CAAC,cAAc,CAAC,4BAA4B;gBAC/C,mCAAmC,GAAG,CAAC,CAAC;QAC1C,CAAC;aAAM;QACN,kDAAkD;QAClD,mCAAmC;YACnC,IAAI,CAAC,cAAc,CAAC,mCAAmC,EACtD,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;YACxC,MAAM,OAAO,GAAkC;gBAC9C,sBAAsB,EAAE,IAAI,CAAC,cAAc,CAAC,4BAA4B,EAAE,4CAA4C;gBACtH,mCAAmC,EAAE,8CAA8C;aACnF,CAAC;YACF,8GAA8G;YAC9G,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;gBACnC,OAAO,CAAC,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,iDAAiD;YAChG,CAAC;YACD,MAAM,CAAC,kBAAkB,CAAC;gBACzB,SAAS,EAAE,kBAAkB;gBAC7B,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;QAED,IACC,IAAI,CAAC,cAAc,CAAC,6BAA6B,KAAK,SAAS;YAC/D,mCAAmC,IAAI,IAAI,CAAC,cAAc,CAAC,6BAA6B,EACvF,CAAC;YACF,IACC,mCAAmC;gBACnC,IAAI,CAAC,cAAc,CAAC,6BAA6B,EAChD,CAAC;gBACF,4CAA4C;gBAC5C,2EAA2E;gBAC3E,kGAAkG;gBAClG,wDAAwD;gBACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC;gBAClE,MAAM,CAAC,oBAAoB,CAAC;oBAC3B,SAAS,EAAE,eAAe;oBAC1B,OAAO,EAAE;wBACR,QAAQ,EAAE,4DAA4D;wBACtE,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,+BAA+B,EAAE,0DAA0D;wBACrH,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,0DAA0D;wBACjG,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,kEAAkE;wBACrH,cAAc,EAAE,qBAAqB,EAAE,6BAA6B;qBACpE;iBACD,CAAC,CAAC;gBACH,IAAI,CAAC,cAAc,CAAC,WAAW,GAAG,CAAC,CAAC;gBACpC,IAAI,CAAC,cAAc,CAAC,iBAAiB,GAAG,CAAC,CAAC;gBAC1C,IAAI,CAAC,cAAc,CAAC,eAAe,GAAG,CAAC,CAAC;gBACxC,IAAI,CAAC,cAAc,CAAC,+BAA+B,GAAG,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,6BAA6B,GAAG,SAAS,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,sCAAsC,CAAC,QAAyB;QACtE,MAAM,6BAA6B,GAAG,EAAE,IAAI,CAAC,6BAA6B,CAAC;QAE3E,mDAAmD;QACnD,QAAQ,CAAC,mCAAmC,GAAG,6BAA6B,CAAC;QAE7E,IAAI,CAAC,cAAc,CAAC,sCAAsC,EAAE,CAAC;QAE7D,mDAAmD;QACnD,8EAA8E;QAC9E,IACC,IAAI,CAAC,cAAc,CAAC,mCAAmC,KAAK,SAAS;YACrE,IAAI,CAAC,cAAc,CAAC,4BAA4B,KAAK,SAAS,EAC7D,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,mCAAmC,GAAG,6BAA6B,CAAC;YACxF,IAAI,CAAC,cAAc,CAAC,4BAA4B,GAAG,6BAA6B,CAAC;QAClF,CAAC;QAED,gHAAgH;QAChH,IACC,IAAI,CAAC,cAAc,CAAC,6BAA6B,KAAK,SAAS;YAC/D,6BAA6B,GAAG,iCAAiC,KAAK,CAAC,EACtE,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjD,IAAI,CAAC,cAAc,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;YAClF,IAAI,CAAC,cAAc,CAAC,+BAA+B;gBAClD,IAAI,CAAC,cAAc,CAAC,sCAAsC,CAAC;YAC5D,IAAI,CAAC,cAAc,CAAC,sCAAsC,GAAG,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISignalEnvelope } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITelemetryLoggerExt,\n\tTelemetryEventPropertyTypeExt,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nconst defaultTelemetrySignalSampleCount = 100;\n\n/**\n * Set of stats/values used to keep track of telemetry related to signals.\n */\ninterface ISignalTelemetryTracking {\n\t/**\n\t * Accumulates the total number of broadcast signals sent during the current signal latency measurement window.\n\t * This value represents the total number of signals sent since the latency measurement began and is used\n\t * logged in telemetry when the latency measurement completes.\n\t */\n\ttotalSignalsSentInLatencyWindow: number;\n\n\t/**\n\t * Counts the number of broadcast signals sent since the last latency measurement was initiated.\n\t * This counter increments with each broadcast signal sent. When a new latency measurement starts,\n\t * this counter is added to `totalSignalsSentInLatencyWindow` and then reset to zero.\n\t */\n\tsignalsSentSinceLastLatencyMeasurement: number;\n\n\t/**\n\t * Number of signals that were expected but not received.\n\t */\n\tsignalsLost: number;\n\n\t/**\n\t * Number of signals received out of order/non-sequentially.\n\t */\n\tsignalsOutOfOrder: number;\n\n\t/**\n\t * Timestamp before submitting the signal we will trace.\n\t */\n\tsignalTimestamp: number;\n\n\t/**\n\t * Signal we will trace for roundtrip latency.\n\t */\n\troundTripSignalSequenceNumber: number | undefined;\n\n\t/**\n\t * Next expected signal sequence number to be received.\n\t */\n\ttrackingSignalSequenceNumber: number | undefined;\n\n\t/**\n\t * Inclusive lower bound of signal monitoring window.\n\t * Used by the logic that checks if signals are received out of order.\n\t */\n\tminimumTrackingSignalSequenceNumber: number | undefined;\n}\n\nexport class SignalTelemetryManager {\n\tprivate readonly signalTracking: ISignalTelemetryTracking = {\n\t\ttotalSignalsSentInLatencyWindow: 0,\n\t\tsignalsLost: 0,\n\t\tsignalsOutOfOrder: 0,\n\t\tsignalsSentSinceLastLatencyMeasurement: 0,\n\t\tsignalTimestamp: 0,\n\t\troundTripSignalSequenceNumber: undefined,\n\t\ttrackingSignalSequenceNumber: undefined,\n\t\tminimumTrackingSignalSequenceNumber: undefined,\n\t};\n\n\t/**\n\t * Identifier to track broadcast signals being submitted in order to\n\t * allow collection of data around the roundtrip of signal messages.\n\t */\n\tprivate broadcastSignalSequenceNumber: number = 0;\n\n\t/**\n\t * Resets the signal tracking state in the {@link SignalTelemetryManager}.\n\t */\n\tpublic resetTracking(): void {\n\t\tthis.signalTracking.signalsLost = 0;\n\t\tthis.signalTracking.signalsOutOfOrder = 0;\n\t\tthis.signalTracking.signalTimestamp = 0;\n\t\tthis.signalTracking.signalsSentSinceLastLatencyMeasurement = 0;\n\t\tthis.signalTracking.totalSignalsSentInLatencyWindow = 0;\n\t\tthis.signalTracking.roundTripSignalSequenceNumber = undefined;\n\t\tthis.signalTracking.trackingSignalSequenceNumber = undefined;\n\t\tthis.signalTracking.minimumTrackingSignalSequenceNumber = undefined;\n\t}\n\n\t/**\n\t * Perform telemetry-related processing of incoming signals.\n\t * @param envelope - The signal envelope to process.\n\t * @param logger - The telemetry logger to use for emitting telemetry events.\n\t * @param consecutiveReconnects - The number of consecutive reconnects that have occurred. Only used for logging.\n\t */\n\tpublic trackReceivedSignal(\n\t\tenvelope: ISignalEnvelope,\n\t\tlogger: ITelemetryLoggerExt,\n\t\tconsecutiveReconnects: number,\n\t): void {\n\t\tconst {\n\t\t\tclientBroadcastSignalSequenceNumber,\n\t\t\tcontents: envelopeContents,\n\t\t\taddress: envelopeAddress,\n\t\t} = envelope;\n\n\t\tif (clientBroadcastSignalSequenceNumber === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\t// If no tracking window has been set, nothing to do\n\t\tif (\n\t\t\tthis.signalTracking.trackingSignalSequenceNumber === undefined ||\n\t\t\tthis.signalTracking.minimumTrackingSignalSequenceNumber === undefined\n\t\t) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tif (\n\t\t\tclientBroadcastSignalSequenceNumber >= this.signalTracking.trackingSignalSequenceNumber\n\t\t) {\n\t\t\t// Calculate the number of signals lost and log the event.\n\t\t\tconst signalsLost =\n\t\t\t\tclientBroadcastSignalSequenceNumber - this.signalTracking.trackingSignalSequenceNumber;\n\t\t\tif (signalsLost > 0) {\n\t\t\t\tthis.signalTracking.signalsLost += signalsLost;\n\t\t\t\tlogger.sendErrorEvent({\n\t\t\t\t\teventName: \"SignalLost\",\n\t\t\t\t\tdetails: {\n\t\t\t\t\t\tsignalsLost, // Number of lost signals detected.\n\t\t\t\t\t\texpectedSequenceNumber: this.signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.\n\t\t\t\t\t\tclientBroadcastSignalSequenceNumber, // Actual signal sequence number received.\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t}\n\t\t\t// Update the tracking signal sequence number to the next expected signal in the sequence.\n\t\t\tthis.signalTracking.trackingSignalSequenceNumber =\n\t\t\t\tclientBroadcastSignalSequenceNumber + 1;\n\t\t} else if (\n\t\t\t// Check if this is a signal in range of interest.\n\t\t\tclientBroadcastSignalSequenceNumber >=\n\t\t\tthis.signalTracking.minimumTrackingSignalSequenceNumber\n\t\t) {\n\t\t\tthis.signalTracking.signalsOutOfOrder++;\n\t\t\tconst details: TelemetryEventPropertyTypeExt = {\n\t\t\t\texpectedSequenceNumber: this.signalTracking.trackingSignalSequenceNumber, // The next expected signal sequence number.\n\t\t\t\tclientBroadcastSignalSequenceNumber, // Sequence number of the out of order signal.\n\t\t\t};\n\t\t\t// Only log `contents.type` when address is for container to avoid chance that contents type is customer data.\n\t\t\tif (envelopeAddress === undefined) {\n\t\t\t\tdetails.contentsType = envelopeContents.type; // Type of signal that was received out of order.\n\t\t\t}\n\t\t\tlogger.sendTelemetryEvent({\n\t\t\t\teventName: \"SignalOutOfOrder\",\n\t\t\t\tdetails,\n\t\t\t});\n\t\t}\n\n\t\tif (\n\t\t\tthis.signalTracking.roundTripSignalSequenceNumber !== undefined &&\n\t\t\tclientBroadcastSignalSequenceNumber >= this.signalTracking.roundTripSignalSequenceNumber\n\t\t) {\n\t\t\tif (\n\t\t\t\tclientBroadcastSignalSequenceNumber ===\n\t\t\t\tthis.signalTracking.roundTripSignalSequenceNumber\n\t\t\t) {\n\t\t\t\t// Latency tracked signal has been received.\n\t\t\t\t// We now emit telemetry with the roundtrip duration of the tracked signal.\n\t\t\t\t// The telemetry event also includes metrics for broadcast signals (sent, lost, and out of order),\n\t\t\t\t// and these metrics are reset after emitting the event.\n\t\t\t\tconst duration = Date.now() - this.signalTracking.signalTimestamp;\n\t\t\t\tlogger.sendPerformanceEvent({\n\t\t\t\t\teventName: \"SignalLatency\",\n\t\t\t\t\tdetails: {\n\t\t\t\t\t\tduration, // Roundtrip duration of the tracked signal in milliseconds.\n\t\t\t\t\t\tsent: this.signalTracking.totalSignalsSentInLatencyWindow, // Signals sent since the last logged SignalLatency event.\n\t\t\t\t\t\tlost: this.signalTracking.signalsLost, // Signals lost since the last logged SignalLatency event.\n\t\t\t\t\t\toutOfOrder: this.signalTracking.signalsOutOfOrder, // Out of order signals since the last logged SignalLatency event.\n\t\t\t\t\t\treconnectCount: consecutiveReconnects, // Container reconnect count.\n\t\t\t\t\t},\n\t\t\t\t});\n\t\t\t\tthis.signalTracking.signalsLost = 0;\n\t\t\t\tthis.signalTracking.signalsOutOfOrder = 0;\n\t\t\t\tthis.signalTracking.signalTimestamp = 0;\n\t\t\t\tthis.signalTracking.totalSignalsSentInLatencyWindow = 0;\n\t\t\t}\n\t\t\tthis.signalTracking.roundTripSignalSequenceNumber = undefined;\n\t\t}\n\t}\n\n\t/**\n\t * Updates tracking state for broadcast signals based on the provided signal envelope, and updates the\n\t * envelope with additional information that the signal needs to have stamped on it.\n\t * @remarks Do not call this for non-broadcast signals.\n\t * @param envelope - The signal envelope to process.\n\t */\n\tpublic applyTrackingToBroadcastSignalEnvelope(envelope: ISignalEnvelope): void {\n\t\tconst broadcastSignalSequenceNumber = ++this.broadcastSignalSequenceNumber;\n\n\t\t// Stamp with the broadcast signal sequence number.\n\t\tenvelope.clientBroadcastSignalSequenceNumber = broadcastSignalSequenceNumber;\n\n\t\tthis.signalTracking.signalsSentSinceLastLatencyMeasurement++;\n\n\t\t// If we don't have a signal monitoring window yet,\n\t\t// initialize tracking to expect the next signal sent by the connected client.\n\t\tif (\n\t\t\tthis.signalTracking.minimumTrackingSignalSequenceNumber === undefined ||\n\t\t\tthis.signalTracking.trackingSignalSequenceNumber === undefined\n\t\t) {\n\t\t\tthis.signalTracking.minimumTrackingSignalSequenceNumber = broadcastSignalSequenceNumber;\n\t\t\tthis.signalTracking.trackingSignalSequenceNumber = broadcastSignalSequenceNumber;\n\t\t}\n\n\t\t// Start tracking roundtrip for a new signal only if we are not tracking one already (and sampling logic is met)\n\t\tif (\n\t\t\tthis.signalTracking.roundTripSignalSequenceNumber === undefined &&\n\t\t\tbroadcastSignalSequenceNumber % defaultTelemetrySignalSampleCount === 1\n\t\t) {\n\t\t\tthis.signalTracking.signalTimestamp = Date.now();\n\t\t\tthis.signalTracking.roundTripSignalSequenceNumber = broadcastSignalSequenceNumber;\n\t\t\tthis.signalTracking.totalSignalsSentInLatencyWindow +=\n\t\t\t\tthis.signalTracking.signalsSentSinceLastLatencyMeasurement;\n\t\t\tthis.signalTracking.signalsSentSinceLastLatencyMeasurement = 0;\n\t\t}\n\t}\n}\n"]}

package/lib/summary/documentSchema.d.ts

@@ -7,9 +7,7 @@
  * Please note that for all property types we should use undefined to indicate that particular capability is off.
  * Using false, or some string value (like "off") will result in clients who do not understand that property failing, whereas
  * we want them to continue to collaborate alongside clients who support that capability, but such capability is shipping dark for now.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export type DocumentSchemaValueType = string | string[] | true | number | undefined;
 /**
@@ -50,9 +48,7 @@ export type IdCompressorMode = "on" | "delayed" | undefined;
  *
  * For now we are limiting it to just plain properties, and only really simple types, but that can be changed in the future.
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export interface IDocumentSchema {
     version: number;
@@ -65,9 +61,7 @@ export interface IDocumentSchema {
  * ContainerMessageType.DocumentSchemaChange messages use CAS (Compare-and-swap) semantics, and convey
  * regSeq of last known schema change (known to a client proposing schema change).
  * @see ContainerRuntimeDocumentSchemaMessage
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export type IDocumentSchemaChangeMessage = IDocumentSchema;
 /**
@@ -76,9 +70,7 @@ export type IDocumentSchemaChangeMessage = IDocumentSchema;
  * WARNING: This type is used to infer IDocumentSchemaCurrent type!
  * Any changes here (including renaming of properties) are potentially changing document format and should be considered carefully!
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export interface IDocumentSchemaFeatures {
     explicitSchemaControl: boolean;
@@ -102,16 +94,12 @@ export interface IDocumentSchemaFeatures {
  * This must be bumped whenever the format of document schema or protocol for changing the current document schema changes.
  * Ex: adding a new configuration property (under IDocumentSchema.runtime) does not require changing this version.
  * Ex: Changing the 'document schema acceptance' mechanism from convert-and-swap to one requiring consensus does require changing this version.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export declare const currentDocumentVersionSchema = 1;
 /**
  * Current document schema.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export type IDocumentSchemaCurrent = {
     version: 1;
@@ -183,9 +171,7 @@ export type IDocumentSchemaCurrent = {
  * Clients can retry, but current implementation is simply - they will not (and will rely on next session / reload to do
  * recalc and decide if schema needs to be changed or not).
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  * @sealed
  */
 export declare class DocumentsSchemaController {
@@ -213,16 +199,6 @@ export declare class DocumentsSchemaController {
      */
     maybeSendSchemaMessage(): IDocumentSchemaChangeMessage | undefined;
     private validateSeqNumber;
-    /**
-     * Process document schema change message
-     * Called by ContainerRuntime whenever it sees document schema messages.
-     * @param content - content of the message
-     * @param local - whether op is local
-     * @param sequenceNumber - sequence number of the op
-     * @returns - true if schema was accepted, otherwise false (rejected due to failed CAS)
-     * @deprecated It has been replaced by processDocumentSchemaMessages instead.
-     */
-    processDocumentSchemaOp(content: IDocumentSchemaChangeMessage, local: boolean, sequenceNumber: number): boolean;
     /**
      * Process document schema change messages
      * Called by ContainerRuntime whenever it sees document schema messages.

package/lib/summary/documentSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documentSchema.d.ts","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;AAEpF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,eAAe;IAI/B,OAAO,EAAE,MAAM,CAAC;IAGhB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;CACjD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,4BAA4B,GAAG,eAAe,CAAC;AAE3D;;;;;;;;;GASG;AACH,MAAM,WAAW,uBAAuB;IAIvC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;;;;;;;OASG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C;;;;;GAKG;AAEH,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE;SACP,CAAC,IAAI,MAAM,uBAAuB,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,SAAS,OAAO,GAC9E,IAAI,GACJ,uBAAuB,CAAC,CAAC,CAAC;KAC7B,CAAC;CACF,CAAC;AAyOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,qBAAa,yBAAyB;IAiCpC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAhChC,OAAO,CAAC,qBAAqB,CAAU;IACvC,OAAO,CAAC,MAAM,CAAQ;IAGtB,OAAO,CAAC,cAAc,CAAyB;IAI/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;IAGvD,OAAO,CAAC,YAAY,CAAqC;IAOlD,aAAa,EAAE,sBAAsB,CAAC;IAE7C;;;;;;OAMG;gBAEF,QAAQ,EAAE,OAAO,EACjB,sBAAsB,EAAE,MAAM,EAC9B,sBAAsB,EAAE,eAAe,GAAG,SAAS,EACnD,QAAQ,EAAE,uBAAuB,EAChB,cAAc,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI;IA0EnE,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAsBlF;;;;;OAKG;IACI,sBAAsB,IAAI,4BAA4B,GAAG,SAAS;IAczE,OAAO,CAAC,iBAAiB;IAmBzB;;;;;;;;OAQG;IACI,uBAAuB,CAC7B,OAAO,EAAE,4BAA4B,EACrC,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,MAAM,GACpB,OAAO;IAIV;;;;;;;OAOG;IACI,6BAA6B,CACnC,QAAQ,EAAE,4BAA4B,EAAE,EACxC,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,MAAM,GACpB,OAAO;IAgDH,YAAY,IAAI,IAAI;CAG3B"}
+{"version":3,"file":"documentSchema.d.ts","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;AAEpF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe;IAI/B,OAAO,EAAE,MAAM,CAAC;IAGhB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;CACjD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG,eAAe,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IAIvC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;;;;;;;;OASG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C;;;GAGG;AAEH,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE;SACP,CAAC,IAAI,MAAM,uBAAuB,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,SAAS,OAAO,GAC9E,IAAI,GACJ,uBAAuB,CAAC,CAAC,CAAC;KAC7B,CAAC;CACF,CAAC;AAyOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,qBAAa,yBAAyB;IAiCpC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAhChC,OAAO,CAAC,qBAAqB,CAAU;IACvC,OAAO,CAAC,MAAM,CAAQ;IAGtB,OAAO,CAAC,cAAc,CAAyB;IAI/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;IAGvD,OAAO,CAAC,YAAY,CAAqC;IAOlD,aAAa,EAAE,sBAAsB,CAAC;IAE7C;;;;;;OAMG;gBAEF,QAAQ,EAAE,OAAO,EACjB,sBAAsB,EAAE,MAAM,EAC9B,sBAAsB,EAAE,eAAe,GAAG,SAAS,EACnD,QAAQ,EAAE,uBAAuB,EAChB,cAAc,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI;IA0EnE,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAsBlF;;;;;OAKG;IACI,sBAAsB,IAAI,4BAA4B,GAAG,SAAS;IAczE,OAAO,CAAC,iBAAiB;IAmBzB;;;;;;;OAOG;IACI,6BAA6B,CACnC,QAAQ,EAAE,4BAA4B,EAAE,EACxC,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,MAAM,GACpB,OAAO;IAgDH,YAAY,IAAI,IAAI;CAG3B"}

package/lib/summary/documentSchema.js

@@ -10,9 +10,7 @@ import { pkgVersion } from "../packageVersion.js";
  * This must be bumped whenever the format of document schema or protocol for changing the current document schema changes.
  * Ex: adding a new configuration property (under IDocumentSchema.runtime) does not require changing this version.
  * Ex: Changing the 'document schema acceptance' mechanism from convert-and-swap to one requiring consensus does require changing this version.
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  */
 export const currentDocumentVersionSchema = 1;
 class TrueOrUndefined {
@@ -245,9 +243,7 @@ function arrayToProp(arr) {
  * Clients can retry, but current implementation is simply - they will not (and will rely on next session / reload to do
  * recalc and decide if schema needs to be changed or not).
  *
- * @legacy
- * @alpha
- * @deprecated This type will be moved to internal in 2.30. External usage is not necessary or supported.
+ * @internal
  * @sealed
  */
 export class DocumentsSchemaController {
@@ -362,18 +358,6 @@ export class DocumentsSchemaController {
             });
         }
     }
-    /**
-     * Process document schema change message
-     * Called by ContainerRuntime whenever it sees document schema messages.
-     * @param content - content of the message
-     * @param local - whether op is local
-     * @param sequenceNumber - sequence number of the op
-     * @returns - true if schema was accepted, otherwise false (rejected due to failed CAS)
-     * @deprecated It has been replaced by processDocumentSchemaMessages instead.
-     */
-    processDocumentSchemaOp(content, local, sequenceNumber) {
-        return this.processDocumentSchemaMessages([content], local, sequenceNumber);
-    }
     /**
      * Process document schema change messages
      * Called by ContainerRuntime whenever it sees document schema messages.