@fedify/redis 2.4.0-dev.2169 → 2.4.0-dev.2190

package/dist/kv.cjs

@@ -30,6 +30,22 @@ let node_buffer = require("node:buffer");
 function expirySeconds(ttl) {
 	return Math.max(1, Math.ceil(ttl.total("second")));
 }
+const casScript = `
+local current = redis.call('GET', KEYS[1])
+if ARGV[1] == '1' then
+  if current then return 0 end
+elseif not current or current ~= ARGV[2] then
+  return 0
+end
+if ARGV[3] == '1' then
+  redis.call('DEL', KEYS[1])
+elseif ARGV[5] ~= '0' then
+  redis.call('SETEX', KEYS[1], ARGV[5], ARGV[4])
+else
+  redis.call('SET', KEYS[1], ARGV[4])
+end
+return 1
+`;
 /**
 * A key–value store that uses Redis as the underlying storage.
 *
@@ -105,6 +121,20 @@ var RedisKvStore = class {
 		const serializedKey = this.#serializeKey(key);
 		await this.#redis.del(serializedKey);
 	}
+	/**
+	* {@inheritDoc KvStore.cas}
+	*
+	* Values are compared as encoded bytes.  A custom {@link Codec} must encode
+	* equal values identically; with {@link JsonCodec}, object property order
+	* affects the comparison.  The `ttl` option follows {@link set}: a
+	* fractional second is rounded up and a non-positive duration uses one
+	* second.
+	* @since 2.4.0
+	*/
+	async cas(key, expectedValue, newValue, options) {
+		const absent = node_buffer.Buffer.alloc(0);
+		return await this.#redis.eval(casScript, 1, this.#serializeKey(key), expectedValue === void 0 ? "1" : "0", expectedValue === void 0 ? absent : this.#codec.encode(expectedValue), newValue === void 0 ? "1" : "0", newValue === void 0 ? absent : this.#codec.encode(newValue), options?.ttl == null ? 0 : expirySeconds(options.ttl)) === 1;
+	}
 	#deserializeKey(redisKey) {
 		return redisKey.slice(this.#keyPrefixStr.length).split("::").map((p) => p.replaceAll("_:", ":"));
 	}

package/dist/kv.d.cts

@@ -16,6 +16,7 @@ interface RedisKvStoreOptions {
   /**
   * The codec to use for encoding and decoding values in the key–value store.
   * Defaults to {@link JsonCodec}.
+  * For {@link RedisKvStore.cas}, equal values must encode to identical bytes.
   */
   readonly codec?: Codec;
 }
@@ -67,6 +68,17 @@ declare class RedisKvStore implements KvStore {
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**
+  * {@inheritDoc KvStore.cas}
+  *
+  * Values are compared as encoded bytes.  A custom {@link Codec} must encode
+  * equal values identically; with {@link JsonCodec}, object property order
+  * affects the comparison.  The `ttl` option follows {@link set}: a
+  * fractional second is rounded up and a non-positive duration uses one
+  * second.
+  * @since 2.4.0
+  */
+  cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
   * {@inheritDoc KvStore.list}
   * @since 1.10.0
   */

package/dist/kv.d.ts

@@ -16,6 +16,7 @@ interface RedisKvStoreOptions {
   /**
   * The codec to use for encoding and decoding values in the key–value store.
   * Defaults to {@link JsonCodec}.
+  * For {@link RedisKvStore.cas}, equal values must encode to identical bytes.
   */
   readonly codec?: Codec;
 }
@@ -67,6 +68,17 @@ declare class RedisKvStore implements KvStore {
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
   /**
+  * {@inheritDoc KvStore.cas}
+  *
+  * Values are compared as encoded bytes.  A custom {@link Codec} must encode
+  * equal values identically; with {@link JsonCodec}, object property order
+  * affects the comparison.  The `ttl` option follows {@link set}: a
+  * fractional second is rounded up and a non-positive duration uses one
+  * second.
+  * @since 2.4.0
+  */
+  cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
   * {@inheritDoc KvStore.list}
   * @since 1.10.0
   */

package/dist/kv.js

@@ -29,6 +29,22 @@ import { Buffer } from "node:buffer";
 function expirySeconds(ttl) {
 	return Math.max(1, Math.ceil(ttl.total("second")));
 }
+const casScript = `
+local current = redis.call('GET', KEYS[1])
+if ARGV[1] == '1' then
+  if current then return 0 end
+elseif not current or current ~= ARGV[2] then
+  return 0
+end
+if ARGV[3] == '1' then
+  redis.call('DEL', KEYS[1])
+elseif ARGV[5] ~= '0' then
+  redis.call('SETEX', KEYS[1], ARGV[5], ARGV[4])
+else
+  redis.call('SET', KEYS[1], ARGV[4])
+end
+return 1
+`;
 /**
 * A key–value store that uses Redis as the underlying storage.
 *
@@ -104,6 +120,20 @@ var RedisKvStore = class {
 		const serializedKey = this.#serializeKey(key);
 		await this.#redis.del(serializedKey);
 	}
+	/**
+	* {@inheritDoc KvStore.cas}
+	*
+	* Values are compared as encoded bytes.  A custom {@link Codec} must encode
+	* equal values identically; with {@link JsonCodec}, object property order
+	* affects the comparison.  The `ttl` option follows {@link set}: a
+	* fractional second is rounded up and a non-positive duration uses one
+	* second.
+	* @since 2.4.0
+	*/
+	async cas(key, expectedValue, newValue, options) {
+		const absent = Buffer.alloc(0);
+		return await this.#redis.eval(casScript, 1, this.#serializeKey(key), expectedValue === void 0 ? "1" : "0", expectedValue === void 0 ? absent : this.#codec.encode(expectedValue), newValue === void 0 ? "1" : "0", newValue === void 0 ? absent : this.#codec.encode(newValue), options?.ttl == null ? 0 : expirySeconds(options.ttl)) === 1;
+	}
 	#deserializeKey(redisKey) {
 		return redisKey.slice(this.#keyPrefixStr.length).split("::").map((p) => p.replaceAll("_:", ":"));
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/redis",
-  "version": "2.4.0-dev.2169+0a45df07",
+  "version": "2.4.0-dev.2190+be3a8be0",
   "description": "Redis drivers for Fedify",
   "keywords": [
     "fedify",
@@ -79,7 +79,7 @@
   },
   "peerDependencies": {
     "ioredis": "^5.8.2",
-    "@fedify/fedify": "^2.4.0-dev.2169+0a45df07"
+    "@fedify/fedify": "^2.4.0-dev.2190+be3a8be0"
   },
   "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.2169+0a45df07"
+    "@fedify/testing": "^2.4.0-dev.2190+be3a8be0"
   },
   "scripts": {
     "build:self": "tsdown",