@things-factory/dataset 7.1.11 → 7.1.12-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/dataset",
-  "version": "7.1.11",
+  "version": "7.1.12-alpha.0",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -40,21 +40,21 @@
     "@operato/shell": "^7.0.0",
     "@operato/styles": "^7.0.0",
     "@operato/utils": "^7.0.0",
-    "@things-factory/auth-base": "^7.1.11",
-    "@things-factory/aws-base": "^7.1.11",
-    "@things-factory/board-service": "^7.1.11",
-    "@things-factory/env": "^7.1.11",
-    "@things-factory/integration-base": "^7.1.11",
-    "@things-factory/organization": "^7.1.11",
-    "@things-factory/personalization": "^7.1.11",
-    "@things-factory/scheduler-client": "^7.1.11",
-    "@things-factory/shell": "^7.1.11",
-    "@things-factory/work-shift": "^7.1.11",
-    "@things-factory/worklist": "^7.1.11",
+    "@things-factory/auth-base": "^7.1.12-alpha.0",
+    "@things-factory/aws-base": "^7.1.12-alpha.0",
+    "@things-factory/board-service": "^7.1.12-alpha.0",
+    "@things-factory/env": "^7.1.12-alpha.0",
+    "@things-factory/integration-base": "^7.1.12-alpha.0",
+    "@things-factory/organization": "^7.1.12-alpha.0",
+    "@things-factory/personalization": "^7.1.12-alpha.0",
+    "@things-factory/scheduler-client": "^7.1.12-alpha.0",
+    "@things-factory/shell": "^7.1.12-alpha.0",
+    "@things-factory/work-shift": "^7.1.12-alpha.0",
+    "@things-factory/worklist": "^7.1.12-alpha.0",
     "cron-parser": "^4.3.0",
     "moment-timezone": "^0.5.45",
     "simple-statistics": "^7.8.3",
     "statistics": "^3.3.0"
   },
-  "gitHead": "039ece6ca36faf7fcfadb53c4f6335f584692968"
+  "gitHead": "2be45c33868b2cc01d55b7b540b9a4877805ff8a"
 }

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

@@ -1,5 +1,5 @@
 import { Arg, Args, Ctx, Directive, FieldResolver, Query, Resolver, Root } from 'type-graphql'
-import { In } from 'typeorm'
+import { Brackets, In } from 'typeorm'
 
 import { Attachment } from '@things-factory/attachment-base'
 import { Role, User } from '@things-factory/auth-base'
@@ -19,6 +19,7 @@ var parser = require('cron-parser')
 
 @Resolver(DataSet)
 export class DataSetQuery {
+  // 데이터셋을 ID로 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSet, { description: 'To fetch a DataSet' })
   async dataSet(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<DataSet> {
@@ -29,6 +30,7 @@ export class DataSetQuery {
     })
   }
 
+  // 데이터셋을 이름으로 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSet, { description: 'To fetch a DataSet by name' })
   async dataSetByName(@Arg('name') name: string, @Ctx() context: ResolverContext): Promise<DataSet> {
@@ -39,6 +41,7 @@ export class DataSetQuery {
     })
   }
 
+  // 여러 데이터셋을 조회
   @Directive('@privilege(category: "data-set", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets' })
   async dataSets(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<DataSetList> {
@@ -57,6 +60,7 @@ export class DataSetQuery {
     return { items, total }
   }
 
+  // 데이터 입력을 위한 데이터셋 조회
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets for data entry manually' })
   async dataSetsForEntry(
     @Args(type => ListParam) params: ListParam,
@@ -64,7 +68,7 @@ export class DataSetQuery {
   ): Promise<DataSetList> {
     var { domain, user } = context.state
 
-    /* 조회한 사용자가 entry-role을 가진 data-set 리스트만 반환 */
+    // 조회한 사용자가 entry-role을 가진 data-set 리스트만 반환
     user = await getRepository(User).findOne({
       where: { id: user.id },
       relations: ['roles']
@@ -86,12 +90,23 @@ export class DataSetQuery {
       searchables: ['name', 'description']
     })
       .andWhere('dataset.active = :active', { active: true })
-      .andWhere('dataset.entryRole IN (:...roles)', { roles })
+      .andWhere(
+        new Brackets(qb => {
+          qb.where('dataset.supervisoryRole IN (:...roles)', { roles }).orWhere('dataset.entryRole IN (:...roles)', {
+            roles
+          })
+        })
+      )
+      .setParameter('roles', roles)
       .getManyAndCount()
 
-    return { items, total }
+    return {
+      items,
+      total
+    }
   }
 
+  // 데이터 보고를 위한 데이터셋 조회
   @Query(returns => DataSetList, { description: 'To fetch multiple DataSets to see data report' })
   async dataSetsForReport(
     @Args(type => ListParam) params: ListParam,
@@ -99,7 +114,7 @@ export class DataSetQuery {
   ): Promise<DataSetList> {
     var { domain, user } = context.state
 
-    /* 조회한 사용자가 supervisory 역할을 가진 data-set 리스트만 반환 */
+    // 조회한 사용자가 supervisory 역할을 가진 data-set 리스트만 반환
     user = await getRepository(User).findOne({
       where: { id: user.id },
       relations: ['roles']
@@ -124,9 +139,10 @@ export class DataSetQuery {
     return { items, total }
   }
 
+  // 데이터셋의 상태를 조회
   @FieldResolver(type => DataSetState)
   async status(@Root() dataSet: DataSet): Promise<DataSetState> {
-    // get information from scheduler service
+    // 스케줄러 서비스에서 정보 가져오기
     return {
       id: '',
       scheduleId: '',
@@ -136,6 +152,7 @@ export class DataSetQuery {
     }
   }
 
+  // 데이터셋의 데이터 항목을 조회
   @FieldResolver(type => [DataItem])
   async dataItems(@Root() dataSet: DataSet): Promise<DataItem[]> {
     if (dataSet.dataItems instanceof Array) {
@@ -145,6 +162,7 @@ export class DataSetQuery {
     return []
   }
 
+  // 데이터셋의 entry 역할을 조회
   @FieldResolver(type => Role)
   async entryRole(@Root() dataSet: DataSet): Promise<Role> {
     return (
@@ -156,7 +174,8 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Role)
+  // 데이터셋의 supervisory 역할을 조회
+  @FieldResolver(type => Role, { description: 'Retrieves the supervisory role for the dataset' })
   async supervisoryRole(@Root() dataSet: DataSet): Promise<Role> {
     return (
       dataSet.supervisoryRole ||
@@ -167,7 +186,7 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => [AssigneeItem])
+  @FieldResolver(type => [AssigneeItem], { description: 'Retrieves the assignee items for the dataset' })
   async assignees(@Root() dataSet: DataSet, @Ctx() context: ResolverContext): Promise<AssigneeItem[]> {
     const { domain, user } = context.state
     const { assignees } = dataSet
@@ -208,7 +227,7 @@ export class DataSetQuery {
     return assigneeItemList
   }
 
-  @FieldResolver(type => [ApprovalLineItem])
+  @FieldResolver(type => [ApprovalLineItem], { description: 'Retrieves the approval line items for the dataset' })
   async approvalLine(@Root() dataSet: DataSet, @Ctx() context: ResolverContext): Promise<ApprovalLineItem[]> {
     const { domain, user } = context.state
     const { reviewApprovalLine } = dataSet
@@ -250,21 +269,21 @@ export class DataSetQuery {
     return approvalLineItems
   }
 
-  @FieldResolver(type => Board, { nullable: true })
+  @FieldResolver(type => Board, { nullable: true, description: 'Retrieves the entry board for the dataset' })
   async entryBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.entryType == 'board' && dataSet.entryView) {
       return await getRepository(Board).findOneBy({ id: dataSet.entryView })
     }
   }
 
-  @FieldResolver(type => Board, { nullable: true })
+  @FieldResolver(type => Board, { nullable: true, description: 'Retrieves the monitor board for the dataset' })
   async monitorBoard(@Root() dataSet: DataSet): Promise<Board> {
     if (dataSet.monitorType == 'board' && dataSet.monitorView) {
       return await getRepository(Board).findOneBy({ id: dataSet.monitorView })
     }
   }
 
-  @FieldResolver(type => DataKeySet, { nullable: true })
+  @FieldResolver(type => DataKeySet, { nullable: true, description: 'Retrieves the data key set for the dataset' })
   async dataKeySet(@Root() dataSet: DataSet): Promise<DataKeySet> {
     return (
       dataSet.dataKeySet ||
@@ -275,7 +294,7 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Scenario)
+  @FieldResolver(type => Scenario, { description: 'Retrieves the normal scenario for the dataset.' })
   async normalScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.normalScenario ||
@@ -286,7 +305,7 @@ export class DataSetQuery {
     )
   }
 
-  @FieldResolver(type => Scenario)
+  @FieldResolver(type => Scenario, { description: 'Retrieves the outlier scenario for the dataset.' })
   async outlierScenario(@Root() dataSet: DataSet): Promise<Scenario> {
     return (
       dataSet.outlierScenario ||
@@ -297,22 +316,25 @@ export class DataSetQuery {
     )
   }
 
+  // 데이터셋의 도메인을 조회
   @FieldResolver(type => Domain)
   async domain(@Root() dataSet: DataSet): Promise<Domain> {
     return dataSet.domainId && (await getRepository(Domain).findOneBy({ id: dataSet.domainId }))
   }
 
+  // 데이터셋의 업데이트한 사용자를 조회
   @FieldResolver(type => User)
   async updater(@Root() dataSet: DataSet): Promise<User> {
     return dataSet.updaterId && (await getRepository(User).findOneBy({ id: dataSet.updaterId }))
   }
 
+  // 데이터셋의 생성자를 조회
   @FieldResolver(type => User)
   async creator(@Root() dataSet: DataSet): Promise<User> {
     return dataSet.creatorId && (await getRepository(User).findOneBy({ id: dataSet.creatorId }))
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the latest collection time for the dataset.' })
   async latestCollectedAt(@Root() dataSet: DataSet): Promise<Date> {
     const sample = await getRepository(DataSample).findOne({
       select: ['id', 'collectedAt'],
@@ -323,7 +345,7 @@ export class DataSetQuery {
     return sample?.collectedAt
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the next schedule time for the dataset.' })
   async nextSchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, schedule, timezone } = dataSet
 
@@ -338,7 +360,7 @@ export class DataSetQuery {
     return interval.next().toDate()
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, { nullable: true, description: 'Retrieves the previous schedule time for the dataset.' })
   async prevSchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, schedule, timezone } = dataSet
 
@@ -353,7 +375,10 @@ export class DataSetQuery {
     return interval.prev().toDate()
   }
 
-  @FieldResolver(type => Date, { nullable: true })
+  @FieldResolver(type => Date, {
+    nullable: true,
+    description: 'Retrieves the next summary schedule time for the dataset.'
+  })
   async nextSummarySchedule(@Root() dataSet: DataSet): Promise<Date> {
     const { domainId, summarySchedule, timezone } = dataSet
 
@@ -367,20 +392,19 @@ export class DataSetQuery {
 
     return interval.next().toDate()
 
-    // /* FIXME: getSchedules 의 파라미터를 수정해야한다. scheduler 가 없거나 커넥션이 끊겨있어서 오래걸리는 문제는 어떻게 ?? 비동기로 처리한다. 어떻게???
-    //   client: {
-    //     application: Application,
-    //     group: `${domain.id}`,
-    //     type: 'data-set',
-    //     key: dataSet.id,
-    //     operation: 'summary'
-    //   },
-    // */
+    // FIXME: getSchedules 의 파라미터를 수정해야한다. scheduler 가 없거나 커넥션이 끊겨있어서 오래걸리는 문제는 어떻게 ?? 비동기로 처리한다. 어떻게???
+    // client: {
+    //   application: Application,
+    //   group: `${domain.id}`,
+    //   type: 'data-set',
+    //   key: dataSet.id,
+    //   operation: 'summary'
+    // }
     // const schedule = getSchedules('name', 'group', false)
     // return schedule.nextSchedule
   }
 
-  @FieldResolver(type => String)
+  @FieldResolver(type => String, { description: 'Retrieves the report template for the dataset.' })
   async reportTemplate(@Root() dataset: DataSet): Promise<string | undefined> {
     const attachment: Attachment = await getRepository(Attachment).findOne({
       where: {
@@ -392,4 +416,36 @@ export class DataSetQuery {
 
     return attachment?.path
   }
+
+  @FieldResolver(returns => Boolean, { description: 'Whether the user is a supervisor for this dataset' })
+  async isSupervisor(@Root() dataset: DataSet, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { user, domain } = context.state
+
+    const foundUser = await getRepository(User).findOne({
+      where: { id: user.id },
+      relations: ['roles']
+    })
+
+    const roles = foundUser.roles
+      .filter(role => role.domainId === domain.id || (domain.parentId && role.domainId === domain.parentId))
+      .map(role => role.id)
+
+    return roles.includes(dataset.supervisoryRoleId)
+  }
+
+  @FieldResolver(returns => Boolean, { description: 'Whether the user is allowed to enter data for this dataset' })
+  async isEntryAllowed(@Root() dataset: DataSet, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { user, domain } = context.state
+
+    const foundUser = await getRepository(User).findOne({
+      where: { id: user.id },
+      relations: ['roles']
+    })
+
+    const roles = foundUser.roles
+      .filter(role => role.domainId === domain.id || (domain.parentId && role.domainId === domain.parentId))
+      .map(role => role.id)
+
+    return roles.includes(dataset.entryRoleId)
+  }
 }