Merge pull request #635 from ivan-nejezchleb/ONE-3417

RELATED: ONE-3417 Create default Treemap sorting on Uri component Reviewed-by: Petr Benes <petr.benes@gooddata.com> https://github.com/pbenes
gooddata · Nov 9, 2018 · 4e1266c · 4e1266c
2 parents 7a7ebc1 + 9a2e525
commit 4e1266c
Show file tree

Hide file tree

Showing 4 changed files with 144 additions and 2 deletions.
diff --git a/__mocks__/fixtures.ts b/__mocks__/fixtures.ts
@@ -931,6 +931,72 @@ export const visualizationObjects: [{ visualizationObject: VisualizationObject.I
                 contributor: '/gdc/account/profile/johndoe'
             }
         }
+    },
+    {
+        visualizationObject: {
+            content: {
+                buckets: [
+                    {
+                        localIdentifier: 'measures',
+                        items: [
+                            {
+                                measure: {
+                                    localIdentifier: 'b5a12d1bf094469d9b4e7d5d2bb87287',
+                                    title: 'Avg. Amount',
+                                    definition: {
+                                        measureDefinition: {
+                                            item: {
+                                                uri: '/gdc/md/jm8bsdakbhujk1a254h25a6mtd6orn9g/obj/62827'
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        ]
+                    },
+                    {
+                        localIdentifier: 'view',
+                        items: [
+                            {
+                                visualizationAttribute: {
+                                    localIdentifier: '02b7736f6bef48b1849798e430d837df',
+                                    displayForm: {
+                                        uri: '/gdc/md/jm8bsdakbhujk1a254h25a6mtd6orn9g/obj/324'
+                                    }
+                                }
+                            }
+                        ]
+                    },
+                    {
+                        localIdentifier: 'segment',
+                        items: [
+                            {
+                                visualizationAttribute: {
+                                    localIdentifier: 'bc5257e06a9342ec99854bd1a53f3262',
+                                    displayForm: {
+                                        uri: '/gdc/md/jm8bsdakbhujk1a254h25a6mtd6orn9g/obj/952'
+                                    }
+                                }
+                            }
+                        ]
+                    }
+                ],
+                visualizationClass: {
+                    uri: '/gdc/md/myproject/obj/treemap'
+                }
+            },
+            meta: {
+                author: '/gdc/account/profile/9a4a028462b504f7ebe71d3c6a6e5786',
+                uri: '/gdc/md/myproject/obj/3',
+                tags: '',
+                created: new Date('2018-05-23T09:24:41Z'),
+                identifier: 'aacp5FkYehh3',
+                summary: '',
+                title: 'ONE-3417',
+                category: 'visualizationObject',
+                contributor: '/gdc/account/profile/9a4a028462b504f7ebe71d3c6a6e5786'
+            }
+        }
     }
 ];
 
@@ -962,5 +1028,19 @@ export const visualizationClasses: [{ visualizationClass: VisualizationClass.IVi
                 uri: '/gdc/md/myproject/obj/table'
             }
         }
+    },
+    {
+        visualizationClass: {
+            content: {
+                url: 'local:treemap',
+                icon: '',
+                iconSelected: '',
+                checksum: ''
+            },
+            meta: {
+                title: 'Treemap',
+                uri: '/gdc/md/myproject/obj/treemap'
+            }
+        }
     }
 ];
diff --git a/src/components/uri/Visualization.tsx b/src/components/uri/Visualization.tsx
@@ -22,7 +22,9 @@ import { LoadingComponent, ILoadingProps } from '../simple/LoadingComponent';
 import { ErrorComponent, IErrorProps } from '../simple/ErrorComponent';
 import { IDrillableItem, generateDimensions, RuntimeError } from '../../';
 import { setTelemetryHeaders } from '../../helpers/utils';
+import { getDefaultTreemapSort } from '../../helpers/sorts';
 import { convertErrors, generateErrorMap, IErrorMap } from '../../helpers/errorHandlers';
+import { isTreemap } from '../visualizations/utils/common';
 export { Requireable };
 
 const {
@@ -385,17 +387,25 @@ export class VisualizationWrapped
                     const afmWithFilters = AfmUtils.appendFilters(afm, attributeFilters, dateFilter);
 
                     const visualizationType: VisType = getVisualizationTypeFromVisualizationClass(visualizationClass);
+                    // keep resultSpec creation in sync with AD
                     const resultSpecWithDimensions = {
                         ...resultSpec,
                         dimensions: generateDimensions(mdObject.content, visualizationType)
                     };
+                    const treemapDefaultSorting = isTreemap(visualizationType) ? {
+                        sorts: getDefaultTreemapSort(afm, resultSpecWithDimensions)
+                    } : {};
+                    const resultSpecWithDimensionsAndSorting = {
+                        ...resultSpecWithDimensions,
+                        ...treemapDefaultSorting
+                    };
 
                     return this.adapter.createDataSource(afmWithFilters)
                         .then((dataSource: IDataSource) => {
                             return {
                                 type: visualizationType,
                                 dataSource,
-                                resultSpec: resultSpecWithDimensions,
+                                resultSpec: resultSpecWithDimensionsAndSorting,
                                 totals: mdObjectTotals,
                                 mdObject
                             };

diff --git a/src/components/uri/tests/Visualization.spec.tsx b/src/components/uri/tests/Visualization.spec.tsx
@@ -24,6 +24,7 @@ import * as HttpStatusCodes from 'http-status-codes';
 const projectId = 'myproject';
 const CHART_URI = `/gdc/md/${projectId}/obj/1`;
 const TABLE_URI = `/gdc/md/${projectId}/obj/2`;
+const TREEMAP_URI = `/gdc/md/${projectId}/obj/3`;
 const CHART_IDENTIFIER = 'chart';
 const TABLE_IDENTIFIER = 'table';
 
@@ -86,6 +87,10 @@ function uriResolver(_sdk: SDK, _projectId: string, uri: string, identifier: str
         return getResponse(CHART_URI, SLOW);
     }
 
+    if (uri === TREEMAP_URI) {
+        return getResponse(TREEMAP_URI, FAST);
+    }
+
     return Promise.reject('Unknown identifier');
 }
 
@@ -470,4 +475,49 @@ describe('VisualizationWrapped', () => {
             expect(mutatedSdk.project.getColorPaletteWithGuids).toHaveBeenCalledTimes(1);
         });
     });
+
+    it('should add default sorting to the Treemap', () => {
+        const props = {
+            sdk,
+            projectId,
+            uri: TREEMAP_URI,
+            fetchVisObject,
+            fetchVisualizationClass,
+            uriResolver,
+            intl,
+            BaseChartComponent: BaseChart
+        };
+
+        const wrapper = mount(
+            <VisualizationWrapped {...props as any} />
+        );
+
+        return testUtils.delay(FAST + 1).then(() => {
+            wrapper.update();
+            const BaseChartElement = wrapper.find(BaseChart).get(0);
+            expect(BaseChartElement.props.resultSpec).toEqual({
+                dimensions: [
+                    {
+                        itemIdentifiers: ['02b7736f6bef48b1849798e430d837df', 'bc5257e06a9342ec99854bd1a53f3262']
+                    },
+                    {
+                        itemIdentifiers: ['measureGroup']
+                    }
+                ],
+                sorts: [
+                    {
+                        attributeSortItem: { attributeIdentifier: '02b7736f6bef48b1849798e430d837df', direction: 'asc' }
+                    },
+                    {
+                        measureSortItem: {
+                            direction: 'desc',
+                            locators: [
+                                { measureLocatorItem: { measureIdentifier: 'b5a12d1bf094469d9b4e7d5d2bb87287' } }
+                            ]
+                        }
+                    }
+                ]
+            });
+        });
+    });
 });
diff --git a/src/index.ts b/src/index.ts
@@ -25,6 +25,7 @@ import * as PropTypes from './proptypes/index';
 import { generateDimensions } from './helpers/dimensions';
 import * as BucketNames from './constants/bucketNames';
 import * as MeasureTitleHelper from './helpers/measureTitleHelper';
+import * as SortsHelper from './helpers/sorts';
 import DerivedMeasureTitleSuffixFactory from './factory/DerivedMeasureTitleSuffixFactory';
 import ArithmeticMeasureTitleFactory from './factory/ArithmeticMeasureTitleFactory';
 import { IDataSourceProviderInjectedProps } from './components/afm/DataSourceProvider';
@@ -120,5 +121,6 @@ export {
     ChartTransformation,
     Chart,
     OverTimeComparisonType,
-    OverTimeComparisonTypes
+    OverTimeComparisonTypes,
+    SortsHelper
 };