@things-factory/dataset 8.0.0 → 8.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/dataset",
-  "version": "8.0.0",
+  "version": "8.0.3",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -40,21 +40,21 @@
     "@operato/shell": "^8.0.0",
     "@operato/styles": "^8.0.0",
     "@operato/utils": "^8.0.0",
-    "@things-factory/auth-base": "^8.0.0",
-    "@things-factory/aws-base": "^8.0.0",
-    "@things-factory/board-service": "^8.0.0",
-    "@things-factory/env": "^8.0.0",
-    "@things-factory/integration-base": "^8.0.0",
-    "@things-factory/organization": "^8.0.0",
-    "@things-factory/personalization": "^8.0.0",
-    "@things-factory/scheduler-client": "^8.0.0",
-    "@things-factory/shell": "^8.0.0",
-    "@things-factory/work-shift": "^8.0.0",
-    "@things-factory/worklist": "^8.0.0",
+    "@things-factory/auth-base": "^8.0.2",
+    "@things-factory/aws-base": "^8.0.2",
+    "@things-factory/board-service": "^8.0.3",
+    "@things-factory/env": "^8.0.2",
+    "@things-factory/integration-base": "^8.0.3",
+    "@things-factory/organization": "^8.0.2",
+    "@things-factory/personalization": "^8.0.2",
+    "@things-factory/scheduler-client": "^8.0.2",
+    "@things-factory/shell": "^8.0.2",
+    "@things-factory/work-shift": "^8.0.2",
+    "@things-factory/worklist": "^8.0.3",
     "cron-parser": "^4.3.0",
     "moment-timezone": "^0.5.45",
     "simple-statistics": "^7.8.3",
     "statistics": "^3.3.0"
   },
-  "gitHead": "07ef27d272dd9a067a9648ac7013748510556a18"
+  "gitHead": "a040c124aa33e9bb8a691e00e0afbded1f378b62"
 }

package/server/activities/activity-data-review.ts

@@ -1,26 +1,53 @@
 import { ActivityInstance, ActivityInstanceStatus, UpdateActivityInstanceStateAddendum } from '@things-factory/worklist'
 
-import { DataOocStatus } from '../service/data-ooc/data-ooc'
+import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
 import { DataSample } from '../service/data-sample/data-sample'
+import { createDataOoc } from '../controllers/create-data-ooc'
+import { issueOocResolve } from '../controllers/issue-ooc-resolve'
 
 async function callback(
   activityInstance: ActivityInstance,
   addendum: UpdateActivityInstanceStateAddendum,
   context: ResolverContext
 ) {
-  const { domain, tx, user } = context.state
+  const { domain, tx } = context.state
   const { input, output, state } = activityInstance
 
   if (state == ActivityInstanceStatus.Ended) {
-    var dataSample = await tx.getRepository(DataSample).findOne({
-      where: { domain: { id: domain.id }, id: input?.dataSample?.id }
+    const { dataSampleId } = input || {}
+
+    if (!dataSampleId) {
+      throw new Error('Data sample ID is missing in the input.')
+    }
+
+    const dataSample = await tx.getRepository(DataSample).findOne({
+      where: { domain: { id: domain.id }, id: dataSampleId },
+      relations: ['domain', 'dataSet', 'creator', 'updater']
     })
 
-    dataSample = await tx.getRepository(DataSample).save({
+    await tx.getRepository(DataSample).save({
       ...dataSample,
       output,
       state: DataOocStatus.REVIEWED
     })
+
+    const { judgment, instruction } = output
+
+    if (judgment == 'abnormal') {
+      /* Review 결과가 Ooc 조치가 필요하다고 하면, DataOoc를 생성하고, DataOocResolve를 이슈한다. */
+      var ooc = await createDataOoc(dataSample, dataSample.dataSet, context)
+
+      ooc = await tx.getRepository(DataOoc).save({
+        ...ooc,
+        reviewedAt: activityInstance.terminatedAt,
+        reviewer: activityInstance.updater,
+        correctiveInstruction: instruction,
+        reviewActivityInstance: activityInstance,
+        state: DataOocStatus.REVIEWED
+      })
+
+      await issueOocResolve(ooc, dataSample.dataSet, instruction, context)
+    }
   }
 }
 

package/server/activities/activity-ooc-review.ts

@@ -1,14 +1,7 @@
-import { In } from 'typeorm'
-import {
-  Activity,
-  ActivityInstance,
-  ActivityInstanceStatus,
-  UpdateActivityInstanceStateAddendum
-} from '@things-factory/worklist'
-import { issue } from '@things-factory/worklist/dist-server/controllers/activity-instance/issue'
-import { Role } from '@things-factory/auth-base'
+import { ActivityInstance, ActivityInstanceStatus, UpdateActivityInstanceStateAddendum } from '@things-factory/worklist'
 
 import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
+import { issueOocResolve } from '../controllers/issue-ooc-resolve'
 
 async function callback(
   activityInstance: ActivityInstance,
@@ -20,69 +13,27 @@ async function callback(
   const { causedBy } = addendum || {}
 
   if (state == ActivityInstanceStatus.Ended) {
-    const activity = (await tx.getRepository(Activity).findOneBy({
-      domain: domain.parentId ? In([domain.id, domain.parentId]) : { id: domain.id },
-      name: 'OOC Resolve'
-    })) as Activity
+    const { dataOocId } = input
+    const correctiveInstruction = output?.instruction
 
-    if (activity) {
-      const { dataOocId } = input
-      const correctiveInstruction = output?.instruction
+    var dataOoc = await tx.getRepository(DataOoc).findOne({
+      where: {
+        domain: { id: domain.id },
+        id: dataOocId
+      },
+      relations: ['dataSet']
+    })
 
-      var dataOoc = await tx.getRepository(DataOoc).findOne({
-        where: {
-          domain: { id: domain.id },
-          id: dataOocId
-        },
-        relations: ['dataSet']
-      })
+    /* dataOoc Review 결과를 dataOoc 엔티티에 반영한다. */
+    dataOoc = await tx.getRepository(DataOoc).save({
+      ...dataOoc,
+      reviewedAt: terminatedAt,
+      reviewer: user,
+      correctiveInstruction,
+      state: DataOocStatus.REVIEWED
+    })
 
-      const dataSet = dataOoc.dataSet
-      const { resolverRoleId, outlierApprovalLine } = dataSet
-
-      /* dataOoc Review 결과를 dataOoc 엔티티에 반영한다. */
-      dataOoc = await tx.getRepository(DataOoc).save({
-        ...dataOoc,
-        reviewedAt: terminatedAt,
-        reviewer: user,
-        correctiveInstruction,
-        state: DataOocStatus.REVIEWED
-      })
-
-      const assigneeRole =
-        resolverRoleId &&
-        (await tx.getRepository(Role).findOneBy({
-          domain: { id: In([domain.id, domain.parentId].filter(Boolean)) },
-          id: resolverRoleId
-        }))
-
-      /* 해당 dataset의 작업 담당자(resolverRole)에게 OOC 해결을 위한 태스크를 지시한다. */
-      if (assigneeRole) {
-        const activityInstance = {
-          name: `[OOC 조치] ${dataSet.name}`,
-          description: dataSet.description,
-          activityId: activity.id,
-          dueAt: new Date(terminatedAt.getTime() + (activity.standardTime || 24 * 60 * 60) * 1000),
-          input: {
-            dataOocId,
-            instruction: correctiveInstruction
-          },
-          assigneeRole,
-          threadsMin: 1,
-          threadsMax: 1,
-          approvalLine: outlierApprovalLine
-        }
-
-        dataOoc.resolveActivityInstance = await issue(activityInstance, context)
-        await tx.getRepository(DataOoc).save(dataOoc)
-      } else {
-        console.error(
-          `Assignees are not set. So, Data OOC Resolve task for ${dataOoc.name}(${dataOoc.id}) could not be issued.`
-        )
-      }
-    } else {
-      console.error('OOC Resolve Activity not installed.')
-    }
+    await issueOocResolve(dataOoc, dataOoc.dataSet, correctiveInstruction, context)
   }
 }
 

package/server/controllers/create-data-ooc.ts

@@ -0,0 +1,80 @@
+import { In } from 'typeorm'
+
+import { Scenario } from '@things-factory/integration-base'
+
+import { DataSet } from '../service/data-set/data-set'
+import { DataSample } from '../service/data-sample/data-sample'
+import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
+
+export async function createDataOoc(
+  dataSample: DataSample,
+  dataSet: DataSet,
+  context: ResolverContext
+): Promise<DataOoc> {
+  const { domain, user, tx } = context.state
+  const { collectedAt, data, ooc, oos, judgment, workDate, workShift } = dataSample
+
+  const dataOoc = await tx.getRepository(DataOoc).save({
+    ...dataSample,
+    history: [
+      {
+        user: {
+          id: user?.id,
+          // @ts-ignore
+          username: user?.username || user?.email,
+          name: user?.name
+        },
+        state: DataOocStatus.ISSUED,
+        timestamp: collectedAt
+      }
+    ],
+    state: DataOocStatus.ISSUED,
+    dataSample: dataSample
+  })
+
+  if (dataSet.outlierScenarioId) {
+    const scenario = await tx.getRepository(Scenario).findOne({
+      where: {
+        domain: domain.parentId ? { id: In([domain.id, domain.parentId]) } : { id: domain.id },
+        id: dataSet.outlierScenarioId
+      },
+      relations: ['domain', 'steps', 'updater']
+    })
+
+    if (scenario) {
+      scenario.start({
+        instanceName: scenario.name + ':' + dataSet.name + ':' + dataSample.id,
+        domain,
+        user,
+        variables: {
+          dataOocId: dataOoc.id,
+          dataSampleId: dataSample.id,
+          dataSet: dataSet.id,
+          data,
+          ooc,
+          oos,
+          judgment,
+          collectedAt,
+          workDate,
+          workShift,
+          domain: {
+            id: domain.id,
+            subdomain: domain.subdomain,
+            name: domain.name
+          },
+          updator: {
+            id: user.id,
+            // @ts-ignore
+            username: user.username || user.email,
+            email: user.email,
+            name: user.name
+          }
+        }
+      })
+    } else {
+      console.error(`Cannot find the set outlier-scenario for the dataset(${dataSet.name}).`)
+    }
+  }
+
+  return dataOoc
+}

package/server/controllers/create-data-sample.ts

@@ -10,10 +10,11 @@ import { Scenario, publishData } from '@things-factory/integration-base'
 import { Activity } from '@things-factory/worklist'
 import { issue } from '@things-factory/worklist/dist-server/controllers/activity-instance/issue'
 
-import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
 import { DataSample } from '../service/data-sample/data-sample'
 import { NewDataSample } from '../service/data-sample/data-sample-type'
 import { DataSet } from '../service/data-set/data-set'
+import { createDataOoc } from './create-data-ooc'
+import { issueOocReview } from './issue-ooc-review'
 import { DataUseCase } from './data-use-case'
 
 // See README.md at ## Data Samples
@@ -196,114 +197,10 @@ export async function createDataSample(newDataSample: NewDataSample, context: Re
   }
 
   if (ooc || oos) {
-    const dataOoc = await tx.getRepository(DataOoc).save({
-      ...dataSample,
-      history: [
-        {
-          user: {
-            id: user?.id,
-            name: user?.name
-          },
-          state: DataOocStatus.ISSUED,
-          timestamp: collectedAt
-        }
-      ],
-      state: DataOocStatus.ISSUED,
-      dataSample: dataSample
-    })
-
-    if (outlierScenarioId) {
-      const scenario = await tx.getRepository(Scenario).findOne({
-        where: {
-          domain: domain.parentId ? { id: In([domain.id, domain.parentId]) } : { id: domain.id },
-          id: outlierScenarioId
-        },
-        relations: ['domain', 'steps', 'updater']
-      })
-
-      if (scenario) {
-        scenario.start({
-          instanceName: scenario.name + ':' + dataSet.name + ':' + dataSample.id,
-          domain,
-          user,
-          variables: {
-            dataOocId: dataOoc.id,
-            dataSampleId: dataSample.id,
-            dataSet: dataSet.id,
-            data,
-            ooc,
-            oos,
-            judgment,
-            collectedAt,
-            workDate,
-            workShift,
-            domain: {
-              id: domain.id,
-              subdomain: domain.subdomain,
-              name: domain.name
-            },
-            updator: {
-              id: user.id,
-              email: user.email,
-              name: user.name
-            }
-          }
-        })
-      } else {
-        console.error(`Cannot find the set outlier-scenario for the dataset(${dataSet.name}).`)
-      }
-    }
-
-    const activity = (await tx.getRepository(Activity).findOneBy({
-      domain: domain.parentId ? { id: In([domain.id, domain.parentId]) } : { id: domain.id },
-      name: 'OOC Review'
-    })) as Activity
-
-    if (activity) {
-      const assigneeRole =
-        dataSet.supervisoryRoleId &&
-        (await tx.getRepository(Role).findOneBy({
-          domain: { id: In([domain.id, domain.parentId].filter(Boolean)) },
-          id: dataSet.supervisoryRoleId
-        }))
-
-      // const assignees = dataSet.supervisoryRoleId
-      //   ? [{ type: 'Role', value: dataSet.supervisoryRoleId, assigneeRole }]
-      //   : []
-
-      /* 해당 dataset의 supervisor로 하여금, OOC를 리뷰하고 instruction을 작성해서, OOC 해결을 위한 태스크를 dataset assignees에게 지시하도록 한다. */
-      if (assigneeRole) {
-        const activityInstance = {
-          name: `[OOC 검토] ${dataSet.name}`,
-          description: dataSet.description,
-          activityId: activity.id,
-          dueAt: new Date(collectedAt.getTime() + (activity.standardTime || 24 * 60 * 60) * 1000),
-          input: {
-            dataOocId: dataOoc.id
-          },
-          assigneeRole,
-          threadsMin: 1,
-          threadsMax: 1,
-          approvalLine: []
-        }
-
-        dataOoc.reviewActivityInstance = await issue(activityInstance as any, context)
-        await tx.getRepository(DataOoc).save(dataOoc)
-      } else {
-        console.error(
-          `Assignees are not set. So Data OOC Review task for ${dataOoc.name}(${dataOoc.id}) could not be issued.`
-        )
-      }
-    } else {
-      console.warn('OOC Review Activity not installed.')
-    }
+    const dataOoc = await createDataOoc(dataSample, dataSet, context)
+    await issueOocReview(dataOoc, dataSet, context)
 
     try {
-      // pubsub.publish('data-ooc', {
-      //   dataOoc,
-      //   supervisoryRoleId: dataSet.supervisoryRoleId
-      // })
-
       pubsub.publish('notification', {
         notification: {
           domain,

package/server/controllers/index.ts

@@ -1,3 +1,6 @@
 export * from './create-data-sample'
+export * from './create-data-ooc'
+export * from './issue-ooc-review'
+export * from './issue-ooc-resolve'
 export * from './data-use-case'
 export * from './query-data-summary-by-period'

package/server/controllers/issue-ooc-resolve.ts

@@ -0,0 +1,58 @@
+import { In } from 'typeorm'
+import { Activity } from '@things-factory/worklist'
+import { issue } from '@things-factory/worklist/dist-server/controllers/activity-instance/issue'
+import { Role } from '@things-factory/auth-base'
+
+import { DataOoc } from '../service/data-ooc/data-ooc'
+import { DataSet } from 'service'
+
+export async function issueOocResolve(
+  dataOoc: DataOoc,
+  dataSet: DataSet,
+  correctiveInstruction: string,
+  context: ResolverContext
+): Promise<void> {
+  const { domain, user, tx } = context.state
+  const { resolverRoleId, outlierApprovalLine } = dataSet
+
+  const activity = (await tx.getRepository(Activity).findOneBy({
+    domain: domain.parentId ? In([domain.id, domain.parentId]) : { id: domain.id },
+    name: 'OOC Resolve'
+  })) as Activity
+
+  if (activity) {
+    const assigneeRole =
+      resolverRoleId &&
+      (await tx.getRepository(Role).findOneBy({
+        domain: { id: In([domain.id, domain.parentId].filter(Boolean)) },
+        id: resolverRoleId
+      }))
+
+    /* 해당 dataset의 작업 담당자(resolverRole)에게 OOC 해결을 위한 태스크를 지시한다. */
+    if (assigneeRole) {
+      const activityInstance = {
+        name: `[OOC 조치] ${dataSet.name}`,
+        description: dataSet.description,
+        activityId: activity.id,
+        dueAt: new Date(Date.now() + (activity.standardTime || 24 * 60 * 60) * 1000),
+        input: {
+          dataOocId: dataOoc.id,
+          instruction: correctiveInstruction
+        },
+        assigneeRole,
+        threadsMin: 1,
+        threadsMax: 1,
+        approvalLine: outlierApprovalLine
+      }
+
+      dataOoc.resolveActivityInstance = await issue(activityInstance, context)
+      await tx.getRepository(DataOoc).save(dataOoc)
+    } else {
+      console.error(
+        `Assignees are not set. So, Data OOC Resolve task for ${dataOoc.name}(${dataOoc.id}) could not be issued.`
+      )
+    }
+  } else {
+    console.error('OOC Resolve Activity not installed.')
+  }
+}

package/server/controllers/issue-ooc-review.ts

@@ -0,0 +1,52 @@
+import { In } from 'typeorm'
+
+import { Role } from '@things-factory/auth-base'
+import { Activity } from '@things-factory/worklist'
+import { issue } from '@things-factory/worklist/dist-server/controllers/activity-instance/issue'
+
+import { DataSet } from '../service/data-set/data-set'
+import { DataOoc } from '../service/data-ooc/data-ooc'
+
+export async function issueOocReview(dataOoc: DataOoc, dataSet: DataSet, context: ResolverContext): Promise<void> {
+  const { domain, tx } = context.state
+  const { collectedAt } = dataOoc
+
+  const activity = (await tx.getRepository(Activity).findOneBy({
+    domain: domain.parentId ? { id: In([domain.id, domain.parentId]) } : { id: domain.id },
+    name: 'OOC Review'
+  })) as Activity
+
+  if (activity) {
+    const assigneeRole =
+      dataSet.supervisoryRoleId &&
+      (await tx.getRepository(Role).findOneBy({
+        domain: { id: In([domain.id, domain.parentId].filter(Boolean)) },
+        id: dataSet.supervisoryRoleId
+      }))
+
+    if (assigneeRole) {
+      const activityInstance = {
+        name: `[OOC 검토] ${dataSet.name}`,
+        description: dataSet.description,
+        activityId: activity.id,
+        dueAt: new Date(collectedAt.getTime() + (activity.standardTime || 24 * 60 * 60) * 1000),
+        input: {
+          dataOocId: dataOoc.id
+        },
+        assigneeRole,
+        threadsMin: 1,
+        threadsMax: 1,
+        approvalLine: []
+      }
+
+      dataOoc.reviewActivityInstance = await issue(activityInstance as any, context)
+      await tx.getRepository(DataOoc).save(dataOoc)
+    } else {
+      console.error(
+        `Assignees are not set. So Data OOC Review task for ${dataOoc.name}(${dataOoc.id}) could not be issued.`
+      )
+    }
+  } else {
+    console.warn('OOC Review Activity not installed.')
+  }
+}

package/translations/en.json

@@ -99,6 +99,9 @@
   "label.datasample review timeline": "data sample review timeline",
   "label.end-date": "end date",
   "label.group-by data-keys": "group by each data-keys",
+  "label.judgment": "judgment",
+  "label.judgment-abnormal": "action needed",
+  "label.judgment-normal": "normal",
   "label.maximum value": "maximum value",
   "label.minimum value": "minimum value",
   "label.ooc resolve timeline": "OOC resolve timeline",

package/translations/ja.json

@@ -99,6 +99,9 @@
   "label.datasample review timeline": "データサンプルレビュータイムライン",
   "label.end-date": "終了日",
   "label.group-by data-keys": "各データキーごとにグループ化",
+  "label.judgment": "判定",
+  "label.judgment-abnormal": "措置必要",
+  "label.judgment-normal": "正常",
   "label.maximum value": "最大値",
   "label.minimum value": "最小値",
   "label.ooc resolve timeline": "OOC 解決タイムライン",

package/translations/ko.json

@@ -99,6 +99,9 @@
   "label.datasample review timeline": "데이타샘플 리뷰 타임라인",
   "label.end-date": "종료일",
   "label.group-by data-keys": "각 데이터 키별로 그룹화",
+  "label.judgment": "판정",
+  "label.judgment-abnormal": "조치필요",
+  "label.judgment-normal": "정상",
   "label.maximum value": "최대값",
   "label.minimum value": "최소값",
   "label.ooc resolve timeline": "OOC 조치 타임라인",

package/translations/ms.json

@@ -99,6 +99,9 @@
   "label.datasample review timeline": "garis masa ulasan sampel data",
   "label.end-date": "tarikh tamat",
   "label.group-by data-keys": "kumpulkan mengikut setiap data-keys",
+  "label.judgment": "penilaian",
+  "label.judgment-abnormal": "memerlukan tindakan",
+  "label.judgment-normal": "normal",
   "label.maximum value": "nilai maksimum",
   "label.minimum value": "nilai minimum",
   "label.ooc resolve timeline": "garis masa penyelesaian OOC",

package/translations/zh.json

@@ -99,6 +99,9 @@
   "label.datasample review timeline": "数据样本审查时间线",
   "label.end-date": "结束日期",
   "label.group-by data-keys": "按每个数据键分组",
+  "label.judgment": "判定",
+  "label.judgment-abnormal": "需要措施",
+  "label.judgment-normal": "正常",
   "label.maximum value": "最大值",
   "label.minimum value": "最小值",
   "label.ooc resolve timeline": "OOC 解决时间线",