@things-factory/dataset 5.0.0-alpha.3 → 5.0.0-alpha.32

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

@@ -0,0 +1,85 @@
+import { DataItem, DataSet } from 'server/service'
+
+export type DataItemSpec = {
+  type: string
+  label: string
+  name: string
+  property: { [option: string]: any }
+}
+
+export type DataItemSpecSet = {
+  name: string
+  description: string
+  specs: DataItemSpec[]
+}
+
+export type EvaluationResult = { oos: boolean; ooc: boolean }
+
+export abstract class DataUseCase {
+  static registry: { [name: string]: DataUseCase } = {}
+
+  public static registerUseCase(name: string, provider: DataUseCase) {
+    DataUseCase.registry[name] = provider
+  }
+
+  public static getUseCaseNames() {
+    return Object.keys(DataUseCase.registry)
+  }
+
+  public static getUseCase(name: string): DataUseCase | undefined {
+    return DataUseCase.registry[name]
+  }
+
+  public static evaluate(dataSet: DataSet, dataItems: DataItem[], data: any): EvaluationResult {
+    var ooc = false
+    var oos = false
+
+    if (!dataSet.useCase) {
+      return { ooc, oos }
+    }
+
+    const useCaseNames = dataSet.useCase.split(',').map(useCaseName => useCaseName.trim())
+    const useCases = useCaseNames.map(useCaseName => DataUseCase.getUseCase(useCaseName)).filter(useCase => !!useCase)
+
+    for (let i = 0; i < dataItems.length; i++) {
+      const dataItem = dataItems[i]
+      const { active, tag } = dataItem
+      if (!active || !tag) {
+        continue
+      }
+
+      let values: any | any[] = data[tag]
+      if (typeof values === 'undefined') {
+        continue // TODO what if in case no value ?
+      }
+
+      if (!(values instanceof Array)) {
+        values = [values]
+      }
+
+      for (let j = 0; j < useCases.length; j++) {
+        const useCase = useCases[j]
+
+        const specs = dataItem.spec?.[dataSet.useCase]
+        if (!specs) {
+          continue
+        }
+
+        const result = useCase.evaluate(specs, values)
+
+        if (result) {
+          ooc ||= result.ooc
+          oos ||= result.oos
+        }
+
+        // if (ooc && oos) {
+        //   return { ooc, oos }
+        // }
+      }
+    }
+
+    return { ooc, oos }
+  }
+
+  public abstract evaluate(specs: any, values: any[]): EvaluationResult
+}

package/server/controllers/index.ts

@@ -0,0 +1 @@
+export * from './data-use-case'

package/server/index.ts

@@ -1,5 +1,8 @@
 import './routes'
 
+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,7 +1,8 @@
 import { getConnection } from 'typeorm'
 
-import { DataSample } from './service'
-import { DataItem } from './service/data-item/data-item'
+import { User } from '@things-factory/auth-base'
+
+import { createDataSample } from './controllers/create-data-sample'
 import { DataSensor } from './service/data-sensor/data-sensor'
 
 const debug = require('debug')('things-factory:dataset:routes')
@@ -47,41 +48,26 @@ process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRout
 
       const domain = sensor.domain
       const dataSet = sensor.dataSet
-      const user = sensor.appliance
-
-      const dataItems = await tx.getRepository(DataItem).find({
+      const user: User = await tx.getRepository(User).findOne({
         where: {
-          domain,
-          dataSet
-        },
-        order: {
-          sequence: 'DESC'
+          reference: sensor.appliance.id,
+          userType: 'appliance'
         }
       })
 
-      var spec = {} as any
-
-      dataItems.forEach(dataItem => {
-        spec[dataItem.name] = dataItem.spec
-      })
-
-      await tx.getRepository(DataSample).save({
-        domain,
-        name: dataSet.name,
-        description: dataSet.description,
-        partitionKeys: dataSet.partitionKeys,
-        dataSet,
-        data,
-        rawData,
-        spec,
-        source: deviceId,
-        collectedAt: new Date(timestamp),
-        creator: user,
-        updater: user
-      })
+      return await createDataSample(
+        {
+          dataSet,
+          data,
+          rawData,
+          source: deviceId,
+          collectedAt: new Date(timestamp)
+        },
+        { state: { domain, user, tx } }
+      )
     })
 
-    return 'OK'
+    context.status = 200
   })
 })
 

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

@@ -24,9 +24,14 @@ export class DataItemMutation {
     await dataItemRepo.delete({ domain, dataSet: dataSetId })
 
     for (let i = 0; i < patches.length; i++) {
+      const patch = patches[i]
+      if (!patch.options) {
+        patch.options = {}
+      }
+
       const result = await dataItemRepo.save({
         quota: 1,
-        ...patches[i],
+        ...patch,
         sequence: i,
         dataSet,
         domain,

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

@@ -1,16 +1,14 @@
-import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
-
-import { ScalarObject } from '@things-factory/shell'
-
 import { DataItem, DataItemType } from './data-item'
+import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
 
 @InputType()
 export class DataItemPatch {
   @Field(type => ID, { nullable: true })
   id?: string
 
-  @Field({ nullable: true })
-  dataSetId?: string
+  @Field(type => ObjectRef, { nullable: true })
+  dataSet?: ObjectRef
 
   @Field({ nullable: true })
   name?: string
@@ -27,12 +25,21 @@ export class DataItemPatch {
   @Field(type => DataItemType, { nullable: true })
   type?: DataItemType
 
+  @Field(type => ScalarObject, { nullable: true })
+  options?: ScalarObject
+
+  @Field({ nullable: true })
+  unit?: string
+
   @Field(type => Int, { nullable: true })
   quota?: number
 
   @Field({ nullable: true })
   active?: boolean
 
+  @Field({ nullable: true })
+  hidden?: boolean
+
   @Field(type => ScalarObject, { nullable: true })
   spec?: ScalarObject
 

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)
@@ -75,12 +75,28 @@ export class DataItem {
   @Field({ nullable: true })
   active?: boolean
 
+  @Column({
+    nullable: true
+  })
+  @Field({ nullable: true })
+  hidden?: boolean
+
   @Column({
     nullable: true
   })
   @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
   })

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

@@ -0,0 +1,150 @@
+import { Arg, Ctx, Directive, Mutation, Resolver } from 'type-graphql'
+
+import { DataOoc, DataOocStatus } from './data-ooc'
+import { DataOocPatch, NewDataOoc } 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,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
+}