@datarailsshared/dr_renderer 1.2.325 → 1.2.326-dragons

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.2.325",
+  "version": "1.2.326-dragons",
   "description": "DataRails charts and tables renderer",
   "keywords": [
     "datarails",

package/src/dr_pivottable.js

@@ -199,10 +199,11 @@ let initDRPivotTable = function($, window, document) {
                 let flatColKey = colKey.join(delim);
 
                 if (this.keysLength === rowKey.length + colKey.length) {
-                    if (!this.rowKeys.some(rKey => rKey.join(delim) === flatRowKey)) {
+                    const isDrValuesRows = this.rowAttrs.length === 1 && this.rowAttrs[0] === 'DR_Values';
+                    if ((!this.isKeysSortingDoneOnBackendSide || isDrValuesRows) && !this.rowKeys.some(rKey => rKey.join(delim) === flatRowKey)) {
                         this.rowKeys.push(rowKey);
                     }
-                    if (!this.colKeys.some(cKey => cKey.join(delim) === flatColKey)) {
+                    if (!this.isKeysSortingDoneOnBackendSide && !this.colKeys.some(cKey => cKey.join(delim) === flatColKey)) {
                         this.colKeys.push(colKey);
                     }
                 }
@@ -234,7 +235,6 @@ let initDRPivotTable = function($, window, document) {
                         insight: insight,
                     });
                 }
-
                 return;
             }
 

package/src/highcharts_renderer.js

@@ -1157,6 +1157,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 ob.name = row_n_value.join(highchartsRenderer.delimer)
                     .replace(highchartsRenderer.DR_OTHERS_KEY, othersName);
             }
+
             lodash.forEach(col_n_keys, function (col_n_value, index) {
                 var agg = pivotData.getAggregator(row_n_value, col_n_value);
                 var val = agg.value();
@@ -1398,6 +1399,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             if (opts.trendLine) {
                 const a = ((ySum * squareXSum) - (xSum * xySum)) / ((n * squareXSum) - (xSum * xSum));
                 const b = ((n * xySum) -  (xSum* ySum)) / ((n * squareXSum) - (xSum * xSum));
+
                 const trendSeries = lodash.clone(chart_series[chart_series.length - 1]);
                 trendSeries.className = 'trendSeries';
                 trendSeries.name = highchartsRenderer.getTrendSeriesName(trendSeries);
@@ -1408,6 +1410,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (colors && colors[i]) {
                     trendSeries.color = colors[i];
                 }
+
                 trendSerieses.push(trendSeries);
             }
             i++;
@@ -1424,6 +1427,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
 
         let weights = { line: 2,spline: 3 ,area:-2, areaspline: -1, scatter:4, column: 1 };
+
         if (opts.comboOptions && lodash.includes(chartType,'combo') && !lodash.isEqual(row_n_keys, EMPTY_ROW_N_KEYS)) {
             chart_series.forEach((series, seriesIndex) => {
                 const savedSeriesOption = lodash.find(opts.comboOptions.seriesOptions, {series: series.name});
@@ -1510,6 +1514,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         const chart_series = [];
         const row_n_keys = pivotData.getRowKeys();
         const col_n_keys = pivotData.getColKeys();
+        const rows_by_cols = pivotData.rowKeysByCols;
 
         let resultObject = {
             data: [],
@@ -1538,7 +1543,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             });
 
             if (col_index !== col_n_keys.length - 1) {
-                lodash.forEach(row_n_keys, function (row_n_value) {
+
+                const rowKeys = rows_by_cols ? rows_by_cols[col_index] : row_n_keys;
+                lodash.forEach(rowKeys, function (row_n_value) {
                     const agg = pivotData.getAggregator(row_n_value, col_n_value);
                     let val = agg.value();
 
@@ -4778,21 +4785,23 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     opts.rendererOptions.onlyOptions = true;
                 }
 
-                const sortByValueSettings = lodash.filter(
-                    lodash.get(widget, 'options.sortingFields', []),
-                    sortingField => lodash.includes(['field_values', 'variance'], lodash.get(sortingField, 'sorting.sort_by'))
-                );
-
-                if (sortByValueSettings.length) {
-                    pivotData.sortByValueAttrs = lodash.map(sortByValueSettings, fieldSorting => fieldSorting.name);
-                    let new_sorting_function = highchartsRenderer.generateSortingFunctionByValues(sortByValueSettings, pivotData, opts, widget);
-                    opts.sorters = new_sorting_function;
-                    optsFiltered.sorters = new_sorting_function;
-                    pivotData.sorters = new_sorting_function;
+                if (!highchartsRenderer.isSortingOnBackendEnabled()) {
+                    const sortByValueSettings = lodash.filter(
+                        lodash.get(widget, 'options.sortingFields', []),
+                        sortingField => lodash.includes(['field_values', 'variance'], lodash.get(sortingField, 'sorting.sort_by'))
+                    );
+    
+                    if (sortByValueSettings.length) {
+                        pivotData.sortByValueAttrs = lodash.map(sortByValueSettings, fieldSorting => fieldSorting.name);
+                        let new_sorting_function = highchartsRenderer.generateSortingFunctionByValues(sortByValueSettings, pivotData, opts, widget);
+                        opts.sorters = new_sorting_function;
+                        optsFiltered.sorters = new_sorting_function;
+                        pivotData.sorters = new_sorting_function;
 
                     if (lodash.isObject(lodash.get(widget, 'pivot'))) {
                         widget.pivot.sorters = new_sorting_function;
                     }
+                    }
                 }
 
                 result = opts.renderer(pivotData, opts.rendererOptions);
@@ -4851,6 +4860,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             rows: lodash.map(pivotOptions.legendArray, 'name'),
             rendererOptions: widget.options,
             dateValuesDictionary: pivotOptions ? pivotOptions.dateValuesDictionary : null,
+            keysObject: pivotOptions ? pivotOptions.keysObject : null,
         };
 
         if (!subopts.rendererOptions) {
@@ -8717,6 +8727,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.getWidgetDataSorters = function (res, widget, defaultDateFormat) {
+        let sorters;
+
         if ($.pivotUtilities && !$.pivotUtilities.additionalFieldsList) {
             $.pivotUtilities.additionalFieldsList = [
                 {key: 'DR_Average', name: 'DR_Average'},
@@ -8724,32 +8736,20 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             ];
         }
 
-        var datesFields = [];
+        let datesFields = [];
         datesFields = lodash.filter(widget.rows, element => element.type == 'Date');
         datesFields = datesFields.concat(lodash.filter(widget.cols, element => element.type == 'Date'));
-
-        const isCustomSorting = widget.options.sortingFields && Array.isArray(widget.options.sortingFields) && widget.options.sortingFields.length > 0;
-        if (isCustomSorting) {
-            lodash.forEach(datesFields, function (field) {
-                const fieldToSort = lodash.find(
-                    widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
-                );
-                field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
-            });
-        }
-
         datesFields = lodash.map(datesFields, function (row) {
             return { "format": highchartsRenderer.getDateFieldFormat(widget, row), "name": row.name, "type": row.type, "values": [], "sorting": row.sorting } //'MMM - yyyy' format
         });
 
-        var data = res;
-
         lodash.forEach(datesFields, function (row) {
             row.val_not_convert = highchartsRenderer.check_values_not_for_convert(widget, row.name);
         });
 
         if (datesFields.length > 0) {
-            lodash.forEach(data, function (element) {
+            const invertedDateStringMap = {};
+            lodash.forEach(res, function (element) {
                 for (var i in datesFields) {
                     if (element.hasOwnProperty(datesFields[i].name)) {
                         datesFields[i].values.push(element[datesFields[i].name]);
@@ -8762,125 +8762,156 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                                 widget.pivot.dateValuesDictionary = {}
                             }
                             widget.pivot.dateValuesDictionary[dateStringValue] = element[datesFields[i].name];
+                            invertedDateStringMap[element[datesFields[i].name]] = dateStringValue;
                         }
                         element[datesFields[i].name] = dateStringValue;
                     }
                 }
             });
+
+            if (highchartsRenderer.isSortingOnBackendEnabled()) {
+                lodash.forEach(['col_keys', 'row_keys'], (keysListName, index) => {
+                    const widgetFields = index ? widget.rows : widget.cols;
+                    const uniqueFormattedKeysList = [];
+                    lodash.forEach(widget.pivot.keysObject[keysListName], subKeysList => {
+                        lodash.forEach(subKeysList, (key, index) => {
+                            if (widgetFields[index].type === 'Date') {
+                                subKeysList[index] = invertedDateStringMap[key] || key;
+                            }
+                        });
+                        if (!lodash.find(uniqueFormattedKeysList, formattedSubKeys => lodash.isEqual(formattedSubKeys, subKeysList))) {
+                            uniqueFormattedKeysList.push(subKeysList);
+                        }
+                    });
+                    widget.pivot.keysObject[keysListName] = uniqueFormattedKeysList;
+                });
+            }
         }
-        lodash.forEach(datesFields, function (row) {
-            row.values = lodash.uniq(row.values);
 
-            const isTimestampDateField = row.type === 'Date' && lodash.some(row.values, value => typeof value ==='number');
-            if (isTimestampDateField) {
-                const nullValueIndex = row.values.indexOf(NULL_VALUE);
-                if (~nullValueIndex) {
-                    row.values.splice(nullValueIndex, 1);
+        if (!highchartsRenderer.isSortingOnBackendEnabled()) {
+            const isCustomSorting = widget.options.sortingFields && Array.isArray(widget.options.sortingFields) && widget.options.sortingFields.length > 0;
+            if (isCustomSorting) {
+                lodash.forEach(datesFields, function (field) {
+                    const fieldToSort = lodash.find(
+                        widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
+                    );
+                    field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
+                });
+            }
+    
+            lodash.forEach(datesFields, function (row) {
+                row.values = lodash.uniq(row.values);
+    
+                const isTimestampDateField = row.type === 'Date' && lodash.some(row.values, value => typeof value ==='number');
+                if (isTimestampDateField) {
+                    const nullValueIndex = row.values.indexOf(NULL_VALUE);
+                    if (~nullValueIndex) {
+                        row.values.splice(nullValueIndex, 1);
+                    }
+                    row.values = row.values.sort((a, b) => a - b);
+                    if (~nullValueIndex) {
+                        row.values.push(NULL_VALUE);
+                    }
+                } else {
+                    row.values = row.values.sort();
                 }
-                row.values = row.values.sort((a, b) => a - b);
-                if (~nullValueIndex) {
-                    row.values.push(NULL_VALUE);
+    
+                if (row.sorting && row.sorting.type == "largestToSmallest") {
+                    row.values = lodash.reverse(row.values);
                 }
-            } else {
-                row.values = row.values.sort();
-            }
+                delete row.sorting;
+                row.values = lodash.map(row.values, function (val) {
+                    return highchartsRenderer.returnRawDataValue(row.type, val, row.format, row.name, row.val_not_convert) + "";
+                })
+    
+            });
 
-            if (row.sorting && row.sorting.type == "largestToSmallest") {
-                row.values = lodash.reverse(row.values);
+            /* date string */
+            var rowsAndCols = [];
+            rowsAndCols = widget.rows.concat(widget.cols);
+
+            if (widget.chart_type === highchartsRenderer.CHART_TYPES.WATERFALL_BREAKDOWN) {
+
+                // if it is breakdown widget - redefine sorting according to breakdown_options
+                // TODO: remove this when BE sort will be implemented
+                lodash.forEach(rowsAndCols, function (field) {
+                    const waterfallFieldType = field.id === widget.cols[0].id ? 'totals' : 'breakdown';
+                    field.sorting = {
+                        type: 'CustomOrder',
+                        values: lodash.map(
+                            widget.options.breakdown_options.values[waterfallFieldType],
+                            value => value.key
+                        ),
+                    };
+                });
+            } else if (isCustomSorting) {
+                lodash.forEach(rowsAndCols, function (field) {
+                    const fieldToSort = lodash.find(
+                        widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
+                    );
+                    field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
+                });
             }
-            delete row.sorting;
-            row.values = lodash.map(row.values, function (val) {
-                return highchartsRenderer.returnRawDataValue(row.type, val, row.format, row.name, row.val_not_convert) + "";
-            })
-
-        });
-
-        /* date string */
-        var rowsAndCols = [];
-        rowsAndCols = widget.rows.concat(widget.cols);
-
-        if (widget.chart_type === highchartsRenderer.CHART_TYPES.WATERFALL_BREAKDOWN) {
 
-            // if it is breakdown widget - redefine sorting according to breakdown_options
-            // TODO: remove this when BE sort will be implemented
-            lodash.forEach(rowsAndCols, function (field) {
-                const waterfallFieldType = field.id === widget.cols[0].id ? 'totals' : 'breakdown';
-                field.sorting = {
-                    type: 'CustomOrder',
-                    values: lodash.map(
-                        widget.options.breakdown_options.values[waterfallFieldType],
-                        value => value.key
-                    ),
-                };
-            });
-        } else if (isCustomSorting) {
             lodash.forEach(rowsAndCols, function (field) {
-                const fieldToSort = lodash.find(
-                    widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
-                );
-                field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
-            });
-        }
-
-        lodash.forEach(rowsAndCols, function (field) {
-            if (field.sorting && (field.sorting.type == "DateString" || field.sorting.type == "largestToSmallest")) {
-                var find_field = lodash.find(datesFields, {name: field.name});
-                if (find_field) {
-                    if (find_field.type != 'Date')
-                        find_field.sorting = field.sorting;
-                } else {
+                if (field.sorting && (field.sorting.type == "DateString" || field.sorting.type == "largestToSmallest")) {
+                    var find_field = lodash.find(datesFields, {name: field.name});
+                    if (find_field) {
+                        if (find_field.type != 'Date')
+                            find_field.sorting = field.sorting;
+                    } else {
+                        datesFields.push({
+                            "format": field.format,
+                            "name": field.name,
+                            "type": field.type,
+                            "values": [],
+                            "sorting": field.sorting,
+                        });
+                    }
+                } else if (field.sorting && field.sorting.type == "CustomOrder" && field.sorting.values) {
                     datesFields.push({
                         "format": field.format,
                         "name": field.name,
                         "type": field.type,
-                        "values": [],
-                        "sorting": field.sorting,
+                        "values": field.sorting.values
                     });
                 }
-            } else if (field.sorting && field.sorting.type == "CustomOrder" && field.sorting.values) {
-                datesFields.push({
-                    "format": field.format,
-                    "name": field.name,
-                    "type": field.type,
-                    "values": field.sorting.values
-                });
-            }
-        });
-
-        if (widget.vals && widget.vals.length > 1) {
-            datesFields.push({name: "DR_Values", values: lodash.map(widget.vals, 'name')});
-        }
+            });
 
-        /****** END *******/
-        
-        // TODO: Remove. sortingValues looks like lagacy which is not in use neither in webclient nor in renderer
-        if (widget.options && widget.options.sortingValues) {
-            var field = lodash.find(datesFields, {name: widget.options.sortingValues.field});
-            if (field) {
-                field.values = widget.options.sortingValues.values;
-                field.sorting = null;
-            } else {
-                datesFields.push({
-                    name: widget.options.sortingValues.field,
-                    values: widget.options.sortingValues.values
-                });
+            if (widget.vals && widget.vals.length > 1) {
+                datesFields.push({name: "DR_Values", values: lodash.map(widget.vals, 'name')});
             }
-        }
-
-        let sorters = function (attr) {
-            var field = lodash.find(datesFields, {name: attr});
-            if (field)
-                if (field.sorting && field.sorting.type == "DateString") {
-                    return $.pivotUtilities.sortDateStrings(field.sorting.month_order);
-                } else if (field.sorting && field.sorting.type == "largestToSmallest") {
-                    if (field.sorting.is_absolute)
-                        return $.pivotUtilities.largeToSmallSortByAbsolute;
-
-                    return $.pivotUtilities.largeToSmallSort;
+    
+            /****** END *******/
+            
+            // TODO: Remove. sortingValues looks like lagacy which is not in use neither in webclient nor in renderer
+            if (widget.options && widget.options.sortingValues) {
+                var field = lodash.find(datesFields, {name: widget.options.sortingValues.field});
+                if (field) {
+                    field.values = widget.options.sortingValues.values;
+                    field.sorting = null;
                 } else {
-                    return $.pivotUtilities.sortAs(field.values);
+                    datesFields.push({
+                        name: widget.options.sortingValues.field,
+                        values: widget.options.sortingValues.values
+                    });
                 }
-        };
+            }
+            sorters = function (attr) {
+                var field = lodash.find(datesFields, {name: attr});
+                if (field)
+                    if (field.sorting && field.sorting.type == "DateString") {
+                        return $.pivotUtilities.sortDateStrings(field.sorting.month_order);
+                    } else if (field.sorting && field.sorting.type == "largestToSmallest") {
+                        if (field.sorting.is_absolute)
+                            return $.pivotUtilities.largeToSmallSortByAbsolute;
+    
+                        return $.pivotUtilities.largeToSmallSort;
+                    } else {
+                        return $.pivotUtilities.sortAs(field.values);
+                    }
+            };
+        }
 
         return sorters;
     };
@@ -8900,6 +8931,12 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     //highchartsRenderer.getGraphOptions(scope.data, override_values, res, scope.dataModel.templatesWithOutData, scope.openDrillDownList, drillDownFunction)
     highchartsRenderer.getGraphOptions = function (widget_obj, override_values, row_data, templates, openDrillDownListFunction, drillDownFunction) {
+
+        let keysObject;
+        if (highchartsRenderer.isSortingOnBackendEnabled()) {
+            keysObject = row_data.pop();
+        }
+
         let res = highchartsRenderer.updateSelectedOverrideValues(widget_obj, override_values, row_data);
         res = highchartsRenderer.convertUniqueDateValues(widget_obj, templates, res);
 
@@ -8911,6 +8948,10 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
         let pivot = {};
 
+        if (highchartsRenderer.isSortingOnBackendEnabled()) {
+            pivot.keysObject = keysObject;
+        }
+
         let templateNoData = lodash.find(templates, {id: widget_obj.template_id});
         if (templateNoData) {
 
@@ -8947,6 +8988,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             subopts.onlyOptions = true;
         }
 
+        subopts.keysObject = keysObject;
+
         let hc_options = highchartsRenderer.rhPivotView(res, subopts, is_table, widget_obj);
 
         return hc_options;
@@ -9301,6 +9344,10 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return highchartsRenderer.enabledNewWidgetValueFormatting && (isCustomFormat || !isSecondaryAxis);
     }
 
+    highchartsRenderer.isSortingOnBackendEnabled = function() {
+        return lodash.includes(lodash.get(document, 'ReportHippo.user.features'), 'enable_server_widget_data_sorting');
+    }
+
     return highchartsRenderer;
 };
 

package/src/pivottable.js

@@ -686,8 +686,17 @@ let initPivotTable = function($, window, document) {
             });
             this.tree = {};
             this.insights = [];
-            this.rowKeys = [];
-            this.colKeys = [];
+
+            this.isKeysSortingDoneOnBackendSide = opts.keysObject && typeof opts.keysObject === 'object';
+            if (this.isKeysSortingDoneOnBackendSide) {
+                this.rowKeys = opts.keysObject.row_keys;
+                this.colKeys = opts.keysObject.col_keys;
+                // TODO: add also for breakdown sort object when BE story is ready.
+            } else {
+                this.rowKeys = [];
+                this.colKeys = [];
+            }
+
             this.rowTotals = {};
             this.colTotals = {};
             this.allTotal = this.aggregator(this, [], []);
@@ -853,12 +862,16 @@ let initPivotTable = function($, window, document) {
         };
 
         PivotData.prototype.getColKeys = function() {
-            this.sortKeys();
+            if (!this.isKeysSortingDoneOnBackendSide) {
+                this.sortKeys();
+            }
             return this.colKeys;
         };
 
         PivotData.prototype.getRowKeys = function() {
-            this.sortKeys();
+            if (!this.isKeysSortingDoneOnBackendSide) {
+                this.sortKeys();
+            }
             return this.rowKeys;
         };