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

package/src/throttler.ts

@@ -4,28 +4,28 @@
  */
 
 export interface IThrottler {
-    /**
-     * Computes what the throttle delay should be, and records an attempt
-     * which will be used for calculating future attempt delays.
-     */
-    getDelay(): number;
-
-    /**
-     * Number of attempts that occurred within the sliding window as of
-     * the most recent delay computation.
-     */
-    readonly numAttempts: number;
-
-    /** Width of sliding delay window in milliseconds. */
-    readonly delayWindowMs: number;
-    /** Maximum delay allowed in milliseconds. */
-    readonly maxDelayMs: number;
-    /**
-     * Delay function used to calculate what the delay should be.
-     * The input is the number of attempts that occurred within the sliding window.
-     * The result is the calculated delay in milliseconds.
-     */
-    readonly delayFn: (numAttempts: number) => number;
+	/**
+	 * Computes what the throttle delay should be, and records an attempt
+	 * which will be used for calculating future attempt delays.
+	 */
+	getDelay(): number;
+
+	/**
+	 * Number of attempts that occurred within the sliding window as of
+	 * the most recent delay computation.
+	 */
+	readonly numAttempts: number;
+
+	/** Width of sliding delay window in milliseconds. */
+	readonly delayWindowMs: number;
+	/** Maximum delay allowed in milliseconds. */
+	readonly maxDelayMs: number;
+	/**
+	 * Delay function used to calculate what the delay should be.
+	 * The input is the number of attempts that occurred within the sliding window.
+	 * The result is the calculated delay in milliseconds.
+	 */
+	readonly delayFn: (numAttempts: number) => number;
 }
 
 /**
@@ -33,74 +33,74 @@ export interface IThrottler {
  * Delay is based on previous attempts within specified time window, subtracting delay time.
  */
 export class Throttler implements IThrottler {
-    private startTimes: number[] = [];
-
-    public get numAttempts() {
-        return this.startTimes.length;
-    }
-
-    /**
-     * Gets all attempt start times after compensating for the delay times
-     * by adding the delay times to the actual times.
-     */
-    public getAttempts(): readonly number[] {
-        return [...this.startTimes];
-    }
-
-    /**
-     * Latest attempt time after compensating for the delay time itself
-     * by adding the delay time to the actual time.
-     */
-    public get latestAttemptTime() {
-        return this.startTimes.length > 0 ? this.startTimes[this.startTimes.length - 1] : undefined;
-    }
-
-    constructor(
-        /** Width of sliding delay window in milliseconds. */
-        public readonly delayWindowMs: number,
-        /** Maximum delay allowed in milliseconds. */
-        public readonly maxDelayMs: number,
-        /**
-         * Delay function used to calculate what the delay should be.
-         * The input is the number of attempts that occurred within the sliding window.
-         * The result is the calculated delay in milliseconds.
-         */
-        public readonly delayFn: (numAttempts: number) => number,
-    ) { }
-
-    public getDelay() {
-        const now = Date.now();
-
-        const latestAttemptTime = this.latestAttemptTime;
-        if (latestAttemptTime !== undefined) {
-            // If getDelay was called sooner than the most recent delay,
-            // subtract the remaining time, since we previously added it.
-            const earlyMs = latestAttemptTime - now;
-            if (earlyMs > 0) {
-                this.startTimes = this.startTimes.map((t) => t - earlyMs);
-            }
-        }
-
-        // Remove all attempts that have already fallen out of the window.
-        this.startTimes = this.startTimes.filter((t) => (now - t) < this.delayWindowMs);
-
-        // Compute delay, but do not exceed the specified max delay.
-        const delayMs = Math.min(this.delayFn(this.startTimes.length), this.maxDelayMs);
-
-        // Record this attempt start time.
-        this.startTimes.push(now);
-
-        // Account for the delay time, by effectively removing it from the delay window.
-        this.startTimes = this.startTimes.map((t) => t + delayMs);
-
-        if (delayMs === this.maxDelayMs) {
-            // We hit max delay, so adding more won't affect anything.
-            // Shift off oldest time to stop this array from growing forever.
-            this.startTimes.shift();
-        }
-
-        return delayMs;
-    }
+	private startTimes: number[] = [];
+
+	public get numAttempts() {
+		return this.startTimes.length;
+	}
+
+	/**
+	 * Gets all attempt start times after compensating for the delay times
+	 * by adding the delay times to the actual times.
+	 */
+	public getAttempts(): readonly number[] {
+		return [...this.startTimes];
+	}
+
+	/**
+	 * Latest attempt time after compensating for the delay time itself
+	 * by adding the delay time to the actual time.
+	 */
+	public get latestAttemptTime() {
+		return this.startTimes.length > 0 ? this.startTimes[this.startTimes.length - 1] : undefined;
+	}
+
+	constructor(
+		/** Width of sliding delay window in milliseconds. */
+		public readonly delayWindowMs: number,
+		/** Maximum delay allowed in milliseconds. */
+		public readonly maxDelayMs: number,
+		/**
+		 * Delay function used to calculate what the delay should be.
+		 * The input is the number of attempts that occurred within the sliding window.
+		 * The result is the calculated delay in milliseconds.
+		 */
+		public readonly delayFn: (numAttempts: number) => number,
+	) {}
+
+	public getDelay() {
+		const now = Date.now();
+
+		const latestAttemptTime = this.latestAttemptTime;
+		if (latestAttemptTime !== undefined) {
+			// If getDelay was called sooner than the most recent delay,
+			// subtract the remaining time, since we previously added it.
+			const earlyMs = latestAttemptTime - now;
+			if (earlyMs > 0) {
+				this.startTimes = this.startTimes.map((t) => t - earlyMs);
+			}
+		}
+
+		// Remove all attempts that have already fallen out of the window.
+		this.startTimes = this.startTimes.filter((t) => now - t < this.delayWindowMs);
+
+		// Compute delay, but do not exceed the specified max delay.
+		const delayMs = Math.min(this.delayFn(this.startTimes.length), this.maxDelayMs);
+
+		// Record this attempt start time.
+		this.startTimes.push(now);
+
+		// Account for the delay time, by effectively removing it from the delay window.
+		this.startTimes = this.startTimes.map((t) => t + delayMs);
+
+		if (delayMs === this.maxDelayMs) {
+			// We hit max delay, so adding more won't affect anything.
+			// Shift off oldest time to stop this array from growing forever.
+			this.startTimes.shift();
+		}
+
+		return delayMs;
+	}
 }
 
 /**
@@ -114,28 +114,37 @@ export class Throttler implements IThrottler {
  * Use initialDelay to decide what should happen when numAttempts is 0,
  * leave it undefined to not special case.
  */
- export const formExponentialFn = ({
-    multiplier = 2,
-    coefficient = 1,
-    offset = 0,
-    initialDelay = undefined as number | undefined,
-} = {}): IThrottler["delayFn"] => (numAttempts) => Math.max(0,
-    numAttempts <= 0 && initialDelay !== undefined
-    ? initialDelay
-    : coefficient * (Math.pow(multiplier, numAttempts)) + offset);
+export const formExponentialFn =
+	({
+		multiplier = 2,
+		coefficient = 1,
+		offset = 0,
+		initialDelay = undefined as number | undefined,
+	} = {}): IThrottler["delayFn"] =>
+	(numAttempts) =>
+		Math.max(
+			0,
+			numAttempts <= 0 && initialDelay !== undefined
+				? initialDelay
+				: coefficient * Math.pow(multiplier, numAttempts) + offset,
+		);
 
 /** f(n) = C x (B^(n+A)) + F = (C x B^A) x B^n + F */
-export const formExponentialFnWithAttemptOffset = (attemptOffset: number, {
-    multiplier = 2,
-    coefficient = 1,
-    offset = 0,
-    initialDelay = undefined as number | undefined,
-} = {}) => formExponentialFn({
-    multiplier,
-    coefficient: coefficient * Math.pow(multiplier, attemptOffset),
-    offset,
-    initialDelay,
-});
+export const formExponentialFnWithAttemptOffset = (
+	attemptOffset: number,
+	{
+		multiplier = 2,
+		coefficient = 1,
+		offset = 0,
+		initialDelay = undefined as number | undefined,
+	} = {},
+) =>
+	formExponentialFn({
+		multiplier,
+		coefficient: coefficient * Math.pow(multiplier, attemptOffset),
+		offset,
+		initialDelay,
+	});
 
 /**
  * Helper function to generate simple linear throttle functions.
@@ -144,17 +153,17 @@ export const formExponentialFnWithAttemptOffset = (attemptOffset: number, {
  * If not provided, coefficient will default to 1, and offset to 0, yielding:
  * 0 ms, 1 ms, 2 ms, 3 ms, ..., n ms delays; a linear back-off.
  */
-export const formLinearFn = ({
-    coefficient = 1,
-    offset = 0,
-} = {}): IThrottler["delayFn"] => (numAttempts) => Math.max(0,
-    coefficient * numAttempts + offset);
+export const formLinearFn =
+	({ coefficient = 1, offset = 0 } = {}): IThrottler["delayFn"] =>
+	(numAttempts) =>
+		Math.max(0, coefficient * numAttempts + offset);
 
 /** f(n) = C x (n+A) + F = C x n + (C x A + F) */
-export const formLinearFnWithAttemptOffset = (attemptOffset: number, {
-    coefficient = 1,
-    offset = 0,
-} = {}) => formLinearFn({
-    coefficient,
-    offset: coefficient * attemptOffset + offset,
-});
+export const formLinearFnWithAttemptOffset = (
+	attemptOffset: number,
+	{ coefficient = 1, offset = 0 } = {},
+) =>
+	formLinearFn({
+		coefficient,
+		offset: coefficient * attemptOffset + offset,
+	});

package/tsc-multi.test.json

@@ -0,0 +1,4 @@
+{
+	"targets": [{ "extname": ".cjs", "module": "CommonJS", "moduleResolution": "Node16" }],
+	"projects": ["./tsconfig.json", "./src/test/tsconfig.json"]
+}

package/tsconfig.json

@@ -1,14 +1,12 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "compilerOptions": {
-        "composite": true,
-        "rootDir": "./src",
-        "outDir": "./dist"
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "src/test/**/*"
-    ]
-}
+	"extends": [
+		"../../../common/build/build-common/tsconfig.base.json",
+		"../../../common/build/build-common/tsconfig.cjs.json",
+	],
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+	},
+}

package/dist/batchTracker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchTracker.js","sourceRoot":"","sources":["../src/batchTracker.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,+DAAmE;AAEnE,qEAA8D;AAE9D,MAAa,YAAY;IAMrB,YACqB,iBAA+B,EAChD,MAAwB,EACxB,oBAA4B,EAC5B,sBAA8B,EAC9B,mBAAiC,GAAG,EAAE,CAAC,0BAAW,CAAC,GAAG,EAAE;QAJvC,sBAAiB,GAAjB,iBAAiB,CAAc;QAJ5C,sBAAiB,GAAW,CAAC,CAAC;QAUlC,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC3E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;YACvD,IAAI,CAAC,6BAA6B,GAAG,gBAAgB,EAAE,CAAC;YACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAsB,EAAE,OAAkC,EAAE,EAAE;YACjG,IAAA,qBAAM,EACF,IAAI,CAAC,wBAAwB,KAAK,SAAS,IAAI,IAAI,CAAC,6BAA6B,KAAK,SAAS,EAC/F,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAExD,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,GAAG,CAAC,CAAC;YAC1E,IAAI,MAAM,IAAI,oBAAoB,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;oBACvB,SAAS,EAAE,cAAc;oBACzB,MAAM;oBACN,SAAS,EAAE,oBAAoB;oBAC/B,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;oBACjE,UAAU,EAAE,KAAK,KAAK,SAAS;iBAClC,CAAC,CAAC;aACN;YAED,IAAI,IAAI,CAAC,iBAAiB,GAAG,sBAAsB,KAAK,CAAC,EAAE;gBACvD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,QAAQ;oBACnB,MAAM;oBACN,YAAY,EAAE,sBAAsB;oBACpC,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;iBACpE,CAAC,CAAC;aACN;YAED,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,6BAA6B,GAAG,SAAS,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AApDD,oCAoDC;AAED;;;;;;;;GAQG;AACI,MAAM,gBAAgB,GAAG,CAC5B,iBAA+B,EAC/B,MAAwB,EACxB,uBAA+B,IAAI,EACnC,yBAAiC,IAAI,EACvC,EAAE,CAAC,IAAI,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,CAAC,CAAC;AALlF,QAAA,gBAAgB,oBAKkE","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\n\nexport class BatchTracker {\n    private readonly logger: ITelemetryLogger;\n    private startBatchSequenceNumber: number | undefined;\n    private trackedBatchCount: number = 0;\n    private batchProcessingStartTimeStamp: number | undefined;\n\n    constructor(\n        private readonly batchEventEmitter: EventEmitter,\n        logger: ITelemetryLogger,\n        batchLengthThreshold: number,\n        batchCountSamplingRate: number,\n        dateTimeProvider: () => number = () => performance.now(),\n    ) {\n        this.logger = ChildLogger.create(logger, \"Batching\");\n\n        this.batchEventEmitter.on(\"batchBegin\", (message: ISequencedDocumentMessage) => {\n            this.startBatchSequenceNumber = message.sequenceNumber;\n            this.batchProcessingStartTimeStamp = dateTimeProvider();\n            this.trackedBatchCount++;\n        });\n\n        this.batchEventEmitter.on(\"batchEnd\", (error: any | undefined, message: ISequencedDocumentMessage) => {\n            assert(\n                this.startBatchSequenceNumber !== undefined && this.batchProcessingStartTimeStamp !== undefined,\n                0x2ba /* \"batchBegin must fire before batchEnd\" */);\n\n            const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;\n            if (length >= batchLengthThreshold) {\n                this.logger.sendErrorEvent({\n                    eventName: \"LengthTooBig\",\n                    length,\n                    threshold: batchLengthThreshold,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                    batchError: error !== undefined,\n                });\n            }\n\n            if (this.trackedBatchCount % batchCountSamplingRate === 0) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"Length\",\n                    length,\n                    samplingRate: batchCountSamplingRate,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                });\n            }\n\n            this.startBatchSequenceNumber = undefined;\n            this.batchProcessingStartTimeStamp = undefined;\n        });\n    }\n}\n\n/**\n * Track batch sizes in terms of op counts and processing times\n *\n * @param batchEventEmitter - event emitter which tracks the lifecycle of batch operations\n * @param logger - logger\n * @param batchLengthThreshold - threshold for the length of a batch when to send an error event\n * @param batchCountSamplingRate - rate for batches for which to send an event with its characteristics\n * @returns\n */\nexport const BindBatchTracker = (\n    batchEventEmitter: EventEmitter,\n    logger: ITelemetryLogger,\n    batchLengthThreshold: number = 1000,\n    batchCountSamplingRate: number = 1000,\n) => new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);\n"]}

package/dist/blobManager.js

@@ -1,249 +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.BlobManager = exports.BlobHandle = void 0;
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
-const common_utils_1 = require("@fluidframework/common-utils");
-const container_definitions_1 = require("@fluidframework/container-definitions");
-const telemetry_utils_1 = require("@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.
- */
-class BlobHandle {
-    constructor(path, routeContext, get) {
-        this.path = path;
-        this.routeContext = routeContext;
-        this.get = get;
-        this.attached = false;
-        this.absolutePath = (0, runtime_utils_1.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");
-    }
-}
-exports.BlobHandle = BlobHandle;
-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;
-        (0, common_utils_1.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 () => telemetry_utils_1.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 === container_definitions_1.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 === container_definitions_1.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 telemetry_utils_1.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 === container_definitions_1.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 common_utils_1.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);
-            (0, common_utils_1.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 === container_definitions_1.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("/");
-            (0, common_utils_1.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 !== container_definitions_1.AttachState.Detached;
-        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;
-        const builder = new runtime_utils_1.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) {
-        (0, common_utils_1.assert)(this.runtime.attachState === container_definitions_1.AttachState.Detached, 0x252 /* "redirect table can only be set in detached container" */);
-        (0, common_utils_1.assert)(!this.redirectTable, 0x253 /* "redirect table already exists" */);
-        for (const [localId, storageId] of table) {
-            (0, common_utils_1.assert)(this.detachedBlobIds.delete(localId), 0x254 /* "unrecognized id in redirect table" */);
-            this.blobIds.add(storageId);
-        }
-        (0, common_utils_1.assert)(this.detachedBlobIds.size === 0, 0x255 /* "detached blob id absent in redirect table" */);
-        this.redirectTable = table;
-    }
-}
-exports.BlobManager = BlobManager;
-BlobManager.basePath = "_blobs";
-BlobManager.redirectTableBlobName = ".redirectTable";
-//# sourceMappingURL=blobManager.js.map

package/dist/blobManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,iEAA8F;AAE9F,+DAAgE;AAEhE,iFAAoE;AACpE,qEAAmE;AAOnE;;;;;;GAMG;AACH,MAAa,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,IAAA,yCAAyB,EAAC,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;AA1BD,gCA0BC;AAUD,MAAa,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,IAAA,qBAAM,EAAC,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,kCAAgB,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,mCAAW,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,mCAAW,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,kCAAgB,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,mCAAW,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,uBAAQ,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,IAAA,qBAAM,EAAC,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,mCAAW,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,IAAA,qBAAM,EACF,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,mCAAW,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,kCAAkB,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,IAAA,qBAAM,EAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,IAAA,qBAAM,EAAC,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,IAAA,qBAAM,EAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AAnQL,kCAoQC;AAnQ0B,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"]}