[Bug] TypeError in getDataParams when getData() returns null on disposed series

オープン
#21,535 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript

調査の方向性

まず dataFormat.ts の DataFormatMixin.getDataParams() と、TreemapSeries.ts、SunburstSeries.ts、TreeSeries.ts、PieSeries.ts、FunnelSeries.ts、ChordSeries.ts にある getDataParams() のオーバーライドを読みます。echarts.ts:778 と TooltipView.ts:385, 458 の呼び出し元からイベントの経路を追跡し、インタラクション中の破棄を再現します。完了条件は、列挙したチャートタイプ全体で古いマウスイベントが TypeErrors なしに無視されることです。

索引モデルが issue の本文から書いたものです。

説明

en pending
Version

6.0.0 (bug present since at least 4.1.0)

Link to Minimal Reproduction

N/A — occurs in any framework (React, Vue, Angular) where chart components unmount during user interaction.

Steps to Reproduce
  1. Render any chart (sankey, treemap, pie, line) with mouse event handlers
  2. Navigate away (unmount the component) or call setOption with replacement data while the mouse cursor is over the chart
  3. A stale mousemove/mouseout event fires after dispose() clears the series data
Current Behavior

TypeError crashes:

  • Cannot read properties of undefined (reading 'getRawIndex') — from DataFormatMixin.getDataParams() base method
  • Cannot read properties of undefined (reading 'tree') — from TreemapSeriesModel.getDataParams() override
  • Similar crashes possible in pie (.each), funnel (.mapDimension), sunburst/tree (.tree), chord (.getName)

Stack trace (Sankey example):

DataFormatMixin.getDataParams (dataFormat.ts)
SankeySeriesModel.getDataParams (SankeySeries.ts)
<anonymous> (echarts.ts:778) — findEventDispatcher callback
ECharts.handler → Handler.mousemove → HandlerDomProxy.mousemove

Stack trace (Treemap example):

TreemapSeriesModel.getDataParams (TreemapSeries.ts:126)
<anonymous> (echarts.ts:778)
findEventDispatcher → ECharts.handler → Handler.mousemove
Expected Behavior

Mouse events on disposed chart elements should be silently ignored, not throw TypeErrors.

Root Cause

SeriesModel.getData() can return null/undefined when a series is not alive. The comment in Series.ts explicitly acknowledges this:

// When series is not alive (that may happen when click toolbox
// restore or setOption with not merge mode), series data may
// be still need to judge animation or something when graphic
// elements want to know whether fade out.
return inner(this).data;  // ← can be undefined

But getDataParams() and its 6 chart-specific overrides unconditionally access properties on the result. The event handler at echarts.ts calls getDataParams() on mouse events, which can fire on stale DOM elements after the series is disposed.

13+ vulnerable call sites identified:

  • dataFormat.ts — base getDataParams() calls data.getRawIndex(), data.getName(), etc.
  • echarts.ts:778 — event handler calls getDataParams() on potentially dead series
  • TreemapSeries.ts, SunburstSeries.ts, TreeSeries.ts — override accesses data.tree
  • PieSeries.ts — override accesses data.each(), data.mapDimension()
  • FunnelSeries.ts — override accesses data.mapDimension(), data.getSum()
  • ChordSeries.ts — override accesses data.getName(), this.getGraph()
  • TooltipView.ts:385, 458 — unguarded callers

Affects all chart types and all frameworks where component lifecycle causes chart disposal during user interaction.

Related Issues
  • #9402 — Original report (pie chart, closed 2018 as "cannot-reproduce" but never fixed)
  • #16998 — Same error on stacked line chart (open)
Environment
  • OS: macOS (also reproducible on Linux/Windows)
  • Browser: Chrome, Firefox, Safari
  • Framework: React 19 + Next.js 16 (but framework-agnostic)
主要言語
TypeScript
スター
67.7k
フォーク
19.9k
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apache/echarts のほかの issue

apache/echarts の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。