pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIX] web: keep server group order in pivot

Browse Source 
In the pivot view, groups comming from many read_group are assemble
to create the header hierarchies and the table.

Groups returned by the read_group may be already sorted by the server
using the order set on the model for instance and that order should
be reflected in the header hierarchies (and in the table).
It is important to keep that order since it might not be possible
to recreate it in the interface. Even if possible it might not be a
good idea for performance reasons.

Before this commit:
The groups are added in a JS object, whose keys are the group ids
(when grouping on a many2one at least). Then, to generate the table,
we iterate over the keys of that object, but those keys are sorted
according to the numerical order (not the insertion order),
because keys are kind of numeric.
See https://stackoverflow.com/questions/5525795/does-javascript-guarantee-object-property-order.

After this commit:
Instead of a JS object, we use a Map for which the insertion order
is used (official spec).

Task ID: 2243416

closes odoo/odoo#50551

X-original-commit: 1a9a85c8b8d0f47c3c6f3878cd6d9401ddc3ad75
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
This commit is contained in:
Mathieu Duckerts-Antoine
2020-05-04 09:36:01 +00:00
parent 3b80166e6d
commit d57e500081
2 changed files with 92 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/web/static/src/js/views/pivot/pivot_model.js
+38 -39
View File
@@ -169,18 +169,20 @@ odoo.define('web.PivotModel', function (require) {
* labels: [la1,...,lal]
* },
* directSubTrees: {
* JSON.stringify(v): {
* v => {
* root: {
* values: [v1,...,vl,v]
* labels: [label1,...,labell,label]
* },
* directSubTrees: {...}
* },
* JSON.stringify(v'): {...},
* v' => {...},
* ...
* }
* }
*
* (directSubTrees is a Map instance)
*
* In the example, the rowGroupTree is:
*
* {
@@ -189,40 +191,40 @@ odoo.define('web.PivotModel', function (require) {
* labels: []
* },
* directSubTrees: {
* 1: {
* 1 => {
* root: {
* values: [1],
* labels: ['Europe'],
* },
* directSubTrees: {
* 1: {
* 1 => {
* root: {
* values: [1, 1],
* labels: ['Europe', 'Brussels'],
* },
* directSubTrees: {},
* directSubTrees: new Map(),
* },
* 2: {
* 2 => {
* root: {
* values: [1, 2],
* labels: ['Europe', 'Paris'],
* },
* directSubTrees: {},
* directSubTrees: new Map(),
* },
* },
* },
* 2: {
* 2 => {
* root: {
* values: [2],
* labels: ['America'],
* },
* directSubTrees: {
* 3: {
* 3 => {
* root: {
* values: [2, 3],
* labels: ['America', 'Washington'],
* }
* directSubTrees: {},
* directSubTrees: new Map(),
* },
* },
* },
@@ -335,7 +337,7 @@ var PivotModel = AbstractModel.extend({
tree = this.colGroupTree;
group = this._findGroup(this.colGroupTree, groupId[1]);
}
group.directSubTrees = {};
group.directSubTrees.clear();
delete group.sortedKeys;
var newGroupBysLength = this._getTreeHeight(tree) - 1;
if (newGroupBysLength <= groupBys.length) {
@@ -650,7 +652,7 @@ var PivotModel = AbstractModel.extend({
var sortFunction = function (tree) {
return function (subTreeKey) {
var subTree = tree.directSubTrees[subTreeKey];
var subTree = tree.directSubTrees.get(subTreeKey);
var groupIntersectionId = [subTree.root.values, colGroupValues];
var value = self._getCellValue(
groupIntersectionId,
@@ -701,16 +703,15 @@ var PivotModel = AbstractModel.extend({
var tree = groupTree;
// we assume here that the group with value value.slice(value.length - 2) has already been added.
values.slice(0, values.length - 1).forEach(function (value) {
var key = JSON.stringify(value);
tree = tree.directSubTrees[key];
tree = tree.directSubTrees.get(value);
});
tree.directSubTrees[JSON.stringify(values[values.length - 1])] = {
tree.directSubTrees.set(values[values.length - 1], {
root: {
labels: labels,
values: values,
},
directSubTrees: {},
};
directSubTrees: new Map(),
});
},
/**
* Compute what should be used as rowGroupBys by the pivot view
@@ -733,8 +734,7 @@ var PivotModel = AbstractModel.extend({
_findGroup: function (groupTree, values) {
var tree = groupTree;
values.slice(0, values.length).forEach(function (value) {
var key = JSON.stringify(value);
tree = tree.directSubTrees[key];
tree = tree.directSubTrees.get(value);
});
return tree;
},
@@ -866,10 +866,10 @@ var PivotModel = AbstractModel.extend({
var self = this;
var leafCounts = {};
var leafCount;
if (_.isEmpty(tree.directSubTrees)) {
if (!tree.directSubTrees.size) {
leafCount = 1;
} else {
leafCount = _.values(tree.directSubTrees).reduce(
leafCount = [...tree.directSubTrees.values()].reduce(
function (acc, subTree) {
var subLeafCounts = self._getLeafCounts(subTree);
_.extend(leafCounts, subLeafCounts);
@@ -1123,7 +1123,7 @@ var PivotModel = AbstractModel.extend({
var rowIndex = group.values.length;
var row = colGroupRows[rowIndex];
var groupId = [[], group.values];
var isLeaf = _.isEmpty(tree.directSubTrees);
var isLeaf = !tree.directSubTrees.size;
var leafCount = leafCounts[JSON.stringify(tree.root.values)];
var cell = {
groupId: groupId,
@@ -1138,7 +1138,7 @@ var PivotModel = AbstractModel.extend({
measureColumns.push(cell);
}
_.values(tree.directSubTrees).forEach(function (subTree) {
[...tree.directSubTrees.values()].forEach(function (subTree) {
generateTreeHeaders(subTree, fields);
});
}
@@ -1185,7 +1185,7 @@ var PivotModel = AbstractModel.extend({
var rowGroupId = [group.values, []];
var title = group.labels[group.labels.length - 1] || _t('Total');
var indent = group.labels.length;
var isLeaf = _.isEmpty(tree.directSubTrees);
var isLeaf = !tree.directSubTrees.size;
var rowGroupBys = this._getGroupBys().rowGroupBys;
var subGroupMeasurements = columns.map(function (column) {
@@ -1215,9 +1215,9 @@ var PivotModel = AbstractModel.extend({
subGroupMeasurements: subGroupMeasurements
});
var subTreeKeys = tree.sortedKeys || Object.keys(tree.directSubTrees);
var subTreeKeys = tree.sortedKeys || [...tree.directSubTrees.keys()];
subTreeKeys.forEach(function (subTreeKey) {
var subTree = tree.directSubTrees[subTreeKey];
var subTree = tree.directSubTrees.get(subTreeKey);
rows = rows.concat(self._getTableRows(subTree, columns));
});
@@ -1231,7 +1231,7 @@ var PivotModel = AbstractModel.extend({
* @returns {number}
*/
_getTreeHeight: function (tree) {
var subTreeHeights = _.values(tree.directSubTrees).map(this._getTreeHeight.bind(this));
var subTreeHeights = [...tree.directSubTrees.values()].map(this._getTreeHeight.bind(this));
return Math.max(0, Math.max.apply(null, subTreeHeights)) + 1;
},
/**
@@ -1259,8 +1259,8 @@ var PivotModel = AbstractModel.extend({
_loadData: function () {
var self = this;
this.rowGroupTree = { root: { labels: [], values: [] }, directSubTrees: {} };
this.colGroupTree = { root: { labels: [], values: [] }, directSubTrees: {} };
this.rowGroupTree = { root: { labels: [], values: [] }, directSubTrees: new Map() };
this.colGroupTree = { root: { labels: [], values: [] }, directSubTrees: new Map() };
this.measurements = {};
this.counts = {};
@@ -1414,20 +1414,19 @@ var PivotModel = AbstractModel.extend({
* @param {Object} oldTree
*/
_pruneTree: function (tree, oldTree) {
if (_.isEmpty(oldTree.directSubTrees)) {
tree.directSubTrees = {};
if (!oldTree.directSubTrees.size) {
tree.directSubTrees.clear();
delete tree.sortedKeys;
return;
}
var self = this;
Object.keys(tree.directSubTrees).forEach(function (subTreeKey) {
var index = Object.keys(oldTree.directSubTrees).indexOf(subTreeKey);
var subTree = tree.directSubTrees[subTreeKey];
if (index === -1) {
subTree.directSubTrees = {};
[...tree.directSubTrees.keys()].forEach(function (subTreeKey) {
var subTree = tree.directSubTrees.get(subTreeKey);
if (!oldTree.directSubTrees.has(subTreeKey)) {
subTree.directSubTrees.clear();
delete subTreeKey.sortedKeys;
} else {
var oldSubTree = oldTree.directSubTrees[subTreeKey];
var oldSubTree = oldTree.directSubTrees.get(subTreeKey);
self._pruneTree(subTree, oldSubTree);
}
});
@@ -1519,8 +1518,8 @@ var PivotModel = AbstractModel.extend({
*/
_sortTree: function (sortFunction, tree) {
var self = this;
tree.sortedKeys = _.sortBy(Object.keys(tree.directSubTrees), sortFunction(tree));
_.values(tree.directSubTrees).forEach(function (subTree) {
tree.sortedKeys = _.sortBy([...tree.directSubTrees.keys()], sortFunction(tree));
[...tree.directSubTrees.values()].forEach(function (subTree) {
self._sortTree(sortFunction, subTree);
});
},
addons/web/static/tests/views/pivot_tests.js
+54 -8
View File
@@ -1393,9 +1393,9 @@ QUnit.module('Views', {
await testUtils.dom.click(pivot.$('.o_pivot_field_menu .dropdown-item[data-field="customer"]'));
values = [
"29", "2", "1", "32",
"29", "1", "2", "32",
"12", "12",
"17", "2", "1", "20",
"17", "1", "2", "20",
];
assert.strictEqual(getCurrentValues(pivot), values.join(','));
@@ -1404,10 +1404,10 @@ QUnit.module('Views', {
await testUtils.dom.click(pivot.$('.o_pivot_field_menu .dropdown-item[data-field="other_product_id"]'));
values = [
"29", "2", "1", "32",
"29", "1", "2", "32",
"12", "12",
"17", "2", "1", "20",
"17", "2", "1", "20",
"17", "1", "2", "20",
"17", "1", "2", "20",
];
assert.strictEqual(getCurrentValues(pivot), values.join(','));
@@ -1421,11 +1421,11 @@ QUnit.module('Views', {
// sanity check of what the table should look like if all groups are
// expanded, to ensure that the former asserts are pertinent
values = [
"12", "17", "2", "1", "32",
"12", "17", "1", "2", "32",
"12", "12",
"12", "12",
"17", "2", "1", "20",
"17", "2", "1", "20",
"17", "1", "2", "20",
"17", "1", "2", "20",
];
assert.strictEqual(getCurrentValues(pivot), values.join(','));
@@ -2720,6 +2720,52 @@ QUnit.module('Views', {
pivot.destroy();
});
QUnit.test('Server order is kept by default', async function (assert) {
assert.expect(1);
let isSecondReadGroup = false;
var pivot = await createView({
View: PivotView,
model: "partner",
data: this.data,
arch: '<pivot>' +
'<field name="customer" type="row"/>' +
'<field name="foo" type="measure"/>' +
'</pivot>',
mockRPC: function (route, args) {
if (args.method === 'read_group' && isSecondReadGroup) {
return Promise.resolve([
{
customer: [2, 'Second'],
foo: 18,
__count: 2,
__domain :[["customer", "=", 2]],
},
{
customer: [1, 'First'],
foo: 14,
__count: 2,
__domain :[["customer", "=", 1]],
}
]);
}
var result = this._super.apply(this, arguments);
isSecondReadGroup = true;
return result;
},
});
const values = [
"32", // Total Value
"18", // Second
"14", // First
];
assert.strictEqual(getCurrentValues(pivot), values.join());
pivot.destroy();
});
QUnit.test('pivot rendering with boolean field', async function (assert) {
assert.expect(4);