chore: Add option for redis (#402)

ckb-js · Jul 31, 2023 · 27b69b6 · 27b69b6
1 parent 7ad94c3
commit 27b69b6
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 4 deletions.
diff --git a/packages/core/sample-projects/kuai.config.ts b/packages/core/sample-projects/kuai.config.ts
@@ -1,7 +1,19 @@
 import { KuaiConfig } from '@ckb-js/kuai-core';
 
+let redisOpt = undefined;
+if (process.env.REDIS_OPT) {
+  try {
+    redisOpt = JSON.parse(process.env.REDIS_OPT);
+  } catch (error) {
+    //ignore error, if error redisOpt will be undefined
+  }
+}
+
 const config: KuaiConfig = {
   port: 3000,
+  redisPort: process.env.REDIS_PORT ? +process.env.REDIS_PORT : undefined,
+  redisHost: process.env.REDIS_HOST,
+  redisOpt,
   ckbChain: {
     rpcUrl: 'http://127.0.0.1:8114',
     prefix: 'ckt',

diff --git a/packages/core/sample-projects/src/main.ts b/packages/core/sample-projects/src/main.ts
@@ -4,7 +4,13 @@ import { getGenesisScriptsConfig, initialKuai } from '@ckb-js/kuai-core';
 import { KoaRouterAdapter, CoR } from '@ckb-js/kuai-io';
 import AppController from './app.controller';
 import './type-extends';
-import { REDIS_HOST_SYMBOL, REDIS_PORT_SYMBOL, initiateResourceBindingManager, mqContainer } from '@ckb-js/kuai-models';
+import {
+  REDIS_HOST_SYMBOL,
+  REDIS_OPT_SYMBOL,
+  REDIS_PORT_SYMBOL,
+  initiateResourceBindingManager,
+  mqContainer,
+} from '@ckb-js/kuai-models';
 import { config } from '@ckb-lumos/lumos';
 
 async function bootstrap() {
@@ -19,6 +25,10 @@ async function bootstrap() {
     mqContainer.bind(REDIS_HOST_SYMBOL).toConstantValue(kuaiEnv.config.redisHost);
   }
 
+  if (kuaiEnv.config.redisOpt) {
+    mqContainer.bind(REDIS_OPT_SYMBOL).toConstantValue(kuaiEnv.config.redisOpt);
+  }
+
   config.initializeConfig(
     config.createConfig({
       PREFIX: kuaiEnv.config.ckbChain.prefix,

diff --git a/packages/core/sample-projects/src/type-extends.ts b/packages/core/sample-projects/src/type-extends.ts
@@ -1,11 +1,13 @@
 import '@ckb-js/kuai-core';
-import { Config } from '@ckb-lumos/config-manager';
+import type { Config } from '@ckb-lumos/config-manager';
+import type { RedisOptions } from 'ioredis';
 
 declare module '@ckb-js/kuai-core' {
   export interface KuaiConfig {
     port?: number;
     lumosConfig?: Config | 'aggron4' | 'lina';
     redisPort?: number;
     redisHost?: string;
+    redisOpt?: RedisOptions;
   }
 }
diff --git a/packages/models/src/actor/actor.ts b/packages/models/src/actor/actor.ts
@@ -12,6 +12,7 @@ import { ActorRefEmptyException } from '../exceptions/actor'
 
 export const REDIS_PORT_SYMBOL = Symbol('mq_redis_port')
 export const REDIS_HOST_SYMBOL = Symbol('mq_redis_host')
+export const REDIS_OPT_SYMBOL = Symbol('mq_redis_opt')
 
 @injectable()
 class MessageQueue {
@@ -20,8 +21,9 @@ class MessageQueue {
   constructor(
     @inject(REDIS_PORT_SYMBOL) @optional() port = 6379,
     @inject(REDIS_HOST_SYMBOL) @optional() host = '127.0.0.1',
+    @inject(REDIS_OPT_SYMBOL) @optional() opt = {},
   ) {
-    this.instance = new Redis(port, host)
+    this.instance = new Redis(port, host, opt)
   }
 }
 

diff --git a/packages/samples/mvp-dapp/kuai.config.js b/packages/samples/mvp-dapp/kuai.config.js
@@ -6,12 +6,22 @@
 
 require('dotenv').config()
 
+let redisOpt = undefined
+if (process.env.REDIS_OPT) {
+  try {
+    redisOpt = JSON.parse(process.env.REDIS_OPT)
+  } catch (error) {
+    //ignore error, if error redisOpt will be undefined
+  }
+}
+
 module.exports = {
   host: process.env.HOST,
   port: process.env.PORT,
   network: 'testnet',
   redisPort: process.env.REDIS_PORT,
   redisHost: process.env.REDIS_HOST,
+  redisOpt,
   jest: {
     preset: 'ts-jest',
     testEnvironment: 'node',

diff --git a/packages/samples/mvp-dapp/src/main.ts b/packages/samples/mvp-dapp/src/main.ts
@@ -12,7 +12,13 @@ import { config } from '@ckb-lumos/lumos'
 import { KoaRouterAdapter, CoR } from '@ckb-js/kuai-io'
 import cors from '@koa/cors'
 import { router } from './app.controller'
-import { mqContainer, REDIS_PORT_SYMBOL, REDIS_HOST_SYMBOL, initiateResourceBindingManager } from '@ckb-js/kuai-models'
+import {
+  mqContainer,
+  REDIS_PORT_SYMBOL,
+  REDIS_HOST_SYMBOL,
+  initiateResourceBindingManager,
+  REDIS_OPT_SYMBOL,
+} from '@ckb-js/kuai-models'
 import { handleException } from './exception'
 
 async function bootstrap() {
@@ -27,6 +33,10 @@ async function bootstrap() {
     mqContainer.bind(REDIS_HOST_SYMBOL).toConstantValue(kuaiEnv.config.redisHost)
   }
 
+  if (kuaiEnv.config.redisOpt) {
+    mqContainer.bind(REDIS_OPT_SYMBOL).toConstantValue(kuaiEnv.config.redisOpt)
+  }
+
   config.initializeConfig(
     config.createConfig({
       PREFIX: kuaiEnv.config.ckbChain.prefix,

diff --git a/packages/samples/mvp-dapp/src/type-extends.d.ts b/packages/samples/mvp-dapp/src/type-extends.d.ts
@@ -6,6 +6,7 @@
 
 import '@ckb-js/kuai-core'
 import type { Config } from '@ckb-lumos/config-manager'
+import type { RedisOptions } from 'ioredis'
 
 declare module '@ckb-js/kuai-core' {
   export interface KuaiConfig {
@@ -14,5 +15,6 @@ declare module '@ckb-js/kuai-core' {
     lumosConfig?: Config | 'aggron4' | 'lina'
     redisPort?: number
     redisHost?: string
+    redisOpt?: RedisOptions
   }
 }