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.

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

[7.x] [SIEM] Fixes Signals count spinner (#56797) #56809

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

import { showInitialLoadingSpinner } from './helpers';

describe('helpers', () => {
describe('showInitialLoadingSpinner', () => {
test('it should (only) show the spinner during initial loading, while we are fetching data', () => {
expect(showInitialLoadingSpinner({ isInitialLoading: true, isLoadingSignals: true })).toBe(
true
);
});

test('it should STOP showing the spinner (during initial loading) when the first data fetch completes', () => {
expect(showInitialLoadingSpinner({ isInitialLoading: true, isLoadingSignals: false })).toBe(
false
);
});

test('it should NOT show the spinner after initial loading has completed, even if the user requests more data (e.g. by clicking Refresh)', () => {
expect(showInitialLoadingSpinner({ isInitialLoading: false, isLoadingSignals: true })).toBe(
false
);
});

test('it should NOT show the spinner after initial loading has completed', () => {
expect(showInitialLoadingSpinner({ isInitialLoading: false, isLoadingSignals: false })).toBe(
false
);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,17 @@ export const getSignalsHistogramQuery = (
},
},
});

/**
* Returns `true` when the signals histogram initial loading spinner should be shown
*
* @param isInitialLoading The loading spinner will only be displayed if this value is `true`, because after initial load, a different, non-spinner loading indicator is displayed
* @param isLoadingSignals When `true`, IO is being performed to request signals (for rendering in the histogram)
*/
export const showInitialLoadingSpinner = ({
isInitialLoading,
isLoadingSignals,
}: {
isInitialLoading: boolean;
isLoadingSignals: boolean;
}): boolean => isInitialLoading && isLoadingSignals;
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { InspectButtonContainer } from '../../../../components/inspect';
import { useQuerySignals } from '../../../../containers/detection_engine/signals/use_query';
import { MatrixLoader } from '../../../../components/matrix_histogram/matrix_loader';

import { formatSignalsData, getSignalsHistogramQuery } from './helpers';
import { formatSignalsData, getSignalsHistogramQuery, showInitialLoadingSpinner } from './helpers';
import * as i18n from './translations';

const DEFAULT_PANEL_HEIGHT = 300;
Expand Down Expand Up @@ -54,7 +54,6 @@ interface SignalsHistogramPanelProps {
from: number;
query?: Query;
legendPosition?: Position;
loadingInitial?: boolean;
panelHeight?: number;
signalIndexName: string | null;
setQuery: (params: RegisterQuery) => void;
Expand All @@ -75,7 +74,6 @@ export const SignalsHistogramPanel = memo<SignalsHistogramPanelProps>(
query,
from,
legendPosition = 'right',
loadingInitial = false,
panelHeight = DEFAULT_PANEL_HEIGHT,
setQuery,
signalIndexName,
Expand All @@ -86,7 +84,7 @@ export const SignalsHistogramPanel = memo<SignalsHistogramPanelProps>(
title = i18n.HISTOGRAM_HEADER,
updateDateRange,
}) => {
const [isInitialLoading, setIsInitialLoading] = useState(loadingInitial || true);
const [isInitialLoading, setIsInitialLoading] = useState(true);
const [defaultNumberFormat] = useUiSetting$<string>(DEFAULT_NUMBER_FORMAT);
const [totalSignalsObj, setTotalSignalsObj] = useState<SignalsTotal>(defaultTotalSignalsObj);
const [selectedStackByOption, setSelectedStackByOption] = useState<SignalsHistogramOption>(
Expand Down Expand Up @@ -124,10 +122,16 @@ export const SignalsHistogramPanel = memo<SignalsHistogramPanelProps>(
const formattedSignalsData = useMemo(() => formatSignalsData(signalsData), [signalsData]);

useEffect(() => {
if (!loadingInitial && isInitialLoading && !isLoadingSignals && signalsData) {
let canceled = false;

if (!canceled && !showInitialLoadingSpinner({ isInitialLoading, isLoadingSignals })) {
setIsInitialLoading(false);
}
}, [loadingInitial, isLoadingSignals, signalsData]);

return () => {
canceled = true; // prevent long running data fetches from updating state after unmounting
};
}, [isInitialLoading, isLoadingSignals, setIsInitialLoading]);

useEffect(() => {
return () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ const DetectionEnginePageComponent: React.FC<DetectionEnginePageComponentProps>
deleteQuery={deleteQuery}
filters={filters}
from={from}
loadingInitial={loading}
query={query}
setQuery={setQuery}
showTotalSignalsCount={true}
Expand Down