@fedify/redis 2.4.0-dev.1962 → 2.4.0-dev.1988

package/dist/kv.cjs

@@ -4,6 +4,33 @@ const require_codec = require("./codec.cjs");
 let node_buffer = require("node:buffer");
 //#region src/kv.ts
 /**
+* Turns a TTL into the whole number of seconds Redis `SETEX` requires.
+*
+* The one-second granularity is `SETEX`'s, not Redis's: Redis can express a
+* millisecond expiry through `SET` with `PX`, and `SETEX` is simply the
+* command this adapter uses.  Within that command a duration which is not a
+* whole number of seconds has to be approximated.
+*
+* It is rounded up rather than to the nearest second, because every other
+* {@link KvStore} implementation keeps a value for at least as long as it was
+* asked to, and expiring early is the direction that can change behaviour
+* rather than just cost a refetch — a TTL used to suppress duplicate work
+* would start letting duplicates through.
+*
+* The result is clamped to 1, the smallest expiry `SETEX` accepts.  A
+* sub-second duration therefore stores the value for one second instead of
+* being rejected, and so do **zero and negative durations**, which `SETEX`
+* rejects outright.  That last part is a policy choice rather than a
+* consequence of the rounding: the other {@link KvStore} implementations read
+* a non-positive TTL as already expired, whereas this one keeps the value for
+* the shortest lifetime the command can express.  Storing it briefly is closer
+* to the caller's request than failing the write, which is what happened
+* before.
+*/
+function expirySeconds(ttl) {
+	return Math.max(1, Math.ceil(ttl.total("second")));
+}
+/**
 * A key–value store that uses Redis as the underlying storage.
 *
 * @example
@@ -59,10 +86,19 @@ var RedisKvStore = class {
 		if (encodedValue == null) return void 0;
 		return this.#codec.decode(encodedValue);
 	}
+	/**
+	* {@inheritDoc KvStore.set}
+	*
+	* The `ttl` option is stored through Redis `SETEX`, which takes a whole
+	* number of seconds, so a duration with a finer resolution is rounded up to
+	* the next second.  A zero or negative duration stores the value for one
+	* second, the shortest expiry the command can express, rather than failing
+	* the write or deleting the key.
+	*/
 	async set(key, value, options) {
 		const serializedKey = this.#serializeKey(key);
 		const encodedValue = this.#codec.encode(value);
-		if (options?.ttl != null) await this.#redis.setex(serializedKey, options.ttl.total("second"), encodedValue);
+		if (options?.ttl != null) await this.#redis.setex(serializedKey, expirySeconds(options.ttl), encodedValue);
 		else await this.#redis.set(serializedKey, encodedValue);
 	}
 	async delete(key) {

package/dist/kv.d.cts

@@ -55,6 +55,15 @@ declare class RedisKvStore implements KvStore {
   */
   constructor(redis: Redis | Cluster, options?: RedisKvStoreOptions);
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
+  /**
+  * {@inheritDoc KvStore.set}
+  *
+  * The `ttl` option is stored through Redis `SETEX`, which takes a whole
+  * number of seconds, so a duration with a finer resolution is rounded up to
+  * the next second.  A zero or negative duration stores the value for one
+  * second, the shortest expiry the command can express, rather than failing
+  * the write or deleting the key.
+  */
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**

package/dist/kv.d.ts

@@ -55,6 +55,15 @@ declare class RedisKvStore implements KvStore {
   */
   constructor(redis: Redis | Cluster, options?: RedisKvStoreOptions);
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
+  /**
+  * {@inheritDoc KvStore.set}
+  *
+  * The `ttl` option is stored through Redis `SETEX`, which takes a whole
+  * number of seconds, so a duration with a finer resolution is rounded up to
+  * the next second.  A zero or negative duration stores the value for one
+  * second, the shortest expiry the command can express, rather than failing
+  * the write or deleting the key.
+  */
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**

package/dist/kv.js

@@ -3,6 +3,33 @@ import { JsonCodec } from "./codec.js";
 import { Buffer } from "node:buffer";
 //#region src/kv.ts
 /**
+* Turns a TTL into the whole number of seconds Redis `SETEX` requires.
+*
+* The one-second granularity is `SETEX`'s, not Redis's: Redis can express a
+* millisecond expiry through `SET` with `PX`, and `SETEX` is simply the
+* command this adapter uses.  Within that command a duration which is not a
+* whole number of seconds has to be approximated.
+*
+* It is rounded up rather than to the nearest second, because every other
+* {@link KvStore} implementation keeps a value for at least as long as it was
+* asked to, and expiring early is the direction that can change behaviour
+* rather than just cost a refetch — a TTL used to suppress duplicate work
+* would start letting duplicates through.
+*
+* The result is clamped to 1, the smallest expiry `SETEX` accepts.  A
+* sub-second duration therefore stores the value for one second instead of
+* being rejected, and so do **zero and negative durations**, which `SETEX`
+* rejects outright.  That last part is a policy choice rather than a
+* consequence of the rounding: the other {@link KvStore} implementations read
+* a non-positive TTL as already expired, whereas this one keeps the value for
+* the shortest lifetime the command can express.  Storing it briefly is closer
+* to the caller's request than failing the write, which is what happened
+* before.
+*/
+function expirySeconds(ttl) {
+	return Math.max(1, Math.ceil(ttl.total("second")));
+}
+/**
 * A key–value store that uses Redis as the underlying storage.
 *
 * @example
@@ -58,10 +85,19 @@ var RedisKvStore = class {
 		if (encodedValue == null) return void 0;
 		return this.#codec.decode(encodedValue);
 	}
+	/**
+	* {@inheritDoc KvStore.set}
+	*
+	* The `ttl` option is stored through Redis `SETEX`, which takes a whole
+	* number of seconds, so a duration with a finer resolution is rounded up to
+	* the next second.  A zero or negative duration stores the value for one
+	* second, the shortest expiry the command can express, rather than failing
+	* the write or deleting the key.
+	*/
 	async set(key, value, options) {
 		const serializedKey = this.#serializeKey(key);
 		const encodedValue = this.#codec.encode(value);
-		if (options?.ttl != null) await this.#redis.setex(serializedKey, options.ttl.total("second"), encodedValue);
+		if (options?.ttl != null) await this.#redis.setex(serializedKey, expirySeconds(options.ttl), encodedValue);
 		else await this.#redis.set(serializedKey, encodedValue);
 	}
 	async delete(key) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/redis",
-  "version": "2.4.0-dev.1962+8aaa5348",
+  "version": "2.4.0-dev.1988+c5c9d617",
   "description": "Redis drivers for Fedify",
   "keywords": [
     "fedify",
@@ -79,7 +79,7 @@
   },
   "peerDependencies": {
     "ioredis": "^5.8.2",
-    "@fedify/fedify": "^2.4.0-dev.1962+8aaa5348"
+    "@fedify/fedify": "^2.4.0-dev.1988+c5c9d617"
   },
   "devDependencies": {
     "@std/async": "npm:@jsr/std__async@^1.0.13",
@@ -88,7 +88,7 @@
     "tsdown": "^0.22.0",
     "typescript": "^6.0.0",
     "@fedify/fixture": "^2.0.0",
-    "@fedify/testing": "^2.4.0-dev.1962+8aaa5348"
+    "@fedify/testing": "^2.4.0-dev.1988+c5c9d617"
   },
   "scripts": {
     "build:self": "tsdown",