@things-factory/dataset 8.0.0-beta.9 → 8.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/dataset",
-  "version": "8.0.0-beta.9",
+  "version": "8.0.2",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -27,34 +27,34 @@
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create ./server/migrations/migration"
   },
   "dependencies": {
-    "@operato/app": "^8.0.0-beta",
-    "@operato/data-grist": "^8.0.0-beta",
-    "@operato/dataset": "^8.0.0-beta",
-    "@operato/ghost-print": "^8.0.0-beta",
-    "@operato/graphql": "^8.0.0-beta",
-    "@operato/grist-editor": "^8.0.0-beta",
-    "@operato/i18n": "^8.0.0-beta",
-    "@operato/layout": "^8.0.0-beta",
-    "@operato/moment-timezone-es": "^8.0.0-beta",
-    "@operato/p13n": "^8.0.0-beta",
-    "@operato/shell": "^8.0.0-beta",
-    "@operato/styles": "^8.0.0-beta",
-    "@operato/utils": "^8.0.0-beta",
-    "@things-factory/auth-base": "^8.0.0-beta.9",
-    "@things-factory/aws-base": "^8.0.0-beta.9",
-    "@things-factory/board-service": "^8.0.0-beta.9",
-    "@things-factory/env": "^8.0.0-beta.4",
-    "@things-factory/integration-base": "^8.0.0-beta.9",
-    "@things-factory/organization": "^8.0.0-beta.9",
-    "@things-factory/personalization": "^8.0.0-beta.9",
-    "@things-factory/scheduler-client": "^8.0.0-beta.9",
-    "@things-factory/shell": "^8.0.0-beta.9",
-    "@things-factory/work-shift": "^8.0.0-beta.9",
-    "@things-factory/worklist": "^8.0.0-beta.9",
+    "@operato/app": "^8.0.0",
+    "@operato/data-grist": "^8.0.0",
+    "@operato/dataset": "^8.0.0",
+    "@operato/ghost-print": "^8.0.0",
+    "@operato/graphql": "^8.0.0",
+    "@operato/grist-editor": "^8.0.0",
+    "@operato/i18n": "^8.0.0",
+    "@operato/layout": "^8.0.0",
+    "@operato/moment-timezone-es": "^8.0.0",
+    "@operato/p13n": "^8.0.0",
+    "@operato/shell": "^8.0.0",
+    "@operato/styles": "^8.0.0",
+    "@operato/utils": "^8.0.0",
+    "@things-factory/auth-base": "^8.0.2",
+    "@things-factory/aws-base": "^8.0.2",
+    "@things-factory/board-service": "^8.0.2",
+    "@things-factory/env": "^8.0.2",
+    "@things-factory/integration-base": "^8.0.2",
+    "@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.2",
     "cron-parser": "^4.3.0",
     "moment-timezone": "^0.5.45",
     "simple-statistics": "^7.8.3",
     "statistics": "^3.3.0"
   },
-  "gitHead": "86b1dfa26292926a2d5447fdc23bfa5a9e983245"
+  "gitHead": "39d60f56e142561233ddf6d47b539c637971357c"
 }

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

@@ -0,0 +1,100 @@
+import { In } from 'typeorm'
+
+import { User } from '@things-factory/auth-base'
+import {
+  Activity,
+  ActivityInstance,
+  ActivityInstanceStatus,
+  UpdateActivityInstanceStateAddendum
+} 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,
+  addendum: UpdateActivityInstanceStateAddendum,
+  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: In([domain.id, domain.parentId].filter(Boolean)) },
+      name: 'Collect Data'
+    })) as Activity
+
+    /* collect-data 액티비티는 한명의 assignee(thread)만 수행하는 multiple: false 액티비티이다. 따라서, output에는 assignee key가 없이, 순수한 data만 들어있다. */
+    const data = output
+
+    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',
+  priority: 1,
+  searchKeys: [
+    {
+      name: 'dataSetName',
+      description: 'DataSet name',
+      inputKey: 'dataSetName',
+      tKey: 'data-set-name'
+    }
+  ],
+  startingType: '',
+  multiple: 'single',
+  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: 'activity-data-collect-edit',
+  viewType: 'custom-element',
+  viewSource: 'activity-data-collect-view',
+  reportType: 'custom-element',
+  reportSource: 'activity-data-collect-view',
+  thumbnail: '/assets/images/data-collect.png',
+  standardTime: 24 * 60 * 60, // seconds
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

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

@@ -0,0 +1,109 @@
+import { ActivityInstance, ActivityInstanceStatus, UpdateActivityInstanceStateAddendum } from '@things-factory/worklist'
+
+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 } = context.state
+  const { input, output, state } = activityInstance
+
+  if (state == ActivityInstanceStatus.Ended) {
+    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']
+    })
+
+    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)
+    }
+  }
+}
+
+export const ActivityDataReview = {
+  name: 'Data Review',
+  description: 'Tasks for data review',
+  release: '1.0.0',
+  provider: 'hatiolab.com',
+  category: 'quality',
+  activityType: 'user',
+  priority: 1,
+  searchKeys: [
+    {
+      name: 'dataSetName',
+      description: 'DataSet name',
+      inputKey: 'dataSetName',
+      tKey: 'data-set-name'
+    }
+  ],
+  startingType: '',
+  multiple: 'single',
+  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: 'activity-data-review-edit',
+  viewType: 'custom-element',
+  viewSource: 'activity-data-review-view',
+  reportType: 'custom-element',
+  reportSource: 'activity-data-review-view',
+  thumbnail: '/assets/images/data-collect.png',
+  standardTime: 24 * 60 * 60, // seconds
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

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

@@ -0,0 +1,123 @@
+import {
+  ActivityInstance,
+  ActivityInstanceStatus,
+  ActivityThread,
+  ActivityThreadStatus,
+  UpdateActivityInstanceStateAddendum
+} from '@things-factory/worklist'
+import { DataOoc, DataOocStatus } from '../service/data-ooc/data-ooc'
+
+async function callback(
+  activityInstance: ActivityInstance,
+  addendum: UpdateActivityInstanceStateAddendum,
+  context: ResolverContext
+) {
+  const { tx, user, domain } = context.state
+  const { id, input, output, state, terminatedAt } = activityInstance
+  const { causedBy } = addendum || {}
+
+  /* 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 = output?.action
+
+    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',
+  priority: 3,
+  searchKeys: [
+    {
+      name: 'dataOocId',
+      description: 'OOC Id.',
+      inputKey: 'dataOocId',
+      tKey: 'data-ooc-id'
+    }
+  ],
+  startingType: '',
+  multiple: 'single',
+  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: 'activity-ooc-resolve-edit',
+  viewType: 'custom-element',
+  viewSource: 'activity-ooc-resolve-view',
+  reportType: 'custom-element',
+  reportSource: 'data-ooc-report-page',
+  thumbnail: '/assets/images/ooc.png',
+  standardTime: 24 * 60 * 60, // seconds
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

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

@@ -0,0 +1,95 @@
+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,
+  addendum: UpdateActivityInstanceStateAddendum,
+  context: ResolverContext
+) {
+  const { domain, user, tx } = context.state
+  const { input, output, state, terminatedAt } = activityInstance
+  const { causedBy } = addendum || {}
+
+  if (state == ActivityInstanceStatus.Ended) {
+    const { dataOocId } = input
+    const correctiveInstruction = output?.instruction
+
+    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
+    })
+
+    await issueOocResolve(dataOoc, dataOoc.dataSet, correctiveInstruction, context)
+  }
+}
+
+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',
+  priority: 2,
+  searchKeys: [
+    {
+      name: 'dataOocId',
+      description: 'OOC Id.',
+      inputKey: 'dataOocId',
+      tKey: 'data-ooc-id'
+    }
+  ],
+  startingType: '',
+  multiple: 'single',
+  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: 'activity-ooc-review-edit',
+  viewType: 'custom-element',
+  viewSource: 'activity-ooc-review-view',
+  reportType: 'custom-element',
+  reportSource: 'data-ooc-report-page',
+  thumbnail: '/assets/images/ooc.png',
+  standardTime: 24 * 60 * 60, // seconds
+  callback /* Called when there is a change in the lifecycle of a task (activity-instance). */
+}

package/server/activities/index.ts

@@ -0,0 +1,11 @@
+import { ActivityInstallations } from '@things-factory/worklist'
+
+import { ActivityDataCollect } from './activity-data-collect'
+import { ActivityDataReview } from './activity-data-review'
+import { ActivityOocResolve } from './activity-ooc-resolve'
+import { ActivityOocReview } from './activity-ooc-review'
+
+/* activity templates installation */
+;[ActivityOocReview, ActivityOocResolve, ActivityDataCollect, ActivityDataReview].forEach(template => {
+  ActivityInstallations.installActivityTemplate(template as any)
+})

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
+}