@things-factory/dataset 5.0.0-alpha.11 → 5.0.0-alpha.14

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

@@ -1,12 +1,13 @@
 import { Arg, Ctx, Directive, Mutation, Resolver } from 'type-graphql'
-import { In } from 'typeorm'
 
 import { DataItem } from '../data-item/data-item'
 import { DataSet } from '../data-set/data-set'
 import { DataSample } from './data-sample'
-import { DataSamplePatch, NewDataSample } from './data-sample-type'
+import { NewDataSample } from './data-sample-type'
 
 import moment from 'moment'
+import { DataUseCase } from '../../controllers'
+import { DataOoc, DataOocStatus } from '../data-ooc/data-ooc'
 
 const debug = require('debug')('things-factory:dataset:data-sample:data-sample-mutation')
 
@@ -22,7 +23,7 @@ const replaceVariables = (keys, dic) => {
   return keys
 }
 
-// It is required UTC date for Partitioning File System like AWS S3.
+// It is required UTC date for Partitioning File System like AWS S3 from Athena.
 // ex) %YYYY, %MM, %DD
 const formatDate = (keys, _moment) => {
   for (const k in keys) {
@@ -43,7 +44,9 @@ export class DataSampleMutation {
   async createDataSample(@Arg('dataSample') dataSample: NewDataSample, @Ctx() context: any): Promise<DataSample> {
     const { domain, user, tx } = context.state
 
-    const dataSet = await tx.getRepository(DataSet).findOne({ id: dataSample.dataSetId })
+    const dataSet = await tx.getRepository(DataSet).findOne({
+      where: { id: dataSample.dataSet.id }
+    })
     const dataItems = await tx.getRepository(DataItem).find({
       where: {
         domain,
@@ -63,6 +66,9 @@ export class DataSampleMutation {
       return spec
     }, {})
 
+    // appending spec to data for reporting and optimizing AWS Athena search
+    dataSample.data = { ...dataSample.data, _spec: JSON.stringify(spec) }
+
     var partitionKeys = {
       ...dataSet.partitionKeys
     }
@@ -70,114 +76,46 @@ export class DataSampleMutation {
     const collectedAt = dataSample.collectedAt || new Date()
     partitionKeys = formatDate(partitionKeys, moment(collectedAt).utc())
     partitionKeys = replaceVariables(partitionKeys, {
-      domainId: domain.id,
-      dataSetId: dataSample.dataSetId,
+      domain: domain.subdomain,
+      dataSetId: dataSample.dataSet.id,
       ...dataSample.data
     })
 
-    return await tx.getRepository(DataSample).save({
+    const { ooc, oos } = DataUseCase.evaluate(dataSet, dataItems, dataSample.data) || {}
+
+    const result = await tx.getRepository(DataSample).save({
       name: dataSet.name,
       description: dataSet.description,
       ...dataSample,
       domain,
       partitionKeys,
       spec,
+      ooc,
+      oos,
       collectedAt,
       creator: user,
       updater: user
     })
-  }
-
-  @Directive('@privilege(category: "data-sample", privilege: "mutation", domainOwnerGranted: true)')
-  @Directive('@transaction')
-  @Mutation(returns => DataSample, { description: 'To modify data sample information' })
-  async updateDataSample(
-    @Arg('id') id: string,
-    @Arg('patch') patch: DataSamplePatch,
-    @Ctx() context: any
-  ): Promise<DataSample> {
-    const { domain, user, tx } = context.state
-
-    const repository = tx.getRepository(DataSample)
-    const dataSample = await repository.findOne({
-      where: { domain, id }
-    })
-
-    return await repository.save({
-      ...dataSample,
-      ...patch,
-      updater: user
-    })
-  }
-
-  @Directive('@privilege(category: "data-sample", privilege: "mutation", domainOwnerGranted: true)')
-  @Directive('@transaction')
-  @Mutation(returns => [DataSample], { description: "To modify multiple data samples' information" })
-  async updateMultipleDataSample(
-    @Arg('patches', type => [DataSamplePatch]) patches: DataSamplePatch[],
-    @Ctx() context: any
-  ): Promise<DataSample[]> {
-    const { domain, user, tx } = context.state
-
-    let results = []
-    const _createRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === '+')
-    const _updateRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === 'M')
-    const dataSampleRepo = tx.getRepository(DataSample)
-
-    if (_createRecords.length > 0) {
-      for (let i = 0; i < _createRecords.length; i++) {
-        const newRecord = _createRecords[i]
-
-        const result = await dataSampleRepo.save({
-          ...newRecord,
-          domain,
-          creator: user,
-          updater: user
-        })
 
-        results.push({ ...result, cuFlag: '+' })
-      }
-    }
-
-    if (_updateRecords.length > 0) {
-      for (let i = 0; i < _updateRecords.length; i++) {
-        const newRecord = _updateRecords[i]
-        const dataSample = await dataSampleRepo.findOne(newRecord.id)
-
-        const result = await dataSampleRepo.save({
-          ...dataSample,
-          ...newRecord,
-          updater: user
-        })
-
-        results.push({ ...result, cuFlag: 'M' })
-      }
+    if (ooc || oos) {
+      await tx.getRepository(DataOoc).save({
+        name: dataSet.name,
+        description: dataSet.description,
+        dataSet,
+        dataSample: result,
+        data: dataSample.data,
+        domain,
+        partitionKeys,
+        spec,
+        ooc,
+        oos,
+        state: DataOocStatus.CREATED,
+        collectedAt,
+        creator: user,
+        updater: user
+      })
     }
 
-    return results
-  }
-
-  @Directive('@privilege(category: "data-sample", privilege: "mutation", domainOwnerGranted: true)')
-  @Directive('@transaction')
-  @Mutation(returns => Boolean, { description: 'To delete a data sample' })
-  async deleteDataSample(@Arg('id') id: string, @Ctx() context: any): Promise<boolean> {
-    const { domain, tx } = context.state
-
-    await tx.getRepository(DataSample).delete({ domain, id })
-    return true
-  }
-
-  @Directive('@privilege(category: "data-sample", privilege: "mutation", domainOwnerGranted: true)')
-  @Directive('@transaction')
-  @Mutation(returns => Boolean, { description: 'To delete multiple data samples' })
-  async deleteDataSamples(@Arg('ids', type => [String]) ids: string[], @Ctx() context: any): Promise<boolean> {
-    const { domain, tx } = context.state
-
-    await tx.getRepository(DataSample).delete({
-      domain,
-      id: In(ids)
-    })
-
-    return true
+    return result
   }
 }

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

@@ -1,6 +1,5 @@
 import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
-
-import { ScalarObject } from '@things-factory/shell'
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
 
 import { DataSample } from './data-sample'
 
@@ -12,8 +11,8 @@ export class NewDataSample {
   @Field({ nullable: true })
   description?: string
 
-  @Field({ nullable: true })
-  dataSetId?: string
+  @Field(type => ObjectRef, { nullable: true })
+  dataSet?: ObjectRef
 
   @Field(type => ScalarObject, { nullable: true })
   data?: ScalarObject
@@ -28,33 +27,6 @@ export class NewDataSample {
   collectedAt?: Date
 }
 
-@InputType()
-export class DataSamplePatch {
-  @Field(type => ID, { nullable: true })
-  id?: string
-
-  @Field({ nullable: true })
-  name?: string
-
-  @Field({ nullable: true })
-  description?: string
-
-  @Field({ nullable: true })
-  dataSetId?: string
-
-  @Field(type => ScalarObject, { nullable: true })
-  data?: ScalarObject
-
-  @Field({ nullable: true })
-  rawData?: string
-
-  @Field({ nullable: true })
-  source?: string
-
-  @Field()
-  cuFlag: string
-}
-
 @ObjectType()
 export class DataSampleList {
   @Field(type => [DataSample])

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

@@ -1,4 +1,3 @@
-import { Field, ID, ObjectType } from 'type-graphql'
 import {
   Column,
   CreateDateColumn,
@@ -9,17 +8,22 @@ import {
   RelationId,
   UpdateDateColumn
 } from 'typeorm'
-
-import { User } from '@things-factory/auth-base'
-import { config } from '@things-factory/env'
 import { Domain, ScalarObject } from '@things-factory/shell'
+import { Field, ID, ObjectType } from 'type-graphql'
 
 import { DataSet } from '../data-set/data-set'
+import { User } from '@things-factory/auth-base'
+import { config } from '@things-factory/env'
 
 const ORMCONFIG = config.get('ormconfig', {})
 const DATABASE_TYPE = ORMCONFIG.type
 @Entity()
 @Index('ix_data_sample_0', (dataSample: DataSample) => [dataSample.domain, dataSample.dataSet], { unique: false })
+@Index(
+  'ix_data_sample_2',
+  (dataSample: DataSample) => [dataSample.domain, dataSample.dataSet, dataSample.collectedAt],
+  { unique: false }
+)
 @ObjectType({ description: 'Entity for DataSample' })
 export class DataSample {
   @PrimaryGeneratedColumn('uuid')
@@ -53,12 +57,11 @@ export class DataSample {
   @Field(type => ScalarObject, { nullable: true })
   partitionKeys?: ScalarObject
 
-  @ManyToOne(type => DataSet, dataSet => dataSet.dataSamples)
-  @Field(type => DataSet, { nullable: true })
+  @ManyToOne(type => DataSet)
+  @Field(type => DataSet, { nullable: false })
   dataSet?: DataSet
 
   @RelationId((dataSample: DataSample) => dataSample.dataSet)
-  @Field({ nullable: true })
   dataSetId?: string
 
   @Column('simple-json', { nullable: true })
@@ -87,6 +90,18 @@ export class DataSample {
   @Field({ nullable: true })
   source?: string
 
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  ooc?: boolean
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  oos?: boolean
+
   @Column({ nullable: true })
   @Field({ nullable: true })
   collectedAt?: Date

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

@@ -200,10 +200,7 @@ export class DataSetMutation {
 
     return copiedDataSets.map(dataSet => {
       dataSet.dataItems = copiedDataItems.filter(dataItem => dataItem.dataSet == dataSet.id)
-      return {
-        ...dataSet,
-        state: 'UNLOADED' // DataSetInstanceStatus.UNLOADED
-      }
+      return dataSet
     })
   }
 }

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

@@ -1,6 +1,5 @@
 import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
-
-import { ScalarObject } from '@things-factory/shell'
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
 
 import { DataSet } from './data-set'
 
@@ -12,11 +11,17 @@ export class NewDataSet {
   @Field({ nullable: true })
   description?: string
 
+  @Field(type => ObjectRef, { nullable: true })
+  supervisoryRole?: ObjectRef
+
   @Field({ nullable: true })
   active?: boolean
 
   @Field({ nullable: true })
-  type?: string
+  type?: 'manual' | 'automatic' | string
+
+  @Field({ nullable: true })
+  useCase?: string
 
   @Field(type => ScalarObject, { nullable: true })
   partitionKeys?: ScalarObject
@@ -39,11 +44,17 @@ export class DataSetPatch {
   @Field({ nullable: true })
   description?: string
 
+  @Field(type => ObjectRef, { nullable: true })
+  supervisoryRole?: ObjectRef
+
   @Field({ nullable: true })
   active?: boolean
 
   @Field({ nullable: true })
-  type?: string
+  type?: 'manual' | 'automatic' | string
+
+  @Field({ nullable: true })
+  useCase?: string
 
   @Field(type => ScalarObject, { nullable: true })
   partitionKeys?: ScalarObject

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

@@ -1,4 +1,3 @@
-import { Field, ID, ObjectType } from 'type-graphql'
 import {
   Column,
   CreateDateColumn,
@@ -10,12 +9,11 @@ import {
   RelationId,
   UpdateDateColumn
 } from 'typeorm'
-
-import { User } from '@things-factory/auth-base'
 import { Domain, ScalarObject } from '@things-factory/shell'
+import { Field, ID, ObjectType } from 'type-graphql'
+import { Role, User } from '@things-factory/auth-base'
 
 import { DataItem } from '../data-item/data-item'
-import { DataSample } from '../data-sample/data-sample'
 
 @Entity()
 @Index('ix_data_set_0', (dataSet: DataSet) => [dataSet.domain, dataSet.name], { unique: true })
@@ -48,11 +46,26 @@ export class DataSet {
   @Field({ nullable: true })
   active?: boolean
 
+  @ManyToOne(type => Role, {
+    nullable: true
+  })
+  @Field({ nullable: true })
+  supervisoryRole?: Role
+
+  @RelationId((dataSet: DataSet) => dataSet.supervisoryRole)
+  supervisoryRoleId?: string
+
   @Column({
     nullable: true
   })
   @Field({ nullable: true })
-  type?: string
+  type?: 'manual' | 'automatic' | string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  useCase?: string
 
   @Column('simple-json', { nullable: true })
   @Field(type => ScalarObject, { nullable: true })
@@ -68,10 +81,6 @@ export class DataSet {
   @Field(type => [DataItem], { nullable: true })
   dataItems: DataItem[]
 
-  @OneToMany(type => DataSample, dataSample => dataSample.dataSet)
-  @Field(type => [DataSample], { nullable: true })
-  dataSamples: DataSample[]
-
   @Column({
     nullable: true
   })

package/server/service/index.ts

@@ -1,11 +1,13 @@
+import { entities as DataItemEntities, resolvers as DataItemResolvers } from './data-item'
 /* IMPORT ENTITIES AND RESOLVERS */
-import { entities as DataSensorEntities, resolvers as DataSensorResolvers } from './data-sensor'
+import { entities as DataOocEntities, resolvers as DataOocResolvers } from './data-ooc'
 import { entities as DataSampleEntities, resolvers as DataSampleResolvers } from './data-sample'
-import { entities as DataItemEntities, resolvers as DataItemResolvers } from './data-item'
+import { entities as DataSensorEntities, resolvers as DataSensorResolvers } from './data-sensor'
 import { entities as DataSetEntities, resolvers as DataSetResolvers } from './data-set'
 import { entities as DataSpecEntities, resolvers as DataSpecResolvers } from './data-spec'
 
 /* EXPORT ENTITY TYPES */
+export * from './data-ooc/data-ooc'
 export * from './data-sensor/data-sensor'
 export * from './data-sample/data-sample'
 export * from './data-item/data-item'
@@ -14,6 +16,7 @@ export * from './data-spec/data-spec'
 
 export const entities = [
   /* ENTITIES */
+  ...DataOocEntities,
   ...DataSensorEntities,
   ...DataSampleEntities,
   ...DataItemEntities,
@@ -24,6 +27,7 @@ export const entities = [
 export const schema = {
   resolverClasses: [
     /* RESOLVER CLASSES */
+    ...DataOocResolvers,
     ...DataSensorResolvers,
     ...DataSampleResolvers,
     ...DataItemResolvers,

package/things-factory.config.js

@@ -15,6 +15,10 @@ export default {
     {
       tagname: 'data-sample-page',
       page: 'data-sample'
+    },
+    {
+      tagname: 'data-ooc-page',
+      page: 'data-ooc'
     }
   ],
   bootstrap

package/translations/en.json

@@ -1,10 +1,16 @@
 {
   "field.appliance": "appliance",
   "field.collected_at": "collected at",
+  "field.corrective-action": "corrective action",
+  "field.corrector": "corrector",
+  "field.corrected-at": "corrected at",
   "field.data": "data",
-  "field.dataSet": "data set",
+  "field.data-sample": "data sample",
+  "field.data-set": "data set",
   "field.device-id": "device id",
   "field.netmask": "network mask",
+  "field.oos": "out of critical limit",
+  "field.ooc": "out of control limit",
   "field.options": "options",
   "field.partition-keys": "partition keys",
   "field.quota": "sampling #",
@@ -12,8 +18,12 @@
   "field.ref-by": "ref. by",
   "field.serial-no": "serial #",
   "field.spec": "spec",
+  "field.state": "state",
+  "field.supervisory-role": "supervisory role",
   "field.tag": "tag name",
   "field.unit": "unit",
+  "field.use-case": "use case",
+  "text.data sample created successfully": "a data sample created successfully",
   "title.data-entry-form": "data entry form",
   "title.data-item list": "data item list",
   "title.data-sample list": "data sample list",

package/translations/ko.json

@@ -1,10 +1,16 @@
 {
   "field.appliance": "어플라이언스",
   "field.collected_at": "수집일시",
+  "field.corrective-action": "조치 활동",
+  "field.corrector": "조치자",
+  "field.corrected-at": "조치 시간",
   "field.data": "데이타",
-  "field.dataSet": "데이타셋",
+  "field.data-sample": "데이타 샘플",
+  "field.data-set": "데이타셋",
   "field.device-id": "디바이스 아이디",
   "field.netmask": "네트워크마스크",
+  "field.oos": "허용한계 이탈여부",
+  "field.ooc": "관리한계 이탈여부",
   "field.options": "선택옵션",
   "field.partition-keys": "파티션 키",
   "field.quota": "샘플수",
@@ -12,8 +18,12 @@
   "field.ref-by": "참조아이템",
   "field.serial-no": "시리얼번호",
   "field.spec": "명세",
+  "field.state": "상태",
+  "field.supervisory-role": "관리자 역할",
   "field.tag": "태그이름",
   "field.unit": "단위",
+  "field.use-case": "사용 사례",
+  "text.data sample created successfully": "데이타 샘플이 성공적으로 생성되었습니다",
   "title.data-entry-form": "데이타 입력",
   "title.data-item list": "데이타 아이템 조회",
   "title.data-sample list": "데이타 샘플 조회",

package/translations/ms.json

@@ -1,10 +1,16 @@
 {
   "field.appliance": "appliance",
   "field.collected_at": "collected at",
+  "field.corrective-action": "corrective action",
+  "field.corrector": "corrector",
+  "field.corrected-at": "corrected at",
   "field.data": "data",
-  "field.dataSet": "data set",
+  "field.data-sample": "data sample",
+  "field.data-set": "data set",
   "field.device-id": "device id",
   "field.netmask": "network mask",
+  "field.oos": "out of critical limit",
+  "field.ooc": "out of control limit",
   "field.options": "options",
   "field.partition-keys": "partition keys",
   "field.quota": "sampling #",
@@ -12,8 +18,12 @@
   "field.ref-by": "ref. by",
   "field.serial-no": "serial #",
   "field.spec": "spec",
+  "field.state": "state",
+  "field.supervisory-role": "supervisory role",
   "field.tag": "tag name",
   "field.unit": "unit",
+  "field.use-case": "use case",
+  "text.data sample created successfully": "a data sample created successfully",
   "title.data-entry-form": "data entry form",
   "title.data-item list": "data item list",
   "title.data-sample list": "data sample list",

package/translations/zh.json

@@ -1,10 +1,16 @@
 {
   "field.appliance": "appliance",
   "field.collected_at": "collected at",
+  "field.corrective-action": "corrective action",
+  "field.corrector": "corrector",
+  "field.corrected-at": "corrected at",
   "field.data": "data",
-  "field.dataSet": "data set",
+  "field.data-sample": "data sample",
+  "field.data-set": "data set",
   "field.device-id": "device id",
   "field.netmask": "network mask",
+  "field.oos": "out of critical limit",
+  "field.ooc": "out of control limit",
   "field.options": "options",
   "field.partition-keys": "partition keys",
   "field.quota": "sampling #",
@@ -12,8 +18,12 @@
   "field.ref-by": "ref. by",
   "field.serial-no": "serial #",
   "field.spec": "spec",
+  "field.state": "state",
+  "field.supervisory-role": "supervisory role",
   "field.tag": "tag name",
   "field.unit": "unit",
+  "field.use-case": "use case",
+  "text.data sample created successfully": "a data sample created successfully",
   "title.data-entry-form": "data entry form",
   "title.data-item list": "data item list",
   "title.data-sample list": "data sample list",