angular-ui/ui-grid

Grouppriority default treeAggregationFn overwrite bug

Open

#5,123 opened on Feb 16, 2016

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
good first issuegrid-grouping

Description

According to the docs the groupingColumnBuilder function should get one of the default aggregations when the groupPriority is undefined or less then 0, however, in the code it does otherwise:

If the groupPriority is undefined or less than 0, then we expect to be aggregating, and we look at the aggregation types to determine what sort of aggregation we can do. Values are in the constants file, but include SUM, COUNT, MAX, MIN

if ( typeof(col.grouping.groupPriority) !== 'undefined' && col.grouping.groupPriority > -1 ){
    col.treeAggregationFn = uiGridTreeBaseService.nativeAggregations()[uiGridGroupingConstants.aggregation.COUNT].aggregationFn;
    col.treeAggregationFinalizerFn = service.groupedFinalizerFn;
}

As you see in the above code, it actually checks for !== 'undefined' && > -1, which overwrites a possible custom set treeAggregationFn with a default one.

This above code is taken from the current release, line #18959

Contributor guide

Tech stack
angularjavascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript basicsAngularJS concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The bug is in the file ui grid.js, around line 18959, in the section that sets treeAggregationFn. The current code overwrites a custom aggregation function when groupPriority is defined and > 1. According to the documentation, the default should only be applied when groupPriority is undefined or less than 0. The fix is to invert the condition: apply default only when typeof col.grouping.groupPriority === 'undefined' || col.grouping.groupPriority < 0. Test with a custom aggregation function to ensure it is not overwritten.
Grouppriority default treeAggregationFn overwrite bug · angular-ui/ui-grid#5123 | Good First Issue