@things-factory/dataset 6.2.118 → 6.2.120

package/server/routes.ts

@@ -2,13 +2,13 @@ import { In } from 'typeorm'
 
 import { Domain, getDataSource } from '@things-factory/shell'
 import { User } from '@things-factory/auth-base'
-import { Activity } from '@things-factory/worklist'
-import { issue } from '@things-factory/worklist/dist-server/controllers/activity-instance/issue'
+import { runScenario } from '@things-factory/integration-base'
 import { ScheduleRegisterRequest } from '@things-factory/scheduler-client'
 
 import { createDataSample } from './controllers/create-data-sample'
 import { renderJasperReport } from './controllers/jasper-report'
 import { renderShinyReport } from './controllers/shiny-report'
+import { issueCollectData } from './controllers/issue-collect-data'
 import { DataSensor } from './service/data-sensor/data-sensor'
 import { DataSet } from './service/data-set/data-set'
 
@@ -23,8 +23,8 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
   globalPublicRouter.post('/sensor-data', async (context, next) => {
     // 데이타 검증
     const { deviceId, data, rawData, timestamp = Date.now() } = context.request.body
-    if (!deviceId || !data) {
-      throw new Error(`deviceId(${deviceId}) and data(${JSON.stringify(data)}) properties are mandatory`)
+    if (!deviceId) {
+      throw new Error(`The deviceId(${deviceId}) property are mandatory`)
     }
 
     // make new data-sample
@@ -32,7 +32,7 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
       // find sensor through deviceId
       const sensor = await tx.getRepository(DataSensor).findOne({
         where: { deviceId },
-        relations: ['domain', 'appliance', 'dataSet']
+        relations: ['domain', 'appliance', 'dataSet', 'decoder']
       })
 
       if (!sensor) {
@@ -47,18 +47,18 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
         throw new Error(`Appliance of the sensor given deviceId(${deviceId}) is not set up`)
       }
 
-      if (!sensor.dataSet) {
-        throw new Error(`DataSet of the sensor given deviceId(${deviceId}) is not set up`)
-      }
+      // if (!sensor.dataSet) {
+      //   throw new Error(`DataSet of the sensor given deviceId(${deviceId}) is not set up`)
+      // }
 
       const domain = sensor.domain
       const dataSet = sensor.dataSet
-      const user: User = await tx.getRepository(User).findOne({
-        where: {
-          reference: sensor.appliance.id,
-          userType: 'appliance'
-        }
-      })
+      // const user: User = await tx.getRepository(User).findOne({
+      //   where: {
+      //     reference: sensor.appliance.id,
+      //     userType: 'appliance'
+      //   }
+      // })
 
       context.state = {
         ...context.state,
@@ -66,19 +66,40 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
         tx
       }
 
-      return await createDataSample(
-        {
-          dataSet,
+      var decoded
+      if (sensor.decoder) {
+        const { name: scenarioName } = sensor.decoder
+        const variables = {
+          dataSensor: sensor,
+          source: deviceId,
           data,
           rawData,
-          source: deviceId,
-          collectedAt: new Date(timestamp)
-        },
-        context
-      )
-    })
+          timestamp
+        }
 
-    context.status = 200
+        decoded = (await runScenario(null, scenarioName, variables, context))?.result
+      }
+
+      if (dataSet) {
+        await createDataSample(
+          {
+            dataSet,
+            data,
+            rawData,
+            source: deviceId,
+            collectedAt: new Date(timestamp),
+            ...decoded
+          },
+          context
+        )
+      }
+
+      context.status = 200
+      context.body = {
+        data,
+        ...decoded
+      }
+    })
   })
 
   /* When a callback occurs from the scheduler when a scheduled dataset is on schedule, data collection task for the dataset should be issued. */
@@ -95,55 +116,7 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
       throw new Error(`group(${domainId}) and key(${dataSetId}) properties should not be empty`)
     }
 
-    await getDataSource().transaction(async tx => {
-      const domain = await tx.getRepository(Domain).findOneBy({ id: domainId })
-
-      if (!domain) {
-        throw new Error(`domain(${domainId}) not found`)
-      }
-
-      const dataSet = await tx
-        .getRepository(DataSet)
-        .findOne({ where: { domain: { id: In([domain.id, domain.parentId].filter(Boolean)) }, id: dataSetId } })
-
-      const activity = (await tx.getRepository(Activity).findOneBy({
-        domain: { id: domainId },
-        name: 'Collect Data'
-      })) as Activity
-
-      if (activity) {
-        const { assignees } = dataSet
-
-        /* 해당 dataset에 대한 데이타 수집 태스크를 dataset assignees에게 할당한다. */
-        if (assignees && assignees instanceof Array && assignees.length > 0) {
-          const activityInstance = {
-            name: `[Data 수집] ${dataSet.name}`,
-            description: dataSet.description,
-            activityId: activity.id,
-            dueAt: new Date(Date.now() + 24 * 60 * 60 * 1000),
-            input: {
-              dataSetId: dataSet.id,
-              dataSetName: dataSet.name
-            },
-            assignees
-          }
-
-          context.state = {
-            ...context.state,
-            domain,
-            tx
-          }
-
-          await issue(activityInstance, context)
-        } else {
-          throw new Error(
-            `Assignees not set. So Data Collect Activity for ${dataSet.name}($dataSet.id) could not be issued.`
-          )
-        }
-      } else {
-        throw new Error(`Data Collect Activity is not installed.`)
-      }
-    })
+    await issueCollectData(domainId, dataSetId, context)
 
     context.status = 200
   })
@@ -169,9 +142,7 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
         throw new Error(`domain(${domainId}) not found`)
       }
 
-      const dataSet = await tx
-        .getRepository(DataSet)
-        .findOne({ where: { domain: { id: In([domain.id, domain.parentId].filter(Boolean)) }, id: dataSetId } })
+      const dataSet = await tx.getRepository(DataSet).findOne({ where: { domain: { id: In([domain.id, domain.parentId].filter(Boolean)) }, id: dataSetId } })
 
       // do what you gotta do
     })

package/server/service/data-sample/data-sample.ts

@@ -3,7 +3,7 @@ import { Column, CreateDateColumn, Entity, Index, JoinColumn, ManyToOne, OneToOn
 
 import { User } from '@things-factory/auth-base'
 import { config } from '@things-factory/env'
-import { Domain, ScalarObject } from '@things-factory/shell'
+import { Domain, ScalarObject, json5Transformer } from '@things-factory/shell'
 import { ActivityInstance } from '@things-factory/worklist'
 
 import { DataItem } from '../data-set/data-item-type'
@@ -74,7 +74,8 @@ export class DataSample {
 
   @Column({
     nullable: true,
-    type: DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb' ? 'longtext' : DATABASE_TYPE == 'oracle' ? 'clob' : 'varchar'
+    type: DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb' ? 'longtext' : DATABASE_TYPE == 'oracle' ? 'clob' : 'varchar',
+    transformer: json5Transformer
   })
   @Field({ nullable: true })
   rawData?: string

package/server/service/data-sensor/data-sensor-query.ts

@@ -2,6 +2,7 @@ import { Arg, Args, Ctx, FieldResolver, Query, Resolver, Root } from 'type-graph
 
 import { Appliance, User } from '@things-factory/auth-base'
 import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
+import { Scenario } from '@things-factory/integration-base'
 
 import { DataSet } from '../data-set/data-set'
 import { DataSensor } from './data-sensor'
@@ -39,11 +40,22 @@ export class DataSensorQuery {
     return dataSensor.applianceId && (await getRepository(Appliance).findOneBy({ id: dataSensor.applianceId }))
   }
 
-  @FieldResolver(type => Appliance)
+  @FieldResolver(type => DataSet)
   async dataSet(@Root() dataSensor: DataSensor): Promise<DataSet> {
     return dataSensor.dataSetId && (await getRepository(DataSet).findOneBy({ id: dataSensor.dataSetId }))
   }
 
+  @FieldResolver(type => Scenario)
+  async decoder(@Root() dataSensor: DataSensor): Promise<Scenario> {
+    return (
+      dataSensor.decoder ||
+      (dataSensor.decoderId &&
+        (await getRepository(Scenario).findOneBy({
+          id: dataSensor.decoderId
+        })))
+    )
+  }
+
   @FieldResolver(type => Domain)
   async domain(@Root() dataSensor: DataSensor): Promise<Domain> {
     return dataSensor.domainId && (await getRepository(Domain).findOneBy({ id: dataSensor.domainId }))

package/server/service/data-sensor/data-sensor-type.ts

@@ -41,6 +41,9 @@ export class NewDataSensor {
 
   @Field(type => ObjectRef, { nullable: true })
   dataSet?: ObjectRef
+
+  @Field(type => ObjectRef, { nullable: true })
+  decoder?: ObjectRef
 }
 
 @InputType()
@@ -84,6 +87,9 @@ export class DataSensorPatch {
   @Field(type => ObjectRef, { nullable: true })
   dataSet?: ObjectRef
 
+  @Field(type => ObjectRef, { nullable: true })
+  decoder?: ObjectRef
+
   @Field()
   cuFlag: string
 }

package/server/service/data-sensor/data-sensor.ts

@@ -1,17 +1,9 @@
 import { Field, ID, ObjectType } from 'type-graphql'
-import {
-  Column,
-  CreateDateColumn,
-  Entity,
-  Index,
-  ManyToOne,
-  PrimaryGeneratedColumn,
-  RelationId,
-  UpdateDateColumn
-} from 'typeorm'
+import { Column, CreateDateColumn, Entity, Index, ManyToOne, PrimaryGeneratedColumn, RelationId, UpdateDateColumn } from 'typeorm'
 
-import { Appliance, User } from '@things-factory/auth-base'
 import { Domain } from '@things-factory/shell'
+import { Appliance, User } from '@things-factory/auth-base'
+import { Scenario } from '@things-factory/integration-base'
 
 import { DataSet } from '../data-set/data-set'
 
@@ -91,6 +83,16 @@ export class DataSensor {
   @RelationId((dataSensor: DataSensor) => dataSensor.dataSet)
   dataSetId?: string
 
+  @ManyToOne(type => Scenario, { nullable: true })
+  @Field(type => Scenario, {
+    nullable: true,
+    description: 'The decoder scenario that automatically executes based on the trigger of raw data collection'
+  })
+  decoder?: Scenario
+
+  @RelationId((dataSensor: DataSensor) => dataSensor.decoder)
+  decoderId?: string
+
   @CreateDateColumn()
   @Field({ nullable: true })
   createdAt?: Date

package/server/service/data-set/data-set-query.ts

@@ -243,21 +243,21 @@ export class DataSetQuery {
   }
 
   @FieldResolver(type => Board, { nullable: true })
-  async entryBoard(@Root() dataSet: DataSet) {
+  async entryBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.entryType == 'board' && dataSet.entryView) {
       return await getRepository(Board).findOneBy({ id: dataSet.entryView })
     }
   }
 
   @FieldResolver(type => Board, { nullable: true })
-  async monitorBoard(@Root() dataSet: DataSet) {
+  async monitorBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.monitorType == 'board' && dataSet.monitorView) {
       return await getRepository(Board).findOneBy({ id: dataSet.monitorView })
     }
   }
 
   @FieldResolver(type => DataKeySet, { nullable: true })
-  async dataKeySet(@Root() dataSet: DataSet) {
+  async dataKeySet(@Root() dataSet: DataSet): Promise<DataKeySet> {
     return (
       dataSet.dataKeySet ||
       (dataSet.dataKeySetId &&
@@ -267,8 +267,8 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Role)
-  async normalScenario(@Root() dataSet: DataSet): Promise<Role> {
+  @FieldResolver(type => Scenario)
+  async normalScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.normalScenario ||
       (dataSet.normalScenarioId &&
@@ -278,8 +278,8 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Role)
-  async outlierScenario(@Root() dataSet: DataSet): Promise<Role> {
+  @FieldResolver(type => Scenario)
+  async outlierScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.outlierScenario ||
       (dataSet.outlierScenarioId &&

package/translations/en.json

@@ -27,6 +27,8 @@
   "field.data-sample": "data sample",
   "field.data-set": "data set",
   "field.date": "date",
+  "field.decoder": "decoder",
+  "field.decoder-scenario": "decoder scenario",
   "field.device-id": "device id",
   "field.download-url": "download url",
   "field.entry-role": "entry role",
@@ -85,6 +87,7 @@
   "label.corrective action": "corrective action",
   "label.corrective instruction": "corrective instruction",
   "label.critical-limits": "critical limits",
+  "label.data-set": "data set",
   "label.data-set-type": "type",
   "label.datasample review timeline": "data sample review timeline",
   "label.end-date": "end date",
@@ -99,11 +102,13 @@
   "label.period-this-month": "this month",
   "label.period-this-year": "this year",
   "label.period-today": "today",
+  "label.raw-data": "raw data",
   "label.start-date": "start date",
   "label.state-corrected": "corrected",
   "label.state-issued": "issued",
   "label.state-reviewed": "reviewed",
   "label.target-limits": "target limits",
+  "label.timestamp": "timestamp",
   "text.automatically collected": "automatically collected",
   "text.corrective action placeholder": "Please enter details for implementing corrective and preventive actions",
   "text.corrective instruction placeholder": "Please enter instructions for corrective and preventive actions",
@@ -145,6 +150,7 @@
   "title.edit duration": "edit duration",
   "title.edit hashtag": "edit hashtag",
   "title.edit json": "edit json",
+  "title.lookup scenario": "lookup scenario",
   "title.open data sample report page": "open data sample report page",
   "title.open data sample search page": "open data sample search page",
   "title.open data sample view": "open data sample view",

package/translations/ja.json

@@ -27,6 +27,8 @@
   "field.data-sample": "データ サンプル",
   "field.data-set": "データ セット",
   "field.date": "日時",
+  "field.decoder": "デコーダー",
+  "field.decoder-scenario": "デコーダーシナリオ",
   "field.device-id": "デバイスID",
   "field.download-url": "ダウンロード アドレス",
   "field.entry-role": "入力担当ロール",
@@ -85,6 +87,7 @@
   "label.corrective action": "是正措置",
   "label.corrective instruction": "是正指示",
   "label.critical-limits": "許容限界範囲",
+  "label.data-set": "データ セット",
   "label.data-set-type": "タイプ",
   "label.datasample review timeline": "データサンプルレビュータイムライン",
   "label.end-date": "終了日",
@@ -99,11 +102,13 @@
   "label.period-this-month": "今月",
   "label.period-this-year": "今年",
   "label.period-today": "今日",
+  "label.raw-data": "生データ",
   "label.start-date": "開始日",
   "label.state-corrected": "修正済",
   "label.state-issued": "発行済",
   "label.state-reviewed": "審査済",
   "label.target-limits": "管理目標範囲",
+  "label.timestamp": "タイムスタンプ",
   "text.automatically collected": "自動収集",
   "text.corrective action placeholder": "是正及び予防措置の実施事項を入力してください",
   "text.corrective instruction placeholder": "是正及び予防措置の指示事項を入力してください",
@@ -144,6 +149,7 @@
   "title.edit duration": "周期編集",
   "title.edit hashtag": "ハッシュタグ編集",
   "title.edit json": "JSON編集",
+  "title.lookup scenario": "ルックアップシナリオ",
   "title.open data sample report page": "データ サンプル レポート ページを開く",
   "title.open data sample search page": "データ サンプル検索ページを開く",
   "title.open data sample view": "データ サンプル ビューページを開く",

package/translations/ko.json

@@ -27,6 +27,8 @@
   "field.data-sample": "데이타 샘플",
   "field.data-set": "데이타셋",
   "field.date": "일자",
+  "field.decoder": "디코더",
+  "field.decoder-scenario": "디코더 시나리오",
   "field.device-id": "디바이스 아이디",
   "field.download-url": "다운로드 주소",
   "field.entry-role": "입력담당 역할",
@@ -85,6 +87,7 @@
   "label.corrective action": "수정 조치",
   "label.corrective instruction": "수정 지시",
   "label.critical-limits": "허용 한계범위",
+  "label.data-set": "데이타셋",
   "label.data-set-type": "유형",
   "label.datasample review timeline": "데이타샘플 리뷰 타임라인",
   "label.end-date": "종료일",
@@ -99,11 +102,13 @@
   "label.period-this-month": "이번달",
   "label.period-this-year": "올해",
   "label.period-today": "오늘",
+  "label.raw-data": "원시 데이타",
   "label.start-date": "시작일",
   "label.state-corrected": "조치완료",
   "label.state-issued": "발생",
   "label.state-reviewed": "검토완료",
   "label.target-limits": "관리 목표범위",
+  "label.timestamp": "타임스탬프",
   "text.automatically collected": "자동 수집",
   "text.corrective action placeholder": "시정 및 예방을 위한 조치 이행 사항을 입력해주세요",
   "text.corrective instruction placeholder": "시정 및 예방을 위한 조치 지시 사항을 입력해주세요",
@@ -144,6 +149,7 @@
   "title.edit duration": "주기 편집",
   "title.edit hashtag": "해시태그 편집",
   "title.edit json": "JSON 편집",
+  "title.lookup scenario": "시나리오 선택",
   "title.open data sample report page": "데이타 샘플 레포트 페이지 열기",
   "title.open data sample search page": "데이타 샘플 검색 페이지 열기",
   "title.open data sample view": "데이타 샘플 뷰페이지 열기",

package/translations/ms.json

@@ -27,6 +27,8 @@
   "field.data-sample": "sampel data",
   "field.data-set": "set data",
   "field.date": "tarikh",
+  "field.decoder": "Pengekod",
+  "field.decoder-scenario": "Skenario Pengekod",
   "field.device-id": "id peranti",
   "field.download-url": "url muat turun",
   "field.entry-role": "peranan masukan",
@@ -85,6 +87,7 @@
   "label.corrective action": "tindakan pembetulan",
   "label.corrective instruction": "instruksi pembetulan",
   "label.critical-limits": "had kritikal",
+  "label.data-set": "set data",
   "label.data-set-type": "jenis",
   "label.datasample review timeline": "garis masa ulasan sampel data",
   "label.end-date": "tarikh tamat",
@@ -99,11 +102,13 @@
   "label.period-this-month": "bulan ini",
   "label.period-this-year": "tahun ini",
   "label.period-today": "hari ini",
+  "label.raw-data": "data mentah",
   "label.start-date": "tarikh mula",
   "label.state-corrected": "diperbetulkan",
   "label.state-issued": "dikeluarkan",
   "label.state-reviewed": "disemak",
   "label.target-limits": "had sasaran",
+  "label.timestamp": "Cap waktu",
   "text.automatically collected": "dikumpulkan secara automatik",
   "text.corrective action placeholder": "Sila masukkan butiran pelaksanaan tindakan pembetulan dan pencegahan",
   "text.corrective instruction placeholder": "Sila masukkan arahan tindakan pembetulan dan pencegahan",
@@ -145,6 +150,7 @@
   "title.edit duration": "edit tempoh",
   "title.edit hashtag": "edit hashtag",
   "title.edit json": "edit json",
+  "title.lookup scenario": "skenario carian",
   "title.open data sample report page": "buka laman laporan sampel data",
   "title.open data sample search page": "buka laman pencarian sampel data",
   "title.open data sample view": "buka paparan sampel data",

package/translations/zh.json

@@ -27,6 +27,8 @@
   "field.data-sample": "数据样本",
   "field.data-set": "数据集",
   "field.date": "日期",
+  "field.decoder": "解码器",
+  "field.decoder-scenario": "解码器场景",
   "field.device-id": "设备ID",
   "field.download-url": "下载地址",
   "field.entry-role": "输入负责角色",
@@ -85,6 +87,7 @@
   "label.corrective action": "纠正措施",
   "label.corrective instruction": "纠正指示",
   "label.critical-limits": "临界限制",
+  "label.data-set": "数据集",
   "label.data-set-type": "类型",
   "label.datasample review timeline": "数据样本审查时间线",
   "label.end-date": "结束日期",
@@ -99,11 +102,13 @@
   "label.period-this-month": "本月",
   "label.period-this-year": "今年",
   "label.period-today": "今天",
+  "label.raw-data": "原始数据",
   "label.start-date": "开始日期",
   "label.state-corrected": "已处理",
   "label.state-issued": "发生",
   "label.state-reviewed": "审核完成",
   "label.target-limits": "管理目标范围",
+  "label.timestamp": "时间戳",
   "text.automatically collected": "自动收集",
   "text.corrective action placeholder": "请输入实施纠正和预防措施的事项",
   "text.corrective instruction placeholder": "请输入纠正和预防措施的指示事项",
@@ -144,6 +149,7 @@
   "title.edit duration": "周期编辑",
   "title.edit hashtag": "哈希标签编辑",
   "title.edit json": "JSON编辑",
+  "title.lookup scenario": "查找场景",
   "title.open data sample report page": "打开数据样本报告页面",
   "title.open data sample search page": "打开数据样本搜索页面",
   "title.open data sample view": "打开数据样本视图页面",