Skip to content

TreeList - DataSourceAdapter - Extract branch loading util #35136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tucchhaa wants to merge 3 commits into
base: main
Choose a base branch
from
Open

TreeList - DataSourceAdapter - Extract branch loading util #35136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
95f5c9f
move branch loading logic to a separate util
Sep 10, 2026
3b52e98
add types
Sep 10, 2026
efcf6b8
add tests
Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...ges/devextreme/js/__internal/grids/grid_core/data_source_adapter/m_data_source_adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export default class DataSourceAdapter extends modules.Controller {

private _cachedData: any;

protected _cachedStoreData: any;
protected _cachedStoreData?: RawItemData[];

private _cachedPagingData: any;

Expand Down Expand Up @@ -259,7 +259,7 @@ export default class DataSourceAdapter extends modules.Controller {
this._totalCountCorrection = 0;
}

protected setCachedStoreData(data): void {
protected setCachedStoreData(data: RawItemData[] | undefined): void {
this._cachedStoreData = data;
this._dataIndexByKey = undefined;
}
Expand Down Expand Up @@ -616,7 +616,7 @@ export default class DataSourceAdapter extends modules.Controller {
if (!this._cachedStoreData) {
this.setCachedStoreData(cloneItems(options.data, gridCoreUtils.normalizeSortingInfo(storeLoadOptions.group).length));
} else if (options.mergeStoreLoadData) {
this.setCachedStoreData(this._cachedStoreData.concat(options.data));
this.setCachedStoreData(this._cachedStoreData.concat(options.data as RawItemData[]));
options.data = this._cachedStoreData;
}
}
Expand Down
15 changes: 9 additions & 6 deletions ...evextreme/js/__internal/grids/tree_list/data_source_adapter/m_data_source_adapter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import CustomStore from '@js/data/custom_store';
import DataSource from '@js/data/data_source';

import { DataSourceAdapterTreeList } from './m_data_source_adapter';
import type { LoadOperation } from './types';
import { loadBranches } from './utils/load_branches';

describe('TreeList DataSourceAdapter - T1311885 Race Condition', () => {
let dataSourceAdapter: DataSourceAdapterTreeList;
Expand Down Expand Up @@ -95,7 +97,7 @@ describe('TreeList DataSourceAdapter - T1311885 Race Condition', () => {
dataSourceAdapter = undefined as any;
});

test('T1311885 - _loadParentsOrChildren should NOT throw concat error when _cachedStoreData is cleared', async () => {
test('T1311885 - loading branches should NOT throw concat error when _cachedStoreData is cleared', async () => {

@anna-shakhova anna-shakhova Sep 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from agent: The T1311885 test no longer touches the adapter at all — it reaches in for the context and calls the free function. The new unit test already asserts the same thing

let firstLoadDeferred: any = null;
let errorMessage = '';

Expand All @@ -116,7 +118,7 @@ describe('TreeList DataSourceAdapter - T1311885 Race Condition', () => {
storeLoadOptions: { sort: null },
loadOptions: { sort: null },
operationId: OPERATION_ID.FIRST,
};
} as unknown as LoadOperation;

// eslint-disable-next-line @typescript-eslint/no-unused-vars
dataSourceAdapter.customLoader.loadFromStore = jest.fn((loadOptions) => {
Expand All @@ -130,10 +132,11 @@ describe('TreeList DataSourceAdapter - T1311885 Race Condition', () => {
return deferred.promise();
});

(dataSourceAdapter as any)._loadParentsOrChildren(
childData,
options,
);
// The context snapshots the dataSource and the customLoader, so it has to be
// built after the stubs above are in place.
const context = (dataSourceAdapter as any).getLoadBranchesContext();

loadBranches(context, childData, options, false);

expect(dataSourceAdapter.customLoader.loadFromStore).toHaveBeenCalledTimes(1);
expect(firstLoadDeferred).toBeDefined();
Expand Down
220 changes: 38 additions & 182 deletions ...ges/devextreme/js/__internal/grids/tree_list/data_source_adapter/m_data_source_adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
import ArrayStore from '@js/common/data/array_store';
import { createObjectWithChanges } from '@js/common/data/array_utils';
import query from '@js/common/data/query';
import storeHelper from '@js/common/data/store_helper';
import { equalByValue } from '@js/core/utils/common';
import { compileGetter, compileSetter } from '@js/core/utils/data';
import { Deferred, when } from '@js/core/utils/deferred';
import { extend } from '@js/core/utils/extend';
import { each } from '@js/core/utils/iterator';
import { Deferred } from '@js/core/utils/deferred';
import { isDefined, isFunction } from '@js/core/utils/type';
import errors from '@js/ui/widget/ui.errors';
import type Store from '@ts/data/abstract_store';
import type { ChangingEvent } from '@ts/data/data_source/types';
import type { BeforePushEvent } from '@ts/data/types';
import type { CustomLoadResult } from '@ts/grids/grid_core/data_source_adapter/custom_loader';
import DataSourceAdapter from '@ts/grids/grid_core/data_source_adapter/m_data_source_adapter';
import { createDataSourceAdapterProvider } from '@ts/grids/grid_core/data_source_adapter/provider';
import type { RawItemData } from '@ts/grids/grid_core/data_source_adapter/types';
import gridCoreUtils from '@ts/grids/grid_core/m_utils';

import treeListCore from '../m_core';
import type { LoadOperation, NodeByKey, TreeNode } from './types';
import { createIdFilter } from './utils/create_id_filter';
import type { LoadBranchesContext } from './utils/load_branches';
import { loadBranches } from './utils/load_branches';
import type { NodesContext } from './utils/nodes';
import {
convertItemToNode, createNodesByItems, fillNodes, getVisibleNodes,
Expand All @@ -45,16 +44,7 @@ const getChildKeys = function (that, keys) {
return childKeys;
};

const applySorting = (data: any[], sort: any): any => queryByOptions(
query(data),
{
sort,
},
).toArray();

export class DataSourceAdapterTreeList extends DataSourceAdapter {
private _indexByKey: any;

private _keyGetter: any;

private _parentIdGetter: any;
Expand Down Expand Up @@ -133,16 +123,6 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
return hasItemsExpr && compileSetter(hasItemsExpr);
}

private _updateIndexByKeyObject(items) {
const that = this;

that._indexByKey = {};

each(items, (index, item) => {
that._indexByKey[item.key] = index;
});
}

private _getNodesContext(): NodesContext {
return {
rootValue: this.option('rootValue'),
Expand All @@ -154,6 +134,24 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
};
}

private getLoadBranchesContext(): LoadBranchesContext {
return {
dataSource: this._dataSource,

@anna-shakhova anna-shakhova Sep 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dataSource and customLoader are grabbed once per load. If the data source is swapped mid-load, the in-flight recursion keeps loading from the dead store. It only needs dataSource for one cancel() call — pass cancel: (id) => this.cancel(id)

customLoader: this.customLoader,
rootValue: this.option('rootValue'),
maxFilterLengthInRequest: this.option('maxFilterLengthInRequest'),
parentIdExpr: this.option('parentIdExpr'),
keyExpr: this.getKeyExpr(),
_parentIdGetter: this._parentIdGetter,
_keyGetter: this._keyGetter,
isRowExpanded: (key) => this.isRowExpanded(key),

@anna-shakhova anna-shakhova Sep 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: lets use same approach for isRowExpanded, setCachedData, getNodeByKey - arrow function or bind

getCachedData: () => this._cachedStoreData,
setCachedData: this.setCachedStoreData.bind(this),
getLastOperationId: () => this._lastOperationId,
getNodeByKey: this.getNodeByKey.bind(this),
};
}

private _convertDataToPlainStructure(data, parentId?, result?) {
let key;

Expand Down Expand Up @@ -193,15 +191,6 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
return data;
}

private _createIdFilter(field, keys) {
const parentIdFilters: any[] = [];

for (let i = 0; i < keys.length; i++) {
parentIdFilters.push([field, '=', keys[i]]);
}
return gridCoreUtils.combineFilters(parentIdFilters, 'or');
}

protected override _calculateOperationTypes(loadOptions, lastLoadOptions, isFullReload?: boolean) {
const currentExpandedKeys = this.option('expandedRowKeys');

Expand Down Expand Up @@ -291,154 +280,11 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
}

options.storeLoadOptions.parentIds = parentIdsToLoad;
options.storeLoadOptions.filter = this._createIdFilter(parentIdExpr, parentIdsToLoad);
options.storeLoadOptions.filter = createIdFilter(parentIdExpr, parentIdsToLoad);
}
}
}

private _generateInfoToLoad(data, needChildren) {
const that = this;
let key;
const keyMap = {};
const resultKeyMap = {};
const resultKeys: any[] = [];
const rootValue = that.option('rootValue');
let i;

for (i = 0; i < data.length; i++) {
key = needChildren ? that._parentIdGetter(data[i]) : that._keyGetter(data[i]);
keyMap[key] = true;
}

for (i = 0; i < data.length; i++) {
key = needChildren ? that._keyGetter(data[i]) : that._parentIdGetter(data[i]);
const needToLoad = needChildren ? that.isRowExpanded(key) : key !== rootValue;

if (!keyMap[key] && !resultKeyMap[key] && needToLoad) {
resultKeyMap[key] = true;
resultKeys.push(key);
}
}

return {
keyMap: resultKeyMap,
keys: resultKeys,
};
}

private _isOperationIdOutdated(operationId) {
return operationId !== undefined
&& this._lastOperationId !== undefined
&& operationId !== this._lastOperationId;
}

private _loadParentsOrChildren(data, options, needChildren?) {
if (this._isOperationIdOutdated(options.operationId)) {
this._dataSource.cancel(options.operationId);
// @ts-expect-error
const rejectedDeferred = new Deferred();
rejectedDeferred.reject();
return rejectedDeferred;
}

let filter;
let needLocalFiltering;
const { keys, keyMap } = this._generateInfoToLoad(data, needChildren);
// @ts-expect-error
const d = new Deferred();
const isRemoteFiltering = options.remoteOperations.filtering;
const maxFilterLengthInRequest = this.option('maxFilterLengthInRequest');
const sort = options.storeLoadOptions?.sort ?? options.loadOptions?.sort;
let loadOptions = isRemoteFiltering ? options.storeLoadOptions : options.loadOptions;

const concatLoadedData = (loadedData): any => {
if (isRemoteFiltering) {
const updatedData = applySorting(
this._cachedStoreData.concat(loadedData),
sort,
);

this.setCachedStoreData(updatedData);
}

return applySorting(
data.concat(loadedData),
sort,
);
};

if (!keys.length) {
return d.resolve(data);
}

let cachedNodes = keys
.map((id) => this.getNodeByKey(id))
.filter((node) => node && node.data) as TreeNode[];

if (cachedNodes.length === keys.length) {
if (needChildren) {
cachedNodes = cachedNodes.reduce((result: TreeNode[], node) => result.concat(node.children), []);
}

if (cachedNodes.length) {
return this._loadParentsOrChildren(concatLoadedData(cachedNodes.map((node) => node.data)), options, needChildren);
}
}

const keyExpr = needChildren ? this.option('parentIdExpr') : this.getKeyExpr();
filter = this._createIdFilter(keyExpr, keys);
const filterLength = encodeURI(JSON.stringify(filter)).length;

if (filterLength > maxFilterLengthInRequest) {
filter = (itemData) => keyMap[needChildren ? this._parentIdGetter(itemData) : this._keyGetter(itemData)];

needLocalFiltering = isRemoteFiltering;
}

loadOptions = extend({}, loadOptions, {
filter: !needLocalFiltering ? filter : null,
});

const loadBranchItemsDeferred = options.fullData
? new ArrayStore(options.fullData).load(loadOptions)
: this.customLoader.loadFromStore(loadOptions);

loadBranchItemsDeferred
.done((loadResult: CustomLoadResult | unknown[]) => {
let loadedData = Array.isArray(loadResult) ? loadResult : loadResult.data;

if (this._isOperationIdOutdated(options.operationId)) {
d.reject();
return;
}

if (loadedData.length) {
if (needLocalFiltering) {
loadedData = query(loadedData).filter(filter).toArray();
}

this._loadParentsOrChildren(concatLoadedData(loadedData), options, needChildren).done(d.resolve).fail(d.reject);
} else {
d.resolve(data);
}
})
.fail(d.reject);

return d;
}

private _loadParents(data, options) {
return this._loadParentsOrChildren(data, options);
}

private _loadChildrenIfNeed(data, options) {
if (isFullBranchFilterMode(this)) {
return this._loadParentsOrChildren(data, options, true);
}

return when(data);
}

private _updateHasItemsMap(options) {
const { parentIds } = options.storeLoadOptions;

Expand Down Expand Up @@ -569,6 +415,7 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
}

if (data.isConverted && this._cachedStoreData) {
// @ts-expect-error
this._cachedStoreData.isConverted = true;
}
}
Expand Down Expand Up @@ -634,14 +481,23 @@ export class DataSourceAdapterTreeList extends DataSourceAdapter {
visibleItems = data;
}

return that._loadParents(data, options).done((data) => {
that._loadChildrenIfNeed(data, options).done((data) => {
options.data = data;
const needLoadChildren = isFullBranchFilterMode(this);

loadBranches(
this.getLoadBranchesContext(),
data as RawItemData[],
options,
needLoadChildren,
)
.done((loadedData) => {
options.data = loadedData;
that._processTreeStructure(options, visibleItems);
super.customizeLoadResultHandlerCore.call(that, options);
d.resolve(options.data);
});
}).fail(d.reject);
})
.fail(d.reject);

return;
}
that._processTreeStructure(options);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/devextreme/js/__internal/grids/tree_list/data_source_adapter/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface LoadOperation extends BaseLoadOperation {
export interface TreeNode {
key: unknown;
children: TreeNode[];
data?: unknown;
data?: RawItemData;
parent?: TreeNode;
level?: number;
visible?: boolean;
Expand Down
Loading
Loading