[CAE-686] Added hash field expiration commands

Author: htemelski-redis

packages/client/lib/commands/HGETDEL.spec.ts

@@ -0,0 +1,49 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../test-utils';
+import { BasicCommandParser } from '../client/parser';
+import HGETDEL from './HGETDEL';
+
+describe('HGETDEL parseCommand', () => {
+    it('hGetDel parseCommand base', () => {
+        const parser = new BasicCommandParser;
+        HGETDEL.parseCommand(parser, 'key', 'field');
+        assert.deepEqual(parser.redisArgs, ['HGETDEL', 'key', 'FIELDS', '1', 'field']);
+    });
+
+    it('hGetDel parseCommand variadic', () => {
+        const parser = new BasicCommandParser;
+        HGETDEL.parseCommand(parser, 'key', ['field1', 'field2']);
+        assert.deepEqual(parser.redisArgs, ['HGETDEL', 'key', 'FIELDS', '2', 'field1', 'field2']);
+    });
+});
+
+
+// TODO: enable when new test container is released
+describe.skip('HGETDEL call', () => {
+  testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetDel empty single field', async client => {
+    assert.deepEqual(
+        await client.hGetDel('key', 'filed1'),
+        [null]
+    );
+  }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetDel empty multiple fields', async client => {
+    assert.deepEqual(
+        await client.hGetDel('key', ['filed1', 'field2']),
+        [null, null]
+    );
+  }, GLOBAL.SERVERS.OPEN);
+
+  testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetDel partially populated multiple fields', async client => {
+    await client.hSet('key', 'field1', 'value1')
+    assert.deepEqual(
+        await client.hGetDel('key', ['filed1', 'field2']),
+        ['value1', null]
+    );
+    
+    assert.deepEqual(
+        await client.hGetDel('key', 'field1'),
+        [null]
+    );
+  }, GLOBAL.SERVERS.OPEN);
+});

packages/client/lib/commands/HGETDEL.ts

@@ -0,0 +1,13 @@
+import { CommandParser } from '../client/parser';
+import { RedisVariadicArgument } from './generic-transformers';
+import { RedisArgument, ArrayReply, BlobStringReply, NullReply, Command } from '../RESP/types';
+
+export default {
+  parseCommand(parser: CommandParser, key: RedisArgument, fields: RedisVariadicArgument) {
+    parser.push('HGETDEL');
+    parser.pushKey(key);
+    parser.push('FIELDS')
+    parser.pushVariadicWithLength(fields);
+  },
+  transformReply: undefined as unknown as () => ArrayReply<BlobStringReply | NullReply>
+} as const satisfies Command;

packages/client/lib/commands/HGETEX.spec.ts

@@ -0,0 +1,79 @@
+import { strict as assert } from 'node:assert';
+import testUtils,{ GLOBAL, sleep } from '../test-utils';
+import { BasicCommandParser } from '../client/parser';
+import HGETEX from './HGETEX';
+
+describe('HGETEX parseCommand', () => {
+  it('hGetEx parseCommand base', () => {
+    const parser = new BasicCommandParser;
+    HGETEX.parseCommand(parser, 'key', 'field');
+    assert.deepEqual(parser.redisArgs, ['HGETEX', 'key', 'FIELDS', '1', 'field']);
+  });
+
+  it('hGetEx parseCommand expiration PERSIST string', () => {
+    const parser = new BasicCommandParser;
+    HGETEX.parseCommand(parser, 'key', 'field', {expiration: 'PERSIST'});
+    assert.deepEqual(parser.redisArgs, ['HGETEX', 'key', 'PERSIST', 'FIELDS', '1', 'field']);
+  });
+
+  it('hGetEx parseCommand expiration PERSIST obj', () => {
+    const parser = new BasicCommandParser;
+    HGETEX.parseCommand(parser, 'key', 'field', {expiration: {type: 'PERSIST'}});
+    assert.deepEqual(parser.redisArgs, ['HGETEX', 'key', 'PERSIST', 'FIELDS', '1', 'field']);
+  });
+
+  it('hGetEx parseCommand expiration EX obj', () => {
+    const parser = new BasicCommandParser;
+    HGETEX.parseCommand(parser, 'key', 'field', {expiration: {type: 'EX', value: 1000}});
+    assert.deepEqual(parser.redisArgs, ['HGETEX', 'key', 'EX', '1000', 'FIELDS', '1', 'field']);
+  });
+
+  it('hGetEx parseCommand expiration EXAT obj variadic', () => {
+    const parser = new BasicCommandParser;
+    HGETEX.parseCommand(parser, 'key', ['field1', 'field2'], {expiration: {type: 'EXAT', value: 1000}});
+    assert.deepEqual(parser.redisArgs, ['HGETEX', 'key', 'EXAT', '1000', 'FIELDS', '2', 'field1', 'field2']);
+  });
+});
+
+
+// TODO: enable when new test container is released
+describe.skip('HGETEX call', () => {
+    testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetEx empty single field', async client => {
+      assert.deepEqual(
+        await client.hGetEx('key', 'filed1', {expiration: 'PERSIST'}),
+        [null]
+      );
+    }, GLOBAL.SERVERS.OPEN);
+  
+    testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetEx empty multiple fields', async client => {
+      assert.deepEqual(
+        await client.hGetEx('key', ['filed1', 'field2'], {expiration: 'PERSIST'}),
+        [null, null]
+      );
+    }, GLOBAL.SERVERS.OPEN);
+
+    testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hGetEx set expiry', async client => {
+        await client.hSet('key', 'field', 'value')
+        assert.deepEqual(
+            await client.hGetEx('key', 'field', {expiration: {type: 'PX', value: 500}}),
+            ['value']
+        );
+
+        await sleep(600)
+        assert.deepEqual(
+            await client.hGet('key', 'field'),
+            null
+        );  
+    }, GLOBAL.SERVERS.OPEN);
+
+    testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'gGetEx set expiry PERSIST', async client => {
+        await client.hSet('key', 'field', 'value')
+        await client.hGetEx('key', 'field', {expiration: {type: 'PX', value: 500}})
+        await client.hGetEx('key', 'field', {expiration: 'PERSIST'})
+        await sleep(600)
+        assert.deepEqual(
+            await client.hGet('key', 'field'),
+            'value'
+        )
+    }, GLOBAL.SERVERS.OPEN);
+});

packages/client/lib/commands/HGETEX.ts

@@ -0,0 +1,42 @@
+import { CommandParser } from '../client/parser';
+import { RedisVariadicArgument } from './generic-transformers';
+import { ArrayReply, Command, BlobStringReply, NullReply, RedisArgument } from '../RESP/types';
+
+export interface HGetExOptions {
+  expiration?: {
+    type: 'EX' | 'PX' | 'EXAT' | 'PXAT';
+    value: number;
+  } | {
+    type: 'PERSIST';
+  } | 'PERSIST';
+}
+
+export default {
+  parseCommand(
+    parser: CommandParser,
+    key: RedisArgument,
+    fields: RedisVariadicArgument,
+    options?: HGetExOptions
+  ) {
+    parser.push('HGETEX');
+    parser.pushKey(key);
+
+    if (options?.expiration) {
+        if (typeof options.expiration === 'string') {
+          parser.push(options.expiration);
+        } else if (options.expiration.type === 'PERSIST') {
+          parser.push('PERSIST');
+        } else {
+          parser.push(
+            options.expiration.type,
+            options.expiration.value.toString()
+          );
+        }
+    }
+
+    parser.push('FIELDS')
+
+    parser.pushVariadicWithLength(fields);
+  },
+  transformReply: undefined as unknown as () => ArrayReply<BlobStringReply | NullReply>
+} as const satisfies Command;

packages/client/lib/commands/HSETEX.spec.ts

@@ -0,0 +1,99 @@
+import { strict as assert } from 'node:assert';
+import testUtils,{ GLOBAL, sleep } from '../test-utils';
+import { BasicCommandParser } from '../client/parser';
+import HSETEX from './HSETEX';
+
+describe('HSETEX parseCommand', () => {
+  it('hSetEx parseCommand base', () => {
+    const parser = new BasicCommandParser;
+    HSETEX.parseCommand(parser, 'key', {}, 'field', 'value');
+    assert.deepEqual(parser.redisArgs, ['HSETEX', 'key', 'FIELDS', '1', 'field', 'value']);
+  });
+
+  it('hSetEx parseCommand base empty obj', () => {
+    const parser = new BasicCommandParser;
+    assert.throws(() => {HSETEX.parseCommand(parser, 'key', {}, {})});
+  });
+
+  it('hSetEx parseCommand base one key obj', () => {
+    const parser = new BasicCommandParser;
+    HSETEX.parseCommand(parser, 'key', {}, {'k': 'v'});
+    assert.deepEqual(parser.redisArgs, ['HSETEX', 'key', 'FIELDS', '1', 'k', 'v']);
+  });
+
+  it('hSetEx parseCommand array', () => {
+    const parser = new BasicCommandParser;
+    HSETEX.parseCommand(parser, 'key', {}, ['field1', 'value1', 'field2', 'value2']);
+    assert.deepEqual(parser.redisArgs, ['HSETEX', 'key', 'FIELDS', '2', 'field1', 'value1', 'field2', 'value2']);
+  });
+
+  it('hSetEx parseCommand array invalid args, thows error', () => {
+    const parser = new BasicCommandParser;
+    assert.throws(() => {HSETEX.parseCommand(parser, 'key', {}, ['field1', 'value1', 'field2'])});
+  });
+
+  it('hSetEx parseCommand array in array', () => {
+    const parser1 = new BasicCommandParser;
+    HSETEX.parseCommand(parser1, 'key', {}, [['field1', 'value1'], ['field2', 'value2']]);
+    assert.deepEqual(parser1.redisArgs, ['HSETEX', 'key', 'FIELDS', '2', 'field1', 'value1', 'field2', 'value2']);
+
+    const parser2 = new BasicCommandParser;
+    HSETEX.parseCommand(parser2, 'key', {}, [['field1', 'value1'], ['field2', 'value2'], ['field3', 'value3']]);
+    assert.deepEqual(parser2.redisArgs, ['HSETEX', 'key', 'FIELDS', '3', 'field1', 'value1', 'field2', 'value2', 'field3', 'value3']);
+  });
+  
+  it('hSetEx parseCommand map', () => {
+    const parser1 = new BasicCommandParser;
+    HSETEX.parseCommand(parser1, 'key', {}, new Map([['field1', 'value1'], ['field2', 'value2']]));
+    assert.deepEqual(parser1.redisArgs, ['HSETEX', 'key', 'FIELDS', '2', 'field1', 'value1', 'field2', 'value2']);
+  });
+
+  it('hSetEx parseCommand obj', () => {
+    const parser1 = new BasicCommandParser;
+    HSETEX.parseCommand(parser1, 'key', {}, {field1: "value1", field2: "value2"});
+    assert.deepEqual(parser1.redisArgs, ['HSETEX', 'key', 'FIELDS', '2', 'field1', 'value1', 'field2', 'value2']);
+  });
+
+  it('hSetEx parseCommand options FNX KEEPTTL', () => {
+    const parser = new BasicCommandParser;
+    HSETEX.parseCommand(parser, 'key', {mode: 'FNX', expiration: 'KEEPTTL'}, 'field', 'value');
+    assert.deepEqual(parser.redisArgs, ['HSETEX', 'key', 'FNX', 'KEEPTTL', 'FIELDS', '1', 'field', 'value']);
+  });
+
+  it('hSetEx parseCommand options FXX EX 500', () => {
+    const parser = new BasicCommandParser;
+    HSETEX.parseCommand(parser, 'key', {mode: 'FXX', expiration: {type: 'EX', value: 500}}, 'field', 'value');
+    assert.deepEqual(parser.redisArgs, ['HSETEX', 'key', 'FXX', 'EX', '500', 'FIELDS', '1', 'field', 'value']);
+  });
+});
+
+
+// TODO: enable when new test container is released
+describe.skip('HSETEX call', () => {
+    testUtils.testWithClientIfVersionWithinRange([[8], 'LATEST'], 'hSetEx empty single field', async client => {
+      assert.deepEqual(
+        await client.hSetEx('key', {expiration: {type: "EX", value: 500}, mode: "FNX"}, 'filed1', 'value1'),
+        1
+      );
+
+      assert.deepEqual(
+        await client.hSetEx('key', {expiration: {type: "EX", value: 500}, mode: "FXX"}, ['filed1', 'value1', 'field2', 'value2']),
+        0
+      );
+
+      assert.deepEqual(
+        await client.hSetEx('key', {expiration: {type: "EX", value: 500}, mode: "FNX"}, ['filed1', 'value1', 'field2', 'value2']),
+        1
+      );
+
+      assert.deepEqual(
+        await client.hSetEx('key', {expiration: {type: "EX", value: 500}, mode: "FNX"}, 'filed2', 'value2'),
+        1
+      );
+
+      assert.deepEqual(
+        await client.hSetEx('key', {expiration: {type: "EX", value: 500}, mode: "FXX"}, ['filed1', 'value1', 'field2', 'value2']),
+        1
+      );
+    }, GLOBAL.SERVERS.OPEN);
+});