All files / src/resp/command/key expire-command.ts

27.58% Statements 8/29
0% Branches 0/10
50% Functions 1/2
27.58% Lines 8/29

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 1061x       1x 1x                                                                                           1x 4x   4x   4x   4x                                                                                              
import { Logger } from "../../../logger";
import { IRequest } from "../../../server/request";
import { Database } from "../../data/database";
import { DatabaseValue } from "../../data/database-value";
import { RedisToken } from "../../protocol/redis-token";
import { IRespCommand } from "../resp-command";
 
/**
 * Available since 1.0.0.
 *
 * EXPIRE key seconds
 *
 * Set a timeout on key. After the timeout has expired, the key will automatically be deleted.
 * A key with an associated timeout is often said to be volatile in Redis terminology.
 *
 * The timeout will only be cleared by commands that delete or overwrite the contents of the key,
 * including DEL, SET, GETSET and all the *STORE commands. This means that all the operations
 * that conceptually alter the value stored at the key without replacing it with a new one will
 * leave the timeout untouched. For instance, incrementing the value of a key with INCR, pushing
 * a new value into a list with LPUSH, or altering the field value of a hash with HSET are all
 * operations that will leave the timeout untouched.
 *
 * The timeout can also be cleared, turning the key back into a persistent key, using the PERSIST
 * command.
 *
 * If a key is renamed with RENAME, the associated time to live is transferred to the new key name.
 *
 * If a key is overwritten by RENAME, like in the case of an existing key Key_A that is
 * overwritten  * by a call like RENAME Key_B Key_A, it does not matter if the original
 * Key_A had a timeout associated or not, the new key Key_A will inherit all the characteristics
 * of Key_B.
 *
 * Note that calling EXPIRE/PEXPIRE with a non-positive timeout or EXPIREAT/PEXPIREAT with a
 * ime in the past will result in the key being deleted rather than expired (accordingly, the
 * emitted key event will be del, not expired).
 *
 * **NOTE: unit-redis-ness does NOT yet support key events**
 *
 * Refreshing expires
 * It is possible to call EXPIRE using as argument a key that already has an existing expire set.
 * In this case the time to live of a key is updated to the new value. There are many useful
 * applications for this, an example is documented in the Navigation session pattern section below.
 *
 * Differences in Redis prior 2.1.3
 * In Redis versions prior 2.1.3 altering a key with an expire set using a command altering its
 * value had the effect of removing the key entirely. This semantics was needed because of
 * limitations in the replication layer that are now fixed.
 *
 * EXPIRE would return 0 and not alter the timeout for a key with a timeout set.
 */
 
export class ExpireCommand extends IRespCommand {
    public maxParams = 2
 
    public minParams = 2
 
    public name = "exists"
 
    private logger: Logger = new Logger(module.id);
 
    public execSync(request: IRequest, db: Database): RedisToken {
        this.logger.debug(
            `${request.getCommand()}.execute(%s)`,
            ...request.getParams()
        );
        let response = 0;
        const key: string = request.getParam(0);
        let dbValue: DatabaseValue = db.get(key);
        if (!dbValue) {
            this.logger.debug(`key ${key} does not exist`);
            return RedisToken.integer(response);
        }
 
        const newTtl: string = request.getParam(1);
        if (isNaN(Number(newTtl)) || Number(newTtl) > parseInt(
            newTtl,
            10
        )) {
            this.logger.debug(`ttl ${newTtl} is invalid`);
            return RedisToken.error("ERR value is not an integer or out of range");
        }
 
        this.logger.debug(`Setting expiredAt to ${Number(newTtl) * 1000} on ${key}`);
        const ttlVal: number = Number(newTtl) < 1
            ? -1
            : new Date().getTime() + Number(newTtl) * 1000;
        dbValue = db.put(
            key,
            dbValue.setExpiredAt(ttlVal)
        );
        this.logger.debug(
            "Updated key is %j",
            `${dbValue}`
        );
        response = 1;
 
        if (dbValue.getExpiredAt() < 0) {
            this.logger.debug(`Key ${key} is effectively deleted - returning ${response}`);
            return RedisToken.integer(response);
        }
 
        this.logger.debug(`${request.getCommand()}.execute ttl set to ${dbValue.getExpiredAt()}`);
        return RedisToken.integer(response);
    }
}