@fluidframework/container-runtime 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/lib/blobManager.js

@@ -1,244 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { generateHandleContextPath, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
-import { assert, Deferred } from "@fluidframework/common-utils";
-import { AttachState } from "@fluidframework/container-definitions";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-/**
- * This class represents blob (long string)
- * This object is used only when creating (writing) new blob and serialization purposes.
- * De-serialization process goes through FluidObjectHandle and request flow:
- * DataObject.request() recognizes requests in the form of `/blobs/<id>`
- * and loads blob.
- */
-export class BlobHandle {
-    constructor(path, routeContext, get) {
-        this.path = path;
-        this.routeContext = routeContext;
-        this.get = get;
-        this.attached = false;
-        this.absolutePath = generateHandleContextPath(path, this.routeContext);
-    }
-    get IFluidHandle() { return this; }
-    get isAttached() {
-        return this.attached;
-    }
-    attachGraph() {
-        this.attached = true;
-    }
-    bind(handle) {
-        throw new Error("Cannot bind to blob handle");
-    }
-}
-export class BlobManager {
-    constructor(routeContext, snapshot, getStorage, attachBlobCallback, 
-    // To be called when a blob node is requested. blobPath is the path of the blob's node in GC's graph. It's
-    // of the format `/<BlobManager.basePath>/<blobId>`.
-    gcNodeUpdated, runtime, logger) {
-        this.routeContext = routeContext;
-        this.getStorage = getStorage;
-        this.attachBlobCallback = attachBlobCallback;
-        this.gcNodeUpdated = gcNodeUpdated;
-        this.runtime = runtime;
-        this.logger = logger;
-        // uploaded blob IDs
-        this.blobIds = new Set();
-        // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a
-        // BlobAttach op has round-tripped.
-        this.pendingBlobIds = new Map();
-        // blobs uploaded while detached; cleared upon attach
-        this.detachedBlobIds = new Set();
-        this.runtime.once("dispose", () => {
-            for (const promise of this.pendingBlobIds.values()) {
-                promise.reject(new Error("runtime disposed while blobAttach op in flight"));
-            }
-        });
-        this.load(snapshot);
-    }
-    hasBlob(id) {
-        return this.blobIds.has(id) || this.detachedBlobIds.has(id);
-    }
-    /**
-     * For a blobId, returns its path in GC's graph. The node path is of the format `/<BlobManager.basePath>/<blobId>`
-     * This path must match the path of the blob handle returned by the createBlob API because blobs are marked
-     * referenced by storing these handles in a referenced DDS.
-     */
-    getBlobGCNodePath(blobId) {
-        return `/${BlobManager.basePath}/${blobId}`;
-    }
-    async getBlob(blobId) {
-        var _a, _b;
-        const storageId = (_b = (_a = this.redirectTable) === null || _a === void 0 ? void 0 : _a.get(blobId)) !== null && _b !== void 0 ? _b : blobId;
-        assert(this.hasBlob(storageId), 0x11f /* "requesting unknown blobs" */);
-        // When this blob is retrieved, let the container runtime know that the corresponding GC node got updated.
-        this.gcNodeUpdated(this.getBlobGCNodePath(blobId));
-        return new BlobHandle(`${BlobManager.basePath}/${storageId}`, this.routeContext, async () => PerformanceEvent.timedExecAsync(this.logger, { eventName: "AttachmentReadBlob", id: storageId }, async () => {
-            return this.getStorage().readBlob(storageId);
-        }, { end: true, cancel: "error" }));
-    }
-    async createBlob(blob) {
-        var _a, _b;
-        if (this.runtime.attachState === AttachState.Attaching) {
-            // blob upload is not supported in "Attaching" state
-            this.logger.sendTelemetryEvent({ eventName: "CreateBlobWhileAttaching" });
-            await new Promise((resolve) => this.runtime.once("attached", resolve));
-        }
-        if (!this.runtime.connected && this.runtime.attachState === AttachState.Attached) {
-            // see https://github.com/microsoft/FluidFramework/issues/8246
-            // Avoid getting storage if we are offline since it might be undefined. In the future we will return
-            // handles immediately while offline
-            await new Promise((resolve) => this.runtime.once("connected", resolve));
-        }
-        const response = await PerformanceEvent.timedExecAsync(this.logger, { eventName: "createBlob" }, async () => this.getStorage().createBlob(blob), { end: true, cancel: "error" });
-        const handle = new BlobHandle(`${BlobManager.basePath}/${response.id}`, this.routeContext, 
-        // get() should go through BlobManager.getBlob() so handles created while detached can be redirected
-        // to the correct storage id after they are uploaded
-        async () => this.getBlob(response.id).then(async (h) => h.get()));
-        if (this.runtime.attachState === AttachState.Detached) {
-            this.detachedBlobIds.add(response.id);
-            return handle;
-        }
-        // Note - server will de-dup blobs, so we might get existing blobId!
-        if (this.pendingBlobIds.has(response.id)) {
-            await ((_a = this.pendingBlobIds.get(response.id)) === null || _a === void 0 ? void 0 : _a.promise);
-        }
-        else if (!this.blobIds.has(response.id)) {
-            this.pendingBlobIds.set(response.id, new Deferred());
-            // send blob attach op and wait until we see it to return the handle
-            this.attachBlobCallback(response.id);
-            await ((_b = this.pendingBlobIds.get(response.id)) === null || _b === void 0 ? void 0 : _b.promise);
-        }
-        return handle;
-    }
-    processBlobAttachOp(blobId, local) {
-        if (local) {
-            const pendingBlobP = this.pendingBlobIds.get(blobId);
-            assert(pendingBlobP !== undefined, 0x1f8 /* "local BlobAttach op with no pending blob" */);
-            pendingBlobP.resolve();
-            this.pendingBlobIds.delete(blobId);
-        }
-        this.blobIds.add(blobId);
-    }
-    /**
-     * Reads blobs needed to load BlobManager from storage.
-     */
-    static async load(blobsTree, tryFetchBlob) {
-        if (!blobsTree) {
-            return {};
-        }
-        let redirectTable;
-        const tableId = blobsTree.blobs[this.redirectTableBlobName];
-        if (tableId) {
-            redirectTable = await tryFetchBlob(tableId);
-        }
-        const ids = Object.entries(blobsTree.blobs)
-            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);
-        return { ids, redirectTable };
-    }
-    /**
-     * Load a set of previously attached blob IDs from a previous snapshot. Note
-     * that BlobManager tracking and reporting attached blobs is a temporary
-     * solution since storage expects attached blobs to be reported and any that
-     * are not reported as attached may be GCed. In the future attached blob
-     * IDs will be collected at summarization time, and runtime will not care
-     * about the existence or specific formatting of this tree in returned
-     * snapshots.
-     *
-     * @param blobsTree - Tree containing IDs of previously attached blobs. This
-     * corresponds to snapshot() below. We look for the IDs in the blob entries
-     * of the tree since the both the r11s and SPO drivers replace the
-     * attachment types returned in snapshot() with blobs.
-     */
-    load(snapshot) {
-        var _a, _b, _c;
-        if (snapshot.ids) {
-            const detached = this.runtime.attachState === AttachState.Detached;
-            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));
-        }
-        if (snapshot.redirectTable) {
-            this.redirectTable = new Map(snapshot.redirectTable);
-        }
-        this.logger.sendTelemetryEvent({
-            eventName: "AttachmentBlobsLoaded",
-            count: (_b = (_a = snapshot.ids) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0,
-            redirectTable: (_c = snapshot.redirectTable) === null || _c === void 0 ? void 0 : _c.length,
-        });
-    }
-    /**
-     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be
-     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.
-     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care
-     * about this for now because the data is a simple list of blob ids.
-     */
-    getGCData(fullGC = false) {
-        const gcData = { gcNodes: {} };
-        this.blobIds.forEach((blobId) => {
-            gcData.gcNodes[this.getBlobGCNodePath(blobId)] = [];
-        });
-        /**
-         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these
-         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node
-         * must also be marked referenced. So, we add a route from the localId node to the storageId node.
-         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or
-         * a blob may be referenced via its storageId handle.
-         */
-        if (this.redirectTable !== undefined) {
-            for (const [localId, storageId] of this.redirectTable) {
-                // Add node for the localId and add a route to the storageId node. The storageId node will have been
-                // added above when adding nodes for this.blobIds.
-                gcData.gcNodes[this.getBlobGCNodePath(localId)] = [this.getBlobGCNodePath(storageId)];
-            }
-        }
-        return gcData;
-    }
-    /**
-     * When running GC in test mode, this is called to delete blobs that are unused.
-     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.
-     */
-    deleteUnusedRoutes(unusedRoutes) {
-        var _a;
-        // The routes or blob node paths are in the same format as returned in getGCData -
-        // `/<BlobManager.basePath>/<blobId>`.
-        for (const route of unusedRoutes) {
-            const pathParts = route.split("/");
-            assert(pathParts.length === 3 && pathParts[1] === BlobManager.basePath, 0x2d5 /* "Invalid blob node id in unused routes." */);
-            const blobId = pathParts[2];
-            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The
-            // corresponding storageId may still be used either directly or via other localIds.
-            if ((_a = this.redirectTable) === null || _a === void 0 ? void 0 : _a.has(blobId)) {
-                this.redirectTable.delete(blobId);
-                continue;
-            }
-            this.blobIds.delete(blobId);
-        }
-    }
-    summarize(telemetryContext) {
-        // If we have a redirect table it means the container is about to transition to "Attaching" state, so we need
-        // to return an actual snapshot containing all the real storage IDs we know about.
-        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;
-        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;
-        const builder = new SummaryTreeBuilder();
-        blobIds.forEach((blobId) => {
-            builder.addAttachment(blobId);
-        });
-        if (this.redirectTable && this.redirectTable.size > 0) {
-            builder.addBlob(BlobManager.redirectTableBlobName, JSON.stringify(Array.from(this.redirectTable.entries())));
-        }
-        return builder.getSummaryTree();
-    }
-    setRedirectTable(table) {
-        assert(this.runtime.attachState === AttachState.Detached, 0x252 /* "redirect table can only be set in detached container" */);
-        assert(!this.redirectTable, 0x253 /* "redirect table already exists" */);
-        for (const [localId, storageId] of table) {
-            assert(this.detachedBlobIds.delete(localId), 0x254 /* "unrecognized id in redirect table" */);
-            this.blobIds.add(storageId);
-        }
-        assert(this.detachedBlobIds.size === 0, 0x255 /* "detached blob id absent in redirect table" */);
-        this.redirectTable = table;
-    }
-}
-BlobManager.basePath = "_blobs";
-BlobManager.redirectTableBlobName = ".redirectTable";
-//# sourceMappingURL=blobManager.js.map

package/lib/blobManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAE9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAOnE;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAWnB,YACoB,IAAY,EACZ,YAAiC,EAC1C,GAAuB;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAC1C,QAAG,GAAH,GAAG,CAAoB;QAb1B,aAAQ,GAAY,KAAK,CAAC;QAe9B,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAdD,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,CAAC,CAAC;IAExD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAYM,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;CACJ;AAUD,MAAM,OAAO,WAAW;IAapB,YACqB,YAAiC,EAClD,QAA8B,EACb,UAAyC,EACzC,kBAA4C;IAC7D,0GAA0G;IAC1G,oDAAoD;IACnC,aAAyC,EACzC,OAA0B,EAC1B,MAAwB;QARxB,iBAAY,GAAZ,YAAY,CAAqB;QAEjC,eAAU,GAAV,UAAU,CAA+B;QACzC,uBAAkB,GAAlB,kBAAkB,CAA0B;QAG5C,kBAAa,GAAb,aAAa,CAA4B;QACzC,YAAO,GAAP,OAAO,CAAmB;QAC1B,WAAM,GAAN,MAAM,CAAkB;QAnB7C,oBAAoB;QACH,YAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClD,+GAA+G;QAC/G,mCAAmC;QAClB,mBAAc,GAAgC,IAAI,GAAG,EAAE,CAAC;QACzE,qDAAqD;QACpC,oBAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;QAetD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE;gBAChD,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;aAC/E;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACK,iBAAiB,CAAC,MAAc;QACpC,OAAO,IAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAc;;QAC/B,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,CAAC,mCAAI,MAAM,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAExE,0GAA0G;QAC1G,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;QAEnD,OAAO,IAAI,UAAU,CACjB,GAAG,WAAW,CAAC,QAAQ,IAAI,SAAS,EAAE,EACtC,IAAI,CAAC,YAAY,EACjB,KAAK,IAAI,EAAE,CAAC,gBAAgB,CAAC,cAAc,CACvC,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,EAAE,SAAS,EAAE,EAClD,KAAK,IAAI,EAAE;YACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC,EACD,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CACjC,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,SAAS,EAAE;YACpD,oDAAoD;YACpD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAChF;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YAC9E,8DAA8D;YAC9D,oGAAoG;YACpG,oCAAoC;YACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;SAC3E;QAED,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAClD,IAAI,CAAC,MAAM,EACX,EAAE,SAAS,EAAE,YAAY,EAAE,EAC3B,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAC9C,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CACjC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,UAAU,CACzB,GAAG,WAAW,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EACxC,IAAI,CAAC,YAAY;QACjB,oGAAoG;QACpG,oDAAoD;QACpD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CACnE,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACtC,MAAM,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;aAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,QAAQ,EAAQ,CAAC,CAAC;YAE3D,oEAAoE;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,MAAM,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,mBAAmB,CAAC,MAAc,EAAE,KAAc;QACrD,IAAI,KAAK,EAAE;YACP,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YAC3F,YAAY,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,SAAoC,EACpC,YAAyD;QAEzD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,EAAE,CAAC;SACb;QACD,IAAI,aAAa,CAAC;QAClB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE;YACT,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,QAA8B;;QACvC,IAAI,QAAQ,CAAC,GAAG,EAAE;YACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SACrG;QACD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,uBAAuB;YAClC,KAAK,EAAE,MAAA,MAAA,QAAQ,CAAC,GAAG,0CAAE,MAAM,mCAAI,CAAC;YAChC,aAAa,EAAE,MAAA,QAAQ,CAAC,aAAa,0CAAE,MAAM;SAChD,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,MAAM,MAAM,GAA2B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAEvD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACpC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH;;;;;;WAMG;QACH,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,oGAAoG;gBACpG,kDAAkD;gBAClD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;aACzF;SACJ;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,YAAsB;;QAC5C,kFAAkF;QAClF,sCAAsC;QACtC,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,CACF,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,QAAQ,EAC/D,KAAK,CAAC,8CAA8C,CACvD,CAAC;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAE5B,mGAAmG;YACnG,mFAAmF;YACnF,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,CAAC,EAAE;gBACjC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;IACL,CAAC;IAEM,SAAS,CAAC,gBAAoC;QACjD,6GAA6G;QAC7G,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;QACtG,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC1E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,OAAO,CACX,WAAW,CAAC,qBAAqB,EACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAC3D,CAAC;SACL;QAED,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC9F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AAlQsB,oBAAQ,GAAG,QAAQ,CAAC;AACnB,iCAAqB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { generateHandleContextPath, SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\n\n/**\n * This class represents blob (long string)\n * This object is used only when creating (writing) new blob and serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * DataObject.request() recognizes requests in the form of `/blobs/<id>`\n * and loads blob.\n */\nexport class BlobHandle implements IFluidHandle<ArrayBufferLike> {\n    private attached: boolean = false;\n\n    public get IFluidHandle(): IFluidHandle { return this; }\n\n    public get isAttached(): boolean {\n        return this.attached;\n    }\n\n    public readonly absolutePath: string;\n\n    constructor(\n        public readonly path: string,\n        public readonly routeContext: IFluidHandleContext,\n        public get: () => Promise<any>,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph() {\n        this.attached = true;\n    }\n\n    public bind(handle: IFluidHandle) {\n        throw new Error(\"Cannot bind to blob handle\");\n    }\n}\n\n/**\n * Information from a snapshot needed to load BlobManager\n */\nexport interface IBlobManagerLoadInfo {\n    ids?: string[];\n    redirectTable?: [string, string][];\n}\n\nexport class BlobManager {\n    public static readonly basePath = \"_blobs\";\n    private static readonly redirectTableBlobName = \".redirectTable\";\n    // uploaded blob IDs\n    private readonly blobIds: Set<string> = new Set();\n    // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a\n    // BlobAttach op has round-tripped.\n    private readonly pendingBlobIds: Map<string, Deferred<void>> = new Map();\n    // blobs uploaded while detached; cleared upon attach\n    private readonly detachedBlobIds: Set<string> = new Set();\n    // map of detached blob IDs to IDs used by storage. used to support blob handles given out while detached\n    private redirectTable: Map<string, string> | undefined;\n\n    constructor(\n        private readonly routeContext: IFluidHandleContext,\n        snapshot: IBlobManagerLoadInfo,\n        private readonly getStorage: () => IDocumentStorageService,\n        private readonly attachBlobCallback: (blobId: string) => void,\n        // To be called when a blob node is requested. blobPath is the path of the blob's node in GC's graph. It's\n        // of the format `/<BlobManager.basePath>/<blobId>`.\n        private readonly gcNodeUpdated: (blobPath: string) => void,\n        private readonly runtime: IContainerRuntime,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.runtime.once(\"dispose\", () => {\n            for (const promise of this.pendingBlobIds.values()) {\n                promise.reject(new Error(\"runtime disposed while blobAttach op in flight\"));\n            }\n        });\n        this.load(snapshot);\n    }\n\n    private hasBlob(id: string): boolean {\n        return this.blobIds.has(id) || this.detachedBlobIds.has(id);\n    }\n\n    /**\n     * For a blobId, returns its path in GC's graph. The node path is of the format `/<BlobManager.basePath>/<blobId>`\n     * This path must match the path of the blob handle returned by the createBlob API because blobs are marked\n     * referenced by storing these handles in a referenced DDS.\n     */\n    private getBlobGCNodePath(blobId: string) {\n        return `/${BlobManager.basePath}/${blobId}`;\n    }\n\n    public async getBlob(blobId: string): Promise<IFluidHandle<ArrayBufferLike>> {\n        const storageId = this.redirectTable?.get(blobId) ?? blobId;\n        assert(this.hasBlob(storageId), 0x11f /* \"requesting unknown blobs\" */);\n\n        // When this blob is retrieved, let the container runtime know that the corresponding GC node got updated.\n        this.gcNodeUpdated(this.getBlobGCNodePath(blobId));\n\n        return new BlobHandle(\n            `${BlobManager.basePath}/${storageId}`,\n            this.routeContext,\n            async () => PerformanceEvent.timedExecAsync(\n                this.logger,\n                { eventName: \"AttachmentReadBlob\", id: storageId },\n                async () => {\n                    return this.getStorage().readBlob(storageId);\n                },\n                { end: true, cancel: \"error\" },\n            ),\n        );\n    }\n\n    public async createBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n        if (this.runtime.attachState === AttachState.Attaching) {\n            // blob upload is not supported in \"Attaching\" state\n            this.logger.sendTelemetryEvent({ eventName: \"CreateBlobWhileAttaching\" });\n            await new Promise<void>((resolve) => this.runtime.once(\"attached\", resolve));\n        }\n\n        if (!this.runtime.connected && this.runtime.attachState === AttachState.Attached) {\n            // see https://github.com/microsoft/FluidFramework/issues/8246\n            // Avoid getting storage if we are offline since it might be undefined. In the future we will return\n            // handles immediately while offline\n            await new Promise((resolve) => this.runtime.once(\"connected\", resolve));\n        }\n\n        const response = await PerformanceEvent.timedExecAsync(\n            this.logger,\n            { eventName: \"createBlob\" },\n            async () => this.getStorage().createBlob(blob),\n            { end: true, cancel: \"error\" },\n        );\n\n        const handle = new BlobHandle(\n            `${BlobManager.basePath}/${response.id}`,\n            this.routeContext,\n            // get() should go through BlobManager.getBlob() so handles created while detached can be redirected\n            // to the correct storage id after they are uploaded\n            async () => this.getBlob(response.id).then(async (h) => h.get()),\n        );\n\n        if (this.runtime.attachState === AttachState.Detached) {\n            this.detachedBlobIds.add(response.id);\n            return handle;\n        }\n\n        // Note - server will de-dup blobs, so we might get existing blobId!\n        if (this.pendingBlobIds.has(response.id)) {\n            await this.pendingBlobIds.get(response.id)?.promise;\n        } else if (!this.blobIds.has(response.id)) {\n            this.pendingBlobIds.set(response.id, new Deferred<void>());\n\n            // send blob attach op and wait until we see it to return the handle\n            this.attachBlobCallback(response.id);\n            await this.pendingBlobIds.get(response.id)?.promise;\n        }\n\n        return handle;\n    }\n\n    public processBlobAttachOp(blobId: string, local: boolean) {\n        if (local) {\n            const pendingBlobP = this.pendingBlobIds.get(blobId);\n            assert(pendingBlobP !== undefined, 0x1f8 /* \"local BlobAttach op with no pending blob\" */);\n            pendingBlobP.resolve();\n            this.pendingBlobIds.delete(blobId);\n        }\n        this.blobIds.add(blobId);\n    }\n\n    /**\n     * Reads blobs needed to load BlobManager from storage.\n     */\n    public static async load(\n        blobsTree: ISnapshotTree | undefined,\n        tryFetchBlob: (id: string) => Promise<[string, string][]>,\n    ): Promise<IBlobManagerLoadInfo> {\n        if (!blobsTree) {\n            return {};\n        }\n        let redirectTable;\n        const tableId = blobsTree.blobs[this.redirectTableBlobName];\n        if (tableId) {\n            redirectTable = await tryFetchBlob(tableId);\n        }\n        const ids = Object.entries(blobsTree.blobs)\n            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);\n        return { ids, redirectTable };\n    }\n\n    /**\n     * Load a set of previously attached blob IDs from a previous snapshot. Note\n     * that BlobManager tracking and reporting attached blobs is a temporary\n     * solution since storage expects attached blobs to be reported and any that\n     * are not reported as attached may be GCed. In the future attached blob\n     * IDs will be collected at summarization time, and runtime will not care\n     * about the existence or specific formatting of this tree in returned\n     * snapshots.\n     *\n     * @param blobsTree - Tree containing IDs of previously attached blobs. This\n     * corresponds to snapshot() below. We look for the IDs in the blob entries\n     * of the tree since the both the r11s and SPO drivers replace the\n     * attachment types returned in snapshot() with blobs.\n     */\n    private load(snapshot: IBlobManagerLoadInfo): void {\n        if (snapshot.ids) {\n            const detached = this.runtime.attachState === AttachState.Detached;\n            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));\n        }\n        if (snapshot.redirectTable) {\n            this.redirectTable = new Map(snapshot.redirectTable);\n        }\n        this.logger.sendTelemetryEvent({\n            eventName: \"AttachmentBlobsLoaded\",\n            count: snapshot.ids?.length ?? 0,\n            redirectTable: snapshot.redirectTable?.length,\n        });\n    }\n\n    /**\n     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be\n     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care\n     * about this for now because the data is a simple list of blob ids.\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        const gcData: IGarbageCollectionData = { gcNodes: {} };\n\n        this.blobIds.forEach((blobId: string) => {\n            gcData.gcNodes[this.getBlobGCNodePath(blobId)] = [];\n        });\n\n        /**\n         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these\n         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node\n         * must also be marked referenced. So, we add a route from the localId node to the storageId node.\n         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or\n         * a blob may be referenced via its storageId handle.\n         */\n        if (this.redirectTable !== undefined) {\n            for (const [localId, storageId] of this.redirectTable) {\n                // Add node for the localId and add a route to the storageId node. The storageId node will have been\n                // added above when adding nodes for this.blobIds.\n                gcData.gcNodes[this.getBlobGCNodePath(localId)] = [this.getBlobGCNodePath(storageId)];\n            }\n        }\n\n        return gcData;\n    }\n\n    /**\n     * When running GC in test mode, this is called to delete blobs that are unused.\n     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.\n     */\n    public deleteUnusedRoutes(unusedRoutes: string[]): void {\n        // The routes or blob node paths are in the same format as returned in getGCData -\n        // `/<BlobManager.basePath>/<blobId>`.\n        for (const route of unusedRoutes) {\n            const pathParts = route.split(\"/\");\n            assert(\n                pathParts.length === 3 && pathParts[1] === BlobManager.basePath,\n                0x2d5 /* \"Invalid blob node id in unused routes.\" */,\n            );\n            const blobId = pathParts[2];\n\n            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The\n            // corresponding storageId may still be used either directly or via other localIds.\n            if (this.redirectTable?.has(blobId)) {\n                this.redirectTable.delete(blobId);\n                continue;\n            }\n            this.blobIds.delete(blobId);\n        }\n    }\n\n    public summarize(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats {\n        // If we have a redirect table it means the container is about to transition to \"Attaching\" state, so we need\n        // to return an actual snapshot containing all the real storage IDs we know about.\n        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;\n        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;\n        const builder = new SummaryTreeBuilder();\n        blobIds.forEach((blobId) => {\n            builder.addAttachment(blobId);\n        });\n\n        if (this.redirectTable && this.redirectTable.size > 0) {\n            builder.addBlob(\n                BlobManager.redirectTableBlobName,\n                JSON.stringify(Array.from(this.redirectTable.entries())),\n            );\n        }\n\n        return builder.getSummaryTree();\n    }\n\n    public setRedirectTable(table: Map<string, string>) {\n        assert(this.runtime.attachState === AttachState.Detached,\n            0x252 /* \"redirect table can only be set in detached container\" */);\n        assert(!this.redirectTable, 0x253 /* \"redirect table already exists\" */);\n        for (const [localId, storageId] of table) {\n            assert(this.detachedBlobIds.delete(localId), 0x254 /* \"unrecognized id in redirect table\" */);\n            this.blobIds.add(storageId);\n        }\n        assert(this.detachedBlobIds.size === 0, 0x255 /* \"detached blob id absent in redirect table\" */);\n        this.redirectTable = table;\n    }\n}\n"]}

package/lib/connectionTelemetry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"connectionTelemetry.d.ts","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAG9C;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAkPrC,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,4BAA4B,EAAE,MAAM,GAAG,SAAS,CAAC;CACpD;AAED,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,MAAM,EAAE,gBAAgB,QAE3B"}

package/lib/connectionTelemetry.js

@@ -1,174 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ChildLogger, TelemetryLogger } from "@fluidframework/telemetry-utils";
-import { MessageType, } from "@fluidframework/protocol-definitions";
-import { assert, performance } from "@fluidframework/common-utils";
-/**
- * We report various latency-related errors when waiting for op roundtrip takes longer than that amout of time.
- */
-export const latencyThreshold = 5000;
-class OpPerfTelemetry {
-    constructor(clientId, deltaManager, logger) {
-        this.clientId = clientId;
-        this.deltaManager = deltaManager;
-        this.pongCount = 0;
-        this.msnTrackingTimestamp = 0;
-        this.opProcessingTimes = {};
-        // Performance Data to be reported for ops round trips and processing.
-        this.opPerfData = {};
-        this.firstConnection = true;
-        this.bootTime = performance.now();
-        this.connectionStartTime = 0;
-        this.gap = 0;
-        this.logger = ChildLogger.create(logger, "OpPerf");
-        this.deltaManager.on("pong", (latency) => this.recordPingTime(latency));
-        this.deltaManager.on("submitOp", (message) => this.beforeOpSubmit(message));
-        this.deltaManager.on("op", (message) => this.afterProcessingOp(message));
-        this.deltaManager.on("connect", (details, opsBehind) => {
-            this.clientId = details.clientId;
-            if (opsBehind !== undefined) {
-                this.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;
-                this.gap = opsBehind;
-                this.connectionStartTime = performance.now();
-                // We might be already up-today. If so, report it right away.
-                if (this.gap <= 0) {
-                    this.reportGettingUpToDate();
-                }
-            }
-        });
-        this.deltaManager.on("disconnect", () => {
-            this.sequenceNumberForMsnTracking = undefined;
-            this.clientSequenceNumberForLatencyStatistics = undefined;
-            this.opProcessingTimes = {};
-            this.opPerfData = {};
-            this.connectionOpSeqNumber = undefined;
-            this.firstConnection = false;
-            this.pongCount = 0;
-        });
-        this.deltaManager.outbound.on("push", (messages) => {
-            for (const msg of messages) {
-                if (msg.type === MessageType.Operation &&
-                    this.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber) {
-                    assert(this.opProcessingTimes.outboundPushEventTime === undefined, 0x2c8 /* "outboundPushEventTime should be undefined" */);
-                    assert(this.opPerfData.durationNetwork === undefined, 0x2c9 /* "durationNetwork should be undefined" */);
-                    this.opProcessingTimes.outboundPushEventTime = Date.now();
-                    assert(this.opPerfData.durationOutboundBatching === undefined, 0x2ca /* "durationOutboundBatching should be undefined" */);
-                    assert(this.opProcessingTimes.submitOpEventTime !== undefined, 0x2cb /* "submitOpEventTime should be undefined" */);
-                    this.opPerfData.durationOutboundBatching = this.opProcessingTimes.outboundPushEventTime
-                        - this.opProcessingTimes.submitOpEventTime;
-                }
-            }
-        });
-        this.deltaManager.inbound.on("push", (message) => {
-            if (this.clientId === message.clientId &&
-                message.type === MessageType.Operation &&
-                this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber &&
-                this.opProcessingTimes.outboundPushEventTime !== undefined) {
-                this.opProcessingTimes.inboundPushEventTime = Date.now();
-                this.opPerfData.durationNetwork = this.opProcessingTimes.inboundPushEventTime
-                    - this.opProcessingTimes.outboundPushEventTime;
-                this.opProcessingTimes.outboundPushEventTime = undefined;
-                this.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;
-            }
-        });
-        this.deltaManager.inbound.on("idle", (count, duration) => {
-            // Do not want to log zero for sure.
-            // We are more interested in aggregates, so logging only if we are processing some number of ops
-            // Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we
-            // want to get answered
-            // back-compat: Once 0.36 loader version saturates (count & duration args were added there),
-            // we can remove typeof check.
-            if (typeof count === "number" && count >= 100) {
-                this.logger.sendPerformanceEvent({
-                    eventName: "GetDeltas_OpProcessing",
-                    count,
-                    duration,
-                });
-            }
-        });
-    }
-    reportGettingUpToDate() {
-        this.connectionOpSeqNumber = undefined;
-        this.logger.sendPerformanceEvent({
-            eventName: "ConnectionSpeed",
-            duration: performance.now() - this.connectionStartTime,
-            ops: this.gap,
-            // track time to connect only for first connection.
-            timeToConnect: this.firstConnection ?
-                TelemetryLogger.formatTick(this.connectionStartTime - this.bootTime) :
-                undefined,
-            firstConnection: this.firstConnection,
-        });
-    }
-    recordPingTime(latency) {
-        this.pingLatency = latency;
-        // logging one in every 1000 pongs, including the first time, if it is a "write" client.
-        if (this.pongCount % 100 === 0 && this.deltaManager.active) {
-            this.logger.sendPerformanceEvent({
-                eventName: "DeltaLatency",
-                duration: latency,
-            });
-        }
-        this.pongCount++;
-    }
-    beforeOpSubmit(message) {
-        // start with first client op and measure latency every 500 client ops
-        if (this.clientSequenceNumberForLatencyStatistics === undefined &&
-            message.clientSequenceNumber % 500 === 1) {
-            assert(this.opProcessingTimes.outboundPushEventTime === undefined, 0x2cc /* "OpTimeSittingInboundQueue should be undefined" */);
-            assert(this.opPerfData.durationNetwork === undefined, 0x2cd /* "durationNetwork should be undefined" */);
-            this.opProcessingTimes.submitOpEventTime = Date.now();
-            this.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;
-        }
-    }
-    afterProcessingOp(message) {
-        const sequenceNumber = message.sequenceNumber;
-        if (sequenceNumber === this.connectionOpSeqNumber) {
-            this.reportGettingUpToDate();
-        }
-        // Record collab window max size after every 1000th op.
-        if (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {
-            this.sequenceNumberForMsnTracking = sequenceNumber;
-            this.msnTrackingTimestamp = message.timestamp;
-        }
-        if (this.sequenceNumberForMsnTracking !== undefined &&
-            message.minimumSequenceNumber >= this.sequenceNumberForMsnTracking) {
-            assert(this.msnTrackingTimestamp !== undefined, 0x2ce /* "msnTrackingTimestamp should not be undefined" */);
-            this.logger.sendPerformanceEvent({
-                eventName: "MsnStatistics",
-                sequenceNumber,
-                msnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,
-                duration: message.timestamp - this.msnTrackingTimestamp,
-            });
-            this.sequenceNumberForMsnTracking = undefined;
-        }
-        if (this.clientId === message.clientId &&
-            this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber) {
-            assert(this.opProcessingTimes.submitOpEventTime !== undefined, 0x120 /* "Undefined latency statistics (op send time)" */);
-            const currentTime = Date.now();
-            if (this.opProcessingTimes.inboundPushEventTime !== undefined) {
-                this.opPerfData.durationInboundToProcessing = currentTime
-                    - this.opProcessingTimes.inboundPushEventTime;
-            }
-            const duration = currentTime - this.opProcessingTimes.submitOpEventTime;
-            // One of the core expectations for Fluid service is to be fast.
-            // When it's not the case, we want to learn about it and be able to investigate, so
-            // raise awareness.
-            // This also helps identify cases where it's due to client behavior (sending too many ops)
-            // that results in overwhelming ordering service and thus starting to see long latencies.
-            // The threshold could be adjusted, but ideally it stays  workload-agnostic, as service
-            // performance impacts all workloads relying on service.
-            const category = duration > latencyThreshold ? "error" : "performance";
-            this.logger.sendPerformanceEvent(Object.assign({ eventName: "OpRoundtripTime", sequenceNumber, referenceSequenceNumber: message.referenceSequenceNumber, duration,
-                category, pingLatency: this.pingLatency, msnDistance: this.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber }, this.opPerfData));
-            this.clientSequenceNumberForLatencyStatistics = undefined;
-            this.opPerfData = {};
-        }
-    }
-}
-export function ReportOpPerfTelemetry(clientId, deltaManager, logger) {
-    new OpPerfTelemetry(clientId, deltaManager, logger);
-}
-//# sourceMappingURL=connectionTelemetry.js.map

package/lib/connectionTelemetry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"connectionTelemetry.js","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAE/E,OAAO,EAGH,WAAW,GACd,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEnE;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAgCrC,MAAM,eAAe;IAuBjB,YACY,QAA4B,EACnB,YAAwE,EACzF,MAAwB;QAFhB,aAAQ,GAAR,QAAQ,CAAoB;QACnB,iBAAY,GAAZ,YAAY,CAA4D;QAxBrF,cAAS,GAAW,CAAC,CAAC;QAKtB,yBAAoB,GAAW,CAAC,CAAC;QAIjC,sBAAiB,GAA4B,EAAE,CAAC;QAExD,sEAAsE;QAC9D,eAAU,GAAwC,EAAE,CAAC;QAErD,oBAAe,GAAG,IAAI,CAAC;QAEd,aAAQ,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACtC,wBAAmB,GAAG,CAAC,CAAC;QACxB,QAAG,GAAG,CAAC,CAAC;QAQZ,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEnD,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;QAE5E,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;QAEzE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YACjC,IAAI,SAAS,KAAK,SAAS,EAAE;gBACzB,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBAClE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;gBACrB,IAAI,CAAC,mBAAmB,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;gBAE7C,6DAA6D;gBAC7D,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE;oBACf,IAAI,CAAC,qBAAqB,EAAE,CAAC;iBAChC;aACJ;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;YAC9C,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;gBACxB,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS;oBAClC,IAAI,CAAC,wCAAwC,KAAK,GAAG,CAAC,oBAAoB,EAAE;oBAC5E,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAC7D,KAAK,CAAC,iDAAiD,CAAC,CAAC;oBAC7D,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EAChD,KAAK,CAAC,2CAA2C,CAAC,CAAC;oBACvD,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAE1D,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,wBAAwB,KAAK,SAAS,EACzD,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBAEhE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EACzD,KAAK,CAAC,6CAA6C,CAAC,CAAC;oBAEzD,IAAI,CAAC,UAAU,CAAC,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,CAAC,qBAAqB;0BACjF,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;iBAClD;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAkC,EAAE,EAAE;YACxE,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAClC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS;gBACtC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB;gBAC9E,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAAE;gBAC5D,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzD,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB;sBACtD,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC;gBACpE,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,GAAG,SAAS,CAAC;gBACzD,IAAI,CAAC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;aACzE;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,QAAgB,EAAE,EAAE;YACrE,oCAAoC;YACpC,gGAAgG;YAChG,0GAA0G;YAC1G,uBAAuB;YACvB,4FAA4F;YAC5F,8BAA8B;YAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,GAAG,EAAE;gBAC3C,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,wBAAwB;oBACnC,KAAK;oBACL,QAAQ;iBACX,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB;QACzB,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,mBAAmB;YACtD,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,mDAAmD;YACnD,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;gBACjC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtE,SAAS;YACb,eAAe,EAAE,IAAI,CAAC,eAAe;SACxC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,OAAe;QAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAC3B,wFAAwF;QACxF,IAAI,IAAI,CAAC,SAAS,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,OAAO;aACpB,CAAC,CAAC;SACN;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;IACrB,CAAC;IAEO,cAAc,CAAC,OAAyB;QAC5C,sEAAsE;QACtE,IAAI,IAAI,CAAC,wCAAwC,KAAK,SAAS;YAC3D,OAAO,CAAC,oBAAoB,GAAG,GAAG,KAAK,CAAC,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,KAAK,SAAS,EAC7D,KAAK,CAAC,qDAAqD,CAAC,CAAC;YACjE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,KAAK,SAAS,EAChD,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACvD,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACtD,IAAI,CAAC,wCAAwC,GAAG,OAAO,CAAC,oBAAoB,CAAC;SAChF;IACL,CAAC;IAEO,iBAAiB,CAAC,OAAkC;QACxD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAE9C,IAAI,cAAc,KAAK,IAAI,CAAC,qBAAqB,EAAE;YAC/C,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAChC;QAED,uDAAuD;QACvD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,EAAE;YAChF,IAAI,CAAC,4BAA4B,GAAG,cAAc,CAAC;YACnD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;SACjD;QACD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS;YAC3C,OAAO,CAAC,qBAAqB,IAAI,IAAI,CAAC,4BAA4B,EAAE;YACxE,MAAM,CAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAC1C,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAChE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBAC7B,SAAS,EAAE,eAAe;gBAC1B,cAAc;gBACd,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC,4BAA4B;gBAC/D,QAAQ,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,oBAAoB;aAC1D,CAAC,CAAC;YACH,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;SACjD;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAClC,IAAI,CAAC,wCAAwC,KAAK,OAAO,CAAC,oBAAoB,EAAE;YAChF,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,SAAS,EACzD,KAAK,CAAC,mDAAmD,CAAC,CAAC;YAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE/B,IAAI,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,KAAK,SAAS,EAAE;gBAC3D,IAAI,CAAC,UAAU,CAAC,2BAA2B,GAAG,WAAW;sBACvD,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;aACjD;YAED,MAAM,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;YAExE,gEAAgE;YAChE,mFAAmF;YACnF,mBAAmB;YACnB,0FAA0F;YAC1F,yFAAyF;YACzF,uFAAuF;YACvF,wDAAwD;YACxD,MAAM,QAAQ,GAAG,QAAQ,GAAG,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;YAEvE,IAAI,CAAC,MAAM,CAAC,oBAAoB,iBAC5B,SAAS,EAAE,iBAAiB,EAC5B,cAAc,EACd,uBAAuB,EAAE,OAAO,CAAC,uBAAuB,EACxD,QAAQ;gBACR,QAAQ,EACR,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,qBAAqB,IACxF,IAAI,CAAC,UAAU,EACpB,CAAC;YACH,IAAI,CAAC,wCAAwC,GAAG,SAAS,CAAC;YAC1D,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACxB;IACL,CAAC;CACJ;AAuBD,MAAM,UAAU,qBAAqB,CACjC,QAA4B,EAC5B,YAAwE,EACxE,MAAwB;IACxB,IAAI,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger, TelemetryLogger } from \"@fluidframework/telemetry-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\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    /** Measure time between (1) and (2) - Measure time outbound op is sitting in queue due to active batch */\n    durationOutboundBatching: number; // was durationOutboundQueue in previous versions\n    /** Measure time between (2) and (3) - Track how long it took for op to be acked by service */\n    durationNetwork: number; // was durationInboundQueue\n    /** Measure time between (3) and (4) - Time between DM's inbound \"push\" event until DM's \"op\" event */\n    durationInboundToProcessing: number;\n    /** Length of the DeltaManager's inbound queue at the time of the DM's inbound \"push\" event (3) */\n    lengthInboundQueue: number;\n}\n\n/**\n * Timings collected at various moments during the op processing.\n */\n interface IOpPerfTimings {\n     /** Starting time for (1) */\n    submitOpEventTime: number;\n     /** Starting time for (2) */\n     outboundPushEventTime: number;\n     /** Starting time for (3) */\n     inboundPushEventTime: number;\n}\n\nclass OpPerfTelemetry {\n    private pongCount: number = 0;\n    private pingLatency: number | undefined;\n\n    // Collab window tracking. This is timestamp of %1000 message.\n    private sequenceNumberForMsnTracking: number | undefined;\n    private msnTrackingTimestamp: number = 0;\n    // To track round trip time for every %500 client message.\n    private clientSequenceNumberForLatencyStatistics: number | undefined;\n\n    private opProcessingTimes: Partial<IOpPerfTimings> = {};\n\n    // Performance Data to be reported for ops round trips and processing.\n    private opPerfData: Partial<IOpPerfTelemetryProperties> = {};\n\n    private firstConnection = true;\n    private connectionOpSeqNumber: number | undefined;\n    private readonly bootTime = performance.now();\n    private connectionStartTime = 0;\n    private gap = 0;\n\n    private readonly logger: ITelemetryLogger;\n\n    public constructor(\n        private clientId: string | undefined,\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        logger: ITelemetryLogger) {\n        this.logger = ChildLogger.create(logger, \"OpPerf\");\n\n        this.deltaManager.on(\"pong\", (latency) => this.recordPingTime(latency));\n        this.deltaManager.on(\"submitOp\", (message) => this.beforeOpSubmit(message));\n\n        this.deltaManager.on(\"op\", (message) => this.afterProcessingOp(message));\n\n        this.deltaManager.on(\"connect\", (details, opsBehind) => {\n            this.clientId = details.clientId;\n            if (opsBehind !== undefined) {\n                this.connectionOpSeqNumber = this.deltaManager.lastKnownSeqNumber;\n                this.gap = opsBehind;\n                this.connectionStartTime = performance.now();\n\n                // We might be already up-today. If so, report it right away.\n                if (this.gap <= 0) {\n                    this.reportGettingUpToDate();\n                }\n            }\n        });\n        this.deltaManager.on(\"disconnect\", () => {\n            this.sequenceNumberForMsnTracking = undefined;\n            this.clientSequenceNumberForLatencyStatistics = undefined;\n            this.opProcessingTimes = {};\n            this.opPerfData = {};\n            this.connectionOpSeqNumber = undefined;\n            this.firstConnection = false;\n            this.pongCount = 0;\n        });\n\n        this.deltaManager.outbound.on(\"push\", (messages) => {\n            for (const msg of messages) {\n                if (msg.type === MessageType.Operation &&\n                    this.clientSequenceNumberForLatencyStatistics === msg.clientSequenceNumber) {\n                    assert(this.opProcessingTimes.outboundPushEventTime === undefined,\n                        0x2c8 /* \"outboundPushEventTime should be undefined\" */);\n                    assert(this.opPerfData.durationNetwork === undefined,\n                        0x2c9 /* \"durationNetwork should be undefined\" */);\n                    this.opProcessingTimes.outboundPushEventTime = Date.now();\n\n                    assert(this.opPerfData.durationOutboundBatching === undefined,\n                        0x2ca /* \"durationOutboundBatching should be undefined\" */);\n\n                    assert(this.opProcessingTimes.submitOpEventTime !== undefined,\n                        0x2cb /* \"submitOpEventTime should be undefined\" */);\n\n                    this.opPerfData.durationOutboundBatching = this.opProcessingTimes.outboundPushEventTime\n                        - this.opProcessingTimes.submitOpEventTime;\n                }\n            }\n        });\n\n        this.deltaManager.inbound.on(\"push\", (message: ISequencedDocumentMessage) => {\n            if (this.clientId === message.clientId &&\n                message.type === MessageType.Operation &&\n                this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber &&\n                this.opProcessingTimes.outboundPushEventTime !== undefined) {\n                this.opProcessingTimes.inboundPushEventTime = Date.now();\n                this.opPerfData.durationNetwork = this.opProcessingTimes.inboundPushEventTime\n                                     - this.opProcessingTimes.outboundPushEventTime;\n                this.opProcessingTimes.outboundPushEventTime = undefined;\n                this.opPerfData.lengthInboundQueue = this.deltaManager.inbound.length;\n            }\n        });\n\n        this.deltaManager.inbound.on(\"idle\", (count: number, duration: number) => {\n            // Do not want to log zero for sure.\n            // We are more interested in aggregates, so logging only if we are processing some number of ops\n            // Cut-off is arbitrary - can be increased or decreased based on amount of data collected and questions we\n            // want to get answered\n            // back-compat: Once 0.36 loader version saturates (count & duration args were added there),\n            // we can remove typeof check.\n            if (typeof count === \"number\" && count >= 100) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"GetDeltas_OpProcessing\",\n                    count,\n                    duration,\n                });\n            }\n        });\n    }\n\n    private reportGettingUpToDate() {\n        this.connectionOpSeqNumber = undefined;\n        this.logger.sendPerformanceEvent({\n            eventName: \"ConnectionSpeed\",\n            duration: performance.now() - this.connectionStartTime,\n            ops: this.gap,\n            // track time to connect only for first connection.\n            timeToConnect: this.firstConnection ?\n                TelemetryLogger.formatTick(this.connectionStartTime - this.bootTime) :\n                undefined,\n            firstConnection: this.firstConnection,\n        });\n    }\n\n    private recordPingTime(latency: number) {\n        this.pingLatency = latency;\n        // logging one in every 1000 pongs, including the first time, if it is a \"write\" client.\n        if (this.pongCount % 100 === 0 && this.deltaManager.active) {\n            this.logger.sendPerformanceEvent({\n                eventName: \"DeltaLatency\",\n                duration: latency,\n            });\n        }\n        this.pongCount++;\n    }\n\n    private beforeOpSubmit(message: IDocumentMessage) {\n        // start with first client op and measure latency every 500 client ops\n        if (this.clientSequenceNumberForLatencyStatistics === undefined &&\n            message.clientSequenceNumber % 500 === 1) {\n            assert(this.opProcessingTimes.outboundPushEventTime === undefined,\n                0x2cc /* \"OpTimeSittingInboundQueue should be undefined\" */);\n            assert(this.opPerfData.durationNetwork === undefined,\n                0x2cd /* \"durationNetwork should be undefined\" */);\n            this.opProcessingTimes.submitOpEventTime = Date.now();\n            this.clientSequenceNumberForLatencyStatistics = message.clientSequenceNumber;\n        }\n    }\n\n    private afterProcessingOp(message: ISequencedDocumentMessage) {\n        const sequenceNumber = message.sequenceNumber;\n\n        if (sequenceNumber === this.connectionOpSeqNumber) {\n            this.reportGettingUpToDate();\n        }\n\n        // Record collab window max size after every 1000th op.\n        if (this.sequenceNumberForMsnTracking === undefined && sequenceNumber % 1000 === 0) {\n            this.sequenceNumberForMsnTracking = sequenceNumber;\n            this.msnTrackingTimestamp = message.timestamp;\n        }\n        if (this.sequenceNumberForMsnTracking !== undefined &&\n                message.minimumSequenceNumber >= this.sequenceNumberForMsnTracking) {\n            assert(this.msnTrackingTimestamp !== undefined,\n                0x2ce /* \"msnTrackingTimestamp should not be undefined\" */);\n            this.logger.sendPerformanceEvent({\n                eventName: \"MsnStatistics\",\n                sequenceNumber,\n                msnDistance: sequenceNumber - this.sequenceNumberForMsnTracking,\n                duration: message.timestamp - this.msnTrackingTimestamp,\n            });\n            this.sequenceNumberForMsnTracking = undefined;\n        }\n\n        if (this.clientId === message.clientId &&\n            this.clientSequenceNumberForLatencyStatistics === message.clientSequenceNumber) {\n            assert(this.opProcessingTimes.submitOpEventTime !== undefined,\n                0x120 /* \"Undefined latency statistics (op send time)\" */);\n            const currentTime = Date.now();\n\n            if (this.opProcessingTimes.inboundPushEventTime !== undefined) {\n                this.opPerfData.durationInboundToProcessing = currentTime\n                - this.opProcessingTimes.inboundPushEventTime;\n            }\n\n            const duration = currentTime - this.opProcessingTimes.submitOpEventTime;\n\n            // One of the core expectations for Fluid service is to be fast.\n            // When it's not the case, we want to learn about it and be able to investigate, so\n            // raise awareness.\n            // This also helps identify cases where it's due to client behavior (sending too many ops)\n            // that results in overwhelming ordering service and thus starting to see long latencies.\n            // The threshold could be adjusted, but ideally it stays  workload-agnostic, as service\n            // performance impacts all workloads relying on service.\n            const category = duration > latencyThreshold ? \"error\" : \"performance\";\n\n            this.logger.sendPerformanceEvent({\n                eventName: \"OpRoundtripTime\",\n                sequenceNumber,\n                referenceSequenceNumber: message.referenceSequenceNumber,\n                duration,\n                category,\n                pingLatency: this.pingLatency,\n                msnDistance: this.deltaManager.lastSequenceNumber - this.deltaManager.minimumSequenceNumber,\n                ...this.opPerfData,\n            });\n            this.clientSequenceNumberForLatencyStatistics = undefined;\n            this.opPerfData = {};\n        }\n    }\n}\nexport interface IPerfSignalReport {\n    /**\n     * Identifier for the signal being submitted in order to\n     * allow collection of data around the roundtrip of signal messages.\n     */\n    signalSequenceNumber: number;\n    /**\n     * Number of signals that were expected but not received.\n     */\n    signalsLost: number;\n\n    /**\n     * Timestamp before submitting the signal we will trace.\n     */\n    signalTimestamp: number;\n\n    /**\n     * Expected Signal Sequence to be received.\n     */\n    trackingSignalSequenceNumber: number | undefined;\n}\n\nexport function ReportOpPerfTelemetry(\n    clientId: string | undefined,\n    deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n    logger: ITelemetryLogger) {\n    new OpPerfTelemetry(clientId, deltaManager, logger);\n}\n"]}

package/lib/containerHandleContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"containerHandleContext.d.ts","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AAGzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,qBAAa,2BAA4B,YAAW,mBAAmB;aAW/C,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO;aACR,YAAY,CAAC;IAZjC,IAAW,mBAAmB,SAAmB;IACjD,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;;;;OAKG;gBAEiB,IAAI,EAAE,MAAM,EACX,OAAO,EAAE,gBAAgB,EAC1B,YAAY,CAAC,iCAAqB;IAK/C,WAAW,IAAI,IAAI;IAI1B,IAAW,UAAU,YAEpB;IAEY,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAGpE"}

package/lib/containerHandleContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"containerHandleContext.js","sourceRoot":"","sources":["../src/containerHandleContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAG1E,MAAM,OAAO,2BAA2B;IAIpC;;;;;OAKG;IACH,YACoB,IAAY,EACX,OAAyB,EAC1B,YAAkC;QAFlC,SAAI,GAAJ,IAAI,CAAQ;QACX,YAAO,GAAP,OAAO,CAAkB;QAC1B,iBAAY,GAAZ,YAAY,CAAsB;QAElD,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAfD,IAAW,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAiB1C,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC7E,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAiB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidHandleContext,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { ContainerRuntime } from \"./containerRuntime\";\n\nexport class ContainerFluidHandleContext implements IFluidHandleContext {\n    public get IFluidHandleContext() { return this; }\n    public readonly absolutePath: string;\n\n    /**\n     * Creates a new ContainerFluidHandleContext.\n     * @param path - The path to this handle relative to the routeContext.\n     * @param runtime - The IRuntime object this context represents.\n     * @param routeContext - The parent IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        public readonly path: string,\n        private readonly runtime: ContainerRuntime,\n        public readonly routeContext?: IFluidHandleContext,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph(): void {\n        throw new Error(\"can't attach container runtime form within container!\");\n    }\n\n    public get isAttached() {\n        return this.runtime.attachState !== AttachState.Detached;\n    }\n\n    public async resolveHandle(request: IRequest): Promise<IResponse> {\n        return this.runtime.resolveHandle(request);\n    }\n}\n"]}