@atproto-labs/simple-store-redis 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atproto-labs/simple-store-redis
+
+## 0.0.1
+
+### Patch Changes
+
+- [#4149](https://github.com/bluesky-social/atproto/pull/4149) [`8914f9abd`](https://github.com/bluesky-social/atproto/commit/8914f9abde2059c551d7e4c8d104227986098b82) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Initial implementation of redis based `SimpleStore` implementation

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Dual MIT/Apache-2.0 License
+
+Copyright (c) 2022-2025 Bluesky Social PBC, and Contributors
+
+Except as otherwise noted in individual files, this software is licensed under the MIT license (<http://opensource.org/licenses/MIT>), or the Apache License, Version 2.0 (<http://www.apache.org/licenses/LICENSE-2.0>).
+
+Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import type { Redis } from 'ioredis';
+import { Awaitable, GetOptions, SimpleStore, Value } from '@atproto-labs/simple-store';
+export type { Awaitable, GetOptions, SimpleStore, Value };
+export type Encoder<K extends string, V extends Value> = (value: V, key: K) => Awaitable<string>;
+export type Decoder<K extends string, V extends Value> = (value: string, key: K) => Awaitable<V>;
+export declare const defaultEncoder: Encoder<any, Value>;
+export declare const defaultDecoder: Decoder<any, Value>;
+export type SimpleStoreRedisOptions<K extends string, V extends Value> = {
+    keyPrefix: string;
+    /** In milliseconds */
+    ttl?: number;
+    /** @default JSON.stringify */
+    encode?: Encoder<K, V>;
+    /** @default JSON.parse */
+    decode?: Decoder<K, V>;
+};
+export declare class SimpleStoreRedis<K extends string, V extends Value> implements SimpleStore<K, V> {
+    protected readonly redis: Redis;
+    protected readonly options: SimpleStoreRedisOptions<K, V>;
+    constructor(redis: Redis, options: SimpleStoreRedisOptions<K, V>);
+    protected encodeKey(key: K): string;
+    get(key: K, options?: GetOptions): Promise<V | undefined>;
+    set(key: K, value: V): Promise<void>;
+    del(key: K): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EACL,SAAS,EACT,UAAU,EACV,WAAW,EACX,KAAK,EACN,MAAM,4BAA4B,CAAA;AAEnC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;AAEzD,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,KAAK,IAAI,CACvD,KAAK,EAAE,CAAC,EACR,GAAG,EAAE,CAAC,KACH,SAAS,CAAC,MAAM,CAAC,CAAA;AACtB,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,KAAK,IAAI,CACvD,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,CAAC,KACH,SAAS,CAAC,CAAC,CAAC,CAAA;AAEjB,eAAO,MAAM,cAAc,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,CACxB,CAAA;AACvB,eAAO,MAAM,cAAc,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,CAAgC,CAAA;AAE/E,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,KAAK,IAAI;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,8BAA8B;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACtB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CACvB,CAAA;AAED,qBAAa,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,KAAK,CAC7D,YAAW,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAG1B,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK;IAC/B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC;gBADtC,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC;IAU3D,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG,MAAM;IAI7B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IASzD,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAIjC"}

package/dist/index.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleStoreRedis = exports.defaultDecoder = exports.defaultEncoder = void 0;
+const defaultEncoder = (value) => JSON.stringify(value);
+exports.defaultEncoder = defaultEncoder;
+const defaultDecoder = (value) => JSON.parse(value);
+exports.defaultDecoder = defaultDecoder;
+class SimpleStoreRedis {
+    constructor(redis, options) {
+        Object.defineProperty(this, "redis", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: redis
+        });
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: options
+        });
+        if (!options.keyPrefix) {
+            throw new TypeError(`keyPrefix must be a non-empty string`);
+        }
+        if (options.ttl != null && options.ttl <= 0) {
+            throw new TypeError(`ttl must be greater than 0`);
+        }
+    }
+    encodeKey(key) {
+        return `${this.options.keyPrefix}${key}`;
+    }
+    async get(key, options) {
+        const eKey = this.encodeKey(key);
+        const eValue = await this.redis.get(eKey);
+        if (eValue == null)
+            return undefined;
+        options?.signal?.throwIfAborted();
+        const { decode = exports.defaultDecoder } = this.options;
+        return decode(eValue, key);
+    }
+    async set(key, value) {
+        const eKey = this.encodeKey(key);
+        const { encode = exports.defaultEncoder, ttl } = this.options;
+        const eValue = await encode(value, key);
+        if (ttl)
+            await this.redis.set(eKey, eValue, 'PX', ttl);
+        else
+            await this.redis.set(eKey, eValue);
+    }
+    async del(key) {
+        const eKey = this.encodeKey(key);
+        await this.redis.del(eKey);
+    }
+}
+exports.SimpleStoreRedis = SimpleStoreRedis;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAmBO,MAAM,cAAc,GAAwB,CAAC,KAAK,EAAE,EAAE,CAC3D,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AADV,QAAA,cAAc,kBACJ;AAChB,MAAM,cAAc,GAAwB,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAAlE,QAAA,cAAc,kBAAoD;AAY/E,MAAa,gBAAgB;IAG3B,YACqB,KAAY,EACZ,OAAsC;QADzD;;;;mBAAmB,KAAK;WAAO;QAC/B;;;;mBAAmB,OAAO;WAA+B;QAEzD,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAA;QAC7D,CAAC;QACD,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAA;QACnD,CAAC;IACH,CAAC;IAES,SAAS,CAAC,GAAM;QACxB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,GAAoB,EAAE,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAM,EAAE,OAAoB;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACzC,IAAI,MAAM,IAAI,IAAI;YAAE,OAAO,SAAS,CAAA;QACpC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QACjC,MAAM,EAAE,MAAM,GAAG,sBAAiC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QACnE,OAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAM,EAAE,KAAQ;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,EAAE,MAAM,GAAG,sBAAc,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QACrD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACvC,IAAI,GAAG;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;;YACjD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAM;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;CACF;AAxCD,4CAwCC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@atproto-labs/simple-store-redis",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Redis based simple-store implementation",
+  "keywords": [
+    "cache",
+    "node",
+    "memory"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/internal/simple-store-redis"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@atproto-labs/simple-store": "0.3.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "ioredis": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json"
+  }
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+import type { Redis } from 'ioredis'
+import {
+  Awaitable,
+  GetOptions,
+  SimpleStore,
+  Value,
+} from '@atproto-labs/simple-store'
+
+export type { Awaitable, GetOptions, SimpleStore, Value }
+
+export type Encoder<K extends string, V extends Value> = (
+  value: V,
+  key: K,
+) => Awaitable<string>
+export type Decoder<K extends string, V extends Value> = (
+  value: string,
+  key: K,
+) => Awaitable<V>
+
+export const defaultEncoder: Encoder<any, Value> = (value) =>
+  JSON.stringify(value)
+export const defaultDecoder: Decoder<any, Value> = (value) => JSON.parse(value)
+
+export type SimpleStoreRedisOptions<K extends string, V extends Value> = {
+  keyPrefix: string
+  /** In milliseconds */
+  ttl?: number
+  /** @default JSON.stringify */
+  encode?: Encoder<K, V>
+  /** @default JSON.parse */
+  decode?: Decoder<K, V>
+}
+
+export class SimpleStoreRedis<K extends string, V extends Value>
+  implements SimpleStore<K, V>
+{
+  constructor(
+    protected readonly redis: Redis,
+    protected readonly options: SimpleStoreRedisOptions<K, V>,
+  ) {
+    if (!options.keyPrefix) {
+      throw new TypeError(`keyPrefix must be a non-empty string`)
+    }
+    if (options.ttl != null && options.ttl <= 0) {
+      throw new TypeError(`ttl must be greater than 0`)
+    }
+  }
+
+  protected encodeKey(key: K): string {
+    return `${this.options.keyPrefix}${key satisfies string}`
+  }
+
+  async get(key: K, options?: GetOptions): Promise<V | undefined> {
+    const eKey = this.encodeKey(key)
+    const eValue = await this.redis.get(eKey)
+    if (eValue == null) return undefined
+    options?.signal?.throwIfAborted()
+    const { decode = defaultDecoder as Decoder<any, V> } = this.options
+    return decode(eValue, key)
+  }
+
+  async set(key: K, value: V): Promise<void> {
+    const eKey = this.encodeKey(key)
+    const { encode = defaultEncoder, ttl } = this.options
+    const eValue = await encode(value, key)
+    if (ttl) await this.redis.set(eKey, eValue, 'PX', ttl)
+    else await this.redis.set(eKey, eValue)
+  }
+
+  async del(key: K): Promise<void> {
+    const eKey = this.encodeKey(key)
+    await this.redis.del(eKey)
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../tsconfig/node.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}

package/tsconfig.build.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts"],"version":"5.8.3"}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "include": [],
+  "references": [{ "path": "./tsconfig.build.json" }]
+}