@things-factory/dataset 6.0.25 → 6.0.28

package/helps/dataset/data-ooc.md

@@ -1,10 +1,11 @@
 # DataOOC
-데이타 이탈 내역을 조회하고 조치합니다. 
+
+데이타 이탈 내역을 조회하고 조치합니다.
 
 - 데이타 이탈점 상세: 데이타 이탈점 상세 팝업 화면을 띄웁니다.
-    - 데이타 셋 아이템 별 CCP, QC 이탈 여부를 조회합니다.
-    - 데이타 이탈점 생성 부터 조치 이력을 조회합니다.
-    - 조치, 조치완료 내용을 입력하고 저장합니다.
+  - 데이타 셋 아이템 별 CCP, QC 이탈 여부를 조회합니다.
+  - 데이타 이탈점 생성 부터 조치 이력을 조회합니다.
+  - 조치, 조치완료 내용을 입력하고 저장합니다.
 - 상태: 생성, 조치, 조치완료 상태를 보여줍니다.
 - 조치 활동: 조치 내용을 보여줍니다.
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@things-factory/dataset",
-  "version": "6.0.25",
+  "version": "6.0.28",
   "main": "dist-server/index.js",
-  "browser": "client/index.js",
+  "browser": "dist-client/index.js",
   "things-factory": true,
   "author": "heartyoh <heartyoh@hatiolab.com>",
   "description": "module for handling data collection",
@@ -16,10 +16,12 @@
     "directory": "packages/dataset"
   },
   "scripts": {
-    "build": "tsc --p tsconfig.json",
-    "build:server": "npm run clean:server && tsc",
-    "clean:server": "rm -rf dist-server",
-    "clean": "npm run clean:server",
+    "build": "npm run build:server && npm run build:client",
+    "build:client": "npx tsc --p ./client/tsconfig.json",
+    "build:server": "npx tsc --p ./server/tsconfig.json",
+    "clean:client": "npx rimraf dist-client",
+    "clean:server": "npx rimraf dist-server",
+    "clean": "npm run clean:server && npm run clean:client",
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
   },
   "dependencies": {
@@ -33,14 +35,17 @@
     "@operato/shell": "^1.0.1",
     "@operato/styles": "^1.0.0",
     "@operato/utils": "^1.0.1",
-    "@things-factory/auth-base": "^6.0.25",
-    "@things-factory/aws-base": "^6.0.25",
-    "@things-factory/board-service": "^6.0.25",
+    "@things-factory/auth-base": "^6.0.28",
+    "@things-factory/aws-base": "^6.0.28",
+    "@things-factory/board-service": "^6.0.28",
     "@things-factory/env": "^6.0.7",
-    "@things-factory/shell": "^6.0.25",
-    "@things-factory/work-shift": "^6.0.25",
+    "@things-factory/organization": "^6.0.28",
+    "@things-factory/scheduler-client": "^6.0.28",
+    "@things-factory/shell": "^6.0.28",
+    "@things-factory/work-shift": "^6.0.28",
+    "@things-factory/worklist": "^6.0.28",
     "cron-parser": "^4.3.0",
     "moment-timezone": "^0.5.40"
   },
-  "gitHead": "8a987a42de944dc915b8cfddb047eb7bc0d4ba41"
+  "gitHead": "8b4e03229444e38fc3f3487227a96837eef85099"
 }

package/server/controllers/activity-template/activity-data-collect.ts

@@ -0,0 +1,84 @@
+import { Activity, ActivityInstance, ActivityInstanceStatus } from '@things-factory/worklist'
+import { NewDataSample } from 'service/data-sample/data-sample-type'
+import { createDataSample } from '../../controllers/create-data-sample'
+
+async function callback(activityInstance: ActivityInstance, context: ResolverContext) {
+  const { domain, tx } = context.state
+  const { input, output, state } = activityInstance
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'Collect Data'
+    })) as Activity
+
+    /* collect-data 액티비티는 한명의 assignee(thread)만 수행하도록 한다. 따라서, output 중에서 샘플 한개만을 data로 취한다. */
+    const assignees = Object.keys(output)
+    const data = assignees.length > 0 && output[assignees[0]]
+
+    if (activity) {
+      const dataSample: NewDataSample = {
+        dataSet: {
+          id: input.dataSetId
+        },
+        data
+      }
+
+      await createDataSample(dataSample, context)
+    } else {
+      console.error('Collect Data Activity not installed.')
+    }
+  }
+}
+
+export const ActivityDataCollect = {
+  name: 'Collect Data',
+  description: 'Tasks assigned for data collection',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'quality',
+  activityType: 'user',
+  searchKeys: [
+    {
+      name: 'dataSetName',
+      description: 'DataSet name',
+      inputKey: 'dataSetName',
+      tKey: 'data-set-name'
+    }
+  ],
+  startable: true,
+  model: [
+    {
+      name: 'dataSetId',
+      description: 'DataSet Id.',
+      tag: 'dataSetId',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'dataSetName',
+      description: 'DataSet name',
+      tag: 'dataSetName',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    }
+  ],
+  uiType: 'custom-element',
+  uiSource: 'data-collect-activity-view',
+  reportType: 'page',
+  reportSource: 'data-collect-activity-view',
+  thumbnail: '/assets/images/data-collect.png',
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

package/server/controllers/activity-template/activity-ooc-resolve.ts

@@ -0,0 +1,114 @@
+import {
+  ActivityInstance,
+  ActivityInstanceStatus,
+  ActivityThread,
+  ActivityThreadStatus
+} from '@things-factory/worklist'
+import { DataOoc, DataOocStatus } from '../../service/data-ooc/data-ooc'
+
+async function callback(activityInstance: ActivityInstance, context: ResolverContext) {
+  const { tx, user, domain } = context.state
+  const { id, input, output, state, terminatedAt } = activityInstance
+
+  /* Resolve Activity가 완료되면, 해당 data-ooc 엔티티의 correctiveAction, correctorId, correctedAt 을 update한다. */
+  if (state == ActivityInstanceStatus.Ended) {
+    const activityThreads = await tx.getRepository(ActivityThread).find({
+      where: {
+        domain: { id: domain.id },
+        activityInstance: { id },
+        state: ActivityThreadStatus.Ended
+      },
+      relations: ['assignee']
+    })
+
+    const corrector = activityThreads[0]?.assignee
+
+    const { dataOocId } = input
+    const correctiveAction = Object.values(output)
+      .map((o: any) => o.action)
+      .join('\n')
+
+    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,
+      correctedAt: terminatedAt,
+      corrector: corrector,
+      correctiveAction,
+      updater: user,
+      state: DataOocStatus.CORRECTED
+    })
+  }
+}
+
+export const ActivityOocResolve = {
+  name: 'OOC Resolve',
+  description: 'Task to take remedial action based on Out Of Control data',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'quality',
+  activityType: 'user',
+  searchKeys: [
+    {
+      name: 'dataOocId',
+      description: 'OOC Id.',
+      inputKey: 'dataOocId',
+      tKey: 'data-ooc-id'
+    }
+  ],
+  startable: true,
+  model: [
+    {
+      name: 'dataOocId',
+      description: 'OOC id',
+      tag: 'dataOocId',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'instruction',
+      description: 'Instructions for resolving OOC',
+      tag: 'instruction',
+      hidden: false,
+      mandatory: true,
+      inout: 'in',
+      type: 'textarea',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'action',
+      description: 'Action Description',
+      tag: 'action',
+      hidden: false,
+      mandatory: true,
+      inout: 'out',
+      type: 'textarea',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    }
+  ],
+  uiType: 'custom-element',
+  uiSource: 'ooc-resolve-activity-view',
+  reportType: 'page',
+  reportSource: 'data-ooc-report-page',
+  thumbnail: '/assets/images/ooc.png',
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

package/server/controllers/activity-template/activity-ooc-review.ts

@@ -0,0 +1,118 @@
+import { Activity, ActivityInstance, ActivityInstanceStatus } from '@things-factory/worklist'
+import { post } from '@things-factory/worklist/dist-server/controllers/activity-instance/post'
+import { DataOoc, DataOocStatus } from '../../service/data-ooc/data-ooc'
+
+async function callback(activityInstance: ActivityInstance, context: ResolverContext) {
+  const { domain, user, tx } = context.state
+  const { input, output, state, terminatedAt } = activityInstance
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'OOC Resolve'
+    })) as Activity
+
+    if (activity) {
+      const { dataOocId } = input
+      const correctiveInstruction = Object.values(output)
+        .map((o: any) => o.instruction)
+        .join('\n')
+
+      var dataOoc = await tx.getRepository(DataOoc).findOne({
+        where: {
+          domain: { id: domain.id },
+          id: dataOocId
+        },
+        relations: ['dataSet']
+      })
+
+      const dataSet = dataOoc.dataSet
+      const { assignees, approvalLine } = dataSet
+
+      /* dataOoc Review 결과를 dataOoc 엔티티에 반영한다. */
+      dataOoc = await tx.getRepository(DataOoc).save({
+        ...dataOoc,
+        reviewedAt: terminatedAt,
+        reviewer: user,
+        correctiveInstruction,
+        state: DataOocStatus.REVIEWED
+      })
+
+      /* 해당 dataset의 작업 담당자(assignees)에게 OOC 해결을 위한 태스크를 지시한다. */
+      if (assignees && assignees instanceof Array && assignees.length > 0) {
+        const activityInstance = {
+          name: `[OOC 조치] ${dataSet.name}`,
+          activityId: activity.id,
+          description: `Data OOC occurred on '${dataSet.name}'`,
+          dueAt: new Date(terminatedAt.getTime() + 24 * 60 * 60 * 1000),
+          input: {
+            dataOocId,
+            instruction: correctiveInstruction
+          },
+          assignees,
+          approvalLine
+        }
+
+        await post(activityInstance, context)
+      } else {
+        console.error(
+          `Assignees are not set. So, Data OOC Resolve task for ${dataOoc.name}(${dataOoc.id}) could not be posted.`
+        )
+      }
+    } else {
+      console.error('OOC Resolve Activity not installed.')
+    }
+  }
+}
+
+export const ActivityOocReview = {
+  name: 'OOC Review',
+  description: 'Task to take remedial action based on Out Of Control data',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'quality',
+  activityType: 'user',
+  searchKeys: [
+    {
+      name: 'dataOocId',
+      description: 'OOC Id.',
+      inputKey: 'dataOocId',
+      tKey: 'data-ooc-id'
+    }
+  ],
+  startable: true,
+  model: [
+    {
+      name: 'dataOocId',
+      description: 'OOC id',
+      tag: 'dataOocId',
+      hidden: true,
+      mandatory: true,
+      inout: 'in',
+      type: 'string',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    },
+    {
+      name: 'Instruction',
+      description: 'Instructions for preventing OOC',
+      tag: 'instruction',
+      hidden: false,
+      mandatory: true,
+      inout: 'out',
+      type: 'textarea',
+      options: {},
+      unit: null,
+      quantifier: [1],
+      spec: {}
+    }
+  ],
+  uiType: 'custom-element',
+  uiSource: 'ooc-review-activity-view',
+  reportType: 'page',
+  reportSource: 'data-ooc-report-page',
+  thumbnail: '/assets/images/ooc.png',
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

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

@@ -1,8 +1,8 @@
 import moment from 'moment-timezone'
-import { EntityManager } from 'typeorm'
 
-import { User } from '@things-factory/auth-base'
-import { Domain, getRedirectSubdomainPath, pubsub } from '@things-factory/shell'
+import { Role } from '@things-factory/auth-base'
+import { getRedirectSubdomainPath, pubsub } from '@things-factory/shell'
+import { logger } from '@things-factory/env'
 import { getWorkDateAndShift } from '@things-factory/work-shift'
 
 import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
@@ -10,6 +10,9 @@ 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 { DataUseCase } from './data-use-case'
+import { Activity } from '@things-factory/worklist'
+
+import { post } from '@things-factory/worklist/dist-server/controllers/activity-instance/post'
 
 // See README.md at ## Data Samples
 process.env.TZ = 'UTC'
@@ -50,10 +53,7 @@ const formatDate = (keys, _moment) => {
   return keys
 }
 
-export async function createDataSample(
-  dataSample: NewDataSample,
-  context: { state: { domain: Domain; user: User; tx: EntityManager } }
-): Promise<DataSample> {
+export async function createDataSample(dataSample: NewDataSample, context: ResolverContext): Promise<DataSample> {
   const { domain, user, tx } = context.state
 
   const dataSet = await tx.getRepository(DataSet).findOne({
@@ -122,27 +122,67 @@ export async function createDataSample(
             name: user.name
           },
           state: DataOocStatus.CREATED,
-          timestamp: Date.now()
+          timestamp: collectedAt
         }
       ],
       state: DataOocStatus.CREATED
     })
 
-    pubsub.publish('data-ooc', {
-      dataOoc,
-      supervisoryRoleId: dataSet.supervisoryRoleId
-    })
+    const activity = (await tx.getRepository(Activity).findOneBy({
+      domain: { id: domain.id },
+      name: 'OOC Review'
+    })) as Activity
+
+    if (activity) {
+      const assignee =
+        dataSet.supervisoryRoleId &&
+        (await tx.getRepository(Role).findOneBy({ domain: { id: domain.id }, id: dataSet.supervisoryRoleId }))
+
+      const assignees = dataSet.supervisoryRoleId ? [{ type: 'Role', value: dataSet.supervisoryRoleId, assignee }] : []
+
+      /* 해당 dataset의 supervisor로 하여금, OOC를 리뷰하고 instruction을 작성해서, OOC 해결을 위한 태스크를 dataset assignees에게 지시하도록 한다. */
+      if (assignees && assignees instanceof Array && assignees.length > 0) {
+        const activityInstance = {
+          name: `[OOC 검토] ${dataSet.name}`,
+          activityId: activity.id,
+          description: `Data OOC occurred on '${dataSet.name}'`,
+          dueAt: new Date(collectedAt.getTime() + 24 * 60 * 60 * 1000),
+          input: {
+            dataOocId: dataOoc.id
+          },
+          assignees,
+          approvalLine: []
+        }
 
-    pubsub.publish('notification', {
-      notification: {
-        domain,
-        type: 'error',
-        title: `Data OOC occurred on '${dataSet.name}'`,
-        body: `Data OOC occurred on '${dataSet.name}'`,
-        url: getRedirectSubdomainPath(context, domain.subdomain, `/data-ooc/${dataOoc.id}`),
-        timestamp: collectedAt
+        await post(activityInstance, context)
+      } else {
+        console.error(
+          `Assignees are not set. So Data OOC Review task for ${dataOoc.name}(${dataOoc.id}) could not be posted.`
+        )
       }
-    })
+    } else {
+      console.error('OOC Review Activity not installed.')
+    }
+
+    try {
+      pubsub.publish('data-ooc', {
+        dataOoc,
+        supervisoryRoleId: dataSet.supervisoryRoleId
+      })
+
+      pubsub.publish('notification', {
+        notification: {
+          domain,
+          type: 'error',
+          title: `[OOC] ${dataSet.name}`,
+          body: `Data OOC occurred on '${dataSet.name}'`,
+          url: getRedirectSubdomainPath(context, domain.subdomain, `/data-ooc/${dataOoc.id}`),
+          timestamp: collectedAt
+        }
+      })
+    } catch (err) {
+      logger.error('Notification', err)
+    }
   }
 
   return result

package/server/controllers/data-use-case.ts

@@ -55,7 +55,7 @@ export abstract class DataUseCase {
         continue
       }
 
-      let values: any | any[] = data[tag]
+      let values: any | any[] = data && data[tag]
       if (values == null) {
         continue // TODO what if in case no value ?
       }

package/server/controllers/index.ts

@@ -1,2 +1,13 @@
+import { ActivityInstallations } from '@things-factory/worklist'
+
+import { ActivityOocReview } from './activity-template/activity-ooc-review'
+import { ActivityOocResolve } from './activity-template/activity-ooc-resolve'
+import { ActivityDataCollect } from './activity-template/activity-data-collect'
+
+/* activity templates installation */
+;[ActivityOocReview, ActivityOocResolve, ActivityDataCollect].forEach(template => {
+  ActivityInstallations.installActivityTemplate(template)
+})
+
 export * from './create-data-sample'
 export * from './data-use-case'

package/server/index.ts

@@ -1,8 +1,7 @@
 import './routes'
+// import './controllers'
 
 export * from './controllers'
-export * from './migrations'
-export * from './middlewares'
 export * from './service'
 
 export * from './service/data-spec/data-spec-manager'

package/server/routes.ts

@@ -1,11 +1,13 @@
-import { getConnection } from 'typeorm'
-
+import { Domain, getDataSource } from '@things-factory/shell'
 import { User } from '@things-factory/auth-base'
+import { Activity } from '@things-factory/worklist'
+import { post } from '@things-factory/worklist/dist-server/controllers/activity-instance/post'
 
 import { createDataSample } from './controllers/create-data-sample'
 import { renderJasperReport } from './controllers/jasper-report'
 import { renderShinyReport } from './controllers/shiny-report'
 import { DataSensor } from './service/data-sensor/data-sensor'
+import { DataSet } from './service/data-set/data-set'
 
 process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
   /*
@@ -23,7 +25,7 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
     }
 
     // make new data-sample
-    await getConnection().transaction(async tx => {
+    await getDataSource().transaction(async tx => {
       // find sensor through deviceId
       const sensor = await tx.getRepository(DataSensor).findOne({
         where: { deviceId },
@@ -55,6 +57,12 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
         }
       })
 
+      context.state = {
+        ...context.state,
+        domain,
+        tx
+      }
+
       return await createDataSample(
         {
           dataSet,
@@ -63,12 +71,62 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
           source: deviceId,
           collectedAt: new Date(timestamp)
         },
-        { state: { domain, user, tx } }
+        context
       )
     })
 
     context.status = 200
   })
+
+  /* When a callback occurs from the scheduler when a scheduled dataset is on schedule, data collection task for the dataset should be issued. */
+  globalPublicRouter.post('/callback-schedule-for-dataset', async (context, next) => {
+    const { domainId, dataSetId } = context.request.body
+
+    getDataSource().transaction(async tx => {
+      const domain = await tx.getRepository(Domain).findOneBy({ id: domainId })
+      const dataSet = await tx.getRepository(DataSet).findOne({ where: { domain: { id: domainId }, 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}`,
+            activityId: activity.id,
+            description: `Data Collect for '${dataSet.name}'`,
+            dueAt: new Date(Date.now() + 24 * 60 * 60 * 1000),
+            input: {
+              dataSetId: dataSet.id,
+              dataSetName: dataSet.name
+            },
+            assignees
+          }
+
+          context.state = {
+            ...context.state,
+            domain,
+            tx
+          }
+
+          await post(activityInstance, context)
+        } else {
+          console.error(
+            `Assignees not set. So Data Collec Activity for ${dataSet.name}($dataSet.id) could not be posted.`
+          )
+        }
+      } else {
+        console.error(`Data Collec Activity is not installed.`)
+      }
+    })
+
+    context.status = 200
+  })
 })
 
 process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {
@@ -99,5 +157,4 @@ process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRo
     let { reportType } = context.params
     context.body = `${reportType} Not Implemented.`
   })
-  
 })

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

@@ -56,6 +56,16 @@ export class DataOocQuery {
     })
   }
 
+  @FieldResolver(type => User)
+  async corrector(@Root() dataOoc: DataOoc): Promise<User> {
+    return dataOoc.correctorId && (await getRepository(User).findOneBy({ id: dataOoc.correctorId }))
+  }
+
+  @FieldResolver(type => User)
+  async reviewer(@Root() dataOoc: DataOoc): Promise<User> {
+    return dataOoc.reviewerId && (await getRepository(User).findOneBy({ id: dataOoc.reviewerId }))
+  }
+
   @FieldResolver(type => Domain)
   async domain(@Root() dataOoc: DataOoc): Promise<Domain> {
     return await getRepository(Domain).findOneBy({ id: dataOoc.domainId })
@@ -63,11 +73,11 @@ export class DataOocQuery {
 
   @FieldResolver(type => User)
   async updater(@Root() dataOoc: DataOoc): Promise<User> {
-    return await getRepository(User).findOneBy({ id: dataOoc.updaterId })
+    return dataOoc.updaterId && (await getRepository(User).findOneBy({ id: dataOoc.updaterId }))
   }
 
   @FieldResolver(type => User)
   async creator(@Root() dataOoc: DataOoc): Promise<User> {
-    return await getRepository(User).findOneBy({ id: dataOoc.creatorId })
+    return dataOoc.creatorId && (await getRepository(User).findOneBy({ id: dataOoc.creatorId }))
   }
 }