Tracing: Rename reset to clear for consistency (#68821)

Rename reset to clear for consistency
This commit is contained in:
Joey 2023-05-23 09:54:51 +01:00 committed by GitHub
parent b9ee723bb7
commit e6c8ba56c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 22 deletions

View File

@ -40,7 +40,7 @@ describe('<NewTracePageSearchBar>', () => {
setShowSpanFilterMatchesOnly: jest.fn(), setShowSpanFilterMatchesOnly: jest.fn(),
setFocusedSpanIdForSearch: jest.fn(), setFocusedSpanIdForSearch: jest.fn(),
datasourceType: '', datasourceType: '',
reset: jest.fn(), clear: jest.fn(),
totalSpans: 100, totalSpans: 100,
}; };
@ -55,13 +55,13 @@ describe('<NewTracePageSearchBar>', () => {
render(<NewTracePageSearchBarWithProps matches={[]} />); render(<NewTracePageSearchBarWithProps matches={[]} />);
const nextResButton = screen.queryByRole('button', { name: 'Next result button' }); const nextResButton = screen.queryByRole('button', { name: 'Next result button' });
const prevResButton = screen.queryByRole('button', { name: 'Prev result button' }); const prevResButton = screen.queryByRole('button', { name: 'Prev result button' });
const resetFiltersButton = screen.getByRole('button', { name: 'Reset filters button' }); const clearFiltersButton = screen.getByRole('button', { name: 'Clear filters button' });
expect(nextResButton).toBeInTheDocument(); expect(nextResButton).toBeInTheDocument();
expect(prevResButton).toBeInTheDocument(); expect(prevResButton).toBeInTheDocument();
expect(resetFiltersButton).toBeInTheDocument(); expect(clearFiltersButton).toBeInTheDocument();
expect((nextResButton as HTMLButtonElement)['disabled']).toBe(true); expect((nextResButton as HTMLButtonElement)['disabled']).toBe(true);
expect((prevResButton as HTMLButtonElement)['disabled']).toBe(true); expect((prevResButton as HTMLButtonElement)['disabled']).toBe(true);
expect((resetFiltersButton as HTMLButtonElement)['disabled']).toBe(true); expect((clearFiltersButton as HTMLButtonElement)['disabled']).toBe(true);
}); });
it('renders total spans', async () => { it('renders total spans', async () => {

View File

@ -28,7 +28,7 @@ export type TracePageSearchBarProps = {
setShowSpanFilterMatchesOnly: (showMatchesOnly: boolean) => void; setShowSpanFilterMatchesOnly: (showMatchesOnly: boolean) => void;
setFocusedSpanIdForSearch: Dispatch<SetStateAction<string>>; setFocusedSpanIdForSearch: Dispatch<SetStateAction<string>>;
datasourceType: string; datasourceType: string;
reset: () => void; clear: () => void;
totalSpans: number; totalSpans: number;
}; };
@ -40,7 +40,7 @@ export default memo(function NewTracePageSearchBar(props: TracePageSearchBarProp
setShowSpanFilterMatchesOnly, setShowSpanFilterMatchesOnly,
setFocusedSpanIdForSearch, setFocusedSpanIdForSearch,
datasourceType, datasourceType,
reset, clear,
totalSpans, totalSpans,
} = props; } = props;
const [currentSpanIndex, setCurrentSpanIndex] = useState(-1); const [currentSpanIndex, setCurrentSpanIndex] = useState(-1);
@ -93,7 +93,7 @@ export default memo(function NewTracePageSearchBar(props: TracePageSearchBarProp
}; };
const buttonEnabled = spanFilterMatches && spanFilterMatches?.size > 0; const buttonEnabled = spanFilterMatches && spanFilterMatches?.size > 0;
const resetEnabled = useMemo(() => { const clearEnabled = useMemo(() => {
return ( return (
(search.serviceName && search.serviceName !== '') || (search.serviceName && search.serviceName !== '') ||
(search.spanName && search.spanName !== '') || (search.spanName && search.spanName !== '') ||
@ -130,16 +130,16 @@ export default memo(function NewTracePageSearchBar(props: TracePageSearchBarProp
<div className={styles.searchBar}> <div className={styles.searchBar}>
<div className={styles.buttons}> <div className={styles.buttons}>
<> <>
<div className={styles.resetButton}> <div className={styles.clearButton}>
<Button <Button
variant="destructive" variant="destructive"
disabled={!resetEnabled} disabled={!clearEnabled}
type="button" type="button"
fill="outline" fill="outline"
aria-label="Reset filters button" aria-label="Clear filters button"
onClick={reset} onClick={clear}
> >
Reset Clear
</Button> </Button>
<div className={styles.matchesOnly}> <div className={styles.matchesOnly}>
<Switch <Switch
@ -199,7 +199,7 @@ export const getStyles = () => {
justify-content: flex-end; justify-content: flex-end;
margin: 5px 0 0 0; margin: 5px 0 0 0;
`, `,
resetButton: css` clearButton: css`
order: 1; order: 1;
`, `,
nextPrevButtons: css` nextPrevButtons: css`

View File

@ -183,9 +183,9 @@ describe('SpanFilters', () => {
it('should allow resetting filters', async () => { it('should allow resetting filters', async () => {
render(<SpanFiltersWithProps />); render(<SpanFiltersWithProps />);
const resetFiltersButton = screen.getByRole('button', { name: 'Reset filters button' }); const clearFiltersButton = screen.getByRole('button', { name: 'Clear filters button' });
expect(resetFiltersButton).toBeInTheDocument(); expect(clearFiltersButton).toBeInTheDocument();
expect((resetFiltersButton as HTMLButtonElement)['disabled']).toBe(true); expect((clearFiltersButton as HTMLButtonElement)['disabled']).toBe(true);
const serviceValue = screen.getByLabelText('Select service name'); const serviceValue = screen.getByLabelText('Select service name');
const spanValue = screen.getByLabelText('Select span name'); const spanValue = screen.getByLabelText('Select span name');
@ -196,8 +196,8 @@ describe('SpanFilters', () => {
await selectAndCheckValue(user, tagKey, 'TagKey0'); await selectAndCheckValue(user, tagKey, 'TagKey0');
await selectAndCheckValue(user, tagValue, 'TagValue0'); await selectAndCheckValue(user, tagValue, 'TagValue0');
expect((resetFiltersButton as HTMLButtonElement)['disabled']).toBe(false); expect((clearFiltersButton as HTMLButtonElement)['disabled']).toBe(false);
await user.click(resetFiltersButton); await user.click(clearFiltersButton);
expect(screen.queryByText('Service0')).not.toBeInTheDocument(); expect(screen.queryByText('Service0')).not.toBeInTheDocument();
expect(screen.queryByText('Span0')).not.toBeInTheDocument(); expect(screen.queryByText('Span0')).not.toBeInTheDocument();
expect(screen.queryByText('TagKey0')).not.toBeInTheDocument(); expect(screen.queryByText('TagKey0')).not.toBeInTheDocument();

View File

@ -66,7 +66,7 @@ export const SpanFilters = memo((props: SpanFilterProps) => {
const [tagKeys, setTagKeys] = useState<Array<SelectableValue<string>>>(); const [tagKeys, setTagKeys] = useState<Array<SelectableValue<string>>>();
const [tagValues, setTagValues] = useState<{ [key: string]: Array<SelectableValue<string>> }>({}); const [tagValues, setTagValues] = useState<{ [key: string]: Array<SelectableValue<string>> }>({});
const reset = useCallback(() => { const clear = useCallback(() => {
setServiceNames(undefined); setServiceNames(undefined);
setSpanNames(undefined); setSpanNames(undefined);
setTagKeys(undefined); setTagKeys(undefined);
@ -75,8 +75,8 @@ export const SpanFilters = memo((props: SpanFilterProps) => {
}, [setSearch]); }, [setSearch]);
useEffect(() => { useEffect(() => {
reset(); clear();
}, [reset, trace]); }, [clear, trace]);
if (!trace) { if (!trace) {
return null; return null;
@ -369,7 +369,7 @@ export const SpanFilters = memo((props: SpanFilterProps) => {
setShowSpanFilterMatchesOnly={setShowSpanFilterMatchesOnly} setShowSpanFilterMatchesOnly={setShowSpanFilterMatchesOnly}
setFocusedSpanIdForSearch={setFocusedSpanIdForSearch} setFocusedSpanIdForSearch={setFocusedSpanIdForSearch}
datasourceType={datasourceType} datasourceType={datasourceType}
reset={reset} clear={clear}
totalSpans={trace.spans.length} totalSpans={trace.spans.length}
/> />
</Collapse> </Collapse>