UpstashCache Class — drizzle-orm Architecture

Source Code

drizzle-orm/src/cache/upstash/cache.ts lines 60–202

export class UpstashCache extends Cache {
	static override readonly [entityKind]: string = 'UpstashCache';
	/**
	 * Prefix for sets which denote the composite table names for each unique table
	 *
	 * Example: In the composite table set of "table1", you may find
	 * `${compositeTablePrefix}table1,table2` and `${compositeTablePrefix}table1,table3`
	 */
	private static compositeTableSetPrefix = '__CTS__';
	/**
	 * Prefix for hashes which map hash or tags to cache values
	 */
	private static compositeTablePrefix = '__CT__';
	/**
	 * Key which holds the mapping of tags to composite table names
	 *
	 * Using this tagsMapKey, you can find the composite table name for a given tag
	 * and get the cache value for that tag:
	 *
	 * ```ts
	 * const compositeTable = redis.hget(tagsMapKey, 'tag1')
	 * console.log(compositeTable) // `${compositeTablePrefix}table1,table2`
	 *
	 * const cachevalue = redis.hget(compositeTable, 'tag1')
	 */
	private static tagsMapKey = '__tagsMap__';
	/**
	 * Queries whose auto invalidation is false aren't stored in their respective
	 * composite table hashes because those hashes are deleted when a mutation
	 * occurs on related tables.
	 *
	 * Instead, they are stored in a separate hash with the prefix
	 * `__nonAutoInvalidate__` to prevent them from being deleted when a mutation
	 */
	private static nonAutoInvalidateTablePrefix = '__nonAutoInvalidate__';

	private luaScripts: {
		getByTagScript: Script;
		onMutateScript: Script;
	};

	private internalConfig: { seconds: number; hexOptions?: ExpireOptions };

	constructor(public redis: Redis, config?: CacheConfig, protected useGlobally?: boolean) {
		super();
		this.internalConfig = this.toInternalConfig(config);
		this.luaScripts = {
			getByTagScript: this.redis.createScript(getByTagScript, { readonly: true }),
			onMutateScript: this.redis.createScript(onMutateScript),
		};
	}

	public strategy() {
		return this.useGlobally ? 'all' : 'explicit';
	}

	private toInternalConfig(config?: CacheConfig): { seconds: number; hexOptions?: ExpireOptions } {
		return config
			? {
				seconds: config.ex!,
				hexOptions: config.hexOptions,
			}
			: {
				seconds: 1,
			};
	}

	override async get(
		key: string,
		tables: string[],
		isTag: boolean = false,
		isAutoInvalidate?: boolean,
	): Promise<any[] | undefined> {
		if (!isAutoInvalidate) {
			const result = await this.redis.hget(UpstashCache.nonAutoInvalidateTablePrefix, key);
			return result === null ? undefined : result as any[];
		}

		if (isTag) {
			const result = await this.luaScripts.getByTagScript.exec([UpstashCache.tagsMapKey], [key]);
			return result === null ? undefined : result as any[];