dtoro
d4d99a7473
Problem: the hexagonal refactor churns the backend tree for nine more phases; the UI delivery stack (web/ SPA, cmd/desktop Wails wrapper, compose/web image) must move to its own repo first so doc/layout rewrites land once on a backend-only tree. Change: - New repo git.hubris.network/dtoro/oikos-web (v0.33.0): web/, desktop/ (updateURL repointed to oikos-web releases), compose/, own CI (web + desktop jobs), own deploy script (CI-green gate, TOCTOU guard, version-tagged images, prune-to-3), own webhook receiver on :9798 + launchd unit, own compose project publishing the same 8091:80. - Cutover executed on mac-mini in order: oikos stack's web service stopped+removed, oikos-web project brought up on 8091; outer Caddy untouched (targets the published port) — serving + Authentik flow + /wails 404 quirk verified post-cutover. - Stripped from oikos: web/, cmd/desktop/, compose/web/, desktop CI workflow, ci.yml web job, Makefile ui/desktop/desktop-package/install targets, the compose web service, oikos-web from deploy.sh's fallback prune list; wails + go-keyring dropped from go.mod, vendor synced. - README / CONTRIBUTING / AGENTS.md / .agents dev+operations docs now point at the new repo; mbse + mascot design docs carry a path note. Risk: production SPA serving depends on the new pipeline now; rollback is versioned-image re-up of the old web service from a pre-split checkout (port 8091). Desktop builds installed before the split still check dtoro/oikos releases — one manual reinstall, noted in the oikos-web release notes. Verification: go vet, make test (race), make generate-check, golangci (no new findings; baseline down 400→365); post-cutover curls — localhost:8091 200, /wails/runtime.js 404, outer Caddy 302 Authentik.
78 lines
3.0 KiB
Markdown
78 lines
3.0 KiB
Markdown
# flat-cache
|
|
|
|
> A stupidly simple key/value storage using files to persist the data
|
|
|
|
[](https://npmjs.org/package/flat-cache)
|
|
[](https://github.com/jaredwray/flat-cache/actions/workflows/tests.yaml)
|
|
[](https://codecov.io/github/jaredwray/flat-cache)
|
|
[](https://npmjs.com/package/flat-cache)
|
|
|
|
## install
|
|
|
|
```bash
|
|
npm i --save flat-cache
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const flatCache = require('flat-cache');
|
|
// loads the cache, if one does not exists for the given
|
|
// Id a new one will be prepared to be created
|
|
const cache = flatCache.load('cacheId');
|
|
|
|
// sets a key on the cache
|
|
cache.setKey('key', { foo: 'var' });
|
|
|
|
// get a key from the cache
|
|
cache.getKey('key'); // { foo: 'var' }
|
|
|
|
// fetch the entire persisted object
|
|
cache.all(); // { 'key': { foo: 'var' } }
|
|
|
|
// remove a key
|
|
cache.removeKey('key'); // removes a key from the cache
|
|
|
|
// save it to disk
|
|
cache.save(); // very important, if you don't save no changes will be persisted.
|
|
// cache.save( true /* noPrune */) // can be used to prevent the removal of non visited keys
|
|
|
|
// loads the cache from a given directory, if one does
|
|
// not exists for the given Id a new one will be prepared to be created
|
|
const cache = flatCache.load('cacheId', path.resolve('./path/to/folder'));
|
|
|
|
// The following methods are useful to clear the cache
|
|
// delete a given cache
|
|
flatCache.clearCacheById('cacheId'); // removes the cacheId document if one exists.
|
|
|
|
// delete all cache
|
|
flatCache.clearAll(); // remove the cache directory
|
|
```
|
|
|
|
## Motivation for this module
|
|
|
|
I needed a super simple and dumb **in-memory cache** with optional disk persistance in order to make
|
|
a script that will beutify files with `esformatter` only execute on the files that were changed since the last run.
|
|
To make that possible we need to store the `fileSize` and `modificationTime` of the files. So a simple `key/value`
|
|
storage was needed and Bam! this module was born.
|
|
|
|
## Important notes
|
|
|
|
- If no directory is especified when the `load` method is called, a folder named `.cache` will be created
|
|
inside the module directory when `cache.save` is called. If you're committing your `node_modules` to any vcs, you
|
|
might want to ignore the default `.cache` folder, or specify a custom directory.
|
|
- The values set on the keys of the cache should be `stringify-able` ones, meaning no circular references
|
|
- All the changes to the cache state are done to memory
|
|
- I could have used a timer or `Object.observe` to deliver the changes to disk, but I wanted to keep this module
|
|
intentionally dumb and simple
|
|
- Non visited keys are removed when `cache.save()` is called. If this is not desired, you can pass `true` to the save call
|
|
like: `cache.save( true /* noPrune */ )`.
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
## Changelog
|
|
|
|
[changelog](./changelog.md)
|