@eggjs/redis 3.0.0 → 4.0.0-beta.26

package/src/config/config.default.ts

@@ -1,111 +0,0 @@
-import type { RedisOptions, ClusterOptions } from 'ioredis';
-
-export interface RedisClientOptions extends RedisOptions {
-  /**
-   * Whether to enable weakDependent mode, the redis client start will not block the application start
-   *
-   * Default to `undefined`
-   */
-  weakDependent?: boolean;
-}
-
-export interface RedisClusterOptions extends ClusterOptions {
-  cluster: true;
-  nodes: RedisClientOptions[];
-}
-
-export interface RedisConfig {
-  /**
-   * Default redis client config
-   *
-   * Default to `{}`
-   */
-  default: RedisClientOptions;
-  /**
-   * Single Redis or Cluster Redis config
-   */
-  client?: RedisClientOptions | RedisClusterOptions;
-  /**
-   * Multi Redis config
-   */
-  clients?: Record<string, RedisClientOptions>;
-  /**
-   * redis client will try to use TIME command to detect client is ready or not
-   * if your redis server not support TIME command, please set this config to false
-   * see https://redis.io/commands/time
-   *
-   * Default to `true`
-   */
-  supportTimeCommand: boolean;
-  /**
-   * Whether to enable redis for `app`
-   *
-   * Default to `true`
-   */
-  app: boolean;
-  /**
-   * Whether to enable redis for `agent`
-   *
-   * Default to `false`
-   */
-  agent: boolean;
-  /**
-   * Customize iovalkey version, only set when you needed
-   *
-   * Default to `undefined`, which means using the built-in ioredis
-   */
-  Redis?: any;
-}
-
-export default {
-  redis: {
-    default: {},
-    app: true,
-    agent: false,
-    supportTimeCommand: true,
-    // Single Redis
-    // client: {
-    //   host: 'host',
-    //   port: 'port',
-    //   family: 'user',
-    //   password: 'password',
-    //   db: 'db',
-    // },
-    //
-    // Cluster Redis
-    // client: {
-    //   cluster: true,
-    //   nodes: [{
-    //     host: 'host',
-    //     port: 'port',
-    //     family: 'user',
-    //     password: 'password',
-    //     db: 'db',
-    //   }, {
-    //     host: 'host',
-    //     port: 'port',
-    //     family: 'user',
-    //     password: 'password',
-    //     db: 'db',
-    //   },
-    // ]},
-    //
-    // Multi Redis
-    // clients: {
-    //   instance1: {
-    //     host: 'host',
-    //     port: 'port',
-    //     family: 'user',
-    //     password: 'password',
-    //     db: 'db',
-    //   },
-    //   instance2: {
-    //     host: 'host',
-    //     port: 'port',
-    //     family: 'user',
-    //     password: 'password',
-    //     db: 'db',
-    //   },
-    // },
-  } as RedisConfig,
-};

package/src/index.ts

@@ -1 +0,0 @@
-import './types.js';

package/src/lib/redis.ts

@@ -1,92 +0,0 @@
-import assert from 'node:assert';
-import { once } from 'node:events';
-import { Redis } from 'ioredis';
-import type { ILifecycleBoot, EggCore } from '@eggjs/core';
-import type { RedisClusterOptions, RedisClientOptions } from '../config/config.default.js';
-
-export class RedisBoot implements ILifecycleBoot {
-  constructor(private readonly app: EggCore) {
-    // empty
-  }
-  async didLoad() {
-    const app = this.app;
-    if (app.type === 'application' && app.config.redis.app) {
-      app.addSingleton('redis', createClient);
-    } else if (app.type === 'agent' && app.config.redis.agent) {
-      app.addSingleton('redis', createClient);
-    }
-  }
-}
-
-let count = 0;
-function createClient(options: RedisClusterOptions | RedisClientOptions, app: EggCore) {
-  const RedisClass: typeof Redis = app.config.redis.Redis ?? Redis;
-  let client;
-
-  if ('cluster' in options && options.cluster === true) {
-    const config = options as RedisClusterOptions;
-    assert(config.nodes && config.nodes.length !== 0, '[@eggjs/redis] cluster nodes configuration is required when use cluster redis');
-
-    config.nodes.forEach(client => {
-      assert(client.host && client.port, `[@eggjs/redis] 'host: ${client.host}', 'port: ${client.port}' are required on config`);
-    });
-    app.coreLogger.info('[@eggjs/redis] cluster connecting');
-    client = new RedisClass.Cluster(config.nodes, config as any);
-  } else if ('sentinels' in options && options.sentinels) {
-    const config = options as RedisClientOptions;
-    assert(config.sentinels && config.sentinels.length !== 0, '[@eggjs/redis] sentinels configuration is required when use redis sentinel');
-
-    config.sentinels.forEach(sentinel => {
-      assert(sentinel.host && sentinel.port,
-        `[@eggjs/redis] 'host: ${sentinel.host}', 'port: ${sentinel.port}' are required on config`);
-    });
-
-    const mask = config.password ? '***' : config.password;
-    assert(config.name && config.password !== undefined && config.db !== undefined,
-      `[@eggjs/redis] 'name of master: ${config.name}', 'password: ${mask}', 'db: ${config.db}' are required on config`);
-
-    app.coreLogger.info('[@eggjs/redis] sentinel connecting start');
-    client = new RedisClass(config as any);
-  } else {
-    const config = options as RedisClientOptions;
-    const mask = config.password ? '***' : config.password;
-    assert((config.host && config.port && config.password !== undefined && config.db !== undefined) || config.path,
-      `[@eggjs/redis] 'host: ${config.host}', 'port: ${config.port}', 'password: ${mask}', 'db: ${config.db}' or 'path:${config.path}' are required on config`);
-    if (config.host) {
-      app.coreLogger.info('[@eggjs/redis] server connecting redis://:***@%s:%s/%s',
-        config.host, config.port, config.db);
-    } else {
-      app.coreLogger.info('[@eggjs/redis] server connecting %s',
-        config.path || config);
-    }
-
-    client = new RedisClass(config as any);
-  }
-
-  client.on('connect', () => {
-    app.coreLogger.info('[@eggjs/redis] client connect success');
-  });
-  client.on('error', err => {
-    app.coreLogger.error('[@eggjs/redis] client error: %s', err);
-    app.coreLogger.error(err);
-  });
-
-  const index = count++;
-  app.lifecycle.registerBeforeStart(async () => {
-    if ('weakDependent' in options && options.weakDependent) {
-      app.coreLogger.info(`[@eggjs/redis] instance[${index}] is weak dependent and won't block app start`);
-      client.once('ready', () => {
-        app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK`);
-      });
-      return;
-    }
-
-    await Promise.race([
-      once(client, 'ready'),
-      once(client, 'error'),
-    ]);
-    app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK, client ready`);
-  }, `[@eggjs/redis] instance[${index}] start check`);
-
-  return client;
-}

package/src/types.ts

@@ -1,14 +0,0 @@
-import type { Singleton } from '@eggjs/core';
-import type { Redis } from 'ioredis';
-import type { RedisConfig } from './config/config.default.js';
-
-declare module '@eggjs/core' {
-  // add EggAppConfig overrides types
-  interface EggAppConfig {
-    redis: RedisConfig;
-  }
-
-  interface EggCore {
-    redis: Redis & Singleton<Redis>;
-  }
-}

package/src/typings/index.d.ts

@@ -1,4 +0,0 @@
-// make sure to import egg typings and let typescript know about it
-// @see https://github.com/whxaxes/blog/issues/11
-// and https://www.typescriptlang.org/docs/handbook/declaration-merging.html
-import 'egg';