@datarailsshared/dr_renderer 1.5.120 → 1.5.124

package/README.md

@@ -63,3 +63,5 @@ try {
 
 ###
 ##
+
+

package/package.json

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

package/src/dr-renderer-helpers.js

@@ -72,7 +72,6 @@ function isShowingEmptyValues(additionOptions) {
 const DELIMER = ' , '
 const FEATURES = {
     ENABLE_NEW_WIDGET_VALUE_FORMATTING: 'enable_new_widget_value_formatting',
-    FORMAT_DATES_AS_OTHER_AXIS_TYPES: 'format_dates_as_other_axis_types',
     MULTIPLE_DIMENSION_TAGS: 'multiple_dimension_tags',
     USE_NEW_SCENARIO_TAG: 'use_new_scenario_tag',
     ENABLE_GAUGE_DYNAMIC_GOAL: 'enable_gauge_dynamic_goal',

package/src/highcharts_renderer.js

@@ -297,8 +297,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 let wrappedFormattedValue = highchartsRenderer.getSpanWrapper(formatted_value);
 
                 const category_text = tooltipOptions.show_x_axis ? `<b>${cols[0] || this.key}</b>` : '';
-                const series_text = tooltipOptions.show_data_series 
-                    ? `<br/><span style="color: ${this.series.color};">\u200E${this.series.name}</span>: ` 
+                const series_text = tooltipOptions.show_data_series
+                    ? `<br/><span style="color: ${this.series.color};">\u200E${this.series.name}</span>: `
                     : '';
                 wrappedFormattedValue = tooltipOptions.show_value ? wrappedFormattedValue : '';
 
@@ -1790,19 +1790,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         resultObject = highchartsRenderer.getDataLabelsOptions(additionOptions, resultObject);
         lodash.forEach(waterfallOptions.values.walkthrough, function(value, index) {
 
-            let keys = [];
-            if (value.trend === 'total' || highchartsRenderer.isFormattingDatesAsOtherAxisTypes()) {
-                keys = value.key;
-            } else {
-                lodash.forEach(value.key, (item) => {
-                    const findKeyByValue = lodash.find(
-                        Object.keys(pivotData.dateValuesDictionary || {}),
-                        key => pivotData.dateValuesDictionary[key] === item
-                    );
-                    keys.push(findKeyByValue ? findKeyByValue : item);
-                 })
-            }
-
+            const keys = value.key;
             const agg = pivotData.getAggregator([], keys);
 
             if (keys[0] === 'Total') {
@@ -7472,18 +7460,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
          return {};
     };
 
-    highchartsRenderer.createDateFromString = function (dateString, format) {
-        if (!(format && highchartsRenderer.isDateFormat(dateString, format) || highchartsRenderer.isDate(dateString))) {
-            return null;
-        }
-        const utcDate = format
-            ? moment_lib.utc(dateString, format, true)
-            : moment_lib.utc(dateString);
-        return utcDate.startOf('day').unix();
-    }
-
     highchartsRenderer.prepareDrillDownFilters = function (r_keys, c_keys, widget) {
-        const isFormattingDatesAsOtherAxisTypes = highchartsRenderer.isFormattingDatesAsOtherAxisTypes();
         let row_key = r_keys;
         let col_key = c_keys;
         if (widget.options &&
@@ -7504,11 +7481,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 let label = col_value;
                 if (widget.cols[0].type === 'Date' && col_value !== NULL_VALUE) {
                     const format = highchartsRenderer.getDateFieldFormat(widget, widget.cols[0]);
-                    let date = isFormattingDatesAsOtherAxisTypes ? +col_value : highchartsRenderer.createDateFromString(col_value, format);
+                    let date = +col_value;
                     colFilter.values.push(date);
-                    label = isFormattingDatesAsOtherAxisTypes
-                        ? highchartsRenderer.returnRawDataValue(widget.cols[0].type, +col_value, format, widget.cols[0].name)
-                        : col_value;
+                    label = highchartsRenderer.returnRawDataValue(widget.cols[0].type, +col_value, format, widget.cols[0].name);
                 } else {
                     colFilter.values.push(col_value);
                 }
@@ -7537,9 +7512,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             return;
                         }
                         temp.values = datetrange;
-                        temp.values.label = isFormattingDatesAsOtherAxisTypes
-                            ? highchartsRenderer.returnRawDataValue(widget.cols[index].type, +col_value, format, widget.cols[index].name)
-                            : col_value;
+                        temp.values.label = highchartsRenderer.returnRawDataValue(widget.cols[index].type, +col_value, format, widget.cols[index].name);
                     } else {
                         temp.values = [col_value];
                     }
@@ -7560,9 +7533,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         return;
                     }
                     temp.values = datetrange;
-                    temp.values.label = isFormattingDatesAsOtherAxisTypes
-                        ? highchartsRenderer.returnRawDataValue(widget.rows[index].type, +row_value, format, widget.rows[index].name)
-                        : row_value;
+                    temp.values.label = highchartsRenderer.returnRawDataValue(widget.rows[index].type, +row_value, format, widget.rows[index].name);
                 } else {
                     temp.values = [row_value];
                 }
@@ -7611,7 +7582,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.prepareDrillDownGraphFilters = function (r_key, c_key, widget) {
-        const isFormattingDatesAsOtherAxisTypes = highchartsRenderer.isFormattingDatesAsOtherAxisTypes();
         let rowKey = r_key;
         let colKey = c_key;
         let widgetOptions = typeof widget.options === 'string' ? JSON.parse(widget.options) : widget.options;
@@ -7649,12 +7619,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 let value = colKey[i];
                 switch (widget.cols[0].type) {
                     case 'Date':
-                        if (value !== NULL_VALUE && !isFormattingDatesAsOtherAxisTypes) {
-                            value = highchartsRenderer.createDateFromString(
-                                value,
-                                highchartsRenderer.getDateFieldFormat(widget, widget.cols[0])
-                            );
-                        } else if (!isNaN(value)) {
+                        if (!isNaN(value)) {
                             value = +value;
                         }
                         break;
@@ -7768,44 +7733,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return res;
     };
 
-    highchartsRenderer.replaceSortingKeysWithMappedValues = function(keys, invertedDateStringMap, widgetFields) {
-        if (!keys || !invertedDateStringMap) {
-            return;
-        }
-        const dateWidgetFields = lodash.filter(widgetFields, obj => obj.type === 'Date');
-        const replaceNestedKeys = (nestedKeys) => {
-            for (let i = 0; i < nestedKeys.length; i++) {
-                if (Array.isArray(nestedKeys[i])) {
-                    replaceNestedKeys(nestedKeys[i]);
-                }
-                else if (invertedDateStringMap[nestedKeys[i]] && widgetFields[i] && widgetFields[i].type === 'Date') {
-                    const getFormat = (obj) => (lodash.get(obj, 'format') ?? '').toUpperCase();
-                    const isSameDateFormats = lodash.every(dateWidgetFields, obj => getFormat(obj) === getFormat(dateWidgetFields[0]));
-
-                    if (isSameDateFormats) {
-                        nestedKeys[i] = invertedDateStringMap[nestedKeys[i]];
-                        continue;
-                    }
-
-                    // Reformatting dates when "widgetFields" array contains fields with different formats
-                    // Fixes the issue - https://datarailsteam.atlassian.net/browse/DR-37813
-                    // Will be removed once "format_dates_as_other_axis_types" FF is deleted
-                    const format = (widgetFields[i].format ?? "MM/DD/YYYY").toUpperCase();
-                    const date = new Date(parseInt(nestedKeys[i]) * 1000);
-                    const formattedDateString = moment_lib(date).utcOffset(0).format(format) + "";
-                    nestedKeys[i] = formattedDateString;
-                }
-            }
-        };
-
-        for (let i = 0; i < keys.length; i++) {
-            replaceNestedKeys(keys[i]);
-        }
-    }
-
     highchartsRenderer.getWidgetDataSorters = function (res, widget, defaultDateFormat) {
-        const isFormattingDatesAsOtherAxisTypes = highchartsRenderer.isFormattingDatesAsOtherAxisTypes();
-
         if ($.pivotUtilities && !$.pivotUtilities.additionalFieldsList) {
             $.pivotUtilities.additionalFieldsList = [
                 {key: 'DR_Average', name: 'DR_Average'},
@@ -7830,7 +7758,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
         datesFields = lodash.map(datesFields, function (row) {
             return {
-                "format": isFormattingDatesAsOtherAxisTypes ? null : highchartsRenderer.getDateFieldFormat(widget, row),
+                "format": null,
                 "name": row.name,
                 "type": row.type,
                 "values": [],
@@ -7838,44 +7766,14 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             } //'MMM - yyyy' format
         });
 
-        if (!isFormattingDatesAsOtherAxisTypes) {
-            lodash.forEach(datesFields, function (row) {
-                row.val_not_convert = highchartsRenderer.check_values_not_for_convert(widget, row.name);
-            });
-        }
-
         if (datesFields.length > 0) {
             widget.pivot.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]);
-
-                        if (!isFormattingDatesAsOtherAxisTypes) {
-                            const dateStringValue = highchartsRenderer.returnRawDataValue(
-                                datesFields[i].type, element[datesFields[i].name],
-                                defaultDateFormat ? defaultDateFormat : datesFields[i].format,
-                                datesFields[i].name, datesFields[i].val_not_convert);
-                            if (widget.pivot) {
-                                if (!widget.pivot.dateValuesDictionary) {
-                                    widget.pivot.dateValuesDictionary = {}
-                                }
-                                widget.pivot.dateValuesDictionary[dateStringValue] = element[datesFields[i].name];
-                                widget.pivot.invertedDateStringMap[element[datesFields[i].name]] = dateStringValue;
-                            }
-                            element[datesFields[i].name] = dateStringValue;
-                        }
                     }
                 }
-                if (!isFormattingDatesAsOtherAxisTypes) {
-                    const keysObject = lodash.get(widget, 'pivot.keysObject');
-
-                    lodash.forEach(['col_keys', 'row_keys', 'row_keys_by_cols'], (keysListName) => {
-                        const widgetFields = keysListName === 'col_keys' ? widget.cols : widget.rows;
-                        highchartsRenderer
-                            .replaceSortingKeysWithMappedValues(lodash.get(keysObject, keysListName), widget.pivot.invertedDateStringMap, widgetFields);
-                    });
-                }
             });
         }
     };
@@ -8235,9 +8133,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             filter.values = field.type === 'Date' && colKey !== NULL_VALUE
                 ? highchartsRenderer.createDateTypeFromValue(colKey, format)
                 : [colKey];
-            filter.value_to_show = field.type === 'Date' && highchartsRenderer.isFormattingDatesAsOtherAxisTypes()
-                ? highchartsRenderer.returnRawDataValue(field.type, +colKey, format, field.name)
-                : colKey;
+            filter.value_to_show = field.type === 'Date' ? highchartsRenderer.returnRawDataValue(field.type, +colKey, format, field.name) : colKey;
         }
     }
 
@@ -8330,12 +8226,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return pivotData.isFormattingAxisLabels;
     }
 
-    highchartsRenderer.isFormattingDatesAsOtherAxisTypes = function () {
-        return highchartsRenderer.hasFeature(FEATURES.FORMAT_DATES_AS_OTHER_AXIS_TYPES);
-    }
-
     // Method for getting formatted kyes for Axis (cols, rows)
-    highchartsRenderer.getFormattedKey = function (initialKey, pivotData, type, forceFormatDates) {
+    highchartsRenderer.getFormattedKey = function (initialKey, pivotData, type) {
         const isFlatKey = lodash.isString(initialKey) || lodash.isNumber(initialKey);
         if (isFlatKey || lodash.isArray(initialKey)) {
             let values = isFlatKey ? initialKey.toString().split(highchartsRenderer.delimer) : lodash.cloneDeep(initialKey);
@@ -8344,10 +8236,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     const formatInfo = pivotData[type][key] || {};
                     const valueToFloat = parseFloat(value);
                     const isDate = formatInfo.type === 'Date' && (moment_lib(valueToFloat).isValid() || moment_lib(value, formatInfo.format).isValid());
-                    const isDateFormatting = isDate && (forceFormatDates || highchartsRenderer.isFormattingDatesAsOtherAxisTypes());
                     const isNumberFormatting = !isDate && formatInfo.format && highchartsRenderer.isFormattingNumberAxis(pivotData);
 
-                    if (isNumberFormatting || isDateFormatting) {
+                    if (isNumberFormatting || isDate) {
                         values[key] = highchartsRenderer.returnRawDataValue(
                             formatInfo.type,
                             !isNaN(valueToFloat) ? valueToFloat : value,
@@ -8372,13 +8263,13 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return highchartsRenderer.getFormattedKey(initialValue, pivotData, 'rowFormats')
     }
 
-    highchartsRenderer.getFormattedKeys = function(pivotData, isCols, keys, forceFormatDates) {
+    highchartsRenderer.getFormattedKeys = function(pivotData, isCols, keys) {
         keys = keys || (isCols ? pivotData.getColKeys() : pivotData.getRowKeys());
-        return lodash.map(keys, key => highchartsRenderer.getFormattedKey(key, pivotData, isCols ? 'colFormats' : 'rowFormats', forceFormatDates));
+        return lodash.map(keys, key => highchartsRenderer.getFormattedKey(key, pivotData, isCols ? 'colFormats' : 'rowFormats'));
     }
 
-    highchartsRenderer.getFormattedColKeys = function(pivotData, keys, forceFormatDates) {
-        return highchartsRenderer.getFormattedKeys(pivotData, true, keys, forceFormatDates);
+    highchartsRenderer.getFormattedColKeys = function(pivotData, keys) {
+        return highchartsRenderer.getFormattedKeys(pivotData, true, keys);
     }
 
     highchartsRenderer.getFormattedRowKeys = function(pivotData, keys) {

package/tests/highcharts_renderer.test.js

@@ -5088,12 +5088,7 @@ describe('highcharts_renderer', () => {
         });
 
         describe('formatting Dates', () => {
-            afterEach(() => {
-                lodash.set(document, 'ReportHippo.user.features', []);
-            });
-
-            it('should return formatted multivalue colKey as array (format_dates_as_other_axis_types is ON)', () => {
-                highchartsRenderer.setFeatures(['format_dates_as_other_axis_types']);
+            it('should return formatted multivalue colKey as array', () => {
                 const initialKey = [1687277052, 1687277052];
                 const pivotData = {
                     colFormats: [{ type: 'Date', format: 'MM/DD/YYYY' }, { type: 'Date', format: 'MMM-yy' }],
@@ -5104,8 +5099,7 @@ describe('highcharts_renderer', () => {
                 expect(formattedKey).toEqual(['06/20/2023', 'Jun-23']);
             });
 
-            it('should return formatted multivalue rowKey as array (format_dates_as_other_axis_types is ON)', () => {
-                highchartsRenderer.setFeatures(['format_dates_as_other_axis_types']);
+            it('should return formatted multivalue rowKey as array', () => {
                 const initialKey = [1687277052, 1687277052];
                 const pivotData = {
                     rowFormats: [{ type: 'Date', format: 'MM/DD/YYYY' }, { type: 'Date', format: 'MMM-yy' }],
@@ -5116,32 +5110,7 @@ describe('highcharts_renderer', () => {
                 expect(formattedKey).toEqual(['06/20/2023', 'Jun-23']);
             });
 
-            it('should return NOT formatted multivalue colKey as array (format_dates_as_other_axis_types is OFF)', () => {
-                highchartsRenderer.setFeatures([]);
-                const initialKeyAlreadyFormatted = ['10/10/2020', '10/10/2021'];
-                const pivotData = {
-                    colFormats: [{ type: 'Date', format: 'MM/DD/YYYY' }, { type: 'Date', format: 'MMM-yy' }],
-                    isFormattingAxisLabels: true,
-                };
-                const type = 'colFormats';
-                const formattedKey = highchartsRenderer.getFormattedKey(initialKeyAlreadyFormatted, pivotData, type);
-                expect(formattedKey).toEqual(initialKeyAlreadyFormatted);
-            });
-
-            it('should return NOT formatted multivalue rowKey as array (format_dates_as_other_axis_types is OFF)', () => {
-                highchartsRenderer.setFeatures([]);
-                const initialKeyAlreadyFormatted = ['10/10/2020', '10/10/2021'];
-                const pivotData = {
-                    rowFormats: [{ type: 'Date', format: 'MM/DD/YYYY' }, { type: 'Date', format: 'MMM-yy' }],
-                    isFormattingAxisLabels: true,
-                };
-                const type = 'rowFormats';
-                const formattedKey = highchartsRenderer.getFormattedKey(initialKeyAlreadyFormatted, pivotData, type);
-                expect(formattedKey).toEqual(initialKeyAlreadyFormatted);
-            });
-
             it('should return NOT formatted value when type is Date but value is not a valid moment date', () => {
-                lodash.set(document, 'ReportHippo.user.features', ['format_dates_as_other_axis_types']);
                 const initialKey = ['Some Text Value', 'Another Text'];
                 const pivotData = {
                     colFormats: [{ type: 'Date' }, { type: 'Date' }],
@@ -5151,28 +5120,6 @@ describe('highcharts_renderer', () => {
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
                 expect(formattedKey).toEqual(initialKey);
             });
-
-            it('should return formatted value when type is Date and value is a valid moment date (format_dates_as_other_axis_types is OFF)', () => {
-                const initialKey = ['Feb-24', 'Jan-24'];
-                const pivotData = {
-                    colFormats: [{ type: 'Date' }, { type: 'Date' }],
-                    isFormattingAxisLabels: true,
-                };
-                const type = 'colFormats';
-                const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
-                expect(formattedKey).toEqual(initialKey);
-            });
-
-            it('should return formatted value when type is Date and value is a valid moment date (with valid format)', () => {
-                const initialKey = ['Q4-20'];
-                const pivotData = {
-                    colFormats: [{ format: "[Q]Q-YY", name: "Date", type: "Date" }],
-                    isFormattingAxisLabels: true,
-                };
-                const type = 'colFormats';
-                const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
-                expect(formattedKey).toEqual(initialKey);
-            });
         });
     });
 
@@ -5274,7 +5221,7 @@ describe('highcharts_renderer', () => {
 
         it('should getFormattedColKeys call getFormattedKeys for colFormats', () => {
             highchartsRenderer.getFormattedColKeys('test1', 'test2');
-            expect(highchartsRenderer.getFormattedKeys).toHaveBeenCalledWith('test1', true, 'test2', undefined);
+            expect(highchartsRenderer.getFormattedKeys).toHaveBeenCalledWith('test1', true, 'test2');
         });
 
         it('should getFormattedRowKeys call getFormattedKeys for rowFormats', () => {
@@ -6027,14 +5974,6 @@ describe('highcharts_renderer', () => {
     describe('Function tableCSVExportRenderer', () => {
         window._ = lodash;
 
-        beforeEach(() => {
-            lodash.set(document, 'ReportHippo.user.features', ['format_dates_as_other_axis_types']);
-        });
-
-        afterEach(() => {
-            lodash.set(document, 'ReportHippo.user.features', []);
-        });
-
         it('should create csv json object representation based on pivot data (only cols)', () => {
             const chartOptions = {
                 table_options: {
@@ -8154,7 +8093,6 @@ describe('highcharts_renderer', () => {
             });
             spyOn(highchartsRenderer, 'getFormattedColKey')
                 .and.callFake((initialName, pivotData) => `formatted(${ initialName })`);
-            spyOn(highchartsRenderer, 'isFormattingDatesAsOtherAxisTypes').and.returnValue(true);
         });
 
         it("should create appropriate series for case when only one column field and one total", () => {
@@ -9215,7 +9153,6 @@ describe('highcharts_renderer', () => {
                 .and.callFake((initialName, pivotData) => `formatted_col(${ initialName })`);
             spyOn(highchartsRenderer, 'getFormattedRowKey')
                 .and.callFake((initialName, pivotData) => `formatted_row(${ initialName })`);
-            spyOn(highchartsRenderer, 'isFormattingDatesAsOtherAxisTypes').and.returnValue(true);
         });
 
         it("should create appropriate series for case no breakdown field (one row value - Variance instead)", () => {