frontend/src/app/shared/helpers/drag-and-drop/reorder-delta-builder.spec.ts
// -- copyright
// OpenProject is an open source project management software.
// Copyright (C) 2012-2024 the OpenProject GmbH
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// See COPYRIGHT and LICENSE files for more details.
//++
import {
DEFAULT_ORDER,
MAX_ORDER,
buildDelta,
} from 'core-app/shared/helpers/drag-and-drop/reorder-delta-builder';
import { QueryOrder } from 'core-app/core/apiv3/endpoints/queries/apiv3-query-order';
describe('ReorderDeltaBuilder', () => {
const work_packages:string[] = ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10'];
function buildSpecDelta(
wpId:string,
positions:QueryOrder,
wps:string[] = work_packages,
fromIndex:number|null = null,
toIndex:number|null = null,
) {
// As work_packages is already the list with moved element, simply compute the index
if (!toIndex) {
toIndex = work_packages.indexOf(wpId);
if (toIndex === -1) {
throw new Error('Invalid wpId given for work_packages, must be contained.');
}
}
return buildDelta(wps, positions, wpId, toIndex, fromIndex);
}
it('Empty, inserting at beginning sets the delta for wpId 1 to the default value', () => {
const delta = buildSpecDelta('1', {});
expect(Object.keys(delta)).toEqual(['1']);
expect(delta['1']).toEqual(DEFAULT_ORDER);
});
it('Empty, inserting at end sets the delta for all predecessors', () => {
const delta = buildSpecDelta('10', {});
expect(Object.keys(delta).length).toEqual(work_packages.length);
expect(delta).toEqual({
1: 0,
2: 16384,
3: 32768,
4: 49152,
5: 65536,
6: 81920,
7: 98304,
8: 114688,
9: 131072,
10: 139264, // 131072 + ORDER_DISTANCE/2
});
});
it('Empty, inserting at end middle the delta for all predecessors', () => {
const delta = buildSpecDelta('5', {});
expect(Object.keys(delta).length).toEqual(5);
expect(delta).toEqual({
1: 0,
2: 16384,
3: 32768,
4: 49152,
5: 57344, // 49152 + 8192
});
});
it('has no problems inserting in the beginning old sort oder (1..n)', () => {
const positions = {
2: 1,
3: 2,
4: 3,
1: 4,
6: 5,
7: 6,
8: 7,
9: 8,
10: 9,
};
const delta = buildSpecDelta('1', positions);
expect(Object.keys(delta).length).toEqual(1);
// Expected to set to 1(position of 2) - 8192(half default distance)
expect(delta['1']).toEqual(-8191);
});
it('has no problems inserting in the middle of old sort oder (1..n)', () => {
const positions = {
1: 0,
2: 1,
3: 2,
4: 4,
6: 5,
7: 6,
8: 7,
9: 8,
10: 9,
};
const delta = buildSpecDelta('5', positions);
expect(Object.keys(delta).length).toEqual(10);
expect(delta).toEqual({
1: 0,
2: 1,
3: 2,
4: 3,
5: 4,
6: 5,
7: 6,
8: 7,
9: 8,
10: 9,
});
});
it('will reorder old sort if there is not enough data', () => {
const positions = {
1: 0,
3: 1,
4: 2,
};
const delta = buildSpecDelta('2', positions);
expect(Object.keys(delta).length).toEqual(10);
expect(delta).toEqual({
1: 0,
2: 1,
3: 2,
4: 3,
5: 4,
6: 5,
7: 6,
8: 7,
9: 8,
10: 9,
});
});
it('will shift min position when successor is max', () => {
const positions = {
1: DEFAULT_ORDER,
2: MAX_ORDER - 1,
4: MAX_ORDER,
};
const delta = buildSpecDelta('3', positions, ['1', '2', '3', '4']);
expect(Object.keys(delta).length).toEqual(4);
expect(delta).toEqual({
// 1 remains at DEFAULT_ORDER
1: DEFAULT_ORDER,
// rest is evenly spaced until MAX
2: 715827882,
// 715827882 * 2
3: 1431655764,
// 715827882 * 3
// gets reassigned due to integer floor()
4: 2147483646,
});
});
it('will shift first position back when predecessor is max', () => {
const positions = {
1: MAX_ORDER - 1,
2: MAX_ORDER,
};
const delta = buildSpecDelta('3', positions, ['1', '2', '3']);
expect(Object.keys(delta).length).toEqual(3);
expect(delta).toEqual({
1: MAX_ORDER - 4,
2: MAX_ORDER - 2,
3: MAX_ORDER,
});
});
it('with successor position, sets the delta for wpId 1 to the default value', () => {
const positions = { 2: DEFAULT_ORDER };
const delta = buildSpecDelta('1', positions);
expect(Object.keys(delta)).toEqual(['1']);
// expect position to be ORDER_DISTANCE/2 before successor position
expect(delta['1']).toEqual(-8192);
});
it('fills in all predecessors when inserting at index > 0', () => {
const positions = {};
const delta = buildSpecDelta('2', positions);
expect(Object.keys(delta)).toEqual(['1', '2']);
// expect position to be ORDER_DISTANCE/2 before successor position
expect(delta['1']).toEqual(0);
expect(delta['2']).toEqual(8192);
});
it('just sets the default when order contains wpId only', () => {
const positions = {};
const delta = buildSpecDelta('1', positions, ['1']);
expect(Object.keys(delta)).toEqual(['1']);
expect(delta['1']).toEqual(0);
});
it('just shifts two values when index <- 1 -> fromIndex', () => {
const positions = {
1: 8192,
2: 0,
3: 16384,
};
// From index 1 to 0
const delta = buildSpecDelta('1', positions, ['1', '2', '3'], 1);
expect(Object.keys(delta)).toEqual(['1', '2']);
expect(delta['1']).toEqual(0);
expect(delta['2']).toEqual(8192);
});
it('adds to the predecessor if successor has no position', () => {
const positions = { 1: 0 };
const delta = buildSpecDelta('2', positions, ['1', '2', '3']);
expect(Object.keys(delta)).toEqual(['2']);
expect(delta['2']).toEqual(8192);
});
it('reorders according to positions when not in ascending order', () => {
const positions = { 1: 0, 2: 1234, 3: 981 };
const delta = buildSpecDelta('1', positions, ['1', '2', '3']);
expect(delta).toEqual({
1: 0,
2: 617,
3: 1234,
});
});
it('reorders according to positions when not in ascending order with missing position', () => {
const positions = { 1: 1234, 3: 981 };
const delta = buildSpecDelta('2', positions, ['1', '2', '3']);
expect(delta).toEqual({
1: 981,
2: 1107, // 981 + floor[(1234-981)/2]
3: 1233, // Due to flooring
});
});
it('reorders on incomplete positions information and moving the first (0 positioned) work package', () => {
// This can happen if a query is saved and the filters on it changed later on so that
// additional work packages are now present.
const delta = buildSpecDelta('1', { 1: 0, 5: 8196 }, ['2', '3', '4', '1', '5'], 0, 3);
expect(delta).toEqual({
2: 0,
3: 2049,
4: 4098,
1: 6147,
5: 8196,
});
});
// It will reassign default orders when not in ascending order and min/max not sufficient
});