bug(cdk-table): Row differ (trackBy) does not detect row template changes
- 主要言語
- TypeScript
- スター
- 25k
- フォーク
- 6.8k
- 平均マージ
- 1日 8時間
- マージ済み PR(30日)
- 91
説明
The CDK Table will detect changes in rows based on a differ which is based on the `trackBy` input function.
https://github.com/angular/components/blob/4152aec5d421d993246b1ede3803027082330492/src/cdk/table/table.ts#L517-L519
This is fine when actual data changes but it does not handle a scenario where the row template has changed but the data has not changed, which is an issue especially when working with virtual scroll.
Since the trackBy handler does not get access to the `rowDef`, only to the index and raw row data, it is not possible to workaround.
> Even if there is access to the rowDef, trackBy is not a predicate so it will be hard to return something logical there, trackBy is for identity, this one needs to happen outside of the trackBy
In some cases, one might write an alternate `trackBy` function but it will not do for all scenarios. Moreover, the `trackBy` function must be dead simple and fast, if the view port is large, showing enough rows with enough columns it becomes a bottleneck.
Usually, most performant way to do the trackBy is just return the index.
However, if the rowDef has changed, it will not be possible to detect it.
Once diff has been calculated, the call to `renderRows` will ignore the change in the row template definition
https://github.com/angular/components/blob/4152aec5d421d993246b1ede3803027082330492/src/cdk/table/table.ts#L611-L623
It will not call `_renderCellTemplateForItem` leaving it with the old template cached in the table.
#### Reproduction
https://stackblitz.com/edit/angular-qvzms7?file=src%2Fapp%2Ftable-flex-basic-example.ts
Basically, we need to have multiple row definitions (CdkRowDef) but `multiTemplateDataRows` is set to false.
We define 2 row templates with `when` predicates, where the 2 predicates are opposite, if one is on the other is off and vice versa.
Using a simple button to toggle a boolean flag we switch between the 2 predicates.
If we use a simple button it will not work, we switch the flag but it does not change the rendered template for the row.
Using the `ChangeDetectorRef` to run manual CD will not work as well because the table handles it's own diff mechanism when it comes to row diffing.
The only way (I found so far...) to force the proper row template to render is calling `_forceRenderDataRows();` which is private. The will force render the entire dataset, using the new row template. This is bad of course, as it's using a private method and it will force render ALL rows, while in real scenarios one will only want some to re-render.
#### Expected Behavior
What behavior were you expecting to see?
Being able to change the row definition template and have the CDK Table autodetect and render it.
#### Actual Behavior
What behavior did you actually see?
CDK Table fail to detect changes in the row definition template.
#### Environment
- Angular: 10+
- CDK/Material: 10+
コントリビューションガイド
調査の方向性
src/cdk/table/table.ts のリンク先の differ セクションと renderRows セクションから始め、次に _renderCellTemplateForItem がどのように使われているかを比較します。複数の CdkRowDef 定義と multiTemplateDataRows=false を使用して、リンク先の StackBlitz で問題を再現します。行の述語を変更すると、非公開の _forceRenderDataRows メソッドに依存せずに適切な行テンプレートがレンダリングされれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- angular, typescript
- 領域
- frontend
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100