@checkstack/cache-redis-common 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @checkstack/cache-redis-common
+
+## 0.1.0
+
+### Minor Changes
+
+- bd41130: feat(cache): add a distributed Redis cache backend
+
+  Ships `cache-redis-backend` (with its `cache-redis-common` access rules), a
+  `CacheProvider` backed by Redis via `ioredis`. Select it in the Infrastructure
+  Cache configuration UI to give every pod one shared, coherent cache - this is the
+  backend a horizontally-scaled deployment MUST use, since the default in-memory
+  backend is per-pod (see the cache-system docs and the in-memory warning in the
+  Cache UI).
+
+  Details:
+
+  - Values are serialized with `v8.serialize` (structured-clone semantics), not
+    JSON, so `Date` / `Map` / `Set` / typed arrays survive the round trip intact -
+    several platform caches (e.g. the health-status response's `evaluatedAt` /
+    `lastRunAt`) carry `Date`s that JSON would flatten to strings.
+  - Honors TTL via `PX`, uses `UNLINK` for non-blocking deletes, and implements
+    prefix invalidation with a non-blocking `SCAN` loop (never `KEYS`).
+  - Namespaces its keys by folding `instanceRuntime.namespace` into the key prefix
+    (`<namespace>:cache:`, or `cache:` for the default instance), so a secondary
+    instance (e.g. PR preview) can share one Redis without colliding.
+  - `getStats` reports `scope: "cluster"` so the UI can flag it as a shared cache.
+
+  The dev-server's provider auto-resolution treats `cache-redis-backend` as a
+  sibling of `cache-memory-backend`, so wiring Redis in a plugin's deps no longer
+  forces the in-memory default to also load.

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@checkstack/cache-redis-common",
+  "version": "0.1.0",
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "main": "src/index.ts",
+  "checkstack": {
+    "type": "common"
+  },
+  "dependencies": {
+    "@checkstack/common": "0.22.0"
+  },
+  "devDependencies": {
+    "@checkstack/tsconfig": "0.0.7",
+    "@checkstack/scripts": "0.7.3"
+  },
+  "scripts": {
+    "typecheck": "tsgo -b",
+    "lint": "bun run lint:code",
+    "lint:code": "eslint . --max-warnings 0",
+    "pack": "bunx @checkstack/scripts plugin-pack"
+  },
+  "description": "Checkstack cache-redis-common plugin",
+  "author": {
+    "name": "Checkstack contributors"
+  },
+  "license": "Elastic-2.0"
+}

package/src/access.ts

@@ -0,0 +1,22 @@
+import { accessPair, type AccessRule } from "@checkstack/common";
+
+/**
+ * Access rules for the Redis Cache plugin.
+ */
+export const cacheRedisAccess = accessPair(
+  "cache-redis",
+  {
+    read: { description: "View Redis cache configuration and statistics" },
+    manage: { description: "Modify Redis cache configuration" },
+  },
+  // Must match the backend plugin id (cache-redis-backend) that registers these.
+  { pluginId: "cache-redis" },
+);
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const cacheRedisAccessRules: AccessRule[] = [
+  cacheRedisAccess.read,
+  cacheRedisAccess.manage,
+];

package/src/index.ts

@@ -0,0 +1 @@
+export { cacheRedisAccess, cacheRedisAccessRules } from "./access";

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@checkstack/tsconfig/common.json",
+  "include": [
+    "src"
+  ],
+  "references": [
+    {
+      "path": "../../core/common"
+    }
+  ]
+}