@fluidframework/container-runtime 1.2.6 → 2.0.0-dev.1.3.0.96595

package/src/summarizerTypes.ts

@@ -21,18 +21,20 @@ import {
 } from "@fluidframework/protocol-definitions";
 import { ISummaryStats } from "@fluidframework/runtime-definitions";
 import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection";
+import { SummarizeReason } from "./summaryGenerator";
+import { ISummaryConfigurationHeuristics } from ".";
 
 /**
- * @deprecated - This will be removed in a later release.
+ * @deprecated This will be removed in a later release.
  */
 export const ISummarizer: keyof IProvideSummarizer = "ISummarizer";
 
 /**
- * @deprecated - This will be removed in a later release.
+ * @deprecated This will be removed in a later release.
  */
 export interface IProvideSummarizer {
     /**
-     * @deprecated - This will be removed in a later release.
+     * @deprecated This will be removed in a later release.
      */
     readonly ISummarizer: ISummarizer;
 }
@@ -98,7 +100,9 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
     /** clientId of parent (non-summarizing) container that owns summarizer container */
     readonly summarizerClientId: string | undefined;
     closeFn(): void;
+    /** @deprecated 1.0, please remove all implementations and usage */
     on(event: "batchEnd", listener: (error: any, op: ISequencedDocumentMessage) => void): this;
+    /** @deprecated 1.0, please remove all implementations and usage */
     removeListener(event: "batchEnd", listener: (error: any, op: ISequencedDocumentMessage) => void): this;
 }
 
@@ -126,6 +130,7 @@ export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
 export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
     /** If specified, The summarize attempt will not occur until after this sequence number. */
     readonly afterSequenceNumber?: number;
+
     /**
      * True to override the existing enqueued summarize attempt if there is one.
      * This will guarantee that this attempt gets enqueued. If override is false,
@@ -150,10 +155,6 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
     readonly gcTotalBlobsSize?: number;
     /** The number of gc blobs in this summary. */
     readonly gcBlobNodeCount?: number;
-    /** Sum of the sizes of all op contents since the last summary */
-    readonly opsSizesSinceLastSummary: number;
-    /** Number of non-system ops since the last summary. See {@link @fluidframework/protocol-base#isSystemMessage} */
-    readonly nonSystemOpsSinceLastSummary: number;
     /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
     readonly summaryNumber: number;
 }
@@ -204,11 +205,16 @@ export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stag
  * The result consists of 4 possible stages, each with its own data.
  * The data is cumulative, so each stage will contain the data from the previous stages.
  * If the final "submitted" stage is not reached, the result may contain the error object.
+ *
  * Stages:
- *  1. "base" - stopped before the summary tree was even generated, and the result only contains the base data
- *  2. "generate" - the summary tree was generated, and the result will contain that tree + stats
- *  3. "upload" - the summary was uploaded to storage, and the result contains the server-provided handle
- *  4. "submit" - the summarize op was submitted, and the result contains the op client sequence number.
+ *
+ * 1. "base" - stopped before the summary tree was even generated, and the result only contains the base data
+ *
+ * 2. "generate" - the summary tree was generated, and the result will contain that tree + stats
+ *
+ * 3. "upload" - the summary was uploaded to storage, and the result contains the server-provided handle
+ *
+ * 4. "submit" - the summarize op was submitted, and the result contains the op client sequence number.
  */
 export type SubmitSummaryResult =
     | IBaseSummarizeResult
@@ -361,6 +367,18 @@ export interface ISummarizeHeuristicData {
     /** Most recent summary that received an ack */
     readonly lastSuccessfulSummary: Readonly<ISummarizeAttempt>;
 
+    /** Number of runtime ops since last summary */
+    numRuntimeOps: number;
+
+    /** Number of non-runtime ops since last summary */
+    numNonRuntimeOps: number;
+
+    /** Cumulative size in bytes of all the ops since the last summary */
+    totalOpsSize: number;
+
+    /** Wether or not this instance contains adjusted metrics due to missing op data */
+    hasMissingOpData: boolean;
+
     /**
      * Updates lastAttempt and lastSuccessfulAttempt based on the last summary.
      * @param lastSummary - last ack summary
@@ -381,7 +399,10 @@ export interface ISummarizeHeuristicData {
 
 /** Responsible for running heuristics determining when to summarize. */
 export interface ISummarizeHeuristicRunner {
-    /** Runs the heuristic to determine if it should try to summarize */
+    /** Start specific heuristic trackers (ex: idle timer) */
+    start(): void;
+
+    /** Runs the heuristics to determine if it should try to summarize */
     run(): void;
 
     /** Runs a different heuristic to check if it should summarize before closing */
@@ -408,6 +429,19 @@ export type ISummarizeTelemetryProperties =
     Pick<ITelemetryProperties, ISummarizeTelemetryRequiredProperties> &
     Partial<Pick<ITelemetryProperties, ISummarizeTelemetryOptionalProperties>>;
 
+/** Strategy used to heuristically determine when we should run a summary */
+export interface ISummaryHeuristicStrategy {
+    /** Summarize reason for this summarize heuristic strategy (ex: "maxTime") */
+    summarizeReason: Readonly<SummarizeReason>;
+
+    /**
+     * Determines if this strategy's summarize criteria been met
+     * @param configuration - summary configuration we are to check against
+     * @param heuristicData - heuristic data used to confirm conditions are met
+     */
+    shouldRunSummary(configuration: ISummaryConfigurationHeuristics, heuristicData: ISummarizeHeuristicData): boolean;
+}
+
 type SummaryGeneratorRequiredTelemetryProperties =
     /** True to generate the full tree with no handle reuse optimizations */
     "fullTree" |
@@ -425,14 +459,15 @@ type SummaryGeneratorOptionalTelemetryProperties =
     "opsSinceLastAttempt" |
     /** Delta between the current reference sequence number and the reference sequence number of the last summary */
     "opsSinceLastSummary" |
-    /** Delta in sum of op sizes between the current reference sequence number and the reference
-     *  sequence number of the last summary */
-    "opsSizesSinceLastSummary" |
     /**
-     * Delta between the number of non-system ops since the last summary.
-     * See {@link @fluidframework/protocol-base#isSystemMessage}
+     * Delta in sum of op sizes between the current reference sequence number and the reference
+     * sequence number of the last summary
      */
-    "nonSystemOpsSinceLastSummary" |
+    "opsSizesSinceLastSummary" |
+    /** Delta between the number of non-runtime ops since the last summary */
+    "nonRuntimeOpsSinceLastSummary" |
+    /** Wether or not this instance contains adjusted metrics due to missing op data */
+    "hasMissingOpData" |
     /** Time it took to generate the summary tree and stats. */
     "generateDuration" |
     /** The handle returned by storage pointing to the uploaded summary tree. */

package/src/summaryCollection.ts

@@ -239,9 +239,7 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
         private readonly logger: ITelemetryLogger,
     ) {
         super();
-        this.deltaManager.on(
-            "op",
-            (op) => this.handleOp(op));
+        this.deltaManager.on("op", (op) => this.handleOp(op));
     }
 
     /**
@@ -295,24 +293,41 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
         return this.lastAck;
     }
 
+    private parseContent(op: ISequencedDocumentMessage) {
+        // back-compat: ADO #1385: Make this unconditional in the future,
+        // when Container.processRemoteMessage stops parsing contents. That said, we should move to
+        // listen for "op" events from ContainerRuntime, and parsing may not be required at all if
+        // ContainerRuntime.process() would parse it for all types of ops.
+        // Can make either of those changes only when LTS moves to a version that has no content
+        // parsing in loader layer!
+        if (typeof op.contents === "string") {
+            op.contents = JSON.parse(op.contents);
+        }
+    }
+
     /**
      * Handler for ops; only handles ops relating to summaries.
      * @param op - op message to handle
      */
-    private handleOp(op: ISequencedDocumentMessage) {
+    private handleOp(opArg: ISequencedDocumentMessage) {
+        const op = { ...opArg };
+
         switch (op.type) {
-            case MessageType.Summarize: {
-                this.handleSummaryOp(op as ISummaryOpMessage);
-                return;
-            }
-            case MessageType.SummaryAck: {
-                this.handleSummaryAck(op as ISummaryAckMessage);
-                return;
-            }
-            case MessageType.SummaryNack: {
-                this.handleSummaryNack(op as ISummaryNackMessage);
-                return;
-            }
+            case MessageType.Summarize:
+                this.parseContent(op);
+                return this.handleSummaryOp(op as ISummaryOpMessage);
+            case MessageType.SummaryAck:
+            case MessageType.SummaryNack:
+                // Old files (prior to PR #10077) may not contain this info
+                // back-compat: ADO #1385: remove cast when ISequencedDocumentMessage changes are propagated
+                if ((op as any).data !== undefined) {
+                    op.contents = JSON.parse((op as any).data);
+                } else {
+                    this.parseContent(op);
+                }
+                return op.type === MessageType.SummaryAck
+                    ? this.handleSummaryAck(op as ISummaryAckMessage)
+                    : this.handleSummaryNack(op as ISummaryNackMessage);
             default: {
                 // If the difference between timestamp of current op and last summary op is greater than
                 // the maxAckWaitTime, then we need to inform summarizer to not wait and summarize
@@ -366,11 +381,11 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
             // from. i.e. initialSequenceNumber > summarySequenceNumber.
             // We really don't care about it for now, since it is older than
             // the one we loaded from.
-            if (seq >= this.deltaManager.initialSequenceNumber) {
+            if (seq > this.deltaManager.initialSequenceNumber) {
                 // Potential causes for it to be later than our initialSequenceNumber
                 // are that the summaryOp was nacked then acked, double-acked, or
                 // the summarySequenceNumber is incorrect.
-                this.logger.sendErrorEvent({
+                this.logger.sendTelemetryEvent({
                     eventName: "SummaryAckWithoutOp",
                     sequenceNumber: op.sequenceNumber, // summary ack seq #
                     summarySequenceNumber: seq, // missing summary seq #

package/src/summaryFormat.ts

@@ -73,7 +73,6 @@ export function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttribu
 export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): boolean {
     return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;
 }
-
 export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
     readonly summaryFormatVersion: 1;
     /** The last message processed at the time of summary. Only primitive property types are added to the summary. */
@@ -82,11 +81,6 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
     readonly disableIsolatedChannels?: true;
     /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
     readonly summaryNumber?: number;
-    /**
-     * @deprecated - User summaryNumber instead.
-     * Counter of the last summary happened, increments every time we summarize
-     */
-    readonly summaryCount?: number;
 }
 
 export interface ICreateContainerMetadata {

package/src/summaryGenerator.ts

@@ -264,28 +264,7 @@ export class SummaryGenerator {
                 opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,
                 opsSinceLastSummary,
             };
-            if (summaryData.stage !== "base") {
-                summarizeTelemetryProps = {
-                    ...summarizeTelemetryProps,
-                    ...summaryData.summaryStats,
-                    generateDuration: summaryData.generateDuration,
-                };
-
-                if (summaryData.stage !== "generate") {
-                    summarizeTelemetryProps = {
-                        ...summarizeTelemetryProps,
-                        handle: summaryData.handle,
-                        uploadDuration: summaryData.uploadDuration,
-                    };
-
-                    if (summaryData.stage !== "upload") {
-                        summarizeTelemetryProps = {
-                            ...summarizeTelemetryProps,
-                            clientSequenceNumber: summaryData.clientSequenceNumber,
-                        };
-                    }
-                }
-            }
+            summarizeTelemetryProps = this.addSummaryDataToTelemetryProps(summaryData, summarizeTelemetryProps);
 
             if (summaryData.stage !== "submit") {
                 return fail("submitSummaryFailure", summaryData.error, summarizeTelemetryProps);
@@ -408,6 +387,45 @@ export class SummaryGenerator {
         }
     }
 
+    private addSummaryDataToTelemetryProps(
+        summaryData: SubmitSummaryResult,
+        initialProps: SummaryGeneratorTelemetry,
+    ): SummaryGeneratorTelemetry {
+        switch (summaryData.stage) {
+            case "base": return initialProps;
+
+            case "generate": return {
+                ...initialProps,
+                ...summaryData.summaryStats,
+                generateDuration: summaryData.generateDuration,
+            };
+
+            case "upload": return {
+                ...initialProps,
+                ...summaryData.summaryStats,
+                generateDuration: summaryData.generateDuration,
+                handle: summaryData.handle,
+                uploadDuration: summaryData.uploadDuration,
+            };
+
+            case "submit": return {
+                ...initialProps,
+                ...summaryData.summaryStats,
+                generateDuration: summaryData.generateDuration,
+                handle: summaryData.handle,
+                uploadDuration: summaryData.uploadDuration,
+                clientSequenceNumber: summaryData.clientSequenceNumber,
+                hasMissingOpData: this.heuristicData.hasMissingOpData,
+                opsSizesSinceLastSummary: this.heuristicData.totalOpsSize,
+                nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,
+            };
+
+            default: assert(true, 0x397 /* Unexpected summary stage */);
+        }
+
+        return initialProps;
+    }
+
     private summarizeTimerHandler(time: number, count: number) {
         this.logger.sendPerformanceEvent({
             eventName: "SummarizeTimeout",

package/src/summaryManager.ts

@@ -14,6 +14,7 @@ import {
     SummarizerStopReason,
 } from "./summarizerTypes";
 import { SummaryCollection } from "./summaryCollection";
+import { Summarizer } from "./summarizer";
 
 const defaultInitialDelayMs = 5000;
 const defaultOpsToBypassInitialDelay = 4000;
@@ -198,8 +199,12 @@ export class SummaryManager implements IDisposable {
             // a summarizer to kick off lastSummary. Without that, we would not be able to summarize and get
             // document out of broken state if it has too many ops and ordering service keeps nacking main
             // container (and thus it goes into cycle of reconnects)
-            if (startWithInitialDelay && this.getShouldSummarizeState().shouldSummarize === false) {
-                return "early exit";
+            // If we can't run the LastSummary, simply return as to avoid paying the cost of launching
+            // the summarizer at all.
+            const shouldSummarizeStateEarlyStage = this.getShouldSummarizeState();
+            if (startWithInitialDelay &&
+                shouldSummarizeStateEarlyStage.shouldSummarize === false) {
+                    return `early exit ${shouldSummarizeStateEarlyStage.stopReason}`;
             }
 
             // We transition to Running before requesting the summarizer, because after requesting we can't predict
@@ -213,11 +218,21 @@ export class SummaryManager implements IDisposable {
             this.summarizer = summarizer;
 
             // Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
+            // If we can't run the LastSummary, simply return as to avoid paying the cost of launching
+            // the summarizer at all.
             const shouldSummarizeState = this.getShouldSummarizeState();
             if (shouldSummarizeState.shouldSummarize === false) {
-                this.state = SummaryManagerState.Starting;
-                summarizer.stop(shouldSummarizeState.stopReason);
-                return "early exit after starting summarizer";
+                // In order to allow the last summary to run, we not only need a stop reason that would
+                // allow it but also, startWithInitialDelay to be false (start the summarization immediately),
+                // which would happen when we have a high enough number of unsummarized ops.
+                if (startWithInitialDelay || !Summarizer.stopReasonCanRunLastSummary(shouldSummarizeState.stopReason)) {
+                    this.state = SummaryManagerState.Starting;
+                    summarizer.stop(shouldSummarizeState.stopReason);
+                    return `early exit after starting summarizer ${shouldSummarizeState.stopReason}`;
+                }
+                this.logger.sendTelemetryEvent({
+                    eventName: "LastAttemptToSummarize",
+                });
             }
 
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -287,8 +302,8 @@ export class SummaryManager implements IDisposable {
 
     /**
      * Implements initial delay before creating summarizer
-     * @returns true, if creation is delayed due to heuristics (not many ops to summarize).
-     *          False if summarizer should start immediately due to too many unsummarized ops.
+     * @returns `true`, if creation is delayed due to heuristics (not many ops to summarize).
+     * `false` if summarizer should start immediately due to too many unsummarized ops.
      */
     private async delayBeforeCreatingSummarizer(): Promise<boolean> {
         // throttle creation of new summarizer containers to prevent spamming the server with websocket connections

package/dist/opTelemetry.d.ts

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

package/dist/opTelemetry.d.ts.map

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

package/dist/opTelemetry.js

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

package/dist/opTelemetry.js.map

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

package/lib/opTelemetry.d.ts

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

package/lib/opTelemetry.d.ts.map

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

package/lib/opTelemetry.js

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

package/lib/opTelemetry.js.map

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

package/src/opTelemetry.ts

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