@things-factory/integration-base 6.2.38 → 6.2.40

package/helps/integration/connector/operato-connector.ja.md

@@ -24,3 +24,14 @@ GraphQLサーバーエンドポイントを指定します。
 ### ドメイン
 
 - 対象サーバーで動作させたいドメインを指定する必要があります。
+
+
+### タグ
+
+- ターゲットサーバーで pubsub ベースのデータを購読する際に使用されるタグ名を指定します。
+
+
+### 场景
+
+- タグが設定されている場合、購読されたメッセージを処理するシナリオを指定します。
+

package/helps/integration/connector/operato-connector.kr.md

@@ -25,4 +25,14 @@ ex. *https://abcd.hatioalb.com/graphql*
 
 ### 도메인
 
-- 대상 서버에서 동작하고자 하는 도메인을 지정해야 합니다.
+- 대상 서버에서 동작하고자 하는 도메인을 지정해야 합니다.
+
+
+### 태그
+
+- 대상 서버에서 pubsub 기반의 데이터를 구독할 때 사용되는 태그 이름을 지정합니다.
+
+
+### 시나리오
+
+- 태그가 설정되어 있을 경우, 구독된 메시지를 처리하기 위한 시나리오를 지정합니다.

package/helps/integration/connector/operato-connector.md

@@ -24,3 +24,13 @@ ex. *https://abcd.hatioalb.com/graphql*
 ### Domain
 
 - Specify the domain you want to operate on the target server.
+
+
+### tag
+
+- Specifies the tag names used when subscribing to pubsub-based data on the target server.
+
+
+### Scenario
+
+- Specifies the scenario for processing subscribed messages if the tag is set.

package/helps/integration/connector/operato-connector.ms.md

@@ -24,3 +24,13 @@ contoh: *https://abcd.hatioalb.com/graphql*
 ### Domain
 
 - Anda perlu menentukan domain yang ingin beroperasi dari server sasaran.
+
+
+### Tag
+
+- Menentukan nama tag yang digunakan saat berlangganan data berbasis pubsub pada server target.
+
+
+### Skenario
+
+- Menentukan skenario untuk memproses pesan yang telah di-subscribe jika tag sudah ditetapkan.

package/helps/integration/connector/operato-connector.zh.md

@@ -24,3 +24,13 @@
 ### 领域
 
 - 您需要指定要在目标服务器上运行的实际域。
+
+
+### 标签
+
+- 指定在目标服务器上订阅基于 pubsub 的数据时使用的标签名称。
+
+
+### 场景
+
+- 如果设置了标签，则指定用于处理已订阅消息的场景。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "6.2.38",
+  "version": "6.2.40",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/cron": "^2.0.1"
   },
-  "gitHead": "df14ab133528fadeb146f3dc2652f499df30a918"
+  "gitHead": "fd7decc71972d25ef12ad0f44ab19eb66c6d289b"
 }

package/server/engine/connector/operato-connector.ts

@@ -1,10 +1,23 @@
 import 'cross-fetch/polyfill'
 
-import { ApolloClient, InMemoryCache, createHttpLink } from '@apollo/client/core'
+import { ApolloClient, InMemoryCache, createHttpLink, split } from '@apollo/client/core'
 import { setContext } from '@apollo/client/link/context'
 
+// for subscription
+import WebSocket from 'ws'
+import { createClient } from 'graphql-ws'
+import { GraphQLWsLink } from '@apollo/client/link/subscriptions'
+import { Observable, getMainDefinition } from '@apollo/client/utilities'
+import gql from 'graphql-tag'
+
 import { ConnectionManager } from '../connection-manager'
 import { Connector } from '../types'
+import { Scenario, ScenarioInstance } from '../../service'
+
+import { getRepository, GraphqlLocalClient, Domain } from '@things-factory/shell'
+import { PrivilegeObject, User } from '@things-factory/auth-base'
+
+const debug = require('debug')('things-factory:integration-base:operato-connector-subscription')
 
 const defaultOptions: any = {
   watchQuery: {
@@ -24,7 +37,34 @@ const cache = new InMemoryCache({
   addTypename: false
 })
 
+export const GRAPHQL_URI = '/graphql'
+export const SUBSCRIPTION_URI = GRAPHQL_URI
+
+async function checkPermission(privilegeObject: PrivilegeObject, user: User, domain: Domain): Promise<boolean> {
+  if (!privilegeObject || !privilegeObject.privilege || !privilegeObject.category) {
+    return true
+  }
+
+  const { owner: domainOwnerGranted, super: superUserGranted, category, privilege } = privilegeObject
+
+  return (
+    (domainOwnerGranted && (await process.domainOwnerGranted(domain, user))) ||
+    (superUserGranted && (await process.superUserGranted(domain, user))) ||
+    (category && privilege && (await User.hasPrivilege(privilege, category, domain, user)))
+  )
+}
+
+interface SubscriberData {
+  tag: string
+  scenario: any
+  subscriptionObserver: any
+}
+;``
+
 export class OperatoConnector implements Connector {
+  private subscriptions: SubscriberData[] = []
+  private context: any
+
   async ready(connectionConfigs) {
     await Promise.all(connectionConfigs.map(this.connect.bind(this)))
 
@@ -34,41 +74,128 @@ export class OperatoConnector implements Connector {
   async connect(connection) {
     var {
       endpoint: uri,
-      params: { authKey, domain }
+      params: { authKey, domain, subscriptionHandlers = {} }
     } = connection
 
-    var ERROR_HANDLER: any = ({ graphQLErrors, networkError }) => {
-      if (graphQLErrors)
-        graphQLErrors.map(({ message, locations, path }) => {
-          ConnectionManager.logger.error(`[GraphQL error] Message: ${message}, Location: ${locations}, Path: ${path}`)
-        })
+    if (!authKey || !domain) {
+      throw new Error('some connection paramter missing.')
+    }
 
-      if (networkError) {
-        ConnectionManager.logger.error(`[Network error - ${networkError.statusCode}] ${networkError}`)
+    var domainOwner = await getRepository(User).findOne({
+      where: {
+        id: connection.domain.owner
       }
+    })
+
+    this.context = {
+      domain: connection.domain,
+      user: domainOwner
+      /* TODO: domainOwner 대신 특정 유저를 지정할 수 있도록 개선해야함. 모든 커넥션에 유저를 지정하는 기능으로 일반화할 필요가 있는 지 고민해야함 */
     }
 
     const httpLink = createHttpLink({
       uri: uri
     })
 
-    ConnectionManager.addConnectionInstance(
-      connection,
-      new ApolloClient({
-        defaultOptions,
-        cache,
-        link: setContext((_, { headers }) => {
-          return {
-            headers: {
-              ...headers,
-              'x-things-factory-domain': domain,
-              authorization: authKey ? `Bearer ${authKey}` : ''
-            }
+    /* 
+    CHECKPOINT: 
+      1. GraphqQLWsLink를 사용하면 setContext를 통한 추가 헤더 설정이 무시됩니다.
+      따라서, GraphQLWsLink를 사용하려면, connectionParams를 통해 헤더를 설정해야 합니다.
+    
+      2. 서버에서 실행시, webSocketImpl을 명시적으로 지정해야 합니다.
+    */
+    const wsLink = new GraphQLWsLink(
+      createClient({
+        url: uri.replace(/^http/, 'ws'),
+        keepAlive: 10_000,
+        retryAttempts: 1_000_000,
+        shouldRetry: e => true,
+        webSocketImpl: WebSocket,
+        connectionParams: {
+          headers: {
+            'x-things-factory-domain': domain,
+            authorization: authKey ? `Bearer ${authKey}` : ''
           }
-        }).concat(httpLink)
+        }
       })
     )
 
+    const splitLink = split(
+      ({ query }) => {
+        const def = getMainDefinition(query)
+        return def.kind === 'OperationDefinition' && def.operation === 'subscription'
+      },
+      wsLink,
+      setContext((_, { headers }) => {
+        return {
+          headers: {
+            ...headers,
+            'x-things-factory-domain': domain,
+            authorization: authKey ? `Bearer ${authKey}` : ''
+          }
+        }
+      }).concat(httpLink)
+    )
+
+    var client = new ApolloClient({
+      defaultOptions,
+      cache,
+      link: splitLink
+    })
+
+    var subscriptions: SubscriberData[] = []
+    Object.keys(subscriptionHandlers).forEach(async tag => {
+      if (!tag || !subscriptionHandlers[tag]) return
+
+      let scenarioName = subscriptionHandlers[tag]
+
+      // fetch a scenario
+      var selectedScenario = await getRepository(Scenario).findOne({
+        where: {
+          name: scenarioName
+        },
+        relations: ['steps', 'domain']
+      })
+
+      const subscription = client.subscribe({
+        query: gql`
+          subscription {
+            data(tag: "${tag}") {
+              tag
+              data
+            }
+          }
+        `
+      })
+
+      var subscriptionObserver = subscription.subscribe({
+        next: async data => {
+          debug('received pubsub msg.:', data?.data)
+          await this.runScenario(subscriptions, data?.data?.data)
+        },
+        error: error => {
+          ConnectionManager.logger.error(`(${connection.name}:${connection.endpoint}) subscription error: ${error}`)
+        },
+        complete: () => {
+          ConnectionManager.logger.info(`(${connection.name}:${connection.endpoint}) subscription complete`)
+        }
+      })
+
+      ConnectionManager.logger.info(
+        `(${connection.name}:${connection.endpoint}) subscription closed flag: ${subscriptionObserver.closed}`
+      )
+
+      subscriptions.push({
+        tag,
+        scenario: selectedScenario,
+        subscriptionObserver
+      })
+      ConnectionManager.logger.info(`(${tag}:${scenarioName}) subscription closed flag: ${subscriptionObserver.closed}`)
+    })
+
+    client['subscriptions'] = subscriptions
+    ConnectionManager.addConnectionInstance(connection, client)
+
     ConnectionManager.logger.info(
       `graphql-connector connection(${connection.name}:${connection.endpoint}) is connected`
     )
@@ -76,12 +203,46 @@ export class OperatoConnector implements Connector {
 
   async disconnect(connection) {
     var client = ConnectionManager.getConnectionInstance(connection)
+    let subscriptions: SubscriberData[] = client['subscriptions']
+    subscriptions.forEach(subscription => subscription.subscriptionObserver.unsubscribe())
     client.stop()
     ConnectionManager.removeConnectionInstance(connection)
 
     ConnectionManager.logger.info(`graphql-connector connection(${connection.name}) is disconnected`)
   }
 
+  async runScenario(subscriptions: SubscriberData[], variables: any): Promise<ScenarioInstance> {
+    const { domain, user } = this.context
+    const { tag } = variables
+
+    if (!tag) {
+      throw new Error(`tag is invalid - ${tag}`)
+    }
+
+    var scenario = subscriptions.find(subscription => subscription.tag === tag)?.scenario
+    if (!scenario) {
+      throw new Error(`scenario is not found - ${tag}`)
+    }
+
+    if (!(await checkPermission(scenario.privilege, user, domain))) {
+      const { category, privilege } = scenario.privilege || {}
+      throw new Error(`Unauthorized! ${category}-${privilege} privilege required`)
+    }
+
+    /* create a scenario instance */
+    let instanceName = scenario.name + '-' + String(Date.now())
+    var instance = new ScenarioInstance(instanceName, scenario, {
+      user,
+      domain,
+      variables,
+      client: GraphqlLocalClient.client
+    })
+
+    // run scenario
+    await instance.run()
+    return instance
+  }
+
   get parameterSpec() {
     return [
       {
@@ -93,6 +254,11 @@ export class OperatoConnector implements Connector {
         type: 'string',
         name: 'domain',
         label: 'domain'
+      },
+      {
+        type: 'tag-scenarios',
+        name: 'subscriptionHandlers',
+        label: 'subscription-handlers'
       }
     ]
   }
@@ -106,7 +272,7 @@ export class OperatoConnector implements Connector {
   }
 
   get description() {
-    return 'Operato Grpahql Connector'
+    return 'Operato Graphql Connector'
   }
 }
 

package/translations/en.json

@@ -3,5 +3,6 @@
   "error.schedule is not set": "schedule should be set for the scenario '{scenario}' in order to register as a schedule",
   "error.timezone is not set": "timezone should be set for the scenario '{scenario}' in order to register as a schedule",
   "error.scenario instance not found": "scenario instance '{instance}' not found.",
-  "label.auth-key": "authentication key"
+  "label.auth-key": "authentication key",
+  "label.subscription-handlers": "subscription handlers"
 }

package/translations/ja.json

@@ -3,5 +3,6 @@
   "error.schedule is not set": "スケジュールとして登録するためにはシナリオ'{scenario}'にスケジュール情報が設定される必要があります.",
   "error.timezone is not set": "スケジュールとして登録するためにはシナリオ'{scenario}'にタイム ゾーン情報が設定される必要があります.",
   "error.scenario instance not found": "シナリオ インスタンス'{instance}'が見つかりません. 既に終了している可能性があります.",
-  "label.auth-key": "認証キー"
+  "label.auth-key": "認証キー",
+  "label.subscription-handlers": "サブスクリプションハンドラー"
 }

package/translations/ko.json

@@ -3,5 +3,6 @@
   "error.schedule is not set": "스케쥴로 등록하기 위해서는 시나리오 '{scenario}'에 스케쥴 정보가 설정되어야 합니다.",
   "error.timezone is not set": "스케쥴로 등록하기 위해서는 시나리오 '{scenario}'에 타임존 정보가 설정되어야 합니다.",
   "error.scenario instance not found": "시나리오 인스턴스 '{instance}'를 찾을 수 없습니다. 이미 종료되었을 수 있습니다.",
-  "label.auth-key": "인증 키"
+  "label.auth-key": "인증 키",
+  "label.subscription-handlers": "구독 핸들러"
 }

package/translations/ms.json

@@ -3,5 +3,6 @@
   "error.schedule is not set": "Untuk mendaftarkan sebagai jadual, maklumat jadual mesti diset dalam senario '{scenario}'.",
   "error.timezone is not set": "Untuk mendaftarkan sebagai jadual, maklumat zon masa mesti diset dalam senario '{scenario}'.",
   "error.scenario instance not found": "Tidak dapat mencari instans senario '{instance}'. Mungkin telah berakhir.",
-  "label.auth-key": "Kunci pengesahan"
+  "label.auth-key": "Kunci pengesahan",
+  "label.subscription-handlers": "pengendali langganan"
 }

package/translations/zh.json

@@ -3,5 +3,6 @@
   "error.schedule is not set": "要注册为计划，场景 '{scenario}' 需要设置计划信息。",
   "error.timezone is not set": "要注册为计划，场景 '{scenario}' 需要设置时区信息。",
   "error.scenario instance not found": "无法找到场景实例 '{instance}'。它可能已经结束。",
-  "label.auth-key": "认证密钥"
+  "label.auth-key": "认证密钥",
+  "label.subscription-handlers": "订阅处理程序"
 }