@datarailsshared/dr_renderer 1.5.66 → 1.5.74

package/.github/workflows/release.yml

@@ -37,10 +37,9 @@ jobs:
   publish-gh-packages:
     name: Publish to GitHub Packages
     needs: publish-npm
-    uses: datarails/dr_github_reusable/.github/workflows/npm-publish-gh-packages.yml@DEVOPS-628
+    uses: datarails/dr_github_reusable/.github/workflows/npm-publish-gh-packages.yml@main
     with:
       node_version: '14.16.1'
       package_scope: '@datarails'
-      use_auto_increment: true
-      version_prefix: '1.5'
+      version: ${{ needs.publish-npm.outputs.version }}
     secrets: inherit

package/package.json

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

package/src/highcharts_renderer.js

@@ -3738,6 +3738,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     }
 
     highchartsRenderer.rhPivotCount = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr = arg[0];
         return function (data, rowKey, colKey) {
             return {
@@ -3819,6 +3820,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.rhPivotAggregatorUniqValues = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr;
         attr = arg[0];
         var sep = '<br>';
@@ -3894,6 +3896,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.rhPivotAggregatorSum = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr = arg[0];
         return function (data, rowKey, colKey) {
             return {
@@ -3987,6 +3990,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.rhPivotAggregatorMin = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr = arg[0];
         return function (data, rowKey, colKey) {
             return {
@@ -4079,6 +4083,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.rhPivotAggregatorMax = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr = arg[0];
         return function (data, rowKey, colKey) {
             return {
@@ -4171,6 +4176,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.rhPivotAggregatorAverage = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
+        render_options = lodash.cloneDeep(render_options);
         var attr = arg[0];
         return function (data, rowKey, colKey) {
             return {
@@ -4458,30 +4464,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return to_return;
     };
 
-    highchartsRenderer.checkFreezePanesAvaliable = function (pivotView) {
-        if (!pivotView || !pivotView.querySelector) {
-            return;
-        }
-
-        const tableContainer = pivotView.querySelector('.pivot-div');
-        const tableHead = pivotView.querySelector('table.pvtTable thead');
-        const tableHeadChildren = tableHead ? tableHead.children[0] : null;
-        const trChildren = tableHeadChildren ? tableHeadChildren.children : [];
-        let thWidth = 0;
-
-        for (let th of trChildren) {
-            if (th.classList.contains('axis-freeze-pane') || th.classList.contains('horizontal-freeze-pane')) {
-                thWidth += th.offsetWidth;
-            }
-        }
-
-        if (thWidth >= tableContainer.offsetWidth) {
-            tableContainer.dataset.canFreezePanes = 'false';
-        } else if (thWidth < tableContainer.offsetWidth &&  tableContainer.dataset.canFreezePanes) {
-            delete tableContainer.dataset.canFreezePanes;
-        }
-    };
-
     /**
      * Support rhPivotViewV2 version
      */
@@ -5171,19 +5153,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
     };
 
-    highchartsRenderer.setWidgetRawData = function (selectedTemplate) {
-        if (!selectedTemplate.widget_raw_data) {
-            selectedTemplate.widget_raw_data = lodash.map(selectedTemplate.raw_data,
-                function (row) {
-                    var ob = {};
-                    lodash.forEach(selectedTemplate.fields, function (value, key) {
-                        ob[value.name] = row[value.name]; //highchartsRenderer.returnRawDataValue(value.type, row[value.name], value.format)+"";
-                    });
-                    return ob;
-                });
-        }
-    };
-
     highchartsRenderer.updateBackwardCompatibleWidgetOptions = function(options, type) {
         if (lodash.get(options, 'chartOptions.chart.hideLegends', false)) {
             options.chartOptions.legends_position = { value: 'none' };

package/tests/highcharts_renderer.test.js

@@ -1501,53 +1501,6 @@ describe('highcharts_renderer', () => {
         });
     });
 
-    describe('function checkFreezePanesAvaliable', () => {
-        let pivotView;
-
-        beforeEach(() => {
-            pivotView = document.createElement('div');
-            pivotView.innerHTML = `
-                <div class="pivot-div">
-                    <table class="pvtTable">
-                        <thead>
-                            <tr>
-                                <th class="axis-freeze-pane" style="width: 100px;"></th>
-                                <th class="horizontal-freeze-pane" style="width: 100px;"></th>
-                                <th style="width: 500px;"></th>
-                            </tr>
-                        </thead>
-                    </table>
-                </div>
-            `;
-        });
-
-        it('should set dataset.canFreezePanes to false when total width of frozen columns exceeds table width', () => {
-            const tableContainer = pivotView.querySelector('.pivot-div');
-            const expectedDataset = { canFreezePanes: 'false' };
-
-            highchartsRenderer.checkFreezePanesAvaliable(pivotView);
-            expect(tableContainer.dataset.canFreezePanes).toEqual(expectedDataset.canFreezePanes);
-        });
-
-        it('should remove dataset.canFreezePanes when total width of frozen columns is less than table width', () => {
-            const tableContainer ={
-                dataset: { canFreezePanes: "false" },
-                offsetWidth: 1000
-            };
-
-            const _pivotView = {
-                querySelector: (p) => p === '.pivot-div' ? tableContainer : null
-            };
-            highchartsRenderer.checkFreezePanesAvaliable(_pivotView);
-
-            expect(tableContainer.dataset.canFreezePanes).toEqual(undefined);
-        });
-
-        it('should not set dataset.canFreezePanes when pivotView or pivotView.querySelector is undefined', () => {
-            expect(highchartsRenderer.checkFreezePanesAvaliable(null)).toEqual(undefined);
-        });
-    });
-
     describe('function getOnlyIncludedOfField', () => {
         it('returns includes array if it exists', () => {
             const fieldObj = {
@@ -1773,56 +1726,6 @@ describe('highcharts_renderer', () => {
         });
     });
 
-    describe('function setWidgetRawData', () => {
-        it('should create widget_raw_data property if it does not exist', () => {
-            const selectedTemplate = {
-                raw_data: [{ name: 'John', age: 30 }, { name: 'Jane', age: 25 }],
-                fields: [{ name: 'name', type: 'string', format: '' }, { name: 'age', type: 'number', format: '' }]
-            };
-
-            highchartsRenderer.setWidgetRawData(selectedTemplate);
-
-            expect(selectedTemplate.widget_raw_data).toBeDefined();
-        });
-
-        it('should map raw_data to widget_raw_data property', () => {
-            const selectedTemplate = {
-                raw_data: [{ name: 'John', age: 30 }, { name: 'Jane', age: 25 }],
-                fields: [{ name: 'name', type: 'string', format: '' }, { name: 'age', type: 'number', format: '' }]
-            };
-
-            highchartsRenderer.setWidgetRawData(selectedTemplate);
-
-            expect(selectedTemplate.widget_raw_data).toEqual([{ name: 'John', age: 30 }, { name: 'Jane', age: 25 }]);
-        });
-
-        it('should return raw_data values formatted based on their type and format', () => {
-            const selectedTemplate = {
-                raw_data: [{ name: 'John', age: 30.5 }, { name: 'Jane', age: 25 }],
-                fields: [{ name: 'name', type: 'string', format: '' }, { name: 'age', type: 'number', format: '0.00' }]
-            };
-
-            highchartsRenderer.setWidgetRawData(selectedTemplate);
-
-            expect(selectedTemplate.widget_raw_data[0].name).toBe('John');
-            expect(selectedTemplate.widget_raw_data[0].age).toBe(30.5);
-            expect(selectedTemplate.widget_raw_data[1].name).toBe('Jane');
-            expect(selectedTemplate.widget_raw_data[1].age).toBe(25);
-        });
-
-        it('shouldn\'t create widget_raw_data if it exists', () => {
-            const selectedTemplate = {
-                widget_raw_data: [{}],
-                raw_data: [{ name: 'John', age: 30 }, { name: 'Jane', age: 25 }],
-                fields: [{ name: 'name', type: 'string', format: '' }, { name: 'age', type: 'number', format: '' }]
-            };
-
-            highchartsRenderer.setWidgetRawData(selectedTemplate);
-
-            expect(selectedTemplate.widget_raw_data.length).toBe(1);
-        });
-    });
-
     describe("function updateBackwardCompatibleWidgetOptions", () => {
         it("should delete chart 'hideLegends' option if exists and true", () => {
             const options = {
@@ -2361,6 +2264,30 @@ describe('highcharts_renderer', () => {
         });
 
         describe('Aggregators functions', () => {
+            const testMutationIsolation = (factory) => {
+                // Use mockImplementationOnce to override the mock only for this test
+                let appliedOptions = null;
+                getAggregatorPercentageValueIfRequiredMock
+                    .mockImplementationOnce((value, opts) => {
+                        appliedOptions = lodash.cloneDeep(opts);
+                        return 'INITIAL';
+                    })
+                    .mockImplementationOnce((value, opts) => {
+                        const mutated = !lodash.isEqual(opts, appliedOptions);
+                        return mutated ? 'MUTATED' : 'INITIAL';
+                    });
+
+                const render_options = { chartOptions: { delta_column: { is_percentage: true } } };
+                const aggregatorFn = factory([], '#,###%', true, render_options, {});
+                const agg = aggregatorFn({}, [], []);
+                const before = agg.format(100, false);
+                render_options.chartOptions.delta_column.is_percentage = false;
+                const after = agg.format(100, false);
+
+                expect(before).toBe('INITIAL');
+                expect(after).toBe('INITIAL');
+            };
+
             describe('Sum aggregator', () => {
                 let arg;
                 let widget_values_format;
@@ -2415,6 +2342,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotAggregatorSum);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotAggregatorSum(arg, widget_values_format, is_graph, render_options, calculated_info);
@@ -2620,6 +2551,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotCount);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotCount(arg, widget_values_format, is_graph, render_options, calculated_info);
@@ -2822,6 +2757,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotAggregatorUniqValues);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotAggregatorUniqValues(arg, widget_values_format, is_graph, render_options, calculated_info);
@@ -2975,6 +2914,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotAggregatorAverage);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotAggregatorAverage(arg, widget_values_format, is_graph, render_options, calculated_info);
@@ -3183,6 +3126,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotAggregatorMin);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotAggregatorMin(arg, widget_values_format, is_graph, render_options, calculated_info);
@@ -3389,6 +3336,10 @@ describe('highcharts_renderer', () => {
                     expect(aggObject.numInputs).toBe(1);
                 });
 
+                it('Should ignore external mutations after initialization', () => {
+                    testMutationIsolation(highchartsRenderer.rhPivotAggregatorMax);
+                });
+
                 describe('Push method', () => {
                     beforeEach(() => {
                         aggregator = highchartsRenderer.rhPivotAggregatorMax(arg, widget_values_format, is_graph, render_options, calculated_info);