feat: msgpackr default encoder

Author: sjdonado

.npmignore

@@ -1,4 +1,9 @@
 node_modules
+
+.nyc_output
+coverage
+
 tests
+
 bunfig.toml
 .prettierrc.json

README.md

@@ -2,7 +2,8 @@
 
 - Runs on top of [bun-sqlite](https://bun.sh/docs/api/sqlite)
 - Optimized `mset`/`mget` support
-- Supports CBOR for efficient and fast storage (selectable between `json` or `cbor`, default: `cbor`)
+- Multiple encoders support: `msgpackr`, `cbor`, `json`
+- Auto purge (clean expired records every hour)
 
 ## Installation
 
@@ -20,7 +21,7 @@ import bunSqliteStore from 'cache-manager-bun-sqlite3';
 
 // SQLite :memory: cache store
 cache = await cacheManager.caching(bunSqliteStore, {
-  serializer: 'json', // default is 'cbor'
+  serializer: 'json', // default is 'msgpackr'
   ttl: 20, // TTL in seconds
 });
 
@@ -31,11 +32,11 @@ const cache = await cacheManager.caching(bunSqliteStore, {
 });
 
 // TTL in seconds
-await cache.set('foo', { test: 'bar' }, 600);
+await cache.set('foo', { test: 'bar' }, 30);
 const value = await cache.get('foo');
 
 // TTL in seconds
-await cache.set('foo', { test: 'bar' }, 600);
+await cache.set('foo', { test: 'bar' }, 30);
 const value = await cache.get('foo');
 ```
 
@@ -75,6 +76,4 @@ await multiCache.mset('foo1', 'bar1', 'foo3', 'bar3', customTTL);
 await multiCache.mget('foo1', 'foo3');
 ```
 
-## Fork from
-
-[node-cache-manager-sqlite](https://github.com/maxpert/node-cache-manager-sqlite)
+Fork from [node-cache-manager-sqlite](https://github.com/maxpert/node-cache-manager-sqlite)

bun.lockb

@@ -1,7 +1,9 @@
 import { Database } from 'bun:sqlite';
-import { decode, encode } from 'cbor-x';
 import type { Store, Config } from 'cache-manager';
 
+import * as cbor from 'cbor-x';
+import * as msgpackr from 'msgpackr';
+
 const configurePragmas = `
 PRAGMA main.synchronous = NORMAL;
 PRAGMA main.journal_mode = WAL2;
@@ -31,15 +33,19 @@ const serializers = {
     deserialize: JSON.parse,
   },
   cbor: {
-    serialize: encode,
-    deserialize: decode,
+    serialize: cbor.encode,
+    deserialize: cbor.decode,
+  },
+  msgpackr: {
+    serialize: msgpackr.pack,
+    deserialize: msgpackr.unpack,
   },
 };
 
 type SqliteCacheOptions = Config & {
   name?: string;
   path?: string;
-  serializer?: 'json' | 'cbor';
+  serializer?: 'msgpackr' | 'cbor' | 'json';
   ttl?: number;
 };
 
@@ -51,13 +57,13 @@ export interface SqliteStore extends Store {
 
 export class NoCacheableError implements Error {
   name = 'NoCacheableError';
-  constructor(public message: string) { }
+  constructor(public message: string) {}
 }
 
 export default async function bunSqliteStore({
   name = 'cache',
   path = ':memory:',
-  serializer = 'cbor',
+  serializer = 'msgpackr',
   ttl = 24 * 60 * 60, // 1 day in seconds
   ...options
 }: SqliteCacheOptions = {}): Promise<SqliteStore> {
@@ -200,5 +206,5 @@ export default async function bunSqliteStore({
     get client() {
       return db;
     },
-  } as SqliteStore;
+  };
 }

index.ts

@@ -1,11 +1,11 @@
 {
   "name": "cache-manager-bun-sqlite3",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Bun sqlite store for node-cache-manager",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sjdonado/node-cache-manager-sqlite.git"
+    "url": "https://github.com/sjdonado/cache-manager-bun-sqlite3.git"
   },
   "keywords": [
     "cache-manager",
@@ -14,7 +14,8 @@
   "author": "Juan Rodriguez",
   "license": "MIT",
   "dependencies": {
-    "cbor-x": "^1.5.9"
+    "cbor-x": "^1.5.9",
+    "msgpackr": "^1.11.0"
   },
   "devDependencies": {
     "bun-types": "^1.1.20",

package.json

@@ -4,22 +4,58 @@ import cacheManager from 'cache-manager';
 import sqliteStore from '../index.js';
 
 describe('Serializers', () => {
-  it('supports CBOR', async () => {
+  it('supports msgpackr', async () => {
+    const cache = await cacheManager.caching(sqliteStore, {
+      serializer: 'msgpackr',
+    });
+
+    const value = {
+      foo: 'bar',
+      arr: [1, true, null],
+      id: '2KvHC9z14GSl4YpkNMX384',
+      description: 'Test · Unicode · Description',
+      hash: 'https://hash/ab67616d0000b2734f0fd9dad63977146e685700',
+      link: 'https://a.test.com/path/df989a31c8233f46b6a997c59025f9c8021784aa',
+    };
+
+    await cache.set('foo', value);
+
+    expect(await cache.get('foo')).toEqual(value);
+  });
+
+  it('supports cbor', async () => {
     const cache = await cacheManager.caching(sqliteStore, {
       serializer: 'cbor',
     });
 
-    await cache.set('foo', { foo: 'bar', arr: [1, true, null] });
-    expect(await cache.get('foo')).toEqual({ foo: 'bar', arr: [1, true, null] });
+    const value = {
+      foo: 'bar',
+      arr: [1, true, null],
+      id: '2KvHC9z14GSl4YpkNMX384',
+    };
+
+    await cache.set('foo', value);
+
+    expect(await cache.get('foo')).toEqual(value);
   });
 
   it('supports JSON', async () => {
     const cache = await cacheManager.caching(sqliteStore, {
       serializer: 'json',
     });
 
-    await cache.set('foo', { foo: 'bar', arr: [1, true, null] });
-    expect(await cache.get('foo')).toEqual({ foo: 'bar', arr: [1, true, null] });
+    const value = {
+      foo: 'bar',
+      arr: [1, true, null],
+      id: '2KvHC9z14GSl4YpkNMX384',
+      description: 'Test · Unicode · Description',
+      hash: 'https://hash/ab67616d0000b2734f0fd9dad63977146e685700',
+      link: 'https://a.test.com/path/df989a31c8233f46b6a997c59025f9c8021784aa',
+    };
+
+    await cache.set('foo', value);
+
+    expect(await cache.get('foo')).toEqual(value);
   });
 
   it('should throw NoCacheableError when setting a bad object', async () => {