@things-factory/integration-base 7.0.7 → 7.0.10

package/helps/integration/task/state-group-read.ja.md

@@ -0,0 +1,8 @@
+# state-group-read
+
+このタスクは、[状態レジスター](../concept/state-register.md)内の特定のグループに属するすべての状態の値を読み取ります。
+
+## パラメータ
+
+- group
+  - 取得する状態「グループ」の名称を指定します。

package/helps/integration/task/state-group-read.ko.md

@@ -0,0 +1,8 @@
+# state-group-read
+
+[상태등록부(state-register)](../concept/state-register.md)에 특정 그룹에 속하는 모든 상태의 값을 읽어오는 태스크이다.
+
+## parameters
+
+- group
+  - 가져올 상태 "그룹"의 명칭을 지정한다

package/helps/integration/task/state-group-read.md

@@ -0,0 +1,10 @@
+### English Translation
+
+# state-group-read
+
+This task reads the values of all states belonging to a specific group in the [state-register](../concept/state-register.md).
+
+## parameters
+
+- group
+  - Specifies the name of the "group" of states to be fetched.

package/helps/integration/task/state-group-read.ms.md

@@ -0,0 +1,8 @@
+# state-group-read
+
+Tugas ini membaca nilai semua keadaan yang tergolong dalam kumpulan tertentu di [daftar keadaan](../concept/state-register.md).
+
+## parameter
+
+- group
+  - Menentukan nama "kumpulan" keadaan yang hendak diambil.

package/helps/integration/task/state-group-read.zh.md

@@ -0,0 +1,8 @@
+# state-group-read
+
+该任务从[状态注册表](../concept/state-register.md)中读取属于特定组的所有状态的值。
+
+## 参数
+
+- group
+  - 指定要获取的状态“组”的名称。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-base",
-  "version": "7.0.7",
+  "version": "7.0.10",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -27,13 +27,13 @@
   "dependencies": {
     "@apollo/client": "^3.6.9",
     "@operato/moment-timezone-es": "^7.0.0",
-    "@things-factory/api": "^7.0.6",
-    "@things-factory/auth-base": "^7.0.6",
-    "@things-factory/cache-service": "^7.0.6",
+    "@things-factory/api": "^7.0.10",
+    "@things-factory/auth-base": "^7.0.10",
+    "@things-factory/cache-service": "^7.0.10",
     "@things-factory/env": "^7.0.0",
-    "@things-factory/oauth2-client": "^7.0.7",
-    "@things-factory/scheduler-client": "^7.0.6",
-    "@things-factory/shell": "^7.0.6",
+    "@things-factory/oauth2-client": "^7.0.10",
+    "@things-factory/scheduler-client": "^7.0.10",
+    "@things-factory/shell": "^7.0.10",
     "@things-factory/utils": "^7.0.0",
     "async-mqtt": "^2.5.0",
     "chance": "^1.1.11",
@@ -44,5 +44,5 @@
     "readline": "^1.3.0",
     "ses": "^1.5.0"
   },
-  "gitHead": "6c9d22d79abfb199bd741f6504b29add846b46a9"
+  "gitHead": "9da4e145880a6d637db60f03116d5bbfdb6f4cfc"
 }

package/server/controllers/index.ts

@@ -1 +1,2 @@
 export * from './scenario-controller'
+export * from './publish-data'

package/server/controllers/publish-data.ts

@@ -0,0 +1,29 @@
+import { Domain, getRepository, pubsub } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+
+import { StateRegister } from '../service/state-register/state-register'
+
+export async function publishData(tag: string, data: any, { domain, user }: { domain: Domain; user: User }) {
+  const repository = getRepository(StateRegister)
+
+  const stateRegister = await repository.findOne({
+    where: { domain: { id: domain?.id }, name: tag }
+  })
+
+  if (stateRegister) {
+    await repository.save({
+      ...stateRegister,
+      state: data,
+      writer: user,
+      wroteAt: new Date()
+    })
+  }
+
+  pubsub.publish('data', {
+    data: {
+      domain,
+      tag,
+      data
+    }
+  })
+}

package/server/engine/task/index.ts

@@ -41,3 +41,4 @@ import './oracle-procedure'
 import './jsonata'
 import './state-read'
 import './state-write'
+import './state-group-read'

package/server/engine/task/state-group-read.ts

@@ -0,0 +1,69 @@
+import gql from 'graphql-tag'
+import { TaskRegistry } from '../task-registry'
+import { InputStep } from '../../service/step/step-type'
+import { Context } from '../types'
+
+async function StateGroupRead(step: InputStep, { logger, publish, data, domain, user, client }: Context) {
+  var {
+    params: { group }
+  } = step
+
+  if (!group) {
+    throw Error(`group should be defined: group - '${group}'`)
+  }
+
+  var { data: queryResult, errors } = await client.query({
+    query: gql`
+      query ($filters: [Filter!]) {
+        stateRegisters(filters: $filters) {
+          items {
+            name
+            state
+          }
+        }
+      }
+    `,
+    variables: {
+      filters: [
+        {
+          name: 'group',
+          operator: 'eq',
+          value: group
+        }
+      ]
+    },
+    context: {
+      state: {
+        domain,
+        user
+      }
+    }
+  })
+
+  if (errors) {
+    errors.forEach(error => {
+      logger.error('GraphQL Error: %s', error)
+    })
+  }
+
+  return {
+    data: queryResult?.stateRegisters?.items.reduce((status, item) => {
+      const { name, state } = item
+      status[name] = state
+      return status
+    }, {})
+  }
+}
+
+StateGroupRead.parameterSpec = [
+  {
+    type: 'string',
+    name: 'group',
+    label: 'group'
+  }
+]
+
+StateGroupRead.connectorFree = true
+StateGroupRead.help = 'integration/task/state-group-read'
+
+TaskRegistry.registerTaskHandler('state-group-read', StateGroupRead)

package/server/service/scenario-instance/scenario-instance-type.ts

@@ -11,6 +11,7 @@ import { cacheService } from '@things-factory/cache-service'
 import { User } from '@things-factory/auth-base'
 import { sleep } from '@things-factory/utils'
 
+import { publishData } from '../../controllers/publish-data'
 import { ConnectionManager } from '../../engine/connection-manager'
 import { TaskRegistry } from '../../engine'
 import { Context } from '../../engine/types'
@@ -390,13 +391,7 @@ export class ScenarioInstance {
   }
 
   publishData(tag, data) {
-    pubsub.publish('data', {
-      data: {
-        domain: this.context.domain,
-        tag,
-        data
-      }
-    })
+    publishData(tag, data, this.context)
   }
 
   publishState() {
@@ -498,9 +493,11 @@ export class ScenarioInstance {
       await this.disposer.call(this)
     }
 
-    // {{ CHECKPOINT 본 인스턴스를 위해서 생성된 logger를 닫는다.
+    // {{ CHECKPOINT 본 인스턴스를 위해서 생성된 logger를 닫는다. 사용을 완료하고 닫기위해서 지연해서 수행한다.
     if (this.context?.logger) {
-      this.context.logger.close()
+      setTimeout(() => {
+        this.context.logger.close()
+      }, 300)
     }
     // }}
   }

package/server/service/state-register/data-resolver.ts

@@ -0,0 +1,56 @@
+import { filter, pipe } from 'graphql-yoga'
+import { Arg, Resolver, Root, Subscription } from 'type-graphql'
+
+import { pubsub, Data, getRepository } from '@things-factory/shell'
+import { StateRegister } from './state-register'
+
+/* 이 Resolver는 @things-factory/shell에서 등록한 DataResolver를 Overide 한 것이다. */
+@Resolver()
+export class DataResolver {
+  @Subscription({
+    subscribe: ({ args, context, info }) => {
+      const { domain, user } = context.state
+      const { tag } = args
+      const subdomain = domain?.subdomain
+
+      if (!domain || !tag) {
+        throw new Error('domain and tag required')
+      }
+
+      //@ts-ignore
+      if (!user.domains?.find(d => d.subdomain === subdomain) && !process.superUserGranted(domain, user)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      process.nextTick(async () => {
+        /* state-register에 등록된 태그라면, 현재 상태값을 publish 한다. */
+        const { domain } = context.state
+
+        const state = await getRepository(StateRegister).findOne({
+          where: { domain: { id: domain.id }, name: tag }
+        })
+
+        if (state) {
+          pubsub.publish('data', {
+            data: {
+              domain,
+              tag,
+              data: state.state
+            }
+          })
+        }
+      })
+
+      return pipe(
+        pubsub.subscribe('data'),
+        filter((payload: { data: Data }) => {
+          const { domain: pdomain, tag: ptag, data } = payload.data
+          return tag === ptag && subdomain === pdomain?.subdomain
+        })
+      )
+    }
+  })
+  data(@Root() payload: { data: Data }, @Arg('tag') tag: string): Data {
+    return payload.data
+  }
+}

package/server/service/state-register/index.ts

@@ -1,7 +1,8 @@
 import { StateRegister } from './state-register'
 import { StateRegisterQuery } from './state-register-query'
 import { StateRegisterMutation } from './state-register-mutation'
+import { DataResolver } from './data-resolver'
 
 export const entities = [StateRegister]
-export const resolvers = [StateRegisterQuery, StateRegisterMutation]
+export const resolvers = [StateRegisterQuery, StateRegisterMutation, DataResolver]
 export const subscribers = []

package/server/service/state-register/state-register-query.ts

@@ -38,7 +38,7 @@ export class StateRegisterQuery {
       domain,
       params,
       repository: await getRepository(StateRegister),
-      searchables: ['name', 'description']
+      searchables: ['name', 'description', 'group']
     })
 
     const [items, total] = await queryBuilder.getManyAndCount()

package/server/service/state-register/state-register-type.ts

@@ -1,64 +1,80 @@
-import type { FileUpload } from 'graphql-upload/GraphQLUpload.js'
-import GraphQLUpload from 'graphql-upload/GraphQLUpload.js'
-import { ObjectType, Field, InputType, Int, ID, registerEnumType } from 'type-graphql'
+import { ObjectType, Field, InputType, Int, ID } from 'type-graphql'
 
-import { ObjectRef, ScalarObject } from '@things-factory/shell'
+import { ScalarObject } from '@things-factory/shell'
 
 import { StateRegister } from './state-register'
 
 @InputType()
 export class NewStateRegister {
-  @Field()
+  @Field({ description: 'Name of the state register' })
   name: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Description of the state register' })
   description?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Group name for the state register' })
+  group?: string
+
+  @Field({ nullable: true, description: 'Type of the state' })
   type?: string
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field({ nullable: true, description: 'Number of decimal places if the state is a number type' })
+  place?: string
+
+  @Field({ nullable: true, description: 'Unit of the state value' })
+  unit?: string
+
+  @Field(type => ScalarObject, { nullable: true, description: 'Current state value' })
   state?: any
 
-  @Field(type => Int, { nullable: true })
+  @Field(type => Int, { nullable: true, description: 'Time to live for the state value in seconds' })
   ttl?: number
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Reference to an external entity or data, used as a flexible foreign key' })
   refBy?: string
 }
 
 @InputType()
 export class StateRegisterPatch {
-  @Field(type => ID, { nullable: true })
+  @Field(type => ID, { nullable: true, description: 'ID of the state register' })
   id?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Name of the state register' })
   name?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Description of the state register' })
   description?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Group name for the state register' })
+  group?: string
+
+  @Field({ nullable: true, description: 'Type of the state' })
   type?: string
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field({ nullable: true, description: 'Number of decimal places if the state is a number type' })
+  place?: string
+
+  @Field({ nullable: true, description: 'Unit of the state value' })
+  unit?: string
+
+  @Field(type => ScalarObject, { nullable: true, description: 'Current state value' })
   state?: any
 
-  @Field(type => Int, { nullable: true })
+  @Field(type => Int, { nullable: true, description: 'Time to live for the state value in seconds' })
   ttl?: number
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Reference to an external entity or data, used as a flexible foreign key' })
   refBy?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Flag indicating create/update operations' })
   cuFlag?: string
 }
 
 @ObjectType()
 export class StateRegisterList {
-  @Field(type => [StateRegister])
+  @Field(type => [StateRegister], { description: 'List of state registers' })
   items: StateRegister[]
 
-  @Field(type => Int)
+  @Field(type => Int, { description: 'Total number of state registers' })
   total: number
 }

package/server/service/state-register/state-register.ts

@@ -1,16 +1,14 @@
 import {
   CreateDateColumn,
   UpdateDateColumn,
-  DeleteDateColumn,
   Entity,
   Index,
   Column,
   RelationId,
   ManyToOne,
-  PrimaryGeneratedColumn,
-  VersionColumn
+  PrimaryGeneratedColumn
 } from 'typeorm'
-import { ObjectType, Field, Int, ID, registerEnumType } from 'type-graphql'
+import { ObjectType, Field, Int, ID } from 'type-graphql'
 
 import { Domain, ScalarObject } from '@things-factory/shell'
 import { User } from '@things-factory/auth-base'
@@ -19,6 +17,14 @@ import { User } from '@things-factory/auth-base'
 @Index('ix_state_register_0', (stateRegister: StateRegister) => [stateRegister.domain, stateRegister.name], {
   unique: true
 })
+@Index(
+  'ix_state_register_1',
+  (stateRegister: StateRegister) => [stateRegister.domain, stateRegister.group, stateRegister.name],
+  {
+    unique: true,
+    where: '"group" IS NOT NULL'
+  }
+)
 @ObjectType({ description: 'Entity for StateRegister' })
 export class StateRegister {
   @PrimaryGeneratedColumn('uuid')
@@ -26,66 +32,82 @@ export class StateRegister {
   readonly id: string
 
   @ManyToOne(type => Domain)
-  @Field(type => Domain)
+  @Field(type => Domain, { description: 'Associated domain for the state register' })
   domain?: Domain
 
   @RelationId((stateRegister: StateRegister) => stateRegister.domain)
+  @Field({ description: 'ID of the associated domain' })
   domainId?: string
 
   @Column()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Name of the state register' })
   name?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Description of the state register' })
   description?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Group name for the state register' })
+  group?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true, description: 'Type of the state' })
   type?: string
 
+  @Column({ nullable: true })
+  @Field({ nullable: true, description: 'Number of decimal places if the state is a number type' })
+  place?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true, description: 'Unit of the state value' })
+  unit?: string
+
   @Column('simple-json', { nullable: true, default: null })
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, { nullable: true, description: 'Current state value' })
   state?: any
 
   @Column({ nullable: true, default: null })
-  @Field(type => Int, { nullable: true })
+  @Field(type => Int, { nullable: true, description: 'Time to live for the state value in seconds' })
   ttl?: number
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Reference to an external entity or data, used as a flexible foreign key' })
   refBy?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Time when the state was recorded' })
   wroteAt?: Date
 
   @CreateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Creation time of the state register' })
   createdAt?: Date
 
   @UpdateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Last update time of the state register' })
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
+  @Field(type => User, { nullable: true, description: 'User who wrote the state' })
   writer?: User
 
   @RelationId((stateRegister: StateRegister) => stateRegister.writer)
+  @Field({ nullable: true, description: 'ID of the user who wrote the state' })
   writerId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
+  @Field(type => User, { nullable: true, description: 'User who created the state register' })
   creator?: User
 
   @RelationId((stateRegister: StateRegister) => stateRegister.creator)
+  @Field({ nullable: true, description: 'ID of the user who created the state register' })
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field(type => User, { nullable: true })
+  @Field(type => User, { nullable: true, description: 'User who last updated the state register' })
   updater?: User
 
   @RelationId((stateRegister: StateRegister) => stateRegister.updater)
+  @Field({ nullable: true, description: 'ID of the user who last updated the state register' })
   updaterId?: string
 }