@fluidframework/container-runtime 2.0.0-internal.4.3.0 → 2.0.0-internal.4.4.0

package/lib/gc/gcSweepReadyUsageDetection.d.ts

@@ -1,53 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryProperties } from "@fluidframework/common-definitions";
-import { ICriticalContainerError } from "@fluidframework/container-definitions";
-import { IFluidErrorBase, LoggingError, MonitoringContext } from "@fluidframework/telemetry-utils";
-/**
- * Feature Gate Key -
- * How many days between closing the container from this error (avoids locking user out of their file altogether)
- */
-export declare const skipClosureForXDaysKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays";
-/**
- * LocalStorage key (NOT via feature gate / monitoring context)
- * A map from docId to info about the last time we closed due to this error
- */
-export declare const closuresMapLocalStorageKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures";
-/**
- * Error class raised when a SweepReady object is used, indicating a bug in how
- * references are managed in the container by the application, or a bug in how
- * GC tracks those references.
- *
- * There's a chance for false positives when this error is raised by an Interactive Container,
- * since only the Summarizer has the latest truth about unreferenced node tracking
- */
-export declare class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {
-    /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */
-    errorType: string;
-}
-/**
- * This class encapsulates the logic around what to do when a SweepReady object is used.
- * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:
- * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation
- * (via sweepReadyUsageDetectionSetting above)
- * - Throttling the frequency of these crashes via a "Skip Closure Period" per container per device
- * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)
- */
-export declare class SweepReadyUsageDetectionHandler {
-    private readonly uniqueContainerKey;
-    private readonly mc;
-    private readonly closeFn;
-    private readonly localStorage;
-    constructor(uniqueContainerKey: string, mc: MonitoringContext, closeFn: (error?: ICriticalContainerError) => void, localStorageOverride?: Pick<Storage, "getItem" | "setItem">);
-    /**
-     * If SweepReady Usage Detection is enabled, close the interactive container.
-     * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.
-     *
-     * Once Sweep is fully implemented, this will be removed since the objects will be gone
-     * and errors will arise elsewhere in the runtime
-     */
-    usageDetectedInInteractiveClient(errorProps: ITelemetryProperties): void;
-}
-//# sourceMappingURL=gcSweepReadyUsageDetection.d.ts.map

package/lib/gc/gcSweepReadyUsageDetection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"gcSweepReadyUsageDetection.d.ts","sourceRoot":"","sources":["../../src/gc/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAEN,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,MAAM,iCAAiC,CAAC;AAGzC;;;GAGG;AACH,eAAO,MAAM,sBAAsB,iFAC4C,CAAC;AAEhF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,sEAC6B,CAAC;AAqBrE;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,YAAa,YAAW,eAAe;IAChF,oHAAoH;IAC7G,SAAS,EAAE,MAAM,CAAiD;CACzE;AAED;;;;;;;GAOG;AACH,qBAAa,+BAA+B;IAI1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO;IALzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuC;gBAGlD,kBAAkB,EAAE,MAAM,EAC1B,EAAE,EAAE,iBAAiB,EACrB,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,EACnE,oBAAoB,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAc5D;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAU,EAAE,oBAAoB;CA+CxE"}

package/lib/gc/gcSweepReadyUsageDetection.js

@@ -1,125 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { LoggingError, } from "@fluidframework/telemetry-utils";
-import { oneDayMs } from "./gcDefinitions";
-/**
- * Feature Gate Key -
- * How many days between closing the container from this error (avoids locking user out of their file altogether)
- */
-export const skipClosureForXDaysKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays";
-/**
- * LocalStorage key (NOT via feature gate / monitoring context)
- * A map from docId to info about the last time we closed due to this error
- */
-export const closuresMapLocalStorageKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures";
-/**
- * Feature gate key to enable closing the container if SweepReady objects are used.
- * Value should contain keywords "interactiveClient" and/or "summarizer" to enable detection in each container type
- */
-const sweepReadyUsageDetectionSetting = {
-    read(config) {
-        const sweepReadyUsageDetectionKey = "Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection";
-        const value = config.getString(sweepReadyUsageDetectionKey);
-        if (value === undefined) {
-            return { interactiveClient: false, summarizer: false };
-        }
-        return {
-            interactiveClient: value.includes("interactiveClient"),
-            summarizer: value.includes("summarizer"),
-        };
-    },
-};
-/**
- * Error class raised when a SweepReady object is used, indicating a bug in how
- * references are managed in the container by the application, or a bug in how
- * GC tracks those references.
- *
- * There's a chance for false positives when this error is raised by an Interactive Container,
- * since only the Summarizer has the latest truth about unreferenced node tracking
- */
-export class SweepReadyUsageError extends LoggingError {
-    constructor() {
-        super(...arguments);
-        /** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */
-        this.errorType = "unreferencedObjectUsedAfterGarbageCollected";
-    }
-}
-/**
- * This class encapsulates the logic around what to do when a SweepReady object is used.
- * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:
- * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation
- * (via sweepReadyUsageDetectionSetting above)
- * - Throttling the frequency of these crashes via a "Skip Closure Period" per container per device
- * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)
- */
-export class SweepReadyUsageDetectionHandler {
-    constructor(uniqueContainerKey, mc, closeFn, localStorageOverride) {
-        var _a;
-        this.uniqueContainerKey = uniqueContainerKey;
-        this.mc = mc;
-        this.closeFn = closeFn;
-        const noopStorage = { getItem: () => null, setItem: () => { } };
-        // localStorage is not defined in Node environment, so fall back to noopStorage if needed.
-        this.localStorage = (_a = localStorageOverride !== null && localStorageOverride !== void 0 ? localStorageOverride : globalThis.localStorage) !== null && _a !== void 0 ? _a : noopStorage;
-        if (this.localStorage === noopStorage) {
-            // This means the Skip Closure Period logic will not work.
-            this.mc.logger.sendTelemetryEvent({
-                eventName: "SweepReadyUsageDetectionHandlerNoopStorage",
-            });
-        }
-    }
-    /**
-     * If SweepReady Usage Detection is enabled, close the interactive container.
-     * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.
-     *
-     * Once Sweep is fully implemented, this will be removed since the objects will be gone
-     * and errors will arise elsewhere in the runtime
-     */
-    usageDetectedInInteractiveClient(errorProps) {
-        var _a;
-        if (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {
-            return;
-        }
-        // Default stance is we close every time - this reflects the severity of SweepReady Object Usage.
-        // However, we may choose to "throttle" the closures by setting the SkipClosureForXDays setting,
-        // which will only allow the container to close once during that period, to avoid locking users out.
-        let shouldClose = true;
-        let pastClosuresMap = {};
-        let lastCloseTime;
-        const skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);
-        if (skipClosureForXDays !== undefined) {
-            // Read pastClosuresMap from localStorage then extract the lastCloseTime from the map
-            try {
-                const rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);
-                const parsedValue = rawValue === null ? {} : JSON.parse(rawValue);
-                if (typeof parsedValue === "object") {
-                    pastClosuresMap = parsedValue;
-                }
-            }
-            catch (e) { }
-            lastCloseTime = (_a = pastClosuresMap[this.uniqueContainerKey]) === null || _a === void 0 ? void 0 : _a.lastCloseTime;
-            // Don't close if we did already within the Skip Closure Period
-            if (lastCloseTime !== undefined &&
-                Date.now() < lastCloseTime + skipClosureForXDays * oneDayMs) {
-                shouldClose = false;
-            }
-        }
-        const error = new SweepReadyUsageError("SweepReady object used in Non-Summarizer Client", {
-            errorDetails: JSON.stringify(Object.assign(Object.assign({}, errorProps), { lastCloseTime, skipClosureForXDays })),
-        });
-        if (shouldClose) {
-            // Update closures map in localStorage before closing
-            // Note there is a race condition between different tabs updating localStorage and overwriting
-            // each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck
-            pastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };
-            this.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));
-            this.closeFn(error);
-        }
-        else {
-            this.mc.logger.sendErrorEvent({ eventName: "SweepReadyObject_UsageAllowed" }, error);
-        }
-    }
-}
-//# sourceMappingURL=gcSweepReadyUsageDetection.js.map

package/lib/gc/gcSweepReadyUsageDetection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"gcSweepReadyUsageDetection.js","sourceRoot":"","sources":["../../src/gc/gcSweepReadyUsageDetection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAGN,YAAY,GAEZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAClC,8EAA8E,CAAC;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GACtC,mEAAmE,CAAC;AAErE;;;GAGG;AACH,MAAM,+BAA+B,GAAG;IACvC,IAAI,CAAC,MAAuB;QAC3B,MAAM,2BAA2B,GAChC,0DAA0D,CAAC;QAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;SACvD;QACD,OAAO;YACN,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YACtD,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;SACxC,CAAC;IACH,CAAC;CACD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAAtD;;QACC,oHAAoH;QAC7G,cAAS,GAAW,6CAA6C,CAAC;IAC1E,CAAC;CAAA;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,+BAA+B;IAG3C,YACkB,kBAA0B,EAC1B,EAAqB,EACrB,OAAkD,EACnE,oBAA2D;;QAH1C,uBAAkB,GAAlB,kBAAkB,CAAQ;QAC1B,OAAE,GAAF,EAAE,CAAmB;QACrB,YAAO,GAAP,OAAO,CAA2C;QAGnE,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC;QAC/D,0FAA0F;QAC1F,IAAI,CAAC,YAAY,GAAG,MAAA,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,UAAU,CAAC,YAAY,mCAAI,WAAW,CAAC;QAEnF,IAAI,IAAI,CAAC,YAAY,KAAK,WAAW,EAAE;YACtC,0DAA0D;YAC1D,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,4CAA4C;aACvD,CAAC,CAAC;SACH;IACF,CAAC;IAED;;;;;;OAMG;IACI,gCAAgC,CAAC,UAAgC;;QACvE,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE;YAC5E,OAAO;SACP;QAED,iGAAiG;QACjG,gGAAgG;QAChG,oGAAoG;QACpG,IAAI,WAAW,GAAY,IAAI,CAAC;QAChC,IAAI,eAAe,GAA0D,EAAE,CAAC;QAChF,IAAI,aAAiC,CAAC;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAC7E,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACtC,qFAAqF;YACrF,IAAI;gBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;gBACvE,MAAM,WAAW,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAClE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;oBACpC,eAAe,GAAG,WAAW,CAAC;iBAC9B;aACD;YAAC,OAAO,CAAC,EAAE,GAAE;YACd,aAAa,GAAG,MAAA,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,0CAAE,aAAa,CAAC;YAExE,+DAA+D;YAC/D,IACC,aAAa,KAAK,SAAS;gBAC3B,IAAI,CAAC,GAAG,EAAE,GAAG,aAAa,GAAG,mBAAmB,GAAG,QAAQ,EAC1D;gBACD,WAAW,GAAG,KAAK,CAAC;aACpB;SACD;QAED,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAAC,iDAAiD,EAAE;YACzF,YAAY,EAAE,IAAI,CAAC,SAAS,iCAAM,UAAU,KAAE,aAAa,EAAE,mBAAmB,IAAG;SACnF,CAAC,CAAC;QACH,IAAI,WAAW,EAAE;YAChB,qDAAqD;YACrD,8FAA8F;YAC9F,mGAAmG;YACnG,eAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACpB;aAAM;YACN,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,+BAA+B,EAAE,EAAE,KAAK,CAAC,CAAC;SACrF;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport {\n\tIConfigProvider,\n\tIFluidErrorBase,\n\tLoggingError,\n\tMonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { oneDayMs } from \"./gcDefinitions\";\n\n/**\n * Feature Gate Key -\n * How many days between closing the container from this error (avoids locking user out of their file altogether)\n */\nexport const skipClosureForXDaysKey =\n\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays\";\n\n/**\n * LocalStorage key (NOT via feature gate / monitoring context)\n * A map from docId to info about the last time we closed due to this error\n */\nexport const closuresMapLocalStorageKey =\n\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures\";\n\n/**\n * Feature gate key to enable closing the container if SweepReady objects are used.\n * Value should contain keywords \"interactiveClient\" and/or \"summarizer\" to enable detection in each container type\n */\nconst sweepReadyUsageDetectionSetting = {\n\tread(config: IConfigProvider) {\n\t\tconst sweepReadyUsageDetectionKey =\n\t\t\t\"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection\";\n\t\tconst value = config.getString(sweepReadyUsageDetectionKey);\n\t\tif (value === undefined) {\n\t\t\treturn { interactiveClient: false, summarizer: false };\n\t\t}\n\t\treturn {\n\t\t\tinteractiveClient: value.includes(\"interactiveClient\"),\n\t\t\tsummarizer: value.includes(\"summarizer\"),\n\t\t};\n\t},\n};\n\n/**\n * Error class raised when a SweepReady object is used, indicating a bug in how\n * references are managed in the container by the application, or a bug in how\n * GC tracks those references.\n *\n * There's a chance for false positives when this error is raised by an Interactive Container,\n * since only the Summarizer has the latest truth about unreferenced node tracking\n */\nexport class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {\n\t/** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */\n\tpublic errorType: string = \"unreferencedObjectUsedAfterGarbageCollected\";\n}\n\n/**\n * This class encapsulates the logic around what to do when a SweepReady object is used.\n * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:\n * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation\n * (via sweepReadyUsageDetectionSetting above)\n * - Throttling the frequency of these crashes via a \"Skip Closure Period\" per container per device\n * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)\n */\nexport class SweepReadyUsageDetectionHandler {\n\tprivate readonly localStorage: Pick<Storage, \"getItem\" | \"setItem\">;\n\n\tconstructor(\n\t\tprivate readonly uniqueContainerKey: string,\n\t\tprivate readonly mc: MonitoringContext,\n\t\tprivate readonly closeFn: (error?: ICriticalContainerError) => void,\n\t\tlocalStorageOverride?: Pick<Storage, \"getItem\" | \"setItem\">,\n\t) {\n\t\tconst noopStorage = { getItem: () => null, setItem: () => {} };\n\t\t// localStorage is not defined in Node environment, so fall back to noopStorage if needed.\n\t\tthis.localStorage = localStorageOverride ?? globalThis.localStorage ?? noopStorage;\n\n\t\tif (this.localStorage === noopStorage) {\n\t\t\t// This means the Skip Closure Period logic will not work.\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"SweepReadyUsageDetectionHandlerNoopStorage\",\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * If SweepReady Usage Detection is enabled, close the interactive container.\n\t * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.\n\t *\n\t * Once Sweep is fully implemented, this will be removed since the objects will be gone\n\t * and errors will arise elsewhere in the runtime\n\t */\n\tpublic usageDetectedInInteractiveClient(errorProps: ITelemetryProperties) {\n\t\tif (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Default stance is we close every time - this reflects the severity of SweepReady Object Usage.\n\t\t// However, we may choose to \"throttle\" the closures by setting the SkipClosureForXDays setting,\n\t\t// which will only allow the container to close once during that period, to avoid locking users out.\n\t\tlet shouldClose: boolean = true;\n\t\tlet pastClosuresMap: Record<string, { lastCloseTime: number } | undefined> = {};\n\t\tlet lastCloseTime: number | undefined;\n\t\tconst skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);\n\t\tif (skipClosureForXDays !== undefined) {\n\t\t\t// Read pastClosuresMap from localStorage then extract the lastCloseTime from the map\n\t\t\ttry {\n\t\t\t\tconst rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);\n\t\t\t\tconst parsedValue = rawValue === null ? {} : JSON.parse(rawValue);\n\t\t\t\tif (typeof parsedValue === \"object\") {\n\t\t\t\t\tpastClosuresMap = parsedValue;\n\t\t\t\t}\n\t\t\t} catch (e) {}\n\t\t\tlastCloseTime = pastClosuresMap[this.uniqueContainerKey]?.lastCloseTime;\n\n\t\t\t// Don't close if we did already within the Skip Closure Period\n\t\t\tif (\n\t\t\t\tlastCloseTime !== undefined &&\n\t\t\t\tDate.now() < lastCloseTime + skipClosureForXDays * oneDayMs\n\t\t\t) {\n\t\t\t\tshouldClose = false;\n\t\t\t}\n\t\t}\n\n\t\tconst error = new SweepReadyUsageError(\"SweepReady object used in Non-Summarizer Client\", {\n\t\t\terrorDetails: JSON.stringify({ ...errorProps, lastCloseTime, skipClosureForXDays }),\n\t\t});\n\t\tif (shouldClose) {\n\t\t\t// Update closures map in localStorage before closing\n\t\t\t// Note there is a race condition between different tabs updating localStorage and overwriting\n\t\t\t// each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck\n\t\t\tpastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };\n\t\t\tthis.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));\n\n\t\t\tthis.closeFn(error);\n\t\t} else {\n\t\t\tthis.mc.logger.sendErrorEvent({ eventName: \"SweepReadyObject_UsageAllowed\" }, error);\n\t\t}\n\t}\n}\n"]}

package/src/gc/gcSweepReadyUsageDetection.ts

@@ -1,145 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { ITelemetryProperties } from "@fluidframework/common-definitions";
-import { ICriticalContainerError } from "@fluidframework/container-definitions";
-import {
-	IConfigProvider,
-	IFluidErrorBase,
-	LoggingError,
-	MonitoringContext,
-} from "@fluidframework/telemetry-utils";
-import { oneDayMs } from "./gcDefinitions";
-
-/**
- * Feature Gate Key -
- * How many days between closing the container from this error (avoids locking user out of their file altogether)
- */
-export const skipClosureForXDaysKey =
-	"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.SkipClosureForXDays";
-
-/**
- * LocalStorage key (NOT via feature gate / monitoring context)
- * A map from docId to info about the last time we closed due to this error
- */
-export const closuresMapLocalStorageKey =
-	"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection.Closures";
-
-/**
- * Feature gate key to enable closing the container if SweepReady objects are used.
- * Value should contain keywords "interactiveClient" and/or "summarizer" to enable detection in each container type
- */
-const sweepReadyUsageDetectionSetting = {
-	read(config: IConfigProvider) {
-		const sweepReadyUsageDetectionKey =
-			"Fluid.GarbageCollection.Dogfood.SweepReadyUsageDetection";
-		const value = config.getString(sweepReadyUsageDetectionKey);
-		if (value === undefined) {
-			return { interactiveClient: false, summarizer: false };
-		}
-		return {
-			interactiveClient: value.includes("interactiveClient"),
-			summarizer: value.includes("summarizer"),
-		};
-	},
-};
-
-/**
- * Error class raised when a SweepReady object is used, indicating a bug in how
- * references are managed in the container by the application, or a bug in how
- * GC tracks those references.
- *
- * There's a chance for false positives when this error is raised by an Interactive Container,
- * since only the Summarizer has the latest truth about unreferenced node tracking
- */
-export class SweepReadyUsageError extends LoggingError implements IFluidErrorBase {
-	/** This errorType will be in temporary use (until Sweep is fully implemented) so don't add to any errorType type */
-	public errorType: string = "unreferencedObjectUsedAfterGarbageCollected";
-}
-
-/**
- * This class encapsulates the logic around what to do when a SweepReady object is used.
- * There are several tactics we plan to use in Dogfood environments to aid diagnosis of these cases:
- * - Closing the interactive container when either the interactive or summarizer client detects this kind of violation
- * (via sweepReadyUsageDetectionSetting above)
- * - Throttling the frequency of these crashes via a "Skip Closure Period" per container per device
- * (via skipClosureForXDaysKey above.  Uses localStorage and closuresMapLocalStorageKey to implement this behavior)
- */
-export class SweepReadyUsageDetectionHandler {
-	private readonly localStorage: Pick<Storage, "getItem" | "setItem">;
-
-	constructor(
-		private readonly uniqueContainerKey: string,
-		private readonly mc: MonitoringContext,
-		private readonly closeFn: (error?: ICriticalContainerError) => void,
-		localStorageOverride?: Pick<Storage, "getItem" | "setItem">,
-	) {
-		const noopStorage = { getItem: () => null, setItem: () => {} };
-		// localStorage is not defined in Node environment, so fall back to noopStorage if needed.
-		this.localStorage = localStorageOverride ?? globalThis.localStorage ?? noopStorage;
-
-		if (this.localStorage === noopStorage) {
-			// This means the Skip Closure Period logic will not work.
-			this.mc.logger.sendTelemetryEvent({
-				eventName: "SweepReadyUsageDetectionHandlerNoopStorage",
-			});
-		}
-	}
-
-	/**
-	 * If SweepReady Usage Detection is enabled, close the interactive container.
-	 * If the SkipClosureForXDays setting is set, don't close the container more than once in that period.
-	 *
-	 * Once Sweep is fully implemented, this will be removed since the objects will be gone
-	 * and errors will arise elsewhere in the runtime
-	 */
-	public usageDetectedInInteractiveClient(errorProps: ITelemetryProperties) {
-		if (!sweepReadyUsageDetectionSetting.read(this.mc.config).interactiveClient) {
-			return;
-		}
-
-		// Default stance is we close every time - this reflects the severity of SweepReady Object Usage.
-		// However, we may choose to "throttle" the closures by setting the SkipClosureForXDays setting,
-		// which will only allow the container to close once during that period, to avoid locking users out.
-		let shouldClose: boolean = true;
-		let pastClosuresMap: Record<string, { lastCloseTime: number } | undefined> = {};
-		let lastCloseTime: number | undefined;
-		const skipClosureForXDays = this.mc.config.getNumber(skipClosureForXDaysKey);
-		if (skipClosureForXDays !== undefined) {
-			// Read pastClosuresMap from localStorage then extract the lastCloseTime from the map
-			try {
-				const rawValue = this.localStorage.getItem(closuresMapLocalStorageKey);
-				const parsedValue = rawValue === null ? {} : JSON.parse(rawValue);
-				if (typeof parsedValue === "object") {
-					pastClosuresMap = parsedValue;
-				}
-			} catch (e) {}
-			lastCloseTime = pastClosuresMap[this.uniqueContainerKey]?.lastCloseTime;
-
-			// Don't close if we did already within the Skip Closure Period
-			if (
-				lastCloseTime !== undefined &&
-				Date.now() < lastCloseTime + skipClosureForXDays * oneDayMs
-			) {
-				shouldClose = false;
-			}
-		}
-
-		const error = new SweepReadyUsageError("SweepReady object used in Non-Summarizer Client", {
-			errorDetails: JSON.stringify({ ...errorProps, lastCloseTime, skipClosureForXDays }),
-		});
-		if (shouldClose) {
-			// Update closures map in localStorage before closing
-			// Note there is a race condition between different tabs updating localStorage and overwriting
-			// each others' updates. If so, some tab will crash again. Just reload one at a time to get unstuck
-			pastClosuresMap[this.uniqueContainerKey] = { lastCloseTime: Date.now() };
-			this.localStorage.setItem(closuresMapLocalStorageKey, JSON.stringify(pastClosuresMap));
-
-			this.closeFn(error);
-		} else {
-			this.mc.logger.sendErrorEvent({ eventName: "SweepReadyObject_UsageAllowed" }, error);
-		}
-	}
-}