money-clip
Version:
For managing your client side cache. Tiny wrapper over IndexedDB supporting versioning and max age.
263 lines (251 loc) • 8.2 kB
JavaScript
/**
* https://bugs.webkit.org/show_bug.cgi?id=226547
* Safari has a horrible bug where IDB requests can hang while the browser is starting up.
* The only solution is to keep nudging it until it's awake.
* This probably creates garbage, but garbage is better than totally failing.
*/
function idbReady() {
const isSafari = !navigator.userAgentData &&
/Safari\//.test(navigator.userAgent) &&
!/Chrom(e|ium)\//.test(navigator.userAgent);
// No point putting other browsers or older versions of Safari through this mess.
if (!isSafari || !indexedDB.databases)
return Promise.resolve();
let intervalId;
return new Promise((resolve) => {
const tryIdb = () => indexedDB.databases().finally(resolve);
intervalId = setInterval(tryIdb, 100);
tryIdb();
}).finally(() => clearInterval(intervalId));
}
function promisifyRequest(request) {
return new Promise((resolve, reject) => {
// @ts-ignore - file size hacks
request.oncomplete = request.onsuccess = () => resolve(request.result);
// @ts-ignore - file size hacks
request.onabort = request.onerror = () => reject(request.error);
});
}
function createStore(dbName, storeName) {
const dbp = idbReady().then(() => {
const request = indexedDB.open(dbName);
request.onupgradeneeded = () => request.result.createObjectStore(storeName);
return promisifyRequest(request);
});
return (txMode, callback) => dbp.then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)));
}
let defaultGetStoreFunc;
function defaultGetStore() {
if (!defaultGetStoreFunc) {
defaultGetStoreFunc = createStore('keyval-store', 'keyval');
}
return defaultGetStoreFunc;
}
/**
* Get a value by its key.
*
* @param key
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function get$1(key, customStore = defaultGetStore()) {
return customStore('readonly', (store) => promisifyRequest(store.get(key)));
}
/**
* Set a value with a key.
*
* @param key
* @param value
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function set$1(key, value, customStore = defaultGetStore()) {
return customStore('readwrite', (store) => {
store.put(value, key);
return promisifyRequest(store.transaction);
});
}
/**
* Set multiple values at once. This is faster than calling set() multiple times.
* It's also atomic – if one of the pairs can't be added, none will be added.
*
* @param entries Array of entries, where each entry is an array of `[key, value]`.
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function setMany(entries, customStore = defaultGetStore()) {
return customStore('readwrite', (store) => {
entries.forEach((entry) => store.put(entry[1], entry[0]));
return promisifyRequest(store.transaction);
});
}
/**
* Get multiple values by their keys
*
* @param keys
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function getMany(keys, customStore = defaultGetStore()) {
return customStore('readonly', (store) => Promise.all(keys.map((key) => promisifyRequest(store.get(key)))));
}
/**
* Update a value. This lets you see the old value and update it as an atomic operation.
*
* @param key
* @param updater A callback that takes the old value and returns a new value.
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function update(key, updater, customStore = defaultGetStore()) {
return customStore('readwrite', (store) =>
// Need to create the promise manually.
// If I try to chain promises, the transaction closes in browsers
// that use a promise polyfill (IE10/11).
new Promise((resolve, reject) => {
store.get(key).onsuccess = function () {
try {
store.put(updater(this.result), key);
resolve(promisifyRequest(store.transaction));
}
catch (err) {
reject(err);
}
};
}));
}
/**
* Delete a particular key from the store.
*
* @param key
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function del(key, customStore = defaultGetStore()) {
return customStore('readwrite', (store) => {
store.delete(key);
return promisifyRequest(store.transaction);
});
}
/**
* Clear all values in the store.
*
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function clear(customStore = defaultGetStore()) {
return customStore('readwrite', (store) => {
store.clear();
return promisifyRequest(store.transaction);
});
}
function eachCursor(customStore, callback) {
return customStore('readonly', (store) => {
// This would be store.getAllKeys(), but it isn't supported by Edge or Safari.
// And openKeyCursor isn't supported by Safari.
store.openCursor().onsuccess = function () {
if (!this.result)
return;
callback(this.result);
this.result.continue();
};
return promisifyRequest(store.transaction);
});
}
/**
* Get all keys in the store.
*
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function keys(customStore = defaultGetStore()) {
const items = [];
return eachCursor(customStore, (cursor) => items.push(cursor.key)).then(() => items);
}
/**
* Get all values in the store.
*
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function values(customStore = defaultGetStore()) {
const items = [];
return eachCursor(customStore, (cursor) => items.push(cursor.value)).then(() => items);
}
/**
* Get all entries in the store. Each entry is an array of `[key, value]`.
*
* @param customStore Method to get a custom store. Use with caution (see the docs).
*/
function entries(customStore = defaultGetStore()) {
const items = [];
return eachCursor(customStore, (cursor) => items.push([cursor.key, cursor.value])).then(() => items);
}
var idbKeyVal = {
__proto__: null,
clear: clear,
createStore: createStore,
del: del,
entries: entries,
get: get$1,
getMany: getMany,
keys: keys,
promisifyRequest: promisifyRequest,
set: set$1,
setMany: setMany,
update: update,
values: values
};
const defaultOpts = {
maxAge: Infinity,
version: 0,
lib: idbKeyVal
};
const getOpts = passedOptions => Object.assign({}, defaultOpts, passedOptions);
const keyValLib = idbKeyVal;
const get = (key, opts, store) => {
const {
maxAge,
version,
lib
} = getOpts(opts);
return lib.get(key, store).then(JSON.parse).then(parsed => {
const age = Date.now() - parsed.time;
if (age > maxAge || version !== parsed.version) {
lib.del(key, store);
return null;
}
return parsed.data;
}).catch(() => null);
};
const set = (key, data, spec, store) => {
const {
lib,
version
} = getOpts(spec);
return lib.set(key, JSON.stringify({
version,
time: Date.now(),
data
}), store).catch(() => null);
};
const getAll = (spec, store) => {
const opts = getOpts(spec);
let keys;
return opts.lib.keys(store).then(retrievedKeys => {
keys = retrievedKeys;
return Promise.all(keys.map(key => get(key, opts, store)));
}).then(data => data.reduce((acc, bundleData, index) => {
if (bundleData) {
acc[keys[index]] = bundleData;
}
return acc;
}, {})).catch(() => {});
};
const getConfiguredCache = spec => {
const opts = getOpts(spec);
let store;
if (opts.name) {
store = createStore(opts.name, opts.name);
}
return {
get: key => get(key, opts, store),
set: (key, val) => set(key, val, opts, store),
getAll: () => getAll(opts, store),
del: key => opts.lib.del(key, store),
clear: () => opts.lib.clear(store),
keys: () => opts.lib.keys(store)
};
};
export { get, getAll, getConfiguredCache, keyValLib, set };