@fluidframework/driver-web-cache 2.0.0-internal.3.0.2 → 2.0.0-internal.3.0.3

package/dist/FluidCache.d.ts

@@ -1,7 +1,3 @@
-/*!
- * 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 {

package/dist/FluidCache.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"FluidCache.d.ts","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAqB5F,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;IAkEvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiB5C,gBAAgB;IA8EjB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAiC/D"}

package/dist/FluidCache.js

@@ -1,8 +1,4 @@
 "use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FluidCache = void 0;
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
@@ -40,9 +36,10 @@ class FluidCache {
             }
         });
         (0, scheduleIdleTask_1.scheduleIdleTask)(async () => {
+            let db;
             // Delete entries that have not been accessed recently to clean up space
             try {
-                const db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
+                db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
                 const transaction = db.transaction(FluidCacheIndexedDb_1.FluidDriverObjectStoreName, "readwrite");
                 const index = transaction.store.index("lastAccessTimeMs");
                 // Get items that have not been accessed in 4 weeks
@@ -55,11 +52,15 @@ class FluidCache {
                     eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
                 }, error);
             }
+            finally {
+                db === null || db === void 0 ? void 0 : db.close();
+            }
         });
     }
     async removeEntries(file) {
+        let db;
         try {
-            const db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
+            db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
             const transaction = db.transaction(FluidCacheIndexedDb_1.FluidDriverObjectStoreName, "readwrite");
             const index = transaction.store.index("fileId");
             const keysToDelete = await index.getAllKeys(file.docId);
@@ -71,6 +72,9 @@ class FluidCache {
                 eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
             }, error);
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
     async get(cacheEntry) {
         const startTime = performance.now();
@@ -86,11 +90,13 @@ class FluidCache {
         return cachedItem === null || cachedItem === void 0 ? void 0 : cachedItem.cachedObject;
     }
     async getItemFromCache(cacheEntry) {
+        let db;
         try {
             const key = (0, FluidCacheIndexedDb_1.getKeyForCacheEntry)(cacheEntry);
-            const db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
+            db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
             const value = await db.get(FluidCacheIndexedDb_1.FluidDriverObjectStoreName, key);
             if (!value) {
+                db.close();
                 return undefined;
             }
             // If the data does not come from the same partition, don't return it
@@ -99,11 +105,13 @@ class FluidCache {
                     eventName: "FluidCachePartitionKeyMismatch" /* FluidCachePartitionKeyMismatch */,
                     subCategory: "FluidCache" /* FluidCache */,
                 });
+                db.close();
                 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) {
+                db.close();
                 return undefined;
             }
             const transaction = db.transaction(FluidCacheIndexedDb_1.FluidDriverObjectStoreName, "readwrite");
@@ -122,9 +130,11 @@ class FluidCache {
                     await transaction.store.put(Object.assign(Object.assign({}, valueToUpdate), { lastAccessTimeMs: currentTime }), key);
                 }
                 await transaction.done;
-                db.close();
+                db === null || db === void 0 ? void 0 : db.close();
             })
-                .catch(() => { });
+                .catch(() => {
+                db === null || db === void 0 ? void 0 : db.close();
+            });
             return value;
         }
         catch (error) {
@@ -133,10 +143,14 @@ class FluidCache {
             this.logger.sendErrorEvent({ eventName: "FluidCacheGetError" /* FluidCacheGetError */ }, error);
             return undefined;
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
     async put(entry, value) {
+        let db;
         try {
-            const db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
+            db = await (0, FluidCacheIndexedDb_1.getFluidCacheIndexedDbInstance)(this.logger);
             const currentTime = new Date().getTime();
             await db.put(FluidCacheIndexedDb_1.FluidDriverObjectStoreName, {
                 cachedObject: value,
@@ -154,6 +168,9 @@ class FluidCache {
             // such as the database version having upgraded underneath us
             this.logger.sendErrorEvent({ eventName: "FluidCachePutError" /* FluidCachePutError */ }, error);
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
 }
 exports.FluidCache = FluidCache;

package/dist/FluidCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"FluidCache.js","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAWH,qEAA8D;AAC9D,yDAAsD;AACtD,+DAI+B;AAoC/B;;GAEG;AACH,MAAa,UAAU;IAOnB,YAAY,MAAwB;QAChC,IAAI,CAAC,MAAM,GAAG,6BAAW,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,IAAA,mCAAgB,EAAC,KAAK,IAAI,EAAE;;YACxB,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAC7B,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,IAAA,mCAAgB,EAAC,KAAK,IAAI,EAAE;YACxB,wEAAwE;YACxE,IAAI;gBACA,MAAM,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,gDAA0B,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,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,gDAA0B,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,IAAA,yCAAmB,EAAC,UAAU,CAAC,CAAC;YAE5C,MAAM,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,gDAA0B,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,gDAA0B,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,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,EAAE,CAAC,GAAG,CACR,gDAA0B,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,IAAA,yCAAmB,EAAC,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;AAxND,gCAwNC","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?.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"]}
+{"version":3,"file":"FluidCache.js","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":";;;AAOA,qEAA8D;AAC9D,yDAAsD;AACtD,+DAK+B;AAoC/B;;GAEG;AACH,MAAa,UAAU;IAOnB,YAAY,MAAwB;QAChC,IAAI,CAAC,MAAM,GAAG,6BAAW,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,IAAA,mCAAgB,EAAC,KAAK,IAAI,EAAE;;YACxB,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAC7B,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;QAET,IAAA,mCAAgB,EAAC,KAAK,IAAI,EAAE;YAC3B,IAAI,EAAgD,CAAC;YAErD,wEAAwE;YACxE,IAAI;gBACH,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE3C,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,gDAA0B,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,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC5E,MAAM,WAAW,CAAC,IAAI,CAAC;aAC1B;YAAC,OAAO,KAAU,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,yEAAsD;iBAClE,EACD,KAAK,CACR,CAAC;aACL;oBAAS;gBACN,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QACvC,IAAI,EAAgD,CAAC;QACrD,IAAI;YACA,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,gDAA0B,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;YAEjE,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5E,MAAM,WAAW,CAAC,IAAI,CAAC;SACvB;QAAC,OAAO,KAAU,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;gBACC,SAAS,yEAAsD;aAC/D,EACD,KAAK,CACL,CAAC;SACF;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;IAES,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;IAEI,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,MAAM,GAAG,GAAG,IAAA,yCAAmB,EAAC,UAAU,CAAC,CAAC;YAEnC,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,gDAA0B,EAAE,GAAG,CAAC,CAAC;YAErE,IAAI,CAAC,KAAK,EAAE;gBACX,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,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;gBAEf,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAElD,6FAA6F;YAC7F,IAAI,WAAW,GAAG,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,EAAE;gBAC7D,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAC9B,gDAA0B,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;gBAEtC,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;YACb,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACX,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;YACb,CAAC,CAAC,CAAC;YACJ,OAAO,KAAK,CAAC;SACb;QAAC,OAAO,KAAU,EAAE;YACpB,uDAAuD;YACvD,4FAA4F;YAC5F,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACL,CAAC;YACF,OAAO,SAAS,CAAC;SACjB;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAkB,EAAE,KAAU;QAC9C,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE9C,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,EAAE,CAAC,GAAG,CACR,gDAA0B,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,IAAA,yCAAmB,EAAC,KAAK,CAAC,CAC7B,CAAC;YAEX,EAAE,CAAC,KAAK,EAAE,CAAC;SACX;QAAC,OAAO,KAAU,EAAE;YACpB,uDAAuD;YACvD,6DAA6D;YAC7D,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACL,CAAC;SACF;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;CACD;AApOD,gCAoOC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDBPDatabase } from \"idb\";\nimport { IPersistedCache, ICacheEntry, IFileEntry } from \"@fluidframework/odsp-driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { scheduleIdleTask } from \"./scheduleIdleTask\";\nimport {\n\tgetFluidCacheIndexedDbInstance,\n\tFluidCacheDBSchema,\n\tFluidDriverObjectStoreName,\n\tgetKeyForCacheEntry,\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?.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\t\tscheduleIdleTask(async () => {\n\t\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\n\t\t\t// Delete entries that have not been accessed recently to clean up space\n\t\t\ttry {\n\t\t\t\tdb = 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(keysToDelete.map((key) => transaction.store.delete(key)));\n                await transaction.done;\n            } catch (error: any) {\n                this.logger.sendErrorEvent(\n                    {\n                        eventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n                    },\n                    error,\n                );\n            } finally {\n                db?.close();\n            }\n        });\n    }\n\n    public async removeEntries(file: IFileEntry): Promise<void> {\n        let db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n        try {\n            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\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\tawait transaction.done;\n\t\t} catch (error: any) {\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{\n\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t},\n\t\t\t\terror,\n\t\t\t);\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\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\tprivate async getItemFromCache(cacheEntry: ICacheEntry) {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tconst key = getKeyForCacheEntry(cacheEntry);\n\n            db = await getFluidCacheIndexedDbInstance(this.logger);\n\n            const value = await db.get(FluidDriverObjectStoreName, key);\n\n\t\t\tif (!value) {\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\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\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\n\n            const currentTime = new Date().getTime();\n\n\t\t\t// If too much time has passed since this cache entry was used, we will also return undefined\n\t\t\tif (currentTime - value.createdTimeMs > this.maxCacheItemAge) {\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\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\t\t\t\t\tdb?.close();\n\t\t\t\t})\n\t\t\t\t.catch(() => {\n\t\t\t\t\tdb?.close();\n\t\t\t\t});\n\t\t\treturn value;\n\t\t} catch (error: any) {\n\t\t\t// We can fail to open the db for a variety of reasons,\n\t\t\t// such as the database version having upgraded underneath us. Return undefined in this case\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{ eventName: FluidCacheErrorEvent.FluidCacheGetError },\n\t\t\t\terror,\n\t\t\t);\n\t\t\treturn undefined;\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\n\n\tpublic async put(entry: ICacheEntry, value: any): Promise<void> {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tdb = 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\t\t\tdb.close();\n\t\t} catch (error: any) {\n\t\t\t// We can fail to open the db for a variety of reasons,\n\t\t\t// such as the database version having upgraded underneath us\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{ eventName: FluidCacheErrorEvent.FluidCachePutError },\n\t\t\t\terror,\n\t\t\t);\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\n}\n"]}

package/dist/FluidCacheIndexedDb.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { DBSchema, IDBPDatabase } from "idb";
+import { DBSchema, DeleteDBCallbacks, IDBPDatabase } from "idb";
 import { ICacheEntry } from "@fluidframework/odsp-driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 export declare const FluidDriverCacheDBName = "fluidDriverCache";
@@ -13,7 +13,7 @@ export declare const oldVersionNameMapping: Partial<{
 }>;
 export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
 export declare function getFluidCacheIndexedDbInstance(logger?: ITelemetryBaseLogger): Promise<IDBPDatabase<FluidCacheDBSchema>>;
-export declare function deleteFluidCacheIndexDbInstance(): Promise<void>;
+export declare function deleteFluidCacheIndexDbInstance(deleteDBCallbacks?: DeleteDBCallbacks): Promise<void>;
 /**
  * Schema for the object store used to cache driver information
  */

package/dist/FluidCacheIndexedDb.d.ts.map

@@ -1 +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,CAAC;CAAE,CAGrE,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"}
+{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAU,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAY,MAAM,KAAK,CAAC;AAClF,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,CAAC;CAAE,CAGrE,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,CAC9C,iBAAiB,CAAC,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAEf;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/dist/FluidCacheIndexedDb.js

@@ -58,8 +58,8 @@ function getFluidCacheIndexedDbInstance(logger) {
 exports.getFluidCacheIndexedDbInstance = getFluidCacheIndexedDbInstance;
 // Deletes the indexed DB instance.
 // Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.
-function deleteFluidCacheIndexDbInstance() {
-    return (0, idb_1.deleteDB)(exports.FluidDriverCacheDBName);
+function deleteFluidCacheIndexDbInstance(deleteDBCallbacks) {
+    return (0, idb_1.deleteDB)(exports.FluidDriverCacheDBName, deleteDBCallbacks);
 }
 exports.deleteFluidCacheIndexDbInstance = deleteFluidCacheIndexDbInstance;
 //# sourceMappingURL=FluidCacheIndexedDb.js.map

package/dist/FluidCacheIndexedDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAA+D;AAG/D,qEAA8D;AAG9D,+DAA+D;AAClD,QAAA,sBAAsB,GAAG,kBAAkB,CAAC;AAEzD,+GAA+G;AAClG,QAAA,0BAA0B,GAAG,kBAAkB,CAAC;AAEhD,QAAA,mBAAmB,GAAG,CAAC,CAAC;AAErC,kGAAkG;AACrF,QAAA,qBAAqB,GAAwC;IACtE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACvB,CAAC;AAEF,SAAgB,mBAAmB,CAAC,KAAkB;IAClD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AAC5D,CAAC;AAFD,kDAEC;AAED,SAAgB,8BAA8B,CAC1C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAA,YAAM,EACF,8BAAsB,EACtB,2BAAmB,EACnB;YACI,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBACxB,IAAI;oBACA,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,6BAAqB,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,6BAAW,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,kCAA0B,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;AA1DD,wEA0DC;AAED,mCAAmC;AACnC,+FAA+F;AAC/F,SAAgB,+BAA+B;IAC3C,OAAO,IAAA,cAAQ,EAAC,8BAAsB,CAAC,CAAC;AAC5C,CAAC;AAFD,0EAEC","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"]}
+{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6BAAkF;AAGlF,qEAA8D;AAG9D,+DAA+D;AAClD,QAAA,sBAAsB,GAAG,kBAAkB,CAAC;AAEzD,+GAA+G;AAClG,QAAA,0BAA0B,GAAG,kBAAkB,CAAC;AAEhD,QAAA,mBAAmB,GAAG,CAAC,CAAC;AAErC,kGAAkG;AACrF,QAAA,qBAAqB,GAAwC;IACtE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACvB,CAAC;AAEF,SAAgB,mBAAmB,CAAC,KAAkB;IAClD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AAC5D,CAAC;AAFD,kDAEC;AAED,SAAgB,8BAA8B,CAC1C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAA,YAAM,EACF,8BAAsB,EACtB,2BAAmB,EACnB;YACI,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBACxB,IAAI;oBACA,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,6BAAqB,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,6BAAW,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,kCAA0B,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;AA1DD,wEA0DC;AAED,mCAAmC;AACnC,+FAA+F;AAC/F,SAAgB,+BAA+B,CAC9C,iBAAqC;IAErC,OAAO,IAAA,cAAQ,EAAC,8BAAsB,EAAE,iBAAiB,CAAC,CAAC;AAC5D,CAAC;AAJD,0EAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { openDB, DBSchema, DeleteDBCallbacks, 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(\n\tdeleteDBCallbacks?: DeleteDBCallbacks,\n): Promise<void> {\n\treturn deleteDB(FluidDriverCacheDBName, deleteDBCallbacks);\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/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-web-cache";
-export declare const pkgVersion = "2.0.0-internal.3.0.2";
+export declare const pkgVersion = "2.0.0-internal.3.0.3";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/driver-web-cache";
-exports.pkgVersion = "2.0.0-internal.3.0.2";
+exports.pkgVersion = "2.0.0-internal.3.0.3";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,sBAAsB,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 = \"2.0.0-internal.3.0.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,sBAAsB,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 = \"2.0.0-internal.3.0.3\";\n"]}

package/lib/FluidCache.d.ts

@@ -1,7 +1,3 @@
-/*!
- * 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 {

package/lib/FluidCache.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"FluidCache.d.ts","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAqB5F,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;IAkEvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiB5C,gBAAgB;IA8EjB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAiC/D"}

package/lib/FluidCache.js

@@ -1,7 +1,3 @@
-/*!
- * 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";
@@ -37,9 +33,10 @@ export class FluidCache {
             }
         });
         scheduleIdleTask(async () => {
+            let db;
             // Delete entries that have not been accessed recently to clean up space
             try {
-                const db = await getFluidCacheIndexedDbInstance(this.logger);
+                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
@@ -52,11 +49,15 @@ export class FluidCache {
                     eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
                 }, error);
             }
+            finally {
+                db === null || db === void 0 ? void 0 : db.close();
+            }
         });
     }
     async removeEntries(file) {
+        let db;
         try {
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            db = await getFluidCacheIndexedDbInstance(this.logger);
             const transaction = db.transaction(FluidDriverObjectStoreName, "readwrite");
             const index = transaction.store.index("fileId");
             const keysToDelete = await index.getAllKeys(file.docId);
@@ -68,6 +69,9 @@ export class FluidCache {
                 eventName: "FluidCacheDeleteOldEntriesError" /* FluidCacheDeleteOldEntriesError */,
             }, error);
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
     async get(cacheEntry) {
         const startTime = performance.now();
@@ -83,11 +87,13 @@ export class FluidCache {
         return cachedItem === null || cachedItem === void 0 ? void 0 : cachedItem.cachedObject;
     }
     async getItemFromCache(cacheEntry) {
+        let db;
         try {
             const key = getKeyForCacheEntry(cacheEntry);
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            db = await getFluidCacheIndexedDbInstance(this.logger);
             const value = await db.get(FluidDriverObjectStoreName, key);
             if (!value) {
+                db.close();
                 return undefined;
             }
             // If the data does not come from the same partition, don't return it
@@ -96,11 +102,13 @@ export class FluidCache {
                     eventName: "FluidCachePartitionKeyMismatch" /* FluidCachePartitionKeyMismatch */,
                     subCategory: "FluidCache" /* FluidCache */,
                 });
+                db.close();
                 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) {
+                db.close();
                 return undefined;
             }
             const transaction = db.transaction(FluidDriverObjectStoreName, "readwrite");
@@ -119,9 +127,11 @@ export class FluidCache {
                     await transaction.store.put(Object.assign(Object.assign({}, valueToUpdate), { lastAccessTimeMs: currentTime }), key);
                 }
                 await transaction.done;
-                db.close();
+                db === null || db === void 0 ? void 0 : db.close();
             })
-                .catch(() => { });
+                .catch(() => {
+                db === null || db === void 0 ? void 0 : db.close();
+            });
             return value;
         }
         catch (error) {
@@ -130,10 +140,14 @@ export class FluidCache {
             this.logger.sendErrorEvent({ eventName: "FluidCacheGetError" /* FluidCacheGetError */ }, error);
             return undefined;
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
     async put(entry, value) {
+        let db;
         try {
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            db = await getFluidCacheIndexedDbInstance(this.logger);
             const currentTime = new Date().getTime();
             await db.put(FluidDriverObjectStoreName, {
                 cachedObject: value,
@@ -151,6 +165,9 @@ export class FluidCache {
             // such as the database version having upgraded underneath us
             this.logger.sendErrorEvent({ eventName: "FluidCachePutError" /* FluidCachePutError */ }, error);
         }
+        finally {
+            db === null || db === void 0 ? void 0 : db.close();
+        }
     }
 }
 //# sourceMappingURL=FluidCache.js.map

package/lib/FluidCache.js.map

@@ -1 +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,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAC7B,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?.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"]}
+{"version":3,"file":"FluidCache.js","sourceRoot":"","sources":["../src/FluidCache.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EACN,8BAA8B,EAE9B,0BAA0B,EAC1B,mBAAmB,GACnB,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,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAC7B,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;QAET,gBAAgB,CAAC,KAAK,IAAI,EAAE;YAC3B,IAAI,EAAgD,CAAC;YAErD,wEAAwE;YACxE,IAAI;gBACH,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE3C,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,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC5E,MAAM,WAAW,CAAC,IAAI,CAAC;aAC1B;YAAC,OAAO,KAAU,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,yEAAsD;iBAClE,EACD,KAAK,CACR,CAAC;aACL;oBAAS;gBACN,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;aACf;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QACvC,IAAI,EAAgD,CAAC;QACrD,IAAI;YACA,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,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;YAEjE,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5E,MAAM,WAAW,CAAC,IAAI,CAAC;SACvB;QAAC,OAAO,KAAU,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;gBACC,SAAS,yEAAsD;aAC/D,EACD,KAAK,CACL,CAAC;SACF;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;IAES,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;IAEI,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAEnC,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YAErE,IAAI,CAAC,KAAK,EAAE;gBACX,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,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;gBAEf,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAElD,6FAA6F;YAC7F,IAAI,WAAW,GAAG,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,EAAE;gBAC7D,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAEQ,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;gBAEtC,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;YACb,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACX,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;YACb,CAAC,CAAC,CAAC;YACJ,OAAO,KAAK,CAAC;SACb;QAAC,OAAO,KAAU,EAAE;YACpB,uDAAuD;YACvD,4FAA4F;YAC5F,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACL,CAAC;YACF,OAAO,SAAS,CAAC;SACjB;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAkB,EAAE,KAAU;QAC9C,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE9C,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;YAEX,EAAE,CAAC,KAAK,EAAE,CAAC;SACX;QAAC,OAAO,KAAU,EAAE;YACpB,uDAAuD;YACvD,6DAA6D;YAC7D,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB,EAAE,SAAS,+CAAyC,EAAE,EACtD,KAAK,CACL,CAAC;SACF;gBAAS;YACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACZ;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDBPDatabase } from \"idb\";\nimport { IPersistedCache, ICacheEntry, IFileEntry } from \"@fluidframework/odsp-driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { scheduleIdleTask } from \"./scheduleIdleTask\";\nimport {\n\tgetFluidCacheIndexedDbInstance,\n\tFluidCacheDBSchema,\n\tFluidDriverObjectStoreName,\n\tgetKeyForCacheEntry,\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?.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\t\tscheduleIdleTask(async () => {\n\t\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\n\t\t\t// Delete entries that have not been accessed recently to clean up space\n\t\t\ttry {\n\t\t\t\tdb = 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(keysToDelete.map((key) => transaction.store.delete(key)));\n                await transaction.done;\n            } catch (error: any) {\n                this.logger.sendErrorEvent(\n                    {\n                        eventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n                    },\n                    error,\n                );\n            } finally {\n                db?.close();\n            }\n        });\n    }\n\n    public async removeEntries(file: IFileEntry): Promise<void> {\n        let db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n        try {\n            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\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\tawait transaction.done;\n\t\t} catch (error: any) {\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{\n\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t},\n\t\t\t\terror,\n\t\t\t);\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\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\tprivate async getItemFromCache(cacheEntry: ICacheEntry) {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tconst key = getKeyForCacheEntry(cacheEntry);\n\n            db = await getFluidCacheIndexedDbInstance(this.logger);\n\n            const value = await db.get(FluidDriverObjectStoreName, key);\n\n\t\t\tif (!value) {\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\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\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\n\n            const currentTime = new Date().getTime();\n\n\t\t\t// If too much time has passed since this cache entry was used, we will also return undefined\n\t\t\tif (currentTime - value.createdTimeMs > this.maxCacheItemAge) {\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\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\t\t\t\t\tdb?.close();\n\t\t\t\t})\n\t\t\t\t.catch(() => {\n\t\t\t\t\tdb?.close();\n\t\t\t\t});\n\t\t\treturn value;\n\t\t} catch (error: any) {\n\t\t\t// We can fail to open the db for a variety of reasons,\n\t\t\t// such as the database version having upgraded underneath us. Return undefined in this case\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{ eventName: FluidCacheErrorEvent.FluidCacheGetError },\n\t\t\t\terror,\n\t\t\t);\n\t\t\treturn undefined;\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\n\n\tpublic async put(entry: ICacheEntry, value: any): Promise<void> {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tdb = 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\t\t\tdb.close();\n\t\t} catch (error: any) {\n\t\t\t// We can fail to open the db for a variety of reasons,\n\t\t\t// such as the database version having upgraded underneath us\n\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t{ eventName: FluidCacheErrorEvent.FluidCachePutError },\n\t\t\t\terror,\n\t\t\t);\n\t\t} finally {\n\t\t\tdb?.close();\n\t\t}\n\t}\n}\n"]}

package/lib/FluidCacheIndexedDb.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { DBSchema, IDBPDatabase } from "idb";
+import { DBSchema, DeleteDBCallbacks, IDBPDatabase } from "idb";
 import { ICacheEntry } from "@fluidframework/odsp-driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 export declare const FluidDriverCacheDBName = "fluidDriverCache";
@@ -13,7 +13,7 @@ export declare const oldVersionNameMapping: Partial<{
 }>;
 export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
 export declare function getFluidCacheIndexedDbInstance(logger?: ITelemetryBaseLogger): Promise<IDBPDatabase<FluidCacheDBSchema>>;
-export declare function deleteFluidCacheIndexDbInstance(): Promise<void>;
+export declare function deleteFluidCacheIndexDbInstance(deleteDBCallbacks?: DeleteDBCallbacks): Promise<void>;
 /**
  * Schema for the object store used to cache driver information
  */

package/lib/FluidCacheIndexedDb.d.ts.map

@@ -1 +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,CAAC;CAAE,CAGrE,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"}
+{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAU,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAY,MAAM,KAAK,CAAC;AAClF,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,CAAC;CAAE,CAGrE,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,CAC9C,iBAAiB,CAAC,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAEf;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

@@ -53,7 +53,7 @@ export function getFluidCacheIndexedDbInstance(logger) {
 }
 // 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);
+export function deleteFluidCacheIndexDbInstance(deleteDBCallbacks) {
+    return deleteDB(FluidDriverCacheDBName, deleteDBCallbacks);
 }
 //# sourceMappingURL=FluidCacheIndexedDb.js.map

package/lib/FluidCacheIndexedDb.js.map

@@ -1 +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,GAAwC;IACtE,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"]}
+{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAA6C,QAAQ,EAAE,MAAM,KAAK,CAAC;AAGlF,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,GAAwC;IACtE,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,CAC9C,iBAAqC;IAErC,OAAO,QAAQ,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;AAC5D,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { openDB, DBSchema, DeleteDBCallbacks, 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(\n\tdeleteDBCallbacks?: DeleteDBCallbacks,\n): Promise<void> {\n\treturn deleteDB(FluidDriverCacheDBName, deleteDBCallbacks);\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/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-web-cache";
-export declare const pkgVersion = "2.0.0-internal.3.0.2";
+export declare const pkgVersion = "2.0.0-internal.3.0.3";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/driver-web-cache";
-export const pkgVersion = "2.0.0-internal.3.0.2";
+export const pkgVersion = "2.0.0-internal.3.0.3";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +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,sBAAsB,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 = \"2.0.0-internal.3.0.2\";\n"]}
+{"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,sBAAsB,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 = \"2.0.0-internal.3.0.3\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-web-cache",
-  "version": "2.0.0-internal.3.0.2",
+  "version": "2.0.0-internal.3.0.3",
   "description": "Implementation of the driver caching API for a web browser",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -40,8 +40,8 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/odsp-driver-definitions": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/odsp-driver-definitions": ">=2.0.0-internal.3.0.3 <2.0.0-internal.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.0.3 <2.0.0-internal.4.0.0",
     "idb": "^6.1.2"
   },
   "devDependencies": {

package/src/FluidCache.ts

@@ -2,22 +2,16 @@
  * 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,
-    ITelemetryLogger,
-} from "@fluidframework/common-definitions";
+import { IDBPDatabase } from "idb";
+import { IPersistedCache, ICacheEntry, IFileEntry } from "@fluidframework/odsp-driver-definitions";
+import { ITelemetryBaseLogger, ITelemetryLogger } from "@fluidframework/common-definitions";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
 import { scheduleIdleTask } from "./scheduleIdleTask";
 import {
-    getFluidCacheIndexedDbInstance,
-    FluidDriverObjectStoreName,
-    getKeyForCacheEntry,
+	getFluidCacheIndexedDbInstance,
+	FluidCacheDBSchema,
+	FluidDriverObjectStoreName,
+	getKeyForCacheEntry,
 } from "./FluidCacheIndexedDb";
 import {
     FluidCacheErrorEvent,
@@ -96,10 +90,12 @@ export class FluidCache implements IPersistedCache {
             }
         });
 
-        scheduleIdleTask(async () => {
-            // Delete entries that have not been accessed recently to clean up space
-            try {
-                const db = await getFluidCacheIndexedDbInstance(this.logger);
+		scheduleIdleTask(async () => {
+			let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
+
+			// Delete entries that have not been accessed recently to clean up space
+			try {
+				db = await getFluidCacheIndexedDbInstance(this.logger);
 
                 const transaction = db.transaction(
                     FluidDriverObjectStoreName,
@@ -113,25 +109,25 @@ export class FluidCache implements IPersistedCache {
                     ),
                 );
 
-                await Promise.all(
-                    keysToDelete.map((key) => transaction.store.delete(key)),
-                );
+                await Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));
                 await transaction.done;
             } catch (error: any) {
                 this.logger.sendErrorEvent(
                     {
-                        eventName:
-                            FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,
+                        eventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,
                     },
                     error,
                 );
+            } finally {
+                db?.close();
             }
         });
     }
 
     public async removeEntries(file: IFileEntry): Promise<void> {
+        let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
         try {
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            db = await getFluidCacheIndexedDbInstance(this.logger);
 
             const transaction = db.transaction(
                 FluidDriverObjectStoreName,
@@ -141,20 +137,19 @@ export class FluidCache implements IPersistedCache {
 
             const keysToDelete = await index.getAllKeys(file.docId);
 
-            await Promise.all(
-                keysToDelete.map((key) => transaction.store.delete(key)),
-            );
-            await transaction.done;
-        } catch (error: any) {
-            this.logger.sendErrorEvent(
-                {
-                    eventName:
-                        FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,
-                },
-                error,
-            );
-        }
-    }
+			await Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));
+			await transaction.done;
+		} catch (error: any) {
+			this.logger.sendErrorEvent(
+				{
+					eventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,
+				},
+				error,
+			);
+		} finally {
+			db?.close();
+		}
+	}
 
     public async get(cacheEntry: ICacheEntry): Promise<any> {
         const startTime = performance.now();
@@ -173,17 +168,19 @@ export class FluidCache implements IPersistedCache {
         return cachedItem?.cachedObject;
     }
 
-    private async getItemFromCache(cacheEntry: ICacheEntry) {
-        try {
-            const key = getKeyForCacheEntry(cacheEntry);
+	private async getItemFromCache(cacheEntry: ICacheEntry) {
+		let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
+		try {
+			const key = getKeyForCacheEntry(cacheEntry);
 
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+            db = await getFluidCacheIndexedDbInstance(this.logger);
 
             const value = await db.get(FluidDriverObjectStoreName, key);
 
-            if (!value) {
-                return undefined;
-            }
+			if (!value) {
+				db.close();
+				return undefined;
+			}
 
             // If the data does not come from the same partition, don't return it
             if (value.partitionKey !== this.partitionKey) {
@@ -193,15 +190,17 @@ export class FluidCache implements IPersistedCache {
                     subCategory: FluidCacheEventSubCategories.FluidCache,
                 });
 
-                return undefined;
-            }
+				db.close();
+				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;
-            }
+			// If too much time has passed since this cache entry was used, we will also return undefined
+			if (currentTime - value.createdTimeMs > this.maxCacheItemAge) {
+				db.close();
+				return undefined;
+			}
 
             const transaction = db.transaction(
                 FluidDriverObjectStoreName,
@@ -228,24 +227,29 @@ export class FluidCache implements IPersistedCache {
                     }
                     await transaction.done;
 
-                    db.close();
-                })
-                .catch(() => { });
-            return value;
-        } catch (error: any) {
-            // 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: FluidCacheErrorEvent.FluidCacheGetError },
-                error,
-            );
-            return undefined;
-        }
-    }
-
-    public async put(entry: ICacheEntry, value: any): Promise<void> {
-        try {
-            const db = await getFluidCacheIndexedDbInstance(this.logger);
+					db?.close();
+				})
+				.catch(() => {
+					db?.close();
+				});
+			return value;
+		} catch (error: any) {
+			// 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: FluidCacheErrorEvent.FluidCacheGetError },
+				error,
+			);
+			return undefined;
+		} finally {
+			db?.close();
+		}
+	}
+
+	public async put(entry: ICacheEntry, value: any): Promise<void> {
+		let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
+		try {
+			db = await getFluidCacheIndexedDbInstance(this.logger);
 
             const currentTime = new Date().getTime();
 
@@ -263,14 +267,16 @@ export class FluidCache implements IPersistedCache {
                 getKeyForCacheEntry(entry),
             );
 
-            db.close();
-        } catch (error: any) {
-            // 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: FluidCacheErrorEvent.FluidCachePutError },
-                error,
-            );
-        }
-    }
+			db.close();
+		} catch (error: any) {
+			// 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: FluidCacheErrorEvent.FluidCachePutError },
+				error,
+			);
+		} finally {
+			db?.close();
+		}
+	}
 }

package/src/FluidCacheIndexedDb.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { openDB, DBSchema, IDBPDatabase, deleteDB } from "idb";
+import { openDB, DBSchema, DeleteDBCallbacks, IDBPDatabase, deleteDB } from "idb";
 import { ICacheEntry } from "@fluidframework/odsp-driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import { ChildLogger } from "@fluidframework/telemetry-utils";
@@ -89,8 +89,10 @@ export function getFluidCacheIndexedDbInstance(
 
 // Deletes the indexed DB instance.
 // Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.
-export function deleteFluidCacheIndexDbInstance(): Promise<void> {
-    return deleteDB(FluidDriverCacheDBName);
+export function deleteFluidCacheIndexDbInstance(
+	deleteDBCallbacks?: DeleteDBCallbacks,
+): Promise<void> {
+	return deleteDB(FluidDriverCacheDBName, deleteDBCallbacks);
 }
 
 /**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-web-cache";
-export const pkgVersion = "2.0.0-internal.3.0.2";
+export const pkgVersion = "2.0.0-internal.3.0.3";