@fluidframework/container-runtime 2.118.1 → 3.0.1

package/dist/runtimeLayerCompatState.js

@@ -4,7 +4,9 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateDatastoreCompatibility = exports.validateLoaderCompatibility = exports.dataStoreSupportRequirementsForRuntime = exports.runtimeCompatDetailsForDataStore = exports.loaderSupportRequirementsForRuntime = exports.runtimeCompatDetailsForLoader = exports.runtimeCoreCompatDetails = exports.disableStrictLoaderLayerCompatibilityCheckKey = void 0;
+exports.dataStoreSupportRequirementsForRuntime = exports.runtimeCompatDetailsForDataStore = exports.loaderSupportRequirementsForRuntime = exports.runtimeCompatDetailsForLoader = exports.runtimeCoreCompatDetails = exports.disableStrictLoaderLayerCompatibilityCheckKey = void 0;
+exports.validateLoaderCompatibility = validateLoaderCompatibility;
+exports.validateDatastoreCompatibility = validateDatastoreCompatibility;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const internal_1 = require("@fluidframework/runtime-definitions/internal");
 const internal_2 = require("@fluidframework/telemetry-utils/internal");
@@ -45,11 +47,12 @@ exports.runtimeCompatDetailsForLoader = {
 exports.loaderSupportRequirementsForRuntime = {
     /**
      * Minimum generation that Loader must be at to be compatible with this Runtime. This is calculated
-     * based on the LayerCompatibilityPolicyWindowMonths.RuntimeLoader value which defines how many months old can
-     * the Loader layer be compared to the Runtime layer for them to still be considered compatible.
+     * based on the LayerCompatibilityPolicyWindowMonths.NewRuntimeOldLoader value which defines how many months
+     * old can the Loader layer be compared to the Runtime layer for them to still be considered compatible.
      * The minimum valid generation value is 0.
      */
-    minSupportedGeneration: Math.max(0, exports.runtimeCoreCompatDetails.generation - client_utils_1.LayerCompatibilityPolicyWindowMonths.RuntimeLoader),
+    minSupportedGeneration: Math.max(0, exports.runtimeCoreCompatDetails.generation -
+        client_utils_1.LayerCompatibilityPolicyWindowMonths.NewRuntimeOldLoader),
     /**
      * The features that the Loader must support to be compatible with Runtime.
      */
@@ -73,12 +76,12 @@ exports.runtimeCompatDetailsForDataStore = {
 exports.dataStoreSupportRequirementsForRuntime = {
     /**
      * Minimum generation that DataStore must be at to be compatible with this Runtime. This is calculated
-     * based on the LayerCompatibilityPolicyWindowMonths.RuntimeDataStore value which defines how many months old can
-     * the DataStore layer be compared to the Runtime layer for them to still be considered compatible.
+     * based on the LayerCompatibilityPolicyWindowMonths.NewRuntimeOldDataStore value which defines how many months
+     * old can the DataStore layer be compared to the Runtime layer for them to still be considered compatible.
      * The minimum valid generation value is 0.
      */
     minSupportedGeneration: Math.max(0, exports.runtimeCoreCompatDetails.generation -
-        client_utils_1.LayerCompatibilityPolicyWindowMonths.RuntimeDataStore),
+        client_utils_1.LayerCompatibilityPolicyWindowMonths.NewRuntimeOldDataStore),
     /**
      * The features that the DataStore must support to be compatible with Runtime.
      */
@@ -94,15 +97,32 @@ function validateLoaderCompatibility(maybeLoaderCompatDetailsForRuntime, dispose
     // since Loader can drift far from the Runtime causing issues.
     // Can be disabled via config `disableStrictLoaderLayerCompatibilityCheckKey`.
     const disableStrictLoaderLayerCompatibilityCheck = mc.config.getBoolean(exports.disableStrictLoaderLayerCompatibilityCheckKey);
-    (0, internal_2.validateLayerCompatibility)("runtime", "loader", exports.runtimeCompatDetailsForLoader, exports.loaderSupportRequirementsForRuntime, maybeLoaderCompatDetailsForRuntime, disposeFn, mc, disableStrictLoaderLayerCompatibilityCheck !== true /* strictCompatibilityCheck */);
+    (0, internal_2.validateLayerCompatibility)(
+    /* validatingLayer */ {
+        layer: "runtime",
+        packageInfo: exports.runtimeCoreCompatDetails,
+        compatSupportRequirements: exports.loaderSupportRequirementsForRuntime,
+    }, 
+    /* targetLayer */ {
+        layer: "loader",
+        compatDetails: maybeLoaderCompatDetailsForRuntime,
+        strictCompatibilityCheck: disableStrictLoaderLayerCompatibilityCheck !== true,
+    }, { disposeFn, mc });
 }
-exports.validateLoaderCompatibility = validateLoaderCompatibility;
 /**
  * Validates that the DataStore layer is compatible with this Runtime.
  * @internal
  */
 function validateDatastoreCompatibility(maybeDataStoreCompatDetailsForRuntime, disposeFn, mc) {
-    (0, internal_2.validateLayerCompatibility)("runtime", "dataStore", exports.runtimeCompatDetailsForDataStore, exports.dataStoreSupportRequirementsForRuntime, maybeDataStoreCompatDetailsForRuntime, disposeFn, mc);
+    (0, internal_2.validateLayerCompatibility)(
+    /* validatingLayer */ {
+        layer: "runtime",
+        packageInfo: exports.runtimeCoreCompatDetails,
+        compatSupportRequirements: exports.dataStoreSupportRequirementsForRuntime,
+    }, 
+    /* targetLayer */ {
+        layer: "dataStore",
+        compatDetails: maybeDataStoreCompatDetailsForRuntime,
+    }, { disposeFn, mc });
 }
-exports.validateDatastoreCompatibility = validateDatastoreCompatibility;
 //# sourceMappingURL=runtimeLayerCompatState.js.map

package/dist/runtimeLayerCompatState.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtimeLayerCompatState.js","sourceRoot":"","sources":["../src/runtimeLayerCompatState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAKsC;AAEtC,2EAGsD;AACtD,uEAGkD;AAElD,2DAAiD;AAEjD;;GAEG;AACU,QAAA,6CAA6C,GACzD,mEAAmE,CAAC;AAErE;;;GAGG;AACU,QAAA,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU,EAAV,8BAAU;IACV;;OAEG;IACH,UAAU,EAAV,yBAAU;CACD,CAAC;AAEX;;;GAGG;AACU,QAAA,6BAA6B,GAAwB;IACjE,GAAG,gCAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACU,QAAA,mCAAmC,GAAoC;IACnF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,gCAAwB,CAAC,UAAU,GAAG,mDAAoC,CAAC,aAAa,CACxF;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACU,QAAA,gCAAgC,GAAwB;IACpE,GAAG,gCAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,CAAS,CAAC,0CAA+B,EAAE,gCAAqB,CAAC,CAAC;CAC5F,CAAC;AAEF;;;GAGG;AACU,QAAA,sCAAsC,GAAoC;IACtF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,gCAAwB,CAAC,UAAU;QAClC,mDAAoC,CAAC,gBAAgB,CACtD;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,SAAgB,2BAA2B,CAC1C,kCAAmE,EACnE,SAAoD,EACpD,EAAqB;IAErB,uGAAuG;IACvG,wEAAwE;IACxE,8DAA8D;IAC9D,8EAA8E;IAC9E,MAAM,0CAA0C,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CACtE,qDAA6C,CAC7C,CAAC;IAEF,IAAA,qCAA0B,EACzB,SAAS,EACT,QAAQ,EACR,qCAA6B,EAC7B,2CAAmC,EACnC,kCAAkC,EAClC,SAAS,EACT,EAAE,EACF,0CAA0C,KAAK,IAAI,CAAC,8BAA8B,CAClF,CAAC;AACH,CAAC;AAvBD,kEAuBC;AAED;;;GAGG;AACH,SAAgB,8BAA8B,CAC7C,qCAAsE,EACtE,SAAqB,EACrB,EAAqB;IAErB,IAAA,qCAA0B,EACzB,SAAS,EACT,WAAW,EACX,wCAAgC,EAChC,8CAAsC,EACtC,qCAAqC,EACrC,SAAS,EACT,EAAE,CACF,CAAC;AACH,CAAC;AAdD,wEAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tgeneration,\n\tLayerCompatibilityPolicyWindowMonths,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tvalidateLayerCompatibility,\n\ttype MonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * The config key to disable strict loader layer compatibility check.\n */\nexport const disableStrictLoaderLayerCompatibilityCheckKey =\n\t\"Fluid.ContainerRuntime.DisableStrictLoaderLayerCompatibilityCheck\";\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,\n} as const;\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 loaderSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Loader must be at to be compatible with this Runtime. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.RuntimeLoader value which defines how many months old can\n\t * the Loader layer be compared to the Runtime layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\truntimeCoreCompatDetails.generation - LayerCompatibilityPolicyWindowMonths.RuntimeLoader,\n\t),\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 / DataStore boundary.\n\t */\n\tsupportedFeatures: new Set<string>([encodeHandlesInContainerRuntime, notifiesReadOnlyState]),\n};\n\n/**\n * The requirements that the DataStore layer must meet to be compatible with this Runtime.\n * @internal\n */\nexport const dataStoreSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that DataStore must be at to be compatible with this Runtime. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.RuntimeDataStore value which defines how many months old can\n\t * the DataStore layer be compared to the Runtime layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\truntimeCoreCompatDetails.generation -\n\t\t\tLayerCompatibilityPolicyWindowMonths.RuntimeDataStore,\n\t),\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\tmc: MonitoringContext,\n): void {\n\t// By default, use strictCompatibilityCheck here - If the Loader doesn't provide compatibility details,\n\t// assume it's a very old version and should be considered incompatible,\n\t// since Loader can drift far from the Runtime causing issues.\n\t// Can be disabled via config `disableStrictLoaderLayerCompatibilityCheckKey`.\n\tconst disableStrictLoaderLayerCompatibilityCheck = mc.config.getBoolean(\n\t\tdisableStrictLoaderLayerCompatibilityCheckKey,\n\t);\n\n\tvalidateLayerCompatibility(\n\t\t\"runtime\",\n\t\t\"loader\",\n\t\truntimeCompatDetailsForLoader,\n\t\tloaderSupportRequirementsForRuntime,\n\t\tmaybeLoaderCompatDetailsForRuntime,\n\t\tdisposeFn,\n\t\tmc,\n\t\tdisableStrictLoaderLayerCompatibilityCheck !== true /* strictCompatibilityCheck */,\n\t);\n}\n\n/**\n * Validates that the DataStore layer is compatible with this Runtime.\n * @internal\n */\nexport function validateDatastoreCompatibility(\n\tmaybeDataStoreCompatDetailsForRuntime: ILayerCompatDetails | undefined,\n\tdisposeFn: () => void,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t\"runtime\",\n\t\t\"dataStore\",\n\t\truntimeCompatDetailsForDataStore,\n\t\tdataStoreSupportRequirementsForRuntime,\n\t\tmaybeDataStoreCompatDetailsForRuntime,\n\t\tdisposeFn,\n\t\tmc,\n\t);\n}\n"]}
+{"version":3,"file":"runtimeLayerCompatState.js","sourceRoot":"","sources":["../src/runtimeLayerCompatState.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAiHH,kEA0BC;AAMD,wEAiBC;AAhKD,+DAKsC;AAEtC,2EAGsD;AACtD,uEAGkD;AAElD,2DAAiD;AAEjD;;GAEG;AACU,QAAA,6CAA6C,GACzD,mEAAmE,CAAC;AAErE;;;GAGG;AACU,QAAA,wBAAwB,GAAG;IACvC;;OAEG;IACH,UAAU,EAAV,8BAAU;IACV;;OAEG;IACH,UAAU,EAAV,yBAAU;CACD,CAAC;AAEX;;;GAGG;AACU,QAAA,6BAA6B,GAAwB;IACjE,GAAG,gCAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,EAAU;CACpC,CAAC;AAEF;;;GAGG;AACU,QAAA,mCAAmC,GAAoC;IACnF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,gCAAwB,CAAC,UAAU;QAClC,mDAAoC,CAAC,mBAAmB,CACzD;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACU,QAAA,gCAAgC,GAAwB;IACpE,GAAG,gCAAwB;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,CAAS,CAAC,0CAA+B,EAAE,gCAAqB,CAAC,CAAC;CAC5F,CAAC;AAEF;;;GAGG;AACU,QAAA,sCAAsC,GAAoC;IACtF;;;;;OAKG;IACH,sBAAsB,EAAE,IAAI,CAAC,GAAG,CAC/B,CAAC,EACD,gCAAwB,CAAC,UAAU;QAClC,mDAAoC,CAAC,sBAAsB,CAC5D;IACD;;OAEG;IACH,gBAAgB,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,SAAgB,2BAA2B,CAC1C,kCAAmE,EACnE,SAAoD,EACpD,EAAqB;IAErB,uGAAuG;IACvG,wEAAwE;IACxE,8DAA8D;IAC9D,8EAA8E;IAC9E,MAAM,0CAA0C,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CACtE,qDAA6C,CAC7C,CAAC;IAEF,IAAA,qCAA0B;IACzB,qBAAqB,CAAC;QACrB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,gCAAwB;QACrC,yBAAyB,EAAE,2CAAmC;KAC9D;IACD,iBAAiB,CAAC;QACjB,KAAK,EAAE,QAAQ;QACf,aAAa,EAAE,kCAAkC;QACjD,wBAAwB,EAAE,0CAA0C,KAAK,IAAI;KAC7E,EACD,EAAE,SAAS,EAAE,EAAE,EAAE,CACjB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,8BAA8B,CAC7C,qCAAsE,EACtE,SAAqB,EACrB,EAAqB;IAErB,IAAA,qCAA0B;IACzB,qBAAqB,CAAC;QACrB,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,gCAAwB;QACrC,yBAAyB,EAAE,8CAAsC;KACjE;IACD,iBAAiB,CAAC;QACjB,KAAK,EAAE,WAAW;QAClB,aAAa,EAAE,qCAAqC;KACpD,EACD,EAAE,SAAS,EAAE,EAAE,EAAE,CACjB,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tgeneration,\n\tLayerCompatibilityPolicyWindowMonths,\n\ttype ILayerCompatDetails,\n\ttype ILayerCompatSupportRequirements,\n} from \"@fluid-internal/client-utils\";\nimport type { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tencodeHandlesInContainerRuntime,\n\tnotifiesReadOnlyState,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tvalidateLayerCompatibility,\n\ttype MonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\n\n/**\n * The config key to disable strict loader layer compatibility check.\n */\nexport const disableStrictLoaderLayerCompatibilityCheckKey =\n\t\"Fluid.ContainerRuntime.DisableStrictLoaderLayerCompatibilityCheck\";\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,\n} as const;\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 loaderSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that Loader must be at to be compatible with this Runtime. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.NewRuntimeOldLoader value which defines how many months\n\t * old can the Loader layer be compared to the Runtime layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\truntimeCoreCompatDetails.generation -\n\t\t\tLayerCompatibilityPolicyWindowMonths.NewRuntimeOldLoader,\n\t),\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 / DataStore boundary.\n\t */\n\tsupportedFeatures: new Set<string>([encodeHandlesInContainerRuntime, notifiesReadOnlyState]),\n};\n\n/**\n * The requirements that the DataStore layer must meet to be compatible with this Runtime.\n * @internal\n */\nexport const dataStoreSupportRequirementsForRuntime: ILayerCompatSupportRequirements = {\n\t/**\n\t * Minimum generation that DataStore must be at to be compatible with this Runtime. This is calculated\n\t * based on the LayerCompatibilityPolicyWindowMonths.NewRuntimeOldDataStore value which defines how many months\n\t * old can the DataStore layer be compared to the Runtime layer for them to still be considered compatible.\n\t * The minimum valid generation value is 0.\n\t */\n\tminSupportedGeneration: Math.max(\n\t\t0,\n\t\truntimeCoreCompatDetails.generation -\n\t\t\tLayerCompatibilityPolicyWindowMonths.NewRuntimeOldDataStore,\n\t),\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\tmc: MonitoringContext,\n): void {\n\t// By default, use strictCompatibilityCheck here - If the Loader doesn't provide compatibility details,\n\t// assume it's a very old version and should be considered incompatible,\n\t// since Loader can drift far from the Runtime causing issues.\n\t// Can be disabled via config `disableStrictLoaderLayerCompatibilityCheckKey`.\n\tconst disableStrictLoaderLayerCompatibilityCheck = mc.config.getBoolean(\n\t\tdisableStrictLoaderLayerCompatibilityCheckKey,\n\t);\n\n\tvalidateLayerCompatibility(\n\t\t/* validatingLayer */ {\n\t\t\tlayer: \"runtime\",\n\t\t\tpackageInfo: runtimeCoreCompatDetails,\n\t\t\tcompatSupportRequirements: loaderSupportRequirementsForRuntime,\n\t\t},\n\t\t/* targetLayer */ {\n\t\t\tlayer: \"loader\",\n\t\t\tcompatDetails: maybeLoaderCompatDetailsForRuntime,\n\t\t\tstrictCompatibilityCheck: disableStrictLoaderLayerCompatibilityCheck !== true,\n\t\t},\n\t\t{ disposeFn, mc },\n\t);\n}\n\n/**\n * Validates that the DataStore layer is compatible with this Runtime.\n * @internal\n */\nexport function validateDatastoreCompatibility(\n\tmaybeDataStoreCompatDetailsForRuntime: ILayerCompatDetails | undefined,\n\tdisposeFn: () => void,\n\tmc: MonitoringContext,\n): void {\n\tvalidateLayerCompatibility(\n\t\t/* validatingLayer */ {\n\t\t\tlayer: \"runtime\",\n\t\t\tpackageInfo: runtimeCoreCompatDetails,\n\t\t\tcompatSupportRequirements: dataStoreSupportRequirementsForRuntime,\n\t\t},\n\t\t/* targetLayer */ {\n\t\t\tlayer: \"dataStore\",\n\t\t\tcompatDetails: maybeDataStoreCompatDetailsForRuntime,\n\t\t},\n\t\t{ disposeFn, mc },\n\t);\n}\n"]}

package/dist/signalTelemetryProcessing.js

@@ -7,23 +7,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignalTelemetryManager = void 0;
 const defaultTelemetrySignalSampleCount = 100;
 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;
-    }
+    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.
+     */
+    broadcastSignalSequenceNumber = 0;
     /**
      * Resets the signal tracking state in the {@link SignalTelemetryManager}.
      */

package/dist/signalTelemetryProcessing.js.map

@@ -1 +1 @@
-{"version":3,"file":"signalTelemetryProcessing.js","sourceRoot":"","sources":["../src/signalTelemetryProcessing.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,MAAM,iCAAiC,GAAG,GAAG,CAAC;AAoD9C,MAAa,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,MAA0B,EAC1B,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;AAzKD,wDAyKC","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\tTelemetryEventPropertyTypeExt,\n\tTelemetryLoggerExt,\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: TelemetryLoggerExt,\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"]}
+{"version":3,"file":"signalTelemetryProcessing.js","sourceRoot":"","sources":["../src/signalTelemetryProcessing.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,MAAM,iCAAiC,GAAG,GAAG,CAAC;AAoD9C,MAAa,sBAAsB;IACjB,cAAc,GAA6B;QAC3D,+BAA+B,EAAE,CAAC;QAClC,WAAW,EAAE,CAAC;QACd,iBAAiB,EAAE,CAAC;QACpB,sCAAsC,EAAE,CAAC;QACzC,eAAe,EAAE,CAAC;QAClB,6BAA6B,EAAE,SAAS;QACxC,4BAA4B,EAAE,SAAS;QACvC,mCAAmC,EAAE,SAAS;KAC9C,CAAC;IAEF;;;OAGG;IACK,6BAA6B,GAAW,CAAC,CAAC;IAElD;;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,MAA0B,EAC1B,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;AAzKD,wDAyKC","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\tTelemetryEventPropertyTypeExt,\n\tTelemetryLoggerExt,\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: TelemetryLoggerExt,\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/dist/storageServiceWithAttachBlobs.js

@@ -10,6 +10,8 @@ exports.StorageServiceWithAttachBlobs = void 0;
  * attach message. We use this to avoid an unnecessary request to the storage service.
  */
 class StorageServiceWithAttachBlobs {
+    internalStorageService;
+    attachBlobs;
     constructor(internalStorageService, attachBlobs) {
         this.internalStorageService = internalStorageService;
         this.attachBlobs = attachBlobs;

package/dist/storageServiceWithAttachBlobs.js.map

@@ -1 +1 @@
-{"version":3,"file":"storageServiceWithAttachBlobs.js","sourceRoot":"","sources":["../src/storageServiceWithAttachBlobs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACH,MAAa,6BAA6B;IACzC,YACkB,sBAA8C,EAC9C,WAAyC;QADzC,2BAAsB,GAAtB,sBAAsB,CAAwB;QAC9C,gBAAW,GAAX,WAAW,CAA8B;IACxD,CAAC;IAEG,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACb,CAAC;QAED,8FAA8F;QAC9F,0EAA0E;QAC1E,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;CACD;AAhBD,sEAgBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRuntimeStorageService } from \"@fluidframework/runtime-definitions/internal\";\n\n/**\n * IRuntimeStorageService proxy which intercepts requests if they can be satisfied by the blobs received in the\n * attach message. We use this to avoid an unnecessary request to the storage service.\n */\nexport class StorageServiceWithAttachBlobs implements IRuntimeStorageService {\n\tconstructor(\n\t\tprivate readonly internalStorageService: IRuntimeStorageService,\n\t\tprivate readonly attachBlobs: Map<string, ArrayBufferLike>,\n\t) {}\n\n\tpublic async readBlob(id: string): Promise<ArrayBufferLike> {\n\t\tconst blob = this.attachBlobs.get(id);\n\t\tif (blob !== undefined) {\n\t\t\treturn blob;\n\t\t}\n\n\t\t// Note that it is intentional not to cache the result of this readBlob - we'll trust the real\n\t\t// IRuntimeStorageService to cache appropriately, no need to double-cache.\n\t\treturn this.internalStorageService.readBlob(id);\n\t}\n}\n"]}
+{"version":3,"file":"storageServiceWithAttachBlobs.js","sourceRoot":"","sources":["../src/storageServiceWithAttachBlobs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACH,MAAa,6BAA6B;IAEvB;IACA;IAFlB,YACkB,sBAA8C,EAC9C,WAAyC;QADzC,2BAAsB,GAAtB,sBAAsB,CAAwB;QAC9C,gBAAW,GAAX,WAAW,CAA8B;IACxD,CAAC;IAEG,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACb,CAAC;QAED,8FAA8F;QAC9F,0EAA0E;QAC1E,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;CACD;AAhBD,sEAgBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRuntimeStorageService } from \"@fluidframework/runtime-definitions/internal\";\n\n/**\n * IRuntimeStorageService proxy which intercepts requests if they can be satisfied by the blobs received in the\n * attach message. We use this to avoid an unnecessary request to the storage service.\n */\nexport class StorageServiceWithAttachBlobs implements IRuntimeStorageService {\n\tconstructor(\n\t\tprivate readonly internalStorageService: IRuntimeStorageService,\n\t\tprivate readonly attachBlobs: Map<string, ArrayBufferLike>,\n\t) {}\n\n\tpublic async readBlob(id: string): Promise<ArrayBufferLike> {\n\t\tconst blob = this.attachBlobs.get(id);\n\t\tif (blob !== undefined) {\n\t\t\treturn blob;\n\t\t}\n\n\t\t// Note that it is intentional not to cache the result of this readBlob - we'll trust the real\n\t\t// IRuntimeStorageService to cache appropriately, no need to double-cache.\n\t\treturn this.internalStorageService.readBlob(id);\n\t}\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"documentSchema.d.ts","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAMnF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;AAEpF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe;IAK/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;IAEjD;;;;OAIG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,EAAE,eAAe,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG,eAAe,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,CAAC;AAE1E;;;;;;;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;IAC3B,wBAAwB,EAAE,IAAI,GAAG,SAAS,CAAC;IAE3C;;;;;;;;;OASG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,CAAC,eAAe,CAAC;IAExE,OAAO,EAAE,OAAO,4BAA4B,CAAC;IAE7C,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;AAwUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,yBAAyB;IAyCpC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAG/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IA3CtC,OAAO,CAAC,qBAAqB,CAAU;IAEvC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAS;IAG1B,OAAO,CAAC,cAAc,CAAkB;IAIxC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;IAGvD,OAAO,CAAC,YAAY,CAAqC;IAOlD,aAAa,EAAE,sBAAsB,CAAC;IAE7C;;;;;;;;;OASG;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,EACzE,IAAI,EAAE,mBAAmB,EACzB,MAAM,EAAE,kBAAkB,EACT,oBAAoB,EAAE,OAAO;IAqGxC,uBAAuB,CAC7B,MAAM,EAAE,MAAM,GACZ,eAAe,GAAG,sBAAsB,GAAG,SAAS;IAqBvD;;;;;OAKG;IACI,0BAA0B,IAAI,oCAAoC,GAAG,SAAS;IAcrF,OAAO,CAAC,iBAAiB;IAmBzB;;;;;;;;OAQG;IACI,6BAA6B,CACnC,QAAQ,EAAE,oCAAoC,EAAE,EAChD,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,MAAM,GACpB,OAAO;IAgEV;;OAEG;IACI,iBAAiB,IAAI,IAAI;CAGhC"}
+{"version":3,"file":"documentSchema.d.ts","sourceRoot":"","sources":["../../src/summary/documentSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAMnF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;AAEpF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe;IAK/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;IAEjD;;;;OAIG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,EAAE,eAAe,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG,eAAe,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG,sBAAsB,CAAC;AAE1E;;;;;;;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;IAC3B,wBAAwB,EAAE,IAAI,GAAG,SAAS,CAAC;IAE3C;;;;;;;;;OASG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,CAAC,eAAe,CAAC;IAExE,OAAO,EAAE,OAAO,4BAA4B,CAAC;IAE7C,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;AAiWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,yBAAyB;IAyCpC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAG/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IA3CtC,OAAO,CAAC,qBAAqB,CAAU;IAEvC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAS;IAG1B,OAAO,CAAC,cAAc,CAAkB;IAIxC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;IAGvD,OAAO,CAAC,YAAY,CAAqC;IAOlD,aAAa,EAAE,sBAAsB,CAAC;IAE7C;;;;;;;;;OASG;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,EACzE,IAAI,EAAE,mBAAmB,EACzB,MAAM,EAAE,kBAAkB,EACT,oBAAoB,EAAE,OAAO;IAqGxC,uBAAuB,CAC7B,MAAM,EAAE,MAAM,GACZ,eAAe,GAAG,sBAAsB,GAAG,SAAS;IAqBvD;;;;;OAKG;IACI,0BAA0B,IAAI,oCAAoC,GAAG,SAAS;IAcrF,OAAO,CAAC,iBAAiB;IAmBzB;;;;;;;;OAQG;IACI,6BAA6B,CACnC,QAAQ,EAAE,oCAAoC,EAAE,EAChD,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,MAAM,GACpB,OAAO;IAgEV;;OAEG;IACI,iBAAiB,IAAI,IAAI;CAGhC"}

package/dist/summary/documentSchema.js

@@ -39,6 +39,7 @@ class TrueOrUndefinedMax extends TrueOrUndefined {
     }
 }
 class MultiChoice {
+    choices;
     constructor(choices) {
         this.choices = choices;
     }
@@ -182,8 +183,10 @@ function and(persistedSchema, providedSchema) {
         runtime[key] = getRuntimeConfigHandler(key).and(persistedSchema.runtime[key], providedSchema.runtime[key]);
     }
     // We keep the persisted minVersionForCollab if present, even if the provided minVersionForCollab
-    // is higher.
-    const minVersionForCollab = persistedSchema.info?.minVersionForCollab ?? providedSchema.info.minVersionForCollab;
+    // is higher, after migrating historical 2.x prerelease values to their stable versions.
+    const minVersionForCollab = persistedSchema.info === undefined
+        ? providedSchema.info.minVersionForCollab
+        : normalizePersistedMinVersionForCollab(persistedSchema.info.minVersionForCollab);
     return {
         version: exports.currentDocumentVersionSchema,
         refSeq: persistedSchema.refSeq,
@@ -199,11 +202,14 @@ function or(persistedSchema, providedSchema) {
     ])) {
         runtime[key] = getRuntimeConfigHandler(key).or(persistedSchema.runtime[key], providedSchema.runtime[key]);
     }
-    // We take the greater of the persisted/provided minVersionForCollab
-    const minVersionForCollab = persistedSchema.info === undefined
+    // We take the greater of the normalized persisted/provided minVersionForCollab.
+    const persistedMinVersionForCollab = persistedSchema.info === undefined
+        ? undefined
+        : normalizePersistedMinVersionForCollab(persistedSchema.info.minVersionForCollab);
+    const minVersionForCollab = persistedMinVersionForCollab === undefined
         ? providedSchema.info.minVersionForCollab
-        : (0, semver_ts_1.gt)(persistedSchema.info.minVersionForCollab, providedSchema.info.minVersionForCollab)
-            ? persistedSchema.info.minVersionForCollab
+        : (0, semver_ts_1.gt)(persistedMinVersionForCollab, providedSchema.info.minVersionForCollab)
+            ? persistedMinVersionForCollab
             : providedSchema.info.minVersionForCollab;
     return {
         version: exports.currentDocumentVersionSchema,
@@ -212,6 +218,22 @@ function or(persistedSchema, providedSchema) {
         runtime,
     };
 }
+/**
+ * Migrates 2.x prerelease values accepted by older clients to the corresponding stable version.
+ *
+ * @remarks
+ * This is monotonic under SemVer and can cross a compatibility checkpoint when the prerelease
+ * shares that checkpoint's major, minor, and patch. Client 3.0 no longer supports active
+ * prerelease collaborators, so the persisted requirement advances before format selection.
+ */
+function normalizePersistedMinVersionForCollab(minVersionForCollab) {
+    const parsed = (0, semver_ts_1.parse)(minVersionForCollab);
+    if (parsed?.major === 2 && parsed.prerelease.length > 0) {
+        // `parse` validates each numeric component before this template is constructed.
+        return `${parsed.major}.${parsed.minor}.${parsed.patch}`;
+    }
+    return minVersionForCollab;
+}
 /**
  * Determines if two schemas are the "same".
  * Schemas are considered **not** the same if a schema change op is required to make
@@ -313,6 +335,27 @@ function arrayToProp(arr) {
  * @sealed
  */
 class DocumentsSchemaController {
+    onSchemaChange;
+    disableSchemaUpgrade;
+    explicitSchemaControl;
+    /**
+     * Have we generated a DocumentSchemaChange op and we're waiting for the ack?
+     * This is used to ensure that we do not generate multiple schema change ops - this client should only ever send one (if any).
+     */
+    opPending = false;
+    // schema coming from document metadata (snapshot we loaded from)
+    documentSchema;
+    // desired schema, based on feature gates / runtime options.
+    // This includes requests to enable to disable functionality
+    desiredSchema;
+    // OR() of document schema and desired schema. It enables all the features that are enabled in either of schemas.
+    futureSchema;
+    // Current schema this session operates with.
+    // 1) Legacy mode (explicitSchemaControl === false): this is same as desired schema - all options that were requested to be on are on, and all options requested to be off are off.
+    // 2) Non-legacy mode (explicitSchemaControl === true): this is AND() of document schema and desired schema. Only options that are enabled in both are enabled here.
+    //    If there are any options that are not enabled in document schema, but are enabled in desired schema, then attempt to change schema
+    //    (and enable such options) will be made through the session.
+    sessionSchema;
     /**
      * Constructs DocumentsSchemaController that controls current schema and processes around it, including changes in schema.
      * @param existing - Is the document existing document, or a new doc.
@@ -326,11 +369,6 @@ class DocumentsSchemaController {
     constructor(existing, snapshotSequenceNumber, documentMetadataSchema, features, onSchemaChange, info, logger, disableSchemaUpgrade) {
         this.onSchemaChange = onSchemaChange;
         this.disableSchemaUpgrade = disableSchemaUpgrade;
-        /**
-         * Have we generated a DocumentSchemaChange op and we're waiting for the ack?
-         * This is used to ensure that we do not generate multiple schema change ops - this client should only ever send one (if any).
-         */
-        this.opPending = false;
         // For simplicity, let's only support new schema features for explicit schema control mode
         (0, internal_1.assert)(features.disallowedVersions.length === 0 || features.explicitSchemaControl, 0x949 /* not supported */);
         // We check the document's metadata to see if there is a minVersionForCollab. If it's not an existing document or
@@ -373,7 +411,7 @@ class DocumentsSchemaController {
         // Latter is important sure that's what will go into summary.
         this.documentSchema = existing
             ? (documentMetadataSchema ??
-                ({
+                {
                     version: exports.currentDocumentVersionSchema,
                     // see comment in summarizeDocumentSchema() on why it has to stay zero
                     refSeq: 0,
@@ -383,7 +421,7 @@ class DocumentsSchemaController {
                     runtime: {
                         explicitSchemaControl: boolToProp(!existing && features.explicitSchemaControl),
                     },
-                }))
+                })
             : this.desiredSchema;
         checkRuntimeCompatibility(this.documentSchema, "document");
         this.validateSeqNumber(this.documentSchema.refSeq, snapshotSequenceNumber, "summary");