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

Fixing Memory Leak #3592

Closed
wants to merge 2 commits into from
Closed

Fixing Memory Leak #3592

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
05162d6
Remove Event Listeners on Component Unmount
KamruzzamanAsif Jan 28, 2025
efe5c51
Fix Memory Leaks
KamruzzamanAsif Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 104 additions & 80 deletions packages/react-ui/internal/FocusControlWrapper/FocusControlWrapper.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,104 @@
import React, { CSSProperties, FC, FormEvent, PropsWithChildren, useCallback, useState } from 'react';
import { globalObject } from '@skbkontur/global-object';
import type { Meta } from '@storybook/react';

import type { Story } from '../../typings/stories';

import { FocusControlWrapper } from './FocusControlWrapper';

export default { title: 'FocusControlWrapper' } as Meta;

const Header: FC<PropsWithChildren<any>> = ({ children }) => <h1 style={{ margin: 10 }}>{children}</h1>;
const Wrapper: FC<PropsWithChildren<any>> = ({ children }) => (
<div style={{ border: 'black solid 1px', margin: 10, padding: 10 }}>{children}</div>
);

const useFormHandlers = () => {
const [isDisabled, setIsDisabled] = useState(false);

const handleSubmit = useCallback((e: FormEvent) => {
e.preventDefault();
e.stopPropagation();
new Promise((resolve) => {
setIsDisabled(true);
setTimeout(resolve, 100);
}).then(() => setIsDisabled(false));
}, []);

const handleKeyDown = useCallback((e: KeyboardEvent) => {
if (e.key === 'Enter') {
new Promise((resolve) => {
setIsDisabled(true);
setTimeout(resolve, 100);
}).then(() => setIsDisabled(false));
}
}, []);

globalObject.document?.addEventListener('keydown', handleKeyDown);

return {
isDisabled,
handleSubmit,
};
};

const BrokenInput = ({ disabled }: { disabled?: boolean }) => {
const [focus, setFocus] = useState<boolean>(false);

const styles: CSSProperties = focus ? { border: '1px solid blue' } : {};

const handleBlur = () => setFocus(false);
const handleFocus = () => setFocus(true);
const handleResetFocus = () => setFocus(false);

return (
<FocusControlWrapper onBlurWhenDisabled={handleResetFocus}>
<input type="text" disabled={disabled} style={styles} onBlur={handleBlur} onFocus={handleFocus} />
</FocusControlWrapper>
);
};

export const Input: Story = () => {
const { isDisabled, handleSubmit } = useFormHandlers();
return (
<>
<Header>Форма</Header>
<Wrapper>
<form onSubmit={handleSubmit}>
<BrokenInput disabled={isDisabled} />
<button type="submit">Submit</button>
</form>
</Wrapper>
</>
);
};

Input.parameters = {
creevey: {
skip: true,
},
};
import React, {
CSSProperties,
FC,
FormEvent,
PropsWithChildren,
useCallback,
useState,
useEffect,
useRef,
} from 'react';
import { globalObject } from '@skbkontur/global-object';
import type { Meta } from '@storybook/react';

import type { Story } from '../../typings/stories';

import { FocusControlWrapper } from './FocusControlWrapper';

export default { title: 'FocusControlWrapper' } as Meta;

const Header: FC<PropsWithChildren<any>> = ({ children }) => <h1 style={{ margin: 10 }}>{children}</h1>;
const Wrapper: FC<PropsWithChildren<any>> = ({ children }) => (
<div style={{ border: 'black solid 1px', margin: 10, padding: 10 }}>{children}</div>
);

const useFormHandlers = () => {
const _timeOutID2: any = useRef(null);
const _timeOutID: any = useRef(null);
let _controller: any = new AbortController();

useEffect(() => {
return () => {
_controller?.abort();
_controller = null;
clearTimeout(_timeOutID.current);
clearTimeout(_timeOutID2.current);
};
}, []);

const [isDisabled, setIsDisabled] = useState(false);

const handleSubmit = useCallback((e: FormEvent) => {
e.preventDefault();
e.stopPropagation();
new Promise((resolve) => {
setIsDisabled(true);
_timeOutID.current = setTimeout(resolve, 100);
}).then(() => setIsDisabled(false));
}, []);

const handleKeyDown = useCallback((e: KeyboardEvent) => {
if (e.key === 'Enter') {
new Promise((resolve) => {
setIsDisabled(true);
_timeOutID2.current = setTimeout(resolve, 100);
}).then(() => setIsDisabled(false));
}
}, []);

globalObject.document?.addEventListener('keydown', handleKeyDown, {
signal: _controller?.signal
} as AddEventListenerOptions);

return {
isDisabled,
handleSubmit,
};
};

const BrokenInput = ({ disabled }: { disabled?: boolean }) => {
const [focus, setFocus] = useState<boolean>(false);

const styles: CSSProperties = focus ? { border: '1px solid blue' } : {};

const handleBlur = () => setFocus(false);
const handleFocus = () => setFocus(true);
const handleResetFocus = () => setFocus(false);

return (
<FocusControlWrapper onBlurWhenDisabled={handleResetFocus}>
<input type="text" disabled={disabled} style={styles} onBlur={handleBlur} onFocus={handleFocus} />
</FocusControlWrapper>
);
};

export const Input: Story = () => {
const { isDisabled, handleSubmit } = useFormHandlers();
return (
<>
<Header>Форма</Header>
<Wrapper>
<form onSubmit={handleSubmit}>
<BrokenInput disabled={isDisabled} />
<button type="submit">Submit</button>
</form>
</Wrapper>
</>
);
};

Input.parameters = {
creevey: {
skip: true,
},
};
92 changes: 46 additions & 46 deletions packages/react-ui/internal/FocusControlWrapper/FocusControlWrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
import React, { PropsWithChildren, isValidElement, cloneElement, ReactElement } from 'react';

import { CommonWrapper } from '../CommonWrapper';

import { useFocusControl } from './useFocusControl';

interface Props {
/**
* Использовать только когда на children нет пропса disabled
*/
disabled?: boolean;

/**
* Событие вызывается когда элемент потеряет фокус, и при этом он задисэйблен
*/
onBlurWhenDisabled(): void | undefined;
}

export function FocusControlWrapper({ disabled, children, onBlurWhenDisabled, ...rest }: PropsWithChildren<Props>) {
const isValidChildren = children && isValidElement(children);

const { handleFocus, handleBlur } = useFocusControl({
disabled: disabled ?? (isValidChildren ? (children as ReactElement).props.disabled : undefined),
onFocus: isValidChildren ? (children as ReactElement).props.onFocus : undefined,
onBlur: isValidChildren ? (children as ReactElement).props.onBlur : undefined,
onBlurWhenDisabled,
});

if (!isValidChildren) {
return null;
}

return (
<CommonWrapper {...rest}>
{React.Children.only(
cloneElement(children as ReactElement, {
onFocus: handleFocus,
onBlur: handleBlur,
}),
)}
</CommonWrapper>
);
}

FocusControlWrapper.__KONTUR_REACT_UI__ = 'FocusControlWrapper';
FocusControlWrapper.displayName = 'FocusControlWrapper';
import React, { PropsWithChildren, isValidElement, cloneElement, ReactElement } from 'react';
import { CommonWrapper } from '../CommonWrapper';
import { useFocusControl } from './useFocusControl';
interface Props {
/**
* Использовать только когда на children нет пропса disabled
*/
disabled?: boolean;
/**
* Событие вызывается когда элемент потеряет фокус, и при этом он задисэйблен
*/
onBlurWhenDisabled(): void | undefined;
}
export function FocusControlWrapper({ disabled, children, onBlurWhenDisabled, ...rest }: PropsWithChildren<Props>) {
const isValidChildren = children && isValidElement(children);
const { handleFocus, handleBlur } = useFocusControl({
disabled: disabled ?? (isValidChildren ? (children as ReactElement).props.disabled : undefined),
onFocus: isValidChildren ? (children as ReactElement).props.onFocus : undefined,
onBlur: isValidChildren ? (children as ReactElement).props.onBlur : undefined,
onBlurWhenDisabled,
});
if (!isValidChildren) {
return null;
}
return (
<CommonWrapper {...rest}>
{React.Children.only(
cloneElement(children as ReactElement, {
onFocus: handleFocus,
onBlur: handleBlur,
}),
)}
</CommonWrapper>
);
}
FocusControlWrapper.__KONTUR_REACT_UI__ = 'FocusControlWrapper';
FocusControlWrapper.displayName = 'FocusControlWrapper';
2 changes: 1 addition & 1 deletion packages/react-ui/internal/FocusControlWrapper/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from './FocusControlWrapper';
export * from './FocusControlWrapper';
68 changes: 34 additions & 34 deletions packages/react-ui/internal/FocusControlWrapper/useFocusControl.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
import React, { useEffect, useState } from 'react';

interface Props {
disabled?: boolean;
onFocus?: React.FocusEventHandler;
onBlur?: React.FocusEventHandler;
onBlurWhenDisabled?(): void;
}

export function useFocusControl({ disabled, onFocus, onBlur, onBlurWhenDisabled }: Props) {
const [isFocused, setFocused] = useState<boolean>(false);

useEffect(() => {
if (disabled && isFocused && onBlurWhenDisabled) {
// force calling custom blur event, try "fix" bug in react https://github.com/facebook/react/issues/9142
onBlurWhenDisabled();
}
}, [disabled, isFocused]);

const handleFocus = (e: React.FocusEvent) => {
setFocused(true);
onFocus?.(e);
};

const handleBlur = (e: React.FocusEvent) => {
setFocused(false);
onBlur?.(e);
};

return {
handleFocus,
handleBlur,
};
}
import React, { useEffect, useState } from 'react';
interface Props {
disabled?: boolean;
onFocus?: React.FocusEventHandler;
onBlur?: React.FocusEventHandler;
onBlurWhenDisabled?(): void;
}
export function useFocusControl({ disabled, onFocus, onBlur, onBlurWhenDisabled }: Props) {
const [isFocused, setFocused] = useState<boolean>(false);
useEffect(() => {
if (disabled && isFocused && onBlurWhenDisabled) {
// force calling custom blur event, try "fix" bug in react https://github.com/facebook/react/issues/9142
onBlurWhenDisabled();
}
}, [disabled, isFocused]);
const handleFocus = (e: React.FocusEvent) => {
setFocused(true);
onFocus?.(e);
};
const handleBlur = (e: React.FocusEvent) => {
setFocused(false);
onBlur?.(e);
};
return {
handleFocus,
handleBlur,
};
}
Loading