@fluidframework/driver-web-cache 0.58.2000-58133

package/.eslintrc.js

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    extends: ["@fluidframework/eslint-config-fluid"],
+    parserOptions: {
+        project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+    },
+    rules: {
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/strict-boolean-expressions": "off",
+        "no-null/no-null": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "@typescript-eslint/no-misused-promises": "off",
+    },
+};

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# @fluidframework/driver-web-cache
+
+This package provides an implementation of the `IPersistedCache` interface in the odsp-driver package. This cache enables
+storing of user content on the user's machine in order to provide faster boot experiences when opening the same Fluid
+containers more than once. This implementation has a dependency on indexeddb, so it is intended to only be used in a browser
+context.
+
+## Usage
+
+```typescript
+import { FluidCache } from '@fluidframework/driver-web-cache';
+
+new FluidCache({
+          partitionKey: userId,
+          logger,
+          maxCacheItemAge
+        })
+```
+
+### Parameters
+
+- `partitionKey` - Used to determine what partition of the cache is being used, and can prevent multiple users on the
+   same machine from sharing a snapshot cache. If you absolutely know that users will not share the cache,
+   can also be set to `null`. Currently optional, but is proposed to be required in the next major bump.
+   The recommendation is to use this key to differentiate users for the cache data.
+- `logger` - An optional implementation of the logger contract where diagnostic data  can be logged.
+- `maxCacheItemAge` - The cache tracks a timestamp with each entry. This flag specifies the maximum age (in milliseconds)
+   for a cache entry to be used. This flag does not control when cached content is deleted since different scenarios and
+   applications may have different staleness thresholds for the same data.
+
+## Clearing cache entries
+
+Whenever any Fluid content is loaded with the web cache enabled, a task is scheduled to clear out all "stale" cache
+entries. This task is scheduled with the `setIdleCallback` browser API. We define stale cache entries as any cache
+entries that have not been used (read or written to) within the last 4 weeks. The cache is cleared of all stale cache
+entries corresponding to all documents, not just the ones corresponding to the Fluid document being loaded.
+
+The `deleteFluidCacheIndexDbInstance` API that an application can use to clear out the entire contents of the snapshot
+cache at any time. We recommend calling this API when the user explicitly signs out. Hosting applications
+are on point for ensuring responsible usage of the snapshot caching capability to still meet any relevant
+customer promises, such as clearing out storage when appropriate or disabling snapshot caching under certain circumstances,
+such as when it is known the user is logged in to a public computer.
+
+
+```typescript
+import { deleteFluidCacheIndexDbInstance } from '@fluidframework/driver-web-cache';
+
+  // We put a catch here because Firefox Incognito will throw an error here. This is why we claim this method is a "best effort", since sometimes the browser won't let us access storage
+deleteFluidCacheIndexDbInstance().catch(() => {});
+```
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks
+or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+}

package/dist/FluidCache.d.ts

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

package/dist/FluidCache.d.ts.map

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

package/dist/FluidCache.js

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

package/dist/FluidCache.js.map

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

package/dist/FluidCacheIndexedDb.d.ts

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

package/dist/FluidCacheIndexedDb.d.ts.map

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

package/dist/FluidCacheIndexedDb.js

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

package/dist/FluidCacheIndexedDb.js.map

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

package/dist/fluidCacheTelemetry.d.ts

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

package/dist/fluidCacheTelemetry.d.ts.map

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

package/dist/fluidCacheTelemetry.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fluidCacheTelemetry.js.map

package/dist/fluidCacheTelemetry.js.map

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

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteFluidCacheIndexDbInstance = void 0;
+__exportStar(require("./FluidCache"), exports);
+var FluidCacheIndexedDb_1 = require("./FluidCacheIndexedDb");
+Object.defineProperty(exports, "deleteFluidCacheIndexDbInstance", { enumerable: true, get: function () { return FluidCacheIndexedDb_1.deleteFluidCacheIndexDbInstance; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.d.ts.map

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

package/dist/packageVersion.js

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pkgVersion = exports.pkgName = void 0;
+exports.pkgName = "@fluidframework/driver-web-cache";
+exports.pkgVersion = "0.58.2000-58133";
+//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -0,0 +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,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-web-cache\";\nexport const pkgVersion = \"0.58.2000-58133\";\n"]}

package/dist/scheduleIdleTask.d.ts

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