@things-factory/shell 7.0.14 → 7.0.19

package/helps/config/pubsub.ja.md

@@ -0,0 +1,46 @@
+## pubsub
+
+### 設定オプション
+
+- **middleware**: Pub/Sub機能を実装するために使用するミドルウェア。（`redis` または `redisCluster` から選択）
+- **host**: Redisサーバーのホスト名（middlewareが `redis` の場合に使用）
+- **port**: Redisサーバーのポート番号（middlewareが `redis` の場合に使用）
+- **nodes**: Redisクラスターノード情報（middlewareが `redisCluster` の場合に使用）
+  - 例：
+    ```json
+    [
+      { "host": "endpoint1", "port": 6379 },
+      { "host": "endpoint2", "port": 6379 }
+    ]
+    ```
+- **options**: RedisまたはRedisクラスターに使用する追加オプション
+
+### デフォルト設定例
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redis',
+    host: 'redis',
+    port: 6379,
+    options: {
+      // Redisに対する追加オプション
+    }
+  }
+}
+```
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redisCluster',
+    nodes: [
+      { host: 'endpoint1', port: 6379 },
+      { host: 'endpoint2', port: 6379 }
+    ],
+    options: {
+      // Redisクラスターに対する追加オプション
+    }
+  }
+}
+```

package/helps/config/pubsub.ko.md

@@ -0,0 +1,46 @@
+## pubsub
+
+### 설정 옵션
+
+- **middleware**: Pub/Sub 기능을 구현하기 위해 사용할 미들웨어. (`redis` 또는 `redisCluster` 중 선택)
+- **host**: Redis 서버의 호스트 이름 (middleware가 `redis`일 경우 사용)
+- **port**: Redis 서버의 포트 번호 (middleware가 `redis`일 경우 사용)
+- **nodes**: Redis 클러스터 노드 정보 (middleware가 `redisCluster`일 경우 사용)
+  - 예시:
+    ```json
+    [
+      { "host": "endpoint1", "port": 6379 },
+      { "host": "endpoint2", "port": 6379 }
+    ]
+    ```
+- **options**: Redis 또는 Redis 클러스터에 사용할 추가 옵션
+
+### 기본 설정 예시
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redis',
+    host: 'redis',
+    port: 6379,
+    options: {
+      // Redis에 대한 추가 옵션
+    }
+  }
+}
+```
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redisCluster',
+    nodes: [
+      { host: 'endpoint1', port: 6379 },
+      { host: 'endpoint2', port: 6379 }
+    ],
+    options: {
+      // Redis 클러스터에 대한 추가 옵션
+    }
+  }
+}
+```

package/helps/config/pubsub.md

@@ -0,0 +1,46 @@
+## pubsub
+
+### Configuration Options
+
+- **middleware**: Middleware to be used for implementing Pub/Sub functionality. (Choose between `redis` or `redisCluster`)
+- **host**: Host name of the Redis server (used when middleware is `redis`)
+- **port**: Port number of the Redis server (used when middleware is `redis`)
+- **nodes**: Redis cluster node information (used when middleware is `redisCluster`)
+  - Example:
+    ```json
+    [
+      { "host": "endpoint1", "port": 6379 },
+      { "host": "endpoint2", "port": 6379 }
+    ]
+    ```
+- **options**: Additional options for Redis or Redis cluster
+
+### Default Configuration Example
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redis',
+    host: 'redis',
+    port: 6379,
+    options: {
+      // Additional options for Redis
+    }
+  }
+}
+```
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redisCluster',
+    nodes: [
+      { host: 'endpoint1', port: 6379 },
+      { host: 'endpoint2', port: 6379 }
+    ],
+    options: {
+      // Additional options for Redis cluster
+    }
+  }
+}
+```

package/helps/config/pubsub.ms.md

@@ -0,0 +1,46 @@
+## pubsub
+
+### Pilihan Konfigurasi
+
+- **middleware**: Middleware yang akan digunakan untuk melaksanakan fungsi Pub/Sub. (Pilih antara `redis` atau `redisCluster`)
+- **host**: Nama host pelayan Redis (digunakan apabila middleware adalah `redis`)
+- **port**: Nombor port pelayan Redis (digunakan apabila middleware adalah `redis`)
+- **nodes**: Maklumat nod kluster Redis (digunakan apabila middleware adalah `redisCluster`)
+  - Contoh:
+    ```json
+    [
+      { "host": "endpoint1", "port": 6379 },
+      { "host": "endpoint2", "port": 6379 }
+    ]
+    ```
+- **options**: Pilihan tambahan untuk Redis atau kluster Redis
+
+### Contoh Konfigurasi Lalai
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redis',
+    host: 'redis',
+    port: 6379,
+    options: {
+      // Pilihan tambahan untuk Redis
+    }
+  }
+}
+```
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redisCluster',
+    nodes: [
+      { host: 'endpoint1', port: 6379 },
+      { host: 'endpoint2', port: 6379 }
+    ],
+    options: {
+      // Pilihan tambahan untuk kluster Redis
+    }
+  }
+}
+```

package/helps/config/pubsub.zh.md

@@ -0,0 +1,46 @@
+## pubsub
+
+### 配置选项
+
+- **middleware**: 用于实现Pub/Sub功能的中间件。 （选择 `redis` 或 `redisCluster`）
+- **host**: Redis服务器的主机名（当middleware为 `redis` 时使用）
+- **port**: Redis服务器的端口号（当middleware为 `redis` 时使用）
+- **nodes**: Redis集群节点信息（当middleware为 `redisCluster` 时使用）
+  - 示例：
+    ```json
+    [
+      { "host": "endpoint1", "port": 6379 },
+      { "host": "endpoint2", "port": 6379 }
+    ]
+    ```
+- **options**: Redis或Redis集群的附加选项
+
+### 默认配置示例
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redis',
+    host: 'redis',
+    port: 6379,
+    options: {
+      // Redis的附加选项
+    }
+  }
+}
+```
+
+```javascript
+module.exports = {
+  pubsub: {
+    middleware: 'redisCluster',
+    nodes: [
+      { host: 'endpoint1', port: 6379 },
+      { host: 'endpoint2', port: 6379 }
+    ],
+    options: {
+      // Redis集群的附加选项
+    }
+  }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/shell",
-  "version": "7.0.14",
+  "version": "7.0.19",
   "description": "Core module for framework",
   "bin": {
     "things-factory": "bin/things-factory",
@@ -41,6 +41,7 @@
     "@graphql-tools/merge": "^9.0.3",
     "@graphql-tools/schema": "^8.5.0",
     "@graphql-tools/utils": "^10.1.2",
+    "@graphql-yoga/redis-event-target": "^3.0.1",
     "@hatiolab/koa-webpack": "^7.0.9",
     "@hatiolab/things-scene": "^3.2.0",
     "@koa/cors": "^5.0.0",
@@ -77,8 +78,6 @@
     "fs-extra": "^9.0.1",
     "glob": "^7.1.6",
     "graphql": "^16.5.0",
-    "graphql-mqtt-subscriptions": "^1.2.0",
-    "graphql-redis-subscriptions": "^2.5.0",
     "graphql-scalars": "^1.22.4",
     "graphql-tag": "^2.12.6",
     "graphql-upload": "^15.0.2",
@@ -88,7 +87,7 @@
     "html-webpack-plugin": "^5.5.0",
     "husky": "7.0.1",
     "inquirer": "^8.2.0",
-    "ioredis": "^4.28.0",
+    "ioredis": "^5.4.1",
     "json-stringify-safe": "^5.0.1",
     "json5": "^2.2.0",
     "koa": "^2.13.4",
@@ -134,5 +133,5 @@
     "pg": "^8.7.3",
     "sqlite3": "^5.0.8"
   },
-  "gitHead": "f035fb9205690ef854626872fcdfc85608d84dc2"
+  "gitHead": "d12e0e75184c6d17e73f0a330a618a18a7e61d22"
 }

package/server/pubsub.ts

@@ -2,33 +2,22 @@
  * @module pubsub
  * @description
  * This module provides a Pub/Sub (Publish/Subscribe) mechanism for handling messages and events.
- * Developers can use various middleware options such as MQTT, Redis, Redis Cluster, or Kafka
+ * Developers can use various middleware options such as Redis, Redis Cluster
  * to implement Pub/Sub functionality.
  */
 
-import { MQTTPubSub } from 'graphql-mqtt-subscriptions'
-import { RedisPubSub } from 'graphql-redis-subscriptions'
 import { createPubSub } from 'graphql-yoga'
+import { createRedisEventTarget } from '@graphql-yoga/redis-event-target'
 import Redis from 'ioredis'
-import { connect } from 'mqtt'
 
 import { config, logger } from '@things-factory/env'
 import { PubSub } from 'type-graphql'
 
-const { middleware, host, port, nodes, topic, options } = config.get('pubsub', {})
+const { middleware, host, port, nodes, options } = config.get('pubsub', {})
 
 let pubsub: PubSub
 
 switch (middleware) {
-  case 'mqtt':
-    //@ts-ignore
-    pubsub = new MQTTPubSub({
-      client: connect('mqtt://' + host, {
-        reconnectPeriod: 1000,
-        ...options
-      }) as any
-    })
-    break
   case 'redis':
     const redisOption = {
       host,
@@ -40,35 +29,22 @@ switch (middleware) {
       ...options
     }
     //@ts-ignore
-    pubsub = new RedisPubSub({
-      publisher: new Redis(redisOption),
-      subscriber: new Redis(redisOption)
+    pubsub = createPubSub({
+      eventTarget: createRedisEventTarget({
+        publishClient: new Redis(redisOption),
+        subscribeClient: new Redis(redisOption)
+      })
     })
     break
   case 'redisCluster':
     const cluster = new Redis.Cluster(nodes, options)
     //@ts-ignore
-    pubsub = new RedisPubSub({
-      publisher: cluster,
-      subscriber: cluster
-    })
-    break
-  case 'kafka':
-    try {
-      /*
-       * https://github.com/hatiolab/things-factory/issues/1239
-       */
-      const { KafkaPubSub } = require('graphql-kafka-subscriptions')
-      pubsub = new KafkaPubSub({
-        topic,
-        host,
-        port,
-        ...options
+    pubsub = createPubSub({
+      eventTarget: createRedisEventTarget({
+        publishClient: cluster,
+        subscribeClient: cluster
       })
-    } catch (e) {
-      logger.error('graphql-kafka-subscriptions module is not installed, so application can not go further.', e)
-      throw e
-    }
+    })
     break
   default:
     pubsub = createPubSub()