Fast, fault-tolerant, cross-platform, disk-based, data-agnostic, content-addressable cache.
npm install @applaud/cacache@applaud/cacache is a Node.js library for managing
local key and content address caches. It's really fast, really good at
concurrency, and it will never give you corrupted data, even if cache files
get corrupted or manipulated.
It was originally written to be used as npm's local cache, but
can just as easily be used on its own.
$ npm install --save @applaud/cacache
* Example
* Features
* Contributing
* API
* Using localized APIs
* Reading
* ls
* ls.stream
* get
* get.stream
* get.info
* get.hasContent
* Writing
* put
* put.stream
put opts
* rm.all
* rm.entry
* rm.content
* Utilities
* setLocale
* clearMemoized
* tmp.mkdir
* tmp.withTmp
* Integrity
* Subresource Integrity
* verify
* verify.lastRun
``javascript
const cacache = require('@applaud/cacache/en')
const fs = require('fs')
const tarball = '/path/to/mytar.tgz'
const cachePath = '/tmp/my-toy-cache'
const key = 'my-unique-key-1234'
// Cache it! Use cachePath as the root of the content cacheSaved content to ${cachePath}.
cacache.put(cachePath, key, '10293801983029384').then(integrity => {
console.log()
})
const destination = '/tmp/mytar.tgz'
// Copy the contents out of the cache and into their destination!
// But this time, use stream instead!
cacache.get.stream(
cachePath, key
).pipe(
fs.createWriteStream(destination)
).on('finish', () => {
console.log('done extracting!')
})
// The same thing, but skip the key index.
cacache.get.byDigest(cachePath, integrityHash).then(data => {
fs.writeFile(destination, data, err => {
console.log('tarball data fetched based on its sha512sum and written out!')
})
})
`
* Extraction by key or by content address (shasum, etc)
* Subresource Integrity web standard support
* Multi-hash support - safely host sha1, sha512, etc, in a single cache
* Automatic content deduplication
* Fault tolerance (immune to corruption, partial writes, process races, etc)
* Consistency guarantees on read and write (full data verification)
* Lockless, high-concurrency cache access
* Streaming support
* Promise support
* Pretty darn fast -- sub-millisecond reads and writes including verification
* Arbitrary metadata storage
* Garbage collection and additional offline verification
* Thorough test coverage
* There's probably a bloom filter in there somewhere. Those are cool, right? π€
The cacache team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! The Contributor Guide has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
All participants and maintainers in this project are expected to follow Code of Conduct, and just generally be excellent to each other.
Please refer to the Changelog for project history details, too.
Happy hacking!
cacache includes a complete API in English, with the same features as other
translations. To use the English API as documented in this README, use
require('@applaud/cacache/en'). This is also currently the default if you dorequire('@applaud/cacache'), but may change in the future.
cacache also supports other languages! You can find the list of currently
supported ones by looking in ./locales in the source directory. You can userequire('@applaud/cacache/
the API in that language with .
Want to add support for a new language? Please go ahead! You should be able to
copy ./locales/en.js and ./locales/en.json and fill them in. Translating theREADME.md is a bit more work, but also appreciated if you get around to it. ππΌ
#### > cacache.ls(cache) -> Promise
Lists info for all entries currently in the cache as a single large object. Each
entry in the object will be keyed by the unique index key, with corresponding
get.info objects as the values.
##### Example
`javascriptcachePath
cacache.ls(cachePath).then(console.log)
// Output
{
'my-thing': {
key: 'my-thing',
integrity: 'sha512-BaSe64/EnCoDED+HAsh=='
path: '.testcache/content/deadbeef', // joined with
time: 12345698490,
size: 4023948,
metadata: {
name: 'blah',
version: '1.2.3',
description: 'this was once a package but now it is my-thing'
}
},
'other-thing': {
key: 'other-thing',
integrity: 'sha1-ANothER+hasH=',
path: '.testcache/content/bada55',
time: 11992309289,
size: 111112
}
}
#### > cacache.ls.stream(cache) -> Readable
Lists info for all entries currently in the cache as a single large object.
This works just like ls, except get.info entries are
returned as 'data' events on the returned stream.
##### Example
`javascriptcachePath
cacache.ls.stream(cachePath).on('data', console.log)
// Output
{
key: 'my-thing',
integrity: 'sha512-BaSe64HaSh',
path: '.testcache/content/deadbeef', // joined with
time: 12345698490,
size: 13423,
metadata: {
name: 'blah',
version: '1.2.3',
description: 'this was once a package but now it is my-thing'
}
}
{
key: 'other-thing',
integrity: 'whirlpool-WoWSoMuchSupport',
path: '.testcache/content/bada55',
time: 11992309289,
size: 498023984029
}
{
...
}
`
#### > cacache.get(cache, key, [opts]) -> Promise({data, metadata, integrity})
Returns an object with the cached data, digest, and metadata identified by
key. The data property of this object will be a Buffer instance that
presumably holds some data that means something to you. I'm sure you know what
to do with it! cacache just won't care.
integrity is a Subresourcedata
Integrity
string. That is, a string that can be used to verify , which looks like.
If there is no content identified by key, or if the locally-stored data does
not pass the validity checksum, the promise will be rejected.
A sub-function, get.byDigest may be used for identical behavior, except lookupdata
will happen by integrity hash, bypassing the index entirely. This version of the
function only returns itself, without any wrapper.
##### Note
This function loads the entire cache entry into memory before returning it. If
you're dealing with Very Large data, consider using get.stream
instead.
##### Example
`javascript
// Look up by key
cache.get(cachePath, 'my-thing').then(console.log)
// Output:
{
metadata: {
thingName: 'my'
},
integrity: 'sha512-BaSe64HaSh',
data: Buffer#
size: 9320
}
// Look up by digest
cache.get.byDigest(cachePath, 'sha512-BaSe64HaSh').then(console.log)
// Output:
Buffer#
`
#### > cacache.get.stream(cache, key, [opts]) -> Readable
Returns a Readable Stream of the cached data identified by key.
If there is no content identified by key, or if the locally-stored data does
not pass the validity checksum, an error will be emitted.
metadata and integrity events will be emitted before the stream closes, if
you need to collect that extra data about the cached entry.
A sub-function, get.stream.byDigest may be used for identical behavior,metadata
except lookup will happen by integrity hash, bypassing the index entirely. This
version does not emit the and integrity events at all.
##### Example
`javascript
// Look up by key
cache.get.stream(
cachePath, 'my-thing'
).on('metadata', metadata => {
console.log('metadata:', metadata)
}).on('integrity', integrity => {
console.log('integrity:', integrity)
}).pipe(
fs.createWriteStream('./x.tgz')
)
// Outputs:
metadata: { ... }
integrity: 'sha512-SoMeDIGest+64=='
// Look up by digest
cache.get.stream.byDigest(
cachePath, 'sha512-SoMeDIGest+64=='
).pipe(
fs.createWriteStream('./x.tgz')
)
`
#### > cacache.get.info(cache, key) -> Promise
Looks up key in the cache index, returning information about the entry if
one exists.
##### Fields
* key - Key the entry was looked up under. Matches the key argument.integrity
* - Subresource Integrity hash for the content this entry refers to.path
* - Filesystem path relative to cache argument where content is stored.time
* - Timestamp the entry was first added on.metadata
* - User-assigned metadata associated with the entry/content.
##### Example
`javascript
cacache.get.info(cachePath, 'my-thing').then(console.log)
// Output
{
key: 'my-thing',
integrity: 'sha256-MUSTVERIFY+ALL/THINGS=='
path: '.testcache/content/deadbeef',
time: 12345698490,
size: 849234,
metadata: {
name: 'blah',
version: '1.2.3',
description: 'this was once a package but now it is my-thing'
}
}
`
#### > cacache.get.hasContent(cache, integrity) -> Promise
Looks up a Subresource Integrity hash in the cache. If content
exists for this integrity, it will return an object, with the specific single integrity hashsri
that was found in key, and the size of the found content as size. If no content exists for this integrity, it will return false.
##### Example
`javascript
cacache.get.hasContent(cachePath, 'sha256-MUSTVERIFY+ALL/THINGS==').then(console.log)
// Output
{
sri: {
source: 'sha256-MUSTVERIFY+ALL/THINGS==',
algorithm: 'sha256',
digest: 'MUSTVERIFY+ALL/THINGS==',
options: []
},
size: 9001
}
cacache.get.hasContent(cachePath, 'sha521-NOT+IN/CACHE==').then(console.log)
// Output
false
`
#### > cacache.put(cache, key, data, [opts]) -> Promise
Inserts data passed to it into the cache. The returned Promise resolves with a
digest (generated according to opts.algorithms) after the
cache entry has been successfully written.
##### Example
`javascript`
fetch(
'https://registry.npmjs.org/@applaud/cacache/-/@applaud/cacache-1.0.0.tgz'
).then(data => {
return cacache.put(cachePath, 'registry.npmjs.org|@applaud/cacache@1.0.0', data)
}).then(integrity => {
console.log('integrity hash is', integrity)
})
#### > cacache.put.stream(cache, key, [opts]) -> Writable
Returns a Writable
Stream that inserts
data written to it into the cache. Emits an integrity event with the digest of
written contents when it succeeds.
##### Example
`javascriptintegrity digest is ${d}
request.get(
'https://registry.npmjs.org/@applaud/cacache/-/@applaud/cacache-1.0.0.tgz'
).pipe(
cacache.put.stream(
cachePath, 'registry.npmjs.org|@applaud/cacache@1.0.0'
).on('integrity', d => console.log())`
)
cacache.put functions have a number of options in common.
##### opts.metadata
Arbitrary metadata to be attached to the inserted key.
##### opts.size
If provided, the data stream will be verified to check that enough data was
passed through. If there's more or less data than expected, insertion will fail
with an EBADSIZE error.
##### opts.integrity
If present, the pre-calculated digest for the inserted content. If this option
if provided and does not match the post-insertion digest, insertion will fail
with an EINTEGRITY error.
algorithms has no effect if this option is present.
##### opts.algorithms
Default: ['sha512']
Hashing algorithms to use when calculating the subresource integrity
digest
for inserted data. Can use any algorithm listed in crypto.getHashes() or'omakase'/'γδ»»γγγΎγ' to pick a random hash algorithm on each insertion. You'modnar'
may also use any anagram of to use this feature.
Currently only supports one algorithm at a time (i.e., an array length of
exactly 1). Has no effect if opts.integrity is present.
##### opts.uid/opts.gid
If provided, cacache will do its best to make sure any new files added to the
cache use this particular uid/gid combination. This can be used,sudo
for example, to drop permissions when someone uses , but cacache makes
no assumptions about your needs here.
##### opts.memoize
Default: null
If provided, cacache will memoize the given cache insertion in memory, bypassing
any filesystem checks for that key or digest in future cache fetches. Nothing
will be written to the in-memory cache unless this option is explicitly truthy.
If opts.memoize is an object or a Map-like (that is, an object with get
and methods), it will be written to instead of the global memoization
cache.
Reading from disk data can be forced by explicitly passing memoize: false to
the reader functions, but their default will be to read from memory.
#### > cacache.rm.all(cache) -> Promise
Clears the entire cache. Mainly by blowing away the cache directory itself.
##### Example
`javascript`
cacache.rm.all(cachePath).then(() => {
console.log('THE APOCALYPSE IS UPON US π±')
})
#### > cacache.rm.entry(cache, key) -> Promise
Alias: cacache.rm
Removes the index entry for key. Content will still be accessible ifget.stream.byDigest
requested directly by content address ().
To remove the content itself (which might still be used by other entries), use
rm.content. Or, to safely vacuum any unused content, use
verify.
##### Example
`javascript`
cacache.rm.entry(cachePath, 'my-thing').then(() => {
console.log('I did not like it anyway')
})
#### > cacache.rm.content(cache, integrity) -> Promise
Removes the content identified by integrity. Any index entries referring to it
will not be usable again until the content is re-added to the cache with an
identical digest.
##### Example
`javascript`
cacache.rm.content(cachePath, 'sha512-SoMeDIGest/IN+BaSE64==').then(() => {
console.log('data for my-thing is gone!')
})
#### > cacache.setLocale(locale)
Configure the language/locale used for messages and errors coming from cacache.
The list of available locales is in the ./locales directory in the project
root.
_Interested in contributing more languages! Submit a PR!_
#### > cacache.clearMemoized()
Completely resets the in-memory entry cache.
#### > tmp.mkdir(cache, opts) -> Promise
Returns a unique temporary directory inside the cache's tmp dir. This
directory will use the same safe user assignment that all the other stuff use.
Once the directory is made, it's the user's responsibility that all files within
are made according to the same opts.gid/opts.uid settings that would betmp.fix()
passed in. If not, you can ask cacache to do it for you by calling, which will fix all tmp directory permissions.
If you want automatic cleanup of this directory, use
tmp.withTmp()
##### Example
`javascript`
cacache.tmp.mkdir(cache).then(dir => {
fs.writeFile(path.join(dir, 'blablabla'), Buffer#<1234>, ...)
})
#### > tmp.withTmp(cache, opts, cb) -> Promise
Creates a temporary directory with tmp.mkdir() and calls cb
with it. The created temporary directory will be removed when the return value
of resolves -- that is, if you return a Promise from cb(), the tmp
directory will be automatically deleted once that promise completes.
The same caveats apply when it comes to managing permissions for the tmp dir's
contents.
##### Example
`javascriptdir
cacache.tmp.withTmp(cache, dir => {
return fs.writeFileAsync(path.join(dir, 'blablabla'), Buffer#<1234>, ...)
}).then(() => {
// no longer exists`
})
#### Subresource Integrity Digests
For content verification and addressing, cacache uses strings following the
Subresource
Integrity spec.
That is, any time cacache expects an integrity argument or option, it
should be in the format .
One deviation from the current spec is that cacache will support any hash
algorithms supported by the underlying Node.js process. You can use
crypto.getHashes() to see which ones you can use.
##### Generating Digests Yourself
If you have an existing content shasum, they are generally formatted as a
hexadecimal string (that is, a sha1 would look like:
5f5513f8822fdbe5145af33b64d8d970dcf95c6e). In order to be compatible withsha1-X1UT+IIv2+UUWvM7ZNjZcNz5XG4=
cacache, you'll need to convert this to an equivalent subresource integrity
string. For this example, the corresponding hash would be:.
If you want to generate an integrity string yourself for existing data, you can
use something like this:
`javascript
const crypto = require('crypto')
const hashAlgorithm = 'sha512'
const data = 'foobarbaz'
const integrity = (
hashAlgorithm +
'-' +
crypto.createHash(hashAlgorithm).update(data).digest('base64')
)
`
You can also use ssri to have a richer set of functionality
around SRI strings, including generation, parsing, and translating from existing
hex-formatted strings.
#### > cacache.verify(cache, opts) -> Promise
Checks out and fixes up your cache:
* Cleans up corrupted or invalid index entries.
* Custom entry filtering options.
* Garbage collects any content entries not referenced by the index.
* Checks integrity for all content entries and removes invalid content.
* Fixes cache ownership.
* Removes the tmp directory in the cache and all its contents.
When it's done, it'll return an object with various stats about the verification
process, including amount of storage reclaimed, number of valid entries, number
of entries removed, etc.
##### Options
* opts.uid - uid to assign to cache and its contentsopts.gid
* - gid to assign to cache and its contentsopts.filter
* - receives a formatted entry. Return false to remove it.
Note: might be called more than once on the same entry.
##### Example
`sh`
echo somegarbage >> $CACHEPATH/content/deadbeef
`javascript`
cacache.verify(cachePath).then(stats => {
// deadbeef collected, because of invalid checksum.
console.log('cache is much nicer now! stats:', stats)
})
#### > cacache.verify.lastRun(cache) -> Promise
Returns a Date representing the last time cacache.verify was run on cache.
##### Example
`javascript``
cacache.verify(cachePath).then(() => {
cacache.verify.lastRun(cachePath).then(lastTime => {
console.log('cacache.verify was last called on' + lastTime)
})
})