@prairielearn/cache 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# `@prairielearn/cache`
+
+Utilities to help connect to and store information in a cache. This package _does not_ load configurations directly. Instead, configs should be passed in when the package is initialized upon loading the application. Then, the package can be used in the throughout the application to interact with the cache.
+
+## Usage
+
+First, you will need to initialize the library with the cache type that you are intending to use, a prefix that will be the start of all of your cache keys, and optionally, a redis server URL if that is the cache type being used:
+
+```ts
+import { cache } from '@prairielearn/cache';
+import { config } from 'lib/config.js';
+
+await cache.init({
+  type: config.cacheType,
+  keyPrefix: config.cacheKeyPrefix,
+  redisUrl: config.redisUrl,
+});
+```
+
+In this example, we are using a config file that has stored the cache configurations and we are passing those in to initialize our cache.
+
+Additionally, the cache package can be used as a class to construct multiple instances. To do so, you must first contsruct a new cache. You can then pass is your arguments and initalize a new cache:
+
+```ts
+import { cache } from '@prairielearn/cache';
+
+const myCache = new cache();
+
+myCache.init({
+  cachetype: 'redis',
+  cacheKeyPrefix: 'prairielearn-cache2:',
+  redisUrl: 'redis://localhost:6379/',
+});
+```
+
+After initializing, we can use our `set`, `get`, `del`, `reset` or `close` functions to interact with the cache. Note, that `set`, `get`, and `del` have required arguments. Calling `set` will require the intended KEY, VALUE, and length of time to store the data (in milliseconds). Calling `get` or `del` will require the KEY for the intended result.
+
+The following example will store `foo: bar` for 10 minutes:
+
+```ts
+await cache.set('foo', 'bar', 600000);
+```
+
+The following example will use the key `foo` to retrieve the value `bar`:
+
+```ts
+await cache.get('foo');
+// returns bar
+```
+
+The following example will use the key `foo` to delete the key value pair `foo: bar`:
+
+```ts
+await cache.del('foo');
+```
+
+Using `reset()` will clear the currently stored data in the cache. Using `close()` will disable the currently used cache and, if using Redis, close the connection.

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { Redis } from 'ioredis';
+import { LRUCache } from 'lru-cache';
+declare class Cache {
+    enabled: boolean;
+    type: string;
+    memoryCache?: LRUCache<string, string>;
+    redisClient?: Redis;
+    keyPrefix: string;
+    init(config: {
+        type: 'none' | 'memory' | 'redis';
+        keyPrefix: string;
+        redisUrl?: string | null;
+    }): Promise<void>;
+    set(key: string, value: any, maxAgeMS: number): void;
+    del(key: string): Promise<void>;
+    /**
+     * Returns the value for the corresponding key if it exists in the cache; null otherwise.
+     */
+    get(key: string): Promise<any>;
+    /**
+     * Clear all entries from the cache.
+     */
+    reset(): Promise<void>;
+    /**
+     * Releases any connections associated with the cache.
+     */
+    close(): Promise<void>;
+}
+export declare const cache: Cache;
+export {};

package/dist/index.js

@@ -0,0 +1,184 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cache = void 0;
+const ioredis_1 = require("ioredis");
+const lru_cache_1 = require("lru-cache");
+const logger_1 = require("@prairielearn/logger");
+const Sentry = __importStar(require("@prairielearn/sentry"));
+const node_assert_1 = __importDefault(require("node:assert"));
+class Cache {
+    enabled = false;
+    type = 'none';
+    memoryCache;
+    redisClient;
+    keyPrefix = '';
+    async init(config) {
+        this.type = config.type;
+        this.keyPrefix = config.keyPrefix;
+        if (!this.type || this.type === 'none') {
+            // No caching
+            this.enabled = false;
+            return;
+        }
+        if (this.type === 'redis') {
+            if (!config.redisUrl)
+                throw new Error('redisUrl not set in config');
+            this.enabled = true;
+            this.redisClient = new ioredis_1.Redis(config.redisUrl);
+            this.redisClient.on('error', (err) => {
+                logger_1.logger.error('Redis error', err);
+                Sentry.captureException(err);
+            });
+        }
+        else if (this.type === 'memory') {
+            this.enabled = true;
+            this.memoryCache = new lru_cache_1.LRUCache({
+                // The in-memory cache is really only suited for development, so we'll
+                // hardcode a relatively low limit here.
+                max: 1000,
+            });
+        }
+        else {
+            throw new Error(`Unknown cache type "${this.type}"`);
+        }
+    }
+    set(key, value, maxAgeMS) {
+        if (!this.enabled)
+            return;
+        const scopedKey = this.keyPrefix + key;
+        switch (this.type) {
+            case 'memory': {
+                (0, node_assert_1.default)(this.memoryCache, 'Memory cache is enabled but not configured');
+                this.memoryCache.set(scopedKey, JSON.stringify(value), { ttl: maxAgeMS });
+                break;
+            }
+            case 'redis': {
+                // This returns a promise, but we don't want to wait for this data
+                // to reach the cache before continuing, and we don't *really*
+                // care if it errors.
+                //
+                // We don't log the error because it contains the cached value,
+                // which can be huge and which fills up the logs.
+                (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+                this.redisClient
+                    .set(scopedKey, JSON.stringify(value), 'PX', maxAgeMS)
+                    .catch((_err) => logger_1.logger.error('Cache set error', { key, scopedKey, maxAgeMS }));
+                break;
+            }
+        }
+    }
+    async del(key) {
+        if (!this.enabled)
+            return;
+        const scopedKey = this.keyPrefix + key;
+        switch (this.type) {
+            case 'memory': {
+                (0, node_assert_1.default)(this.memoryCache, 'Memory cache is enabled but not configured');
+                this.memoryCache.delete(scopedKey);
+                break;
+            }
+            case 'redis': {
+                (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+                await this.redisClient.del(scopedKey);
+                break;
+            }
+        }
+    }
+    /**
+     * Returns the value for the corresponding key if it exists in the cache; null otherwise.
+     */
+    async get(key) {
+        if (!this.enabled)
+            return null;
+        const scopedKey = this.keyPrefix + key;
+        switch (this.type) {
+            case 'memory': {
+                (0, node_assert_1.default)(this.memoryCache, 'Memory cache is enabled but not configured');
+                const value = this.memoryCache.get(scopedKey);
+                if (typeof value === 'string') {
+                    return JSON.parse(value);
+                }
+                return undefined;
+            }
+            case 'redis': {
+                (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+                const value = await this.redisClient.get(scopedKey);
+                if (typeof value === 'string') {
+                    return JSON.parse(value);
+                }
+                return undefined;
+            }
+            default: {
+                return null;
+            }
+        }
+    }
+    /**
+     * Clear all entries from the cache.
+     */
+    async reset() {
+        if (!this.enabled)
+            return;
+        switch (this.type) {
+            case 'memory': {
+                (0, node_assert_1.default)(this.memoryCache, 'Memory cache is enabled but not configured');
+                this.memoryCache.clear();
+                break;
+            }
+            case 'redis': {
+                let cursor = '0';
+                do {
+                    (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+                    const reply = await this.redisClient.scan(cursor, 'MATCH', `${this.keyPrefix}*`, 'COUNT', 1000);
+                    cursor = reply[0];
+                    const keys = reply[1];
+                    if (keys.length > 0) {
+                        (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+                        await this.redisClient.del(keys);
+                    }
+                } while (cursor !== '0');
+                break;
+            }
+        }
+    }
+    /**
+     * Releases any connections associated with the cache.
+     */
+    async close() {
+        if (!this.enabled)
+            return;
+        this.enabled = false;
+        if (this.type === 'redis') {
+            (0, node_assert_1.default)(this.redisClient, 'Redis client is enabled but not configured');
+            await this.redisClient.quit();
+        }
+    }
+}
+exports.cache = new Cache();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAgC;AAChC,yCAAqC;AACrC,iDAA8C;AAC9C,6DAA+C;AAC/C,8DAAiC;AAEjC,MAAM,KAAK;IACT,OAAO,GAAG,KAAK,CAAC;IAChB,IAAI,GAAG,MAAM,CAAC;IACd,WAAW,CAA4B;IACvC,WAAW,CAAS;IACpB,SAAS,GAAG,EAAE,CAAC;IAEf,KAAK,CAAC,IAAI,CAAC,MAIV;QACC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACvC,aAAa;YACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YACpE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,IAAI,eAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACnC,eAAM,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;gBACjC,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,IAAI,oBAAQ,CAAC;gBAC9B,sEAAsE;gBACtE,wCAAwC;gBACxC,GAAG,EAAE,IAAI;aACV,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,QAAgB;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAEvC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM;YACR,CAAC;YAED,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,kEAAkE;gBAClE,8DAA8D;gBAC9D,qBAAqB;gBACrB,EAAE;gBACF,+DAA+D;gBAC/D,iDAAiD;gBACjD,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,IAAI,CAAC,WAAW;qBACb,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC;qBACrD,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;gBAClF,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAE1B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAEvC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACnC,MAAM;YACR,CAAC;YAED,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACtC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAE/B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QAEvC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,OAAO,CAAC,CAAC,CAAC;gBACR,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAE1B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;gBACvE,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;gBACzB,MAAM;YACR,CAAC;YAED,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,IAAI,MAAM,GAAG,GAAG,CAAC;gBACjB,GAAG,CAAC;oBACF,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;oBACvE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CACvC,MAAM,EACN,OAAO,EACP,GAAG,IAAI,CAAC,SAAS,GAAG,EACpB,OAAO,EACP,IAAI,CACL,CAAC;oBACF,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBAElB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACpB,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;wBACvE,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBACnC,CAAC;gBACH,CAAC,QAAQ,MAAM,KAAK,GAAG,EAAE;gBACzB,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,IAAA,qBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAC;YACvE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;CACF;AAEY,QAAA,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@prairielearn/cache",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput"
+  },
+  "dependencies": {
+    "@prairielearn/logger": "^1.0.12",
+    "@prairielearn/sentry": "^1.2.1",
+    "ioredis": "^5.3.2",
+    "lru-cache": "^10.2.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "*",
+    "typescript": "^5.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,178 @@
+import { Redis } from 'ioredis';
+import { LRUCache } from 'lru-cache';
+import { logger } from '@prairielearn/logger';
+import * as Sentry from '@prairielearn/sentry';
+import assert from 'node:assert';
+
+class Cache {
+  enabled = false;
+  type = 'none';
+  memoryCache?: LRUCache<string, string>;
+  redisClient?: Redis;
+  keyPrefix = '';
+
+  async init(config: {
+    type: 'none' | 'memory' | 'redis';
+    keyPrefix: string;
+    redisUrl?: string | null;
+  }) {
+    this.type = config.type;
+    this.keyPrefix = config.keyPrefix;
+    if (!this.type || this.type === 'none') {
+      // No caching
+      this.enabled = false;
+      return;
+    }
+
+    if (this.type === 'redis') {
+      if (!config.redisUrl) throw new Error('redisUrl not set in config');
+      this.enabled = true;
+      this.redisClient = new Redis(config.redisUrl);
+      this.redisClient.on('error', (err) => {
+        logger.error('Redis error', err);
+        Sentry.captureException(err);
+      });
+    } else if (this.type === 'memory') {
+      this.enabled = true;
+      this.memoryCache = new LRUCache({
+        // The in-memory cache is really only suited for development, so we'll
+        // hardcode a relatively low limit here.
+        max: 1000,
+      });
+    } else {
+      throw new Error(`Unknown cache type "${this.type}"`);
+    }
+  }
+
+  set(key: string, value: any, maxAgeMS: number) {
+    if (!this.enabled) return;
+
+    const scopedKey = this.keyPrefix + key;
+
+    switch (this.type) {
+      case 'memory': {
+        assert(this.memoryCache, 'Memory cache is enabled but not configured');
+        this.memoryCache.set(scopedKey, JSON.stringify(value), { ttl: maxAgeMS });
+        break;
+      }
+
+      case 'redis': {
+        // This returns a promise, but we don't want to wait for this data
+        // to reach the cache before continuing, and we don't *really*
+        // care if it errors.
+        //
+        // We don't log the error because it contains the cached value,
+        // which can be huge and which fills up the logs.
+        assert(this.redisClient, 'Redis client is enabled but not configured');
+        this.redisClient
+          .set(scopedKey, JSON.stringify(value), 'PX', maxAgeMS)
+          .catch((_err) => logger.error('Cache set error', { key, scopedKey, maxAgeMS }));
+        break;
+      }
+    }
+  }
+
+  async del(key: string) {
+    if (!this.enabled) return;
+
+    const scopedKey = this.keyPrefix + key;
+
+    switch (this.type) {
+      case 'memory': {
+        assert(this.memoryCache, 'Memory cache is enabled but not configured');
+        this.memoryCache.delete(scopedKey);
+        break;
+      }
+
+      case 'redis': {
+        assert(this.redisClient, 'Redis client is enabled but not configured');
+        await this.redisClient.del(scopedKey);
+        break;
+      }
+    }
+  }
+
+  /**
+   * Returns the value for the corresponding key if it exists in the cache; null otherwise.
+   */
+  async get(key: string): Promise<any> {
+    if (!this.enabled) return null;
+
+    const scopedKey = this.keyPrefix + key;
+
+    switch (this.type) {
+      case 'memory': {
+        assert(this.memoryCache, 'Memory cache is enabled but not configured');
+        const value = this.memoryCache.get(scopedKey);
+        if (typeof value === 'string') {
+          return JSON.parse(value);
+        }
+        return undefined;
+      }
+
+      case 'redis': {
+        assert(this.redisClient, 'Redis client is enabled but not configured');
+        const value = await this.redisClient.get(scopedKey);
+        if (typeof value === 'string') {
+          return JSON.parse(value);
+        }
+        return undefined;
+      }
+
+      default: {
+        return null;
+      }
+    }
+  }
+
+  /**
+   * Clear all entries from the cache.
+   */
+  async reset() {
+    if (!this.enabled) return;
+
+    switch (this.type) {
+      case 'memory': {
+        assert(this.memoryCache, 'Memory cache is enabled but not configured');
+        this.memoryCache.clear();
+        break;
+      }
+
+      case 'redis': {
+        let cursor = '0';
+        do {
+          assert(this.redisClient, 'Redis client is enabled but not configured');
+          const reply = await this.redisClient.scan(
+            cursor,
+            'MATCH',
+            `${this.keyPrefix}*`,
+            'COUNT',
+            1000,
+          );
+          cursor = reply[0];
+
+          const keys = reply[1];
+          if (keys.length > 0) {
+            assert(this.redisClient, 'Redis client is enabled but not configured');
+            await this.redisClient.del(keys);
+          }
+        } while (cursor !== '0');
+        break;
+      }
+    }
+  }
+  /**
+   * Releases any connections associated with the cache.
+   */
+  async close() {
+    if (!this.enabled) return;
+    this.enabled = false;
+
+    if (this.type === 'redis') {
+      assert(this.redisClient, 'Redis client is enabled but not configured');
+      await this.redisClient.quit();
+    }
+  }
+}
+
+export const cache = new Cache();

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@prairielearn/tsconfig/tsconfig.package.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["mocha"],
+  },
+}