@fluidframework/container-runtime 2.117.0 → 3.0.0

package/dist/connectionTelemetry.js

@@ -4,7 +4,8 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReportOpPerfTelemetry = exports.latencyThreshold = void 0;
+exports.latencyThreshold = void 0;
+exports.ReportOpPerfTelemetry = ReportOpPerfTelemetry;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const core_interfaces_1 = require("@fluidframework/core-interfaces");
 const internal_1 = require("@fluidframework/core-utils/internal");
@@ -16,6 +17,42 @@ const internal_4 = require("@fluidframework/telemetry-utils/internal");
  */
 exports.latencyThreshold = 5000;
 class OpPerfTelemetry {
+    clientId;
+    deltaManager;
+    pingLatency;
+    // Collab window tracking. This is timestamp of %1000 message.
+    sequenceNumberForMsnTracking;
+    msnTrackingTimestamp = 0;
+    // To track round trip time for every %500 client message.
+    clientSequenceNumberForLatencyStatistics;
+    // Performance Data to be reported for ops round trips and processing.
+    latencyStatistics = new Map();
+    firstConnection = true;
+    connectionOpSeqNumber;
+    bootTime = (0, client_utils_1.performanceNow)();
+    connectionStartTime = 0;
+    gap = 0;
+    /**
+     * Count of no-ops sent by this client. This variable is reset everytime the OpStats sampled event is logged
+     */
+    noOpCountForTelemetry = 0;
+    /**
+     * Cumulative size of the ops processed by this client. This variable is reset everytime the OpStats sampled event is logged
+     */
+    processedOpSizeForTelemetry = 0;
+    logger;
+    static OP_LATENCY_SAMPLE_RATE = 500;
+    opLatencyLogger;
+    static DELTA_LATENCY_SAMPLE_RATE = 100;
+    deltaLatencyLogger;
+    static PROCESSED_OPS_SAMPLE_RATE = 500;
+    /**
+     * A sampled logger to log Ops that have been processed by the current client, the NoOp sent and the
+     * size of the ops processed within one sampling window of this log event.
+     * The data from this logger will be used to monitor the efficiency of NoOp-heuristics or to get approximate collab window size.
+     * Note: no log events are sent when sampling is disabled, because logging at every op will be too noisy.
+     */
+    opsLogger;
     /**
      * Create an instance of OpPerfTelemetry which starts monitoring and generating telemetry related to op performance.
      *
@@ -47,21 +84,6 @@ class OpPerfTelemetry {
     logger) {
         this.clientId = clientId;
         this.deltaManager = deltaManager;
-        this.msnTrackingTimestamp = 0;
-        // Performance Data to be reported for ops round trips and processing.
-        this.latencyStatistics = new Map();
-        this.firstConnection = true;
-        this.bootTime = (0, client_utils_1.performanceNow)();
-        this.connectionStartTime = 0;
-        this.gap = 0;
-        /**
-         * Count of no-ops sent by this client. This variable is reset everytime the OpStats sampled event is logged
-         */
-        this.noOpCountForTelemetry = 0;
-        /**
-         * Cumulative size of the ops processed by this client. This variable is reset everytime the OpStats sampled event is logged
-         */
-        this.processedOpSizeForTelemetry = 0;
         this.logger = (0, internal_4.createChildLogger)({ logger, namespace: "OpPerf" });
         const deltaLatencyEventSampler = (() => {
             let eventCount = -1;
@@ -305,9 +327,6 @@ class OpPerfTelemetry {
         }
     }
 }
-OpPerfTelemetry.OP_LATENCY_SAMPLE_RATE = 500;
-OpPerfTelemetry.DELTA_LATENCY_SAMPLE_RATE = 100;
-OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE = 500;
 /**
  * Starts monitoring and generation of telemetry related to op performance.
  *
@@ -319,5 +338,4 @@ OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE = 500;
 function ReportOpPerfTelemetry(clientId, deltaManager, containerRuntimeEvents, logger) {
     new OpPerfTelemetry(clientId, deltaManager, containerRuntimeEvents, (0, internal_4.createChildLogger)({ logger }));
 }
-exports.ReportOpPerfTelemetry = ReportOpPerfTelemetry;
 //# sourceMappingURL=connectionTelemetry.js.map

package/dist/connectionTelemetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"connectionTelemetry.js","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAI9D,qEAA2D;AAC3D,kEAA6D;AAC7D,0EAIqD;AACrD,oEAAyE;AACzE,uEAOkD;AAElD;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,CAAC;AA8CrC,MAAM,eAAe;IAkDpB;;;;;;;OAOG;IACH;IACC;;;;;;OAMG;IACK,QAA4B;IACpC;;OAEG;IACc,YAA+B;IAChD;;OAEG;IACH,sBAA+D;IAC/D;;OAEG;IACH,MAA0B;QAZlB,aAAQ,GAAR,QAAQ,CAAoB;QAInB,iBAAY,GAAZ,YAAY,CAAmB;QAjEzC,yBAAoB,GAAW,CAAC,CAAC;QAGzC,sEAAsE;QACrD,sBAAiB,GAAG,IAAI,GAAG,EAMzC,CAAC;QAEI,oBAAe,GAAG,IAAI,CAAC;QAEd,aAAQ,GAAG,IAAA,6BAAc,GAAE,CAAC;QACrC,wBAAmB,GAAG,CAAC,CAAC;QACxB,QAAG,GAAG,CAAC,CAAC;QAEhB;;WAEG;QACK,0BAAqB,GAAG,CAAC,CAAC;QAClC;;WAEG;QACK,gCAA2B,GAAG,CAAC,CAAC;QAkDvC,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEjE,MAAM,wBAAwB,GAAkB,CAAC,GAAG,EAAE;YACrD,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YACpB,OAAO;gBACN,MAAM,EAAE,GAAG,EAAE;oBACZ,UAAU,EAAE,CAAC;oBACb,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,CAAC,yBAAyB,KAAK,CAAC,CAAC;oBAClF,IAAI,YAAY,EAAE,CAAC;wBAClB,UAAU,GAAG,CAAC,CAAC;oBAChB,CAAC;oBACD,OAAO,YAAY,CAAC;gBACrB,CAAC;aACD,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QAEL,IAAI,CAAC,kBAAkB,GAAG,IAAA,8BAAmB,EAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAEhF,4FAA4F;QAC5F,4GAA4G;QAC5G,wFAAwF;QACxF,IAAI,CAAC,eAAe,GAAG,IAAA,8BAAmB,EAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAkB,CAAC,GAAG,EAAE;YAC5C,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,OAAO;gBACN,MAAM,EAAE,GAAG,EAAE;oBACZ,UAAU,EAAE,CAAC;oBACb,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,CAAC,yBAAyB,KAAK,CAAC,CAAC;oBAClF,IAAI,YAAY,EAAE,CAAC;wBAClB,UAAU,GAAG,CAAC,CAAC;wBACf,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;wBAC/B,IAAI,CAAC,2BAA2B,GAAG,CAAC,CAAC;oBACtC,CAAC;oBACD,OAAO,YAAY,CAAC;gBACrB,CAAC;aACD,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QACL,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAmB,EACnC,MAAM,EACN,eAAe,EACf,IAAI,CAAC,uCAAuC,CAC5C,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC7B,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBAClE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;gBACrB,IAAI,CAAC,mBAAmB,GAAG,IAAA,6BAAc,GAAE,CAAC;gBAE5C,6DAA6D;gBAC7D,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;oBACnB,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC9B,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACvC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;YAC9C,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC5B,IACC,GAAG,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;oBAClC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;wBACvC,IAAI,CAAC,wCAAwC,KAAK,GAAG,CAAC,oBAAoB,CAAC,EAC3E,CAAC;oBACF,oEAAoE;oBACpE,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAE,CAAC;oBAC3E,IAAA,iBAAM,EAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;oBAClF,IAAA,iBAAM,EACL,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAClE,KAAK,CAAC,iDAAiD,CACvD,CAAC;oBACF,IAAA,iBAAM,EACL,YAAY,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EACrD,KAAK,CAAC,2CAA2C,CACjD,CAAC;oBACF,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAElE,IAAA,iBAAM,EACL,YAAY,CAAC,UAAU,CAAC,wBAAwB,KAAK,SAAS,EAC9D,KAAK,CAAC,oDAAoD,CAC1D,CAAC;oBAEF,IAAA,iBAAM,EACL,YAAY,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EAC9D,KAAK,CAAC,6CAA6C,CACnD,CAAC;oBAEF,YAAY,CAAC,UAAU,CAAC,wBAAwB;wBAC/C,YAAY,CAAC,iBAAiB,CAAC,qBAAqB;4BACpD,YAAY,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;gBACnD,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC3E,IACC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAClC,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;gBACtC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;oBACvC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,CAAC,EAC/E,CAAC;gBACF,yDAAyD;gBACzD,oEAAoE;gBACpE,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAE,CAAC;gBAC/E,IAAA,iBAAM,EAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAClF,IAAI,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;oBACxE,YAAY,CAAC,iBAAiB,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACjE,YAAY,CAAC,UAAU,CAAC,eAAe;wBACtC,YAAY,CAAC,iBAAiB,CAAC,oBAAoB;4BACnD,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;oBACtD,YAAY,CAAC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC/E,CAAC;YACF,CAAC;YACD,IAAI,IAAA,2BAAgB,EAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACvE,IAAI,CAAC,2BAA2B,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC7D,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,QAAgB,EAAE,EAAE;YACxE,oCAAoC;YACpC,gGAAgG;YAChG,0GAA0G;YAC1G,uBAAuB;YACvB,4FAA4F;YAC5F,8BAA8B;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;gBAC/C,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAChC,SAAS,EAAE,wBAAwB;oBACnC,KAAK;oBACL,QAAQ;iBACR,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,sBAAsB,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YACtD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC7B,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB;QAC5B,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAC/B;YACC,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,IAAA,6BAAc,GAAE,GAAG,IAAI,CAAC,mBAAmB;YACrD,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,mDAAmD;YACnD,aAAa,EAAE,IAAI,CAAC,eAAe;gBAClC,CAAC,CAAC,IAAA,qBAAU,EAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC;gBACtD,CAAC,CAAC,SAAS;YACZ,eAAe,EAAE,IAAI,CAAC,eAAe;SACrC,EACD,SAAS,EAAE,QAAQ;QACnB,0BAAQ,CAAC,IAAI,CACb,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,OAAe;QACrC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,sCAAsC;QACtC,IAAI,OAAO,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBAC1B,SAAS,EAAE,gBAAgB;gBAC3B,QAAQ,EAAE,OAAO;aACjB,CAAC,CAAC;QACJ,CAAC;QAED,6GAA6G;QAC7G,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC;gBAC5C,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,OAAO;aACjB,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAEO,cAAc,CAAC,OAAyB;QAC/C,sEAAsE;QACtE,IACC,IAAI,CAAC,eAAe,CAAC,kBAAkB;YACvC,CAAC,IAAI,CAAC,wCAAwC,KAAK,SAAS;gBAC3D,OAAO,CAAC,oBAAoB,GAAG,eAAe,CAAC,sBAAsB,KAAK,CAAC,CAAC,EAC5E,CAAC;YACF,IAAA,iBAAM,EACL,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAK,SAAS,EACtE,KAAK,CAAC,sDAAsD,CAC5D,CAAC;YACF,IAAI,CAAC,wCAAwC,GAAG,OAAO,CAAC,oBAAoB,CAAC;YAC7E,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE;gBACxD,iBAAiB,EAAE;oBAClB,iBAAiB,EAAE,IAAI,CAAC,GAAG,EAAE;iBAC7B;gBACD,UAAU,EAAE,EAAE;aACd,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,IAAI,EAAE,CAAC;YACvC,uDAAuD;YACvD,4DAA4D;YAC5D,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC9B,CAAC;IACF,CAAC;IAEO,iBAAiB,CAAC,OAAkC;QAC3D,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAE9C,IAAI,cAAc,KAAK,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACnD,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC9B,CAAC;QAED,uDAAuD;QACvD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;YACpF,IAAI,CAAC,4BAA4B,GAAG,cAAc,CAAC;YACnD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;QAC/C,CAAC;QACD,IACC,IAAI,CAAC,4BAA4B,KAAK,SAAS;YAC/C,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,4BAA4B,EACjE,CAAC;YACF,IAAA,iBAAM,EACL,IAAI,CAAC,oBAAoB,KAAK,SAAS,EACvC,KAAK,CAAC,oDAAoD,CAC1D,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAChC,SAAS,EAAE,eAAe;gBAC1B,cAAc;gBACd,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC,4BAA4B;gBAC/D,QAAQ,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,oBAAoB;aACvD,CAAC,CAAC;YACH,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAC/C,CAAC;QAED,IACC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAClC,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;YACtC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;gBACvC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,CAAC,EAC/E,CAAC;YACF,yDAAyD;YACzD,oEAAoE;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAE,CAAC;YAC9E,IAAA,iBAAM,EAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YACnF,IAAA,iBAAM,EACL,WAAW,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EAC7D,KAAK,CAAC,0DAA0D,CAChE,CAAC;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC/B,IAAI,WAAW,CAAC,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACtE,WAAW,CAAC,UAAU,CAAC,2BAA2B;oBACjD,WAAW,GAAG,WAAW,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;YACnE,CAAC;YACD,MAAM,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;YAE/E,gEAAgE;YAChE,mFAAmF;YACnF,mBAAmB;YACnB,0FAA0F;YAC1F,yFAAyF;YACzF,uFAAuF;YACvF,wDAAwD;YACxD,MAAM,QAAQ,GAAG,QAAQ,GAAG,wBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;YACvE,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC;gBACzC,SAAS,EAAE,iBAAiB;gBAC5B,cAAc;gBACd,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;gBACxD,QAAQ;gBACR,QAAQ;gBACR,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,WAAW,EACV,IAAI,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,qBAAqB;gBAC/E,GAAG,WAAW,CAAC,UAAU;aACzB,CAAC,CAAC;YAEH,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,IAAA,2BAAgB,EAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,+FAA+F;YAC/F,0EAA0E;YAC1E,gHAAgH;YAChH,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;gBACnC,SAAS,EAAE,SAAS;gBACpB,qFAAqF;gBACrF,OAAO,EAAE;oBACR,iFAAiF;oBACjF,yDAAyD;oBACzD,gBAAgB,EAAE,eAAe,CAAC,yBAAyB;oBAC3D,kGAAkG;oBAClG,eAAe,EAAE,IAAI,CAAC,2BAA2B;oBACjD,oFAAoF;oBACpF,iBAAiB,EAAE,IAAI,CAAC,qBAAqB;iBAC7C;aACD,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;;AAhWuB,sCAAsB,GAAG,GAAG,AAAN,CAAO;AAG7B,yCAAyB,GAAG,GAAG,AAAN,CAAO;AAGhC,yCAAyB,GAAG,GAAG,AAAN,CAAO;AA6VzD;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACpC,QAA4B,EAC5B,YAA+B,EAC/B,sBAA+D,EAC/D,MAA4B;IAE5B,IAAI,eAAe,CAClB,QAAQ,EACR,YAAY,EACZ,sBAAsB,EACtB,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,CAAC,CAC7B,CAAC;AACH,CAAC;AAZD,sDAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performanceNow } from \"@fluid-internal/client-utils\";\nimport type { IDeltaManagerFull } from \"@fluidframework/container-definitions/internal\";\nimport type { IContainerRuntimeEvents } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type { ITelemetryBaseLogger, IEventProvider } from \"@fluidframework/core-interfaces\";\nimport { LogLevel } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\ttype IDocumentMessage,\n\tMessageType,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { isRuntimeMessage } from \"@fluidframework/driver-utils/internal\";\nimport {\n\tcreateChildLogger,\n\tcreateSampledLogger,\n\tformatTick,\n\ttype IEventSampler,\n\ttype ISampledTelemetryLogger,\n\ttype TelemetryLoggerExt,\n} from \"@fluidframework/telemetry-utils/internal\";\n\n/**\n * We report various latency-related errors when waiting for op roundtrip takes longer than that amout of time.\n */\nexport const latencyThreshold = 5000;\n\n// Phases in OpPerfTelemetry:\n// 1.\tOp is added to DeltaManager (DM) buffer.\n// 2.\tOp is sent to service (op leaves outbound queue).\n// \t - Note: We do not know for sure when op is sent, we only track when it is added to outbound queue.\n//     If outbound queue is paused, time queue is paused is counted as network time.\n// 3.\tOp received from service back (pushed to inbound queue).\n// 4.\tOp is processed.\ninterface IOpPerfTelemetryProperties {\n\t/**\n\t * Measure time between (1) and (2) - Measure time outbound op is sitting in queue due to active batch\n\t */\n\tdurationOutboundBatching: number; // was durationOutboundQueue in previous versions\n\t/**\n\t * Measure time between (2) and (3) - Track how long it took for op to be acked by service\n\t */\n\tdurationNetwork: number; // was durationInboundQueue\n\t/**\n\t * Measure time between (3) and (4) - Time between DM's inbound \"push\" event until DM's \"op\" event\n\t */\n\tdurationInboundToProcessing: number;\n\t/**\n\t * Length of the DeltaManager's inbound queue at the time of the DM's inbound \"push\" event (3)\n\t */\n\tlengthInboundQueue: number;\n}\n\n/**\n * Timings collected at various moments during the op processing.\n */\ninterface IOpPerfTimings {\n\t/**\n\t * Starting time for (1)\n\t */\n\tsubmitOpEventTime: number;\n\t/**\n\t * Starting time for (2)\n\t */\n\toutboundPushEventTime: number;\n\t/**\n\t * Starting time for (3)\n\t */\n\tinboundPushEventTime: number;\n}\n\nclass OpPerfTelemetry {\n\tprivate pingLatency: number | undefined;\n\n\t// Collab window tracking. This is timestamp of %1000 message.\n\tprivate sequenceNumberForMsnTracking: number | undefined;\n\tprivate msnTrackingTimestamp: number = 0;\n\t// To track round trip time for every %500 client message.\n\tprivate clientSequenceNumberForLatencyStatistics: number | undefined;\n\t// Performance Data to be reported for ops round trips and processing.\n\tprivate readonly latencyStatistics = new Map<\n\t\tnumber,\n\t\t{\n\t\t\topProcessingTimes: Partial<IOpPerfTimings>;\n\t\t\topPerfData: Partial<IOpPerfTelemetryProperties>;\n\t\t}\n\t>();\n\n\tprivate firstConnection = true;\n\tprivate connectionOpSeqNumber: number | undefined;\n\tprivate readonly bootTime = performanceNow();\n\tprivate connectionStartTime = 0;\n\tprivate gap = 0;\n\n\t/**\n\t * Count of no-ops sent by this client. This variable is reset everytime the OpStats sampled event is logged\n\t */\n\tprivate noOpCountForTelemetry = 0;\n\t/**\n\t * Cumulative size of the ops processed by this client. This variable is reset everytime the OpStats sampled event is logged\n\t */\n\tprivate processedOpSizeForTelemetry = 0;\n\n\tprivate readonly logger: TelemetryLoggerExt;\n\n\tprivate static readonly OP_LATENCY_SAMPLE_RATE = 500;\n\tprivate readonly opLatencyLogger: ISampledTelemetryLogger;\n\n\tprivate static readonly DELTA_LATENCY_SAMPLE_RATE = 100;\n\tprivate readonly deltaLatencyLogger: ISampledTelemetryLogger;\n\n\tprivate static readonly PROCESSED_OPS_SAMPLE_RATE = 500;\n\n\t/**\n\t * A sampled logger to log Ops that have been processed by the current client, the NoOp sent and the\n\t * size of the ops processed within one sampling window of this log event.\n\t * The data from this logger will be used to monitor the efficiency of NoOp-heuristics or to get approximate collab window size.\n\t * Note: no log events are sent when sampling is disabled, because logging at every op will be too noisy.\n\t */\n\tprivate readonly opsLogger: ISampledTelemetryLogger;\n\n\t/**\n\t * Create an instance of OpPerfTelemetry which starts monitoring and generating telemetry related to op performance.\n\t *\n\t * @param clientId - The clientId of the current container.\n\t * @param deltaManager - DeltaManager instance to monitor.\n\t * @param containerRuntimeEvents - Emitter of events for the container runtime.\n\t * @param logger - Telemetry logger to write events to.\n\t */\n\tpublic constructor(\n\t\t/**\n\t\t * The clientId of the current container.\n\t\t *\n\t\t * @remarks Until the container connects to the server and receives an ack for its own join op, this can be undefined.\n\t\t * It gets updated in response to event changes once the value provided by the server is available.\n\t\t * If the container loses its connection, this could be the last known clientId.\n\t\t */\n\t\tprivate clientId: string | undefined,\n\t\t/**\n\t\t * DeltaManager instance to monitor.\n\t\t */\n\t\tprivate readonly deltaManager: IDeltaManagerFull,\n\t\t/**\n\t\t * Emitter of events for the container runtime.\n\t\t */\n\t\tcontainerRuntimeEvents: IEventProvider<IContainerRuntimeEvents>,\n\t\t/**\n\t\t * Telemetry logger to write events to.\n\t\t */\n\t\tlogger: TelemetryLoggerExt,\n\t) {\n\t\tthis.logger = createChildLogger({ logger, namespace: \"OpPerf\" });\n\n\t\tconst deltaLatencyEventSampler: IEventSampler = (() => {\n\t\t\tlet eventCount = -1;\n\t\t\treturn {\n\t\t\t\tsample: () => {\n\t\t\t\t\teventCount++;\n\t\t\t\t\tconst shouldSample = eventCount % OpPerfTelemetry.DELTA_LATENCY_SAMPLE_RATE === 0;\n\t\t\t\t\tif (shouldSample) {\n\t\t\t\t\t\teventCount = 0;\n\t\t\t\t\t}\n\t\t\t\t\treturn shouldSample;\n\t\t\t\t},\n\t\t\t};\n\t\t})();\n\n\t\tthis.deltaLatencyLogger = createSampledLogger(logger, deltaLatencyEventSampler);\n\n\t\t// The SampledLogger here is used get access to the isSamplingDisabled property derived from\n\t\t// telemetry config properties. The actual sampling logic for op messages happens outside this SampledLogger\n\t\t// due to complexity of the different asynchronus scenarios of the op message lifecycle.\n\t\tthis.opLatencyLogger = createSampledLogger(logger);\n\n\t\tconst opsEventSampler: IEventSampler = (() => {\n\t\t\tlet eventCount = 0;\n\t\t\treturn {\n\t\t\t\tsample: () => {\n\t\t\t\t\teventCount++;\n\t\t\t\t\tconst shouldSample = eventCount % OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE === 0;\n\t\t\t\t\tif (shouldSample) {\n\t\t\t\t\t\teventCount = 0;\n\t\t\t\t\t\tthis.noOpCountForTelemetry = 0;\n\t\t\t\t\t\tthis.processedOpSizeForTelemetry = 0;\n\t\t\t\t\t}\n\t\t\t\t\treturn shouldSample;\n\t\t\t\t},\n\t\t\t};\n\t\t})();\n\t\tthis.opsLogger = createSampledLogger(\n\t\t\tlogger,\n\t\t\topsEventSampler,\n\t\t\ttrue /* skipLoggingWhenSamplingIsDisabled */,\n\t\t);\n\n\t\tthis.deltaManager.on(\"pong\", (latency) => this.recordPingTime(latency));\n\t\tthis.deltaManager.on(\"submitOp\", (message) => this.beforeOpSubmit(message));\n\t\tthis.deltaManager.on(\"op\", (message) => this.afterProcessingOp(message));\n\t\tthis.deltaManager.on(\"connect\", (details, opsBehind) => {\n\t\t\tif (opsBehind !== undefined) {\n\t\t\t\tthis.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;\n\t\t\t\tthis.gap = opsBehind;\n\t\t\t\tthis.connectionStartTime = performanceNow();\n\n\t\t\t\t// We might be already up-today. If so, report it right away.\n\t\t\t\tif (this.gap <= 0) {\n\t\t\t\t\tthis.reportGettingUpToDate();\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\t\tthis.deltaManager.on(\"disconnect\", () => {\n\t\t\tthis.sequenceNumberForMsnTracking = undefined;\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = undefined;\n\t\t\tthis.connectionOpSeqNumber = undefined;\n\t\t\tthis.firstConnection = false;\n\t\t\tthis.latencyStatistics.clear();\n\t\t});\n\n\t\tthis.deltaManager.outbound.on(\"push\", (messages) => {\n\t\t\tfor (const msg of messages) {\n\t\t\t\tif (\n\t\t\t\t\tmsg.type === MessageType.Operation &&\n\t\t\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber)\n\t\t\t\t) {\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\tconst latencyStats = this.latencyStatistics.get(msg.clientSequenceNumber)!;\n\t\t\t\t\tassert(latencyStats !== undefined, 0x7c2 /* Latency stats for op should exist */);\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime === undefined,\n\t\t\t\t\t\t0x2c8 /* \"outboundPushEventTime should be undefined\" */,\n\t\t\t\t\t);\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opPerfData.durationNetwork === undefined,\n\t\t\t\t\t\t0x2c9 /* \"durationNetwork should be undefined\" */,\n\t\t\t\t\t);\n\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime = Date.now();\n\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opPerfData.durationOutboundBatching === undefined,\n\t\t\t\t\t\t0x2ca /* \"durationOutboundBatching should be undefined\" */,\n\t\t\t\t\t);\n\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.submitOpEventTime !== undefined,\n\t\t\t\t\t\t0x2cb /* \"submitOpEventTime should be undefined\" */,\n\t\t\t\t\t);\n\n\t\t\t\t\tlatencyStats.opPerfData.durationOutboundBatching =\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime -\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.submitOpEventTime;\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\tthis.deltaManager.inbound.on(\"push\", (message: ISequencedDocumentMessage) => {\n\t\t\tif (\n\t\t\t\tthis.clientId === message.clientId &&\n\t\t\t\tmessage.type === MessageType.Operation &&\n\t\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber)\n\t\t\t) {\n\t\t\t\t// We do an explicit check for undefined right after this\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\tconst latencyStats = this.latencyStatistics.get(message.clientSequenceNumber)!;\n\t\t\t\tassert(latencyStats !== undefined, 0x7c3 /* Latency stats for op should exist */);\n\t\t\t\tif (latencyStats.opProcessingTimes.outboundPushEventTime !== undefined) {\n\t\t\t\t\tlatencyStats.opProcessingTimes.inboundPushEventTime = Date.now();\n\t\t\t\t\tlatencyStats.opPerfData.durationNetwork =\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.inboundPushEventTime -\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime;\n\t\t\t\t\tlatencyStats.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (isRuntimeMessage(message) && typeof message.contents === \"string\") {\n\t\t\t\tthis.processedOpSizeForTelemetry += message.contents.length;\n\t\t\t}\n\t\t});\n\n\t\tthis.deltaManager.inbound.on(\"idle\", (count: number, duration: number) => {\n\t\t\t// Do not want to log zero for sure.\n\t\t\t// We are more interested in aggregates, so logging only if we are processing some number of ops\n\t\t\t// Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we\n\t\t\t// want to get answered\n\t\t\t// back-compat: Once 0.36 loader version saturates (count & duration args were added there),\n\t\t\t// we can remove typeof check.\n\t\t\tif (typeof count === \"number\" && count >= 100) {\n\t\t\t\tthis.logger.sendPerformanceEvent({\n\t\t\t\t\teventName: \"GetDeltas_OpProcessing\",\n\t\t\t\t\tcount,\n\t\t\t\t\tduration,\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tcontainerRuntimeEvents.on(\"connected\", (newClientId) => {\n\t\t\tthis.clientId = newClientId;\n\t\t});\n\t}\n\n\tprivate reportGettingUpToDate(): void {\n\t\tthis.connectionOpSeqNumber = undefined;\n\t\tthis.logger.sendPerformanceEvent(\n\t\t\t{\n\t\t\t\teventName: \"ConnectionSpeed\",\n\t\t\t\tduration: performanceNow() - this.connectionStartTime,\n\t\t\t\tops: this.gap,\n\t\t\t\t// track time to connect only for first connection.\n\t\t\t\ttimeToConnect: this.firstConnection\n\t\t\t\t\t? formatTick(this.connectionStartTime - this.bootTime)\n\t\t\t\t\t: undefined,\n\t\t\t\tfirstConnection: this.firstConnection,\n\t\t\t},\n\t\t\tundefined, // error\n\t\t\tLogLevel.info,\n\t\t);\n\t}\n\n\tprivate recordPingTime(latency: number): void {\n\t\tthis.pingLatency = latency;\n\n\t\t// Log if latency is longer than 1 min\n\t\tif (latency > 1000 * 60) {\n\t\t\tthis.logger.sendErrorEvent({\n\t\t\t\teventName: \"LatencyTooLong\",\n\t\t\t\tduration: latency,\n\t\t\t});\n\t\t}\n\n\t\t// logging one in every DELTA_LATENCY_SAMPLE_RATE pongs, including the first time, if it is a \"write\" client.\n\t\tif (this.deltaManager.active) {\n\t\t\tthis.deltaLatencyLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"DeltaLatency\",\n\t\t\t\tduration: latency,\n\t\t\t});\n\t\t}\n\t}\n\n\tprivate beforeOpSubmit(message: IDocumentMessage): void {\n\t\t// start with first client op and measure latency every 500 client ops\n\t\tif (\n\t\t\tthis.opLatencyLogger.isSamplingDisabled ||\n\t\t\t(this.clientSequenceNumberForLatencyStatistics === undefined &&\n\t\t\t\tmessage.clientSequenceNumber % OpPerfTelemetry.OP_LATENCY_SAMPLE_RATE === 1)\n\t\t) {\n\t\t\tassert(\n\t\t\t\tthis.latencyStatistics.get(message.clientSequenceNumber) === undefined,\n\t\t\t\t0x7c4 /* Existing op perf data for client sequence number */,\n\t\t\t);\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;\n\t\t\tthis.latencyStatistics.set(message.clientSequenceNumber, {\n\t\t\t\topProcessingTimes: {\n\t\t\t\t\tsubmitOpEventTime: Date.now(),\n\t\t\t\t},\n\t\t\t\topPerfData: {},\n\t\t\t});\n\t\t}\n\n\t\tif (message.type === MessageType.NoOp) {\n\t\t\t// Count the number of no-ops submitted by this client.\n\t\t\t// The value is reset when we log the OpStats sampled event.\n\t\t\tthis.noOpCountForTelemetry++;\n\t\t}\n\t}\n\n\tprivate afterProcessingOp(message: ISequencedDocumentMessage): void {\n\t\tconst sequenceNumber = message.sequenceNumber;\n\n\t\tif (sequenceNumber === this.connectionOpSeqNumber) {\n\t\t\tthis.reportGettingUpToDate();\n\t\t}\n\n\t\t// Record collab window max size after every 1000th op.\n\t\tif (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {\n\t\t\tthis.sequenceNumberForMsnTracking = sequenceNumber;\n\t\t\tthis.msnTrackingTimestamp = message.timestamp;\n\t\t}\n\t\tif (\n\t\t\tthis.sequenceNumberForMsnTracking !== undefined &&\n\t\t\tmessage.minimumSequenceNumber >= this.sequenceNumberForMsnTracking\n\t\t) {\n\t\t\tassert(\n\t\t\t\tthis.msnTrackingTimestamp !== undefined,\n\t\t\t\t0x2ce /* \"msnTrackingTimestamp should not be undefined\" */,\n\t\t\t);\n\t\t\tthis.logger.sendPerformanceEvent({\n\t\t\t\teventName: \"MsnStatistics\",\n\t\t\t\tsequenceNumber,\n\t\t\t\tmsnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,\n\t\t\t\tduration: message.timestamp - this.msnTrackingTimestamp,\n\t\t\t});\n\t\t\tthis.sequenceNumberForMsnTracking = undefined;\n\t\t}\n\n\t\tif (\n\t\t\tthis.clientId === message.clientId &&\n\t\t\tmessage.type === MessageType.Operation &&\n\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber)\n\t\t) {\n\t\t\t// We do an explicit check for undefined right after this\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tconst latencyData = this.latencyStatistics.get(message.clientSequenceNumber)!;\n\t\t\tassert(latencyData !== undefined, 0x7c5 /* Undefined latency statistics for op */);\n\t\t\tassert(\n\t\t\t\tlatencyData.opProcessingTimes.submitOpEventTime !== undefined,\n\t\t\t\t0x120 /* \"Undefined latency statistics for op (op send time)\" */,\n\t\t\t);\n\t\t\tconst currentTime = Date.now();\n\t\t\tif (latencyData.opProcessingTimes.inboundPushEventTime !== undefined) {\n\t\t\t\tlatencyData.opPerfData.durationInboundToProcessing =\n\t\t\t\t\tcurrentTime - latencyData.opProcessingTimes.inboundPushEventTime;\n\t\t\t}\n\t\t\tconst duration = currentTime - latencyData.opProcessingTimes.submitOpEventTime;\n\n\t\t\t// One of the core expectations for Fluid service is to be fast.\n\t\t\t// When it's not the case, we want to learn about it and be able to investigate, so\n\t\t\t// raise awareness.\n\t\t\t// This also helps identify cases where it's due to client behavior (sending too many ops)\n\t\t\t// that results in overwhelming ordering service and thus starting to see long latencies.\n\t\t\t// The threshold could be adjusted, but ideally it stays  workload-agnostic, as service\n\t\t\t// performance impacts all workloads relying on service.\n\t\t\tconst category = duration > latencyThreshold ? \"error\" : \"performance\";\n\t\t\tthis.opLatencyLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"OpRoundtripTime\",\n\t\t\t\tsequenceNumber,\n\t\t\t\treferenceSequenceNumber: message.referenceSequenceNumber,\n\t\t\t\tduration,\n\t\t\t\tcategory,\n\t\t\t\tpingLatency: this.pingLatency,\n\t\t\t\tmsnDistance:\n\t\t\t\t\tthis.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber,\n\t\t\t\t...latencyData.opPerfData,\n\t\t\t});\n\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = undefined;\n\t\t\tthis.latencyStatistics.delete(message.clientSequenceNumber);\n\t\t}\n\n\t\tif (isRuntimeMessage(message)) {\n\t\t\t// Sampled logging of Ops that have been processed by the current client, the NoOp sent and the\n\t\t\t// size of the ops processed within one sampling window of this log event.\n\t\t\t// This data will be used to monitor the efficiency of NoOp-heuristics or to get approximate collab window size.\n\t\t\tthis.opsLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"OpStats\",\n\t\t\t\t// Logging as 'details' property to avoid adding new column name to the log tables */\n\t\t\t\tdetails: {\n\t\t\t\t\t// Count of the ops processed by the current client. Note: these counts are after\n\t\t\t\t\t// compression/grouping/chunking (if enabled) of the ops.\n\t\t\t\t\tprocessedOpCount: OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE,\n\t\t\t\t\t// Cumulative size of all the ops processed by the current client since the last OpStats event log\n\t\t\t\t\tprocessedOpSize: this.processedOpSizeForTelemetry,\n\t\t\t\t\t// Count of all the NoOp sent by the current client since the last OpStats event log\n\t\t\t\t\tsubmitedNoOpCount: this.noOpCountForTelemetry,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\t}\n}\n\n/**\n * Starts monitoring and generation of telemetry related to op performance.\n *\n * @param clientId - The clientId of the current container.\n * @param deltaManager - DeltaManager instance to monitor.\n * @param containerRuntimeEvents - Emitter of events for the container runtime.\n * @param logger - Telemetry logger to write events to.\n */\nexport function ReportOpPerfTelemetry(\n\tclientId: string | undefined,\n\tdeltaManager: IDeltaManagerFull,\n\tcontainerRuntimeEvents: IEventProvider<IContainerRuntimeEvents>,\n\tlogger: ITelemetryBaseLogger,\n): void {\n\tnew OpPerfTelemetry(\n\t\tclientId,\n\t\tdeltaManager,\n\t\tcontainerRuntimeEvents,\n\t\tcreateChildLogger({ logger }),\n\t);\n}\n"]}
+{"version":3,"file":"connectionTelemetry.js","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAqdH,sDAYC;AA/dD,+DAA8D;AAI9D,qEAA2D;AAC3D,kEAA6D;AAC7D,0EAIqD;AACrD,oEAAyE;AACzE,uEAOkD;AAElD;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,CAAC;AA8CrC,MAAM,eAAe;IAkEX;IAIS;IArEV,WAAW,CAAqB;IAExC,8DAA8D;IACtD,4BAA4B,CAAqB;IACjD,oBAAoB,GAAW,CAAC,CAAC;IACzC,0DAA0D;IAClD,wCAAwC,CAAqB;IACrE,sEAAsE;IACrD,iBAAiB,GAAG,IAAI,GAAG,EAMzC,CAAC;IAEI,eAAe,GAAG,IAAI,CAAC;IACvB,qBAAqB,CAAqB;IACjC,QAAQ,GAAG,IAAA,6BAAc,GAAE,CAAC;IACrC,mBAAmB,GAAG,CAAC,CAAC;IACxB,GAAG,GAAG,CAAC,CAAC;IAEhB;;OAEG;IACK,qBAAqB,GAAG,CAAC,CAAC;IAClC;;OAEG;IACK,2BAA2B,GAAG,CAAC,CAAC;IAEvB,MAAM,CAAqB;IAEpC,MAAM,CAAU,sBAAsB,GAAG,GAAG,CAAC;IACpC,eAAe,CAA0B;IAElD,MAAM,CAAU,yBAAyB,GAAG,GAAG,CAAC;IACvC,kBAAkB,CAA0B;IAErD,MAAM,CAAU,yBAAyB,GAAG,GAAG,CAAC;IAExD;;;;;OAKG;IACc,SAAS,CAA0B;IAEpD;;;;;;;OAOG;IACH;IACC;;;;;;OAMG;IACK,QAA4B;IACpC;;OAEG;IACc,YAA+B;IAChD;;OAEG;IACH,sBAA+D;IAC/D;;OAEG;IACH,MAA0B;QAZlB,aAAQ,GAAR,QAAQ,CAAoB;QAInB,iBAAY,GAAZ,YAAY,CAAmB;QAUhD,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEjE,MAAM,wBAAwB,GAAkB,CAAC,GAAG,EAAE;YACrD,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YACpB,OAAO;gBACN,MAAM,EAAE,GAAG,EAAE;oBACZ,UAAU,EAAE,CAAC;oBACb,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,CAAC,yBAAyB,KAAK,CAAC,CAAC;oBAClF,IAAI,YAAY,EAAE,CAAC;wBAClB,UAAU,GAAG,CAAC,CAAC;oBAChB,CAAC;oBACD,OAAO,YAAY,CAAC;gBACrB,CAAC;aACD,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QAEL,IAAI,CAAC,kBAAkB,GAAG,IAAA,8BAAmB,EAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAEhF,4FAA4F;QAC5F,4GAA4G;QAC5G,wFAAwF;QACxF,IAAI,CAAC,eAAe,GAAG,IAAA,8BAAmB,EAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAkB,CAAC,GAAG,EAAE;YAC5C,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,OAAO;gBACN,MAAM,EAAE,GAAG,EAAE;oBACZ,UAAU,EAAE,CAAC;oBACb,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,CAAC,yBAAyB,KAAK,CAAC,CAAC;oBAClF,IAAI,YAAY,EAAE,CAAC;wBAClB,UAAU,GAAG,CAAC,CAAC;wBACf,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;wBAC/B,IAAI,CAAC,2BAA2B,GAAG,CAAC,CAAC;oBACtC,CAAC;oBACD,OAAO,YAAY,CAAC;gBACrB,CAAC;aACD,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QACL,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAmB,EACnC,MAAM,EACN,eAAe,EACf,IAAI,CAAC,uCAAuC,CAC5C,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;YACtD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC7B,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBAClE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;gBACrB,IAAI,CAAC,mBAAmB,GAAG,IAAA,6BAAc,GAAE,CAAC;gBAE5C,6DAA6D;gBAC7D,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;oBACnB,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC9B,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACvC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;YAC9C,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBAC5B,IACC,GAAG,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;oBAClC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;wBACvC,IAAI,CAAC,wCAAwC,KAAK,GAAG,CAAC,oBAAoB,CAAC,EAC3E,CAAC;oBACF,oEAAoE;oBACpE,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAE,CAAC;oBAC3E,IAAA,iBAAM,EAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;oBAClF,IAAA,iBAAM,EACL,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAClE,KAAK,CAAC,iDAAiD,CACvD,CAAC;oBACF,IAAA,iBAAM,EACL,YAAY,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EACrD,KAAK,CAAC,2CAA2C,CACjD,CAAC;oBACF,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAElE,IAAA,iBAAM,EACL,YAAY,CAAC,UAAU,CAAC,wBAAwB,KAAK,SAAS,EAC9D,KAAK,CAAC,oDAAoD,CAC1D,CAAC;oBAEF,IAAA,iBAAM,EACL,YAAY,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EAC9D,KAAK,CAAC,6CAA6C,CACnD,CAAC;oBAEF,YAAY,CAAC,UAAU,CAAC,wBAAwB;wBAC/C,YAAY,CAAC,iBAAiB,CAAC,qBAAqB;4BACpD,YAAY,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;gBACnD,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC3E,IACC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAClC,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;gBACtC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;oBACvC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,CAAC,EAC/E,CAAC;gBACF,yDAAyD;gBACzD,oEAAoE;gBACpE,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAE,CAAC;gBAC/E,IAAA,iBAAM,EAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAClF,IAAI,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;oBACxE,YAAY,CAAC,iBAAiB,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACjE,YAAY,CAAC,UAAU,CAAC,eAAe;wBACtC,YAAY,CAAC,iBAAiB,CAAC,oBAAoB;4BACnD,YAAY,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;oBACtD,YAAY,CAAC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;gBAC/E,CAAC;YACF,CAAC;YACD,IAAI,IAAA,2BAAgB,EAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACvE,IAAI,CAAC,2BAA2B,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC7D,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,QAAgB,EAAE,EAAE;YACxE,oCAAoC;YACpC,gGAAgG;YAChG,0GAA0G;YAC1G,uBAAuB;YACvB,4FAA4F;YAC5F,8BAA8B;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;gBAC/C,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAChC,SAAS,EAAE,wBAAwB;oBACnC,KAAK;oBACL,QAAQ;iBACR,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,sBAAsB,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YACtD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC7B,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB;QAC5B,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAC/B;YACC,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,IAAA,6BAAc,GAAE,GAAG,IAAI,CAAC,mBAAmB;YACrD,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,mDAAmD;YACnD,aAAa,EAAE,IAAI,CAAC,eAAe;gBAClC,CAAC,CAAC,IAAA,qBAAU,EAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC;gBACtD,CAAC,CAAC,SAAS;YACZ,eAAe,EAAE,IAAI,CAAC,eAAe;SACrC,EACD,SAAS,EAAE,QAAQ;QACnB,0BAAQ,CAAC,IAAI,CACb,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,OAAe;QACrC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,sCAAsC;QACtC,IAAI,OAAO,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBAC1B,SAAS,EAAE,gBAAgB;gBAC3B,QAAQ,EAAE,OAAO;aACjB,CAAC,CAAC;QACJ,CAAC;QAED,6GAA6G;QAC7G,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC;gBAC5C,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,OAAO;aACjB,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAEO,cAAc,CAAC,OAAyB;QAC/C,sEAAsE;QACtE,IACC,IAAI,CAAC,eAAe,CAAC,kBAAkB;YACvC,CAAC,IAAI,CAAC,wCAAwC,KAAK,SAAS;gBAC3D,OAAO,CAAC,oBAAoB,GAAG,eAAe,CAAC,sBAAsB,KAAK,CAAC,CAAC,EAC5E,CAAC;YACF,IAAA,iBAAM,EACL,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAK,SAAS,EACtE,KAAK,CAAC,sDAAsD,CAC5D,CAAC;YACF,IAAI,CAAC,wCAAwC,GAAG,OAAO,CAAC,oBAAoB,CAAC;YAC7E,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE;gBACxD,iBAAiB,EAAE;oBAClB,iBAAiB,EAAE,IAAI,CAAC,GAAG,EAAE;iBAC7B;gBACD,UAAU,EAAE,EAAE;aACd,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,IAAI,EAAE,CAAC;YACvC,uDAAuD;YACvD,4DAA4D;YAC5D,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC9B,CAAC;IACF,CAAC;IAEO,iBAAiB,CAAC,OAAkC;QAC3D,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAE9C,IAAI,cAAc,KAAK,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACnD,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC9B,CAAC;QAED,uDAAuD;QACvD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC;YACpF,IAAI,CAAC,4BAA4B,GAAG,cAAc,CAAC;YACnD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;QAC/C,CAAC;QACD,IACC,IAAI,CAAC,4BAA4B,KAAK,SAAS;YAC/C,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,4BAA4B,EACjE,CAAC;YACF,IAAA,iBAAM,EACL,IAAI,CAAC,oBAAoB,KAAK,SAAS,EACvC,KAAK,CAAC,oDAAoD,CAC1D,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAChC,SAAS,EAAE,eAAe;gBAC1B,cAAc;gBACd,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC,4BAA4B;gBAC/D,QAAQ,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,oBAAoB;aACvD,CAAC,CAAC;YACH,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAC/C,CAAC;QAED,IACC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAClC,OAAO,CAAC,IAAI,KAAK,sBAAW,CAAC,SAAS;YACtC,CAAC,IAAI,CAAC,eAAe,CAAC,kBAAkB;gBACvC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,CAAC,EAC/E,CAAC;YACF,yDAAyD;YACzD,oEAAoE;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAE,CAAC;YAC9E,IAAA,iBAAM,EAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YACnF,IAAA,iBAAM,EACL,WAAW,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EAC7D,KAAK,CAAC,0DAA0D,CAChE,CAAC;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC/B,IAAI,WAAW,CAAC,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACtE,WAAW,CAAC,UAAU,CAAC,2BAA2B;oBACjD,WAAW,GAAG,WAAW,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;YACnE,CAAC;YACD,MAAM,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;YAE/E,gEAAgE;YAChE,mFAAmF;YACnF,mBAAmB;YACnB,0FAA0F;YAC1F,yFAAyF;YACzF,uFAAuF;YACvF,wDAAwD;YACxD,MAAM,QAAQ,GAAG,QAAQ,GAAG,wBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;YACvE,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC;gBACzC,SAAS,EAAE,iBAAiB;gBAC5B,cAAc;gBACd,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;gBACxD,QAAQ;gBACR,QAAQ;gBACR,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,WAAW,EACV,IAAI,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,qBAAqB;gBAC/E,GAAG,WAAW,CAAC,UAAU;aACzB,CAAC,CAAC;YAEH,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,IAAA,2BAAgB,EAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,+FAA+F;YAC/F,0EAA0E;YAC1E,gHAAgH;YAChH,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;gBACnC,SAAS,EAAE,SAAS;gBACpB,qFAAqF;gBACrF,OAAO,EAAE;oBACR,iFAAiF;oBACjF,yDAAyD;oBACzD,gBAAgB,EAAE,eAAe,CAAC,yBAAyB;oBAC3D,kGAAkG;oBAClG,eAAe,EAAE,IAAI,CAAC,2BAA2B;oBACjD,oFAAoF;oBACpF,iBAAiB,EAAE,IAAI,CAAC,qBAAqB;iBAC7C;aACD,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;;AAGF;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACpC,QAA4B,EAC5B,YAA+B,EAC/B,sBAA+D,EAC/D,MAA4B;IAE5B,IAAI,eAAe,CAClB,QAAQ,EACR,YAAY,EACZ,sBAAsB,EACtB,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,CAAC,CAC7B,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { performanceNow } from \"@fluid-internal/client-utils\";\nimport type { IDeltaManagerFull } from \"@fluidframework/container-definitions/internal\";\nimport type { IContainerRuntimeEvents } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type { ITelemetryBaseLogger, IEventProvider } from \"@fluidframework/core-interfaces\";\nimport { LogLevel } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\ttype IDocumentMessage,\n\tMessageType,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { isRuntimeMessage } from \"@fluidframework/driver-utils/internal\";\nimport {\n\tcreateChildLogger,\n\tcreateSampledLogger,\n\tformatTick,\n\ttype IEventSampler,\n\ttype ISampledTelemetryLogger,\n\ttype TelemetryLoggerExt,\n} from \"@fluidframework/telemetry-utils/internal\";\n\n/**\n * We report various latency-related errors when waiting for op roundtrip takes longer than that amout of time.\n */\nexport const latencyThreshold = 5000;\n\n// Phases in OpPerfTelemetry:\n// 1.\tOp is added to DeltaManager (DM) buffer.\n// 2.\tOp is sent to service (op leaves outbound queue).\n// \t - Note: We do not know for sure when op is sent, we only track when it is added to outbound queue.\n//     If outbound queue is paused, time queue is paused is counted as network time.\n// 3.\tOp received from service back (pushed to inbound queue).\n// 4.\tOp is processed.\ninterface IOpPerfTelemetryProperties {\n\t/**\n\t * Measure time between (1) and (2) - Measure time outbound op is sitting in queue due to active batch\n\t */\n\tdurationOutboundBatching: number; // was durationOutboundQueue in previous versions\n\t/**\n\t * Measure time between (2) and (3) - Track how long it took for op to be acked by service\n\t */\n\tdurationNetwork: number; // was durationInboundQueue\n\t/**\n\t * Measure time between (3) and (4) - Time between DM's inbound \"push\" event until DM's \"op\" event\n\t */\n\tdurationInboundToProcessing: number;\n\t/**\n\t * Length of the DeltaManager's inbound queue at the time of the DM's inbound \"push\" event (3)\n\t */\n\tlengthInboundQueue: number;\n}\n\n/**\n * Timings collected at various moments during the op processing.\n */\ninterface IOpPerfTimings {\n\t/**\n\t * Starting time for (1)\n\t */\n\tsubmitOpEventTime: number;\n\t/**\n\t * Starting time for (2)\n\t */\n\toutboundPushEventTime: number;\n\t/**\n\t * Starting time for (3)\n\t */\n\tinboundPushEventTime: number;\n}\n\nclass OpPerfTelemetry {\n\tprivate pingLatency: number | undefined;\n\n\t// Collab window tracking. This is timestamp of %1000 message.\n\tprivate sequenceNumberForMsnTracking: number | undefined;\n\tprivate msnTrackingTimestamp: number = 0;\n\t// To track round trip time for every %500 client message.\n\tprivate clientSequenceNumberForLatencyStatistics: number | undefined;\n\t// Performance Data to be reported for ops round trips and processing.\n\tprivate readonly latencyStatistics = new Map<\n\t\tnumber,\n\t\t{\n\t\t\topProcessingTimes: Partial<IOpPerfTimings>;\n\t\t\topPerfData: Partial<IOpPerfTelemetryProperties>;\n\t\t}\n\t>();\n\n\tprivate firstConnection = true;\n\tprivate connectionOpSeqNumber: number | undefined;\n\tprivate readonly bootTime = performanceNow();\n\tprivate connectionStartTime = 0;\n\tprivate gap = 0;\n\n\t/**\n\t * Count of no-ops sent by this client. This variable is reset everytime the OpStats sampled event is logged\n\t */\n\tprivate noOpCountForTelemetry = 0;\n\t/**\n\t * Cumulative size of the ops processed by this client. This variable is reset everytime the OpStats sampled event is logged\n\t */\n\tprivate processedOpSizeForTelemetry = 0;\n\n\tprivate readonly logger: TelemetryLoggerExt;\n\n\tprivate static readonly OP_LATENCY_SAMPLE_RATE = 500;\n\tprivate readonly opLatencyLogger: ISampledTelemetryLogger;\n\n\tprivate static readonly DELTA_LATENCY_SAMPLE_RATE = 100;\n\tprivate readonly deltaLatencyLogger: ISampledTelemetryLogger;\n\n\tprivate static readonly PROCESSED_OPS_SAMPLE_RATE = 500;\n\n\t/**\n\t * A sampled logger to log Ops that have been processed by the current client, the NoOp sent and the\n\t * size of the ops processed within one sampling window of this log event.\n\t * The data from this logger will be used to monitor the efficiency of NoOp-heuristics or to get approximate collab window size.\n\t * Note: no log events are sent when sampling is disabled, because logging at every op will be too noisy.\n\t */\n\tprivate readonly opsLogger: ISampledTelemetryLogger;\n\n\t/**\n\t * Create an instance of OpPerfTelemetry which starts monitoring and generating telemetry related to op performance.\n\t *\n\t * @param clientId - The clientId of the current container.\n\t * @param deltaManager - DeltaManager instance to monitor.\n\t * @param containerRuntimeEvents - Emitter of events for the container runtime.\n\t * @param logger - Telemetry logger to write events to.\n\t */\n\tpublic constructor(\n\t\t/**\n\t\t * The clientId of the current container.\n\t\t *\n\t\t * @remarks Until the container connects to the server and receives an ack for its own join op, this can be undefined.\n\t\t * It gets updated in response to event changes once the value provided by the server is available.\n\t\t * If the container loses its connection, this could be the last known clientId.\n\t\t */\n\t\tprivate clientId: string | undefined,\n\t\t/**\n\t\t * DeltaManager instance to monitor.\n\t\t */\n\t\tprivate readonly deltaManager: IDeltaManagerFull,\n\t\t/**\n\t\t * Emitter of events for the container runtime.\n\t\t */\n\t\tcontainerRuntimeEvents: IEventProvider<IContainerRuntimeEvents>,\n\t\t/**\n\t\t * Telemetry logger to write events to.\n\t\t */\n\t\tlogger: TelemetryLoggerExt,\n\t) {\n\t\tthis.logger = createChildLogger({ logger, namespace: \"OpPerf\" });\n\n\t\tconst deltaLatencyEventSampler: IEventSampler = (() => {\n\t\t\tlet eventCount = -1;\n\t\t\treturn {\n\t\t\t\tsample: () => {\n\t\t\t\t\teventCount++;\n\t\t\t\t\tconst shouldSample = eventCount % OpPerfTelemetry.DELTA_LATENCY_SAMPLE_RATE === 0;\n\t\t\t\t\tif (shouldSample) {\n\t\t\t\t\t\teventCount = 0;\n\t\t\t\t\t}\n\t\t\t\t\treturn shouldSample;\n\t\t\t\t},\n\t\t\t};\n\t\t})();\n\n\t\tthis.deltaLatencyLogger = createSampledLogger(logger, deltaLatencyEventSampler);\n\n\t\t// The SampledLogger here is used get access to the isSamplingDisabled property derived from\n\t\t// telemetry config properties. The actual sampling logic for op messages happens outside this SampledLogger\n\t\t// due to complexity of the different asynchronus scenarios of the op message lifecycle.\n\t\tthis.opLatencyLogger = createSampledLogger(logger);\n\n\t\tconst opsEventSampler: IEventSampler = (() => {\n\t\t\tlet eventCount = 0;\n\t\t\treturn {\n\t\t\t\tsample: () => {\n\t\t\t\t\teventCount++;\n\t\t\t\t\tconst shouldSample = eventCount % OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE === 0;\n\t\t\t\t\tif (shouldSample) {\n\t\t\t\t\t\teventCount = 0;\n\t\t\t\t\t\tthis.noOpCountForTelemetry = 0;\n\t\t\t\t\t\tthis.processedOpSizeForTelemetry = 0;\n\t\t\t\t\t}\n\t\t\t\t\treturn shouldSample;\n\t\t\t\t},\n\t\t\t};\n\t\t})();\n\t\tthis.opsLogger = createSampledLogger(\n\t\t\tlogger,\n\t\t\topsEventSampler,\n\t\t\ttrue /* skipLoggingWhenSamplingIsDisabled */,\n\t\t);\n\n\t\tthis.deltaManager.on(\"pong\", (latency) => this.recordPingTime(latency));\n\t\tthis.deltaManager.on(\"submitOp\", (message) => this.beforeOpSubmit(message));\n\t\tthis.deltaManager.on(\"op\", (message) => this.afterProcessingOp(message));\n\t\tthis.deltaManager.on(\"connect\", (details, opsBehind) => {\n\t\t\tif (opsBehind !== undefined) {\n\t\t\t\tthis.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;\n\t\t\t\tthis.gap = opsBehind;\n\t\t\t\tthis.connectionStartTime = performanceNow();\n\n\t\t\t\t// We might be already up-today. If so, report it right away.\n\t\t\t\tif (this.gap <= 0) {\n\t\t\t\t\tthis.reportGettingUpToDate();\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\t\tthis.deltaManager.on(\"disconnect\", () => {\n\t\t\tthis.sequenceNumberForMsnTracking = undefined;\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = undefined;\n\t\t\tthis.connectionOpSeqNumber = undefined;\n\t\t\tthis.firstConnection = false;\n\t\t\tthis.latencyStatistics.clear();\n\t\t});\n\n\t\tthis.deltaManager.outbound.on(\"push\", (messages) => {\n\t\t\tfor (const msg of messages) {\n\t\t\t\tif (\n\t\t\t\t\tmsg.type === MessageType.Operation &&\n\t\t\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber)\n\t\t\t\t) {\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\tconst latencyStats = this.latencyStatistics.get(msg.clientSequenceNumber)!;\n\t\t\t\t\tassert(latencyStats !== undefined, 0x7c2 /* Latency stats for op should exist */);\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime === undefined,\n\t\t\t\t\t\t0x2c8 /* \"outboundPushEventTime should be undefined\" */,\n\t\t\t\t\t);\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opPerfData.durationNetwork === undefined,\n\t\t\t\t\t\t0x2c9 /* \"durationNetwork should be undefined\" */,\n\t\t\t\t\t);\n\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime = Date.now();\n\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opPerfData.durationOutboundBatching === undefined,\n\t\t\t\t\t\t0x2ca /* \"durationOutboundBatching should be undefined\" */,\n\t\t\t\t\t);\n\n\t\t\t\t\tassert(\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.submitOpEventTime !== undefined,\n\t\t\t\t\t\t0x2cb /* \"submitOpEventTime should be undefined\" */,\n\t\t\t\t\t);\n\n\t\t\t\t\tlatencyStats.opPerfData.durationOutboundBatching =\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime -\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.submitOpEventTime;\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n\t\tthis.deltaManager.inbound.on(\"push\", (message: ISequencedDocumentMessage) => {\n\t\t\tif (\n\t\t\t\tthis.clientId === message.clientId &&\n\t\t\t\tmessage.type === MessageType.Operation &&\n\t\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber)\n\t\t\t) {\n\t\t\t\t// We do an explicit check for undefined right after this\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\tconst latencyStats = this.latencyStatistics.get(message.clientSequenceNumber)!;\n\t\t\t\tassert(latencyStats !== undefined, 0x7c3 /* Latency stats for op should exist */);\n\t\t\t\tif (latencyStats.opProcessingTimes.outboundPushEventTime !== undefined) {\n\t\t\t\t\tlatencyStats.opProcessingTimes.inboundPushEventTime = Date.now();\n\t\t\t\t\tlatencyStats.opPerfData.durationNetwork =\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.inboundPushEventTime -\n\t\t\t\t\t\tlatencyStats.opProcessingTimes.outboundPushEventTime;\n\t\t\t\t\tlatencyStats.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (isRuntimeMessage(message) && typeof message.contents === \"string\") {\n\t\t\t\tthis.processedOpSizeForTelemetry += message.contents.length;\n\t\t\t}\n\t\t});\n\n\t\tthis.deltaManager.inbound.on(\"idle\", (count: number, duration: number) => {\n\t\t\t// Do not want to log zero for sure.\n\t\t\t// We are more interested in aggregates, so logging only if we are processing some number of ops\n\t\t\t// Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we\n\t\t\t// want to get answered\n\t\t\t// back-compat: Once 0.36 loader version saturates (count & duration args were added there),\n\t\t\t// we can remove typeof check.\n\t\t\tif (typeof count === \"number\" && count >= 100) {\n\t\t\t\tthis.logger.sendPerformanceEvent({\n\t\t\t\t\teventName: \"GetDeltas_OpProcessing\",\n\t\t\t\t\tcount,\n\t\t\t\t\tduration,\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tcontainerRuntimeEvents.on(\"connected\", (newClientId) => {\n\t\t\tthis.clientId = newClientId;\n\t\t});\n\t}\n\n\tprivate reportGettingUpToDate(): void {\n\t\tthis.connectionOpSeqNumber = undefined;\n\t\tthis.logger.sendPerformanceEvent(\n\t\t\t{\n\t\t\t\teventName: \"ConnectionSpeed\",\n\t\t\t\tduration: performanceNow() - this.connectionStartTime,\n\t\t\t\tops: this.gap,\n\t\t\t\t// track time to connect only for first connection.\n\t\t\t\ttimeToConnect: this.firstConnection\n\t\t\t\t\t? formatTick(this.connectionStartTime - this.bootTime)\n\t\t\t\t\t: undefined,\n\t\t\t\tfirstConnection: this.firstConnection,\n\t\t\t},\n\t\t\tundefined, // error\n\t\t\tLogLevel.info,\n\t\t);\n\t}\n\n\tprivate recordPingTime(latency: number): void {\n\t\tthis.pingLatency = latency;\n\n\t\t// Log if latency is longer than 1 min\n\t\tif (latency > 1000 * 60) {\n\t\t\tthis.logger.sendErrorEvent({\n\t\t\t\teventName: \"LatencyTooLong\",\n\t\t\t\tduration: latency,\n\t\t\t});\n\t\t}\n\n\t\t// logging one in every DELTA_LATENCY_SAMPLE_RATE pongs, including the first time, if it is a \"write\" client.\n\t\tif (this.deltaManager.active) {\n\t\t\tthis.deltaLatencyLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"DeltaLatency\",\n\t\t\t\tduration: latency,\n\t\t\t});\n\t\t}\n\t}\n\n\tprivate beforeOpSubmit(message: IDocumentMessage): void {\n\t\t// start with first client op and measure latency every 500 client ops\n\t\tif (\n\t\t\tthis.opLatencyLogger.isSamplingDisabled ||\n\t\t\t(this.clientSequenceNumberForLatencyStatistics === undefined &&\n\t\t\t\tmessage.clientSequenceNumber % OpPerfTelemetry.OP_LATENCY_SAMPLE_RATE === 1)\n\t\t) {\n\t\t\tassert(\n\t\t\t\tthis.latencyStatistics.get(message.clientSequenceNumber) === undefined,\n\t\t\t\t0x7c4 /* Existing op perf data for client sequence number */,\n\t\t\t);\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;\n\t\t\tthis.latencyStatistics.set(message.clientSequenceNumber, {\n\t\t\t\topProcessingTimes: {\n\t\t\t\t\tsubmitOpEventTime: Date.now(),\n\t\t\t\t},\n\t\t\t\topPerfData: {},\n\t\t\t});\n\t\t}\n\n\t\tif (message.type === MessageType.NoOp) {\n\t\t\t// Count the number of no-ops submitted by this client.\n\t\t\t// The value is reset when we log the OpStats sampled event.\n\t\t\tthis.noOpCountForTelemetry++;\n\t\t}\n\t}\n\n\tprivate afterProcessingOp(message: ISequencedDocumentMessage): void {\n\t\tconst sequenceNumber = message.sequenceNumber;\n\n\t\tif (sequenceNumber === this.connectionOpSeqNumber) {\n\t\t\tthis.reportGettingUpToDate();\n\t\t}\n\n\t\t// Record collab window max size after every 1000th op.\n\t\tif (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {\n\t\t\tthis.sequenceNumberForMsnTracking = sequenceNumber;\n\t\t\tthis.msnTrackingTimestamp = message.timestamp;\n\t\t}\n\t\tif (\n\t\t\tthis.sequenceNumberForMsnTracking !== undefined &&\n\t\t\tmessage.minimumSequenceNumber >= this.sequenceNumberForMsnTracking\n\t\t) {\n\t\t\tassert(\n\t\t\t\tthis.msnTrackingTimestamp !== undefined,\n\t\t\t\t0x2ce /* \"msnTrackingTimestamp should not be undefined\" */,\n\t\t\t);\n\t\t\tthis.logger.sendPerformanceEvent({\n\t\t\t\teventName: \"MsnStatistics\",\n\t\t\t\tsequenceNumber,\n\t\t\t\tmsnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,\n\t\t\t\tduration: message.timestamp - this.msnTrackingTimestamp,\n\t\t\t});\n\t\t\tthis.sequenceNumberForMsnTracking = undefined;\n\t\t}\n\n\t\tif (\n\t\t\tthis.clientId === message.clientId &&\n\t\t\tmessage.type === MessageType.Operation &&\n\t\t\t(this.opLatencyLogger.isSamplingDisabled ||\n\t\t\t\tthis.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber)\n\t\t) {\n\t\t\t// We do an explicit check for undefined right after this\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tconst latencyData = this.latencyStatistics.get(message.clientSequenceNumber)!;\n\t\t\tassert(latencyData !== undefined, 0x7c5 /* Undefined latency statistics for op */);\n\t\t\tassert(\n\t\t\t\tlatencyData.opProcessingTimes.submitOpEventTime !== undefined,\n\t\t\t\t0x120 /* \"Undefined latency statistics for op (op send time)\" */,\n\t\t\t);\n\t\t\tconst currentTime = Date.now();\n\t\t\tif (latencyData.opProcessingTimes.inboundPushEventTime !== undefined) {\n\t\t\t\tlatencyData.opPerfData.durationInboundToProcessing =\n\t\t\t\t\tcurrentTime - latencyData.opProcessingTimes.inboundPushEventTime;\n\t\t\t}\n\t\t\tconst duration = currentTime - latencyData.opProcessingTimes.submitOpEventTime;\n\n\t\t\t// One of the core expectations for Fluid service is to be fast.\n\t\t\t// When it's not the case, we want to learn about it and be able to investigate, so\n\t\t\t// raise awareness.\n\t\t\t// This also helps identify cases where it's due to client behavior (sending too many ops)\n\t\t\t// that results in overwhelming ordering service and thus starting to see long latencies.\n\t\t\t// The threshold could be adjusted, but ideally it stays  workload-agnostic, as service\n\t\t\t// performance impacts all workloads relying on service.\n\t\t\tconst category = duration > latencyThreshold ? \"error\" : \"performance\";\n\t\t\tthis.opLatencyLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"OpRoundtripTime\",\n\t\t\t\tsequenceNumber,\n\t\t\t\treferenceSequenceNumber: message.referenceSequenceNumber,\n\t\t\t\tduration,\n\t\t\t\tcategory,\n\t\t\t\tpingLatency: this.pingLatency,\n\t\t\t\tmsnDistance:\n\t\t\t\t\tthis.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber,\n\t\t\t\t...latencyData.opPerfData,\n\t\t\t});\n\n\t\t\tthis.clientSequenceNumberForLatencyStatistics = undefined;\n\t\t\tthis.latencyStatistics.delete(message.clientSequenceNumber);\n\t\t}\n\n\t\tif (isRuntimeMessage(message)) {\n\t\t\t// Sampled logging of Ops that have been processed by the current client, the NoOp sent and the\n\t\t\t// size of the ops processed within one sampling window of this log event.\n\t\t\t// This data will be used to monitor the efficiency of NoOp-heuristics or to get approximate collab window size.\n\t\t\tthis.opsLogger.sendPerformanceEvent({\n\t\t\t\teventName: \"OpStats\",\n\t\t\t\t// Logging as 'details' property to avoid adding new column name to the log tables */\n\t\t\t\tdetails: {\n\t\t\t\t\t// Count of the ops processed by the current client. Note: these counts are after\n\t\t\t\t\t// compression/grouping/chunking (if enabled) of the ops.\n\t\t\t\t\tprocessedOpCount: OpPerfTelemetry.PROCESSED_OPS_SAMPLE_RATE,\n\t\t\t\t\t// Cumulative size of all the ops processed by the current client since the last OpStats event log\n\t\t\t\t\tprocessedOpSize: this.processedOpSizeForTelemetry,\n\t\t\t\t\t// Count of all the NoOp sent by the current client since the last OpStats event log\n\t\t\t\t\tsubmitedNoOpCount: this.noOpCountForTelemetry,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\t}\n}\n\n/**\n * Starts monitoring and generation of telemetry related to op performance.\n *\n * @param clientId - The clientId of the current container.\n * @param deltaManager - DeltaManager instance to monitor.\n * @param containerRuntimeEvents - Emitter of events for the container runtime.\n * @param logger - Telemetry logger to write events to.\n */\nexport function ReportOpPerfTelemetry(\n\tclientId: string | undefined,\n\tdeltaManager: IDeltaManagerFull,\n\tcontainerRuntimeEvents: IEventProvider<IContainerRuntimeEvents>,\n\tlogger: ITelemetryBaseLogger,\n): void {\n\tnew OpPerfTelemetry(\n\t\tclientId,\n\t\tdeltaManager,\n\t\tcontainerRuntimeEvents,\n\t\tcreateChildLogger({ logger }),\n\t);\n}\n"]}

package/dist/containerCompatibility.d.ts

@@ -37,15 +37,15 @@ export type RuntimeOptionKeysThatRequireExplicitSchemaControl = keyof Omit<Runti
 /**
  * Keys of {@link ContainerRuntimeOptionsInternal} that require explicitSchemaControl to be enabled.
  */
-export declare const runtimeOptionKeysThatRequireExplicitSchemaControl: "createBlobPayloadPending"[];
+export declare const runtimeOptionKeysThatRequireExplicitSchemaControl: RuntimeOptionKeysThatRequireExplicitSchemaControl[];
 /**
  * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.
  */
 export declare function getMinVersionForCollabDefaults(minVersionForCollab: OldestSupportedClientVersion): RuntimeOptionsAffectingDocSchema;
 /**
  * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.
- * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab
- * is set to "1.0.0", then we should throw a UsageError since 1.x clients do not support batching.
+ * For example, if a user enables an option introduced in 2.40.0 while the
+ * minVersionForCollab is set to "2.0.0", then we should throw a UsageError.
  * */
 export declare function validateRuntimeOptions(minVersionForCollab: OldestSupportedClientVersion, runtimeOptions: Partial<ContainerRuntimeOptionsInternal>): void;
 export {};

package/dist/containerCompatibility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"containerCompatibility.d.ts","sourceRoot":"","sources":["../src/containerCompatibility.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,KAAK,4BAA4B,EACjC,MAAM,8CAA8C,CAAC;AAatD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAClD,+BAA+B,EAC7B,kBAAkB,GAClB,qBAAqB,GACrB,gCAAgC,GAChC,gBAAgB,GAChB,+BAA+B,GAC/B,sBAAsB,CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,KAAK,+CAA+C,GAAG,MAAM,IAAI,CAChE,gCAAgC,EAC9B,uBAAuB,GACvB,oBAAoB,GACpB,2BAA2B,GAC3B,WAAW,GACX,WAAW,GACX,uBAAuB,CACzB,CAAC;AAmBF;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAAG,MAAM,IAAI,CACzE,gCAAgC,EAChC,+CAA+C,CAC/C,CAAC;AA4EF;;GAEG;AACH,eAAO,MAAM,iDAAiD,8BAQL,CAAC;AAoC1D;;GAEG;AACH,wBAAgB,8BAA8B,CAC7C,mBAAmB,EAAE,4BAA4B,GAC/C,gCAAgC,CAKlC;AAED;;;;KAIK;AACL,wBAAgB,sBAAsB,CACrC,mBAAmB,EAAE,4BAA4B,EACjD,cAAc,EAAE,OAAO,CAAC,+BAA+B,CAAC,GACtD,IAAI,CAMN"}
+{"version":3,"file":"containerCompatibility.d.ts","sourceRoot":"","sources":["../src/containerCompatibility.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,KAAK,4BAA4B,EACjC,MAAM,8CAA8C,CAAC;AAatD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAClD,+BAA+B,EAC7B,kBAAkB,GAClB,qBAAqB,GACrB,gCAAgC,GAChC,gBAAgB,GAChB,+BAA+B,GAC/B,sBAAsB,CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,KAAK,+CAA+C,GAAG,MAAM,IAAI,CAChE,gCAAgC,EAC9B,uBAAuB,GACvB,oBAAoB,GACpB,2BAA2B,GAC3B,WAAW,GACX,WAAW,GACX,uBAAuB,CACzB,CAAC;AAmBF;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAAG,MAAM,IAAI,CACzE,gCAAgC,EAChC,+CAA+C,CAC/C,CAAC;AAmEF;;GAEG;AACH,eAAO,MAAM,iDAAiD,EAQxD,iDAAiD,EAAE,CAAC;AAoC1D;;GAEG;AACH,wBAAgB,8BAA8B,CAC7C,mBAAmB,EAAE,4BAA4B,GAC/C,gCAAgC,CAKlC;AAED;;;;KAIK;AACL,wBAAgB,sBAAsB,CACrC,mBAAmB,EAAE,4BAA4B,EACjD,cAAc,EAAE,OAAO,CAAC,+BAA+B,CAAC,GACtD,IAAI,CAMN"}

package/dist/containerCompatibility.js

@@ -4,7 +4,9 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateRuntimeOptions = exports.getMinVersionForCollabDefaults = exports.runtimeOptionKeysThatRequireExplicitSchemaControl = void 0;
+exports.runtimeOptionKeysThatRequireExplicitSchemaControl = void 0;
+exports.getMinVersionForCollabDefaults = getMinVersionForCollabDefaults;
+exports.validateRuntimeOptions = validateRuntimeOptions;
 const internal_1 = require("@fluidframework/runtime-definitions/internal");
 const internal_2 = require("@fluidframework/runtime-utils/internal");
 const compressionDefinitions_js_1 = require("./compressionDefinitions.js");
@@ -32,26 +34,27 @@ const keysOfOptionsPredatingExplicitSchemaControl = new Set([
  * the format changes introduced by the property, then the default value for that OldestSupportedClientVersion will enable the feature associated with the property.
  * Otherwise, the feature will be disabled.
  *
- * For example if the minVersionForCollab is a 1.x version (i.e. "1.5.0"), then the default value for `enableGroupedBatching` will be false since 1.x
- * clients do not understand the document format when batching is enabled. If the minVersionForCollab is a 2.x client (i.e. "2.0.0" or later), then the
- * default value for `enableGroupedBatching` will be true because clients running 2.0 or later will be able to understand the format changes associated
- * with the batching feature.
+ * For example, the default value for `enableGroupedBatching` is true at the supported
+ * floor of 2.0.0 because clients running 2.0.0 or later understand the associated
+ * document format.
  */
 const runtimeOptionsAffectingDocSchemaConfigMap = {
     enableGroupedBatching: {
-        "1.0.0": false,
-        "2.0.0-defaults": true,
+        // Grouped batching was already enabled by default before callers explicitly selected
+        // a compatibility version. All supported 2.x clients understand this format.
+        "2.0.0": true,
     },
     compressionOptions: {
-        "1.0.0": compressionDefinitions_js_1.disabledCompressionConfig,
-        "2.0.0-defaults": compressionDefinitions_js_1.enabledCompressionConfig,
+        // Compression was already enabled by default before callers explicitly selected a
+        // compatibility version. All supported 2.x clients understand this format.
+        "2.0.0": compressionDefinitions_js_1.enabledCompressionConfig,
     },
     enableRuntimeIdCompressor: {
         // For IdCompressorMode, `undefined` represents a logical state (off).
         // However, to satisfy the Required<> constraint while
         // `exactOptionalPropertyTypes` is `false` (TODO: AB#8215), we need
         // to have it defined, so we trick the type checker here.
-        "1.0.0": undefined,
+        "2.0.0": undefined,
         // We do not yet want to enable idCompressor by default since it will
         // increase bundle sizes, and not all customers will benefit from it.
         // Therefore, we will require customers to explicitly enable it. We
@@ -59,28 +62,18 @@ const runtimeOptionsAffectingDocSchemaConfigMap = {
         // change in the future.
     },
     explicitSchemaControl: {
-        "1.0.0": false,
         // This option's intention is to prevent 1.x clients from joining sessions
-        // when enabled. This is set to true when the minVersionForCollab is set
-        // to >=2.0.0 (explicitly). This is different than other 2.0 defaults
-        // because it was not enabled by default prior to the implementation of
-        // `minVersionForCollab`.
-        // `defaultMinVersionForCollab` is set to "2.0.0-defaults" which "2.0.0"
-        // does not satisfy to avoiding enabling this option by default as of
-        // `minVersionForCollab` introduction, which could be unexpected.
-        // Only enable as a default when `minVersionForCollab` is specified at
-        // 2.0.0+.
+        // when enabled. Before Client 3.0, this became true only when callers explicitly
+        // selected 2.0.0 or later. Client 3.0 also uses 2.0.0 when the setting is omitted.
         "2.0.0": true,
     },
     flushMode: {
-        // Note: 1.x clients are compatible with TurnBased flushing, but here we elect to remain on Immediate flush mode
-        // as a work-around for inability to send batches larger than 1Mb. Immediate flushing keeps batches smaller as
-        // fewer messages will be included per flush.
-        "1.0.0": internal_1.FlushMode.Immediate,
-        "2.0.0-defaults": internal_1.FlushMode.TurnBased,
+        // TurnBased flushing was already the default before callers explicitly selected a
+        // compatibility version.
+        "2.0.0": internal_1.FlushMode.TurnBased,
     },
     gcOptions: {
-        "1.0.0": {},
+        "2.0.0": {},
         // Although sweep is supported in 2.x, it is disabled by default until minVersionForCollab>=3.0.0 to be extra safe.
         // Note that enabling this is a significant change, that should likely be announced in the relevant version:
         // It would be bad if this simple caused the enablement when when the current package version passed this point without anyone being aware.
@@ -93,7 +86,7 @@ const runtimeOptionsAffectingDocSchemaConfigMap = {
         // This feature is new and disabled by default. In the future we will enable it by default, but we have not
         // closed on the version where that will happen yet.  Probably a .10 release since blob functionality is not
         // exposed on the `@public` API surface.
-        "1.0.0": undefined,
+        "2.0.0": undefined,
     },
 };
 /**
@@ -105,32 +98,32 @@ exports.runtimeOptionKeysThatRequireExplicitSchemaControl = Object.keys(runtimeO
 // A lot of the information in this seems redundant with whats defined above. Might be nice to combine them somehow.
 const runtimeOptionsAffectingDocSchemaConfigValidationMap = {
     enableGroupedBatching: (0, internal_2.configValueToMinVersionForCollab)([
-        [false, "1.0.0"],
-        [true, "2.0.0-defaults"],
+        [false, "2.0.0"],
+        [true, "2.0.0"],
     ]),
     compressionOptions: (0, internal_2.configValueToMinVersionForCollab)([
-        [{ ...compressionDefinitions_js_1.disabledCompressionConfig }, "1.0.0"],
-        [{ ...compressionDefinitions_js_1.enabledCompressionConfig }, "2.0.0-defaults"],
+        [{ ...compressionDefinitions_js_1.disabledCompressionConfig }, "2.0.0"],
+        [{ ...compressionDefinitions_js_1.enabledCompressionConfig }, "2.0.0"],
     ]),
     enableRuntimeIdCompressor: (0, internal_2.configValueToMinVersionForCollab)([
-        [undefined, "1.0.0"],
-        ["on", "2.0.0-defaults"],
-        ["delayed", "2.0.0-defaults"],
+        [undefined, "2.0.0"],
+        ["on", "2.0.0"],
+        ["delayed", "2.0.0"],
     ]),
     explicitSchemaControl: (0, internal_2.configValueToMinVersionForCollab)([
-        [false, "1.0.0"],
-        [true, "2.0.0-defaults"],
+        [false, "2.0.0"],
+        [true, "2.0.0"],
     ]),
     flushMode: (0, internal_2.configValueToMinVersionForCollab)([
-        [internal_1.FlushMode.Immediate, "1.0.0"],
-        [internal_1.FlushMode.TurnBased, "2.0.0-defaults"],
+        [internal_1.FlushMode.Immediate, "2.0.0"],
+        [internal_1.FlushMode.TurnBased, "2.0.0"],
     ]),
     gcOptions: (0, internal_2.configValueToMinVersionForCollab)([
-        [{ enableGCSweep: undefined }, "1.0.0"],
-        [{ enableGCSweep: true }, "2.0.0-defaults"],
+        [{ enableGCSweep: undefined }, "2.0.0"],
+        [{ enableGCSweep: true }, "2.0.0"],
     ]),
     createBlobPayloadPending: (0, internal_2.configValueToMinVersionForCollab)([
-        [undefined, "1.0.0"],
+        [undefined, "2.0.0"],
         [true, "2.40.0"],
     ]),
 };
@@ -140,14 +133,12 @@ const runtimeOptionsAffectingDocSchemaConfigValidationMap = {
 function getMinVersionForCollabDefaults(minVersionForCollab) {
     return (0, internal_2.getConfigsForMinVersionForCollab)(minVersionForCollab, runtimeOptionsAffectingDocSchemaConfigMap);
 }
-exports.getMinVersionForCollabDefaults = getMinVersionForCollabDefaults;
 /**
  * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.
- * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab
- * is set to "1.0.0", then we should throw a UsageError since 1.x clients do not support batching.
+ * For example, if a user enables an option introduced in 2.40.0 while the
+ * minVersionForCollab is set to "2.0.0", then we should throw a UsageError.
  * */
 function validateRuntimeOptions(minVersionForCollab, runtimeOptions) {
     (0, internal_2.validateConfigMapOverrides)(minVersionForCollab, runtimeOptions, runtimeOptionsAffectingDocSchemaConfigValidationMap);
 }
-exports.validateRuntimeOptions = validateRuntimeOptions;
 //# sourceMappingURL=containerCompatibility.js.map

package/dist/containerCompatibility.js.map

@@ -1 +1 @@
-{"version":3,"file":"containerCompatibility.js","sourceRoot":"","sources":["../src/containerCompatibility.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2EAGsD;AACtD,qEAMgD;AAEhD,2EAGqC;AA+CrC;;;;;;;GAOG;AACH,MAAM,2CAA2C,GAAG,IAAI,GAAG,CAAC;IAC3D,uBAAuB;IACvB,oBAAoB;IACpB,2BAA2B;IAC3B,WAAW;IACX,WAAW;IACX,uBAAuB;CACvB,CAAgE,CAAC;AAUlE;;;;;;;;;;;;GAYG;AACH,MAAM,yCAAyC,GAC9C;IACC,qBAAqB,EAAE;QACtB,OAAO,EAAE,KAAK;QACd,gBAAgB,EAAE,IAAI;KACtB;IACD,kBAAkB,EAAE;QACnB,OAAO,EAAE,qDAAyB;QAClC,gBAAgB,EAAE,oDAAwB;KAC1C;IACD,yBAAyB,EAAE;QAC1B,sEAAsE;QACtE,sDAAsD;QACtD,mEAAmE;QACnE,yDAAyD;QACzD,OAAO,EAAE,SAAS;QAClB,qEAAqE;QACrE,qEAAqE;QACrE,mEAAmE;QACnE,qEAAqE;QACrE,wBAAwB;KACxB;IACD,qBAAqB,EAAE;QACtB,OAAO,EAAE,KAAK;QACd,0EAA0E;QAC1E,wEAAwE;QACxE,qEAAqE;QACrE,uEAAuE;QACvE,yBAAyB;QACzB,wEAAwE;QACxE,qEAAqE;QACrE,iEAAiE;QACjE,sEAAsE;QACtE,UAAU;QACV,OAAO,EAAE,IAAI;KACb;IACD,SAAS,EAAE;QACV,gHAAgH;QAChH,8GAA8G;QAC9G,6CAA6C;QAC7C,OAAO,EAAE,oBAAS,CAAC,SAAS;QAC5B,gBAAgB,EAAE,oBAAS,CAAC,SAAS;KACrC;IACD,SAAS,EAAE;QACV,OAAO,EAAE,EAAE;QACX,mHAAmH;QACnH,4GAA4G;QAC5G,2IAA2I;QAC3I,6EAA6E;QAC7E,gHAAgH;QAChH,kFAAkF;QAClF,oCAAoC;KACpC;IACD,wBAAwB,EAAE;QACzB,2GAA2G;QAC3G,4GAA4G;QAC5G,wCAAwC;QACxC,OAAO,EAAE,SAAS;KAClB;CACD,CAAC;AAEH;;GAEG;AACU,QAAA,iDAAiD,GAC7D,MAAM,CAAC,IAAI,CACV,yCAAyC,CAE1C,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IAChB,OAAO,CAAC,2CAA2C,CAAC,GAAG,CACtD,GAAsD,CACtD,CAAC;AACH,CAAC,CAAwD,CAAC;AAE1D,oHAAoH;AACpH,MAAM,mDAAmD,GACxD;IACC,qBAAqB,EAAE,IAAA,2CAAgC,EAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,gBAAgB,CAAC;KACxB,CAAC;IACF,kBAAkB,EAAE,IAAA,2CAAgC,EAAC;QACpD,CAAC,EAAE,GAAG,qDAAyB,EAAE,EAAE,OAAO,CAAC;QAC3C,CAAC,EAAE,GAAG,oDAAwB,EAAE,EAAE,gBAAgB,CAAC;KACnD,CAAC;IACF,yBAAyB,EAAE,IAAA,2CAAgC,EAAC;QAC3D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,gBAAgB,CAAC;QACxB,CAAC,SAAS,EAAE,gBAAgB,CAAC;KAC7B,CAAC;IACF,qBAAqB,EAAE,IAAA,2CAAgC,EAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,gBAAgB,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,IAAA,2CAAgC,EAAC;QAC3C,CAAC,oBAAS,CAAC,SAAS,EAAE,OAAO,CAAC;QAC9B,CAAC,oBAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;KACvC,CAAC;IACF,SAAS,EAAE,IAAA,2CAAgC,EAAC;QAC3C,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC;QACvC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,gBAAgB,CAAC;KAC3C,CAAC;IACF,wBAAwB,EAAE,IAAA,2CAAgC,EAAC;QAC1D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,QAAQ,CAAC;KAChB,CAAC;CACF,CAAC;AAEH;;GAEG;AACH,SAAgB,8BAA8B,CAC7C,mBAAiD;IAEjD,OAAO,IAAA,2CAAgC,EACtC,mBAAmB,EACnB,yCAAyC,CACzC,CAAC;AACH,CAAC;AAPD,wEAOC;AAED;;;;KAIK;AACL,SAAgB,sBAAsB,CACrC,mBAAiD,EACjD,cAAwD;IAExD,IAAA,qCAA0B,EACzB,mBAAmB,EACnB,cAAc,EACd,mDAAmD,CACnD,CAAC;AACH,CAAC;AATD,wDASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tFlushMode,\n\ttype OldestSupportedClientVersion,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tconfigValueToMinVersionForCollab,\n\tgetConfigsForMinVersionForCollab,\n\tvalidateConfigMapOverrides,\n\ttype ConfigMap,\n\ttype ConfigValidationMap,\n} from \"@fluidframework/runtime-utils/internal\";\n\nimport {\n\tdisabledCompressionConfig,\n\tenabledCompressionConfig,\n} from \"./compressionDefinitions.js\";\nimport type { ContainerRuntimeOptionsInternal } from \"./containerRuntime.js\";\n\n/**\n * Subset of the {@link ContainerRuntimeOptionsInternal} properties which\n * affect {@link IDocumentSchemaFeatures}.\n *\n * @remarks\n * When a new option is added to {@link ContainerRuntimeOptionsInternal}, we\n * must consider if it changes the DocumentSchema. If so, then a corresponding\n * entry must be added to {@link runtimeOptionsAffectingDocSchemaConfigMap}\n * below. If not, then it must be omitted from this type.\n *\n * Note: `Omit` is used instead of `Pick` to ensure that all new options are\n * included in this type by default. If any new properties are added to\n * {@link ContainerRuntimeOptionsInternal}, they will be included in this\n * type unless explicitly omitted. This will prevent us from forgetting to\n * account for any new properties in the future.\n */\nexport type RuntimeOptionsAffectingDocSchema = Omit<\n\tContainerRuntimeOptionsInternal,\n\t| \"chunkSizeInBytes\"\n\t| \"maxBatchSizeInBytes\"\n\t| \"loadSequenceNumberVerification\"\n\t| \"summaryOptions\"\n\t| \"stagingModeAutoFlushThreshold\"\n\t| \"disableSchemaUpgrade\"\n>;\n\n/**\n * Subset of {@link RuntimeOptionsAffectingDocSchema} which existed prior to the introduction of explicitSchemaControl.\n *\n * @remarks\n * Runtime options that affect document schema should generally require explicitSchemaControl to be enabled.\n * However, to prevent disruption to existing customers, options that existed prior to explicitSchemaControl\n * do not explicity require explicitSchemaControl to be enabled. Do not add new options to this list.\n */\ntype RuntimeOptionKeysPredatingExplicitSchemaControl = keyof Pick<\n\tRuntimeOptionsAffectingDocSchema,\n\t| \"explicitSchemaControl\"\n\t| \"compressionOptions\"\n\t| \"enableRuntimeIdCompressor\"\n\t| \"flushMode\"\n\t| \"gcOptions\"\n\t| \"enableGroupedBatching\"\n>;\n\n/**\n * List of keys of {@link RuntimeOptionsAffectingDocSchema} which existed prior to the introduction of explicitSchemaControl.\n *\n * @remarks\n * Runtime options that affect document schema should generally require explicitSchemaControl to be enabled.\n * However, to prevent disruption to existing customers, options that existed prior to explicitSchemaControl\n * do not explicity require explicitSchemaControl to be enabled. Do not add new keys to this list.\n */\nconst keysOfOptionsPredatingExplicitSchemaControl = new Set([\n\t\"explicitSchemaControl\",\n\t\"compressionOptions\",\n\t\"enableRuntimeIdCompressor\",\n\t\"flushMode\",\n\t\"gcOptions\",\n\t\"enableGroupedBatching\",\n]) satisfies Set<RuntimeOptionKeysPredatingExplicitSchemaControl>;\n\n/**\n * Subset of {@link RuntimeOptionsAffectingDocSchema} which require explicitSchemaControl to be enabled.\n */\nexport type RuntimeOptionKeysThatRequireExplicitSchemaControl = keyof Omit<\n\tRuntimeOptionsAffectingDocSchema,\n\tRuntimeOptionKeysPredatingExplicitSchemaControl\n>;\n\n/**\n * Mapping of RuntimeOptionsAffectingDocSchema to their compatibility related configs.\n *\n * Each key in this map corresponds to a property in RuntimeOptionsAffectingDocSchema. The value is an object that maps OldestSupportedClientVersion\n * to the appropriate default value for that property to supporting that OldestSupportedClientVersion. If clients running OldestSupportedClientVersion X are able to understand\n * the format changes introduced by the property, then the default value for that OldestSupportedClientVersion will enable the feature associated with the property.\n * Otherwise, the feature will be disabled.\n *\n * For example if the minVersionForCollab is a 1.x version (i.e. \"1.5.0\"), then the default value for `enableGroupedBatching` will be false since 1.x\n * clients do not understand the document format when batching is enabled. If the minVersionForCollab is a 2.x client (i.e. \"2.0.0\" or later), then the\n * default value for `enableGroupedBatching` will be true because clients running 2.0 or later will be able to understand the format changes associated\n * with the batching feature.\n */\nconst runtimeOptionsAffectingDocSchemaConfigMap: ConfigMap<RuntimeOptionsAffectingDocSchema> =\n\t{\n\t\tenableGroupedBatching: {\n\t\t\t\"1.0.0\": false,\n\t\t\t\"2.0.0-defaults\": true,\n\t\t},\n\t\tcompressionOptions: {\n\t\t\t\"1.0.0\": disabledCompressionConfig,\n\t\t\t\"2.0.0-defaults\": enabledCompressionConfig,\n\t\t},\n\t\tenableRuntimeIdCompressor: {\n\t\t\t// For IdCompressorMode, `undefined` represents a logical state (off).\n\t\t\t// However, to satisfy the Required<> constraint while\n\t\t\t// `exactOptionalPropertyTypes` is `false` (TODO: AB#8215), we need\n\t\t\t// to have it defined, so we trick the type checker here.\n\t\t\t\"1.0.0\": undefined,\n\t\t\t// We do not yet want to enable idCompressor by default since it will\n\t\t\t// increase bundle sizes, and not all customers will benefit from it.\n\t\t\t// Therefore, we will require customers to explicitly enable it. We\n\t\t\t// are keeping it as a DocSchema affecting option for now as this may\n\t\t\t// change in the future.\n\t\t},\n\t\texplicitSchemaControl: {\n\t\t\t\"1.0.0\": false,\n\t\t\t// This option's intention is to prevent 1.x clients from joining sessions\n\t\t\t// when enabled. This is set to true when the minVersionForCollab is set\n\t\t\t// to >=2.0.0 (explicitly). This is different than other 2.0 defaults\n\t\t\t// because it was not enabled by default prior to the implementation of\n\t\t\t// `minVersionForCollab`.\n\t\t\t// `defaultMinVersionForCollab` is set to \"2.0.0-defaults\" which \"2.0.0\"\n\t\t\t// does not satisfy to avoiding enabling this option by default as of\n\t\t\t// `minVersionForCollab` introduction, which could be unexpected.\n\t\t\t// Only enable as a default when `minVersionForCollab` is specified at\n\t\t\t// 2.0.0+.\n\t\t\t\"2.0.0\": true,\n\t\t},\n\t\tflushMode: {\n\t\t\t// Note: 1.x clients are compatible with TurnBased flushing, but here we elect to remain on Immediate flush mode\n\t\t\t// as a work-around for inability to send batches larger than 1Mb. Immediate flushing keeps batches smaller as\n\t\t\t// fewer messages will be included per flush.\n\t\t\t\"1.0.0\": FlushMode.Immediate,\n\t\t\t\"2.0.0-defaults\": FlushMode.TurnBased,\n\t\t},\n\t\tgcOptions: {\n\t\t\t\"1.0.0\": {},\n\t\t\t// Although sweep is supported in 2.x, it is disabled by default until minVersionForCollab>=3.0.0 to be extra safe.\n\t\t\t// Note that enabling this is a significant change, that should likely be announced in the relevant version:\n\t\t\t// It would be bad if this simple caused the enablement when when the current package version passed this point without anyone being aware.\n\t\t\t// This is configuration targeting a future versions, which is not supported.\n\t\t\t// TODO: when preparing 3.0 (or at some later point), consider enabling this by default for clients 3.0 or newer\n\t\t\t// (and add user facing documentation indicating this is enabled by that version).\n\t\t\t// \"3.0.0\": { enableGCSweep: true },\n\t\t},\n\t\tcreateBlobPayloadPending: {\n\t\t\t// This feature is new and disabled by default. In the future we will enable it by default, but we have not\n\t\t\t// closed on the version where that will happen yet.  Probably a .10 release since blob functionality is not\n\t\t\t// exposed on the `@public` API surface.\n\t\t\t\"1.0.0\": undefined,\n\t\t},\n\t};\n\n/**\n * Keys of {@link ContainerRuntimeOptionsInternal} that require explicitSchemaControl to be enabled.\n */\nexport const runtimeOptionKeysThatRequireExplicitSchemaControl = (\n\tObject.keys(\n\t\truntimeOptionsAffectingDocSchemaConfigMap,\n\t) as (keyof RuntimeOptionsAffectingDocSchema)[]\n).filter((key) => {\n\treturn !keysOfOptionsPredatingExplicitSchemaControl.has(\n\t\tkey as RuntimeOptionKeysPredatingExplicitSchemaControl,\n\t);\n}) as RuntimeOptionKeysThatRequireExplicitSchemaControl[];\n\n// A lot of the information in this seems redundant with whats defined above. Might be nice to combine them somehow.\nconst runtimeOptionsAffectingDocSchemaConfigValidationMap: ConfigValidationMap<RuntimeOptionsAffectingDocSchema> =\n\t{\n\t\tenableGroupedBatching: configValueToMinVersionForCollab([\n\t\t\t[false, \"1.0.0\"],\n\t\t\t[true, \"2.0.0-defaults\"],\n\t\t]),\n\t\tcompressionOptions: configValueToMinVersionForCollab([\n\t\t\t[{ ...disabledCompressionConfig }, \"1.0.0\"],\n\t\t\t[{ ...enabledCompressionConfig }, \"2.0.0-defaults\"],\n\t\t]),\n\t\tenableRuntimeIdCompressor: configValueToMinVersionForCollab([\n\t\t\t[undefined, \"1.0.0\"],\n\t\t\t[\"on\", \"2.0.0-defaults\"],\n\t\t\t[\"delayed\", \"2.0.0-defaults\"],\n\t\t]),\n\t\texplicitSchemaControl: configValueToMinVersionForCollab([\n\t\t\t[false, \"1.0.0\"],\n\t\t\t[true, \"2.0.0-defaults\"],\n\t\t]),\n\t\tflushMode: configValueToMinVersionForCollab([\n\t\t\t[FlushMode.Immediate, \"1.0.0\"],\n\t\t\t[FlushMode.TurnBased, \"2.0.0-defaults\"],\n\t\t]),\n\t\tgcOptions: configValueToMinVersionForCollab([\n\t\t\t[{ enableGCSweep: undefined }, \"1.0.0\"],\n\t\t\t[{ enableGCSweep: true }, \"2.0.0-defaults\"],\n\t\t]),\n\t\tcreateBlobPayloadPending: configValueToMinVersionForCollab([\n\t\t\t[undefined, \"1.0.0\"],\n\t\t\t[true, \"2.40.0\"],\n\t\t]),\n\t};\n\n/**\n * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.\n */\nexport function getMinVersionForCollabDefaults(\n\tminVersionForCollab: OldestSupportedClientVersion,\n): RuntimeOptionsAffectingDocSchema {\n\treturn getConfigsForMinVersionForCollab(\n\t\tminVersionForCollab,\n\t\truntimeOptionsAffectingDocSchemaConfigMap,\n\t);\n}\n\n/**\n * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.\n * For example, if a user sets the `enableGroupedBatching` option to true, but the minVersionForCollab\n * is set to \"1.0.0\", then we should throw a UsageError since 1.x clients do not support batching.\n * */\nexport function validateRuntimeOptions(\n\tminVersionForCollab: OldestSupportedClientVersion,\n\truntimeOptions: Partial<ContainerRuntimeOptionsInternal>,\n): void {\n\tvalidateConfigMapOverrides<RuntimeOptionsAffectingDocSchema>(\n\t\tminVersionForCollab,\n\t\truntimeOptions,\n\t\truntimeOptionsAffectingDocSchemaConfigValidationMap,\n\t);\n}\n"]}
+{"version":3,"file":"containerCompatibility.js","sourceRoot":"","sources":["../src/containerCompatibility.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA4MH,wEAOC;AAOD,wDASC;AAjOD,2EAGsD;AACtD,qEAMgD;AAEhD,2EAGqC;AA+CrC;;;;;;;GAOG;AACH,MAAM,2CAA2C,GAAG,IAAI,GAAG,CAAC;IAC3D,uBAAuB;IACvB,oBAAoB;IACpB,2BAA2B;IAC3B,WAAW;IACX,WAAW;IACX,uBAAuB;CACvB,CAAgE,CAAC;AAUlE;;;;;;;;;;;GAWG;AACH,MAAM,yCAAyC,GAC9C;IACC,qBAAqB,EAAE;QACtB,qFAAqF;QACrF,6EAA6E;QAC7E,OAAO,EAAE,IAAI;KACb;IACD,kBAAkB,EAAE;QACnB,kFAAkF;QAClF,2EAA2E;QAC3E,OAAO,EAAE,oDAAwB;KACjC;IACD,yBAAyB,EAAE;QAC1B,sEAAsE;QACtE,sDAAsD;QACtD,mEAAmE;QACnE,yDAAyD;QACzD,OAAO,EAAE,SAAS;QAClB,qEAAqE;QACrE,qEAAqE;QACrE,mEAAmE;QACnE,qEAAqE;QACrE,wBAAwB;KACxB;IACD,qBAAqB,EAAE;QACtB,0EAA0E;QAC1E,iFAAiF;QACjF,mFAAmF;QACnF,OAAO,EAAE,IAAI;KACb;IACD,SAAS,EAAE;QACV,kFAAkF;QAClF,yBAAyB;QACzB,OAAO,EAAE,oBAAS,CAAC,SAAS;KAC5B;IACD,SAAS,EAAE;QACV,OAAO,EAAE,EAAE;QACX,mHAAmH;QACnH,4GAA4G;QAC5G,2IAA2I;QAC3I,6EAA6E;QAC7E,gHAAgH;QAChH,kFAAkF;QAClF,oCAAoC;KACpC;IACD,wBAAwB,EAAE;QACzB,2GAA2G;QAC3G,4GAA4G;QAC5G,wCAAwC;QACxC,OAAO,EAAE,SAAS;KAClB;CACD,CAAC;AAEH;;GAEG;AACU,QAAA,iDAAiD,GAC7D,MAAM,CAAC,IAAI,CACV,yCAAyC,CAE1C,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IAChB,OAAO,CAAC,2CAA2C,CAAC,GAAG,CACtD,GAAsD,CACtD,CAAC;AACH,CAAC,CAAwD,CAAC;AAE1D,oHAAoH;AACpH,MAAM,mDAAmD,GACxD;IACC,qBAAqB,EAAE,IAAA,2CAAgC,EAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;IACF,kBAAkB,EAAE,IAAA,2CAAgC,EAAC;QACpD,CAAC,EAAE,GAAG,qDAAyB,EAAE,EAAE,OAAO,CAAC;QAC3C,CAAC,EAAE,GAAG,oDAAwB,EAAE,EAAE,OAAO,CAAC;KAC1C,CAAC;IACF,yBAAyB,EAAE,IAAA,2CAAgC,EAAC;QAC3D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,OAAO,CAAC;QACf,CAAC,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IACF,qBAAqB,EAAE,IAAA,2CAAgC,EAAC;QACvD,CAAC,KAAK,EAAE,OAAO,CAAC;QAChB,CAAC,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;IACF,SAAS,EAAE,IAAA,2CAAgC,EAAC;QAC3C,CAAC,oBAAS,CAAC,SAAS,EAAE,OAAO,CAAC;QAC9B,CAAC,oBAAS,CAAC,SAAS,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE,IAAA,2CAAgC,EAAC;QAC3C,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC;QACvC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC;KAClC,CAAC;IACF,wBAAwB,EAAE,IAAA,2CAAgC,EAAC;QAC1D,CAAC,SAAS,EAAE,OAAO,CAAC;QACpB,CAAC,IAAI,EAAE,QAAQ,CAAC;KAChB,CAAC;CACF,CAAC;AAEH;;GAEG;AACH,SAAgB,8BAA8B,CAC7C,mBAAiD;IAEjD,OAAO,IAAA,2CAAgC,EACtC,mBAAmB,EACnB,yCAAyC,CACzC,CAAC;AACH,CAAC;AAED;;;;KAIK;AACL,SAAgB,sBAAsB,CACrC,mBAAiD,EACjD,cAAwD;IAExD,IAAA,qCAA0B,EACzB,mBAAmB,EACnB,cAAc,EACd,mDAAmD,CACnD,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tFlushMode,\n\ttype OldestSupportedClientVersion,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\tconfigValueToMinVersionForCollab,\n\tgetConfigsForMinVersionForCollab,\n\tvalidateConfigMapOverrides,\n\ttype ConfigMap,\n\ttype ConfigValidationMap,\n} from \"@fluidframework/runtime-utils/internal\";\n\nimport {\n\tdisabledCompressionConfig,\n\tenabledCompressionConfig,\n} from \"./compressionDefinitions.js\";\nimport type { ContainerRuntimeOptionsInternal } from \"./containerRuntime.js\";\n\n/**\n * Subset of the {@link ContainerRuntimeOptionsInternal} properties which\n * affect {@link IDocumentSchemaFeatures}.\n *\n * @remarks\n * When a new option is added to {@link ContainerRuntimeOptionsInternal}, we\n * must consider if it changes the DocumentSchema. If so, then a corresponding\n * entry must be added to {@link runtimeOptionsAffectingDocSchemaConfigMap}\n * below. If not, then it must be omitted from this type.\n *\n * Note: `Omit` is used instead of `Pick` to ensure that all new options are\n * included in this type by default. If any new properties are added to\n * {@link ContainerRuntimeOptionsInternal}, they will be included in this\n * type unless explicitly omitted. This will prevent us from forgetting to\n * account for any new properties in the future.\n */\nexport type RuntimeOptionsAffectingDocSchema = Omit<\n\tContainerRuntimeOptionsInternal,\n\t| \"chunkSizeInBytes\"\n\t| \"maxBatchSizeInBytes\"\n\t| \"loadSequenceNumberVerification\"\n\t| \"summaryOptions\"\n\t| \"stagingModeAutoFlushThreshold\"\n\t| \"disableSchemaUpgrade\"\n>;\n\n/**\n * Subset of {@link RuntimeOptionsAffectingDocSchema} which existed prior to the introduction of explicitSchemaControl.\n *\n * @remarks\n * Runtime options that affect document schema should generally require explicitSchemaControl to be enabled.\n * However, to prevent disruption to existing customers, options that existed prior to explicitSchemaControl\n * do not explicity require explicitSchemaControl to be enabled. Do not add new options to this list.\n */\ntype RuntimeOptionKeysPredatingExplicitSchemaControl = keyof Pick<\n\tRuntimeOptionsAffectingDocSchema,\n\t| \"explicitSchemaControl\"\n\t| \"compressionOptions\"\n\t| \"enableRuntimeIdCompressor\"\n\t| \"flushMode\"\n\t| \"gcOptions\"\n\t| \"enableGroupedBatching\"\n>;\n\n/**\n * List of keys of {@link RuntimeOptionsAffectingDocSchema} which existed prior to the introduction of explicitSchemaControl.\n *\n * @remarks\n * Runtime options that affect document schema should generally require explicitSchemaControl to be enabled.\n * However, to prevent disruption to existing customers, options that existed prior to explicitSchemaControl\n * do not explicity require explicitSchemaControl to be enabled. Do not add new keys to this list.\n */\nconst keysOfOptionsPredatingExplicitSchemaControl = new Set([\n\t\"explicitSchemaControl\",\n\t\"compressionOptions\",\n\t\"enableRuntimeIdCompressor\",\n\t\"flushMode\",\n\t\"gcOptions\",\n\t\"enableGroupedBatching\",\n]) satisfies Set<RuntimeOptionKeysPredatingExplicitSchemaControl>;\n\n/**\n * Subset of {@link RuntimeOptionsAffectingDocSchema} which require explicitSchemaControl to be enabled.\n */\nexport type RuntimeOptionKeysThatRequireExplicitSchemaControl = keyof Omit<\n\tRuntimeOptionsAffectingDocSchema,\n\tRuntimeOptionKeysPredatingExplicitSchemaControl\n>;\n\n/**\n * Mapping of RuntimeOptionsAffectingDocSchema to their compatibility related configs.\n *\n * Each key in this map corresponds to a property in RuntimeOptionsAffectingDocSchema. The value is an object that maps OldestSupportedClientVersion\n * to the appropriate default value for that property to supporting that OldestSupportedClientVersion. If clients running OldestSupportedClientVersion X are able to understand\n * the format changes introduced by the property, then the default value for that OldestSupportedClientVersion will enable the feature associated with the property.\n * Otherwise, the feature will be disabled.\n *\n * For example, the default value for `enableGroupedBatching` is true at the supported\n * floor of 2.0.0 because clients running 2.0.0 or later understand the associated\n * document format.\n */\nconst runtimeOptionsAffectingDocSchemaConfigMap: ConfigMap<RuntimeOptionsAffectingDocSchema> =\n\t{\n\t\tenableGroupedBatching: {\n\t\t\t// Grouped batching was already enabled by default before callers explicitly selected\n\t\t\t// a compatibility version. All supported 2.x clients understand this format.\n\t\t\t\"2.0.0\": true,\n\t\t},\n\t\tcompressionOptions: {\n\t\t\t// Compression was already enabled by default before callers explicitly selected a\n\t\t\t// compatibility version. All supported 2.x clients understand this format.\n\t\t\t\"2.0.0\": enabledCompressionConfig,\n\t\t},\n\t\tenableRuntimeIdCompressor: {\n\t\t\t// For IdCompressorMode, `undefined` represents a logical state (off).\n\t\t\t// However, to satisfy the Required<> constraint while\n\t\t\t// `exactOptionalPropertyTypes` is `false` (TODO: AB#8215), we need\n\t\t\t// to have it defined, so we trick the type checker here.\n\t\t\t\"2.0.0\": undefined,\n\t\t\t// We do not yet want to enable idCompressor by default since it will\n\t\t\t// increase bundle sizes, and not all customers will benefit from it.\n\t\t\t// Therefore, we will require customers to explicitly enable it. We\n\t\t\t// are keeping it as a DocSchema affecting option for now as this may\n\t\t\t// change in the future.\n\t\t},\n\t\texplicitSchemaControl: {\n\t\t\t// This option's intention is to prevent 1.x clients from joining sessions\n\t\t\t// when enabled. Before Client 3.0, this became true only when callers explicitly\n\t\t\t// selected 2.0.0 or later. Client 3.0 also uses 2.0.0 when the setting is omitted.\n\t\t\t\"2.0.0\": true,\n\t\t},\n\t\tflushMode: {\n\t\t\t// TurnBased flushing was already the default before callers explicitly selected a\n\t\t\t// compatibility version.\n\t\t\t\"2.0.0\": FlushMode.TurnBased,\n\t\t},\n\t\tgcOptions: {\n\t\t\t\"2.0.0\": {},\n\t\t\t// Although sweep is supported in 2.x, it is disabled by default until minVersionForCollab>=3.0.0 to be extra safe.\n\t\t\t// Note that enabling this is a significant change, that should likely be announced in the relevant version:\n\t\t\t// It would be bad if this simple caused the enablement when when the current package version passed this point without anyone being aware.\n\t\t\t// This is configuration targeting a future versions, which is not supported.\n\t\t\t// TODO: when preparing 3.0 (or at some later point), consider enabling this by default for clients 3.0 or newer\n\t\t\t// (and add user facing documentation indicating this is enabled by that version).\n\t\t\t// \"3.0.0\": { enableGCSweep: true },\n\t\t},\n\t\tcreateBlobPayloadPending: {\n\t\t\t// This feature is new and disabled by default. In the future we will enable it by default, but we have not\n\t\t\t// closed on the version where that will happen yet.  Probably a .10 release since blob functionality is not\n\t\t\t// exposed on the `@public` API surface.\n\t\t\t\"2.0.0\": undefined,\n\t\t},\n\t};\n\n/**\n * Keys of {@link ContainerRuntimeOptionsInternal} that require explicitSchemaControl to be enabled.\n */\nexport const runtimeOptionKeysThatRequireExplicitSchemaControl = (\n\tObject.keys(\n\t\truntimeOptionsAffectingDocSchemaConfigMap,\n\t) as (keyof RuntimeOptionsAffectingDocSchema)[]\n).filter((key) => {\n\treturn !keysOfOptionsPredatingExplicitSchemaControl.has(\n\t\tkey as RuntimeOptionKeysPredatingExplicitSchemaControl,\n\t);\n}) as RuntimeOptionKeysThatRequireExplicitSchemaControl[];\n\n// A lot of the information in this seems redundant with whats defined above. Might be nice to combine them somehow.\nconst runtimeOptionsAffectingDocSchemaConfigValidationMap: ConfigValidationMap<RuntimeOptionsAffectingDocSchema> =\n\t{\n\t\tenableGroupedBatching: configValueToMinVersionForCollab([\n\t\t\t[false, \"2.0.0\"],\n\t\t\t[true, \"2.0.0\"],\n\t\t]),\n\t\tcompressionOptions: configValueToMinVersionForCollab([\n\t\t\t[{ ...disabledCompressionConfig }, \"2.0.0\"],\n\t\t\t[{ ...enabledCompressionConfig }, \"2.0.0\"],\n\t\t]),\n\t\tenableRuntimeIdCompressor: configValueToMinVersionForCollab([\n\t\t\t[undefined, \"2.0.0\"],\n\t\t\t[\"on\", \"2.0.0\"],\n\t\t\t[\"delayed\", \"2.0.0\"],\n\t\t]),\n\t\texplicitSchemaControl: configValueToMinVersionForCollab([\n\t\t\t[false, \"2.0.0\"],\n\t\t\t[true, \"2.0.0\"],\n\t\t]),\n\t\tflushMode: configValueToMinVersionForCollab([\n\t\t\t[FlushMode.Immediate, \"2.0.0\"],\n\t\t\t[FlushMode.TurnBased, \"2.0.0\"],\n\t\t]),\n\t\tgcOptions: configValueToMinVersionForCollab([\n\t\t\t[{ enableGCSweep: undefined }, \"2.0.0\"],\n\t\t\t[{ enableGCSweep: true }, \"2.0.0\"],\n\t\t]),\n\t\tcreateBlobPayloadPending: configValueToMinVersionForCollab([\n\t\t\t[undefined, \"2.0.0\"],\n\t\t\t[true, \"2.40.0\"],\n\t\t]),\n\t};\n\n/**\n * Returns the default RuntimeOptionsAffectingDocSchema configuration for a given minVersionForCollab.\n */\nexport function getMinVersionForCollabDefaults(\n\tminVersionForCollab: OldestSupportedClientVersion,\n): RuntimeOptionsAffectingDocSchema {\n\treturn getConfigsForMinVersionForCollab(\n\t\tminVersionForCollab,\n\t\truntimeOptionsAffectingDocSchemaConfigMap,\n\t);\n}\n\n/**\n * Validates if the runtime options passed in from the user are compatible with the minVersionForCollab.\n * For example, if a user enables an option introduced in 2.40.0 while the\n * minVersionForCollab is set to \"2.0.0\", then we should throw a UsageError.\n * */\nexport function validateRuntimeOptions(\n\tminVersionForCollab: OldestSupportedClientVersion,\n\truntimeOptions: Partial<ContainerRuntimeOptionsInternal>,\n): void {\n\tvalidateConfigMapOverrides<RuntimeOptionsAffectingDocSchema>(\n\t\tminVersionForCollab,\n\t\truntimeOptions,\n\t\truntimeOptionsAffectingDocSchemaConfigValidationMap,\n\t);\n}\n"]}

package/dist/containerHandleContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"containerHandleContext.d.ts","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAGpF,MAAM,WAAW,8BAA8B;IAC9C,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED,qBAAa,2BAA4B,YAAW,mBAAmB;aAarD,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO;aACR,YAAY,CAAC;IAd9B,IAAW,mBAAmB,IAAI,mBAAmB,CAEpD;IACD,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;;;;OAKG;gBAEc,IAAI,EAAE,MAAM,EACX,OAAO,EAAE,8BAA8B,EACxC,YAAY,CAAC,iCAAqB;IAK5C,WAAW,IAAI,IAAI;IAI1B,IAAW,UAAU,IAAI,OAAO,CAE/B;IAEY,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAGjE"}
+{"version":3,"file":"containerHandleContext.d.ts","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAGpF,MAAM,WAAW,8BAA8B;IAC9C,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED,qBAAa,2BAA4B,YAAW,mBAAmB;aAarD,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO;aACR,YAAY,CAAC,EAAE,mBAAmB;IAdnD,IAAW,mBAAmB,IAAI,mBAAmB,CAEpD;IACD,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;;;;OAKG;gBAEc,IAAI,EAAE,MAAM,EACX,OAAO,EAAE,8BAA8B,EACxC,YAAY,CAAC,EAAE,mBAAmB,YAAA;IAK5C,WAAW,IAAI,IAAI;IAI1B,IAAW,UAAU,IAAI,OAAO,CAE/B;IAEY,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAGjE"}

package/dist/containerHandleContext.js

@@ -8,9 +8,13 @@ exports.ContainerFluidHandleContext = void 0;
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/runtime-utils/internal");
 class ContainerFluidHandleContext {
+    path;
+    runtime;
+    routeContext;
     get IFluidHandleContext() {
         return this;
     }
+    absolutePath;
     /**
      * Creates a new ContainerFluidHandleContext.
      * @param path - The path to this handle relative to the routeContext.

package/dist/containerHandleContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"containerHandleContext.js","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iFAAoE;AAGpE,qEAAmF;AAOnF,MAAa,2BAA2B;IACvC,IAAW,mBAAmB;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IAGD;;;;;OAKG;IACH,YACiB,IAAY,EACX,OAAuC,EACxC,YAAkC;QAFlC,SAAI,GAAJ,IAAI,CAAQ;QACX,YAAO,GAAP,OAAO,CAAgC;QACxC,iBAAY,GAAZ,YAAY,CAAsB;QAElD,IAAI,CAAC,YAAY,GAAG,IAAA,oCAAyB,EAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACxE,CAAC;IAEM,WAAW;QACjB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC1E,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAiB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CACD;AA/BD,kEA+BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport type { IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport type { IFluidHandleContext } from \"@fluidframework/core-interfaces/internal\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils/internal\";\n\nexport interface IContainerHandleContextRuntime {\n\tattachState: AttachState;\n\tresolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport class ContainerFluidHandleContext implements IFluidHandleContext {\n\tpublic get IFluidHandleContext(): IFluidHandleContext {\n\t\treturn this;\n\t}\n\tpublic readonly absolutePath: string;\n\n\t/**\n\t * Creates a new ContainerFluidHandleContext.\n\t * @param path - The path to this handle relative to the routeContext.\n\t * @param runtime - The IRuntime object this context represents.\n\t * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n\t */\n\tconstructor(\n\t\tpublic readonly path: string,\n\t\tprivate readonly runtime: IContainerHandleContextRuntime,\n\t\tpublic readonly routeContext?: IFluidHandleContext,\n\t) {\n\t\tthis.absolutePath = generateHandleContextPath(path, this.routeContext);\n\t}\n\n\tpublic attachGraph(): void {\n\t\tthrow new Error(\"can't attach container runtime form within container!\");\n\t}\n\n\tpublic get isAttached(): boolean {\n\t\treturn this.runtime.attachState !== AttachState.Detached;\n\t}\n\n\tpublic async resolveHandle(request: IRequest): Promise<IResponse> {\n\t\treturn this.runtime.resolveHandle(request);\n\t}\n}\n"]}
+{"version":3,"file":"containerHandleContext.js","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iFAAoE;AAGpE,qEAAmF;AAOnF,MAAa,2BAA2B;IAatB;IACC;IACD;IAdjB,IAAW,mBAAmB;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IACe,YAAY,CAAS;IAErC;;;;;OAKG;IACH,YACiB,IAAY,EACX,OAAuC,EACxC,YAAkC;QAFlC,SAAI,GAAJ,IAAI,CAAQ;QACX,YAAO,GAAP,OAAO,CAAgC;QACxC,iBAAY,GAAZ,YAAY,CAAsB;QAElD,IAAI,CAAC,YAAY,GAAG,IAAA,oCAAyB,EAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACxE,CAAC;IAEM,WAAW;QACjB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC1E,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAiB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;CACD;AA/BD,kEA+BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport type { IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport type { IFluidHandleContext } from \"@fluidframework/core-interfaces/internal\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils/internal\";\n\nexport interface IContainerHandleContextRuntime {\n\tattachState: AttachState;\n\tresolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport class ContainerFluidHandleContext implements IFluidHandleContext {\n\tpublic get IFluidHandleContext(): IFluidHandleContext {\n\t\treturn this;\n\t}\n\tpublic readonly absolutePath: string;\n\n\t/**\n\t * Creates a new ContainerFluidHandleContext.\n\t * @param path - The path to this handle relative to the routeContext.\n\t * @param runtime - The IRuntime object this context represents.\n\t * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n\t */\n\tconstructor(\n\t\tpublic readonly path: string,\n\t\tprivate readonly runtime: IContainerHandleContextRuntime,\n\t\tpublic readonly routeContext?: IFluidHandleContext,\n\t) {\n\t\tthis.absolutePath = generateHandleContextPath(path, this.routeContext);\n\t}\n\n\tpublic attachGraph(): void {\n\t\tthrow new Error(\"can't attach container runtime form within container!\");\n\t}\n\n\tpublic get isAttached(): boolean {\n\t\treturn this.runtime.attachState !== AttachState.Detached;\n\t}\n\n\tpublic async resolveHandle(request: IRequest): Promise<IResponse> {\n\t\treturn this.runtime.resolveHandle(request);\n\t}\n}\n"]}

package/dist/containerRuntime.d.ts

@@ -335,10 +335,10 @@ export interface LoadContainerRuntimeParams {
      *
      * @privateRemarks
      * Used to determine the default configuration for {@link IContainerRuntimeOptionsInternal} that affect the document schema.
-     * For example, let's say that feature `foo` was added in 2.0 which introduces a new op type. Additionally, option `bar`
-     * was added to `IContainerRuntimeOptionsInternal` in 2.0 to enable/disable `foo` since clients prior to 2.0 would not
-     * understand the new op type. If a customer were to set oldestSupportedClient to 2.0.0, then `bar` would be set to
-     * enable `foo` by default. If a customer were to set oldestSupportedClient to 1.0.0, then `bar` would be set to
+     * For example, let's say that feature `foo` was added in 2.40 which introduces a new op type. Additionally, option `bar`
+     * was added to `IContainerRuntimeOptionsInternal` in 2.40 to enable/disable `foo` since clients prior to 2.40 would not
+     * understand the new op type. If a customer were to set oldestSupportedClient to 2.40.0, then `bar` would be set to
+     * enable `foo` by default. If a customer were to set oldestSupportedClient to 2.0.0, then `bar` would be set to
      * disable `foo` by default.
      */
     oldestSupportedClient?: OldestSupportedClientVersion;