fix: allow pass in redis url as argument

Author: stanley2058

bin/worker.js

@@ -27,4 +27,4 @@ if (s3Endpoint) {
   store = createMemoryStorage()
 }
 
-api.createWorker(store, redisPrefix)
+api.createWorker(store, { redisPrefix })

src/api.js

@@ -86,10 +86,10 @@ const decodeRedisRoomStreamName = (rediskey, expectedPrefix) => {
 
 /**
  * @param {import('./storage.js').AbstractStorage} store
- * @param {string} redisPrefix
+ * @param {{ redisPrefix?: string, redisUrl?: string }} opts
  */
-export const createApiClient = async (store, redisPrefix) => {
-  const a = new Api(store, redisPrefix)
+export const createApiClient = async (store, { redisPrefix, redisUrl }) => {
+  const a = new Api(store, redisPrefix, redisUrl)
   await a.redis.connect()
   try {
     await a.redis.xGroupCreate(a.redisWorkerStreamName, a.redisWorkerGroupName, '0', { MKSTREAM: true })
@@ -100,9 +100,10 @@ export const createApiClient = async (store, redisPrefix) => {
 export class Api {
   /**
    * @param {import('./storage.js').AbstractStorage} store
-   * @param {string} prefix
+   * @param {string=} prefix
+   * @param {string=} url
    */
-  constructor (store, prefix) {
+  constructor (store, prefix = 'y', url = redisUrl) {
     this.store = store
     this.prefix = prefix
     this.consumername = random.uuidv4()
@@ -119,7 +120,7 @@ export class Api {
     this.redisWorkerGroupName = this.prefix + ':worker'
     this._destroyed = false
     this.redis = redis.createClient({
-      url: redisUrl,
+      url,
       // scripting: https://github.com/redis/node-redis/#lua-scripts
       scripts: {
         addMessage: redis.defineScript({
@@ -333,10 +334,10 @@ export class Api {
 
 /**
  * @param {import('./storage.js').AbstractStorage} store
- * @param {string} redisPrefix
+ * @param {{ redisPrefix?: string, redisUrl?: string }} opts
  */
-export const createWorker = async (store, redisPrefix) => {
-  const a = await createApiClient(store, redisPrefix)
+export const createWorker = async (store, opts) => {
+  const a = await createApiClient(store, opts)
   return new Worker(a)
 }
 

src/subscriber.js

@@ -32,10 +32,10 @@ const run = async subscriber => {
 
 /**
  * @param {import('./storage.js').AbstractStorage} store
- * @param {string} redisPrefix
+ * @param {{ redisPrefix?: string, redisUrl?: string }} opts
  */
-export const createSubscriber = async (store, redisPrefix) => {
-  const client = await api.createApiClient(store, redisPrefix)
+export const createSubscriber = async (store, opts) => {
+  const client = await api.createApiClient(store, opts)
   return new Subscriber(client)
 }
 

src/y-socket-io/y-socket-io.js

@@ -109,13 +109,13 @@ export class YSocketIO {
    *
    *  It also starts socket connection listeners.
    * @param {import('../storage.js').AbstractStorage} store
-   * @param {{ redisPrefix?: string }=} redisPrefix
+   * @param {{ redisPrefix?: string, redisUrl?: string }=} opts
    * @public
    */
-  async initialize (store, { redisPrefix = 'y' } = {}) {
+  async initialize (store, { redisUrl, redisPrefix = 'y' } = {}) {
     const [client, subscriber] = await promise.all([
-      api.createApiClient(store, redisPrefix),
-      createSubscriber(store, redisPrefix)
+      api.createApiClient(store, { redisUrl, redisPrefix }),
+      createSubscriber(store, { redisUrl, redisPrefix })
     ])
     this.client = client
     this.subscriber = subscriber

tests/api.tests.js

@@ -20,7 +20,7 @@ const createTestCase = async tc => {
   const keysToDelete = await redisClient.keys(redisPrefix + ':*')
   keysToDelete.length > 0 && await redisClient.del(keysToDelete)
   await redisClient.quit()
-  const client = await api.createApiClient(store, redisPrefix)
+  const client = await api.createApiClient(store, { redisPrefix })
   prevClients.push(client)
   const room = tc.testName
   const docid = 'main'
@@ -44,7 +44,7 @@ const createTestCase = async tc => {
 }
 
 const createWorker = async () => {
-  const worker = await api.createWorker(store, redisPrefix)
+  const worker = await api.createWorker(store, { redisPrefix })
   worker.client.redisMinMessageLifetime = 200
   worker.client.redisWorkerTimeout = 50
   prevClients.push(worker.client)

tests/socketio.tests.js

@@ -34,7 +34,10 @@ const createWsClient = (tc, room) => {
 }
 
 const createWorker = async () => {
-  const worker = await api.createWorker(utils.store, utils.redisPrefix)
+  const worker = await api.createWorker(
+    utils.store,
+    { redisPrefix: utils.redisPrefix }
+  )
   worker.client.redisMinMessageLifetime = 500
   worker.client.redisWorkerTimeout = 100
   utils.prevClients.push(worker.client)
@@ -52,7 +55,7 @@ const createServer = async () => {
 }
 
 const createApiClient = async () => {
-  const client = await api.createApiClient(utils.store, utils.redisPrefix)
+  const client = await api.createApiClient(utils.store, { redisPrefix: utils.redisPrefix })
   utils.prevClients.push(client)
   return client
 }