@fluidframework/driver-web-cache 2.61.0-355656 → 2.61.0-355934
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/FluidCacheIndexedDb.d.ts.map +1 -1
- package/dist/FluidCacheIndexedDb.js +4 -3
- package/dist/FluidCacheIndexedDb.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/lib/FluidCacheIndexedDb.d.ts.map +1 -1
- package/lib/FluidCacheIndexedDb.js +2 -1
- package/lib/FluidCacheIndexedDb.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/package.json +7 -7
- package/src/FluidCacheIndexedDb.ts +5 -2
- package/src/packageVersion.ts +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,
|
|
1
|
+
{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EACN,WAAW,EAEX,MAAM,kDAAkD,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAoB,MAAM,KAAK,CAAC;AAKlF,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;AAED;;;;;GAKG;AACH,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;;;;;eAKG;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"}
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.deleteFluidCacheIndexDbInstance = exports.getFluidCacheIndexedDbInstance = exports.getKeyForCacheEntry = exports.oldVersionNameMapping = exports.CurrentCacheVersion = exports.FluidDriverObjectStoreName = exports.FluidDriverCacheDBName = void 0;
|
|
8
|
-
const internal_1 = require("@fluidframework/
|
|
8
|
+
const internal_1 = require("@fluidframework/odsp-driver-definitions/internal");
|
|
9
|
+
const internal_2 = require("@fluidframework/telemetry-utils/internal");
|
|
9
10
|
const idb_1 = require("idb");
|
|
10
11
|
// The name of the database that we use for caching Fluid info.
|
|
11
12
|
exports.FluidDriverCacheDBName = "fluidDriverCache";
|
|
@@ -18,7 +19,7 @@ exports.oldVersionNameMapping = {
|
|
|
18
19
|
2: "diverStorage.V2",
|
|
19
20
|
};
|
|
20
21
|
function getKeyForCacheEntry(entry) {
|
|
21
|
-
return
|
|
22
|
+
return (0, internal_1.getKeyForCacheEntry)(entry);
|
|
22
23
|
}
|
|
23
24
|
exports.getKeyForCacheEntry = getKeyForCacheEntry;
|
|
24
25
|
function getFluidCacheIndexedDbInstance(logger) {
|
|
@@ -39,7 +40,7 @@ function getFluidCacheIndexedDbInstance(logger) {
|
|
|
39
40
|
// Catch any error done when attempting to delete the older version.
|
|
40
41
|
// If the object does not exist db will throw.
|
|
41
42
|
// We can now assume that the old version is no longer there regardless.
|
|
42
|
-
(0,
|
|
43
|
+
(0, internal_2.createChildLogger)({ logger }).sendErrorEvent({
|
|
43
44
|
eventName: "FluidCacheDeleteOldDbError" /* FluidCacheErrorEvent.FluidCacheDeleteOldDbError */,
|
|
44
45
|
}, error);
|
|
45
46
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+EAG0D;AAC1D,uEAA6E;AAC7E,6BAAkF;AAIlF,+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,IAAA,8BAAuB,EAAC,KAAK,CAAC,CAAC;AACvC,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,CAAC;oBACJ,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,6BAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE,CAAC;wBACnB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;oBAC5C,CAAC;gBACF,CAAC;gBAAC,OAAO,KAAU,EAAE,CAAC;oBACrB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,IAAA,4BAAiB,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,cAAc,CAC3C;wBACC,SAAS,oFAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;gBACH,CAAC;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;;;;;GAKG;AACH,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 { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tICacheEntry,\n\tgetKeyForCacheEntry as odspGetKeyForCacheEntry,\n} from \"@fluidframework/odsp-driver-definitions/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\nimport { DBSchema, DeleteDBCallbacks, IDBPDatabase, deleteDB, openDB } from \"idb\";\n\nimport { FluidCacheErrorEvent } from \"./fluidCacheTelemetry.js\";\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 odspGetKeyForCacheEntry(entry);\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\tcreateChildLogger({ 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/**\n * Deletes the indexed DB instance.\n *\n * @remarks Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.\n * @legacy @beta\n */\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 * With the recent change, this won't be updated on read as it will not be used anywhere. Only keeping\n\t\t\t * so as to not upgrade the schema version.\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
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/driver-web-cache";
|
|
8
|
-
export declare const pkgVersion = "2.61.0-
|
|
8
|
+
export declare const pkgVersion = "2.61.0-355934";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
package/dist/packageVersion.js
CHANGED
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.pkgVersion = exports.pkgName = void 0;
|
|
10
10
|
exports.pkgName = "@fluidframework/driver-web-cache";
|
|
11
|
-
exports.pkgVersion = "2.61.0-
|
|
11
|
+
exports.pkgVersion = "2.61.0-355934";
|
|
12
12
|
//# sourceMappingURL=packageVersion.js.map
|
|
@@ -1 +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,eAAe,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.61.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,eAAe,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.61.0-355934\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,
|
|
1
|
+
{"version":3,"file":"FluidCacheIndexedDb.d.ts","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EACN,WAAW,EAEX,MAAM,kDAAkD,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAoB,MAAM,KAAK,CAAC;AAKlF,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;AAED;;;;;GAKG;AACH,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;;;;;eAKG;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"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
+
import { getKeyForCacheEntry as odspGetKeyForCacheEntry, } from "@fluidframework/odsp-driver-definitions/internal";
|
|
5
6
|
import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
|
|
6
7
|
import { deleteDB, openDB } from "idb";
|
|
7
8
|
// The name of the database that we use for caching Fluid info.
|
|
@@ -15,7 +16,7 @@ export const oldVersionNameMapping = {
|
|
|
15
16
|
2: "diverStorage.V2",
|
|
16
17
|
};
|
|
17
18
|
export function getKeyForCacheEntry(entry) {
|
|
18
|
-
return
|
|
19
|
+
return odspGetKeyForCacheEntry(entry);
|
|
19
20
|
}
|
|
20
21
|
export function getFluidCacheIndexedDbInstance(logger) {
|
|
21
22
|
return new Promise((resolve, reject) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"FluidCacheIndexedDb.js","sourceRoot":"","sources":["../src/FluidCacheIndexedDb.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,mBAAmB,IAAI,uBAAuB,GAC9C,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,EAA6C,QAAQ,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAIlF,+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,uBAAuB,CAAC,KAAK,CAAC,CAAC;AACvC,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,CAAC;oBACJ,wDAAwD;oBACxD,kDAAkD;oBAClD,MAAM,aAAa,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;oBACxD,IAAI,aAAa,EAAE,CAAC;wBACnB,sEAAsE;wBACtE,sDAAsD;wBACtD,EAAE,CAAC,iBAAiB,CAAC,aAAoB,CAAC,CAAC;oBAC5C,CAAC;gBACF,CAAC;gBAAC,OAAO,KAAU,EAAE,CAAC;oBACrB,oEAAoE;oBACpE,8CAA8C;oBAC9C,wEAAwE;oBACxE,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,cAAc,CAC3C;wBACC,SAAS,oFAAiD;qBAC1D,EACD,KAAK,CACL,CAAC;gBACH,CAAC;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;;;;;GAKG;AACH,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 { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tICacheEntry,\n\tgetKeyForCacheEntry as odspGetKeyForCacheEntry,\n} from \"@fluidframework/odsp-driver-definitions/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\nimport { DBSchema, DeleteDBCallbacks, IDBPDatabase, deleteDB, openDB } from \"idb\";\n\nimport { FluidCacheErrorEvent } from \"./fluidCacheTelemetry.js\";\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 odspGetKeyForCacheEntry(entry);\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\tcreateChildLogger({ 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/**\n * Deletes the indexed DB instance.\n *\n * @remarks Warning this can throw an error in Firefox incognito, where accessing storage is prohibited.\n * @legacy @beta\n */\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 * With the recent change, this won't be updated on read as it will not be used anywhere. Only keeping\n\t\t\t * so as to not upgrade the schema version.\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
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/driver-web-cache";
|
|
8
|
-
export declare const pkgVersion = "2.61.0-
|
|
8
|
+
export declare const pkgVersion = "2.61.0-355934";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
package/lib/packageVersion.js
CHANGED
|
@@ -1 +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,eAAe,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.61.0-
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,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.61.0-355934\";\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/driver-web-cache",
|
|
3
|
-
"version": "2.61.0-
|
|
3
|
+
"version": "2.61.0-355934",
|
|
4
4
|
"description": "Implementation of the driver caching API for a web browser",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -47,18 +47,18 @@
|
|
|
47
47
|
"main": "lib/index.js",
|
|
48
48
|
"types": "lib/public.d.ts",
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@fluidframework/core-interfaces": "2.61.0-
|
|
51
|
-
"@fluidframework/core-utils": "2.61.0-
|
|
52
|
-
"@fluidframework/odsp-driver-definitions": "2.61.0-
|
|
53
|
-
"@fluidframework/telemetry-utils": "2.61.0-
|
|
50
|
+
"@fluidframework/core-interfaces": "2.61.0-355934",
|
|
51
|
+
"@fluidframework/core-utils": "2.61.0-355934",
|
|
52
|
+
"@fluidframework/odsp-driver-definitions": "2.61.0-355934",
|
|
53
|
+
"@fluidframework/telemetry-utils": "2.61.0-355934",
|
|
54
54
|
"idb": "^6.1.2"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
58
58
|
"@biomejs/biome": "~1.9.3",
|
|
59
|
-
"@fluid-tools/build-cli": "^0.58.
|
|
59
|
+
"@fluid-tools/build-cli": "^0.58.3",
|
|
60
60
|
"@fluidframework/build-common": "^2.0.3",
|
|
61
|
-
"@fluidframework/build-tools": "^0.58.
|
|
61
|
+
"@fluidframework/build-tools": "^0.58.3",
|
|
62
62
|
"@fluidframework/driver-web-cache-previous": "npm:@fluidframework/driver-web-cache@2.60.0",
|
|
63
63
|
"@fluidframework/eslint-config-fluid": "^6.0.0",
|
|
64
64
|
"@microsoft/api-extractor": "7.52.11",
|
|
@@ -4,7 +4,10 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
|
|
7
|
-
import {
|
|
7
|
+
import {
|
|
8
|
+
ICacheEntry,
|
|
9
|
+
getKeyForCacheEntry as odspGetKeyForCacheEntry,
|
|
10
|
+
} from "@fluidframework/odsp-driver-definitions/internal";
|
|
8
11
|
import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
|
|
9
12
|
import { DBSchema, DeleteDBCallbacks, IDBPDatabase, deleteDB, openDB } from "idb";
|
|
10
13
|
|
|
@@ -25,7 +28,7 @@ export const oldVersionNameMapping: Partial<{ [key: number]: string }> = {
|
|
|
25
28
|
};
|
|
26
29
|
|
|
27
30
|
export function getKeyForCacheEntry(entry: ICacheEntry) {
|
|
28
|
-
return
|
|
31
|
+
return odspGetKeyForCacheEntry(entry);
|
|
29
32
|
}
|
|
30
33
|
|
|
31
34
|
export function getFluidCacheIndexedDbInstance(
|
package/src/packageVersion.ts
CHANGED