@things-factory/dataset 6.0.82 → 6.0.84

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/dataset",
-  "version": "6.0.82",
+  "version": "6.0.84",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -50,5 +50,5 @@
     "simple-statistics": "^7.8.3",
     "statistics": "^3.3.0"
   },
-  "gitHead": "6cd2a84db2c9ad8d9e75ecbdfcc53df1b20cf79f"
+  "gitHead": "b858eba746efe1b59c54bb2e0f4b3b5e67ee8741"
 }

package/server/controllers/generate-data-summary.ts

@@ -1,7 +1,6 @@
 const statistics = require('simple-statistics')
 const deepClone = require('lodash/cloneDeep')
 
-import { Between } from 'typeorm'
 import moment from 'moment-timezone'
 
 import { Sorting, getQueryBuilderFromListParams } from '@things-factory/shell'

package/server/controllers/query-data-summary-by-period.ts

@@ -0,0 +1,200 @@
+import moment from 'moment-timezone'
+
+import { getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
+
+import { DataSet, DataSetSummaryPeriodType } from '../service/data-set/data-set'
+
+import { DataSummary } from '../service/data-summary/data-summary'
+import { DataSummaryList } from '../service/data-summary/data-summary-type'
+
+const STAT_FUNCTION_MAP = {
+  sum: 'sum',
+  mean: 'mean',
+  stddev: 'standardDeviation',
+  variance: 'variance',
+  min: 'min',
+  max: 'max',
+  range: 'range',
+  median: 'median',
+  mode: 'mode'
+}
+
+async function getTimesForPeriod(
+  period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',
+  context: ResolverContext
+): Promise<{ from: string; to: string }> {
+  const { domain } = context.state
+  const theDate = moment.tz(new Date(), domain.timezone)
+
+  if (period == 'today') {
+    const from = theDate.clone().format('YYYY-MM-DD')
+    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')
+
+    return { from, to }
+  } else if (period == 'this month') {
+    const from = theDate.clone().startOf('month').format('YYYY-MM-DD')
+    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')
+
+    return { from, to }
+  } else if (period == '30 days') {
+    const from = theDate.clone().subtract(30, 'day').format('YYYY-MM-DD')
+    const to = theDate.clone().add(1, 'day').startOf('day').format('YYYY-MM-DD')
+
+    return { from, to }
+  } else if (period == 'this year') {
+    const from = theDate.clone().startOf('year').format('YYYY-MM-DD')
+    const to = theDate.clone().add(1, 'year').startOf('year').format('YYYY-MM-DD')
+
+    return { from, to }
+  } else if (period == '12 months') {
+    const from = theDate.clone().subtract(12, 'month').startOf('month').format('YYYY-MM-DD')
+    const to = theDate.clone().add(1, 'month').startOf('month').format('YYYY-MM-DD')
+
+    return { from, to }
+  }
+}
+
+export async function queryDataSummaryByPeriod(
+  period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',
+  dataSetName: string,
+  params: ListParam,
+  context: ResolverContext
+): Promise<DataSummary[]> {
+  const { domain, user, tx } = context.state
+
+  const dataSet = await getRepository(DataSet).findOne({
+    where: { domain: { id: domain.id }, name: dataSetName },
+    relations: ['dataKeySet']
+  })
+
+  if (!dataSet) {
+    throw new Error(`dataSet not found by the given dataSetName(${dataSetName})`)
+  }
+
+  // 주어진 기간에 따라서, date의 범위를 구한다.
+  // day : 시간별 서머리를 제공한다. 'today'
+  // month : 일별 서머리를 제공한다. 'this month', '30 days'
+  // year : 월별 서머리를 제공한다. 'this year', '12 months'
+
+  // limitations
+  const summaryPeriodType = dataSet.summaryPeriod
+  if (
+    (summaryPeriodType == DataSetSummaryPeriodType.Day || summaryPeriodType == DataSetSummaryPeriodType.WorkDate) &&
+    period == 'today'
+  ) {
+    throw new Error(`given dataSet(${dataSetName}) is not allowed for getting summary for ${period}`)
+  }
+
+  const dataKeyItems = dataSet.dataKeySet?.dataKeyItems || []
+  const searchables = dataKeyItems.map((item, index) => `key0${index + 1}`)
+  const dataItems = dataSet.dataItems.filter(item => item.stat)
+
+  const { from, to } = await getTimesForPeriod(period, context)
+
+  const selectPeriod =
+    period == 'today'
+      ? ['summary.date', 'summary.period']
+      : ['this year', '12 months'].includes(period)
+      ? ['SUBSTRING(summary.date, 1, 7) AS month']
+      : ['summary.date']
+  const selectKeys = dataKeyItems.map((item, index) => {
+    const aliasName = `key0${index + 1}`
+    const columnName = `summary.${aliasName}`
+
+    return `${columnName} as ${aliasName}`
+  }) as string[]
+  const selectData = dataItems.map((item, index) => {
+    const aliasName = `data0${index + 1}`
+    const columnName = `summary.${aliasName}`
+
+    switch (item.stat) {
+      case STAT_FUNCTION_MAP.sum:
+        return `SUM(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.mean:
+        // 일차 mean 된 값들을 다시 계산하므로, 무의미할 수 있다.
+        return `AVG(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.stddev:
+        // 일차 stddev 된 값들을 다시 계산하므로, 무의미할 수 있다.
+        return `STDDEV(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.variance:
+        // 일차 variance 된 값들을 다시 계산하므로, 무의미할 수 있다.
+        return `VARIANCE(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.min:
+        return `MIN(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.max:
+        return `MAX(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.range:
+        // 일차 range 값들을 다시 계산하므로, 무의미할 수 있다.
+        return `MAX(${columnName}) - MIN(${columnName}) as ${aliasName}`
+      case STAT_FUNCTION_MAP.mode:
+        // not guaranteed
+        return `MODE() WITHIN GROUP (ORDER BY ${columnName})`
+      default:
+        return `AVG(${columnName}) as ${aliasName}`
+    }
+  })
+
+  const groupByPeriod =
+    period == 'today'
+      ? 'summary.date, summary.period'
+      : ['this year', '12 months'].includes(period)
+      ? 'month'
+      : 'summary.date'
+  const groupByKeys = dataKeyItems
+    .map((item, index) => {
+      return `summary.key0${index + 1}`
+    })
+    .join(' ')
+
+  const orderByPeriod: { sort: string; order: 'DESC' | 'ASC' }[] =
+    period == 'today'
+      ? [
+          {
+            sort: 'summary.date',
+            order: 'DESC'
+          },
+          {
+            sort: 'summary.period',
+            order: 'DESC'
+          }
+        ]
+      : ['this year', '12 months'].includes(period)
+      ? [{ sort: 'month', order: 'DESC' }]
+      : [{ sort: 'summary.date', order: 'DESC' }]
+
+  const queryBuilder = getQueryBuilderFromListParams({
+    repository: getRepository(DataSummary),
+    params,
+    domain,
+    alias: 'summary',
+    searchables: ['name', 'description'].concat(searchables)
+  })
+    .select('summary.dataSet')
+    .addSelect('ds.name', 'name')
+    .addSelect('ds.description', 'description')
+    .addSelect('summary.date', 'date')
+    .addSelect('summary.period', 'period')
+    .addSelect(selectPeriod)
+    .addSelect(selectKeys)
+    .addSelect(selectData)
+    .addSelect('SUM(summary.count)', 'count')
+    .addSelect('SUM(summary.countOoc)', 'countOoc')
+    .addSelect('SUM(summary.countOos)', 'countOos')
+    .innerJoin('summary.dataSet', 'ds', 'ds.id = :dataSetName', {
+      dataSetName: dataSet.id
+    })
+    .andWhere('summary.domain = :domain', { domain: domain.id })
+    .andWhere('summary.date >= :from', { from })
+    .andWhere('summary.date < :to', { to })
+    .addGroupBy(groupByPeriod)
+    .addGroupBy(groupByKeys)
+
+  orderByPeriod.map(orderBy => {
+    const { sort, order } = orderBy
+    queryBuilder.addOrderBy(sort, order)
+  })
+
+  const items = await queryBuilder.getRawMany()
+
+  return items
+}

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

@@ -4,9 +4,9 @@ import { User } from '@things-factory/auth-base'
 import { DataKeySet } from '../data-key-set/data-key-set'
 import { DataItem } from '../data-set/data-item-type'
 import { DataSet } from '../data-set/data-set'
-import { DataSetHistory } from '../data-set-history/data-set-history'
 import { DataSummary } from './data-summary'
-import { DataSummaryList } from './data-summary-type'
+import { DataSummaryList, DynamicDataSummary } from './data-summary-type'
+import { queryDataSummaryByPeriod } from '../../controllers/query-data-summary-by-period'
 
 @Resolver(DataSummary)
 export class DataSummaryQuery {
@@ -35,6 +35,52 @@ export class DataSummaryQuery {
     return { items, total }
   }
 
+  @Query(returns => [DynamicDataSummary], { description: 'To fetch multiple dynamically grouped DataSummaries' })
+  async dataSummaryByPeriod(
+    @Arg('period') period: 'today' | 'this month' | '30 days' | 'this year' | '12 months',
+    @Arg('dataSetName') dataSetName: string,
+    @Args() params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<DynamicDataSummary[]> {
+    return await queryDataSummaryByPeriod(period, dataSetName, params, context)
+  }
+
+  @Directive('@privilege(category: "data-summary", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => DataSummaryList, { description: 'To fetch multiple data summaries by data set name' })
+  async dataSummariesByDataSetName(
+    @Arg('dataSetName') dataSetName: string,
+    @Args() params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<DataSummaryList> {
+    const { domain } = context.state
+
+    const dataSet = await getRepository(DataSet).findOne({
+      where: { domain: { id: domain.id }, name: dataSetName },
+      relations: ['dataKeySet']
+    })
+
+    if (!dataSet) {
+      throw new Error(`dataSet not found by the given dataSetName(${dataSetName})`)
+    }
+
+    const dataKeyItems = dataSet.dataKeySet?.dataKeyItems || []
+    const searchables = dataKeyItems.map((item, index) => `key0${index + 1}`)
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      repository: getRepository(DataSummary),
+      params,
+      domain,
+      alias: 'summary',
+      searchables: ['name', 'description'].concat(searchables)
+    }).innerJoin('summary.dataSet', 'ds', 'ds.id = :dataSetName', {
+      dataSetName: dataSet.id
+    })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
   @Directive('@privilege(category: "data-summary", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => DataSummaryList, { description: 'To fetch multiple data summaries by data set' })
   async dataSummariesByDataSet(

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

@@ -25,6 +25,63 @@ export class DataSummaryPatch {
   cuFlag?: string
 }
 
+@ObjectType()
+export class DynamicDataSummary {
+  @Field({ nullable: true })
+  name?: string
+
+  @Field({ nullable: true })
+  description?: string
+
+  @Field({ nullable: true })
+  month?: string = ''
+
+  @Field({ nullable: true })
+  date?: string = ''
+
+  @Field({ nullable: true })
+  period?: string = ''
+
+  @Field({ nullable: true })
+  count?: number
+
+  @Field({ nullable: true })
+  countOoc?: number
+
+  @Field({ nullable: true })
+  countOos?: number
+
+  @Field({ nullable: true })
+  key01?: string = ''
+
+  @Field({ nullable: true })
+  key02?: string = ''
+
+  @Field({ nullable: true })
+  key03?: string = ''
+
+  @Field({ nullable: true })
+  key04?: string = ''
+
+  @Field({ nullable: true })
+  key05?: string = ''
+
+  @Field({ nullable: true })
+  data01?: number
+
+  @Field({ nullable: true })
+  data02?: number
+
+  @Field({ nullable: true })
+  data03?: number
+
+  @Field({ nullable: true })
+  data04?: number
+
+  @Field({ nullable: true })
+  data05?: number
+}
+
 @ObjectType()
 export class DataSummaryList {
   @Field(type => [DataSummary])

package/things-factory.config.js

@@ -28,6 +28,10 @@ export default {
       tagname: 'data-summary-search-page',
       page: 'data-summary-search'
     },
+    {
+      tagname: 'data-summary-period-page',
+      page: 'data-summary-period'
+    },
     {
       tagname: 'data-ooc-view-page',
       page: 'data-ooc'

package/translations/en.json

@@ -15,6 +15,7 @@
   "field.data-sample": "data sample",
   "field.data-set": "data set",
   "field.date": "date",
+  "field.month": "month",
   "field.device-id": "device id",
   "field.download-url": "download url",
   "field.entry-role": "entry role",
@@ -104,6 +105,7 @@
   "title.data-sample search": "data sample search",
   "title.data-sample view": "data sample view",
   "title.data-summary list": "data summary list",
+  "title.data-summary period": "data summary period",
   "title.data-summary search": "data summary search",
   "title.data-summary view": "data summary view",
   "title.data-sensor list": "data sensor list",

package/translations/ko.json

@@ -15,6 +15,7 @@
   "field.data-key": "데이타 키",
   "field.data-key-set": "데이타 키셋",
   "field.date": "일자",
+  "field.month": "월",
   "field.device-id": "디바이스 아이디",
   "field.download-url": "다운로드 주소",
   "field.entry-role": "입력담당 역할",
@@ -102,6 +103,7 @@
   "title.data-sample search": "데이타 샘플 검색",
   "title.data-sample view": "데이타 샘플 상세",
   "title.data-summary list": "데이터 수집 마감 조회",
+  "title.data-summary period": "데이타 수집 마감 기간별 조회",
   "title.data-summary search": "데이타 수집 마감 검색",
   "title.data-summary view": "데이타 수집 마감 상세",
   "title.data-sensor list": "데이타 센서 조회",

package/translations/ms.json

@@ -15,6 +15,7 @@
   "field.data-sample": "data sample",
   "field.data-set": "data set",
   "field.date": "date",
+  "field.month": "month",
   "field.device-id": "device id",
   "field.entry-role": "entry role",
   "field.entry-type": "entry type",
@@ -90,6 +91,7 @@
   "title.data-sample search": "data sample search",
   "title.data-sample view": "data sample view",
   "title.data-summary list": "data summary list",
+  "title.data-summary period": "data summary period",
   "title.data-summary search": "data summary search",
   "title.data-summary view": "data summary view",
   "title.data-sensor list": "data sensor list",

package/translations/zh.json

@@ -15,6 +15,7 @@
   "field.data-sample": "data sample",
   "field.data-set": "data set",
   "field.date": "date",
+  "field.month": "month",
   "field.device-id": "device id",
   "field.entry-role": "entry role",
   "field.entry-type": "entry type",
@@ -90,6 +91,7 @@
   "title.data-sample search": "data sample search",
   "title.data-sample view": "data sample view",
   "title.data-summary list": "data summary list",
+  "title.data-summary period": "data summary period",
   "title.data-summary search": "data summary search",
   "title.data-summary view": "data summary view",
   "title.data-sensor list": "data sensor list",