Skip to content
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

Jump to bottom

fix: #3073 #3862

Merged
merged 2 commits into from Oct 17, 2023
Merged

fix: #3073 #3862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0171b05
fix: #3073
HHongSeungWoo Oct 15, 2023
4226f32
filtering for undefined syncId
HHongSeungWoo Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 5 additions & 21 deletions src/chart/generateCategoricalChart.tsx
View file
Open in desktop
Expand Up @@ -1091,8 +1091,6 @@ export const generateCategoricalChart = ({
return class CategoricalChartWrapper extends Component<CategoricalChartProps, CategoricalChartState> {
static displayName = chartName;

uniqueChartId: string;

clipPathId: string;

cancelDefer: CancelFunction | null;
Expand All @@ -1116,8 +1114,7 @@ export const generateCategoricalChart = ({
constructor(props: CategoricalChartProps) {
super(props);

this.uniqueChartId = _.isNil(props.id) ? uniqueId('recharts') : props.id;
this.clipPathId = `${this.uniqueChartId}-clip`;
this.clipPathId = `${props.id ?? uniqueId('recharts')}-clip`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice. Love the small cleanups.


if (props.throttleDelay) {
this.triggeredAfterMouseMove = _.throttle(this.triggeredAfterMouseMove, props.throttleDelay);
Expand Down Expand Up @@ -1423,21 +1420,12 @@ export const generateCategoricalChart = ({
};
}

/* eslint-disable no-underscore-dangle */
addListener() {
eventCenter.on(SYNC_EVENT, this.handleReceiveSyncEvent);

if (eventCenter.setMaxListeners && eventCenter._maxListeners) {
eventCenter.setMaxListeners(eventCenter._maxListeners + 1);
}
}

removeListener() {
eventCenter.removeListener(SYNC_EVENT, this.handleReceiveSyncEvent);

if (eventCenter.setMaxListeners && eventCenter._maxListeners) {
eventCenter.setMaxListeners(eventCenter._maxListeners - 1);
}
ckifer marked this conversation as resolved.
Show resolved Hide resolved
}

clearDefer = () => {
Expand Down Expand Up @@ -1466,10 +1454,8 @@ export const generateCategoricalChart = ({
}
};

handleReceiveSyncEvent = (cId: number | string, chartId: string, data: CategoricalChartState) => {
const { syncId } = this.props;

if (syncId === cId && chartId !== this.uniqueChartId) {
handleReceiveSyncEvent = (cId: number | string, data: CategoricalChartState) => {
if (this.props.syncId === cId) {
this.clearDefer();
this.cancelDefer = deferer(this.applySyncEvent.bind(this, data));
}
Expand Down Expand Up @@ -1659,10 +1645,8 @@ export const generateCategoricalChart = ({
};

triggerSyncEvent(data: CategoricalChartState) {
const { syncId } = this.props;

if (!_.isNil(syncId)) {
eventCenter.emit(SYNC_EVENT, syncId, this.uniqueChartId, data);
if (this.props.syncId !== undefined) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (this.props.syncId !== undefined) {
if (this.props.syncId != undefined) {

I assume we would also want to catch null, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, there shouldn't be null. Typing errors should be caught by TypeScript.

eventCenter.emit(SYNC_EVENT, this.props.syncId, data);
}
}

Expand Down
12 changes: 2 additions & 10 deletions src/util/Events.ts
View file
Open in desktop
Expand Up @@ -2,19 +2,11 @@ import EventEmitter from 'eventemitter3';

type CategoricalChartState = import('../chart/generateCategoricalChart').CategoricalChartState;

interface EventCenter extends EventEmitter<EventTypes> {
setMaxListeners?(maxListeners: number): void;
_maxListeners?: number;
}
const eventCenter: EventCenter = new EventEmitter();

if (eventCenter.setMaxListeners) {
eventCenter.setMaxListeners(10);
}
const eventCenter: EventEmitter<EventTypes> = new EventEmitter();

export { eventCenter };
export const SYNC_EVENT = 'recharts.syncMouseEvents';

interface EventTypes {
[SYNC_EVENT](syncId: number | string, uniqueChartId: string, data: CategoricalChartState): void;
[SYNC_EVENT](syncId: number | string, data: CategoricalChartState): void;
}
11 changes: 5 additions & 6 deletions test/chart/LineChart.spec.tsx
View file
Open in desktop
@@ -1,6 +1,5 @@
import React, { FC } from 'react';
import { render, fireEvent, screen } from '@testing-library/react';
import type { JSX } from '@babel/types';

import { LineChart, Line, XAxis, YAxis, Tooltip, Brush, CartesianAxis, Legend } from '../../src';

Expand Down Expand Up @@ -393,9 +392,9 @@ describe('<LineChart />', () => {
describe('<LineChart /> - Pure Rendering', () => {
const pureElements = [Line];

const spies: Array<jest.SpyInstance<JSX.Element | null, []>> = [];
const spies: Array<jest.SpyInstance<React.ReactElement | null, []>> = [];
// CartesianAxis is what is actually render for XAxis and YAxis
let axisSpy: jest.SpyInstance<JSX.Element | null, []>;
let axisSpy: jest.SpyInstance<React.ReactElement | null, []>;

// spy on each pure element before each test, and restore the spy afterwards
beforeAll(() => {
Expand Down Expand Up @@ -475,9 +474,9 @@ describe('<LineChart /> - Pure Rendering', () => {
describe('<LineChart /> - Pure Rendering with legend', () => {
const pureElements = [Line];

const spies: Array<jest.SpyInstance<JSX.Element | null, []>> = [];
const spies: Array<jest.SpyInstance<React.ReactElement | null, []>> = [];
// CartesianAxis is what is actually render for XAxis and YAxis
let axisSpy: jest.SpyInstance<JSX.Element | null, []>;
let axisSpy: jest.SpyInstance<React.ReactElement | null, []>;

// spy on each pure element before each test, and restore the spy afterwards
beforeAll(() => {
Expand Down Expand Up @@ -751,7 +750,7 @@ describe('<LineChart /> - Rendering two line charts with syncId', () => {
expect(container.querySelectorAll('.recharts-tooltip-cursor')).toHaveLength(2);

// make sure tooltips display the correct values, synced by data value
expect(screen.queryByText('400')).toBeTruthy();
expect(screen.queryByText('300')).toBeTruthy();
Copy link
Contributor

Choose a reason for hiding this comment

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

This is surprising. Did the test previously capture behaviour that was a bug itself?
Could you please add a storybook test (i.e. in a play function for a story with syncId) to verify that the syncId still works correctly?

Copy link
Member Author

Choose a reason for hiding this comment

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

Great, I'll give it a try.

expect(screen.queryByText('550')).toBeTruthy();

// Check the activeDots are highlighted
Expand Down