angular / angular/components

bug(tree): Using cdk-tree with ArrayDataSource and Observable can cause expand functionality to fail under certain conditions.

Open
#29,661 1 comment 0 reactions 0 assignees View on GitHub
area: material/tree needs investigation P2
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

### Is this a regression?

- [ ] Yes, this behavior used to work in the previous version

### The previous version in which this bug was not present was

_No response_

### Description

Using cdk-tree with ArrayDataSource and Observable, the expand functionality can fail under the following conditions:
1. The Observable emits more than one value asynchronously.
2. The emitted values are dynamically generated.
3. trackBy is not based on identity comparison.

### Reproduction

StackBlitz link: https://stackblitz.com/edit/2ypkpy?file=src%2Fexample%2Fcdk-tree-flat-children-accessor-example.ts
Steps to reproduce:
Click the tree node toggler

### Expected Behavior

Child nodes expand normally.

### Actual Behavior

Child nodes fail to expand.

### Environment

```
_ _ ____ _ ___
/ \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _|
/ △ \ | '_ \ / _` | | | | |/ _` | '__| | | | | | |
/ ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | |
/_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___|
|___/

Angular CLI: 18.2.1
Node: 18.20.3
Package Manager: yarn 1.22.19
OS: linux x64

Angular: 18.2.2
... animations, cdk, common, compiler, compiler-cli, core, forms
... localize, material, material-experimental
... material-moment-adapter, platform-browser
... platform-browser-dynamic, router

Package Version
---------------------------------------------------------
@angular-devkit/architect 0.1802.1
@angular-devkit/build-angular 18.2.1
@angular-devkit/core 18.2.1
@angular-devkit/schematics 18.2.1
@angular/cli 18.2.1
@schematics/angular 18.2.1
rxjs 7.4.0
typescript 5.5.4
zone.js 0.14.10
```

- Browser(s): Edge 127.0.2651.105
- Operating System (e.g. Windows, macOS, Ubuntu): Windows 11

Contributor guide

Open the contributing guide

Research direction

Start with the linked StackBlitz reproduction, especially src/example/cdk-tree-flat-children-accessor-example.ts, and click the tree node toggler while observing the asynchronous emissions. Trace the cdk-tree behavior for dynamically generated values with a non-identity trackBy; done means child nodes expand normally under those conditions.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.