feat: add support for facet key selection for reports

anzalab · Sep 19, 2019 · a43dc0f · a43dc0f
1 parent 3e54038
commit a43dc0f
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 16 deletions.
diff --git a/src/http.router.js b/src/http.router.js
@@ -394,7 +394,7 @@
  */
 
 /* dependencies */
-import { merge } from 'lodash';
+import { compact, isEmpty, merge } from 'lodash';
 import { Router } from '@lykmapipo/express-common';
 import { getString } from '@lykmapipo/env';
 import getOverviewReport from './reports/overview';
@@ -435,9 +435,13 @@ router.get(PATH_OVERVIEW, (request, response, next) => {
 
   const filter = options.filter || {};
 
-  const facets = options.facets || [];
+  const { facets } = request.query;
 
-  const facetKeys = [].concat(facets);
+  let facetKeys = [];
+
+  if (!isEmpty(facets)) {
+    facetKeys = compact([].concat(facets.split(',')));
+  }
 
   getOverviewReport(filter, facetKeys, (error, results) => {
     if (error) {
@@ -471,7 +475,15 @@ router.get(PATH_PERFORMANCE, (request, response, next) => {
 
   const filter = options.filter || {};
 
-  getPerformanceReport(filter, (error, results) => {
+  const { facets } = request.query;
+
+  let facetKeys = [];
+
+  if (!isEmpty(facets)) {
+    facetKeys = compact([].concat(facets.split(',')));
+  }
+
+  getPerformanceReport(filter, facetKeys, (error, results) => {
     if (error) {
       next(error);
     } else {
@@ -505,7 +517,15 @@ router.get(PATH_OPERATOR_PERFORMANCE, (request, response, next) => {
 
   const filter = options.filter || {};
 
-  getOperatorPerformanceReport(filter, (error, results) => {
+  const { facets } = request.query;
+
+  let facetKeys = [];
+
+  if (!isEmpty(facets)) {
+    facetKeys = compact([].concat(facets.split(',')));
+  }
+
+  getOperatorPerformanceReport(filter, facetKeys, (error, results) => {
     if (error) {
       next(error);
     } else {
@@ -537,7 +557,15 @@ router.get(PATH_OPERATIONAL, (request, response, next) => {
 
   const filter = options.filter || {};
 
-  getOperationalReport(filter, (error, results) => {
+  const { facets } = request.query;
+
+  let facetKeys = [];
+
+  if (!isEmpty(facets)) {
+    facetKeys = compact([].concat(facets.split(',')));
+  }
+
+  getOperationalReport(filter, facetKeys, (error, results) => {
     if (error) {
       next(error);
     } else {

diff --git a/src/reports/operational.js b/src/reports/operational.js
@@ -19,6 +19,7 @@
 
 /* dependencies */
 import getBaseAggregation from '../base/servicerequest.base';
+import { getFacet } from '../util';
 import { OVERALL_FACET, SERVICE_FACET } from '../base/facets';
 
 const OPERATIONAL_FACET = {
@@ -32,21 +33,24 @@ const OPERATIONAL_FACET = {
  * @description Generate operational report based on provided criteria
  *
  * @param {object} criteria Criteria condition to be applied in $match
+ * @param {string[]} facetKeys Contain list of facets key to be used to generate report
  * @param {object} onResults Callback when aggregation operation finishes
  * @returns {object} executed aggregation
  *
- * @version 0.1.0
+ * @version 0.2.0
  * @since 0.1.0
  *
  * @example
  *  getOperationalReport(criteria, function(error, data){
  *    ...
  *  });
  */
-const getOperationalReport = (criteria, onResults) => {
+const getOperationalReport = (criteria, facetKeys, onResults) => {
   const baseAggregation = getBaseAggregation(criteria);
 
-  return baseAggregation.facet(OPERATIONAL_FACET).exec(onResults);
+  const FACET = getFacet(OPERATIONAL_FACET, facetKeys);
+
+  return baseAggregation.facet(FACET).exec(onResults);
 };
 
 export default getOperationalReport;
diff --git a/src/reports/operator.js b/src/reports/operator.js
@@ -15,6 +15,7 @@
 
 /* dependencies */
 import getBaseAggregation from '../base/servicerequest.base';
+import { getFacet } from '../util';
 import { OVERALL_FACET, SERVICE_FACET } from '../base/facets';
 
 const OPERATOR_PERFORMANCE_FACET = {
@@ -28,21 +29,24 @@ const OPERATOR_PERFORMANCE_FACET = {
  * @description Generate operator performance report based on provided criteria
  *
  * @param {object} criteria Criteria condition to be applied in $match
+ * @param {string[]} facetKeys Contain list of facets key to be used to generate report
  * @param {object} onResults Callback when aggregation operation finishes
  * @returns {object} executed aggregation
  *
- * @version 0.1.0
+ * @version 0.2.0
  * @since 0.1.0
  *
  * @example
  *  getOperatorPerformanceReport(criteria, function(error, data){
  *    ...
  *  });
  */
-const getOperatorPerformanceReport = (criteria, onResults) => {
+const getOperatorPerformanceReport = (criteria, facetKeys, onResults) => {
   const baseAggregation = getBaseAggregation(criteria);
 
-  return baseAggregation.facet(OPERATOR_PERFORMANCE_FACET).exec(onResults);
+  const FACET = getFacet(OPERATOR_PERFORMANCE_FACET, facetKeys);
+
+  return baseAggregation.facet(FACET).exec(onResults);
 };
 
 export default getOperatorPerformanceReport;
diff --git a/src/reports/overview.js b/src/reports/overview.js
@@ -58,7 +58,7 @@ const OVERVIEW_FACET = {
  * @param {object} onResults Callback when aggregation operation finishes
  * @returns {object} executed aggregation
  *
- * @version 0.1.0
+ * @version 0.2.0
  * @since 0.1.0
  *
  * @example

diff --git a/src/reports/performance.js b/src/reports/performance.js
@@ -20,6 +20,7 @@
 
 /* dependencies */
 import getBaseAggregation from '../base/servicerequest.base';
+import { getFacet } from '../util';
 import {
   OVERALL_FACET,
   STATUS_FACET,
@@ -44,21 +45,24 @@ const PERFORMANCE_FACET = {
  * @description Generate performance report based on provided criteria
  *
  * @param {object} criteria Criteria condition to be applied in $match
+ * @param {string[]} facetKeys Contain list of facets key to be used to generate report
  * @param {object} onResults Callback when aggregation operation finishes
  * @returns {object} executed aggregation
  *
- * @version 0.1.0
+ * @version 0.2.0
  * @since 0.1.0
  *
  * @example
  *  getPerformanceReport(criteria, function(error, data){
  *    ...
  *  });
  */
-const getPerformanceReport = (criteria, onResults) => {
+const getPerformanceReport = (criteria, facetKeys, onResults) => {
   const baseAggregation = getBaseAggregation(criteria);
 
-  return baseAggregation.facet(PERFORMANCE_FACET).exec(onResults);
+  const FACET = getFacet(PERFORMANCE_FACET, facetKeys);
+
+  return baseAggregation.facet(FACET).exec(onResults);
 };
 
 export default getPerformanceReport;