@fluidframework/driver-web-cache 0.58.2000-58133

package/dist/scheduleIdleTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleIdleTask.d.ts","sourceRoot":"","sources":["../src/scheduleIdleTask.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,mBAAmB,EACjB,CAAC,CACC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;YAC7B,aAAa,EAAE,MAAM,MAAM,CAAC;SAC/B,KAAK,IAAI,EACV,IAAI,CAAC,EAAE;YACH,OAAO,EAAE,MAAM,CAAC;SACnB,KACA,MAAM,CAAC,GACV,SAAS,CAAC;QACZ,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;KAC9D;CACJ;AAaD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,QAMhD"}

package/dist/scheduleIdleTask.js

@@ -0,0 +1,80 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleIdleTask = void 0;
+// A set of tasks that still have to be run
+let taskQueue = [];
+// Set to true when we have a pending idle task scheduled
+let idleTaskScheduled = false;
+/**
+ * A function that schedules a non critical task to be run when the browser has cycles available
+ * @param task - The task to be executed
+ * @param options - Optional configuration for the task execution
+ */
+function scheduleIdleTask(task) {
+    taskQueue.push({
+        task,
+    });
+    ensureIdleCallback();
+}
+exports.scheduleIdleTask = scheduleIdleTask;
+/**
+ * Ensures an idle callback has been scheduled for the remaining tasks
+ */
+function ensureIdleCallback() {
+    if (!idleTaskScheduled) {
+        // Exception added when eslint rule was added, this should be revisited when modifying this code
+        if (window.requestIdleCallback) {
+            window.requestIdleCallback(idleTaskCallback);
+        }
+        else {
+            const deadline = Date.now() + 50;
+            window.setTimeout(() => idleTaskCallback({
+                timeRemaining: () => Math.max(deadline - Date.now(), 0),
+                didTimeout: false,
+            }), 0);
+        }
+        idleTaskScheduled = true;
+    }
+}
+/**
+ * Runs tasks from the task queue
+ * @param filter - An optional function that will be called for each task to see if it should run.
+ * Returns false for tasks that should not run. If omitted all tasks run.
+ * @param shouldContinueRunning - An optional function that will be called to determine if
+ * we have enough time to continue running tasks. If omitted, we don't stop running tasks.
+ */
+function runTasks(filter, shouldContinueRunning) {
+    // The next value for the task queue
+    const newTaskQueue = [];
+    for (let index = 0; index < taskQueue.length; index += 1) {
+        if (shouldContinueRunning && !shouldContinueRunning()) {
+            // Add the tasks we didn't get to to the end of the new task queue
+            newTaskQueue.push(...taskQueue.slice(index));
+            break;
+        }
+        const taskQueueItem = taskQueue[index];
+        if (filter && !filter(taskQueueItem)) {
+            newTaskQueue.push(taskQueueItem);
+        }
+        else {
+            taskQueueItem.task();
+        }
+    }
+    taskQueue = newTaskQueue;
+}
+// Runs all the tasks in the task queue
+function idleTaskCallback(deadline) {
+    // Minimum time that must be available on deadline to run any more tasks
+    const minTaskTime = 10;
+    runTasks(undefined, () => deadline.timeRemaining() > minTaskTime);
+    idleTaskScheduled = false;
+    // If we didn't run through the entire queue, schedule another idle callback
+    if (taskQueue.length > 0) {
+        ensureIdleCallback();
+    }
+}
+//# sourceMappingURL=scheduleIdleTask.js.map

package/dist/scheduleIdleTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleIdleTask.js","sourceRoot":"","sources":["../src/scheduleIdleTask.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA0BH,2CAA2C;AAC3C,IAAI,SAAS,GAAoB,EAAE,CAAC;AAEpC,yDAAyD;AACzD,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAgB;IAC7C,SAAS,CAAC,IAAI,CAAC;QACX,IAAI;KACP,CAAC,CAAC;IAEH,kBAAkB,EAAE,CAAC;AACzB,CAAC;AAND,4CAMC;AAED;;GAEG;AACH,SAAS,kBAAkB;IACvB,IAAI,CAAC,iBAAiB,EAAE;QACpB,gGAAgG;QAChG,IAAI,MAAM,CAAC,mBAAmB,EAAE;YAC5B,MAAM,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;SAChD;aAAM;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;YACjC,MAAM,CAAC,UAAU,CACb,GAAG,EAAE,CACD,gBAAgB,CAAC;gBACb,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACvD,UAAU,EAAE,KAAK;aACpB,CAAC,EACN,CAAC,CACJ,CAAC;SACL;QACD,iBAAiB,GAAG,IAAI,CAAC;KAC5B;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,QAAQ,CACb,MAAkD,EAClD,qBAAqC;IAErC,oCAAoC;IACpC,MAAM,YAAY,GAAoB,EAAE,CAAC;IAEzC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE;QACtD,IAAI,qBAAqB,IAAI,CAAC,qBAAqB,EAAE,EAAE;YACnD,kEAAkE;YAClE,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7C,MAAM;SACT;QAED,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvC,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;YAClC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpC;aAAM;YACH,aAAa,CAAC,IAAI,EAAE,CAAC;SACxB;KACJ;IAED,SAAS,GAAG,YAAY,CAAC;AAC7B,CAAC;AAED,uCAAuC;AACvC,SAAS,gBAAgB,CAAC,QAGzB;IACG,wEAAwE;IACxE,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,WAAW,CAAC,CAAC;IAClE,iBAAiB,GAAG,KAAK,CAAC;IAE1B,4EAA4E;IAC5E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,kBAAkB,EAAE,CAAC;KACxB;AACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Older versions of Typescript considered this API experimental and not in Typescript included types.\n// This can be removed when FF updates to Typescript 4.4 or later\ndeclare global {\n    interface Window {\n        requestIdleCallback:\n        | ((\n            callback: (deadline: {\n                readonly didTimeout: boolean;\n                timeRemaining: () => number;\n            }) => void,\n            opts?: {\n                timeout: number;\n            }\n        ) => number)\n        | undefined;\n        cancelIdleCallback: ((handle: number) => void) | undefined;\n    }\n}\n\ninterface TaskQueueItem {\n    /** The task to run */\n    task: () => void;\n}\n\n// A set of tasks that still have to be run\nlet taskQueue: TaskQueueItem[] = [];\n\n// Set to true when we have a pending idle task scheduled\nlet idleTaskScheduled = false;\n\n/**\n * A function that schedules a non critical task to be run when the browser has cycles available\n * @param task - The task to be executed\n * @param options - Optional configuration for the task execution\n */\nexport function scheduleIdleTask(task: () => void) {\n    taskQueue.push({\n        task,\n    });\n\n    ensureIdleCallback();\n}\n\n/**\n * Ensures an idle callback has been scheduled for the remaining tasks\n */\nfunction ensureIdleCallback() {\n    if (!idleTaskScheduled) {\n        // Exception added when eslint rule was added, this should be revisited when modifying this code\n        if (window.requestIdleCallback) {\n            window.requestIdleCallback(idleTaskCallback);\n        } else {\n            const deadline = Date.now() + 50;\n            window.setTimeout(\n                () =>\n                    idleTaskCallback({\n                        timeRemaining: () => Math.max(deadline - Date.now(), 0),\n                        didTimeout: false,\n                    }),\n                0,\n            );\n        }\n        idleTaskScheduled = true;\n    }\n}\n\n/**\n * Runs tasks from the task queue\n * @param filter - An optional function that will be called for each task to see if it should run.\n * Returns false for tasks that should not run. If omitted all tasks run.\n * @param shouldContinueRunning - An optional function that will be called to determine if\n * we have enough time to continue running tasks. If omitted, we don't stop running tasks.\n */\nfunction runTasks(\n    filter?: (taskQueueItem: TaskQueueItem) => boolean,\n    shouldContinueRunning?: () => boolean,\n) {\n    // The next value for the task queue\n    const newTaskQueue: TaskQueueItem[] = [];\n\n    for (let index = 0; index < taskQueue.length; index += 1) {\n        if (shouldContinueRunning && !shouldContinueRunning()) {\n            // Add the tasks we didn't get to to the end of the new task queue\n            newTaskQueue.push(...taskQueue.slice(index));\n            break;\n        }\n\n        const taskQueueItem = taskQueue[index];\n\n        if (filter && !filter(taskQueueItem)) {\n            newTaskQueue.push(taskQueueItem);\n        } else {\n            taskQueueItem.task();\n        }\n    }\n\n    taskQueue = newTaskQueue;\n}\n\n// Runs all the tasks in the task queue\nfunction idleTaskCallback(deadline: {\n    timeRemaining: () => number;\n    readonly didTimeout: boolean;\n}) {\n    // Minimum time that must be available on deadline to run any more tasks\n    const minTaskTime = 10;\n    runTasks(undefined, () => deadline.timeRemaining() > minTaskTime);\n    idleTaskScheduled = false;\n\n    // If we didn't run through the entire queue, schedule another idle callback\n    if (taskQueue.length > 0) {\n        ensureIdleCallback();\n    }\n}\n"]}

package/jest.config.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    roots: ["<rootDir>/dist"],
+    testEnvironment: "jsdom",
+    testMatch: ["**/?(*.)+(spec|test).[j]s"],
+    testPathIgnorePatterns: ["/node_modules/"],
+    verbose: true,
+};

package/lib/FluidCache.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IPersistedCache, ICacheEntry, IFileEntry } from "@fluidframework/odsp-driver-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+export interface FluidCacheConfig {
+    /**
+     * A string to specify what partition of the cache you wish to use (e.g. a user id).
+     * Null can be used to explicity indicate no partitioning, and has been chosen
+     * vs undefined so that it is clear this is an intentional choice by the caller.
+     * A null value should only be used when the host can ensure that the cache is not able
+     * to be shared with multiple users.
+     */
+    partitionKey: string | null;
+    /**
+     * A logger that can be used to get insight into cache performance and errors
+     */
+    logger?: ITelemetryBaseLogger;
+    /**
+     * A value in milliseconds that determines the maximum age of a cache entry to return.
+     * If an entry exists in the cache, but is older than this value, the cached value will not be returned.
+     */
+    maxCacheItemAge: number;
+}
+/**
+ * A cache that can be used by the Fluid ODSP driver to cache data for faster performance
+ */
+export declare class FluidCache implements IPersistedCache {
+    private readonly logger;
+    private readonly partitionKey;
+    private readonly maxCacheItemAge;
+    constructor(config: FluidCacheConfig);
+    removeEntries(file: IFileEntry): Promise<void>;
+    get(cacheEntry: ICacheEntry): Promise<any>;
+    private getItemFromCache;
+    put(entry: ICacheEntry, value: any): Promise<void>;
+}
+//# sourceMappingURL=FluidCache.d.ts.map

package/lib/FluidCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FluidCache.d.ts","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,eAAe,EACf,WAAW,EACX,UAAU,EACb,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACH,oBAAoB,EAEvB,MAAM,oCAAoC,CAAC;AAoB5C,MAAM,WAAW,gBAAgB;IAC7B;;;;;;OAMG;IAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,eAAe;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,MAAM,EAAE,gBAAgB;IAiEvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiBzC,gBAAgB;IAsEjB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CA8BlE"}

package/lib/FluidCache.js

@@ -0,0 +1,155 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ChildLogger } from "@fluidframework/telemetry-utils";
+import { scheduleIdleTask } from "./scheduleIdleTask";
+import { getFluidCacheIndexedDbInstance, FluidDriverObjectStoreName, getKeyForCacheEntry, } from "./FluidCacheIndexedDb";
+/**
+ * A cache that can be used by the Fluid ODSP driver to cache data for faster performance
+ */
+export class FluidCache {
+    constructor(config) {
+        this.logger = ChildLogger.create(config.logger);
+        this.partitionKey = config.partitionKey;
+        this.maxCacheItemAge = config.maxCacheItemAge;
+        scheduleIdleTask(async () => {
+            // Log how much storage space is currently being used by indexed db.
+            // NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.
+            // Exception added when eslint rule was added, this should be revisited when modifying this code
+            if (navigator.storage && navigator.storage.estimate) {
+                const estimate = await navigator.storage.estimate();
+                // Some browsers have a usageDetails property that will tell you
+                // more detailed information on how the storage is being used
+                let indexedDBSize;
+                if ("usageDetails" in estimate) {
+                    indexedDBSize = estimate
+                        .usageDetails.indexedDB;
+                }
+                this.logger.sendTelemetryEvent({
+                    eventName: "FluidCacheStorageInfo" /* FluidCacheStorageInfo */,
+                    subCategory: "FluidCache" /* FluidCache */,
+                    quota: estimate.quota,
+                    usage: estimate.usage,
+                    indexedDBSize,
+                });
+            }
+        });
+        scheduleIdleTask(async () => {
+            // Delete entries that have not been accessed recently to clean up space
+            try {
+                const db = await getFluidCacheIndexedDbInstance(this.logger);
+                const transaction = db.transaction(FluidDriverObjectStoreName, "readwrite");
+                const index = transaction.store.index("lastAccessTimeMs");
+                // Get items that have not been accessed in 4 weeks
+                const keysToDelete = await index.getAllKeys(IDBKeyRange.upperBound(new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000));
+                await Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));
+                await transaction.done;
+            }
+            catch (error) {
+                this.logger.sendErrorEvent({
+                    eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
+                }, error);
+            }
+        });
+    }
+    async removeEntries(file) {
+        try {
+            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            const transaction = db.transaction(FluidDriverObjectStoreName, "readwrite");
+            const index = transaction.store.index("fileId");
+            const keysToDelete = await index.getAllKeys(file.docId);
+            await Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));
+            await transaction.done;
+        }
+        catch (error) {
+            this.logger.sendErrorEvent({
+                eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
+            }, error);
+        }
+    }
+    async get(cacheEntry) {
+        const startTime = performance.now();
+        const cachedItem = await this.getItemFromCache(cacheEntry);
+        this.logger.sendPerformanceEvent({
+            eventName: "FluidCacheAccess",
+            cacheHit: cachedItem !== undefined,
+            type: cacheEntry.type,
+            duration: performance.now() - startTime,
+        });
+        // Value will contain metadata like the expiry time, we just want to return the object we were asked to cache
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return cachedItem === null || cachedItem === void 0 ? void 0 : cachedItem.cachedObject;
+    }
+    async getItemFromCache(cacheEntry) {
+        try {
+            const key = getKeyForCacheEntry(cacheEntry);
+            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            const value = await db.get(FluidDriverObjectStoreName, key);
+            if (!value) {
+                return undefined;
+            }
+            // If the data does not come from the same partition, don't return it
+            if (value.partitionKey !== this.partitionKey) {
+                this.logger.sendTelemetryEvent({
+                    eventName: "FluidCachePartitionKeyMismatch" /* FluidCachePartitionKeyMismatch */,
+                    subCategory: "FluidCache" /* FluidCache */,
+                });
+                return undefined;
+            }
+            const currentTime = new Date().getTime();
+            // If too much time has passed since this cache entry was used, we will also return undefined
+            if (currentTime - value.createdTimeMs > this.maxCacheItemAge) {
+                return undefined;
+            }
+            const transaction = db.transaction(FluidDriverObjectStoreName, "readwrite");
+            // We don't want to block the get return of this function on updating the last accessed time
+            // We catch this promise because there is no user bad if this is rejected.
+            transaction.store
+                .get(key)
+                .then(async (valueToUpdate) => {
+                // This value in the database could have been updated concurrently by other tabs/iframes
+                // since we first read it. Only update the last accessed time if the current value in the
+                // DB was the same one we returned.
+                if (valueToUpdate !== undefined &&
+                    valueToUpdate.createdTimeMs === value.createdTimeMs &&
+                    (valueToUpdate.lastAccessTimeMs === undefined ||
+                        valueToUpdate.lastAccessTimeMs < currentTime)) {
+                    await transaction.store.put(Object.assign(Object.assign({}, valueToUpdate), { lastAccessTimeMs: currentTime }), key);
+                }
+                await transaction.done;
+                db.close();
+            })
+                .catch(() => { });
+            return value;
+        }
+        catch (error) {
+            // We can fail to open the db for a variety of reasons,
+            // such as the database version having upgraded underneath us. Return undefined in this case
+            this.logger.sendErrorEvent({ eventName: "FluidCacheGetError" /* FluidCacheGetError */ }, error);
+            return undefined;
+        }
+    }
+    async put(entry, value) {
+        try {
+            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            const currentTime = new Date().getTime();
+            await db.put(FluidDriverObjectStoreName, {
+                cachedObject: value,
+                fileId: entry.file.docId,
+                type: entry.type,
+                cacheItemId: entry.key,
+                partitionKey: this.partitionKey,
+                createdTimeMs: currentTime,
+                lastAccessTimeMs: currentTime,
+            }, getKeyForCacheEntry(entry));
+            db.close();
+        }
+        catch (error) {
+            // We can fail to open the db for a variety of reasons,
+            // such as the database version having upgraded underneath us
+            this.logger.sendErrorEvent({ eventName: "FluidCachePutError" /* FluidCachePutError */ }, error);
+        }
+    }
+}
+//# sourceMappingURL=FluidCache.js.map

package/lib/FluidCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FluidCache.js","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EACH,8BAA8B,EAC9B,0BAA0B,EAC1B,mBAAmB,GACtB,MAAM,uBAAuB,CAAC;AAoC/B;;GAEG;AACH,MAAM,OAAO,UAAU;IAOnB,YAAY,MAAwB;QAChC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAE9C,gBAAgB,CAAC,KAAK,IAAI,EAAE;YACxB,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACjD,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAEpD,gEAAgE;gBAChE,6DAA6D;gBAC7D,IAAI,aAAiC,CAAC;gBACtC,IAAI,cAAc,IAAI,QAAQ,EAAE;oBAC5B,aAAa,GACR,QAAgB;yBACZ,YACR,CAAC,SAAS,CAAC;iBACf;gBAED,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,qDAA8C;oBACvD,WAAW,+BAAyC;oBACpD,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,aAAa;iBAChB,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;QAEH,gBAAgB,CAAC,KAAK,IAAI,EAAE;YACxB,wEAAwE;YACxE,IAAI;gBACA,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,0BAA0B,EAC1B,WAAW,CACd,CAAC;gBACF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,mDAAmD;gBACnD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CACvC,WAAW,CAAC,UAAU,CAClB,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CACrD,CACJ,CAAC;gBAEF,MAAM,OAAO,CAAC,GAAG,CACb,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAC3D,CAAC;gBACF,MAAM,WAAW,CAAC,IAAI,CAAC;aAC1B;YAAC,OAAO,KAAU,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,yEAC+C;iBAC3D,EACD,KAAK,CACR,CAAC;aACL;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QACvC,IAAI;YACA,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,0BAA0B,EAC1B,WAAW,CACd,CAAC;YACF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAEhD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAExD,MAAM,OAAO,CAAC,GAAG,CACb,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAC3D,CAAC;YACF,MAAM,WAAW,CAAC,IAAI,CAAC;SAC1B;QAAC,OAAO,KAAU,EAAE;YACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;gBACI,SAAS,yEAC+C;aAC3D,EACD,KAAK,CACR,CAAC;SACL;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAuB;QACpC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAEpC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,kBAAkB;YAC7B,QAAQ,EAAE,UAAU,KAAK,SAAS;YAClC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SAC1C,CAAC,CAAC;QAEH,6GAA6G;QAC7G,+DAA+D;QAC/D,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QAClD,IAAI;YACA,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAE5C,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YAE5D,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO,SAAS,CAAC;aACpB;YAED,qEAAqE;YACrE,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE;gBAC1C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,uEACgD;oBACzD,WAAW,+BAAyC;iBACvD,CAAC,CAAC;gBAEH,OAAO,SAAS,CAAC;aACpB;YAED,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,6FAA6F;YAC7F,IAAI,WAAW,GAAG,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,EAAE;gBAC1D,OAAO,SAAS,CAAC;aACpB;YAED,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,0BAA0B,EAC1B,WAAW,CACd,CAAC;YACF,4FAA4F;YAC5F,0EAA0E;YAC1E,WAAW,CAAC,KAAK;iBACZ,GAAG,CAAC,GAAG,CAAC;iBACR,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC1B,wFAAwF;gBACxF,yFAAyF;gBACzF,mCAAmC;gBACnC,IACI,aAAa,KAAK,SAAS;oBAC3B,aAAa,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;oBACnD,CAAC,aAAa,CAAC,gBAAgB,KAAK,SAAS;wBACzC,aAAa,CAAC,gBAAgB,GAAG,WAAW,CAAC,EACnD;oBACE,MAAM,WAAW,CAAC,KAAK,CAAC,GAAG,iCAClB,aAAa,KAAE,gBAAgB,EAAE,WAAW,KACjD,GAAG,CACN,CAAC;iBACL;gBACD,MAAM,WAAW,CAAC,IAAI,CAAC;gBAEvB,EAAE,CAAC,KAAK,EAAE,CAAC;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACtB,OAAO,KAAK,CAAC;SAChB;QAAC,OAAO,KAAU,EAAE;YACjB,uDAAuD;YACvD,4FAA4F;YAC5F,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACR,CAAC;YACF,OAAO,SAAS,CAAC;SACpB;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAkB,EAAE,KAAU;QAC3C,IAAI;YACA,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,EAAE,CAAC,GAAG,CACR,0BAA0B,EAC1B;gBACI,YAAY,EAAE,KAAK;gBACnB,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK;gBACxB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,WAAW,EAAE,KAAK,CAAC,GAAG;gBACtB,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,aAAa,EAAE,WAAW;gBAC1B,gBAAgB,EAAE,WAAW;aAChC,EACD,mBAAmB,CAAC,KAAK,CAAC,CAC7B,CAAC;YAEF,EAAE,CAAC,KAAK,EAAE,CAAC;SACd;QAAC,OAAO,KAAU,EAAE;YACjB,uDAAuD;YACvD,6DAA6D;YAC7D,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACR,CAAC;SACL;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IPersistedCache,\n    ICacheEntry,\n    IFileEntry,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport {\n    ITelemetryBaseLogger,\n    ITelemetryLogger,\n} from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { scheduleIdleTask } from \"./scheduleIdleTask\";\nimport {\n    getFluidCacheIndexedDbInstance,\n    FluidDriverObjectStoreName,\n    getKeyForCacheEntry,\n} from \"./FluidCacheIndexedDb\";\nimport {\n    FluidCacheErrorEvent,\n    FluidCacheEventSubCategories,\n    FluidCacheGenericEvent,\n} from \"./fluidCacheTelemetry\";\n\n// Some browsers have a usageDetails property that will tell you more detailed information\n// on how the storage is being used\ninterface StorageQuotaUsageDetails {\n    indexedDB: number | undefined;\n}\n\nexport interface FluidCacheConfig {\n    /**\n     * A string to specify what partition of the cache you wish to use (e.g. a user id).\n     * Null can be used to explicity indicate no partitioning, and has been chosen\n     * vs undefined so that it is clear this is an intentional choice by the caller.\n     * A null value should only be used when the host can ensure that the cache is not able\n     * to be shared with multiple users.\n     */\n    // eslint-disable-next-line @rushstack/no-new-null\n    partitionKey: string | null;\n\n    /**\n     * A logger that can be used to get insight into cache performance and errors\n     */\n    logger?: ITelemetryBaseLogger;\n\n    /**\n     * A value in milliseconds that determines the maximum age of a cache entry to return.\n     * If an entry exists in the cache, but is older than this value, the cached value will not be returned.\n     */\n    maxCacheItemAge: number;\n}\n\n/**\n * A cache that can be used by the Fluid ODSP driver to cache data for faster performance\n */\nexport class FluidCache implements IPersistedCache {\n    private readonly logger: ITelemetryLogger;\n\n    private readonly partitionKey: string | null;\n\n    private readonly maxCacheItemAge: number;\n\n    constructor(config: FluidCacheConfig) {\n        this.logger = ChildLogger.create(config.logger);\n        this.partitionKey = config.partitionKey;\n        this.maxCacheItemAge = config.maxCacheItemAge;\n\n        scheduleIdleTask(async () => {\n            // Log how much storage space is currently being used by indexed db.\n            // NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.\n            // Exception added when eslint rule was added, this should be revisited when modifying this code\n            if (navigator.storage && navigator.storage.estimate) {\n                const estimate = await navigator.storage.estimate();\n\n                // Some browsers have a usageDetails property that will tell you\n                // more detailed information on how the storage is being used\n                let indexedDBSize: number | undefined;\n                if (\"usageDetails\" in estimate) {\n                    indexedDBSize = (\n                        (estimate as any)\n                            .usageDetails as StorageQuotaUsageDetails\n                    ).indexedDB;\n                }\n\n                this.logger.sendTelemetryEvent({\n                    eventName: FluidCacheGenericEvent.FluidCacheStorageInfo,\n                    subCategory: FluidCacheEventSubCategories.FluidCache,\n                    quota: estimate.quota,\n                    usage: estimate.usage,\n                    indexedDBSize,\n                });\n            }\n        });\n\n        scheduleIdleTask(async () => {\n            // Delete entries that have not been accessed recently to clean up space\n            try {\n                const db = await getFluidCacheIndexedDbInstance(this.logger);\n\n                const transaction = db.transaction(\n                    FluidDriverObjectStoreName,\n                    \"readwrite\",\n                );\n                const index = transaction.store.index(\"lastAccessTimeMs\");\n                // Get items that have not been accessed in 4 weeks\n                const keysToDelete = await index.getAllKeys(\n                    IDBKeyRange.upperBound(\n                        new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000,\n                    ),\n                );\n\n                await Promise.all(\n                    keysToDelete.map((key) => transaction.store.delete(key)),\n                );\n                await transaction.done;\n            } catch (error: any) {\n                this.logger.sendErrorEvent(\n                    {\n                        eventName:\n                            FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n                    },\n                    error,\n                );\n            }\n        });\n    }\n\n    public async removeEntries(file: IFileEntry): Promise<void> {\n        try {\n            const db = await getFluidCacheIndexedDbInstance(this.logger);\n\n            const transaction = db.transaction(\n                FluidDriverObjectStoreName,\n                \"readwrite\",\n            );\n            const index = transaction.store.index(\"fileId\");\n\n            const keysToDelete = await index.getAllKeys(file.docId);\n\n            await Promise.all(\n                keysToDelete.map((key) => transaction.store.delete(key)),\n            );\n            await transaction.done;\n        } catch (error: any) {\n            this.logger.sendErrorEvent(\n                {\n                    eventName:\n                        FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n                },\n                error,\n            );\n        }\n    }\n\n    public async get(cacheEntry: ICacheEntry): Promise<any> {\n        const startTime = performance.now();\n\n        const cachedItem = await this.getItemFromCache(cacheEntry);\n\n        this.logger.sendPerformanceEvent({\n            eventName: \"FluidCacheAccess\",\n            cacheHit: cachedItem !== undefined,\n            type: cacheEntry.type,\n            duration: performance.now() - startTime,\n        });\n\n        // Value will contain metadata like the expiry time, we just want to return the object we were asked to cache\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return cachedItem?.cachedObject;\n    }\n\n    private async getItemFromCache(cacheEntry: ICacheEntry) {\n        try {\n            const key = getKeyForCacheEntry(cacheEntry);\n\n            const db = await getFluidCacheIndexedDbInstance(this.logger);\n\n            const value = await db.get(FluidDriverObjectStoreName, key);\n\n            if (!value) {\n                return undefined;\n            }\n\n            // If the data does not come from the same partition, don't return it\n            if (value.partitionKey !== this.partitionKey) {\n                this.logger.sendTelemetryEvent({\n                    eventName:\n                        FluidCacheGenericEvent.FluidCachePartitionKeyMismatch,\n                    subCategory: FluidCacheEventSubCategories.FluidCache,\n                });\n\n                return undefined;\n            }\n\n            const currentTime = new Date().getTime();\n\n            // If too much time has passed since this cache entry was used, we will also return undefined\n            if (currentTime - value.createdTimeMs > this.maxCacheItemAge) {\n                return undefined;\n            }\n\n            const transaction = db.transaction(\n                FluidDriverObjectStoreName,\n                \"readwrite\",\n            );\n            // We don't want to block the get return of this function on updating the last accessed time\n            // We catch this promise because there is no user bad if this is rejected.\n            transaction.store\n                .get(key)\n                .then(async (valueToUpdate) => {\n                    // This value in the database could have been updated concurrently by other tabs/iframes\n                    // since we first read it. Only update the last accessed time if the current value in the\n                    // DB was the same one we returned.\n                    if (\n                        valueToUpdate !== undefined &&\n                        valueToUpdate.createdTimeMs === value.createdTimeMs &&\n                        (valueToUpdate.lastAccessTimeMs === undefined ||\n                            valueToUpdate.lastAccessTimeMs < currentTime)\n                    ) {\n                        await transaction.store.put(\n                            { ...valueToUpdate, lastAccessTimeMs: currentTime },\n                            key,\n                        );\n                    }\n                    await transaction.done;\n\n                    db.close();\n                })\n                .catch(() => { });\n            return value;\n        } catch (error: any) {\n            // We can fail to open the db for a variety of reasons,\n            // such as the database version having upgraded underneath us. Return undefined in this case\n            this.logger.sendErrorEvent(\n                { eventName: FluidCacheErrorEvent.FluidCacheGetError },\n                error,\n            );\n            return undefined;\n        }\n    }\n\n    public async put(entry: ICacheEntry, value: any): Promise<void> {\n        try {\n            const db = await getFluidCacheIndexedDbInstance(this.logger);\n\n            const currentTime = new Date().getTime();\n\n            await db.put(\n                FluidDriverObjectStoreName,\n                {\n                    cachedObject: value,\n                    fileId: entry.file.docId,\n                    type: entry.type,\n                    cacheItemId: entry.key,\n                    partitionKey: this.partitionKey,\n                    createdTimeMs: currentTime,\n                    lastAccessTimeMs: currentTime,\n                },\n                getKeyForCacheEntry(entry),\n            );\n\n            db.close();\n        } catch (error: any) {\n            // We can fail to open the db for a variety of reasons,\n            // such as the database version having upgraded underneath us\n            this.logger.sendErrorEvent(\n                { eventName: FluidCacheErrorEvent.FluidCachePutError },\n                error,\n            );\n        }\n    }\n}\n"]}

package/lib/FluidCacheIndexedDb.d.ts

@@ -0,0 +1,65 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DBSchema, IDBPDatabase } from "idb";
+import { ICacheEntry } from "@fluidframework/odsp-driver-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+export declare const FluidDriverCacheDBName = "fluidDriverCache";
+export declare const FluidDriverObjectStoreName = "driverStorage.V3";
+export declare const CurrentCacheVersion = 3;
+export declare const oldVersionNameMapping: Partial<{
+    [key: number]: string;
+}>;
+export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
+export declare function getFluidCacheIndexedDbInstance(logger?: ITelemetryBaseLogger): Promise<IDBPDatabase<FluidCacheDBSchema>>;
+export declare function deleteFluidCacheIndexDbInstance(): Promise<void>;
+/**
+ * Schema for the object store used to cache driver information
+ */
+export interface FluidCacheDBSchema extends DBSchema {
+    [FluidDriverObjectStoreName]: {
+        /**
+         * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId
+         */
+        key: string;
+        value: {
+            /**
+             * The identifier of the file associated with the cache entry
+             */
+            fileId: string;
+            /**
+             * Describes the type of content being cached, such as snapshot
+             */
+            type: string;
+            /**
+             * Files may have multiple cached items associated with them,
+             * this property uniquely identifies a specific cache entry for a file.
+             * This is not globally unique, but rather a unique id for this file
+             */
+            cacheItemId: string;
+            cachedObject: any;
+            /**
+             * A string to specify what partition of the cache you wish to use (e.g. a user id).
+             * Null can be used to explicity indicate no partitioning.
+             */
+            partitionKey: string | null;
+            /**
+             * The time when the cache entry was put into the cache
+             */
+            createdTimeMs: number;
+            /**
+             * The last time the cache entry was used.
+             * This is initially set to the time the cache entry was created Measured as ms since unix epoch.
+             */
+            lastAccessTimeMs: number;
+        };
+        indexes: {
+            createdTimeMs: number;
+            partitionKey: string;
+            lastAccessTimeMs: number;
+            fileId: string;
+        };
+    };
+}
+//# sourceMappingURL=FluidCacheIndexedDb.d.ts.map

package/lib/FluidCacheIndexedDb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAU,QAAQ,EAAE,YAAY,EAAY,MAAM,KAAK,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAK1E,eAAO,MAAM,sBAAsB,qBAAqB,CAAC;AAGzD,eAAO,MAAM,0BAA0B,qBAAqB,CAAC;AAE7D,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAGrC,eAAO,MAAM,qBAAqB,EAAE,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAGpE,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,UAErD;AAED,wBAAgB,8BAA8B,CAC1C,MAAM,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAwD3C;AAID,wBAAgB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAChD,CAAC,0BAA0B,CAAC,EAAE;QAC1B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE;YACH;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;;;eAIG;YACH,WAAW,EAAE,MAAM,CAAC;YAKpB,YAAY,EAAE,GAAG,CAAC;YAElB;;;eAGG;YAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;;eAGG;YACH,gBAAgB,EAAE,MAAM,CAAC;SAC5B,CAAC;QAEF,OAAO,EAAE;YACL,aAAa,EAAE,MAAM,CAAC;YACtB,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;KACL,CAAC;CACL"}

package/lib/FluidCacheIndexedDb.js

@@ -0,0 +1,59 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { openDB, deleteDB } from "idb";
+import { ChildLogger } from "@fluidframework/telemetry-utils";
+// The name of the database that we use for caching Fluid info.
+export const FluidDriverCacheDBName = "fluidDriverCache";
+// The name of the object store within the indexed db instance that the driver will use to cache Fluid content.
+export const FluidDriverObjectStoreName = "driverStorage.V3";
+export const CurrentCacheVersion = 3;
+// Note that V1 and V2 were misspelled as "diver", and we need to keep using the misspelling here.
+export const oldVersionNameMapping = {
+    1: "diverStorage",
+    2: "diverStorage.V2",
+};
+export function getKeyForCacheEntry(entry) {
+    return `${entry.file.docId}_${entry.type}_${entry.key}`;
+}
+export function getFluidCacheIndexedDbInstance(logger) {
+    return new Promise((resolve, reject) => {
+        openDB(FluidDriverCacheDBName, CurrentCacheVersion, {
+            upgrade: (db, oldVersion) => {
+                try {
+                    // We changed the format of the object store, so we must
+                    // delete the old stores to create a new one in V3
+                    const cacheToDelete = oldVersionNameMapping[oldVersion];
+                    if (cacheToDelete) {
+                        // We don't include the old object stores in the schema, so we need to
+                        // use a typecast here to prevent IDB from complaining
+                        db.deleteObjectStore(cacheToDelete);
+                    }
+                }
+                catch (error) {
+                    // Catch any error done when attempting to delete the older version.
+                    // If the object does not exist db will throw.
+                    // We can now assume that the old version is no longer there regardless.
+                    ChildLogger.create(logger).sendErrorEvent({
+                        eventName: "FluidCacheDeleteOldDbError" /* FluidCacheDeleteOldDbError */,
+                    }, error);
+                }
+                const cacheObjectStore = db.createObjectStore(FluidDriverObjectStoreName);
+                cacheObjectStore.createIndex("createdTimeMs", "createdTimeMs");
+                cacheObjectStore.createIndex("lastAccessTimeMs", "lastAccessTimeMs");
+                cacheObjectStore.createIndex("partitionKey", "partitionKey");
+                cacheObjectStore.createIndex("fileId", "fileId");
+            },
+            blocked: () => {
+                reject(new Error("Could not open DB since it is blocked by an older client that has the DB open"));
+            },
+        }).then(resolve, reject);
+    });
+}
+// Deletes the indexed DB instance.
+// Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.
+export function deleteFluidCacheIndexDbInstance() {
+    return deleteDB(FluidDriverCacheDBName);
+}
+//# sourceMappingURL=FluidCacheIndexedDb.js.map

package/lib/FluidCacheIndexedDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAA0B,QAAQ,EAAE,MAAM,KAAK,CAAC;AAG/D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAG9D,+DAA+D;AAC/D,MAAM,CAAC,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAEzD,+GAA+G;AAC/G,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE7D,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC,kGAAkG;AAClG,MAAM,CAAC,MAAM,qBAAqB,GAAuC;IACrE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACvB,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,KAAkB;IAClD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC1C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,MAAM,CACF,sBAAsB,EACtB,mBAAmB,EACnB;YACI,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBACxB,IAAI;oBACA,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE;wBACf,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;qBAC9C;iBACJ;gBAAC,OAAO,KAAU,EAAE;oBACjB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CACrC;wBACI,SAAS,+DAC0C;qBACtD,EACD,KAAK,CACR,CAAC;iBACL;gBAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,iBAAiB,CACzC,0BAA0B,CAC7B,CAAC;gBACF,gBAAgB,CAAC,WAAW,CACxB,eAAe,EACf,eAAe,CAClB,CAAC;gBACF,gBAAgB,CAAC,WAAW,CACxB,kBAAkB,EAClB,kBAAkB,CACrB,CAAC;gBACF,gBAAgB,CAAC,WAAW,CACxB,cAAc,EACd,cAAc,CACjB,CAAC;gBACF,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACV,MAAM,CACF,IAAI,KAAK,CACL,+EAA+E,CAClF,CACJ,CAAC;YACN,CAAC;SACJ,CACJ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACP,CAAC;AAED,mCAAmC;AACnC,+FAA+F;AAC/F,MAAM,UAAU,+BAA+B;IAC3C,OAAO,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { openDB, DBSchema, IDBPDatabase, deleteDB } from \"idb\";\nimport { ICacheEntry } from \"@fluidframework/odsp-driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { FluidCacheErrorEvent } from \"./fluidCacheTelemetry\";\n\n// The name of the database that we use for caching Fluid info.\nexport const FluidDriverCacheDBName = \"fluidDriverCache\";\n\n// The name of the object store within the indexed db instance that the driver will use to cache Fluid content.\nexport const FluidDriverObjectStoreName = \"driverStorage.V3\";\n\nexport const CurrentCacheVersion = 3;\n\n// Note that V1 and V2 were misspelled as \"diver\", and we need to keep using the misspelling here.\nexport const oldVersionNameMapping: Partial<{ [key: number]: string }> = {\n    1: \"diverStorage\",\n    2: \"diverStorage.V2\",\n};\n\nexport function getKeyForCacheEntry(entry: ICacheEntry) {\n    return `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n\nexport function getFluidCacheIndexedDbInstance(\n    logger?: ITelemetryBaseLogger,\n): Promise<IDBPDatabase<FluidCacheDBSchema>> {\n    return new Promise((resolve, reject) => {\n        openDB<FluidCacheDBSchema>(\n            FluidDriverCacheDBName,\n            CurrentCacheVersion,\n            {\n                upgrade: (db, oldVersion) => {\n                    try {\n                        // We changed the format of the object store, so we must\n                        // delete the old stores to create a new one in V3\n                        const cacheToDelete = oldVersionNameMapping[oldVersion];\n                        if (cacheToDelete) {\n                            // We don't include the old object stores in the schema, so we need to\n                            // use a typecast here to prevent IDB from complaining\n                            db.deleteObjectStore(cacheToDelete as any);\n                        }\n                    } catch (error: any) {\n                        // Catch any error done when attempting to delete the older version.\n                        // If the object does not exist db will throw.\n                        // We can now assume that the old version is no longer there regardless.\n                        ChildLogger.create(logger).sendErrorEvent(\n                            {\n                                eventName:\n                                    FluidCacheErrorEvent.FluidCacheDeleteOldDbError,\n                            },\n                            error,\n                        );\n                    }\n\n                    const cacheObjectStore = db.createObjectStore(\n                        FluidDriverObjectStoreName,\n                    );\n                    cacheObjectStore.createIndex(\n                        \"createdTimeMs\",\n                        \"createdTimeMs\",\n                    );\n                    cacheObjectStore.createIndex(\n                        \"lastAccessTimeMs\",\n                        \"lastAccessTimeMs\",\n                    );\n                    cacheObjectStore.createIndex(\n                        \"partitionKey\",\n                        \"partitionKey\",\n                    );\n                    cacheObjectStore.createIndex(\"fileId\", \"fileId\");\n                },\n                blocked: () => {\n                    reject(\n                        new Error(\n                            \"Could not open DB since it is blocked by an older client that has the DB open\",\n                        ),\n                    );\n                },\n            },\n        ).then(resolve, reject);\n    });\n}\n\n// Deletes the indexed DB instance.\n// Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.\nexport function deleteFluidCacheIndexDbInstance(): Promise<void> {\n    return deleteDB(FluidDriverCacheDBName);\n}\n\n/**\n * Schema for the object store used to cache driver information\n */\nexport interface FluidCacheDBSchema extends DBSchema {\n    [FluidDriverObjectStoreName]: {\n        /**\n         * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId\n         */\n        key: string;\n\n        value: {\n            /**\n             * The identifier of the file associated with the cache entry\n             */\n            fileId: string;\n\n            /**\n             * Describes the type of content being cached, such as snapshot\n             */\n            type: string;\n\n            /**\n             * Files may have multiple cached items associated with them,\n             * this property uniquely identifies a specific cache entry for a file.\n             * This is not globally unique, but rather a unique id for this file\n             */\n            cacheItemId: string;\n\n            /*\n             * Opaque object that the driver asks us to store in a cache for performance reasons\n             */\n            cachedObject: any;\n\n            /**\n             * A string to specify what partition of the cache you wish to use (e.g. a user id).\n             * Null can be used to explicity indicate no partitioning.\n             */\n            // eslint-disable-next-line @rushstack/no-new-null\n            partitionKey: string | null;\n\n            /**\n             * The time when the cache entry was put into the cache\n             */\n            createdTimeMs: number;\n\n            /**\n             * The last time the cache entry was used.\n             * This is initially set to the time the cache entry was created Measured as ms since unix epoch.\n             */\n            lastAccessTimeMs: number;\n        };\n\n        indexes: {\n            createdTimeMs: number;\n            partitionKey: string;\n            lastAccessTimeMs: number;\n            fileId: string;\n        };\n    };\n}\n"]}

package/lib/fluidCacheTelemetry.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export declare const enum FluidCacheGenericEvent {
+    "FluidCacheStorageInfo" = "FluidCacheStorageInfo",
+    "FluidCachePartitionKeyMismatch" = "FluidCachePartitionKeyMismatch"
+}
+export declare const enum FluidCacheErrorEvent {
+    "FluidCacheDeleteOldEntriesError" = "FluidCacheDeleteOldEntriesError",
+    "FluidCacheGetError" = "FluidCacheGetError",
+    "FluidCachePutError" = "FluidCachePutError",
+    "FluidCacheUpdateUsageError" = "FluidCacheUpdateUsageError",
+    "FluidCacheDeleteOldDbError" = "FluidCacheDeleteOldDbError"
+}
+export declare const enum FluidCacheEventSubCategories {
+    "FluidCache" = "FluidCache"
+}
+//# sourceMappingURL=fluidCacheTelemetry.d.ts.map

package/lib/fluidCacheTelemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidCacheTelemetry.d.ts","sourceRoot":"","sources":["../src/fluidCacheTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,0BAAkB,sBAAsB;IACpC,uBAAuB,0BAA0B;IACjD,gCAAgC,mCAAmC;CACtE;AAED,0BAAkB,oBAAoB;IAClC,iCAAiC,oCAAoC;IACrE,oBAAoB,uBAAuB;IAC3C,oBAAoB,uBAAuB;IAC3C,4BAA4B,+BAA+B;IAC3D,4BAA4B,+BAA+B;CAC9D;AAED,0BAAkB,4BAA4B;IAC1C,YAAY,eAAe;CAC9B"}

package/lib/fluidCacheTelemetry.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=fluidCacheTelemetry.js.map

package/lib/fluidCacheTelemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluidCacheTelemetry.js","sourceRoot":"","sources":["../src/fluidCacheTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport const enum FluidCacheGenericEvent {\n    \"FluidCacheStorageInfo\" = \"FluidCacheStorageInfo\",\n    \"FluidCachePartitionKeyMismatch\" = \"FluidCachePartitionKeyMismatch\",\n}\n\nexport const enum FluidCacheErrorEvent {\n    \"FluidCacheDeleteOldEntriesError\" = \"FluidCacheDeleteOldEntriesError\",\n    \"FluidCacheGetError\" = \"FluidCacheGetError\",\n    \"FluidCachePutError\" = \"FluidCachePutError\",\n    \"FluidCacheUpdateUsageError\" = \"FluidCacheUpdateUsageError\",\n    \"FluidCacheDeleteOldDbError\" = \"FluidCacheDeleteOldDbError\",\n}\n\nexport const enum FluidCacheEventSubCategories {\n    \"FluidCache\" = \"FluidCache\",\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./FluidCache";
+export { deleteFluidCacheIndexDbInstance } from "./FluidCacheIndexedDb";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC"}

package/lib/index.js

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./FluidCache";
+export { deleteFluidCacheIndexDbInstance } from "./FluidCacheIndexedDb";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./FluidCache\";\nexport { deleteFluidCacheIndexDbInstance } from \"./FluidCacheIndexedDb\";\n"]}

package/lib/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export declare const pkgName = "@fluidframework/driver-web-cache";
+export declare const pkgVersion = "0.58.2000-58133";
+//# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,oBAAoB,CAAC"}

package/lib/packageVersion.js

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export const pkgName = "@fluidframework/driver-web-cache";
+export const pkgVersion = "0.58.2000-58133";
+//# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-web-cache\";\nexport const pkgVersion = \"0.58.2000-58133\";\n"]}

package/lib/scheduleIdleTask.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+declare global {
+    interface Window {
+        requestIdleCallback: ((callback: (deadline: {
+            readonly didTimeout: boolean;
+            timeRemaining: () => number;
+        }) => void, opts?: {
+            timeout: number;
+        }) => number) | undefined;
+        cancelIdleCallback: ((handle: number) => void) | undefined;
+    }
+}
+/**
+ * A function that schedules a non critical task to be run when the browser has cycles available
+ * @param task - The task to be executed
+ * @param options - Optional configuration for the task execution
+ */
+export declare function scheduleIdleTask(task: () => void): void;
+//# sourceMappingURL=scheduleIdleTask.d.ts.map

package/lib/scheduleIdleTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleIdleTask.d.ts","sourceRoot":"","sources":["../src/scheduleIdleTask.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,mBAAmB,EACjB,CAAC,CACC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;YAC7B,aAAa,EAAE,MAAM,MAAM,CAAC;SAC/B,KAAK,IAAI,EACV,IAAI,CAAC,EAAE;YACH,OAAO,EAAE,MAAM,CAAC;SACnB,KACA,MAAM,CAAC,GACV,SAAS,CAAC;QACZ,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;KAC9D;CACJ;AAaD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,QAMhD"}