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

Đang mở
#21,535 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
42/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
data-visualization

Hướng nghiên cứu

Bắt đầu bằng cách đọc DataFormatMixin.getDataParams() trong dataFormat.ts và các phiên bản override của getDataParams() trong TreemapSeries.ts, SunburstSeries.ts, TreeSeries.ts, PieSeries.ts, FunnelSeries.ts và ChordSeries.ts. Theo dõi đường đi của sự kiện từ echarts.ts:778 và các bên gọi trong TooltipView.ts:385, 458, rồi tái hiện việc giải phóng trong quá trình tương tác. Hoàn thành nghĩa là các sự kiện chuột cũ trên các loại biểu đồ được liệt kê bị bỏ qua mà không có TypeErrors.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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)
Ngôn ngữ chính
TypeScript
Star
67.7k
Fork
19.9k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của apache/echarts

Tất cả issue của apache/echarts

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.