@things-factory/dataset 5.0.0-alpha.2 → 5.0.0-alpha.20

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

@@ -1,4 +1,3 @@
-import { Field, ID, Int, ObjectType, registerEnumType } from 'type-graphql'
 import {
   Column,
   CreateDateColumn,
@@ -9,17 +8,18 @@ import {
   RelationId,
   UpdateDateColumn
 } from 'typeorm'
-
-import { User } from '@things-factory/auth-base'
 import { Domain, ScalarObject } from '@things-factory/shell'
+import { Field, ID, Int, ObjectType, registerEnumType } from 'type-graphql'
 
 import { DataSet } from '../data-set/data-set'
+import { User } from '@things-factory/auth-base'
 
 export enum DataItemType {
   number = 'number',
   text = 'text',
   boolean = 'boolean',
-  select = 'select'
+  select = 'select',
+  file = 'file'
 }
 
 registerEnumType(DataItemType, {
@@ -53,7 +53,7 @@ export class DataItem {
   description?: string
 
   @ManyToOne(type => DataSet, dataSet => dataSet.dataItems, { onDelete: 'CASCADE' })
-  @Field(type => DataSet, { nullable: true })
+  @Field(type => DataSet, { nullable: false })
   dataSet?: DataSet
 
   @RelationId((dataItem: DataItem) => dataItem.dataSet)
@@ -81,6 +81,16 @@ export class DataItem {
   @Field({ nullable: true })
   type?: DataItemType
 
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  options?: ScalarObject
+
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  unit?: string
+
   @Column({
     nullable: true
   })
@@ -89,7 +99,7 @@ export class DataItem {
 
   @Column('simple-json', { nullable: true })
   @Field(type => ScalarObject, { nullable: true })
-  spec?: object
+  spec?: ScalarObject
 
   @CreateDateColumn()
   @Field({ nullable: true })

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

@@ -0,0 +1,150 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+import { getRepository, In } from 'typeorm'
+import { DataOoc, DataOocStatus } from './data-ooc'
+import { NewDataOoc, DataOocPatch } from './data-ooc-type'
+
+@Resolver(DataOoc)
+export class DataOocMutation {
+  @Directive('@privilege(category: "data-ooc", privilege: "mutation", domainOwnerGranted: true)')
+  @Directive('@transaction')
+  @Mutation(returns => DataOoc, { description: 'To create new DataOoc' })
+  async createDataOoc(@Arg('dataOoc') dataOoc: NewDataOoc, @Ctx() context: any): Promise<DataOoc> {
+    const { domain, user, tx } = context.state
+
+    const state = dataOoc.state || DataOocStatus.CREATED
+    const history = [
+      {
+        user: {
+          id: user.id,
+          name: user.name
+        },
+        state,
+        timestamp: Date.now()
+      }
+    ]
+
+    return await tx.getRepository(DataOoc).save({
+      ...dataOoc,
+      state,
+      domain,
+      history,
+      creator: user,
+      updater: user
+    })
+  }
+
+  @Directive('@privilege(category: "data-ooc", privilege: "mutation", domainOwnerGranted: true)')
+  @Directive('@transaction')
+  @Mutation(returns => DataOoc, { description: 'To modify DataOoc information' })
+  async updateDataOoc(@Arg('id') id: string, @Arg('patch') patch: DataOocPatch, @Ctx() context: any): Promise<DataOoc> {
+    const { domain, user, tx } = context.state
+
+    const repository = tx.getRepository(DataOoc)
+    const dataOoc = await repository.findOne({
+      where: { domain, id }
+    })
+
+    const state = patch.state || dataOoc.state
+
+    const history = dataOoc.history || []
+    history.push({
+      user: {
+        id: user.id,
+        name: user.name
+      },
+      state,
+      comment: patch.correctiveAction || '',
+      timestamp: Date.now()
+    })
+
+    const more = {} as any
+
+    if (dataOoc.state !== patch.state) {
+      if (patch.state === DataOocStatus.CORRECTED) {
+        more.corrector = user
+      } else {
+        more.corrector = null
+      }
+    }
+
+    return await repository.save({
+      ...dataOoc,
+      ...patch,
+      ...more,
+      state,
+      history,
+      updater: user
+    })
+  }
+
+  // @Directive('@privilege(category: "data-ooc", privilege: "mutation", domainOwnerGranted: true)')
+  // @Directive('@transaction')
+  // @Mutation(returns => [DataOoc], { description: "To modify multiple DataOoc' information" })
+  // async updateMultipleDataOoc(
+  //   @Arg('patches', type => [DataOocPatch]) patches: DataOocPatch[],
+  //   @Ctx() context: any
+  // ): Promise<DataOoc[]> {
+  //   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 dataOocRepo = tx.getRepository(DataOoc)
+
+  //   if (_createRecords.length > 0) {
+  //     for (let i = 0; i < _createRecords.length; i++) {
+  //       const newRecord = _createRecords[i]
+
+  //       const result = await dataOocRepo.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 dataOoc = await dataOocRepo.findOne(newRecord.id)
+
+  //       const result = await dataOocRepo.save({
+  //         ...dataOoc,
+  //         ...newRecord,
+  //         updater: user
+  //       })
+
+  //       results.push({ ...result, cuFlag: 'M' })
+  //     }
+  //   }
+
+  //   return results
+  // }
+
+  // @Directive('@privilege(category: "data-ooc", privilege: "mutation", domainOwnerGranted: true)')
+  // @Directive('@transaction')
+  // @Mutation(returns => Boolean, { description: 'To delete DataOoc' })
+  // async deleteDataOoc(@Arg('id') id: string, @Ctx() context: any): Promise<boolean> {
+  //   const { domain, tx } = context.state
+
+  //   await tx.getRepository(DataOoc).delete({ domain, id })
+  //   return true
+  // }
+
+  // @Directive('@privilege(category: "data-ooc", privilege: "mutation", domainOwnerGranted: true)')
+  // @Directive('@transaction')
+  // @Mutation(returns => Boolean, { description: 'To delete multiple dataOocs' })
+  // async deleteDataOocs(@Arg('ids', type => [String]) ids: string[], @Ctx() context: any): Promise<boolean> {
+  //   const { domain, tx } = context.state
+
+  //   await tx.getRepository(DataOoc).delete({
+  //     domain,
+  //     id: In(ids)
+  //   })
+
+  //   return true
+  // }
+}

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

@@ -0,0 +1,63 @@
+import { Arg, Args, Ctx, Directive, FieldResolver, Query, Resolver, Root } from 'type-graphql'
+import { getRepository } from 'typeorm'
+
+import { User } from '@things-factory/auth-base'
+import { convertListParams, Domain, ListParam } from '@things-factory/shell'
+
+import { DataSample } from '../data-sample/data-sample'
+import { DataSet } from '../data-set/data-set'
+import { DataOoc } from './data-ooc'
+import { DataOocList } from './data-ooc-type'
+
+@Resolver(DataOoc)
+export class DataOocQuery {
+  @Directive('@privilege(category: "data-ooc", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => DataOoc, { description: 'To fetch a DataOoc' })
+  async dataOoc(@Arg('id') id: string, @Ctx() context: any): Promise<DataOoc> {
+    const { domain } = context.state
+
+    return await getRepository(DataOoc).findOne({
+      where: { domain, id }
+    })
+  }
+
+  @Directive('@privilege(category: "data-ooc", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => DataOocList, { description: 'To fetch multiple DataOoc' })
+  async dataOocs(@Args() params: ListParam, @Ctx() context: any): Promise<DataOocList> {
+    const { domain } = context.state
+
+    const convertedParams = convertListParams(params, domain.id)
+    const [items, total] = await getRepository(DataOoc).findAndCount(convertedParams)
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => DataSet)
+  async dataSet(@Root() dataOoc: DataOoc): Promise<DataSet> {
+    return await getRepository(DataSet).findOne({
+      id: dataOoc.dataSetId
+    })
+  }
+
+  @FieldResolver(type => DataSample)
+  async dataSample(@Root() dataOoc: DataOoc): Promise<DataSample> {
+    return await getRepository(DataSample).findOne({
+      id: dataOoc.dataSampleId
+    })
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() dataOoc: DataOoc): Promise<Domain> {
+    return await getRepository(Domain).findOne(dataOoc.domainId)
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() dataOoc: DataOoc): Promise<User> {
+    return await getRepository(User).findOne(dataOoc.updaterId)
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() dataOoc: DataOoc): Promise<User> {
+    return await getRepository(User).findOne(dataOoc.creatorId)
+  }
+}

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

@@ -0,0 +1,51 @@
+import { Resolver, Subscription, Root } from 'type-graphql'
+import { withFilter } from 'graphql-subscriptions'
+import { pubsub } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+import { DataOoc } from './data-ooc'
+import { getRepository } from 'typeorm'
+
+const debug = require('debug')('things-factory:dataset:data-ooc-subscription')
+
+@Resolver(DataOoc)
+export class DataOocSubscription {
+  @Subscription({
+    subscribe: (_, args, context, info) => {
+      const { domain, user } = context.state
+      const subdomain = domain?.subdomain
+
+      debug('subscribe', subdomain)
+
+      if (!domain) {
+        throw new Error('domain required')
+      }
+
+      if (!user.domains?.find(d => d.subdomain === subdomain)) {
+        throw new Error(`domain(${subdomain}) is not working for user(${user.email}).`)
+      }
+
+      return withFilter(
+        () => pubsub.asyncIterator('data-ooc'),
+        async (payload, variables, context, info) => {
+          const { dataOoc, supervisoryRoleId } = payload
+          const { domain } = dataOoc
+
+          if (subdomain !== domain?.subdomain) {
+            return false
+          }
+
+          // check if the user has that role
+          const userWithRoles: User = await getRepository(User).findOne({
+            where: { id: user.id },
+            relations: ['roles']
+          })
+
+          return userWithRoles.roles.find(role => role.id === supervisoryRoleId)
+        }
+      )(_, args, context, info)
+    }
+  })
+  dataOoc(@Root() payload: { dataOoc: DataOoc; supervisoryRoleId: string }): DataOoc {
+    return payload.dataOoc
+  }
+}

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

@@ -0,0 +1,62 @@
+import { DataOoc, DataOocStatus } from './data-ooc'
+import { Field, ID, InputType, Int, ObjectType, registerEnumType } from 'type-graphql'
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { User } from '@things-factory/auth-base'
+
+@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 })
+  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,195 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  JoinColumn,
+  ManyToOne,
+  OneToOne,
+  PrimaryGeneratedColumn,
+  RelationId,
+  UpdateDateColumn
+} from 'typeorm'
+import { Domain, ScalarObject } from '@things-factory/shell'
+import { Field, ID, Int, ObjectType, registerEnumType } from 'type-graphql'
+
+import { DataSample } from '../data-sample/data-sample'
+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
+
+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 })
+  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]