fix(backend): use node-redis instead of ioredis for sharedb-redis-pubsub (#38)

* fix(backend): use node-redis instead of ioredis for sharedb-redis-pubsub

* chore: use yarn from alpha branch

* chore(sharedb-access,sharedb-schema): remove dev deps for now since tests are not working anyways and they lead to non-deduped instances of sharedb

Author: cray0000

packages/backend/index.d.ts

@@ -40,6 +40,7 @@ export interface DbExports {
 export function createBackend (options?: BackendOptions): any // Replace 'any' with Backend class type
 
 // Exports instances and constructors for Redis and database connections
+export function getRedis (options?: any): Redis
 export const redis: RedisExports['redis']
 export const redlock: RedisExports['redlock']
 export const Redlock: RedisExports['Redlock']

packages/backend/index.js

@@ -44,7 +44,7 @@ export default function createBackend ({
 
   const backend = new ShareDB({
     db,
-    pubsub,
+    ...(pubsub ? { pubsub } : {}),
     extraDbs
   })
 

packages/backend/package.json

@@ -22,8 +22,9 @@
     "ioredis": "^5.3.2",
     "ioredis-mock": "^8.9.0",
     "mongodb": "^6.0.0",
+    "redis": "^5.0.0",
     "redlock": "^3.0.0",
-    "sharedb": "^5.0.0",
+    "sharedb": "5.2.2",
     "sharedb-hooks": "~4.0.0",
     "sharedb-mongo": "^4.1.2",
     "sharedb-redis-pubsub": "^5.1.0",

packages/backend/redis/getRedis.js packages/backend/redis/getIoRedis.jspackages/backend/redis/getRedis.js renamed to packages/backend/redis/getIoRedis.js

@@ -4,7 +4,7 @@ import RedisMock from 'ioredis-mock'
 
 export { Redis, RedisMock }
 
-export function getRedis ({ enable = true, opts, url, keyPrefix, ...additionalOptions }) {
+export function getIoRedis ({ enable = true, opts, url, keyPrefix, ...additionalOptions }) {
   if (enable) {
     if (typeof opts === 'string') {
       opts = JSON.parse(opts)

packages/backend/redis/getNodeRedis.js

@@ -0,0 +1,59 @@
+import { readFileSync } from 'fs'
+import { createClient, createSentinel } from 'redis'
+
+export function getNodeRedis ({ opts, url }) {
+  const parsedOpts = typeof opts === 'string' ? JSON.parse(opts) : opts
+
+  let client
+
+  if (parsedOpts?.sentinels) {
+    client = createSentinel(_getSentinelOptions(parsedOpts))
+  } else if (url) {
+    client = createClient({ url })
+  }
+
+  if (!client) {
+    throw new Error('[@teamplay/backend] REDIS_URL or REDIS_OPTS is required when Redis pubsub is enabled')
+  }
+
+  client.on('error', error => {
+    console.error('[@teamplay/backend] Redis pubsub client error:', error)
+  })
+
+  return client
+}
+
+function _getSentinelOptions (opts) {
+  const tls = _getTlsOptions(opts)
+  const socket = tls ? { tls: true, ...tls } : undefined
+  const sentinelRootNodes = opts.sentinels.map(sentinel => ({
+    host: sentinel.host || sentinel.hostname || sentinel.ip || sentinel.address,
+    port: Number(sentinel.port || opts.sentinel_port || 26379)
+  }))
+
+  return {
+    name: opts.name || 'mymaster',
+    sentinelRootNodes,
+    nodeClientOptions: {
+      socket,
+      username: opts.username,
+      password: opts.password,
+      database: opts.db || 0
+    },
+    sentinelClientOptions: {
+      socket,
+      username: opts.sentinelUsername,
+      password: opts.sentinelPassword
+    }
+  }
+}
+
+function _getTlsOptions (opts) {
+  if (!opts?.key) return
+
+  return {
+    key: readFileSync(opts.key),
+    cert: readFileSync(opts.cert),
+    ca: readFileSync(opts.ca)
+  }
+}

packages/backend/redis/index.js

@@ -1,23 +1,34 @@
 import Redlock from 'redlock'
 import redisPubSub from 'sharedb-redis-pubsub'
-import { getRedis, Redis, RedisMock } from './getRedis.js'
+import { getIoRedis, Redis, RedisMock } from './getIoRedis.js'
+import { getNodeRedis } from './getNodeRedis.js'
 
 const ENABLE_REDIS = !process.env.NO_REDIS
+const ENABLE_REDIS_PUBSUB = ENABLE_REDIS && !!(process.env.REDIS_URL || process.env.REDIS_OPTS)
 
 const RedisClient = ENABLE_REDIS ? Redis : RedisMock
-export { RedisClient as Redis, getRedis, getRedisOptions, generatePrefix }
+export {
+  RedisClient as Redis,
+  getRedisOptions,
+  generatePrefix
+}
+export const getRedis = getIoRedis
 export const prefix = generatePrefix({
   mongoUrl: process.env.MONGO_URL,
   baseUrl: process.env.BASE_URL
 })
-export const redis = getRedis(getRedisOptions())
-export const redisObserver = getRedis(getRedisOptions())
+export const redis = getIoRedis(getRedisOptions())
 
-export const pubsub = redisPubSub({
-  client: redis,
-  observer: redisObserver,
-  prefix
-})
+// Teamplay exposes ioredis for the rest of the backend ecosystem
+// (BullMQ, Redlock, mocks), but sharedb-redis-pubsub@5 expects node-redis.
+// We therefore create separate node-redis clients only for ShareDB pubsub.
+export const pubsub = ENABLE_REDIS_PUBSUB
+  ? redisPubSub({
+    client: getNodeRedis(getRedisOptions({ addPrefix: false })),
+    observer: getNodeRedis(getRedisOptions({ addPrefix: false })),
+    prefix
+  })
+  : undefined
 
 export const redlock = getRedlock(redis)
 

packages/sharedb-access/package.json

@@ -22,8 +22,6 @@
     "lodash": "^4.17.20"
   },
   "devDependencies": {
-    "mocha": "^11.7.5",
-    "racer": "1.0.1",
-    "sharedb": "^5.0.0"
+    "mocha": "^11.7.5"
   }
 }

packages/sharedb-access/test/db.js

@@ -1,3 +1,4 @@
+// TODO: Update tests to work with new teamplay api
 import promisifyRacer from '@startupjs/orm/lib/promisifyRacer.js'
 import racer from 'racer'
 import sharedb from 'sharedb'

packages/sharedb-schema/package.json

@@ -19,8 +19,6 @@
     "z-schema": "^4.2.3"
   },
   "devDependencies": {
-    "mocha": "^11.7.5",
-    "racer": "1.0.1",
-    "sharedb": "^5.0.0"
+    "mocha": "^11.7.5"
   }
 }

packages/sharedb-schema/test/model.js

@@ -1,3 +1,4 @@
+// TODO: Update tests to work with new teamplay api
 import promisifyRacer from '@startupjs/orm/lib/promisifyRacer.js'
 import racer from 'racer'
 import sharedb from 'sharedb'