[REQUEST] Support Redis Cluster mode (AWS ElastiCache cluster-mode-enabled)

Abierto
  • ¿Algo no está bien?
#9,734 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
aws, node.js, redis, typescript
Área
backend, databases

Línea de trabajo

Start by locating the standalone ioredis client construction and the Redis pub/sub paths; the issue does not name their files, so search for REDIS_URL and the subscriber setup. Check how TLS settings reach the client and how live status handles subscriptions. Done means cluster mode can connect to Redis Cluster with TLS and key/value operations and live status both work; the issue leaves the configuration shape and pub/sub approach open.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Is your feature request related to a problem? Please describe.

Self-hosted Sim cannot use a Redis Cluster, which rules out AWS ElastiCache in
cluster-mode-enabled (and ElastiCache Serverless, which requires a cluster-capable
client). The only managed option left is a cluster-mode-disabled replication group,
which caps scaling at a single primary.

The env surface is a single endpoint:

REDIS_URL:            z.string().url().optional()
REDIS_TLS_SERVERNAME: z.string().min(1).optional()

There is no cluster flag and no seed-node list, and Sim never constructs an ioredis
Cluster — a standalone client is built from that one URL. Pointing it at a
configuration endpoint connects to a single shard, so any key hashing to another
slot fails with MOVED.

Notably ioredis 5.11.1 is already bundled and exports Cluster, so the capability
is present in the dependency tree and simply isn't reachable through configuration.

Describe the solution you'd like

Let REDIS_URL (or an additional variable) drive an ioredis Cluster client when
cluster mode is requested. Something like:

  • REDIS_CLUSTER_MODE=true, or a comma-separated REDIS_CLUSTER_NODES, selecting
    new Redis.Cluster(nodes, opts) instead of new Redis(url)
  • the existing REDIS_TLS_SERVERNAME / rediss:// handling carried through to
    redisOptions, since in-transit encryption is the norm on ElastiCache

The pub/sub paths matter as much as the key/value ones here: cluster pub/sub needs
either sharded pub/sub (SSUBSCRIBE) or a node-aware subscriber, so a transparent
swap of the client constructor alone may not be sufficient for live status.

Describe alternatives you've considered

  • Cluster-mode-disabled replication group — what I'm doing now. Works, but it
    caps scaling at a single primary.
  • A cluster-aware proxy (Envoy Redis filter, twemproxy) — not viable. Envoy's
    Redis proxy does not support pub/sub, which is exactly what Sim needs Redis for.
    Caching would work while live status silently never streams.
  • Patching Sim to build a Cluster — possible since ioredis is already present,
    but that means maintaining a fork and rebuilding the image on every upgrade.

Additional context

Observed on ghcr.io/simstudioai/simstudio:latest (pulled 2026-11-06), ioredis
5.11.1, Docker Compose self-host.

Per the compose comments, Redis is optional for storage (Postgres is the fallback)
but the pub/sub channels have no fallback — so for anyone wanting live status on a
managed Redis, the cluster-mode constraint decides the architecture. Happy to test
a patch against ElastiCache if that's useful.

Lenguaje dominante
TypeScript
Estrellas
29.8k
Forks
3.9k
Merge medio
1 h 44 min
PR fusionados (30 d)
841

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de simstudioai/sim

Todos los issues de simstudioai/sim

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.