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

Đang mở
  • Có gì không ổn?
#9,734 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
aws, node.js, redis, typescript
Lĩnh vực
backend, databases

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
29.8k
Fork
3.9k
Merge trung bình
1 giờ 44 phút
Pull request đã merge (30 ngày)
841

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của simstudioai/sim

Tất cả issue của simstudioai/sim

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.