@things-factory/dataset 5.0.0-alpha.4 → 5.0.0-alpha.42

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

@@ -0,0 +1,68 @@
+import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
+
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { DataOoc, DataOocStatus } from './data-ooc'
+
+@InputType()
+export class NewDataOoc {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => ObjectRef, { nullable: true })
+  dataSet?: ObjectRef
+
+  @Field(type => ObjectRef, { nullable: true })
+  dataSample?: ObjectRef
+
+  @Field(type => DataOocStatus, { nullable: true })
+  state?: DataOocStatus
+
+  @Field(type => ScalarObject, { nullable: true })
+  data?: ScalarObject
+
+  @Field({ nullable: true })
+  rawData?: string
+
+  @Field({ nullable: true })
+  source?: string
+
+  @Field({ nullable: true })
+  ooc?: boolean
+
+  @Field({ nullable: true })
+  oos?: boolean
+
+  @Field({ nullable: true })
+  workDate?: string
+
+  @Field({ nullable: true })
+  workShift?: string
+
+  @Field({ nullable: true })
+  collectedAt?: Date
+}
+
+@InputType()
+export class DataOocPatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field(type => DataOocStatus, { nullable: true })
+  state?: DataOocStatus
+
+  @Field({ nullable: true })
+  correctiveAction?: string
+}
+
+@ObjectType()
+export class DataOocList {
+  @Field(type => [DataOoc])
+  items: DataOoc[]
+
+  @Field(type => Int)
+  total: number
+}

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

@@ -0,0 +1,204 @@
+import { Field, ID, ObjectType, registerEnumType } from 'type-graphql'
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  JoinColumn,
+  ManyToOne,
+  OneToOne,
+  PrimaryGeneratedColumn,
+  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 { DataSample } from '../data-sample/data-sample'
+import { DataSet } from '../data-set/data-set'
+
+const ORMCONFIG = config.get('ormconfig', {})
+const DATABASE_TYPE = ORMCONFIG.type
+
+export enum DataOocStatus {
+  CREATED = 'CREATED',
+  REVIEWED = 'REVIEWED',
+  CORRECTED = 'CORRECTED'
+}
+
+registerEnumType(DataOocStatus, {
+  name: 'DataOocStatus',
+  description: 'Out of control data corrective action process progress status'
+})
+
+@Entity()
+@Index('ix_data_ooc_0', (dataOoc: DataOoc) => [dataOoc.domain, dataOoc.dataSet], { unique: false })
+@Index('ix_data_ooc_1', (dataOoc: DataOoc) => [dataOoc.domain, dataOoc.dataSample], { unique: true })
+@Index('ix_data_ooc_2', (dataOoc: DataOoc) => [dataOoc.domain, dataOoc.collectedAt], { unique: false })
+@ObjectType({ description: 'Entity for Out of control data' })
+export class DataOoc {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @ManyToOne(type => Domain)
+  @Field({ nullable: true })
+  domain?: Domain
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.domain)
+  domainId?: string
+
+  @Column()
+  @Field()
+  name: string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  description?: string
+
+  @ManyToOne(type => DataSet)
+  @Field(type => DataSet, { nullable: true })
+  dataSet?: DataSet
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.dataSet)
+  dataSetId?: string
+
+  @OneToOne(type => DataSample)
+  @JoinColumn()
+  @Field(type => DataSample, { nullable: true })
+  dataSample?: DataSample
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.dataSample)
+  dataSampleId?: string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  ooc?: boolean
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  oos?: boolean
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  state?: DataOocStatus
+
+  @Column({
+    nullable: true,
+    type:
+      DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? 'longtext'
+        : DATABASE_TYPE == 'oracle'
+        ? 'clob'
+        : 'varchar'
+  })
+  @Field({ nullable: true })
+  correctiveAction?: string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  type?: string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  useCase?: string
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  partitionKeys?: ScalarObject
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  data?: ScalarObject
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  spec?: ScalarObject
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  history?: ScalarObject
+
+  @Column({
+    nullable: true,
+    type:
+      DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? 'longtext'
+        : DATABASE_TYPE == 'oracle'
+        ? 'clob'
+        : 'varchar'
+  })
+  @Field({ nullable: true })
+  rawData?: string
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  source?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  workDate?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  workShift?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  collectedAt?: Date
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  correctedAt?: Date
+
+  @CreateDateColumn()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @UpdateDateColumn()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @ManyToOne(type => User, {
+    nullable: true
+  })
+  @Field({ nullable: true })
+  corrector?: User
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.corrector)
+  correctorId?: string
+
+  @ManyToOne(type => User, {
+    nullable: true
+  })
+  @Field({ nullable: true })
+  creator?: User
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, {
+    nullable: true
+  })
+  @Field({ nullable: true })
+  updater?: User
+
+  @RelationId((dataOoc: DataOoc) => dataOoc.creator)
+  updaterId?: string
+}

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

@@ -0,0 +1,7 @@
+import { DataOoc } from './data-ooc'
+import { DataOocMutation } from './data-ooc-mutation'
+import { DataOocQuery } from './data-ooc-query'
+import { DataOocSubscription } from './data-ooc-subscription'
+
+export const entities = [DataOoc]
+export const resolvers = [DataOocQuery, DataOocMutation, DataOocSubscription]

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

@@ -1,187 +1,18 @@
 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 { createDataSample } from '../../controllers/create-data-sample'
 
 const debug = require('debug')('things-factory:dataset:data-sample:data-sample-mutation')
 
-// parse variable javascript string pattern
-const replaceVariables = (keys, dic) => {
-  for (const k in keys) {
-    const matches = keys[k].match(/\$\{\w*\}/g)
-    matches &&
-      matches.forEach(m => {
-        keys[k] = keys[k].replace(m, dic[m.slice(2, -1)])
-      })
-  }
-  return keys
-}
-
-// It is required UTC date for Partitioning File System like AWS S3.
-// ex) %YYYY, %MM, %DD
-const formatDate = (keys, _moment) => {
-  for (const k in keys) {
-    const matches = keys[k].match(/%\w*/g)
-    matches &&
-      matches.forEach(m => {
-        keys[k] = keys[k].replace(m, _moment.format(m.substr(1)))
-      })
-  }
-  return keys
-}
-
 @Resolver(DataSample)
 export class DataSampleMutation {
   @Directive('@privilege(category: "data-sample", privilege: "mutation", domainOwnerGranted: true)')
   @Directive('@transaction')
   @Mutation(returns => DataSample, { description: 'To create new data sample' })
   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 dataItems = await tx.getRepository(DataItem).find({
-      where: {
-        domain,
-        dataSet
-      },
-      order: {
-        sequence: 'DESC'
-      }
-    })
-
-    const spec = dataItems.reduce((spec, dataItem) => {
-      spec[dataItem.tag] = {
-        ...dataItem.spec,
-        name: dataItem.name /* do we need ? */
-      }
-
-      return spec
-    }, {})
-
-    var partitionKeys = {
-      ...dataSet.partitionKeys,
-      year: '%YYYY',
-      month: '%MM',
-      date: '%DD',
-      variableX: '${x}',
-      variableDataSetId: '${dataSetId}'
-    }
-
-    const collectedAt = dataSample.collectedAt || new Date()
-    partitionKeys = formatDate(partitionKeys, moment(collectedAt).utc())
-    partitionKeys = replaceVariables(partitionKeys, {
-      dataSetId: dataSample.dataSetId,
-      ...dataSample.data
-    })
-
-    return await tx.getRepository(DataSample).save({
-      name: dataSet.name,
-      description: dataSet.description,
-      ...dataSample,
-      domain,
-      partitionKeys,
-      spec,
-      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' })
-      }
-    }
-
-    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 await createDataSample(dataSample, context)
   }
 }

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

@@ -2,7 +2,7 @@ import { Arg, Args, Ctx, Directive, FieldResolver, Query, Resolver, Root } from
 import { getRepository } from 'typeorm'
 
 import { User } from '@things-factory/auth-base'
-import { convertListParams, Domain, ListParam } from '@things-factory/shell'
+import { Domain, getQueryBuilderFromListParams, ListParam } from '@things-factory/shell'
 
 import { DataSet } from '../data-set/data-set'
 import { DataSample } from './data-sample'
@@ -25,8 +25,14 @@ export class DataSampleQuery {
   async dataSamples(@Args() params: ListParam, @Ctx() context: any): Promise<DataSampleList> {
     const { domain } = context.state
 
-    const convertedParams = convertListParams(params, domain.id)
-    const [items, total] = await getRepository(DataSample).findAndCount(convertedParams)
+    const queryBuilder = getQueryBuilderFromListParams({
+      repository: getRepository(DataSample),
+      params,
+      domain,
+      alias: 'datasample'
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
 
     return { items, total }
   }

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

@@ -1,6 +1,6 @@
-import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
+import { Field, 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 +12,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
@@ -25,34 +25,13 @@ export class NewDataSample {
   source?: string
 
   @Field({ nullable: true })
-  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
+  workDate?: string
 
   @Field({ nullable: true })
-  rawData?: string
+  workShift?: string
 
   @Field({ nullable: true })
-  source?: string
-
-  @Field()
-  cuFlag: string
+  collectedAt?: Date
 }
 
 @ObjectType()

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

@@ -20,6 +20,11 @@ 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')
@@ -49,16 +54,21 @@ export class DataSample {
   @Field({ nullable: true })
   type?: string
 
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  useCase?: string
+
   @Column('simple-json', { nullable: true })
   @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 +97,26 @@ 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 })
+  workDate?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  workShift?: string
+
   @Column({ nullable: true })
   @Field({ nullable: true })
   collectedAt?: Date

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

@@ -2,7 +2,7 @@ import { Arg, Args, Ctx, FieldResolver, Query, Resolver, Root } from 'type-graph
 import { getRepository } from 'typeorm'
 
 import { Appliance, User } from '@things-factory/auth-base'
-import { convertListParams, Domain, ListParam } from '@things-factory/shell'
+import { Domain, getQueryBuilderFromListParams, ListParam } from '@things-factory/shell'
 
 import { DataSet } from '../data-set/data-set'
 import { DataSensor } from './data-sensor'
@@ -23,8 +23,14 @@ export class DataSensorQuery {
   async dataSensors(@Args() params: ListParam, @Ctx() context: any): Promise<DataSensorList> {
     const { domain } = context.state
 
-    const convertedParams = convertListParams(params, domain.id)
-    const [items, total] = await getRepository(DataSensor).findAndCount(convertedParams)
+    const queryBuilder = getQueryBuilderFromListParams({
+      repository: getRepository(DataSensor),
+      params,
+      domain,
+      alias: 'datasensor'
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
 
     return { items, total }
   }