Add hash expiration commands (#62)

* fix: add hash expiration commands

* fix: fmt

* fix: rm list spread operator

* fix: types in commands.pyi

* fix: add hpersist tests

* fix: update docstrings

* Update upstash_redis/commands.py

---------

Co-authored-by: Metin Dumandag <[email protected]>

Author: CahidArda

tests/commands/hash/test_hexpireat.py

@@ -0,0 +1,22 @@
+import pytest
+import time
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hexpireat_sets_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    future_timestamp = int(time.time()) + 2
+    assert redis.hexpireat(hash_name, field, future_timestamp)[0] == 1
+
+    time.sleep(3)
+    assert redis.hexists(hash_name, field) == 0

tests/commands/hash/test_hexpiretime.py

@@ -0,0 +1,38 @@
+import pytest
+import time
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hexpiretime_returns_correct_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hexpire(hash_name, field, 5)
+    expiry_time = redis.hexpiretime(hash_name, [field])[0]
+
+    assert expiry_time > int(time.time())
+    assert expiry_time <= int(time.time()) + 5
+
+
+def test_hexpiretime_returns_minus1_if_no_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    assert redis.hexpiretime(hash_name, [field])[0] == -1
+
+
+def test_hexpiretime_returns_minus2_if_field_does_not_exist(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+
+    assert redis.hexpiretime(hash_name, [field])[0] == -2

tests/commands/hash/test_hpersist.py

@@ -0,0 +1,32 @@
+import pytest
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hpersist_removes_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hexpire(hash_name, field, 500)
+    ttl_before = redis.httl(hash_name, field)
+    assert ttl_before[0] > 0
+
+    redis.hpersist(hash_name, field)
+    ttl_after = redis.httl(hash_name, field)
+    assert ttl_after == [-1]
+
+
+def test_hpersist_does_nothing_if_no_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1500"
+
+    redis.hset(hash_name, field, value)
+    assert redis.hpersist(hash_name, field) == [-1]

tests/commands/hash/test_hpexpire.py

@@ -0,0 +1,41 @@
+import pytest
+import time
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hpexpire_sets_expiry_in_milliseconds(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    assert redis.hpexpire(hash_name, field, 500) == [1]
+
+    time.sleep(1)
+    assert redis.hget(hash_name, field) is None
+
+
+def test_hpexpire_does_not_set_expiry_if_field_does_not_exist(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+
+    assert redis.hpexpire(hash_name, field, 500) == [-2]
+
+
+def test_hpexpire_overwrites_existing_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hpexpire(hash_name, field, 1000)
+    assert redis.hpexpire(hash_name, field, 2000) == [1]
+
+    time.sleep(2.5)
+    assert redis.hget(hash_name, field) is None

tests/commands/hash/test_hpexpireat.py

@@ -0,0 +1,22 @@
+import pytest
+import time
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hpexpireat_sets_expiry_in_milliseconds(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    future_timestamp_ms = int(time.time() * 1000) + 500
+    assert redis.hpexpireat(hash_name, field, future_timestamp_ms) == [1]
+
+    time.sleep(1)
+    assert redis.hget(hash_name, field) is None

tests/commands/hash/test_hpexpiretime.py

@@ -0,0 +1,38 @@
+import pytest
+import time
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hpexpiretime_returns_correct_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hpexpire(hash_name, field, 500)
+    expiry_time_ms = redis.hpexpiretime(hash_name, [field])[0]
+
+    assert expiry_time_ms > 0
+    assert expiry_time_ms <= int(time.time() * 1000) + 1000
+
+
+def test_hpexpiretime_returns_minus1_if_no_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    assert redis.hpexpiretime(hash_name, [field])[0] == -1
+
+
+def test_hpexpiretime_returns_minus2_if_field_does_not_exist(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+
+    assert redis.hpexpiretime(hash_name, [field])[0] == -2

tests/commands/hash/test_hpttl.py

@@ -0,0 +1,36 @@
+import pytest
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_hpttl_returns_correct_ttl(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hpexpire(hash_name, field, 1500)
+    ttl = redis.hpttl(hash_name, [field])[0]
+
+    assert ttl > 0
+
+
+def test_hpttl_returns_minus1_if_no_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    assert redis.hpttl(hash_name, [field])[0] == -1
+
+
+def test_hpttl_returns_minus2_if_field_does_not_exist(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+
+    assert redis.hpttl(hash_name, [field])[0] == -2

tests/commands/hash/test_httl.py

@@ -0,0 +1,37 @@
+import pytest
+from upstash_redis import Redis
+
+
+@pytest.fixture(autouse=True)
+def flush_hash(redis: Redis):
+    hash_name = "myhash"
+    redis.delete(hash_name)
+
+
+def test_httl_returns_correct_ttl(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    redis.hexpire(hash_name, field, 5)
+    ttl = redis.httl(hash_name, [field])[0]
+
+    assert ttl > 0
+    assert ttl <= 5
+
+
+def test_httl_returns_minus1_if_no_expiry(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+    value = "value1"
+
+    redis.hset(hash_name, field, value)
+    assert redis.httl(hash_name, [field])[0] == -1
+
+
+def test_httl_returns_minus2_if_field_does_not_exist(redis: Redis):
+    hash_name = "myhash"
+    field = "field1"
+
+    assert redis.httl(hash_name, [field])[0] == -2