28 Commits

Author SHA1 Message Date
96080c5de0 3.0.8 2024-02-14 01:33:57 +01:00
a981c63f9b fix(core): update 2024-02-14 01:33:56 +01:00
cd5e2f03f4 3.0.7 2024-02-14 01:32:20 +01:00
eb5c1f40ee fix(core): update 2024-02-14 01:32:19 +01:00
ed1d66ee2a 3.0.6 2023-07-21 00:44:40 +02:00
45122024fc fix(core): update 2023-07-21 00:44:39 +02:00
fcaed1a3a0 3.0.5 2023-07-21 00:44:07 +02:00
0ce5eba798 fix(core): update 2023-07-21 00:44:06 +02:00
9d6111a77f 3.0.4 2023-07-20 22:54:08 +02:00
ac11045812 fix(core): update 2023-07-20 22:54:07 +02:00
2266ee0c73 switch to new org scheme 2023-07-11 00:00:42 +02:00
e4f0a60644 switch to new org scheme 2023-07-10 02:41:30 +02:00
946e1cb7d3 3.0.3 2023-01-09 13:01:09 +01:00
6e5d17a793 fix(core): update 2023-01-09 13:01:08 +01:00
3f7a3c2786 3.0.2 2022-06-09 19:23:56 +02:00
925921a9fe fix(core): update 2022-06-09 19:23:55 +02:00
61ccf38d85 3.0.1 2022-04-04 14:18:39 +02:00
061a79b0fd update 2022-04-04 14:18:36 +02:00
2f4fb82918 3.0.0 2022-04-02 17:40:38 +02:00
266da3b476 2.0.1 2022-03-22 23:15:08 +01:00
074767b294 fix(core): update 2022-03-22 23:15:08 +01:00
85abc4da3d 2.0.0 2022-03-22 22:45:13 +01:00
716d805723 BREAKING CHANGE(core): switch to esm 2022-03-22 22:45:12 +01:00
9feaa921bf 1.0.10 2021-05-10 14:26:32 +00:00
6b57e8b1f3 fix(caching): properly respect ttl for all cache levels 2021-05-10 14:26:32 +00:00
f7b6df5ff7 1.0.9 2021-04-23 18:50:21 +00:00
6a4df84f4f 1.0.8 2021-04-23 18:41:30 +00:00
17b59fd222 fix(core): update 2021-04-23 18:41:30 +00:00
25 changed files with 6647 additions and 13494 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
npmci command tsdoc
continue-on-error: true

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -1,126 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
tags:
- lossless
- docker
- notpriv
snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags:
- lossless
- docker
- notpriv
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- notpriv
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }

View File

@ -15,7 +15,7 @@
"properties": { "properties": {
"projectType": { "projectType": {
"type": "string", "type": "string",
"enum": ["website", "element", "service", "npm"] "enum": ["website", "element", "service", "npm", "wcc"]
} }
} }
} }

View File

@ -3,10 +3,10 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "levelcache", "gitrepo": "levelcache",
"shortDescription": "a cache that uses memory/disk/s3 as backup", "description": "a cache that uses memory/disk/s3 as backup",
"npmPackagename": "@pushrocks/levelcache", "npmPackagename": "@push.rocks/levelcache",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"
} }

13188
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,45 +1,54 @@
{ {
"name": "@pushrocks/levelcache", "name": "@push.rocks/levelcache",
"version": "1.0.7", "version": "3.0.8",
"private": false, "private": false,
"description": "a cache that uses memory/disk/s3 as backup", "description": "a cache that uses memory/disk/s3 as backup",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/ --web)", "test": "(tstest test/ --web)",
"build": "(tsbuild --web)" "build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc",
"localPublish": "gitzone commit && pnpm run build && pnpm publish && pnpm publish --access public --registry=\"https://registry.npmjs.org\""
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@gitzone/tsbuild": "^2.1.66",
"@gitzone/tstest": "^1.0.52", "@gitzone/tsrun": "^1.2.44",
"@pushrocks/tapbundle": "^3.2.14", "@gitzone/tstest": "^1.0.77",
"@types/node": "^14.14.41", "@push.rocks/tapbundle": "^5.0.15",
"tslint": "^6.1.3", "@types/node": "^20.11.17"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^4.0.20", "@push.rocks/lik": "^6.0.12",
"@pushrocks/smartbucket": "^1.0.39", "@push.rocks/smartbucket": "^2.0.4",
"@pushrocks/smartcache": "^1.0.13", "@push.rocks/smartcache": "^1.0.13",
"@pushrocks/smartexit": "^1.0.15", "@push.rocks/smartenv": "^5.0.12",
"@pushrocks/smartfile": "^8.0.9", "@push.rocks/smartexit": "^1.0.21",
"@pushrocks/smartjson": "^4.0.6", "@push.rocks/smartfile": "^11.0.4",
"@pushrocks/smartpromise": "^3.1.5", "@push.rocks/smartjson": "^5.0.10",
"@pushrocks/smartstring": "^3.0.24", "@push.rocks/smartpath": "^5.0.11",
"@pushrocks/smartunique": "^3.0.3", "@push.rocks/smartpromise": "^4.0.3",
"@pushrocks/taskbuffer": "^2.1.13" "@push.rocks/smartstring": "^4.0.13",
"@push.rocks/smartunique": "^3.0.6",
"@push.rocks/taskbuffer": "^3.1.7",
"@tsclass/tsclass": "^4.0.51"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
"ts_web/**/*", "ts_web/**/*",
"dist/**/*", "dist/**/*",
"dist_web/**/*", "dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

6180
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,20 +1,26 @@
# @pushrocks/levelcache # @push.rocks/levelcache
a cache that uses memory/disk/s3 as backup a cache that uses memory/disk/s3 as backup
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/levelcache) * [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/levelcache)
* [gitlab.com (source)](https://gitlab.com/pushrocks/levelcache) * [gitlab.com (source)](https://gitlab.com/push.rocks/levelcache)
* [github.com (source mirror)](https://github.com/pushrocks/levelcache) * [github.com (source mirror)](https://github.com/push.rocks/levelcache)
* [docs (typedoc)](https://pushrocks.gitlab.io/levelcache/) * [docs (typedoc)](https://push.rocks.gitlab.io/levelcache/)
## Status for master ## Status for master
[![pipeline status](https://gitlab.com/pushrocks/levelcache/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/levelcache/commits/master)
[![coverage report](https://gitlab.com/pushrocks/levelcache/badges/master/coverage.svg)](https://gitlab.com/pushrocks/levelcache/commits/master) Status Category | Status Badge
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/levelcache.svg)](https://www.npmjs.com/package/@pushrocks/levelcache) -- | --
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/levelcache/badge.svg)](https://snyk.io/test/npm/@pushrocks/levelcache) GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/levelcache/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/levelcache/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/levelcache)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/levelcache)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/levelcache)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/levelcache)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/levelcache)](https://lossless.cloud)
## Usage ## Usage
@ -29,7 +35,6 @@ We are always happy for code contributions. If you are not the code contributing
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -1,24 +1,43 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as levelcache from '../ts/index'; import * as levelcache from '../ts/index.js';
import { CacheEntry } from '../ts/index'; import { CacheEntry } from '../ts/index.js';
let testLevelCache: levelcache.LevelCache; let testLevelCache: levelcache.LevelCache;
tap.test('should create a new levelcache instance', async () => { tap.test('should create a new levelcache instance', async () => {
testLevelCache = new levelcache.LevelCache({ testLevelCache = new levelcache.LevelCache({
cacheId: 'myCache' cacheId: 'myCache',
}); });
expect(testLevelCache).to.be.instanceOf(levelcache.LevelCache); expect(testLevelCache).toBeInstanceOf(levelcache.LevelCache);
}); });
tap.test('should cache a value', async () => { tap.test('should cache a value', async () => {
await testLevelCache.storeCacheEntryByKey('mykey', new CacheEntry({ await testLevelCache.storeCacheEntryByKey(
'mykey',
new CacheEntry({
contents: Buffer.from('heythere'), contents: Buffer.from('heythere'),
ttl: 10000, ttl: 10000,
typeInfo: 'string' typeInfo: 'string',
})); })
);
const result = await testLevelCache.retrieveCacheEntryByKey('mykey'); const result = await testLevelCache.retrieveCacheEntryByKey('mykey');
console.log(result); expect(result.contents.toString()).toEqual('heythere');
});
tap.test('should respect ttl', async (tools) => {
await testLevelCache.storeCacheEntryByKey(
'mykey',
new CacheEntry({
contents: Buffer.from('heythere'),
ttl: 1000,
typeInfo: 'string',
})
);
const result = await testLevelCache.retrieveCacheEntryByKey('mykey');
expect(result.contents.toString()).toEqual('heythere');
await tools.delayFor(1100);
const result2 = await testLevelCache.retrieveCacheEntryByKey('mykey');
expect(result2).toBeNull();
}); });
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/levelcache',
version: '3.0.8',
description: 'a cache that uses memory/disk/s3 as backup'
}

View File

@ -1,3 +1,2 @@
export * from './levelcache.classes.levelcache'; export * from './levelcache.classes.levelcache.js';
export * from './levelcache.classes.cacheentry'; export * from './levelcache.classes.cacheentry.js';

View File

@ -1,25 +1,38 @@
import { CacheEntry } from "./levelcache.classes.cacheentry"; import { CacheEntry } from './levelcache.classes.cacheentry.js';
export abstract class AbstractCache { export abstract class AbstractCache {
public abstract ready: Promise<void>; public abstract ready: Promise<void>;
public abstract status: 'active' | 'inactive'; public abstract status: 'active' | 'inactive';
// Blobs // Cache Entries
/** /**
* store a Blob * store a Blob
*/ */
public abstract storeCacheEntryByKey(keyArg: string, valueArg: CacheEntry): Promise<void>; public abstract storeCacheEntryByKey(keyArg: string, valueArg: CacheEntry): Promise<void>;
// Cache Entries
/** /**
* retrieve cache entry * retrieve cache entry
*/ */
public abstract retrieveCacheEntryByKey(keyArg: string): Promise<CacheEntry>; public abstract retrieveCacheEntryByKey(keyArg: string): Promise<CacheEntry>;
/**
* checks for the presence of a key
* @param keyArg
*/
public abstract checkKeyPresence(keyArg: string): Promise<boolean>; public abstract checkKeyPresence(keyArg: string): Promise<boolean>;
/** /**
* cleans the cache * delete a key
*/ */
public abstract clean(): Promise<void>; public abstract deleteCacheEntryByKey(keyArg: string): Promise<void>;
/**
* clean the cache
*/
public abstract cleanOutdated(): Promise<void>;
/**
* cleans the complete cache
*/
public abstract cleanAll(): Promise<void>;
} }

View File

@ -1,8 +1,8 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
import * as paths from './levelcache.paths'; import * as paths from './levelcache.paths.js';
import { AbstractCache } from './levelcache.abstract.classes.cache'; import { AbstractCache } from './levelcache.abstract.classes.cache.js';
import { ILevelCacheConstructorOptions, LevelCache } from './levelcache.classes.levelcache'; import { type ILevelCacheConstructorOptions, LevelCache } from './levelcache.classes.levelcache.js';
import { CacheEntry } from './levelcache.classes.cacheentry'; import { CacheEntry } from './levelcache.classes.cacheentry.js';
/** /**
* *
@ -12,7 +12,7 @@ export class CacheDiskManager extends AbstractCache {
private readyDeferred = plugins.smartpromise.defer<void>(); private readyDeferred = plugins.smartpromise.defer<void>();
public ready = this.readyDeferred.promise; public ready = this.readyDeferred.promise;
public status: 'active' | 'inactive'; public status: 'active' | 'inactive';
public fsPath: string; public fsPath: string;
public maxCacheSizeInMb: number; public maxCacheSizeInMb: number;
@ -24,7 +24,10 @@ export class CacheDiskManager extends AbstractCache {
public async init() { public async init() {
if (this.levelCacheRef.options.diskStoragePath) { if (this.levelCacheRef.options.diskStoragePath) {
this.fsPath = plugins.path.join(this.levelCacheRef.options.diskStoragePath, this.levelCacheRef.options.cacheId); this.fsPath = plugins.path.join(
this.levelCacheRef.options.diskStoragePath,
this.levelCacheRef.options.cacheId
);
} else { } else {
this.fsPath = plugins.path.join(paths.nogitDir, this.levelCacheRef.options.cacheId); this.fsPath = plugins.path.join(paths.nogitDir, this.levelCacheRef.options.cacheId);
} }
@ -35,22 +38,30 @@ export class CacheDiskManager extends AbstractCache {
} }
public async retrieveCacheEntryByKey(keyArg: string): Promise<CacheEntry> { public async retrieveCacheEntryByKey(keyArg: string): Promise<CacheEntry> {
const fileString = await plugins.smartfile.fs.toStringSync(plugins.path.join(this.fsPath, encodeURIComponent(keyArg))); const fileString = await plugins.smartfile.fs.toStringSync(
plugins.path.join(this.fsPath, encodeURIComponent(keyArg))
);
return CacheEntry.fromStorageJsonString(fileString); return CacheEntry.fromStorageJsonString(fileString);
} }
public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry) { public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry) {
await plugins.smartfile.memory.toFs(cacheEntryArg.foldToJson(), plugins.path.join(this.fsPath, encodeURIComponent(keyArg))); await plugins.smartfile.memory.toFs(
cacheEntryArg.foldToJson(),
plugins.path.join(this.fsPath, encodeURIComponent(keyArg))
);
} }
public async checkKeyPresence(keyArg): Promise<boolean> { public async checkKeyPresence(keyArg: string): Promise<boolean> {
return plugins.smartfile.fs.isFile(plugins.path.join(this.fsPath, encodeURIComponent(keyArg))); return plugins.smartfile.fs.isFile(plugins.path.join(this.fsPath, encodeURIComponent(keyArg)));
} }
/** public async deleteCacheEntryByKey(keyArg: string) {
* cleans the DiskCache directory await plugins.smartfile.fs.remove(plugins.path.join(this.fsPath, encodeURIComponent(keyArg)));
*/ }
public async clean() {
public async cleanOutdated() {}
public async cleanAll() {
if (this.status === 'active') { if (this.status === 'active') {
if (plugins.smartfile.fs.isDirectory(this.fsPath)) { if (plugins.smartfile.fs.isDirectory(this.fsPath)) {
await plugins.smartfile.fs.ensureEmptyDir(this.fsPath); await plugins.smartfile.fs.ensureEmptyDir(this.fsPath);

View File

@ -1,7 +1,7 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
import { AbstractCache } from './levelcache.abstract.classes.cache'; import { AbstractCache } from './levelcache.abstract.classes.cache.js';
import { CacheEntry } from './levelcache.classes.cacheentry'; import { CacheEntry } from './levelcache.classes.cacheentry.js';
import { ILevelCacheConstructorOptions, LevelCache } from './levelcache.classes.levelcache'; import { type ILevelCacheConstructorOptions, LevelCache } from './levelcache.classes.levelcache.js';
export class CacheMemoryManager extends AbstractCache { export class CacheMemoryManager extends AbstractCache {
private levelCacheRef: LevelCache; private levelCacheRef: LevelCache;
@ -38,8 +38,13 @@ export class CacheMemoryManager extends AbstractCache {
} }
} }
public async clean() { public async deleteCacheEntryByKey(keyArg: string) {
this.fastMap.clean(); this.fastMap.removeFromMap(keyArg);
} }
public async cleanOutdated() {}
public async cleanAll() {
this.fastMap.clean();
}
} }

View File

@ -1,7 +1,7 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
import { AbstractCache } from './levelcache.abstract.classes.cache'; import { AbstractCache } from './levelcache.abstract.classes.cache.js';
import { LevelCache } from './levelcache.classes.levelcache'; import { LevelCache } from './levelcache.classes.levelcache.js';
import { CacheEntry } from './levelcache.classes.cacheentry'; import { CacheEntry } from './levelcache.classes.cacheentry.js';
/** /**
* *
@ -26,9 +26,9 @@ export class CacheS3Manager extends AbstractCache {
if (this.levelCacheRef.options.s3Config) { if (this.levelCacheRef.options.s3Config) {
this.smartbucket = new plugins.smartbucket.SmartBucket(this.levelCacheRef.options.s3Config); this.smartbucket = new plugins.smartbucket.SmartBucket(this.levelCacheRef.options.s3Config);
this.s3CacheBucket = await this.smartbucket.getBucketByName(''); this.s3CacheBucket = await this.smartbucket.getBucketByName('');
this.s3CacheDir = await (await this.s3CacheBucket.getBaseDirectory()).getSubDirectoryByName( this.s3CacheDir = await (
this.levelCacheRef.options.cacheId await this.s3CacheBucket.getBaseDirectory()
); ).getSubDirectoryByName(this.levelCacheRef.options.cacheId);
if (this.levelCacheRef.options.maxS3StorageInMB) { if (this.levelCacheRef.options.maxS3StorageInMB) {
console.log(`cache level S3 activated with ${this.levelCacheRef.options.maxS3StorageInMB}`); console.log(`cache level S3 activated with ${this.levelCacheRef.options.maxS3StorageInMB}`);
} else { } else {
@ -48,7 +48,10 @@ export class CacheS3Manager extends AbstractCache {
} }
public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry) { public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry) {
await this.s3CacheDir.fastStore(encodeURIComponent(keyArg), cacheEntryArg.toStorageJsonString()); await this.s3CacheDir.fastStore(
encodeURIComponent(keyArg),
cacheEntryArg.toStorageJsonString()
);
} }
public async checkKeyPresence(keyArg: string): Promise<boolean> { public async checkKeyPresence(keyArg: string): Promise<boolean> {
@ -61,7 +64,18 @@ export class CacheS3Manager extends AbstractCache {
return false; return false;
} }
public async clean() { public async deleteCacheEntryByKey(keyArg: string) {
if (this.status === 'active') {
await this.s3CacheDir.fastRemove(encodeURIComponent(keyArg));
}
}
/**
* clean outdated
*/
public async cleanOutdated() {}
public async cleanAll() {
await this.s3CacheDir.deleteWithAllContents(); await this.s3CacheDir.deleteWithAllContents();
} }
} }

View File

@ -1,4 +1,4 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
export interface ICacheEntryConstructorOptions { export interface ICacheEntryConstructorOptions {
key?: string; key?: string;
@ -10,7 +10,10 @@ export interface ICacheEntryConstructorOptions {
/** /**
* a CacheEntry * a CacheEntry
*/ */
export class CacheEntry extends plugins.smartjson.Smartjson implements ICacheEntryConstructorOptions { export class CacheEntry
extends plugins.smartjson.Smartjson
implements ICacheEntryConstructorOptions
{
public static fromStorageJsonString(storageJsonString: string) { public static fromStorageJsonString(storageJsonString: string) {
return new CacheEntry(plugins.smartjson.parse(storageJsonString)); return new CacheEntry(plugins.smartjson.parse(storageJsonString));
} }
@ -21,6 +24,9 @@ export class CacheEntry extends plugins.smartjson.Smartjson implements ICacheEnt
@plugins.smartjson.foldDec() @plugins.smartjson.foldDec()
public ttl: number; public ttl: number;
@plugins.smartjson.foldDec()
public createdAt: number;
@plugins.smartjson.foldDec() @plugins.smartjson.foldDec()
public typeInfo: string; public typeInfo: string;

View File

@ -1,7 +1,7 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
import { LevelCache } from './levelcache.classes.levelcache'; import { LevelCache } from './levelcache.classes.levelcache.js';
import { AbstractCache } from './levelcache.abstract.classes.cache'; import { AbstractCache } from './levelcache.abstract.classes.cache.js';
import { CacheEntry } from './levelcache.classes.cacheentry'; import { CacheEntry } from './levelcache.classes.cacheentry.js';
export class CacheRouter { export class CacheRouter {
public levelCacheRef: LevelCache; public levelCacheRef: LevelCache;
@ -16,22 +16,29 @@ export class CacheRouter {
*/ */
async getCacheForStoreAction(keyArg: string, cacheEntry: CacheEntry): Promise<AbstractCache> { async getCacheForStoreAction(keyArg: string, cacheEntry: CacheEntry): Promise<AbstractCache> {
let returnCache: AbstractCache; let returnCache: AbstractCache;
const mbToBytesMultiplier = 1000 * 1000;
const maxMemoryBytes = this.levelCacheRef.options.maxMemoryStorageInMB * mbToBytesMultiplier;
const maxDiskBytes = this.levelCacheRef.options.maxDiskStorageInMB * mbToBytesMultiplier;
const maxS3Bytes = this.levelCacheRef.options.maxS3StorageInMB * mbToBytesMultiplier;
switch (true) { switch (true) {
case cacheEntry.contents.byteLength <= 500: case cacheEntry.contents.byteLength <= maxMemoryBytes &&
this.levelCacheRef.cacheMemoryManager.status === 'active':
returnCache = this.levelCacheRef.cacheMemoryManager; returnCache = this.levelCacheRef.cacheMemoryManager;
break; break;
case this.levelCacheRef.cacheDiskManager.status === 'active' && case this.levelCacheRef.cacheDiskManager.status === 'active' &&
cacheEntry.contents.byteLength >= 500 && cacheEntry.contents.byteLength > maxMemoryBytes &&
(cacheEntry.contents.byteLength < 10000 || cacheEntry.contents.byteLength <= maxDiskBytes &&
this.levelCacheRef.cacheS3Manager.status === 'inactive'): this.levelCacheRef.cacheDiskManager.status === 'active':
returnCache = this.levelCacheRef.cacheDiskManager; returnCache = this.levelCacheRef.cacheDiskManager;
break; break;
case cacheEntry.contents.byteLength >= 10000 && case cacheEntry.contents.byteLength > maxDiskBytes &&
cacheEntry.contents.byteLength < maxS3Bytes &&
this.levelCacheRef.cacheS3Manager.status === 'active': this.levelCacheRef.cacheS3Manager.status === 'active':
returnCache = this.levelCacheRef.cacheS3Manager; returnCache = this.levelCacheRef.cacheS3Manager;
break; break;
default: default:
returnCache = this.levelCacheRef.cacheMemoryManager; returnCache = null;
} }
this.cacheKeyMap.addToMap(keyArg, returnCache); this.cacheKeyMap.addToMap(keyArg, returnCache);
return returnCache; return returnCache;
@ -46,7 +53,7 @@ export class CacheRouter {
if (!returnCache && this.levelCacheRef.options.persistentCache) { if (!returnCache && this.levelCacheRef.options.persistentCache) {
const checkCache = (cacheArg: AbstractCache) => { const checkCache = (cacheArg: AbstractCache) => {
const resultPromise = cacheArg.checkKeyPresence(keyArg); const resultPromise = cacheArg.checkKeyPresence(keyArg);
resultPromise.then(hasKeyArg => { resultPromise.then((hasKeyArg) => {
if (hasKeyArg) { if (hasKeyArg) {
done.resolve(cacheArg); done.resolve(cacheArg);
} }
@ -56,7 +63,7 @@ export class CacheRouter {
Promise.all([ Promise.all([
checkCache(this.levelCacheRef.cacheMemoryManager), checkCache(this.levelCacheRef.cacheMemoryManager),
checkCache(this.levelCacheRef.cacheDiskManager), checkCache(this.levelCacheRef.cacheDiskManager),
checkCache(this.levelCacheRef.cacheMemoryManager) checkCache(this.levelCacheRef.cacheMemoryManager),
]).then(() => { ]).then(() => {
done.resolve(returnCache); done.resolve(returnCache);
}); });

View File

@ -1,10 +1,10 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
import { CacheDiskManager } from './levelcache.classes.cache.diskmanager'; import { CacheDiskManager } from './levelcache.classes.cache.diskmanager.js';
import { CacheMemoryManager } from './levelcache.classes.cache.memorymanager'; import { CacheMemoryManager } from './levelcache.classes.cache.memorymanager.js';
import { CacheS3Manager } from './levelcache.classes.cache.s3manager'; import { CacheS3Manager } from './levelcache.classes.cache.s3manager.js';
import { CacheEntry } from './levelcache.classes.cacheentry'; import { CacheEntry } from './levelcache.classes.cacheentry.js';
import { CacheRouter } from './levelcache.classes.cacherouter'; import { CacheRouter } from './levelcache.classes.cacherouter.js';
import { AbstractCache } from './levelcache.abstract.classes.cache'; import { AbstractCache } from './levelcache.abstract.classes.cache.js';
export interface ILevelCacheConstructorOptions { export interface ILevelCacheConstructorOptions {
/** /**
@ -15,7 +15,7 @@ export interface ILevelCacheConstructorOptions {
maxDiskStorageInMB?: number; maxDiskStorageInMB?: number;
maxS3StorageInMB?: number; maxS3StorageInMB?: number;
diskStoragePath?: string; diskStoragePath?: string;
s3Config?: plugins.smartbucket.ISmartBucketConfig; s3Config?: plugins.tsclass.storage.IS3Descriptor;
s3BucketName?: string; s3BucketName?: string;
forceLevel?: 'memory' | 'disk' | 's3'; forceLevel?: 'memory' | 'disk' | 's3';
expirationInMs?: number; expirationInMs?: number;
@ -42,13 +42,18 @@ export class LevelCache extends AbstractCache {
constructor(optionsArg: ILevelCacheConstructorOptions) { constructor(optionsArg: ILevelCacheConstructorOptions) {
super(); super();
this.options = optionsArg; this.options = {
maxMemoryStorageInMB: 0.5,
maxDiskStorageInMB: 10,
maxS3StorageInMB: 50,
...optionsArg,
};
this.init(); this.init();
} }
public async init() { public async init() {
this.cacheDiskManager = new CacheDiskManager(this);
this.cacheMemoryManager = new CacheMemoryManager(this); this.cacheMemoryManager = new CacheMemoryManager(this);
this.cacheDiskManager = new CacheDiskManager(this);
this.cacheS3Manager = new CacheS3Manager(this); this.cacheS3Manager = new CacheS3Manager(this);
await Promise.all([ await Promise.all([
this.cacheDiskManager.ready, this.cacheDiskManager.ready,
@ -62,6 +67,7 @@ export class LevelCache extends AbstractCache {
public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry): Promise<void> { public async storeCacheEntryByKey(keyArg: string, cacheEntryArg: CacheEntry): Promise<void> {
cacheEntryArg.key = keyArg; cacheEntryArg.key = keyArg;
const targetCache = await this.cacheRouter.getCacheForStoreAction(keyArg, cacheEntryArg); const targetCache = await this.cacheRouter.getCacheForStoreAction(keyArg, cacheEntryArg);
cacheEntryArg.createdAt = Date.now();
await targetCache.storeCacheEntryByKey(keyArg, cacheEntryArg); await targetCache.storeCacheEntryByKey(keyArg, cacheEntryArg);
} }
@ -73,30 +79,43 @@ export class LevelCache extends AbstractCache {
const targetCache = await this.cacheRouter.getCacheForRetrieveAction(keyArg); const targetCache = await this.cacheRouter.getCacheForRetrieveAction(keyArg);
if (targetCache) { if (targetCache) {
const cacheEntry = await targetCache.retrieveCacheEntryByKey(keyArg); const cacheEntry = await targetCache.retrieveCacheEntryByKey(keyArg);
if (cacheEntry.createdAt + cacheEntry.ttl < Date.now()) {
await this.deleteCacheEntryByKey(keyArg).catch();
return null;
}
return cacheEntry; return cacheEntry;
} else { } else {
return null; return null;
} }
} }
public async checkKeyPresence(keyArg: string): Promise<boolean> { public async checkKeyPresence(keyArg: string): Promise<boolean> {
return plugins.smartpromise.getFirstTrueOrFalse([ return plugins.smartpromise.getFirstTrueOrFalse([
this.cacheMemoryManager.checkKeyPresence(keyArg), this.cacheMemoryManager.checkKeyPresence(keyArg),
this.cacheDiskManager.checkKeyPresence(keyArg), this.cacheDiskManager.checkKeyPresence(keyArg),
this.cacheS3Manager.checkKeyPresence(keyArg) this.cacheS3Manager.checkKeyPresence(keyArg),
]);
}
public async deleteCacheEntryByKey(keyArg) {
await Promise.all([
this.cacheMemoryManager.deleteCacheEntryByKey(keyArg),
this.cacheDiskManager.deleteCacheEntryByKey(keyArg),
this.cacheS3Manager.deleteCacheEntryByKey(keyArg),
]); ]);
} }
// cache maintenance // cache maintenance
public async cleanOutdated() {}
/** /**
* cleans the cache * cleans the complete cache
*/ */
public async clean(): Promise<void> { public async cleanAll(): Promise<void> {
await Promise.all([ await Promise.all([
this.cacheDiskManager.clean(), this.cacheDiskManager.cleanAll(),
this.cacheDiskManager.clean(), this.cacheDiskManager.cleanAll(),
this.cacheS3Manager.clean(), this.cacheS3Manager.cleanAll(),
]); ]);
} }
} }

View File

@ -1,4 +1,7 @@
import * as plugins from './levelcache.plugins'; import * as plugins from './levelcache.plugins.js';
export const packageDir = plugins.path.join(__dirname, '../'); export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../'
);
export const nogitDir = plugins.path.join(packageDir, '.nogit/'); export const nogitDir = plugins.path.join(packageDir, '.nogit/');

View File

@ -3,16 +3,17 @@ import * as path from 'path';
export { path }; export { path };
// @pushrocks scope // @push.rocks scope
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartbucket from '@pushrocks/smartbucket'; import * as smartbucket from '@push.rocks/smartbucket';
import * as smartcache from '@pushrocks/smartcache'; import * as smartcache from '@push.rocks/smartcache';
import * as smartfile from '@pushrocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartjson from '@pushrocks/smartjson'; import * as smartjson from '@push.rocks/smartjson';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpath from '@push.rocks/smartpath';
import * as smartstring from '@pushrocks/smartstring'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartunique from '@pushrocks/smartunique'; import * as smartstring from '@push.rocks/smartstring';
import * as taskbuffer from '@pushrocks/taskbuffer'; import * as smartunique from '@push.rocks/smartunique';
import * as taskbuffer from '@push.rocks/taskbuffer';
export { export {
lik, lik,
@ -20,8 +21,16 @@ export {
smartcache, smartcache,
smartfile, smartfile,
smartjson, smartjson,
smartpath,
smartpromise, smartpromise,
smartstring, smartstring,
smartunique, smartunique,
taskbuffer, taskbuffer,
}; };
// @tsclass scope
import * as tsclass from '@tsclass/tsclass';
export {
tsclass,
};

View File

@ -1,7 +1,14 @@
{ {
"compilerOptions": { "compilerOptions": {
"experimentalDecorators": true, "experimentalDecorators": true,
"target": "es2017", "useDefineForClassFields": false,
"module": "commonjs" "target": "ES2022",
} "module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
} }

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}