@fluidframework/driver-web-cache 2.0.0-internal.3.1.0 → 2.0.0-internal.3.2.1

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,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAoB5F,MAAM,WAAW,gBAAgB;IAChC;;;;;;OAMG;IAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,eAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,MAAM,EAAE,gBAAgB;IAuDvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiBzC,gBAAgB;IAkEjB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B/D"}
+{"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;IAChC;;;;;;OAMG;IAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,eAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,MAAM,EAAE,gBAAgB;IA2DvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiBzC,gBAAgB;IA0EjB,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;;;AAIH,qEAA8D;AAC9D,yDAAsD;AACtD,+DAI+B;AAoC/B;;GAEG;AACH,MAAa,UAAU;IAOtB,YAAY,MAAwB;QACnC,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;;YAC3B,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAChC,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;oBAC/B,aAAa,GAAK,QAAgB,CAAC,YAAyC;yBAC1E,SAAS,CAAC;iBACZ;gBAED,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,qDAA8C;oBACvD,WAAW,+BAAyC;oBACpD,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,aAAa;iBACb,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,IAAA,mCAAgB,EAAC,KAAK,IAAI,EAAE;YAC3B,wEAAwE;YACxE,IAAI;gBACH,MAAM,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,mDAAmD;gBACnD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAC1C,WAAW,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAC1E,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;aACvB;YAAC,OAAO,KAAU,EAAE;gBACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;oBACC,SAAS,yEAAsD;iBAC/D,EACD,KAAK,CACL,CAAC;aACF;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QAC1C,IAAI;YACH,MAAM,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,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,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;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAuB;QACvC,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;YAChC,SAAS,EAAE,kBAAkB;YAC7B,QAAQ,EAAE,UAAU,KAAK,SAAS;YAClC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SACvC,CAAC,CAAC;QAEH,6GAA6G;QAC7G,+DAA+D;QAC/D,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI;YACH,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;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,qEAAqE;YACrE,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE;gBAC7C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,uEAAuD;oBAChE,WAAW,+BAAyC;iBACpD,CAAC,CAAC;gBAEH,OAAO,SAAS,CAAC;aACjB;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;gBAC7D,OAAO,SAAS,CAAC;aACjB;YAED,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,4FAA4F;YAC5F,0EAA0E;YAC1E,WAAW,CAAC,KAAK;iBACf,GAAG,CAAC,GAAG,CAAC;iBACR,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC7B,wFAAwF;gBACxF,yFAAyF;gBACzF,mCAAmC;gBACnC,IACC,aAAa,KAAK,SAAS;oBAC3B,aAAa,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;oBACnD,CAAC,aAAa,CAAC,gBAAgB,KAAK,SAAS;wBAC5C,aAAa,CAAC,gBAAgB,GAAG,WAAW,CAAC,EAC7C;oBACD,MAAM,WAAW,CAAC,KAAK,CAAC,GAAG,iCACrB,aAAa,KAAE,gBAAgB,EAAE,WAAW,KACjD,GAAG,CACH,CAAC;iBACF;gBACD,MAAM,WAAW,CAAC,IAAI,CAAC;gBAEvB,EAAE,CAAC,KAAK,EAAE,CAAC;YACZ,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClB,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;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAkB,EAAE,KAAU;QAC9C,IAAI;YACH,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,CACX,gDAA0B,EAC1B;gBACC,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;aAC7B,EACD,IAAA,yCAAmB,EAAC,KAAK,CAAC,CAC1B,CAAC;YAEF,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;IACF,CAAC;CACD;AApMD,gCAoMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\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\tFluidDriverObjectStoreName,\n\tgetKeyForCacheEntry,\n} from \"./FluidCacheIndexedDb\";\nimport {\n\tFluidCacheErrorEvent,\n\tFluidCacheEventSubCategories,\n\tFluidCacheGenericEvent,\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\tindexedDB: number | undefined;\n}\n\nexport interface FluidCacheConfig {\n\t/**\n\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t * Null can be used to explicity indicate no partitioning, and has been chosen\n\t * vs undefined so that it is clear this is an intentional choice by the caller.\n\t * A null value should only be used when the host can ensure that the cache is not able\n\t * to be shared with multiple users.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpartitionKey: string | null;\n\n\t/**\n\t * A logger that can be used to get insight into cache performance and errors\n\t */\n\tlogger?: ITelemetryBaseLogger;\n\n\t/**\n\t * A value in milliseconds that determines the maximum age of a cache entry to return.\n\t * If an entry exists in the cache, but is older than this value, the cached value will not be returned.\n\t */\n\tmaxCacheItemAge: 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\tprivate readonly logger: ITelemetryLogger;\n\n\tprivate readonly partitionKey: string | null;\n\n\tprivate readonly maxCacheItemAge: number;\n\n\tconstructor(config: FluidCacheConfig) {\n\t\tthis.logger = ChildLogger.create(config.logger);\n\t\tthis.partitionKey = config.partitionKey;\n\t\tthis.maxCacheItemAge = config.maxCacheItemAge;\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Log how much storage space is currently being used by indexed db.\n\t\t\t// NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.\n\t\t\t// Exception added when eslint rule was added, this should be revisited when modifying this code\n\t\t\tif (navigator.storage?.estimate) {\n\t\t\t\tconst estimate = await navigator.storage.estimate();\n\n\t\t\t\t// Some browsers have a usageDetails property that will tell you\n\t\t\t\t// more detailed information on how the storage is being used\n\t\t\t\tlet indexedDBSize: number | undefined;\n\t\t\t\tif (\"usageDetails\" in estimate) {\n\t\t\t\t\tindexedDBSize = ((estimate as any).usageDetails as StorageQuotaUsageDetails)\n\t\t\t\t\t\t.indexedDB;\n\t\t\t\t}\n\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCacheStorageInfo,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t\tquota: estimate.quota,\n\t\t\t\t\tusage: estimate.usage,\n\t\t\t\t\tindexedDBSize,\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Delete entries that have not been accessed recently to clean up space\n\t\t\ttry {\n\t\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t\tconst index = transaction.store.index(\"lastAccessTimeMs\");\n\t\t\t\t// Get items that have not been accessed in 4 weeks\n\t\t\t\tconst keysToDelete = await index.getAllKeys(\n\t\t\t\t\tIDBKeyRange.upperBound(new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000),\n\t\t\t\t);\n\n\t\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\t\tawait transaction.done;\n\t\t\t} catch (error: any) {\n\t\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic async removeEntries(file: IFileEntry): Promise<void> {\n\t\ttry {\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\tconst index = transaction.store.index(\"fileId\");\n\n\t\t\tconst 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}\n\t}\n\n\tpublic async get(cacheEntry: ICacheEntry): Promise<any> {\n\t\tconst startTime = performance.now();\n\n\t\tconst cachedItem = await this.getItemFromCache(cacheEntry);\n\n\t\tthis.logger.sendPerformanceEvent({\n\t\t\teventName: \"FluidCacheAccess\",\n\t\t\tcacheHit: cachedItem !== undefined,\n\t\t\ttype: cacheEntry.type,\n\t\t\tduration: performance.now() - startTime,\n\t\t});\n\n\t\t// Value will contain metadata like the expiry time, we just want to return the object we were asked to cache\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn cachedItem?.cachedObject;\n\t}\n\n\tprivate async getItemFromCache(cacheEntry: ICacheEntry) {\n\t\ttry {\n\t\t\tconst key = getKeyForCacheEntry(cacheEntry);\n\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst value = await db.get(FluidDriverObjectStoreName, key);\n\n\t\t\tif (!value) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\t// If the data does not come from the same partition, don't return it\n\t\t\tif (value.partitionKey !== this.partitionKey) {\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCachePartitionKeyMismatch,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t});\n\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\tconst 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\treturn undefined;\n\t\t\t}\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t// We don't want to block the get return of this function on updating the last accessed time\n\t\t\t// We catch this promise because there is no user bad if this is rejected.\n\t\t\ttransaction.store\n\t\t\t\t.get(key)\n\t\t\t\t.then(async (valueToUpdate) => {\n\t\t\t\t\t// This value in the database could have been updated concurrently by other tabs/iframes\n\t\t\t\t\t// since we first read it. Only update the last accessed time if the current value in the\n\t\t\t\t\t// DB was the same one we returned.\n\t\t\t\t\tif (\n\t\t\t\t\t\tvalueToUpdate !== undefined &&\n\t\t\t\t\t\tvalueToUpdate.createdTimeMs === value.createdTimeMs &&\n\t\t\t\t\t\t(valueToUpdate.lastAccessTimeMs === undefined ||\n\t\t\t\t\t\t\tvalueToUpdate.lastAccessTimeMs < currentTime)\n\t\t\t\t\t) {\n\t\t\t\t\t\tawait transaction.store.put(\n\t\t\t\t\t\t\t{ ...valueToUpdate, lastAccessTimeMs: currentTime },\n\t\t\t\t\t\t\tkey,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t\tawait transaction.done;\n\n\t\t\t\t\tdb.close();\n\t\t\t\t})\n\t\t\t\t.catch(() => {});\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}\n\t}\n\n\tpublic async put(entry: ICacheEntry, value: any): Promise<void> {\n\t\ttry {\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst currentTime = new Date().getTime();\n\n\t\t\tawait db.put(\n\t\t\t\tFluidDriverObjectStoreName,\n\t\t\t\t{\n\t\t\t\t\tcachedObject: value,\n\t\t\t\t\tfileId: entry.file.docId,\n\t\t\t\t\ttype: entry.type,\n\t\t\t\t\tcacheItemId: entry.key,\n\t\t\t\t\tpartitionKey: this.partitionKey,\n\t\t\t\t\tcreatedTimeMs: currentTime,\n\t\t\t\t\tlastAccessTimeMs: currentTime,\n\t\t\t\t},\n\t\t\t\tgetKeyForCacheEntry(entry),\n\t\t\t);\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}\n\t}\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;IAOtB,YAAY,MAAwB;QACnC,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;;YAC3B,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAChC,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;oBAC/B,aAAa,GAAK,QAAgB,CAAC,YAAyC;yBAC1E,SAAS,CAAC;iBACZ;gBAED,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,qDAA8C;oBACvD,WAAW,+BAAyC;oBACpD,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,aAAa;iBACb,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,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;gBAEvD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,mDAAmD;gBACnD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAC1C,WAAW,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAC1E,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;aACvB;YAAC,OAAO,KAAU,EAAE;gBACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;oBACC,SAAS,yEAAsD;iBAC/D,EACD,KAAK,CACL,CAAC;aACF;oBAAS;gBACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;aACZ;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QAC1C,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,EAAE,GAAG,MAAM,IAAA,oDAA8B,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,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,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;IAEM,KAAK,CAAC,GAAG,CAAC,UAAuB;QACvC,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;YAChC,SAAS,EAAE,kBAAkB;YAC7B,QAAQ,EAAE,UAAU,KAAK,SAAS;YAClC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SACvC,CAAC,CAAC;QAEH,6GAA6G;QAC7G,+DAA+D;QAC/D,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,MAAM,GAAG,GAAG,IAAA,yCAAmB,EAAC,UAAU,CAAC,CAAC;YAE5C,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;YAE5D,IAAI,CAAC,KAAK,EAAE;gBACX,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,qEAAqE;YACrE,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE;gBAC7C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,uEAAuD;oBAChE,WAAW,+BAAyC;iBACpD,CAAC,CAAC;gBAEH,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;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;gBAC7D,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,gDAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,4FAA4F;YAC5F,0EAA0E;YAC1E,WAAW,CAAC,KAAK;iBACf,GAAG,CAAC,GAAG,CAAC;iBACR,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC7B,wFAAwF;gBACxF,yFAAyF;gBACzF,mCAAmC;gBACnC,IACC,aAAa,KAAK,SAAS;oBAC3B,aAAa,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;oBACnD,CAAC,aAAa,CAAC,gBAAgB,KAAK,SAAS;wBAC5C,aAAa,CAAC,gBAAgB,GAAG,WAAW,CAAC,EAC7C;oBACD,MAAM,WAAW,CAAC,KAAK,CAAC,GAAG,iCACrB,aAAa,KAAE,gBAAgB,EAAE,WAAW,KACjD,GAAG,CACH,CAAC;iBACF;gBACD,MAAM,WAAW,CAAC,IAAI,CAAC;gBAEvB,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;YAEvD,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,EAAE,CAAC,GAAG,CACX,gDAA0B,EAC1B;gBACC,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;aAC7B,EACD,IAAA,yCAAmB,EAAC,KAAK,CAAC,CAC1B,CAAC;YAEF,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;AAtND,gCAsNC","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\tFluidCacheErrorEvent,\n\tFluidCacheEventSubCategories,\n\tFluidCacheGenericEvent,\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\tindexedDB: number | undefined;\n}\n\nexport interface FluidCacheConfig {\n\t/**\n\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t * Null can be used to explicity indicate no partitioning, and has been chosen\n\t * vs undefined so that it is clear this is an intentional choice by the caller.\n\t * A null value should only be used when the host can ensure that the cache is not able\n\t * to be shared with multiple users.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpartitionKey: string | null;\n\n\t/**\n\t * A logger that can be used to get insight into cache performance and errors\n\t */\n\tlogger?: ITelemetryBaseLogger;\n\n\t/**\n\t * A value in milliseconds that determines the maximum age of a cache entry to return.\n\t * If an entry exists in the cache, but is older than this value, the cached value will not be returned.\n\t */\n\tmaxCacheItemAge: 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\tprivate readonly logger: ITelemetryLogger;\n\n\tprivate readonly partitionKey: string | null;\n\n\tprivate readonly maxCacheItemAge: number;\n\n\tconstructor(config: FluidCacheConfig) {\n\t\tthis.logger = ChildLogger.create(config.logger);\n\t\tthis.partitionKey = config.partitionKey;\n\t\tthis.maxCacheItemAge = config.maxCacheItemAge;\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Log how much storage space is currently being used by indexed db.\n\t\t\t// NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.\n\t\t\t// Exception added when eslint rule was added, this should be revisited when modifying this code\n\t\t\tif (navigator.storage?.estimate) {\n\t\t\t\tconst estimate = await navigator.storage.estimate();\n\n\t\t\t\t// Some browsers have a usageDetails property that will tell you\n\t\t\t\t// more detailed information on how the storage is being used\n\t\t\t\tlet indexedDBSize: number | undefined;\n\t\t\t\tif (\"usageDetails\" in estimate) {\n\t\t\t\t\tindexedDBSize = ((estimate as any).usageDetails as StorageQuotaUsageDetails)\n\t\t\t\t\t\t.indexedDB;\n\t\t\t\t}\n\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCacheStorageInfo,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t\tquota: estimate.quota,\n\t\t\t\t\tusage: estimate.usage,\n\t\t\t\t\tindexedDBSize,\n\t\t\t\t});\n\t\t\t}\n\t\t});\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\t\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t\tconst index = transaction.store.index(\"lastAccessTimeMs\");\n\t\t\t\t// Get items that have not been accessed in 4 weeks\n\t\t\t\tconst keysToDelete = await index.getAllKeys(\n\t\t\t\t\tIDBKeyRange.upperBound(new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000),\n\t\t\t\t);\n\n\t\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\t\tawait transaction.done;\n\t\t\t} catch (error: any) {\n\t\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t} finally {\n\t\t\t\tdb?.close();\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic async removeEntries(file: IFileEntry): Promise<void> {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tdb = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\tconst index = transaction.store.index(\"fileId\");\n\n\t\t\tconst 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\tpublic async get(cacheEntry: ICacheEntry): Promise<any> {\n\t\tconst startTime = performance.now();\n\n\t\tconst cachedItem = await this.getItemFromCache(cacheEntry);\n\n\t\tthis.logger.sendPerformanceEvent({\n\t\t\teventName: \"FluidCacheAccess\",\n\t\t\tcacheHit: cachedItem !== undefined,\n\t\t\ttype: cacheEntry.type,\n\t\t\tduration: performance.now() - startTime,\n\t\t});\n\n\t\t// Value will contain metadata like the expiry time, we just want to return the object we were asked to cache\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn cachedItem?.cachedObject;\n\t}\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\t\t\tdb = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst 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\t\t\t// If the data does not come from the same partition, don't return it\n\t\t\tif (value.partitionKey !== this.partitionKey) {\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCachePartitionKeyMismatch,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t});\n\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\tconst 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\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t// We don't want to block the get return of this function on updating the last accessed time\n\t\t\t// We catch this promise because there is no user bad if this is rejected.\n\t\t\ttransaction.store\n\t\t\t\t.get(key)\n\t\t\t\t.then(async (valueToUpdate) => {\n\t\t\t\t\t// This value in the database could have been updated concurrently by other tabs/iframes\n\t\t\t\t\t// since we first read it. Only update the last accessed time if the current value in the\n\t\t\t\t\t// DB was the same one we returned.\n\t\t\t\t\tif (\n\t\t\t\t\t\tvalueToUpdate !== undefined &&\n\t\t\t\t\t\tvalueToUpdate.createdTimeMs === value.createdTimeMs &&\n\t\t\t\t\t\t(valueToUpdate.lastAccessTimeMs === undefined ||\n\t\t\t\t\t\t\tvalueToUpdate.lastAccessTimeMs < currentTime)\n\t\t\t\t\t) {\n\t\t\t\t\t\tawait transaction.store.put(\n\t\t\t\t\t\t\t{ ...valueToUpdate, lastAccessTimeMs: currentTime },\n\t\t\t\t\t\t\tkey,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t\tawait 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\t\t\tconst currentTime = new Date().getTime();\n\n\t\t\tawait db.put(\n\t\t\t\tFluidDriverObjectStoreName,\n\t\t\t\t{\n\t\t\t\t\tcachedObject: value,\n\t\t\t\t\tfileId: entry.file.docId,\n\t\t\t\t\ttype: entry.type,\n\t\t\t\t\tcacheItemId: entry.key,\n\t\t\t\t\tpartitionKey: this.partitionKey,\n\t\t\t\t\tcreatedTimeMs: currentTime,\n\t\t\t\t\tlastAccessTimeMs: currentTime,\n\t\t\t\t},\n\t\t\t\tgetKeyForCacheEntry(entry),\n\t\t\t);\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,CAAA;CAAE,CAGpE,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,UAErD;AAED,wBAAgB,8BAA8B,CAC7C,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAwC3C;AAID,wBAAgB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IACnD,CAAC,0BAA0B,CAAC,EAAE;QAC7B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE;YACN;;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;SACzB,CAAC;QAEF,OAAO,EAAE;YACR,aAAa,EAAE,MAAM,CAAC;YACtB,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;KACF,CAAC;CACF"}
+{"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,CAAA;CAAE,CAGpE,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,UAErD;AAED,wBAAgB,8BAA8B,CAC7C,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAwC3C;AAID,wBAAgB,+BAA+B,CAC9C,iBAAiB,CAAC,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IACnD,CAAC,0BAA0B,CAAC,EAAE;QAC7B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE;YACN;;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;SACzB,CAAC;QAEF,OAAO,EAAE;YACR,aAAa,EAAE,MAAM,CAAC;YACtB,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;KACF,CAAC;CACF"}

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,GAAuC;IACxE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACpB,CAAC;AAEF,SAAgB,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAFD,kDAEC;AAED,SAAgB,8BAA8B,CAC7C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,IAAA,YAAM,EAAqB,8BAAsB,EAAE,2BAAmB,EAAE;YACvE,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBAC3B,IAAI;oBACH,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,6BAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE;wBAClB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;qBAC3C;iBACD;gBAAC,OAAO,KAAU,EAAE;oBACpB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,6BAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CACxC;wBACC,SAAS,+DAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;iBACF;gBAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,iBAAiB,CAAC,kCAA0B,CAAC,CAAC;gBAC1E,gBAAgB,CAAC,WAAW,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;gBAC/D,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACrE,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;gBAC7D,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,MAAM,CACL,IAAI,KAAK,CACR,+EAA+E,CAC/E,CACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACJ,CAAC;AA1CD,wEA0CC;AAED,mCAAmC;AACnC,+FAA+F;AAC/F,SAAgB,+BAA+B;IAC9C,OAAO,IAAA,cAAQ,EAAC,8BAAsB,CAAC,CAAC;AACzC,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\t1: \"diverStorage\",\n\t2: \"diverStorage.V2\",\n};\n\nexport function getKeyForCacheEntry(entry: ICacheEntry) {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n\nexport function getFluidCacheIndexedDbInstance(\n\tlogger?: ITelemetryBaseLogger,\n): Promise<IDBPDatabase<FluidCacheDBSchema>> {\n\treturn new Promise((resolve, reject) => {\n\t\topenDB<FluidCacheDBSchema>(FluidDriverCacheDBName, CurrentCacheVersion, {\n\t\t\tupgrade: (db, oldVersion) => {\n\t\t\t\ttry {\n\t\t\t\t\t// We changed the format of the object store, so we must\n\t\t\t\t\t// delete the old stores to create a new one in V3\n\t\t\t\t\tconst cacheToDelete = oldVersionNameMapping[oldVersion];\n\t\t\t\t\tif (cacheToDelete) {\n\t\t\t\t\t\t// We don't include the old object stores in the schema, so we need to\n\t\t\t\t\t\t// use a typecast here to prevent IDB from complaining\n\t\t\t\t\t\tdb.deleteObjectStore(cacheToDelete as any);\n\t\t\t\t\t}\n\t\t\t\t} catch (error: any) {\n\t\t\t\t\t// Catch any error done when attempting to delete the older version.\n\t\t\t\t\t// If the object does not exist db will throw.\n\t\t\t\t\t// We can now assume that the old version is no longer there regardless.\n\t\t\t\t\tChildLogger.create(logger).sendErrorEvent(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldDbError,\n\t\t\t\t\t\t},\n\t\t\t\t\t\terror,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tconst cacheObjectStore = db.createObjectStore(FluidDriverObjectStoreName);\n\t\t\t\tcacheObjectStore.createIndex(\"createdTimeMs\", \"createdTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"lastAccessTimeMs\", \"lastAccessTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"partitionKey\", \"partitionKey\");\n\t\t\t\tcacheObjectStore.createIndex(\"fileId\", \"fileId\");\n\t\t\t},\n\t\t\tblocked: () => {\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\n\t\t\t\t\t\t\"Could not open DB since it is blocked by an older client that has the DB open\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t},\n\t\t}).then(resolve, reject);\n\t});\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\treturn deleteDB(FluidDriverCacheDBName);\n}\n\n/**\n * Schema for the object store used to cache driver information\n */\nexport interface FluidCacheDBSchema extends DBSchema {\n\t[FluidDriverObjectStoreName]: {\n\t\t/**\n\t\t * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId\n\t\t */\n\t\tkey: string;\n\n\t\tvalue: {\n\t\t\t/**\n\t\t\t * The identifier of the file associated with the cache entry\n\t\t\t */\n\t\t\tfileId: string;\n\n\t\t\t/**\n\t\t\t * Describes the type of content being cached, such as snapshot\n\t\t\t */\n\t\t\ttype: string;\n\n\t\t\t/**\n\t\t\t * Files may have multiple cached items associated with them,\n\t\t\t * this property uniquely identifies a specific cache entry for a file.\n\t\t\t * This is not globally unique, but rather a unique id for this file\n\t\t\t */\n\t\t\tcacheItemId: string;\n\n\t\t\t/*\n\t\t\t * Opaque object that the driver asks us to store in a cache for performance reasons\n\t\t\t */\n\t\t\tcachedObject: any;\n\n\t\t\t/**\n\t\t\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t\t\t * Null can be used to explicity indicate no partitioning.\n\t\t\t */\n\t\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\t\tpartitionKey: string | null;\n\n\t\t\t/**\n\t\t\t * The time when the cache entry was put into the cache\n\t\t\t */\n\t\t\tcreatedTimeMs: number;\n\n\t\t\t/**\n\t\t\t * The last time the cache entry was used.\n\t\t\t * This is initially set to the time the cache entry was created Measured as ms since unix epoch.\n\t\t\t */\n\t\t\tlastAccessTimeMs: number;\n\t\t};\n\n\t\tindexes: {\n\t\t\tcreatedTimeMs: number;\n\t\t\tpartitionKey: string;\n\t\t\tlastAccessTimeMs: number;\n\t\t\tfileId: string;\n\t\t};\n\t};\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,GAAuC;IACxE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACpB,CAAC;AAEF,SAAgB,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAFD,kDAEC;AAED,SAAgB,8BAA8B,CAC7C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,IAAA,YAAM,EAAqB,8BAAsB,EAAE,2BAAmB,EAAE;YACvE,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBAC3B,IAAI;oBACH,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,6BAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE;wBAClB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;qBAC3C;iBACD;gBAAC,OAAO,KAAU,EAAE;oBACpB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,6BAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CACxC;wBACC,SAAS,+DAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;iBACF;gBAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,iBAAiB,CAAC,kCAA0B,CAAC,CAAC;gBAC1E,gBAAgB,CAAC,WAAW,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;gBAC/D,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACrE,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;gBAC7D,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,MAAM,CACL,IAAI,KAAK,CACR,+EAA+E,CAC/E,CACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACJ,CAAC;AA1CD,wEA0CC;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\t1: \"diverStorage\",\n\t2: \"diverStorage.V2\",\n};\n\nexport function getKeyForCacheEntry(entry: ICacheEntry) {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n\nexport function getFluidCacheIndexedDbInstance(\n\tlogger?: ITelemetryBaseLogger,\n): Promise<IDBPDatabase<FluidCacheDBSchema>> {\n\treturn new Promise((resolve, reject) => {\n\t\topenDB<FluidCacheDBSchema>(FluidDriverCacheDBName, CurrentCacheVersion, {\n\t\t\tupgrade: (db, oldVersion) => {\n\t\t\t\ttry {\n\t\t\t\t\t// We changed the format of the object store, so we must\n\t\t\t\t\t// delete the old stores to create a new one in V3\n\t\t\t\t\tconst cacheToDelete = oldVersionNameMapping[oldVersion];\n\t\t\t\t\tif (cacheToDelete) {\n\t\t\t\t\t\t// We don't include the old object stores in the schema, so we need to\n\t\t\t\t\t\t// use a typecast here to prevent IDB from complaining\n\t\t\t\t\t\tdb.deleteObjectStore(cacheToDelete as any);\n\t\t\t\t\t}\n\t\t\t\t} catch (error: any) {\n\t\t\t\t\t// Catch any error done when attempting to delete the older version.\n\t\t\t\t\t// If the object does not exist db will throw.\n\t\t\t\t\t// We can now assume that the old version is no longer there regardless.\n\t\t\t\t\tChildLogger.create(logger).sendErrorEvent(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldDbError,\n\t\t\t\t\t\t},\n\t\t\t\t\t\terror,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tconst cacheObjectStore = db.createObjectStore(FluidDriverObjectStoreName);\n\t\t\t\tcacheObjectStore.createIndex(\"createdTimeMs\", \"createdTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"lastAccessTimeMs\", \"lastAccessTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"partitionKey\", \"partitionKey\");\n\t\t\t\tcacheObjectStore.createIndex(\"fileId\", \"fileId\");\n\t\t\t},\n\t\t\tblocked: () => {\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\n\t\t\t\t\t\t\"Could not open DB since it is blocked by an older client that has the DB open\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t},\n\t\t}).then(resolve, reject);\n\t});\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\t[FluidDriverObjectStoreName]: {\n\t\t/**\n\t\t * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId\n\t\t */\n\t\tkey: string;\n\n\t\tvalue: {\n\t\t\t/**\n\t\t\t * The identifier of the file associated with the cache entry\n\t\t\t */\n\t\t\tfileId: string;\n\n\t\t\t/**\n\t\t\t * Describes the type of content being cached, such as snapshot\n\t\t\t */\n\t\t\ttype: string;\n\n\t\t\t/**\n\t\t\t * Files may have multiple cached items associated with them,\n\t\t\t * this property uniquely identifies a specific cache entry for a file.\n\t\t\t * This is not globally unique, but rather a unique id for this file\n\t\t\t */\n\t\t\tcacheItemId: string;\n\n\t\t\t/*\n\t\t\t * Opaque object that the driver asks us to store in a cache for performance reasons\n\t\t\t */\n\t\t\tcachedObject: any;\n\n\t\t\t/**\n\t\t\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t\t\t * Null can be used to explicity indicate no partitioning.\n\t\t\t */\n\t\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\t\tpartitionKey: string | null;\n\n\t\t\t/**\n\t\t\t * The time when the cache entry was put into the cache\n\t\t\t */\n\t\t\tcreatedTimeMs: number;\n\n\t\t\t/**\n\t\t\t * The last time the cache entry was used.\n\t\t\t * This is initially set to the time the cache entry was created Measured as ms since unix epoch.\n\t\t\t */\n\t\t\tlastAccessTimeMs: number;\n\t\t};\n\n\t\tindexes: {\n\t\t\tcreatedTimeMs: number;\n\t\t\tpartitionKey: string;\n\t\t\tlastAccessTimeMs: number;\n\t\t\tfileId: string;\n\t\t};\n\t};\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.1.0";
+export declare const pkgVersion = "2.0.0-internal.3.2.1";
 //# 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.1.0";
+exports.pkgVersion = "2.0.0-internal.3.2.1";
 //# 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.1.0\";\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.2.1\";\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,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAoB5F,MAAM,WAAW,gBAAgB;IAChC;;;;;;OAMG;IAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,eAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,MAAM,EAAE,gBAAgB;IAuDvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiBzC,gBAAgB;IAkEjB,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B/D"}
+{"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;IAChC;;;;;;OAMG;IAEH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,eAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAE1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,MAAM,EAAE,gBAAgB;IA2DvB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB9C,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;YAiBzC,gBAAgB;IA0EjB,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;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EACN,8BAA8B,EAC9B,0BAA0B,EAC1B,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAoC/B;;GAEG;AACH,MAAM,OAAO,UAAU;IAOtB,YAAY,MAAwB;QACnC,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;;YAC3B,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAChC,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;oBAC/B,aAAa,GAAK,QAAgB,CAAC,YAAyC;yBAC1E,SAAS,CAAC;iBACZ;gBAED,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,qDAA8C;oBACvD,WAAW,+BAAyC;oBACpD,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,aAAa;iBACb,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,gBAAgB,CAAC,KAAK,IAAI,EAAE;YAC3B,wEAAwE;YACxE,IAAI;gBACH,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,mDAAmD;gBACnD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAC1C,WAAW,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAC1E,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;aACvB;YAAC,OAAO,KAAU,EAAE;gBACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;oBACC,SAAS,yEAAsD;iBAC/D,EACD,KAAK,CACL,CAAC;aACF;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QAC1C,IAAI;YACH,MAAM,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE7D,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,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,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;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAuB;QACvC,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;YAChC,SAAS,EAAE,kBAAkB;YAC7B,QAAQ,EAAE,UAAU,KAAK,SAAS;YAClC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SACvC,CAAC,CAAC;QAEH,6GAA6G;QAC7G,+DAA+D;QAC/D,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI;YACH,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;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,qEAAqE;YACrE,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE;gBAC7C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,uEAAuD;oBAChE,WAAW,+BAAyC;iBACpD,CAAC,CAAC;gBAEH,OAAO,SAAS,CAAC;aACjB;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;gBAC7D,OAAO,SAAS,CAAC;aACjB;YAED,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,4FAA4F;YAC5F,0EAA0E;YAC1E,WAAW,CAAC,KAAK;iBACf,GAAG,CAAC,GAAG,CAAC;iBACR,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC7B,wFAAwF;gBACxF,yFAAyF;gBACzF,mCAAmC;gBACnC,IACC,aAAa,KAAK,SAAS;oBAC3B,aAAa,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;oBACnD,CAAC,aAAa,CAAC,gBAAgB,KAAK,SAAS;wBAC5C,aAAa,CAAC,gBAAgB,GAAG,WAAW,CAAC,EAC7C;oBACD,MAAM,WAAW,CAAC,KAAK,CAAC,GAAG,iCACrB,aAAa,KAAE,gBAAgB,EAAE,WAAW,KACjD,GAAG,CACH,CAAC;iBACF;gBACD,MAAM,WAAW,CAAC,IAAI,CAAC;gBAEvB,EAAE,CAAC,KAAK,EAAE,CAAC;YACZ,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClB,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;IACF,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,KAAkB,EAAE,KAAU;QAC9C,IAAI;YACH,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,CACX,0BAA0B,EAC1B;gBACC,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;aAC7B,EACD,mBAAmB,CAAC,KAAK,CAAC,CAC1B,CAAC;YAEF,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;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\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\tFluidDriverObjectStoreName,\n\tgetKeyForCacheEntry,\n} from \"./FluidCacheIndexedDb\";\nimport {\n\tFluidCacheErrorEvent,\n\tFluidCacheEventSubCategories,\n\tFluidCacheGenericEvent,\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\tindexedDB: number | undefined;\n}\n\nexport interface FluidCacheConfig {\n\t/**\n\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t * Null can be used to explicity indicate no partitioning, and has been chosen\n\t * vs undefined so that it is clear this is an intentional choice by the caller.\n\t * A null value should only be used when the host can ensure that the cache is not able\n\t * to be shared with multiple users.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpartitionKey: string | null;\n\n\t/**\n\t * A logger that can be used to get insight into cache performance and errors\n\t */\n\tlogger?: ITelemetryBaseLogger;\n\n\t/**\n\t * A value in milliseconds that determines the maximum age of a cache entry to return.\n\t * If an entry exists in the cache, but is older than this value, the cached value will not be returned.\n\t */\n\tmaxCacheItemAge: 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\tprivate readonly logger: ITelemetryLogger;\n\n\tprivate readonly partitionKey: string | null;\n\n\tprivate readonly maxCacheItemAge: number;\n\n\tconstructor(config: FluidCacheConfig) {\n\t\tthis.logger = ChildLogger.create(config.logger);\n\t\tthis.partitionKey = config.partitionKey;\n\t\tthis.maxCacheItemAge = config.maxCacheItemAge;\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Log how much storage space is currently being used by indexed db.\n\t\t\t// NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.\n\t\t\t// Exception added when eslint rule was added, this should be revisited when modifying this code\n\t\t\tif (navigator.storage?.estimate) {\n\t\t\t\tconst estimate = await navigator.storage.estimate();\n\n\t\t\t\t// Some browsers have a usageDetails property that will tell you\n\t\t\t\t// more detailed information on how the storage is being used\n\t\t\t\tlet indexedDBSize: number | undefined;\n\t\t\t\tif (\"usageDetails\" in estimate) {\n\t\t\t\t\tindexedDBSize = ((estimate as any).usageDetails as StorageQuotaUsageDetails)\n\t\t\t\t\t\t.indexedDB;\n\t\t\t\t}\n\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCacheStorageInfo,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t\tquota: estimate.quota,\n\t\t\t\t\tusage: estimate.usage,\n\t\t\t\t\tindexedDBSize,\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Delete entries that have not been accessed recently to clean up space\n\t\t\ttry {\n\t\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t\tconst index = transaction.store.index(\"lastAccessTimeMs\");\n\t\t\t\t// Get items that have not been accessed in 4 weeks\n\t\t\t\tconst keysToDelete = await index.getAllKeys(\n\t\t\t\t\tIDBKeyRange.upperBound(new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000),\n\t\t\t\t);\n\n\t\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\t\tawait transaction.done;\n\t\t\t} catch (error: any) {\n\t\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic async removeEntries(file: IFileEntry): Promise<void> {\n\t\ttry {\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\tconst index = transaction.store.index(\"fileId\");\n\n\t\t\tconst 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}\n\t}\n\n\tpublic async get(cacheEntry: ICacheEntry): Promise<any> {\n\t\tconst startTime = performance.now();\n\n\t\tconst cachedItem = await this.getItemFromCache(cacheEntry);\n\n\t\tthis.logger.sendPerformanceEvent({\n\t\t\teventName: \"FluidCacheAccess\",\n\t\t\tcacheHit: cachedItem !== undefined,\n\t\t\ttype: cacheEntry.type,\n\t\t\tduration: performance.now() - startTime,\n\t\t});\n\n\t\t// Value will contain metadata like the expiry time, we just want to return the object we were asked to cache\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn cachedItem?.cachedObject;\n\t}\n\n\tprivate async getItemFromCache(cacheEntry: ICacheEntry) {\n\t\ttry {\n\t\t\tconst key = getKeyForCacheEntry(cacheEntry);\n\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst value = await db.get(FluidDriverObjectStoreName, key);\n\n\t\t\tif (!value) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\t// If the data does not come from the same partition, don't return it\n\t\t\tif (value.partitionKey !== this.partitionKey) {\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCachePartitionKeyMismatch,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t});\n\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\tconst 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\treturn undefined;\n\t\t\t}\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t// We don't want to block the get return of this function on updating the last accessed time\n\t\t\t// We catch this promise because there is no user bad if this is rejected.\n\t\t\ttransaction.store\n\t\t\t\t.get(key)\n\t\t\t\t.then(async (valueToUpdate) => {\n\t\t\t\t\t// This value in the database could have been updated concurrently by other tabs/iframes\n\t\t\t\t\t// since we first read it. Only update the last accessed time if the current value in the\n\t\t\t\t\t// DB was the same one we returned.\n\t\t\t\t\tif (\n\t\t\t\t\t\tvalueToUpdate !== undefined &&\n\t\t\t\t\t\tvalueToUpdate.createdTimeMs === value.createdTimeMs &&\n\t\t\t\t\t\t(valueToUpdate.lastAccessTimeMs === undefined ||\n\t\t\t\t\t\t\tvalueToUpdate.lastAccessTimeMs < currentTime)\n\t\t\t\t\t) {\n\t\t\t\t\t\tawait transaction.store.put(\n\t\t\t\t\t\t\t{ ...valueToUpdate, lastAccessTimeMs: currentTime },\n\t\t\t\t\t\t\tkey,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t\tawait transaction.done;\n\n\t\t\t\t\tdb.close();\n\t\t\t\t})\n\t\t\t\t.catch(() => {});\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}\n\t}\n\n\tpublic async put(entry: ICacheEntry, value: any): Promise<void> {\n\t\ttry {\n\t\t\tconst db = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst currentTime = new Date().getTime();\n\n\t\t\tawait db.put(\n\t\t\t\tFluidDriverObjectStoreName,\n\t\t\t\t{\n\t\t\t\t\tcachedObject: value,\n\t\t\t\t\tfileId: entry.file.docId,\n\t\t\t\t\ttype: entry.type,\n\t\t\t\t\tcacheItemId: entry.key,\n\t\t\t\t\tpartitionKey: this.partitionKey,\n\t\t\t\t\tcreatedTimeMs: currentTime,\n\t\t\t\t\tlastAccessTimeMs: currentTime,\n\t\t\t\t},\n\t\t\t\tgetKeyForCacheEntry(entry),\n\t\t\t);\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}\n\t}\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;IAOtB,YAAY,MAAwB;QACnC,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;;YAC3B,oEAAoE;YACpE,wGAAwG;YACxG,gGAAgG;YAChG,IAAI,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,EAAE;gBAChC,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;oBAC/B,aAAa,GAAK,QAAgB,CAAC,YAAyC;yBAC1E,SAAS,CAAC;iBACZ;gBAED,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,qDAA8C;oBACvD,WAAW,+BAAyC;oBACpD,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,aAAa;iBACb,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;QAEH,gBAAgB,CAAC,KAAK,IAAI,EAAE;YAC3B,IAAI,EAAgD,CAAC;YAErD,wEAAwE;YACxE,IAAI;gBACH,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEvD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;gBAC5E,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC1D,mDAAmD;gBACnD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,UAAU,CAC1C,WAAW,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAC1E,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;aACvB;YAAC,OAAO,KAAU,EAAE;gBACpB,IAAI,CAAC,MAAM,CAAC,cAAc,CACzB;oBACC,SAAS,yEAAsD;iBAC/D,EACD,KAAK,CACL,CAAC;aACF;oBAAS;gBACT,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;aACZ;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,IAAgB;QAC1C,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,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,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;IAEM,KAAK,CAAC,GAAG,CAAC,UAAuB;QACvC,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;YAChC,SAAS,EAAE,kBAAkB;YAC7B,QAAQ,EAAE,UAAU,KAAK,SAAS;YAClC,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;SACvC,CAAC,CAAC;QAEH,6GAA6G;QAC7G,+DAA+D;QAC/D,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAuB;QACrD,IAAI,EAAgD,CAAC;QACrD,IAAI;YACH,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAE5C,EAAE,GAAG,MAAM,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEvD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YAE5D,IAAI,CAAC,KAAK,EAAE;gBACX,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,qEAAqE;YACrE,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,EAAE;gBAC7C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,uEAAuD;oBAChE,WAAW,+BAAyC;iBACpD,CAAC,CAAC;gBAEH,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;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;gBAC7D,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;aACjB;YAED,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAAE,WAAW,CAAC,CAAC;YAC5E,4FAA4F;YAC5F,0EAA0E;YAC1E,WAAW,CAAC,KAAK;iBACf,GAAG,CAAC,GAAG,CAAC;iBACR,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC7B,wFAAwF;gBACxF,yFAAyF;gBACzF,mCAAmC;gBACnC,IACC,aAAa,KAAK,SAAS;oBAC3B,aAAa,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;oBACnD,CAAC,aAAa,CAAC,gBAAgB,KAAK,SAAS;wBAC5C,aAAa,CAAC,gBAAgB,GAAG,WAAW,CAAC,EAC7C;oBACD,MAAM,WAAW,CAAC,KAAK,CAAC,GAAG,iCACrB,aAAa,KAAE,gBAAgB,EAAE,WAAW,KACjD,GAAG,CACH,CAAC;iBACF;gBACD,MAAM,WAAW,CAAC,IAAI,CAAC;gBAEvB,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;YAEvD,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,EAAE,CAAC,GAAG,CACX,0BAA0B,EAC1B;gBACC,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;aAC7B,EACD,mBAAmB,CAAC,KAAK,CAAC,CAC1B,CAAC;YAEF,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\tFluidCacheErrorEvent,\n\tFluidCacheEventSubCategories,\n\tFluidCacheGenericEvent,\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\tindexedDB: number | undefined;\n}\n\nexport interface FluidCacheConfig {\n\t/**\n\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t * Null can be used to explicity indicate no partitioning, and has been chosen\n\t * vs undefined so that it is clear this is an intentional choice by the caller.\n\t * A null value should only be used when the host can ensure that the cache is not able\n\t * to be shared with multiple users.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpartitionKey: string | null;\n\n\t/**\n\t * A logger that can be used to get insight into cache performance and errors\n\t */\n\tlogger?: ITelemetryBaseLogger;\n\n\t/**\n\t * A value in milliseconds that determines the maximum age of a cache entry to return.\n\t * If an entry exists in the cache, but is older than this value, the cached value will not be returned.\n\t */\n\tmaxCacheItemAge: 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\tprivate readonly logger: ITelemetryLogger;\n\n\tprivate readonly partitionKey: string | null;\n\n\tprivate readonly maxCacheItemAge: number;\n\n\tconstructor(config: FluidCacheConfig) {\n\t\tthis.logger = ChildLogger.create(config.logger);\n\t\tthis.partitionKey = config.partitionKey;\n\t\tthis.maxCacheItemAge = config.maxCacheItemAge;\n\n\t\tscheduleIdleTask(async () => {\n\t\t\t// Log how much storage space is currently being used by indexed db.\n\t\t\t// NOTE: This API is not supported in all browsers and it doesn't let you see the size of a specific DB.\n\t\t\t// Exception added when eslint rule was added, this should be revisited when modifying this code\n\t\t\tif (navigator.storage?.estimate) {\n\t\t\t\tconst estimate = await navigator.storage.estimate();\n\n\t\t\t\t// Some browsers have a usageDetails property that will tell you\n\t\t\t\t// more detailed information on how the storage is being used\n\t\t\t\tlet indexedDBSize: number | undefined;\n\t\t\t\tif (\"usageDetails\" in estimate) {\n\t\t\t\t\tindexedDBSize = ((estimate as any).usageDetails as StorageQuotaUsageDetails)\n\t\t\t\t\t\t.indexedDB;\n\t\t\t\t}\n\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCacheStorageInfo,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t\tquota: estimate.quota,\n\t\t\t\t\tusage: estimate.usage,\n\t\t\t\t\tindexedDBSize,\n\t\t\t\t});\n\t\t\t}\n\t\t});\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\t\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t\tconst index = transaction.store.index(\"lastAccessTimeMs\");\n\t\t\t\t// Get items that have not been accessed in 4 weeks\n\t\t\t\tconst keysToDelete = await index.getAllKeys(\n\t\t\t\t\tIDBKeyRange.upperBound(new Date().getTime() - 4 * 7 * 24 * 60 * 60 * 1000),\n\t\t\t\t);\n\n\t\t\t\tawait Promise.all(keysToDelete.map((key) => transaction.store.delete(key)));\n\t\t\t\tawait transaction.done;\n\t\t\t} catch (error: any) {\n\t\t\t\tthis.logger.sendErrorEvent(\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldEntriesError,\n\t\t\t\t\t},\n\t\t\t\t\terror,\n\t\t\t\t);\n\t\t\t} finally {\n\t\t\t\tdb?.close();\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic async removeEntries(file: IFileEntry): Promise<void> {\n\t\tlet db: IDBPDatabase<FluidCacheDBSchema> | undefined;\n\t\ttry {\n\t\t\tdb = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\tconst index = transaction.store.index(\"fileId\");\n\n\t\t\tconst 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\tpublic async get(cacheEntry: ICacheEntry): Promise<any> {\n\t\tconst startTime = performance.now();\n\n\t\tconst cachedItem = await this.getItemFromCache(cacheEntry);\n\n\t\tthis.logger.sendPerformanceEvent({\n\t\t\teventName: \"FluidCacheAccess\",\n\t\t\tcacheHit: cachedItem !== undefined,\n\t\t\ttype: cacheEntry.type,\n\t\t\tduration: performance.now() - startTime,\n\t\t});\n\n\t\t// Value will contain metadata like the expiry time, we just want to return the object we were asked to cache\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn cachedItem?.cachedObject;\n\t}\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\t\t\tdb = await getFluidCacheIndexedDbInstance(this.logger);\n\n\t\t\tconst 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\t\t\t// If the data does not come from the same partition, don't return it\n\t\t\tif (value.partitionKey !== this.partitionKey) {\n\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\teventName: FluidCacheGenericEvent.FluidCachePartitionKeyMismatch,\n\t\t\t\t\tsubCategory: FluidCacheEventSubCategories.FluidCache,\n\t\t\t\t});\n\n\t\t\t\tdb.close();\n\t\t\t\treturn undefined;\n\t\t\t}\n\n\t\t\tconst 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\t\t\tconst transaction = db.transaction(FluidDriverObjectStoreName, \"readwrite\");\n\t\t\t// We don't want to block the get return of this function on updating the last accessed time\n\t\t\t// We catch this promise because there is no user bad if this is rejected.\n\t\t\ttransaction.store\n\t\t\t\t.get(key)\n\t\t\t\t.then(async (valueToUpdate) => {\n\t\t\t\t\t// This value in the database could have been updated concurrently by other tabs/iframes\n\t\t\t\t\t// since we first read it. Only update the last accessed time if the current value in the\n\t\t\t\t\t// DB was the same one we returned.\n\t\t\t\t\tif (\n\t\t\t\t\t\tvalueToUpdate !== undefined &&\n\t\t\t\t\t\tvalueToUpdate.createdTimeMs === value.createdTimeMs &&\n\t\t\t\t\t\t(valueToUpdate.lastAccessTimeMs === undefined ||\n\t\t\t\t\t\t\tvalueToUpdate.lastAccessTimeMs < currentTime)\n\t\t\t\t\t) {\n\t\t\t\t\t\tawait transaction.store.put(\n\t\t\t\t\t\t\t{ ...valueToUpdate, lastAccessTimeMs: currentTime },\n\t\t\t\t\t\t\tkey,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t\tawait 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\t\t\tconst currentTime = new Date().getTime();\n\n\t\t\tawait db.put(\n\t\t\t\tFluidDriverObjectStoreName,\n\t\t\t\t{\n\t\t\t\t\tcachedObject: value,\n\t\t\t\t\tfileId: entry.file.docId,\n\t\t\t\t\ttype: entry.type,\n\t\t\t\t\tcacheItemId: entry.key,\n\t\t\t\t\tpartitionKey: this.partitionKey,\n\t\t\t\t\tcreatedTimeMs: currentTime,\n\t\t\t\t\tlastAccessTimeMs: currentTime,\n\t\t\t\t},\n\t\t\t\tgetKeyForCacheEntry(entry),\n\t\t\t);\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,CAAA;CAAE,CAGpE,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,UAErD;AAED,wBAAgB,8BAA8B,CAC7C,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAwC3C;AAID,wBAAgB,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IACnD,CAAC,0BAA0B,CAAC,EAAE;QAC7B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE;YACN;;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;SACzB,CAAC;QAEF,OAAO,EAAE;YACR,aAAa,EAAE,MAAM,CAAC;YACtB,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;KACF,CAAC;CACF"}
+{"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,CAAA;CAAE,CAGpE,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,UAErD;AAED,wBAAgB,8BAA8B,CAC7C,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAwC3C;AAID,wBAAgB,+BAA+B,CAC9C,iBAAiB,CAAC,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IACnD,CAAC,0BAA0B,CAAC,EAAE;QAC7B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE;YACN;;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;SACzB,CAAC;QAEF,OAAO,EAAE;YACR,aAAa,EAAE,MAAM,CAAC;YACtB,YAAY,EAAE,MAAM,CAAC;YACrB,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC;SACf,CAAC;KACF,CAAC;CACF"}

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,GAAuC;IACxE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACpB,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC7C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,CAAqB,sBAAsB,EAAE,mBAAmB,EAAE;YACvE,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBAC3B,IAAI;oBACH,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE;wBAClB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;qBAC3C;iBACD;gBAAC,OAAO,KAAU,EAAE;oBACpB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CACxC;wBACC,SAAS,+DAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;iBACF;gBAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;gBAC1E,gBAAgB,CAAC,WAAW,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;gBAC/D,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACrE,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;gBAC7D,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,MAAM,CACL,IAAI,KAAK,CACR,+EAA+E,CAC/E,CACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,mCAAmC;AACnC,+FAA+F;AAC/F,MAAM,UAAU,+BAA+B;IAC9C,OAAO,QAAQ,CAAC,sBAAsB,CAAC,CAAC;AACzC,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\t1: \"diverStorage\",\n\t2: \"diverStorage.V2\",\n};\n\nexport function getKeyForCacheEntry(entry: ICacheEntry) {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n\nexport function getFluidCacheIndexedDbInstance(\n\tlogger?: ITelemetryBaseLogger,\n): Promise<IDBPDatabase<FluidCacheDBSchema>> {\n\treturn new Promise((resolve, reject) => {\n\t\topenDB<FluidCacheDBSchema>(FluidDriverCacheDBName, CurrentCacheVersion, {\n\t\t\tupgrade: (db, oldVersion) => {\n\t\t\t\ttry {\n\t\t\t\t\t// We changed the format of the object store, so we must\n\t\t\t\t\t// delete the old stores to create a new one in V3\n\t\t\t\t\tconst cacheToDelete = oldVersionNameMapping[oldVersion];\n\t\t\t\t\tif (cacheToDelete) {\n\t\t\t\t\t\t// We don't include the old object stores in the schema, so we need to\n\t\t\t\t\t\t// use a typecast here to prevent IDB from complaining\n\t\t\t\t\t\tdb.deleteObjectStore(cacheToDelete as any);\n\t\t\t\t\t}\n\t\t\t\t} catch (error: any) {\n\t\t\t\t\t// Catch any error done when attempting to delete the older version.\n\t\t\t\t\t// If the object does not exist db will throw.\n\t\t\t\t\t// We can now assume that the old version is no longer there regardless.\n\t\t\t\t\tChildLogger.create(logger).sendErrorEvent(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldDbError,\n\t\t\t\t\t\t},\n\t\t\t\t\t\terror,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tconst cacheObjectStore = db.createObjectStore(FluidDriverObjectStoreName);\n\t\t\t\tcacheObjectStore.createIndex(\"createdTimeMs\", \"createdTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"lastAccessTimeMs\", \"lastAccessTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"partitionKey\", \"partitionKey\");\n\t\t\t\tcacheObjectStore.createIndex(\"fileId\", \"fileId\");\n\t\t\t},\n\t\t\tblocked: () => {\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\n\t\t\t\t\t\t\"Could not open DB since it is blocked by an older client that has the DB open\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t},\n\t\t}).then(resolve, reject);\n\t});\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\treturn deleteDB(FluidDriverCacheDBName);\n}\n\n/**\n * Schema for the object store used to cache driver information\n */\nexport interface FluidCacheDBSchema extends DBSchema {\n\t[FluidDriverObjectStoreName]: {\n\t\t/**\n\t\t * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId\n\t\t */\n\t\tkey: string;\n\n\t\tvalue: {\n\t\t\t/**\n\t\t\t * The identifier of the file associated with the cache entry\n\t\t\t */\n\t\t\tfileId: string;\n\n\t\t\t/**\n\t\t\t * Describes the type of content being cached, such as snapshot\n\t\t\t */\n\t\t\ttype: string;\n\n\t\t\t/**\n\t\t\t * Files may have multiple cached items associated with them,\n\t\t\t * this property uniquely identifies a specific cache entry for a file.\n\t\t\t * This is not globally unique, but rather a unique id for this file\n\t\t\t */\n\t\t\tcacheItemId: string;\n\n\t\t\t/*\n\t\t\t * Opaque object that the driver asks us to store in a cache for performance reasons\n\t\t\t */\n\t\t\tcachedObject: any;\n\n\t\t\t/**\n\t\t\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t\t\t * Null can be used to explicity indicate no partitioning.\n\t\t\t */\n\t\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\t\tpartitionKey: string | null;\n\n\t\t\t/**\n\t\t\t * The time when the cache entry was put into the cache\n\t\t\t */\n\t\t\tcreatedTimeMs: number;\n\n\t\t\t/**\n\t\t\t * The last time the cache entry was used.\n\t\t\t * This is initially set to the time the cache entry was created Measured as ms since unix epoch.\n\t\t\t */\n\t\t\tlastAccessTimeMs: number;\n\t\t};\n\n\t\tindexes: {\n\t\t\tcreatedTimeMs: number;\n\t\t\tpartitionKey: string;\n\t\t\tlastAccessTimeMs: number;\n\t\t\tfileId: string;\n\t\t};\n\t};\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,GAAuC;IACxE,CAAC,EAAE,cAAc;IACjB,CAAC,EAAE,iBAAiB;CACpB,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC7C,MAA6B;IAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,CAAqB,sBAAsB,EAAE,mBAAmB,EAAE;YACvE,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE;gBAC3B,IAAI;oBACH,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE;wBAClB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;qBAC3C;iBACD;gBAAC,OAAO,KAAU,EAAE;oBACpB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CACxC;wBACC,SAAS,+DAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;iBACF;gBAED,MAAM,gBAAgB,GAAG,EAAE,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;gBAC1E,gBAAgB,CAAC,WAAW,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;gBAC/D,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;gBACrE,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;gBAC7D,gBAAgB,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;gBACb,MAAM,CACL,IAAI,KAAK,CACR,+EAA+E,CAC/E,CACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACJ,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\t1: \"diverStorage\",\n\t2: \"diverStorage.V2\",\n};\n\nexport function getKeyForCacheEntry(entry: ICacheEntry) {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n\nexport function getFluidCacheIndexedDbInstance(\n\tlogger?: ITelemetryBaseLogger,\n): Promise<IDBPDatabase<FluidCacheDBSchema>> {\n\treturn new Promise((resolve, reject) => {\n\t\topenDB<FluidCacheDBSchema>(FluidDriverCacheDBName, CurrentCacheVersion, {\n\t\t\tupgrade: (db, oldVersion) => {\n\t\t\t\ttry {\n\t\t\t\t\t// We changed the format of the object store, so we must\n\t\t\t\t\t// delete the old stores to create a new one in V3\n\t\t\t\t\tconst cacheToDelete = oldVersionNameMapping[oldVersion];\n\t\t\t\t\tif (cacheToDelete) {\n\t\t\t\t\t\t// We don't include the old object stores in the schema, so we need to\n\t\t\t\t\t\t// use a typecast here to prevent IDB from complaining\n\t\t\t\t\t\tdb.deleteObjectStore(cacheToDelete as any);\n\t\t\t\t\t}\n\t\t\t\t} catch (error: any) {\n\t\t\t\t\t// Catch any error done when attempting to delete the older version.\n\t\t\t\t\t// If the object does not exist db will throw.\n\t\t\t\t\t// We can now assume that the old version is no longer there regardless.\n\t\t\t\t\tChildLogger.create(logger).sendErrorEvent(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\teventName: FluidCacheErrorEvent.FluidCacheDeleteOldDbError,\n\t\t\t\t\t\t},\n\t\t\t\t\t\terror,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tconst cacheObjectStore = db.createObjectStore(FluidDriverObjectStoreName);\n\t\t\t\tcacheObjectStore.createIndex(\"createdTimeMs\", \"createdTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"lastAccessTimeMs\", \"lastAccessTimeMs\");\n\t\t\t\tcacheObjectStore.createIndex(\"partitionKey\", \"partitionKey\");\n\t\t\t\tcacheObjectStore.createIndex(\"fileId\", \"fileId\");\n\t\t\t},\n\t\t\tblocked: () => {\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\n\t\t\t\t\t\t\"Could not open DB since it is blocked by an older client that has the DB open\",\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t},\n\t\t}).then(resolve, reject);\n\t});\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\t[FluidDriverObjectStoreName]: {\n\t\t/**\n\t\t * A unique identifier for an item in the cache. It is a combination of file, type, and cacheItemId\n\t\t */\n\t\tkey: string;\n\n\t\tvalue: {\n\t\t\t/**\n\t\t\t * The identifier of the file associated with the cache entry\n\t\t\t */\n\t\t\tfileId: string;\n\n\t\t\t/**\n\t\t\t * Describes the type of content being cached, such as snapshot\n\t\t\t */\n\t\t\ttype: string;\n\n\t\t\t/**\n\t\t\t * Files may have multiple cached items associated with them,\n\t\t\t * this property uniquely identifies a specific cache entry for a file.\n\t\t\t * This is not globally unique, but rather a unique id for this file\n\t\t\t */\n\t\t\tcacheItemId: string;\n\n\t\t\t/*\n\t\t\t * Opaque object that the driver asks us to store in a cache for performance reasons\n\t\t\t */\n\t\t\tcachedObject: any;\n\n\t\t\t/**\n\t\t\t * A string to specify what partition of the cache you wish to use (e.g. a user id).\n\t\t\t * Null can be used to explicity indicate no partitioning.\n\t\t\t */\n\t\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\t\tpartitionKey: string | null;\n\n\t\t\t/**\n\t\t\t * The time when the cache entry was put into the cache\n\t\t\t */\n\t\t\tcreatedTimeMs: number;\n\n\t\t\t/**\n\t\t\t * The last time the cache entry was used.\n\t\t\t * This is initially set to the time the cache entry was created Measured as ms since unix epoch.\n\t\t\t */\n\t\t\tlastAccessTimeMs: number;\n\t\t};\n\n\t\tindexes: {\n\t\t\tcreatedTimeMs: number;\n\t\t\tpartitionKey: string;\n\t\t\tlastAccessTimeMs: number;\n\t\t\tfileId: string;\n\t\t};\n\t};\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.1.0";
+export declare const pkgVersion = "2.0.0-internal.3.2.1";
 //# 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.1.0";
+export const pkgVersion = "2.0.0-internal.3.2.1";
 //# 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.1.0\";\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.2.1\";\n"]}

package/package.json

@@ -1,73 +1,73 @@
 {
-	"name": "@fluidframework/driver-web-cache",
-	"version": "2.0.0-internal.3.1.0",
-	"description": "Implementation of the driver caching API for a web browser",
-	"homepage": "https://fluidframework.com",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/microsoft/FluidFramework.git",
-		"directory": "packages/drivers/driver-web-cache"
-	},
-	"license": "MIT",
-	"author": "Microsoft and contributors",
-	"sideEffects": false,
-	"main": "dist/index.js",
-	"module": "lib/index.js",
-	"types": "dist/index.d.ts",
-	"scripts": {
-		"build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-		"build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-		"build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-		"build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-		"build:esnext": "tsc --project ./tsconfig.esnext.json",
-		"build:full": "npm run build",
-		"build:full:compile": "npm run build:compile",
-		"build:genver": "gen-version",
-		"build:test": "tsc --project ./src/test/tsconfig.json",
-		"ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-		"clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-		"eslint": "eslint --format stylish src",
-		"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-		"format": "npm run prettier:fix",
-		"lint": "npm run prettier && npm run eslint",
-		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
-		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-		"test": "jest",
-		"tsc": "tsc",
-		"typetests:gen": "flub generate typetests --generate --dir .",
-		"typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-	},
-	"dependencies": {
-		"@fluidframework/common-definitions": "^0.20.1",
-		"@fluidframework/odsp-driver-definitions": ">=2.0.0-internal.3.1.0 <2.0.0-internal.4.0.0",
-		"@fluidframework/telemetry-utils": ">=2.0.0-internal.3.1.0 <2.0.0-internal.4.0.0",
-		"idb": "^6.1.2"
-	},
-	"devDependencies": {
-		"@fluid-tools/build-cli": "^0.9.0",
-		"@fluidframework/build-common": "^1.1.0",
-		"@fluidframework/build-tools": "^0.9.0",
-		"@fluidframework/driver-web-cache-previous": "npm:@fluidframework/driver-web-cache@2.0.0-internal.3.0.0",
-		"@fluidframework/eslint-config-fluid": "^2.0.0",
-		"@microsoft/api-extractor": "^7.22.2",
-		"@rushstack/eslint-config": "^2.5.1",
-		"@types/jest": "22.2.3",
-		"@types/node": "^14.18.36",
-		"concurrently": "^6.2.0",
-		"copyfiles": "^2.4.1",
-		"eslint": "~8.6.0",
-		"fake-indexeddb": "3.1.4",
-		"jest": "^26.6.3",
-		"prettier": "~2.6.2",
-		"rimraf": "^2.6.2",
-		"typescript": "~4.5.5"
-	},
-	"typeValidation": {
-		"version": "2.0.0-internal.3.1.0",
-		"previousVersionStyle": "~previousMinor",
-		"baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
-		"baselineVersion": "2.0.0-internal.3.0.0",
-		"broken": {}
-	}
-}
+  "name": "@fluidframework/driver-web-cache",
+  "version": "2.0.0-internal.3.2.1",
+  "description": "Implementation of the driver caching API for a web browser",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/drivers/driver-web-cache"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@fluidframework/common-definitions": "^0.20.1",
+    "@fluidframework/odsp-driver-definitions": ">=2.0.0-internal.3.2.1 <2.0.0-internal.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.2.1 <2.0.0-internal.4.0.0",
+    "idb": "^6.1.2"
+  },
+  "devDependencies": {
+    "@fluid-tools/build-cli": "^0.10.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.10.0",
+    "@fluidframework/driver-web-cache-previous": "npm:@fluidframework/driver-web-cache@2.0.0-internal.3.1.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@microsoft/api-extractor": "^7.22.2",
+    "@rushstack/eslint-config": "^2.5.1",
+    "@types/jest": "22.2.3",
+    "@types/node": "^14.18.36",
+    "concurrently": "^6.2.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.6.0",
+    "fake-indexeddb": "3.1.4",
+    "jest": "^26.6.3",
+    "prettier": "~2.6.2",
+    "rimraf": "^2.6.2",
+    "typescript": "~4.5.5"
+  },
+  "typeValidation": {
+    "version": "2.0.0-internal.3.2.0",
+    "previousVersionStyle": "~previousMinor",
+    "baselineRange": ">=2.0.0-internal.3.1.0 <2.0.0-internal.3.2.0",
+    "baselineVersion": "2.0.0-internal.3.1.0",
+    "broken": {}
+  },
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "jest",
+    "tsc": "tsc",
+    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  }
+}

package/src/FluidCache.ts

@@ -2,13 +2,14 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-
+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,
+	FluidCacheDBSchema,
 	FluidDriverObjectStoreName,
 	getKeyForCacheEntry,
 } from "./FluidCacheIndexedDb";
@@ -88,9 +89,11 @@ export class FluidCache implements IPersistedCache {
 		});
 
 		scheduleIdleTask(async () => {
+			let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
+
 			// 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");
@@ -108,13 +111,16 @@ export class FluidCache implements IPersistedCache {
 					},
 					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, "readwrite");
 			const index = transaction.store.index("fileId");
@@ -130,6 +136,8 @@ export class FluidCache implements IPersistedCache {
 				},
 				error,
 			);
+		} finally {
+			db?.close();
 		}
 	}
 
@@ -151,14 +159,16 @@ export class FluidCache implements IPersistedCache {
 	}
 
 	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) {
+				db.close();
 				return undefined;
 			}
 
@@ -169,6 +179,7 @@ export class FluidCache implements IPersistedCache {
 					subCategory: FluidCacheEventSubCategories.FluidCache,
 				});
 
+				db.close();
 				return undefined;
 			}
 
@@ -176,6 +187,7 @@ export class FluidCache implements IPersistedCache {
 
 			// 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;
 			}
 
@@ -201,9 +213,11 @@ export class FluidCache implements IPersistedCache {
 					}
 					await transaction.done;
 
-					db.close();
+					db?.close();
 				})
-				.catch(() => {});
+				.catch(() => {
+					db?.close();
+				});
 			return value;
 		} catch (error: any) {
 			// We can fail to open the db for a variety of reasons,
@@ -213,12 +227,15 @@ export class FluidCache implements IPersistedCache {
 				error,
 			);
 			return undefined;
+		} finally {
+			db?.close();
 		}
 	}
 
 	public async put(entry: ICacheEntry, value: any): Promise<void> {
+		let db: IDBPDatabase<FluidCacheDBSchema> | undefined;
 		try {
-			const db = await getFluidCacheIndexedDbInstance(this.logger);
+			db = await getFluidCacheIndexedDbInstance(this.logger);
 
 			const currentTime = new Date().getTime();
 
@@ -244,6 +261,8 @@ export class FluidCache implements IPersistedCache {
 				{ 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";
@@ -73,8 +73,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.1.0";
+export const pkgVersion = "2.0.0-internal.3.2.1";