faastjs
Version:
Serverless batch computing made simple.
110 lines • 13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.caches = exports.PersistentCache = void 0;
const fs_extra_1 = require("fs-extra");
const os_1 = require("os");
const path_1 = require("path");
const uuid_1 = require("uuid");
/**
* A simple persistent key-value store. Used to implement {@link Limits.cache}
* for {@link throttle}.
* @remarks
* Entries can be expired, but are not actually deleted individually. The entire
* cache can be deleted at once. Hence this cache is useful for storing results
* that are expensive to compute but do not change too often (e.g. the
* node_modules folder from an 'npm install' where 'package.json' is not
* expected to change too often).
*
* By default faast.js will use the directory `~/.faastjs` as a local cache to
* store data such as pricing retrieved from cloud APIs, and garbage collection
* information. This directory can be safely deleted if no faast.js instances
* are running.
* @public
*/
class PersistentCache {
/**
* Construct a new persistent cache, typically used with {@link Limits} as
* part of the arguments to {@link throttle}.
* @param dirRelativeToHomeDir - The directory under the user's home
* directory that will be used to store cached values. The directory will be
* created if it doesn't exist.
* @param expiration - The age (in ms) after which a cached entry is
* invalid. Default: `24*3600*1000` (1 day).
*/
constructor(
/**
* The directory under the user's home directory that will be used to
* store cached values. The directory will be created if it doesn't
* exist.
*/
dirRelativeToHomeDir,
/**
* The age (in ms) after which a cached entry is invalid. Default:
* `24*3600*1000` (1 day).
*/
expiration = 24 * 3600 * 1000) {
this.dirRelativeToHomeDir = dirRelativeToHomeDir;
this.expiration = expiration;
this.dir = (0, path_1.join)((0, os_1.homedir)(), dirRelativeToHomeDir);
this.initialized = this.initialize(this.dir);
}
async initialize(dir) {
if (!(await (0, fs_extra_1.pathExists)(dir))) {
await (0, fs_extra_1.mkdirp)(dir);
}
}
/**
* Retrieves the value previously set for the given key, or undefined if the
* key is not found.
*/
async get(key) {
await this.initialized;
const entry = (0, path_1.join)(this.dir, key);
const statEntry = await (0, fs_extra_1.stat)(entry).catch(_ => { });
if (statEntry) {
if (Date.now() - statEntry.mtimeMs > this.expiration) {
return undefined;
}
return (0, fs_extra_1.readFile)(entry).catch(_ => undefined);
}
return undefined;
}
/**
* Set the cache key to the given value.
* @returns a Promise that resolves when the cache entry has been persisted.
*/
async set(key, value) {
await this.initialized;
const entry = (0, path_1.join)(this.dir, key);
const tmpEntry = (0, path_1.join)(this.dir, (0, uuid_1.v4)());
await (0, fs_extra_1.writeFile)(tmpEntry, value, { mode: 0o600, encoding: "binary" });
await (0, fs_extra_1.rename)(tmpEntry, entry);
}
/**
* Retrieve all keys stored in the cache, including expired entries.
*/
entries() {
return (0, fs_extra_1.readdir)(this.dir);
}
/**
* Deletes all cached entries from disk.
* @param leaveEmptyDir - If true, leave the cache directory in place after
* deleting its contents. If false, the cache directory will be removed.
* Default: `true`.
*/
async clear({ leaveEmptyDir = true } = {}) {
await this.initialized;
await (0, fs_extra_1.remove)(this.dir);
if (leaveEmptyDir) {
await (0, fs_extra_1.mkdirp)(this.dir);
}
}
}
exports.PersistentCache = PersistentCache;
const days = 24 * 3600 * 1000;
exports.caches = {
awsPrices: new PersistentCache(".faastjs/aws/pricing", 1 * days),
googlePrices: new PersistentCache(".faastjs/google/pricing", 1 * days),
awsGc: new PersistentCache(".faastjs/aws/gc", 7 * days)
};
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":";;;AAAA,uCASkB;AAClB,2BAA6B;AAC7B,+BAA4B;AAE5B,+BAAoC;AAIpC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,eAAe;IAcxB;;;;;;;;OAQG;IACH;IACI;;;;OAIG;IACM,oBAA4B;IACrC;;;OAGG;IACM,aAAqB,EAAE,GAAG,IAAI,GAAG,IAAI;QALrC,yBAAoB,GAApB,oBAAoB,CAAQ;QAK5B,eAAU,GAAV,UAAU,CAA2B;QAE9C,IAAI,CAAC,GAAG,GAAG,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,oBAAoB,CAAC,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAnCO,KAAK,CAAC,UAAU,CAAC,GAAW;QAChC,IAAI,CAAC,CAAC,MAAM,IAAA,qBAAU,EAAC,GAAG,CAAC,CAAC,EAAE;YAC1B,MAAM,IAAA,iBAAM,EAAC,GAAG,CAAC,CAAC;SACrB;IACL,CAAC;IAiCD;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW;QACjB,MAAM,IAAI,CAAC,WAAW,CAAC;QACvB,MAAM,KAAK,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAClC,MAAM,SAAS,GAAG,MAAM,IAAA,eAAI,EAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAE,CAAC,CAAC,CAAC;QACnD,IAAI,SAAS,EAAE;YACX,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE;gBAClD,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;SAChD;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAqD;QACxE,MAAM,IAAI,CAAC,WAAW,CAAC;QACvB,MAAM,KAAK,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,EAAE,IAAA,SAAM,GAAE,CAAC,CAAC;QAC1C,MAAM,IAAA,oBAAS,EAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,IAAA,iBAAM,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,OAAO;QACH,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,IAAI,EAAE,GAAG,EAAE;QACrC,MAAM,IAAI,CAAC,WAAW,CAAC;QAEvB,MAAM,IAAA,iBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEvB,IAAI,aAAa,EAAE;YACf,MAAM,IAAA,iBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC1B;IACL,CAAC;CACJ;AA3FD,0CA2FC;AAED,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjB,QAAA,MAAM,GAAG;IAClB,SAAS,EAAE,IAAI,eAAe,CAAC,sBAAsB,EAAE,CAAC,GAAG,IAAI,CAAC;IAChE,YAAY,EAAE,IAAI,eAAe,CAAC,yBAAyB,EAAE,CAAC,GAAG,IAAI,CAAC;IACtE,KAAK,EAAE,IAAI,eAAe,CAAC,iBAAiB,EAAE,CAAC,GAAG,IAAI,CAAC;CAC1D,CAAC","sourcesContent":["import {\n    mkdirp,\n    pathExists,\n    readdir,\n    readFile,\n    remove,\n    rename,\n    stat,\n    writeFile\n} from \"fs-extra\";\nimport { homedir } from \"os\";\nimport { join } from \"path\";\nimport { Readable } from \"stream\";\nimport { v4 as uuidv4 } from \"uuid\";\n\ninterface Blob {}\n\n/**\n * A simple persistent key-value store. Used to implement {@link Limits.cache}\n * for {@link throttle}.\n * @remarks\n * Entries can be expired, but are not actually deleted individually. The entire\n * cache can be deleted at once. Hence this cache is useful for storing results\n * that are expensive to compute but do not change too often (e.g. the\n * node_modules folder from an 'npm install' where 'package.json' is not\n * expected to change too often).\n *\n * By default faast.js will use the directory `~/.faastjs` as a local cache to\n * store data such as pricing retrieved from cloud APIs, and garbage collection\n * information. This directory can be safely deleted if no faast.js instances\n * are running.\n * @public\n */\nexport class PersistentCache {\n    private initialized: Promise<void>;\n\n    private async initialize(dir: string) {\n        if (!(await pathExists(dir))) {\n            await mkdirp(dir);\n        }\n    }\n\n    /**\n     * The directory on disk where cached values are stored.\n     */\n    readonly dir: string;\n\n    /**\n     * Construct a new persistent cache, typically used with {@link Limits} as\n     * part of the arguments to {@link throttle}.\n     * @param dirRelativeToHomeDir - The directory under the user's home\n     * directory that will be used to store cached values. The directory will be\n     * created if it doesn't exist.\n     * @param expiration - The age (in ms) after which a cached entry is\n     * invalid. Default: `24*3600*1000` (1 day).\n     */\n    constructor(\n        /**\n         * The directory under the user's home directory that will be used to\n         * store cached values. The directory will be created if it doesn't\n         * exist.\n         */\n        readonly dirRelativeToHomeDir: string,\n        /**\n         * The age (in ms) after which a cached entry is invalid. Default:\n         * `24*3600*1000` (1 day).\n         */\n        readonly expiration: number = 24 * 3600 * 1000\n    ) {\n        this.dir = join(homedir(), dirRelativeToHomeDir);\n        this.initialized = this.initialize(this.dir);\n    }\n\n    /**\n     * Retrieves the value previously set for the given key, or undefined if the\n     * key is not found.\n     */\n    async get(key: string) {\n        await this.initialized;\n        const entry = join(this.dir, key);\n        const statEntry = await stat(entry).catch(_ => {});\n        if (statEntry) {\n            if (Date.now() - statEntry.mtimeMs > this.expiration) {\n                return undefined;\n            }\n            return readFile(entry).catch(_ => undefined);\n        }\n        return undefined;\n    }\n\n    /**\n     * Set the cache key to the given value.\n     * @returns a Promise that resolves when the cache entry has been persisted.\n     */\n    async set(key: string, value: Buffer | string | Uint8Array | Readable | Blob) {\n        await this.initialized;\n        const entry = join(this.dir, key);\n        const tmpEntry = join(this.dir, uuidv4());\n        await writeFile(tmpEntry, value, { mode: 0o600, encoding: \"binary\" });\n        await rename(tmpEntry, entry);\n    }\n\n    /**\n     * Retrieve all keys stored in the cache, including expired entries.\n     */\n    entries() {\n        return readdir(this.dir);\n    }\n\n    /**\n     * Deletes all cached entries from disk.\n     * @param leaveEmptyDir - If true, leave the cache directory in place after\n     * deleting its contents. If false, the cache directory will be removed.\n     * Default: `true`.\n     */\n    async clear({ leaveEmptyDir = true } = {}) {\n        await this.initialized;\n\n        await remove(this.dir);\n\n        if (leaveEmptyDir) {\n            await mkdirp(this.dir);\n        }\n    }\n}\n\nconst days = 24 * 3600 * 1000;\n\nexport const caches = {\n    awsPrices: new PersistentCache(\".faastjs/aws/pricing\", 1 * days),\n    googlePrices: new PersistentCache(\".faastjs/google/pricing\", 1 * days),\n    awsGc: new PersistentCache(\".faastjs/aws/gc\", 7 * days)\n};\n"]}