DX-2439: add sintercard (#1413)

* feat: add sintercard

* fix: fmt

* fix: add sleep between script load and evalsha to fix race condition with replication

Author: CahidArda

.claude/CLAUDE.md

@@ -0,0 +1,101 @@
+# redis-js SDK
+
+## Adding a New Redis Command
+
+You need to touch **6 files** (2 new, 4 existing):
+
+### 1. Create the command file: `pkg/commands/<command_name>.ts`
+
+```typescript
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ * @see https://redis.io/commands/<command-name>
+ */
+export class MyCommand extends Command<TResult, TData> {
+  constructor(cmd: [...args], opts?: CommandOptions<TResult, TData>) {
+    super(["mycommand", ...builtArgs], opts);
+  }
+}
+```
+
+Key patterns:
+
+- `Command<number, number>` for commands returning a count (SCARD, SINTERCARD, SINTERSTORE)
+- `Command<unknown[], TData[]>` for commands returning arrays (SINTER, SMEMBERS)
+- Constructor first param is a tuple of the command's Redis arguments
+- Constructor second param is always `CommandOptions`
+- Call `super(["commandname", ...args], opts)` to build the Redis command array
+- For optional params (like LIMIT), conditionally push to the command array:
+  ```typescript
+  if (opts?.limit !== undefined) {
+    command.push("LIMIT", opts.limit);
+  }
+  ```
+- For commands taking a variable number of keys with a numkeys param, accept `keys: string[]` and spread: `["cmd", keys.length, ...keys]`
+
+### 2. Create the test file: `pkg/commands/<command_name>.test.ts`
+
+```typescript
+import { keygen, newHttpClient, randomID } from "../test-utils";
+import { afterAll, expect, test } from "bun:test";
+import { SAddCommand } from "./sadd"; // or whatever setup commands needed
+import { MyCommand } from "./my_command";
+
+const client = newHttpClient();
+const { newKey, cleanup } = keygen();
+afterAll(cleanup);
+
+test("description", async () => {
+  const key = newKey();
+  // setup
+  const res = await new MyCommand([...args]).exec(client);
+  expect(res).toEqual(expected);
+});
+```
+
+Run tests with: `npx bun test pkg/commands/<command_name>.test.ts`
+
+### 3. Add export to `pkg/commands/mod.ts`
+
+Insert `export * from "./<command_name>";` in alphabetical order among existing exports.
+
+### 4. Add type export to `pkg/commands/types.ts`
+
+Insert `export { type MyCommand } from "./<command_name>";` in alphabetical order.
+
+### 5. Add method to `pkg/redis.ts`
+
+- Add `MyCommand` to the import block from `"./commands/mod"` (alphabetical within the S/Z/etc group)
+- Add method to the class (alphabetical among similar commands):
+
+```typescript
+/**
+ * @see https://redis.io/commands/<command-name>
+ */
+mycommand = (...args: CommandArgs<typeof MyCommand>) =>
+  new MyCommand(args, this.opts).exec(this.client);
+```
+
+### 6. Add method to `pkg/pipeline.ts`
+
+- Same import addition as redis.ts
+- Add method using `this.chain()` instead of `.exec()`:
+
+```typescript
+/**
+ * @see https://redis.io/commands/<command-name>
+ */
+mycommand = (...args: CommandArgs<typeof MyCommand>) =>
+  this.chain(new MyCommand(args, this.commandOptions));
+```
+
+### Checklist
+
+- [ ] `pkg/commands/<name>.ts` - Command class
+- [ ] `pkg/commands/<name>.test.ts` - Tests
+- [ ] `pkg/commands/mod.ts` - Add `export *` line
+- [ ] `pkg/commands/types.ts` - Add `export { type }` line
+- [ ] `pkg/redis.ts` - Add import + method
+- [ ] `pkg/pipeline.ts` - Add import + method
+- [ ] Run `npx bun test pkg/commands/<name>.test.ts` to verify

pkg/commands/evalshaRo.test.ts

@@ -14,6 +14,10 @@ describe("without keys", () => {
   test("returns something", async () => {
     const value = randomID();
     const sha1 = await new ScriptLoadCommand([`return {ARGV[1], "${value}"}`]).exec(client);
+
+    // sleep 150 ms
+    await new Promise((resolve) => setTimeout(resolve, 150));
+
     const res = await new EvalshaROCommand([sha1, [], [value]]).exec(client);
     expect(res).toEqual([value, value]);
   });

pkg/commands/mod.ts

@@ -141,6 +141,7 @@ export * from "./setex";
 export * from "./setnx";
 export * from "./setrange";
 export * from "./sinter";
+export * from "./sintercard";
 export * from "./sinterstore";
 export * from "./sismember";
 export * from "./smembers";

pkg/commands/sintercard.test.ts

@@ -0,0 +1,32 @@
+import { keygen, newHttpClient, randomID } from "../test-utils";
+
+import { afterAll, expect, test } from "bun:test";
+import { SAddCommand } from "./sadd";
+import { SInterCardCommand } from "./sintercard";
+
+const client = newHttpClient();
+
+const { newKey, cleanup } = keygen();
+afterAll(cleanup);
+
+test("returns the cardinality of the intersection", async () => {
+  const key1 = newKey();
+  const key2 = newKey();
+  const member1 = randomID();
+  const member2 = randomID();
+  await new SAddCommand([key1, member1, member2]).exec(client);
+  await new SAddCommand([key2, member1]).exec(client);
+  const res = await new SInterCardCommand([[key1, key2]]).exec(client);
+  expect(res).toEqual(1);
+});
+
+test("with limit", async () => {
+  const key1 = newKey();
+  const key2 = newKey();
+  const member1 = randomID();
+  const member2 = randomID();
+  await new SAddCommand([key1, member1, member2]).exec(client);
+  await new SAddCommand([key2, member1, member2]).exec(client);
+  const res = await new SInterCardCommand([[key1, key2], { limit: 1 }]).exec(client);
+  expect(res).toEqual(1);
+});

pkg/commands/sintercard.ts

@@ -0,0 +1,19 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ * @see https://redis.io/commands/sintercard
+ */
+export class SInterCardCommand extends Command<number, number> {
+  constructor(
+    cmd: [keys: string[], opts?: { limit?: number }],
+    cmdOpts?: CommandOptions<number, number>
+  ) {
+    const [keys, opts] = cmd;
+
+    const command: unknown[] = ["sintercard", keys.length, ...keys];
+    if (opts?.limit !== undefined) {
+      command.push("LIMIT", opts.limit);
+    }
+    super(command, cmdOpts);
+  }
+}

pkg/commands/types.ts

@@ -125,6 +125,7 @@ export { type SetExCommand } from "./setex";
 export { type SetNxCommand } from "./setnx";
 export { type SetRangeCommand } from "./setrange";
 export { type SInterCommand } from "./sinter";
+export { type SInterCardCommand } from "./sintercard";
 export { type SInterStoreCommand } from "./sinterstore";
 export { type SIsMemberCommand } from "./sismember";
 export { type SMembersCommand } from "./smembers";

pkg/pipeline.ts

@@ -138,6 +138,7 @@ import {
   SDiffCommand,
   SDiffStoreCommand,
   SInterCommand,
+  SInterCardCommand,
   SInterStoreCommand,
   SIsMemberCommand,
   SMIsMemberCommand,
@@ -1088,6 +1089,12 @@ export class Pipeline<TCommands extends Command<any, any>[] = []> {
   sinter = (...args: CommandArgs<typeof SInterCommand>) =>
     this.chain(new SInterCommand(args, this.commandOptions));
 
+  /**
+   * @see https://redis.io/commands/sintercard
+   */
+  sintercard = (...args: CommandArgs<typeof SInterCardCommand>) =>
+    this.chain(new SInterCardCommand(args, this.commandOptions));
+
   /**
    * @see https://redis.io/commands/sinterstore
    */

pkg/redis.ts

@@ -143,6 +143,7 @@ import {
   SDiffCommand,
   SDiffStoreCommand,
   SInterCommand,
+  SInterCardCommand,
   SInterStoreCommand,
   SIsMemberCommand,
   SMIsMemberCommand,
@@ -1276,6 +1277,12 @@ export class Redis {
   sinter = (...args: CommandArgs<typeof SInterCommand>) =>
     new SInterCommand(args, this.opts).exec(this.client);
 
+  /**
+   * @see https://redis.io/commands/sintercard
+   */
+  sintercard = (...args: CommandArgs<typeof SInterCardCommand>) =>
+    new SInterCardCommand(args, this.opts).exec(this.client);
+
   /**
    * @see https://redis.io/commands/sinterstore
    */