Compare commits

...

2 Commits

21 changed files with 438 additions and 150 deletions

View File

@@ -1,4 +1,10 @@
import { type MouseEvent, useCallback, useMemo, useRef } from 'react';
import {
type FocusEvent,
type MouseEvent,
useCallback,
useMemo,
useRef,
} from 'react';
import {
autocompletion,
closeCompletion,
@@ -67,6 +73,20 @@ function SearchBar({
const onSubmitRef = useRef(handleSubmit);
onSubmitRef.current = handleSubmit;
// Leaving the box runs an unrun draft, e.g. terms picked from the suggestions.
// A blur from switching windows or tabs does not.
const handleBlur = useCallback(
(event: FocusEvent<HTMLDivElement>): void => {
const stillInside = event.currentTarget.contains(
event.relatedTarget as Node | null,
);
if (!stillInside && dirty && !disabled && document.hasFocus()) {
handleSubmit();
}
},
[dirty, disabled, handleSubmit],
);
const extensions = useMemo(
() => [
dslHighlight,
@@ -127,7 +147,10 @@ function SearchBar({
return (
<div className={styles.wrapper}>
<div className={cx(styles.field, { [styles.disabled]: disabled })}>
<div
className={cx(styles.field, { [styles.disabled]: disabled })}
onBlur={handleBlur}
>
<Search
size={12}
color={Color.BG_VANILLA_400}

View File

@@ -0,0 +1,96 @@
import { render, screen, userEvent } from 'tests/test-utils';
import type { DslGrammar } from '../../dsl/types';
import SearchBar from '../SearchBar';
const GRAMMAR: DslGrammar = {
fields: [{ key: 'name', type: 'string' }],
dynamicKey: { detail: 'tag', prefix: '' },
};
function renderSearchBar(props: { dirty: boolean; disabled?: boolean }): {
onSubmit: jest.Mock;
onSubmitted: jest.Mock;
} {
const onSubmit = jest.fn();
const onSubmitted = jest.fn();
render(
<>
<SearchBar
value="name = 'x'"
grammar={GRAMMAR}
testIdPrefix="list-search"
onChange={jest.fn()}
onSubmit={onSubmit}
onSubmitted={onSubmitted}
dirty={props.dirty}
disabled={props.disabled}
/>
<button type="button" data-testid="outside">
outside
</button>
</>,
);
return { onSubmit, onSubmitted };
}
function searchContent(): HTMLElement {
return screen
.getByTestId('list-search')
.querySelector('.cm-content') as HTMLElement;
}
describe('SearchBar — run on blur', () => {
let hasFocus: jest.SpyInstance<boolean, []>;
beforeEach(() => {
// jsdom reports no focus once it leaves the editor; a focused browser window does.
hasFocus = jest.spyOn(document, 'hasFocus').mockReturnValue(true);
});
afterEach(() => {
jest.restoreAllMocks();
});
it('runs an unrun draft when focus leaves the box', async () => {
const user = userEvent.setup({ pointerEventsCheck: 0 });
const { onSubmit, onSubmitted } = renderSearchBar({ dirty: true });
await user.click(searchContent());
await user.click(screen.getByTestId('outside'));
expect(onSubmit).toHaveBeenCalledTimes(1);
expect(onSubmitted).toHaveBeenCalledWith(true);
});
it('does nothing when the draft was already run', async () => {
const user = userEvent.setup({ pointerEventsCheck: 0 });
const { onSubmit } = renderSearchBar({ dirty: false });
await user.click(searchContent());
await user.click(screen.getByTestId('outside'));
expect(onSubmit).not.toHaveBeenCalled();
});
it('does nothing when focus leaves the window', async () => {
const user = userEvent.setup({ pointerEventsCheck: 0 });
const { onSubmit } = renderSearchBar({ dirty: true });
await user.click(searchContent());
hasFocus.mockReturnValue(false);
await user.click(screen.getByTestId('outside'));
expect(onSubmit).not.toHaveBeenCalled();
});
it('runs once when Run query is clicked with an unrun draft', async () => {
const user = userEvent.setup({ pointerEventsCheck: 0 });
const { onSubmit } = renderSearchBar({ dirty: true });
await user.click(searchContent());
await user.click(screen.getByTestId('list-search-submit'));
expect(onSubmit).toHaveBeenCalledTimes(1);
});
});

View File

@@ -1,3 +1,9 @@
import {
alertRulesFixture,
listRulesV3Response,
} from 'mocks-server/__mockdata__/alert_rules';
import { server } from 'mocks-server/server';
import { rest } from 'msw';
import { screen, waitFor } from 'tests/test-utils';
import { renderListAlertRules } from './_helpers';
@@ -7,6 +13,25 @@ describe('ListAlertRules — list rendering', () => {
jest.setSystemTime(new Date('2023-10-20T12:00:00Z'));
});
it('asks for rules sorted by status, firing first, by default', async () => {
const requests: URLSearchParams[] = [];
server.use(
rest.get('http://localhost/api/v3/rules', (req, res, ctx) => {
requests.push(req.url.searchParams);
return res(
ctx.status(200),
ctx.json(listRulesV3Response(alertRulesFixture, req.url.searchParams)),
);
}),
);
renderListAlertRules();
await screen.findByText('High CPU Alert');
expect(requests[0].get('sort')).toBe('state');
expect(requests[0].get('order')).toBe('desc');
});
it('renders alert rules from API', async () => {
renderListAlertRules();
@@ -101,7 +126,7 @@ describe('ListAlertRules — list rendering', () => {
);
});
it('renders header controls (search, states, columns, new alert)', async () => {
it('renders header controls (search, columns, new alert) and no state filter', async () => {
renderListAlertRules();
await waitFor(() =>
@@ -112,7 +137,9 @@ describe('ListAlertRules — list rendering', () => {
expect(
screen.getByTestId('alert-rules-list-search-submit'),
).toBeInTheDocument();
expect(screen.getByTestId('alert-rules-filter-states')).toBeInTheDocument();
expect(
screen.queryByTestId('alert-rules-filter-states'),
).not.toBeInTheDocument();
expect(screen.getByTestId('alert-columns-button')).toBeInTheDocument();
expect(
screen.getByTestId('list-alerts-new-alert-button'),

View File

@@ -1,5 +1,6 @@
import { safeNavigateMock } from '__tests__/safeNavigateMock';
import userEvent from '@testing-library/user-event';
import { useAlertRuleViewsStore } from 'container/ListAlertRules/useAlertRuleViewsStore';
import { screen, waitFor } from 'tests/test-utils';
import { renderListAlertRules } from './_helpers';
@@ -7,6 +8,7 @@ import { renderListAlertRules } from './_helpers';
describe('ListAlertRules — row click navigation', () => {
beforeEach(() => {
jest.setSystemTime(new Date('2023-10-20T12:00:00Z'));
useAlertRuleViewsStore.setState({ recent: [] });
});
it('clicking a row calls safeNavigate to alerts/overview with ruleId', async () => {
@@ -29,6 +31,22 @@ describe('ListAlertRules — row click navigation', () => {
expect(url).not.toContain('compositeQuery=');
});
it('records an opened rule as recently viewed, most recent first', async () => {
const user = userEvent.setup({ delay: null });
useAlertRuleViewsStore.setState({ recent: ['rule-2', 'rule-1'] });
renderListAlertRules();
const ruleCell = await screen.findByText('High CPU Alert');
await user.click(ruleCell.closest('td') as HTMLElement);
await waitFor(() => {
expect(useAlertRuleViewsStore.getState().recent).toStrictEqual([
'rule-1',
'rule-2',
]);
});
});
it('ctrl+click on a row navigates with newTab option', async () => {
const user = userEvent.setup({ delay: null });
renderListAlertRules();

View File

@@ -19,6 +19,16 @@ import {
const QUERY = "name CONTAINS 'CPU'";
function getSearchContent(): HTMLElement {
const content = screen
.getByTestId('alert-rules-list-search')
.querySelector<HTMLElement>('.cm-content');
if (!content) {
throw new Error('Search editor content not found');
}
return content;
}
function lastRequest(requests: URLSearchParams[]): URLSearchParams {
return requests[requests.length - 1];
}
@@ -26,6 +36,10 @@ function lastRequest(requests: URLSearchParams[]): URLSearchParams {
describe('ListAlertRules — search', () => {
let requests: URLSearchParams[];
afterEach(() => {
jest.restoreAllMocks();
});
beforeEach(() => {
jest.setSystemTime(new Date('2023-10-20T12:00:00Z'));
requests = [];
@@ -129,42 +143,53 @@ describe('ListAlertRules — search', () => {
});
});
it('sends the selected states once, as repeated states= params, when the dropdown closes', async () => {
const user = userEvent.setup({ delay: null });
it('runs the draft when the search box loses focus', async () => {
const user = userEvent.setup({ delay: null, pointerEventsCheck: 0 });
// jsdom reports no focus once it lands on <body>; a focused browser window does.
jest.spyOn(document, 'hasFocus').mockReturnValue(true);
renderListAlertRules();
await screen.findByText('High CPU Alert');
await user.click(
within(screen.getByTestId('alert-rules-filter-states')).getByRole(
'combobox',
),
);
const dropdown = await waitFor(() => {
const element = document.querySelector<HTMLElement>('.ant-select-dropdown');
expect(element).not.toBeNull();
return element as HTMLElement;
});
await user.click(within(dropdown).getByText('Firing'));
await user.click(within(dropdown).getByText('Disabled'));
expect(requests.some((r) => r.has('states'))).toBe(false);
expect(getCurrentNuqsSearchParams().has('states')).toBe(false);
await user.click(getSearchContent());
setSearchDraft(QUERY);
await user.click(document.body);
await waitFor(() => {
expect(lastRequest(requests).getAll('states')).toStrictEqual([
'firing',
'disabled',
]);
expect(lastRequest(requests).get('query')).toBe(QUERY);
});
expect(requests.filter((r) => r.has('states'))).toHaveLength(1);
expect(lastRequest(requests).has('states[]')).toBe(false);
await waitFor(() => {
expect(getCurrentNuqsSearchParams().get('states')).toBe('firing,disabled');
expect(getCurrentNuqsSearchParams().get('query')).toBe(QUERY);
});
}, 15_000);
});
it('keeps the draft unrun when focus leaves the window', async () => {
const user = userEvent.setup({ delay: null, pointerEventsCheck: 0 });
renderListAlertRules();
await screen.findByText('High CPU Alert');
await user.click(getSearchContent());
setSearchDraft(QUERY);
jest.spyOn(document, 'hasFocus').mockReturnValue(false);
await user.click(document.body);
expect(requests.some((r) => r.has('query'))).toBe(false);
expect(
screen.getByTestId('alert-rules-list-search-dirty'),
).toBeInTheDocument();
});
it('still sends states= from a link, without a state filter in the UI', async () => {
renderListAlertRules({ initialRoute: '/?states=firing' });
await screen.findByText('High CPU Alert');
expect(lastRequest(requests).getAll('states')).toStrictEqual(['firing']);
expect(
screen.queryByTestId('alert-rules-filter-states'),
).not.toBeInTheDocument();
});
it('Clear empties the query and the states', async () => {
const user = userEvent.setup({ delay: null });

View File

@@ -33,16 +33,16 @@ const makeRule = (overrides: Partial<AlertRule>): AlertRule => ({
});
describe('toListSort', () => {
it('returns the default sort when orderBy is null', () => {
it('returns the default sort, status first, when orderBy is null', () => {
expect(toListSort(null)).toStrictEqual({
sort: RuletypesListSortDTO.updated_at,
sort: RuletypesListSortDTO.state,
order: RuletypesListOrderDTO.desc,
});
});
it('returns the default sort for an unknown column', () => {
expect(toListSort({ columnName: 'labels', order: 'asc' })).toStrictEqual({
sort: RuletypesListSortDTO.updated_at,
sort: RuletypesListSortDTO.state,
order: RuletypesListOrderDTO.desc,
});
});
@@ -71,10 +71,16 @@ describe('toListSort', () => {
describe('toOrderBy', () => {
it('returns null for the default sort', () => {
expect(
toOrderBy(RuletypesListSortDTO.updated_at, RuletypesListOrderDTO.desc),
toOrderBy(RuletypesListSortDTO.state, RuletypesListOrderDTO.desc),
).toBeNull();
});
it('keeps the previous default, updated_at desc, as an explicit sort', () => {
expect(
toOrderBy(RuletypesListSortDTO.updated_at, RuletypesListOrderDTO.desc),
).toStrictEqual<SortState>({ columnName: 'updatedAt', order: 'desc' });
});
it('returns the column for a non-default sort', () => {
expect(
toOrderBy(RuletypesListSortDTO.created_at, RuletypesListOrderDTO.asc),

View File

@@ -131,7 +131,7 @@ describe('ListAlertRules — saved views rail', () => {
beforeEach(() => {
jest.setSystemTime(new Date('2023-10-20T12:00:00Z'));
localStorage.removeItem(LOCALSTORAGE.ALERT_RULES_LIST_VIEWS);
useAlertRuleViewsStore.setState({ railCollapsed: false });
useAlertRuleViewsStore.setState({ railCollapsed: false, recent: [] });
});
describe('builtin views', () => {
@@ -141,7 +141,9 @@ describe('ListAlertRules — saved views rail', () => {
await screen.findByText('High CPU Alert');
expect(viewItem('mine')).toHaveTextContent('My alert rules');
expect(viewItem('all')).toHaveTextContent('All alert rules');
expect(viewItem('recent')).toHaveTextContent('Recently viewed');
expect(viewItem('firing')).toHaveTextContent('Firing');
expect(viewItem('enabled')).toHaveTextContent('Enabled');
expect(viewItem('disabled')).toHaveTextContent('Disabled');
expect(activeHeading()).toHaveTextContent('All alert rules');
expect(
@@ -174,6 +176,45 @@ describe('ListAlertRules — saved views rail', () => {
).not.toBeInTheDocument();
});
it('Enabled sends every state except disabled', async () => {
const user = userEvent.setup({ delay: null, pointerEventsCheck: 0 });
const requests = captureRulesRequests();
renderListAlertRules();
await screen.findByText('High CPU Alert');
await selectView(user, 'enabled');
const enabled = ['inactive', 'pending', 'recovering', 'firing', 'nodata'];
await waitFor(() => {
expect(lastRequest(requests).getAll('states')).toStrictEqual(enabled);
});
expect(lastRequest(requests).has('query')).toBe(false);
expect(activeHeading()).toHaveTextContent('Enabled');
});
it('Recently viewed lists the opened rules in visit order from one large page', async () => {
const user = userEvent.setup({ delay: null, pointerEventsCheck: 0 });
const requests = captureRulesRequests();
useAlertRuleViewsStore.setState({ recent: ['rule-3', 'rule-1'] });
renderListAlertRules();
await screen.findByText('Memory Pending Alert');
await selectView(user, 'recent');
await waitFor(() => {
expect(lastRequest(requests).get('limit')).toBe('200');
});
expect(lastRequest(requests).get('offset')).toBe('0');
await waitFor(() => {
expect(screen.queryByText('Memory Pending Alert')).not.toBeInTheDocument();
});
const names = screen
.getAllByTestId(/^alert-row-.+-name$/)
.map((cell) => cell.textContent);
expect(names).toStrictEqual(['Healthy Alert', 'High CPU Alert']);
expect(activeHeading()).toHaveTextContent('Recently viewed');
});
it('My alert rules filters by the current user as creator', async () => {
const user = userEvent.setup({ delay: null, pointerEventsCheck: 0 });
const requests = captureRulesRequests();
@@ -217,7 +258,7 @@ describe('ListAlertRules — saved views rail', () => {
version: 'v1',
query: 'foo',
states: [],
sort: 'updated_at',
sort: 'state',
order: 'desc',
},
});

View File

@@ -3,7 +3,6 @@ import type { SuggestionSource } from 'components/ListFilter/dsl/types';
import type { CreatorOption } from 'components/ListFilter/types';
import { RULES_DSL_GRAMMAR } from '../list.config';
import RuleStatesFilter from './RuleStatesFilter';
interface Props {
query: string;
@@ -33,7 +32,6 @@ function AlertRulesFilterZone({
creatorOptions={creatorOptions}
source={source}
onQueryChange={onQueryChange}
extraFilters={<RuleStatesFilter states={states} onChange={onStatesChange} />}
hasExtraFilters={states.length > 0}
onClearAll={(): void => onStatesChange([])}
error={error ?? undefined}

View File

@@ -1,60 +0,0 @@
import { useEffect, useState } from 'react';
import { RuletypesAlertStateDTO } from 'api/generated/services/sigNoz.schemas';
import MultiSelectFilter, {
type MultiSelectFilterOption,
} from 'components/ListFilter/FilterZone/MultiSelectFilter';
import { isSameStates } from '../utils';
const STATE_OPTIONS: MultiSelectFilterOption[] = [
{ value: RuletypesAlertStateDTO.firing, label: 'Firing' },
{ value: RuletypesAlertStateDTO.pending, label: 'Pending' },
{ value: RuletypesAlertStateDTO.recovering, label: 'Recovering' },
{ value: RuletypesAlertStateDTO.inactive, label: 'OK' },
{ value: RuletypesAlertStateDTO.nodata, label: 'No data' },
{ value: RuletypesAlertStateDTO.disabled, label: 'Disabled' },
];
interface RuleStatesFilterProps {
states: string[];
onChange: (states: string[]) => void;
}
function RuleStatesFilter({
states,
onChange,
}: RuleStatesFilterProps): JSX.Element {
const [draft, setDraft] = useState(states);
const [open, setOpen] = useState(false);
useEffect(() => {
setDraft(states);
}, [states]);
const handleChange = (next: string[]): void => {
setDraft(next);
if (!open) {
onChange(next);
}
};
const handleDropdownVisibleChange = (nextOpen: boolean): void => {
setOpen(nextOpen);
if (!nextOpen && !isSameStates(draft, states)) {
onChange(draft);
}
};
return (
<MultiSelectFilter
value={draft}
options={STATE_OPTIONS}
placeholder="State"
testId="alert-rules-filter-states"
onChange={handleChange}
onDropdownVisibleChange={handleDropdownVisibleChange}
/>
);
}
export default RuleStatesFilter;

View File

@@ -25,7 +25,12 @@ import { useAlertRulesHandlers } from './useAlertRulesHandlers';
import { useAlertRulesListFilter } from './useAlertRulesListFilter';
import { useAlertRuleViews } from './useAlertRuleViews';
import { useAlertRuleViewsStore } from './useAlertRuleViewsStore';
import { DEFAULT_RULE_VIEW, RULE_BUILTIN_VIEWS } from './list.config';
import {
DEFAULT_RULE_VIEW,
findRuleBuiltinView,
RULE_BUILTIN_VIEWS,
} from './list.config';
import { useRuleViewCtx } from './useRuleViewCtx';
const QUERY_PARAMS_CONFIG = {
orderBy: 'orderBy',
@@ -33,6 +38,9 @@ const QUERY_PARAMS_CONFIG = {
limit: 'limit',
} as const;
// Client-filtered views (Recently viewed) narrow one page of the API's max size.
const CLIENT_VIEW_LIMIT = 200;
const DEFAULT_PAGE = 1;
const DEFAULT_LIMIT = 10;
@@ -71,21 +79,25 @@ function ListAlertRules(): JSX.Element {
setRailCollapsed(!railCollapsed);
}, [setRailCollapsed, railCollapsed]);
const viewCtx = useRuleViewCtx();
const clientFilter = findRuleBuiltinView(ruleViews.activeViewId)?.clientFilter;
const clientView = !!clientFilter;
const listParams = useMemo(
() => ({
query: filter.query || undefined,
states: filter.states.length ? filter.states : undefined,
sort: filter.sort,
order: filter.order,
limit,
offset: (page - 1) * limit,
limit: clientView ? CLIENT_VIEW_LIMIT : limit,
offset: clientView ? 0 : (page - 1) * limit,
}),
[filter, limit, page],
[filter, limit, page, clientView],
);
const {
rules,
total,
rules: fetchedRules,
total: fetchedTotal,
labels,
reservedKeywords,
isFetching,
@@ -94,6 +106,19 @@ function ListAlertRules(): JSX.Element {
refetch,
} = useAlertRulesData(listParams);
const clientRules = useMemo(
() => (clientFilter ? clientFilter(fetchedRules, viewCtx) : null),
[clientFilter, fetchedRules, viewCtx],
);
const rules = useMemo(
() =>
clientRules
? clientRules.slice((page - 1) * limit, page * limit)
: fetchedRules,
[clientRules, fetchedRules, page, limit],
);
const total = clientRules ? clientRules.length : fetchedTotal;
const { creatorOptions, source } = useAlertRulesFilterSource({
rules,
labels,

View File

@@ -1,5 +1,5 @@
import { RuletypesAlertStateDTO } from 'api/generated/services/sigNoz.schemas';
import { BellOff, Flame, Layers, User } from '@signozhq/icons';
import { Bell, BellOff, Clock, Flame, Layers, User } from '@signozhq/icons';
import { clause } from 'components/ListFilter/dsl/filterQuery';
import type {
ClauseBuilder,
@@ -7,7 +7,7 @@ import type {
} from 'components/ListFilter/dsl/types';
import type { BuiltinViewConfig } from 'components/ListViews/types';
import type { RuleListFilter, RuleViewCtx } from './types';
import type { AlertRule, RuleListFilter, RuleViewCtx } from './types';
// Mirrors pkg/types/ruletypes/list_filter.go. Label keys go under `labels.`.
export const RULES_DSL_GRAMMAR = {
@@ -44,9 +44,14 @@ const where: ClauseBuilder<
(typeof RULES_DSL_GRAMMAR)['fields'][number]['key']
> = clause;
type RuleViewConfig = BuiltinViewConfig<RuleListFilter, RuleViewCtx>;
type RuleViewConfig = BuiltinViewConfig<RuleListFilter, RuleViewCtx, AlertRule>;
const ENABLED_STATES = Object.values(RuletypesAlertStateDTO).filter(
(state) => state !== RuletypesAlertStateDTO.disabled,
);
// Built-in views replace query and states; the current sort/order is kept.
// `clientFilter` views narrow one large fetched page in the browser.
const views = [
{
id: 'mine',
@@ -59,6 +64,24 @@ const views = [
states: [],
}),
},
{
id: 'recent',
label: 'Recently viewed',
icon: Clock,
section: 'personal',
filter: (current): RuleListFilter => ({ ...current, query: '', states: [] }),
// Keeps visit order, whatever the active sort.
clientFilter: (rows, { recent }): AlertRule[] => {
const order = new Map(recent.map((id, index) => [id, index]));
return rows
.filter((rule) => !!rule.id && order.has(rule.id))
.sort((a, b) => (order.get(a.id) ?? 0) - (order.get(b.id) ?? 0));
},
emptyState: {
title: 'No recently viewed alert rules',
description: 'Alert rules you open will appear here.',
},
},
{
id: 'all',
label: 'All alert rules',
@@ -77,6 +100,17 @@ const views = [
states: [RuletypesAlertStateDTO.firing],
}),
},
{
id: 'enabled',
label: 'Enabled',
icon: Bell,
section: 'system',
filter: (current): RuleListFilter => ({
...current,
query: '',
states: ENABLED_STATES,
}),
},
{
id: 'disabled',
label: 'Disabled',
@@ -95,3 +129,6 @@ export type RuleViewId = (typeof views)[number]['id'];
export const RULE_BUILTIN_VIEWS: readonly RuleViewConfig[] = views;
export const DEFAULT_RULE_VIEW: RuleViewId = 'all';
export const findRuleBuiltinView = (id: string): RuleViewConfig | undefined =>
RULE_BUILTIN_VIEWS.find((v) => v.id === id);

View File

@@ -19,4 +19,5 @@ export type RuleView = SavedListView<RuleListFilter>;
export interface RuleViewCtx {
userEmail: string;
recent: string[];
}

View File

@@ -2,18 +2,29 @@ import { create } from 'zustand';
import { persist } from 'zustand/middleware';
import { LOCALSTORAGE } from 'constants/localStorage';
// Most-recently-viewed list is capped so it stays a useful shortlist.
const RECENT_LIMIT = 20;
interface AlertRuleViewsState {
railCollapsed: boolean;
recent: string[]; // rule ids, most-recent first
setRailCollapsed: (collapsed: boolean) => void;
markViewed: (id: string) => void;
}
export const useAlertRuleViewsStore = create<AlertRuleViewsState>()(
persist(
(set) => ({
railCollapsed: false,
recent: [],
setRailCollapsed: (collapsed): void => {
set({ railCollapsed: collapsed });
},
markViewed: (id): void => {
set((s) => ({
recent: [id, ...s.recent.filter((r) => r !== id)].slice(0, RECENT_LIMIT),
}));
},
}),
{ name: LOCALSTORAGE.ALERT_RULES_LIST_VIEWS },
),

View File

@@ -8,6 +8,7 @@ import useUrlQuery from 'hooks/useUrlQuery';
import { isModifierKeyPressed } from 'utils/app';
import type { AlertRule } from './types';
import { useAlertRuleViewsStore } from './useAlertRuleViewsStore';
interface UseAlertRulesHandlersReturn {
handleEdit: (
@@ -24,6 +25,16 @@ export function useAlertRulesHandlers(
): UseAlertRulesHandlersReturn {
const { safeNavigate } = useSafeNavigate();
const params = useUrlQuery();
const markViewed = useAlertRuleViewsStore((s) => s.markViewed);
const markRuleViewed = useCallback(
(rule: Pick<AlertRule, 'id'>): void => {
if (rule.id) {
markViewed(rule.id);
}
},
[markViewed],
);
const getEditUrl = useCallback(
(rule: Pick<AlertRule, 'id'>): string => {
@@ -36,9 +47,10 @@ export function useAlertRulesHandlers(
const handleEdit = useCallback(
(rule: Pick<AlertRule, 'id'>, options?: { newTab?: boolean }): void => {
markRuleViewed(rule);
safeNavigate(getEditUrl(rule), options);
},
[getEditUrl, safeNavigate],
[getEditUrl, safeNavigate, markRuleViewed],
);
const handleNewAlert = useCallback(
@@ -57,6 +69,7 @@ export function useAlertRulesHandlers(
const { handleRowClick, handleRowClickNewTab } = useTableRowClick<AlertRule>({
getUrl: getEditUrl,
onNavigate: safeNavigate,
onBeforeNavigate: markRuleViewed,
});
return {

View File

@@ -2,8 +2,13 @@ import { useMemo } from 'react';
import { useAppContext } from 'providers/App/App';
import type { RuleViewCtx } from './types';
import { useAlertRuleViewsStore } from './useAlertRuleViewsStore';
export function useRuleViewCtx(): RuleViewCtx {
const { user } = useAppContext();
return useMemo(() => ({ userEmail: user.email }), [user.email]);
const recent = useAlertRuleViewsStore((s) => s.recent);
return useMemo(
() => ({ userEmail: user.email, recent }),
[user.email, recent],
);
}

View File

@@ -45,7 +45,8 @@ const COLUMN_TO_SORT: Record<string, RuletypesListSortDTO> = {
updatedAt: RuletypesListSortDTO.updated_at,
};
export const DEFAULT_RULE_LIST_SORT = RuletypesListSortDTO.updated_at;
// Status, highest rank first: firing, nodata, pending, recovering, inactive, disabled.
export const DEFAULT_RULE_LIST_SORT = RuletypesListSortDTO.state;
export const DEFAULT_RULE_LIST_ORDER = RuletypesListOrderDTO.desc;
// `rule_list_filter_invalid`: DSL syntax / key / operator; `rule_list_invalid`: other list params.

View File

@@ -164,7 +164,7 @@ export const ruleViewsFixture: RuletypesRuleViewDTO[] = [
version: 'v1',
query: "team = 'infra'",
states: [],
sort: RuletypesListSortDTO.updated_at,
sort: RuletypesListSortDTO.state,
order: RuletypesListOrderDTO.desc,
},
},

View File

@@ -20,6 +20,7 @@ import { componentPermission } from 'utils/permission';
import { DEFAULT_RULE_LIST_FILTER } from 'container/ListAlertRules/utils';
import {
DEFAULT_RULE_VIEW,
findRuleBuiltinView,
RULE_BUILTIN_VIEWS,
type RuleViewId,
} from 'container/ListAlertRules/list.config';
@@ -57,10 +58,20 @@ type ActionState = (typeof ACTION_STATES)[number];
const VIEW_CHOICES = [
'all',
'mine',
'recent',
'firing',
'enabled',
'disabled',
'saved',
] as const satisfies readonly (RuleViewId | 'saved')[];
/** Rules the browser remembers opening, most recent first. */
const STORY_RECENT_RULE_IDS = ['rule-3', 'rule-1', 'rule-6'];
const STORY_VIEW_CTX = {
userEmail: STORY_USER_EMAIL,
recent: STORY_RECENT_RULE_IDS,
};
type ViewChoice = (typeof VIEW_CHOICES)[number];
/**
@@ -79,14 +90,16 @@ const listRoute = (view: ViewChoice): string => {
? { query: saved.data.query ?? '', states: saved.data.states ?? [] }
: RULE_BUILTIN_VIEWS.find((v) => v.id === view)?.filter(
DEFAULT_RULE_LIST_FILTER,
{ userEmail: STORY_USER_EMAIL },
STORY_VIEW_CTX,
);
params.set('view', view === 'saved' ? saved.id : view);
if (filter?.query) {
params.set('query', filter.query);
}
filter?.states.forEach((state) => params.append('states', state));
if (filter?.states.length) {
params.set('states', filter.states.join(','));
}
return `/alerts?${params.toString()}`;
};
@@ -146,7 +159,7 @@ export const alertRulesMocks = defineStoryMocks({
view: choiceControl<ViewChoice>('Active view', {
group: VIEWS,
description:
'The rail entry the page opens on. `saved` is the first saved view; the built-ins apply a query or a state set.',
'The rail entry the page opens on. `saved` is the first saved view; the built-ins apply a query or a state set, and `recent` narrows one large page to the rules the browser remembers opening.',
options: VIEW_CHOICES,
value: DEFAULT_RULE_VIEW,
}),
@@ -265,7 +278,10 @@ export const alertRulesMocks = defineStoryMocks({
],
config: (values) => ({ route: listRoute(values.view) }),
effect: (values) => {
useAlertRuleViewsStore.setState({ railCollapsed: values.railCollapsed });
useAlertRuleViewsStore.setState({
railCollapsed: values.railCollapsed,
recent: STORY_RECENT_RULE_IDS,
});
},
});
@@ -299,11 +315,13 @@ export const listedRules = (
return [];
}
return alertRulesPage(
const { rules } = alertRulesPage(
args.rules,
{ severity: args.ruleSeverity, state: args.ruleState },
params,
).data.rules;
).data;
const clientFilter = findRuleBuiltinView(args.view)?.clientFilter;
return clientFilter ? clientFilter(rules, STORY_VIEW_CTX) : rules;
};
export const hasRowMenu = (args: AlertRulesArgs): boolean =>

View File

@@ -17,7 +17,6 @@ import {
openRenameViewPopover,
openRowActions,
openSaveViewPopover,
openStatesFilter,
toggleAlert,
} from './__story_mockdata__/alertRules.play';
@@ -48,7 +47,7 @@ type Story = StoryObj<AlertRulesArgs>;
/**
* Every alert rule the org has configured, with the state each one evaluated to
* on its last run and the severity it fires at.
* on its last run and the severity it fires at, firing rules first.
*/
export const Default: Story = {};
@@ -83,6 +82,19 @@ export const QuerySuggestions: Story = {
play: openQuerySuggestions,
};
/** The Enabled view: every rule that is not disabled, whatever it evaluated to. */
export const EnabledView: Story = {
args: { view: 'enabled' },
};
/**
* Recently viewed: the rules this browser opened from the list, in the order they
* were opened, whatever the sort.
*/
export const RecentlyViewed: Story = {
args: { view: 'recent' },
};
/** A workspace with no saved view yet, where the rail says how to make one. */
export const NoSavedViews: Story = {
args: { ruleViews: 0 },
@@ -180,11 +192,6 @@ export const ColumnPicker: Story = {
play: openColumnPicker,
};
/** The State dropdown, open with a state picked. */
export const StateFilterOpen: Story = {
play: openStatesFilter,
};
/**
* Every label badge in the Labels column, held open: each one repeats its own
* `key: value` with a copy button. The rules carry two labels apiece, which fit

View File

@@ -148,30 +148,6 @@ export const openColumnPicker = async ({
await screen.findByText(/toggle columns/i);
};
export const openStatesFilter = async ({
canvasElement,
args,
}: PlayContext): Promise<void> => {
if (showsNoRulesPage(args)) {
return;
}
const filter = await within(canvasElement).findByTestId(
'alert-rules-filter-states',
undefined,
untilLoaded,
);
await userEvent.click(filter.querySelector('.ant-select-selector') ?? filter);
const option = (await screen.findAllByText('Firing')).find((node) =>
node.closest('.ant-select-dropdown'),
);
if (screen.queryAllByRole('checkbox', { checked: true }).length === 0) {
await userEvent.click(option ?? filter);
}
await screen.findAllByRole('checkbox', { checked: true });
};
export const toggleAlert = async ({
canvasElement,
args,

View File

@@ -18,9 +18,20 @@ import {
type RuleShape,
} from '../../../stories/__story_mockdata__/alerts';
/** `AlertState.DisplayRank()` in pkg/types/ruletypes/alert_state.go. */
const STATE_DISPLAY_RANK: Record<string, number> = {
[RuletypesAlertStateDTO.firing]: 5,
[RuletypesAlertStateDTO.nodata]: 4,
[RuletypesAlertStateDTO.pending]: 3,
[RuletypesAlertStateDTO.recovering]: 2,
[RuletypesAlertStateDTO.inactive]: 1,
[RuletypesAlertStateDTO.disabled]: 0,
};
/**
* The v3 list as the API answers it: `states` and paging are applied on the
* server. The `query` DSL is not evaluated, so a query narrows nothing here.
* The v3 list as the API answers it: `states`, the `state` sort and paging are
* applied on the server. The `query` DSL is not evaluated, so a query narrows
* nothing here, and other sorts keep the builder's order.
*/
export const alertRulesPage = (
count: number,
@@ -31,6 +42,15 @@ export const alertRulesPage = (
const rules = alertRulesResponse(count, shape).data.filter(
(rule) => states.length === 0 || states.includes(rule.state),
);
if (searchParams.get('sort') === RuletypesListSortDTO.state) {
const direction =
searchParams.get('order') === RuletypesListOrderDTO.asc ? 1 : -1;
rules.sort(
(a, b) =>
direction *
((STATE_DISPLAY_RANK[a.state] ?? 0) - (STATE_DISPLAY_RANK[b.state] ?? 0)),
);
}
const labels = new Map<string, { key: string; value: string }>();
rules.forEach((rule) =>
Object.entries(rule.labels ?? {}).forEach(([key, value]) =>