@fluidframework/container-runtime 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

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/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

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

package/dist/garbageCollectionTombstoneUtils.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryGenericEvent } from "@fluidframework/common-definitions";
-import { MonitoringContext } from "@fluidframework/telemetry-utils";
-/**
- * Consolidates info / logic for logging when we encounter a Tombstone
- */
-export declare function sendGCTombstoneEvent(mc: MonitoringContext, event: ITelemetryGenericEvent & {
-    category: "error" | "generic";
-    isSummarizerClient: boolean;
-}, packagePath: readonly string[] | undefined, error?: unknown): void;
-//# sourceMappingURL=garbageCollectionTombstoneUtils.d.ts.map

package/dist/garbageCollectionTombstoneUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"garbageCollectionTombstoneUtils.d.ts","sourceRoot":"","sources":["../src/garbageCollectionTombstoneUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAGpE;;GAEG;AACH,wBAAgB,oBAAoB,CAChC,EAAE,EAAE,iBAAiB,EACrB,KAAK,EAAE,sBAAsB,GAAG;IAAE,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,kBAAkB,EAAE,OAAO,CAAA;CAAE,EAC9F,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAC1C,KAAK,CAAC,EAAE,OAAO,QAUlB"}

package/dist/garbageCollectionTombstoneUtils.js

@@ -1,23 +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.sendGCTombstoneEvent = void 0;
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
-const garbageCollectionConstants_1 = require("./garbageCollectionConstants");
-/**
- * Consolidates info / logic for logging when we encounter a Tombstone
- */
-function sendGCTombstoneEvent(mc, event, packagePath, error) {
-    event.pkg = (0, runtime_utils_1.packagePathToTelemetryProperty)(packagePath);
-    event.tombstoneFlags = JSON.stringify({
-        DisableTombstone: mc.config.getBoolean(garbageCollectionConstants_1.disableTombstoneKey),
-        ThrowOnTombstoneUsage: mc.config.getBoolean(garbageCollectionConstants_1.throwOnTombstoneUsageKey),
-        ThrowOnTombstoneLoad: mc.config.getBoolean(garbageCollectionConstants_1.throwOnTombstoneLoadKey),
-    });
-    mc.logger.sendTelemetryEvent(event, error);
-}
-exports.sendGCTombstoneEvent = sendGCTombstoneEvent;
-//# sourceMappingURL=garbageCollectionTombstoneUtils.js.map

package/dist/garbageCollectionTombstoneUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"garbageCollectionTombstoneUtils.js","sourceRoot":"","sources":["../src/garbageCollectionTombstoneUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iEAA+E;AAE/E,6EAAsH;AAEtH;;GAEG;AACH,SAAgB,oBAAoB,CAChC,EAAqB,EACrB,KAA8F,EAC9F,WAA0C,EAC1C,KAAe;IAEf,KAAK,CAAC,GAAG,GAAG,IAAA,8CAA8B,EAAC,WAAW,CAAC,CAAC;IACxD,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,gBAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,gDAAmB,CAAC;QAC3D,qBAAqB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,qDAAwB,CAAC;QACrE,oBAAoB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,oDAAuB,CAAC;KACtE,CAAC,CAAC;IAEH,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAdD,oDAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryGenericEvent } from \"@fluidframework/common-definitions\";\nimport { packagePathToTelemetryProperty } from \"@fluidframework/runtime-utils\";\nimport { MonitoringContext } from \"@fluidframework/telemetry-utils\";\nimport { disableTombstoneKey, throwOnTombstoneLoadKey, throwOnTombstoneUsageKey } from \"./garbageCollectionConstants\";\n\n/**\n * Consolidates info / logic for logging when we encounter a Tombstone\n */\nexport function sendGCTombstoneEvent(\n    mc: MonitoringContext,\n    event: ITelemetryGenericEvent & { category: \"error\" | \"generic\", isSummarizerClient: boolean },\n    packagePath: readonly string[] | undefined,\n    error?: unknown,\n) {\n    event.pkg = packagePathToTelemetryProperty(packagePath);\n    event.tombstoneFlags = JSON.stringify({\n        DisableTombstone: mc.config.getBoolean(disableTombstoneKey),\n        ThrowOnTombstoneUsage: mc.config.getBoolean(throwOnTombstoneUsageKey),\n        ThrowOnTombstoneLoad: mc.config.getBoolean(throwOnTombstoneLoadKey),\n    });\n\n    mc.logger.sendTelemetryEvent(event, error);\n}\n"]}

package/lib/garbageCollectionTombstoneUtils.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryGenericEvent } from "@fluidframework/common-definitions";
-import { MonitoringContext } from "@fluidframework/telemetry-utils";
-/**
- * Consolidates info / logic for logging when we encounter a Tombstone
- */
-export declare function sendGCTombstoneEvent(mc: MonitoringContext, event: ITelemetryGenericEvent & {
-    category: "error" | "generic";
-    isSummarizerClient: boolean;
-}, packagePath: readonly string[] | undefined, error?: unknown): void;
-//# sourceMappingURL=garbageCollectionTombstoneUtils.d.ts.map

package/lib/garbageCollectionTombstoneUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"garbageCollectionTombstoneUtils.d.ts","sourceRoot":"","sources":["../src/garbageCollectionTombstoneUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAGpE;;GAEG;AACH,wBAAgB,oBAAoB,CAChC,EAAE,EAAE,iBAAiB,EACrB,KAAK,EAAE,sBAAsB,GAAG;IAAE,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,kBAAkB,EAAE,OAAO,CAAA;CAAE,EAC9F,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAC1C,KAAK,CAAC,EAAE,OAAO,QAUlB"}

package/lib/garbageCollectionTombstoneUtils.js

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { packagePathToTelemetryProperty } from "@fluidframework/runtime-utils";
-import { disableTombstoneKey, throwOnTombstoneLoadKey, throwOnTombstoneUsageKey } from "./garbageCollectionConstants";
-/**
- * Consolidates info / logic for logging when we encounter a Tombstone
- */
-export function sendGCTombstoneEvent(mc, event, packagePath, error) {
-    event.pkg = packagePathToTelemetryProperty(packagePath);
-    event.tombstoneFlags = JSON.stringify({
-        DisableTombstone: mc.config.getBoolean(disableTombstoneKey),
-        ThrowOnTombstoneUsage: mc.config.getBoolean(throwOnTombstoneUsageKey),
-        ThrowOnTombstoneLoad: mc.config.getBoolean(throwOnTombstoneLoadKey),
-    });
-    mc.logger.sendTelemetryEvent(event, error);
-}
-//# sourceMappingURL=garbageCollectionTombstoneUtils.js.map

package/lib/garbageCollectionTombstoneUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"garbageCollectionTombstoneUtils.js","sourceRoot":"","sources":["../src/garbageCollectionTombstoneUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAEtH;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAChC,EAAqB,EACrB,KAA8F,EAC9F,WAA0C,EAC1C,KAAe;IAEf,KAAK,CAAC,GAAG,GAAG,8BAA8B,CAAC,WAAW,CAAC,CAAC;IACxD,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;QAClC,gBAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC;QAC3D,qBAAqB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC;QACrE,oBAAoB,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC;KACtE,CAAC,CAAC;IAEH,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryGenericEvent } from \"@fluidframework/common-definitions\";\nimport { packagePathToTelemetryProperty } from \"@fluidframework/runtime-utils\";\nimport { MonitoringContext } from \"@fluidframework/telemetry-utils\";\nimport { disableTombstoneKey, throwOnTombstoneLoadKey, throwOnTombstoneUsageKey } from \"./garbageCollectionConstants\";\n\n/**\n * Consolidates info / logic for logging when we encounter a Tombstone\n */\nexport function sendGCTombstoneEvent(\n    mc: MonitoringContext,\n    event: ITelemetryGenericEvent & { category: \"error\" | \"generic\", isSummarizerClient: boolean },\n    packagePath: readonly string[] | undefined,\n    error?: unknown,\n) {\n    event.pkg = packagePathToTelemetryProperty(packagePath);\n    event.tombstoneFlags = JSON.stringify({\n        DisableTombstone: mc.config.getBoolean(disableTombstoneKey),\n        ThrowOnTombstoneUsage: mc.config.getBoolean(throwOnTombstoneUsageKey),\n        ThrowOnTombstoneLoad: mc.config.getBoolean(throwOnTombstoneLoadKey),\n    });\n\n    mc.logger.sendTelemetryEvent(event, error);\n}\n"]}

package/src/garbageCollectionTombstoneUtils.ts

@@ -1,28 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { ITelemetryGenericEvent } from "@fluidframework/common-definitions";
-import { packagePathToTelemetryProperty } from "@fluidframework/runtime-utils";
-import { MonitoringContext } from "@fluidframework/telemetry-utils";
-import { disableTombstoneKey, throwOnTombstoneLoadKey, throwOnTombstoneUsageKey } from "./garbageCollectionConstants";
-
-/**
- * Consolidates info / logic for logging when we encounter a Tombstone
- */
-export function sendGCTombstoneEvent(
-    mc: MonitoringContext,
-    event: ITelemetryGenericEvent & { category: "error" | "generic", isSummarizerClient: boolean },
-    packagePath: readonly string[] | undefined,
-    error?: unknown,
-) {
-    event.pkg = packagePathToTelemetryProperty(packagePath);
-    event.tombstoneFlags = JSON.stringify({
-        DisableTombstone: mc.config.getBoolean(disableTombstoneKey),
-        ThrowOnTombstoneUsage: mc.config.getBoolean(throwOnTombstoneUsageKey),
-        ThrowOnTombstoneLoad: mc.config.getBoolean(throwOnTombstoneLoadKey),
-    });
-
-    mc.logger.sendTelemetryEvent(event, error);
-}