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

package/server/service/process/process-history.ts

@@ -0,0 +1,108 @@
+import { Field, ID, ObjectType } from 'type-graphql'
+import { Column, Entity, Index, ManyToOne, PrimaryGeneratedColumn, RelationId } from 'typeorm'
+
+import {
+  HistoryActionColumn,
+  HistoryActionType,
+  HistoryEntityInterface,
+  HistoryOriginalIdColumn
+} from '@operato/typeorm-history'
+import { Role, User } from '@things-factory/auth-base'
+import { config } from '@things-factory/env'
+import { Domain } from '@things-factory/shell'
+
+import { Process, ProcessStatus } from './process'
+
+const ORMCONFIG = config.get('ormconfig', {})
+const DATABASE_TYPE = ORMCONFIG.type
+
+@Entity()
+@Index(
+  'ix_process_history_0',
+  (processHistory: ProcessHistory) => [processHistory.originalId, processHistory.version],
+  { unique: true }
+)
+@Index(
+  'ix_process_history_1',
+  (processHistory: ProcessHistory) => [processHistory.domain, processHistory.originalId, processHistory.version],
+  { unique: true }
+)
+@ObjectType({ description: 'History Entity of Process' })
+export class ProcessHistory implements HistoryEntityInterface<Process> {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @Column({ nullable: true, default: 1 })
+  @Field({ nullable: true })
+  version?: number = 1
+
+  @ManyToOne(type => Domain)
+  @Field(type => Domain)
+  domain?: Domain
+
+  @RelationId((process: Process) => process.domain)
+  domainId?: string
+
+  @Column()
+  @Field({ nullable: true })
+  name?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  description?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  state?: ProcessStatus
+
+  @ManyToOne(type => Role, { nullable: true })
+  @Field(type => Role, { nullable: true })
+  supervisoryRole?: Role
+
+  @RelationId((process: Process) => process.supervisoryRole)
+  supervisoryRoleId?: string
+
+  @Column()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @Column()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  creator?: User
+
+  @RelationId((process: Process) => process.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  updater?: User
+
+  @RelationId((process: Process) => process.updater)
+  updaterId?: string
+
+  @HistoryOriginalIdColumn()
+  public originalId!: string
+
+  @HistoryActionColumn({
+    nullable: false,
+    type:
+      DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? 'enum'
+        : DATABASE_TYPE == 'oracle'
+          ? 'varchar2'
+          : DATABASE_TYPE == 'mssql'
+            ? 'nvarchar'
+            : 'varchar',
+    enum:
+      DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
+        ? HistoryActionType
+        : undefined,
+    length: DATABASE_TYPE == 'postgres' || DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb' ? undefined : 10
+  })
+  public action!: HistoryActionType
+}

package/server/service/process/process-mutation.ts

@@ -0,0 +1,210 @@
+import { Arg, Ctx, Directive, Mutation, Resolver } from 'type-graphql'
+import { In } from 'typeorm'
+
+import { createAttachment, deleteAttachmentsByRef } from '@things-factory/attachment-base'
+import { Application, CallbackBase, registerSchedule, unregisterSchedule } from '@things-factory/scheduler-client'
+
+import { Process } from './process'
+import { ProcessPatch, NewProcess } from './process-type'
+
+@Resolver(Process)
+export class ProcessMutation {
+  @Directive('@transaction')
+  @Directive('@privilege(category: "process", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => Process, { description: 'To create new Process' })
+  async createProcess(@Arg('process') process: NewProcess, @Ctx() context: ResolverContext): Promise<Process> {
+    const { domain, user, tx } = context.state
+
+    const result = await tx.getRepository(Process).save({
+      ...process,
+      domain,
+      creator: user,
+      updater: user
+    })
+
+    if (process.thumbnail) {
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: process.thumbnail,
+            refType: Process.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Directive('@privilege(category: "process", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => Process, { description: 'To modify Process information' })
+  async updateProcess(
+    @Arg('id') id: string,
+    @Arg('patch') patch: ProcessPatch,
+    @Ctx() context: ResolverContext
+  ): Promise<Process> {
+    const { domain, user, tx } = context.state
+
+    const repository = tx.getRepository(Process)
+    const process = await repository.findOne({
+      where: { domain: { id: domain.id }, id },
+      /* history에 항상 반영될 수 있도록 relations가 있어야 함. */
+      relations: ['domain', 'issuerRole', 'supervisoryRole', 'creator', 'updater']
+    })
+
+    const result = await repository.save({
+      ...process,
+      ...patch,
+      updater: user
+    })
+
+    if (patch.thumbnail) {
+      await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: patch.thumbnail,
+            refType: Process.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Directive('@privilege(category: "process", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => [Process], { description: "To modify multiple Processes' information" })
+  async updateMultipleProcess(
+    @Arg('patches', type => [ProcessPatch]) patches: ProcessPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<Process[]> {
+    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 processRepo = tx.getRepository(Process)
+
+    if (_createRecords.length > 0) {
+      for (let i = 0; i < _createRecords.length; i++) {
+        const newRecord = _createRecords[i]
+
+        const result = await processRepo.save({
+          ...newRecord,
+          domain,
+          creator: user,
+          updater: user
+        })
+
+        if (newRecord.thumbnail) {
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: newRecord.thumbnail,
+                refType: Process.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: '+' })
+      }
+    }
+
+    if (_updateRecords.length > 0) {
+      for (let i = 0; i < _updateRecords.length; i++) {
+        const updateRecord = _updateRecords[i]
+        const process = await processRepo.findOne({
+          where: { id: updateRecord.id },
+          /* history에 항상 반영될 수 있도록 relations가 있어야 함. */
+          relations: ['domain', 'issuerRole', 'supervisoryRole', 'creator', 'updater']
+        })
+
+        const result = await processRepo.save({
+          ...process,
+          ...updateRecord,
+          updater: user
+        })
+
+        if (updateRecord.thumbnail) {
+          await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: updateRecord.thumbnail,
+                refType: Process.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: 'M' })
+      }
+    }
+
+    return results
+  }
+
+  @Directive('@transaction')
+  @Directive('@privilege(category: "process", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => Boolean, { description: 'To delete Process' })
+  async deleteProcess(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(Process).delete({ domain: { id: domain.id }, id })
+    await deleteAttachmentsByRef(null, { refBys: [id] }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple Processes' })
+  async deleteProcesses(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(Process).delete({
+      domain: { id: domain.id },
+      id: In(ids)
+    })
+
+    await deleteAttachmentsByRef(null, { refBys: ids }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Directive('@privilege(category: "process", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => Boolean, { description: 'To import multiple Processes' })
+  async importProcesses(
+    @Arg('processes', type => [ProcessPatch]) processes: ProcessPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await Promise.all(
+      processes.map(async (process: ProcessPatch) => {
+        const createdProcess: Process = await tx.getRepository(Process).save({ domain, ...process })
+      })
+    )
+
+    return true
+  }
+}

package/server/service/process/process-query.ts

@@ -0,0 +1,120 @@
+import { Arg, Args, Ctx, Directive, FieldResolver, Query, Resolver, Root } from 'type-graphql'
+
+import { Attachment } from '@things-factory/attachment-base'
+import { Role, User } from '@things-factory/auth-base'
+import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
+
+import { Process } from './process'
+import { ProcessList } from './process-type'
+
+@Resolver(Process)
+export class ProcessQuery {
+  @Directive('@privilege(category: "process", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => Process!, { nullable: true, description: 'To fetch a Process' })
+  async process(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<Process> {
+    const { domain } = context.state
+
+    return await getRepository(Process).findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+  }
+
+  @Directive('@privilege(category: "process", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => Process!, { nullable: true, description: 'To fetch a Process by name' })
+  async processByName(@Arg('name') name: string, @Ctx() context: ResolverContext): Promise<Process> {
+    const { domain } = context.state
+
+    return await getRepository(Process).findOne({
+      where: { domain: { id: domain.id }, name }
+    })
+  }
+
+  @Directive('@privilege(category: "process", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => ProcessList, { description: 'To fetch multiple Processes' })
+  async processes(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<ProcessList> {
+    const { domain } = context.state
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      domain,
+      params,
+      repository: getRepository(Process),
+      alias: 'process',
+      searchables: ['name', 'description', 'supervisoryRole']
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
+  @Directive('@privilege(category: "process", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => ProcessList, { description: 'To fetch the list of processes that I can report on' })
+  async supervisableProcesses(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<ProcessList> {
+    var { domain, user } = context.state
+
+    /* 조회한 사용자가 assigner 역할을 가진 process-instance 리스트만 반환 */
+    user = await getRepository(User).findOne({
+      where: { id: user.id },
+      relations: ['roles']
+    })
+    const roles = user.roles.filter(role => role.domainId === domain.id).map(role => role.id)
+
+    if (!roles.length) {
+      return { items: [], total: 0 }
+    }
+
+    const [items, total] = await getQueryBuilderFromListParams({
+      repository: getRepository(Process),
+      params,
+      domain,
+      alias: 'process',
+      searchables: ['name', 'description']
+    })
+      .andWhere(`process.supervisoryRole IN (:...roles)`, { roles })
+      .getManyAndCount()
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => Role)
+  async supervisoryRole(@Root() process: Process): Promise<Role> {
+    return (
+      process.supervisoryRole ||
+      (process.supervisoryRoleId &&
+        (await getRepository(Role).findOneBy({
+          id: process.supervisoryRoleId
+        })))
+    )
+  }
+
+  @FieldResolver(type => String)
+  async thumbnail(@Root() process: Process): Promise<string | undefined> {
+    const attachment: Attachment = await getRepository(Attachment).findOne({
+      where: {
+        domain: { id: process.domainId },
+        refType: Process.name,
+        refBy: process.id
+      }
+    })
+
+    return attachment?.fullpath
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() process: Process): Promise<Domain> {
+    return await getRepository(Domain).findOneBy({ id: process.domainId })
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() process: Process): Promise<User> {
+    return await getRepository(User).findOneBy({ id: process.updaterId })
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() process: Process): Promise<User> {
+    return await getRepository(User).findOneBy({ id: process.creatorId })
+  }
+}

package/server/service/process/process-search-key-item-type.ts

@@ -0,0 +1,16 @@
+import { Field, ObjectType } from 'type-graphql'
+
+@ObjectType({ description: 'Entity for ProcessSearchKeyItem' })
+export class ProcessSearchKeyItem {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field({ nullable: true })
+  inputKey: string
+
+  @Field({ nullable: true })
+  tKey?: string
+}

package/server/service/process/process-type.ts

@@ -0,0 +1,65 @@
+import type { FileUpload } from 'graphql-upload/GraphQLUpload.js'
+import GraphQLUpload from 'graphql-upload/GraphQLUpload.js'
+import { Field, ID, InputType, Int, ObjectType } from 'type-graphql'
+
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { Process, ProcessStatus } from './process'
+import { ProcessSearchKeyItem } from './process-search-key-item-type'
+
+@InputType()
+export class NewProcess {
+  @Field()
+  name: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => ScalarObject, { nullable: true })
+  searchKeys?: ProcessSearchKeyItem[]
+
+  @Field({ nullable: true })
+  state?: ProcessStatus
+
+  @Field(type => ObjectRef, { nullable: true })
+  supervisoryRole?: ObjectRef
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+}
+
+@InputType()
+export class ProcessPatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field({ nullable: true })
+  name?: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field(type => ScalarObject, { nullable: true })
+  searchKeys?: ProcessSearchKeyItem[]
+
+  @Field({ nullable: true })
+  state?: ProcessStatus
+
+  @Field(type => ObjectRef, { nullable: true })
+  supervisoryRole?: ObjectRef
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+
+  @Field({ nullable: true })
+  cuFlag?: string
+}
+
+@ObjectType()
+export class ProcessList {
+  @Field(type => [Process])
+  items: Process[]
+
+  @Field(type => Int)
+  total: number
+}

package/server/service/process/process.ts

@@ -0,0 +1,97 @@
+import { Field, ID, ObjectType, registerEnumType } from 'type-graphql'
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  RelationId,
+  UpdateDateColumn,
+  VersionColumn
+} from 'typeorm'
+
+import { Role, User } from '@things-factory/auth-base'
+import { Domain } from '@things-factory/shell'
+
+import { ProcessSearchKeyItem } from './process-search-key-item-type'
+
+export enum ProcessStatus {
+  Draft = 'draft',
+  Released = 'released',
+  Deprecated = 'deprecated'
+}
+
+registerEnumType(ProcessStatus, {
+  name: 'ProcessStatus',
+  description: 'state enumeration of a process'
+})
+
+@Entity()
+@Index('ix_process_0', (process: Process) => [process.domain, process.name], { unique: true })
+@Index('ix_process_1', (process: Process) => [process.domain, process.state], { unique: false })
+@ObjectType({ description: 'Entity for Process' })
+export class Process {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @VersionColumn()
+  @Field({ nullable: true })
+  version?: number = 1
+
+  @ManyToOne(type => Domain)
+  @Field(type => Domain, { nullable: true })
+  domain?: Domain
+
+  @RelationId((process: Process) => process.domain)
+  domainId?: string
+
+  @Column()
+  @Field({ nullable: true })
+  name?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  description?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  state?: ProcessStatus
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => [ProcessSearchKeyItem], { nullable: true })
+  searchKeys?: ProcessSearchKeyItem[]
+
+  @ManyToOne(type => Role, { nullable: true })
+  @Field(type => Role, { nullable: true, description: 'The final authority on a given process.' })
+  supervisoryRole?: Role
+
+  @RelationId((process: Process) => process.supervisoryRole)
+  supervisoryRoleId?: string
+
+  @CreateDateColumn()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @UpdateDateColumn()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  creator?: User
+
+  @RelationId((process: Process) => process.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  updater?: User
+
+  @RelationId((process: Process) => process.updater)
+  updaterId?: string
+
+  @Field(type => String, { nullable: true })
+  thumbnail?: string
+}

package/server/service/process-instance/event-subscriber.ts

@@ -0,0 +1,44 @@
+import { EventSubscriber, EntitySubscriberInterface, InsertEvent, UpdateEvent } from 'typeorm'
+
+import { HistoryEntitySubscriber } from '@operato/typeorm-history'
+import { pubsub } from '@things-factory/shell'
+
+import { ProcessInstance } from './process-instance'
+import { ProcessInstanceHistory } from './process-instance-history'
+
+@EventSubscriber()
+export class ProcessInstanceSubscriber implements EntitySubscriberInterface<ProcessInstance> {
+  listenTo() {
+    return ProcessInstance
+  }
+
+  async afterInsert(event: InsertEvent<ProcessInstance>): Promise<any | void> {
+    const { entity: processInstance, manager: tx } = event
+
+    pubsub.publish('process-instance', {
+      processInstance
+    })
+  }
+
+  async afterUpdate(event: UpdateEvent<ProcessInstance>): Promise<any | void> {
+    const { entity: processInstance, manager: tx } = event
+
+    pubsub.publish('process-instance', {
+      processInstance
+    })
+  }
+}
+
+@EventSubscriber()
+export class ProcessInstanceHistoryEntitySubscriber extends HistoryEntitySubscriber<
+  ProcessInstance,
+  ProcessInstanceHistory
+> {
+  public get entity() {
+    return ProcessInstance
+  }
+
+  public get historyEntity() {
+    return ProcessInstanceHistory
+  }
+}

package/server/service/process-instance/index.ts

@@ -0,0 +1,10 @@
+import { ProcessInstance } from './process-instance'
+import { ProcessInstanceHistory } from './process-instance-history'
+import { ProcessInstanceMutation } from './process-instance-mutation'
+import { ProcessInstanceQuery } from './process-instance-query'
+import { ProcessInstanceSubscription } from './process-instance-subscription'
+import { ProcessInstanceHistoryEntitySubscriber, ProcessInstanceSubscriber } from './event-subscriber'
+
+export const entities = [ProcessInstance, ProcessInstanceHistory]
+export const resolvers = [ProcessInstanceQuery, ProcessInstanceMutation, ProcessInstanceSubscription]
+export const subscribers = [ProcessInstanceSubscriber, ProcessInstanceHistoryEntitySubscriber]