Skip to content

ref(dashboards): migrate errors to hook pattern #107001

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

Merged
DominikB2014 merged 1 commit into from
Jan 27, 2026
Merged

ref(dashboards): migrate errors to hook pattern #107001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 0 additions & 100 deletions static/app/views/dashboards/datasetConfig/errors.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
import {LocationFixture} from 'sentry-fixture/locationFixture';
import {OrganizationFixture} from 'sentry-fixture/organization';
import {PageFiltersFixture} from 'sentry-fixture/pageFilters';
import {ProjectFixture} from 'sentry-fixture/project';
import {ThemeFixture} from 'sentry-fixture/theme';
import {UserFixture} from 'sentry-fixture/user';
import {WidgetFixture} from 'sentry-fixture/widget';

import {render, screen, userEvent} from 'sentry-test/reactTestingLibrary';

import type {Client} from 'sentry/api';
import type {EventViewOptions} from 'sentry/utils/discover/eventView';
import EventView from 'sentry/utils/discover/eventView';
import {DiscoverDatasets} from 'sentry/utils/discover/types';
import {ErrorsConfig} from 'sentry/views/dashboards/datasetConfig/errors';

const theme = ThemeFixture();
Expand Down Expand Up @@ -108,100 +104,4 @@ describe('ErrorsConfig', () => {
});
});
});

describe('getEventsRequest', () => {
let api!: Client;
let organization!: ReturnType<typeof OrganizationFixture>;
let mockEventsRequest!: jest.Mock;

beforeEach(() => {
MockApiClient.clearMockResponses();

api = new MockApiClient();
organization = OrganizationFixture();

mockEventsRequest = MockApiClient.addMockResponse({
url: '/organizations/org-slug/events/',
body: {
data: [],
},
});
});

it('makes a request to the errors dataset', () => {
const pageFilters = PageFiltersFixture();
const widget = WidgetFixture();

ErrorsConfig.getTableRequest!(
api,
widget,
{
fields: ['count()'],
aggregates: ['count()'],
columns: [],
conditions: '',
name: '',
orderby: '',
},
organization,
pageFilters
);

expect(mockEventsRequest).toHaveBeenCalledWith(
'/organizations/org-slug/events/',
expect.objectContaining({
query: expect.objectContaining({
dataset: DiscoverDatasets.ERRORS,
}),
})
);
});
});

describe('getSeriesRequest', () => {
let api!: Client;
let organization!: ReturnType<typeof OrganizationFixture>;
let mockEventsRequest!: jest.Mock;

beforeEach(() => {
MockApiClient.clearMockResponses();

api = new MockApiClient();
organization = OrganizationFixture();

mockEventsRequest = MockApiClient.addMockResponse({
url: '/organizations/org-slug/events-stats/',
body: {
data: [],
},
});
});

it('makes a request to the errors dataset', () => {
const pageFilters = PageFiltersFixture();
const widget = WidgetFixture({
queries: [
{
fields: ['count()'],
aggregates: ['count()'],
columns: [],
conditions: '',
name: '',
orderby: '',
},
],
});

ErrorsConfig.getSeriesRequest!(api, widget, 0, organization, pageFilters);

expect(mockEventsRequest).toHaveBeenCalledWith(
'/organizations/org-slug/events-stats/',
expect.objectContaining({
query: expect.objectContaining({
dataset: DiscoverDatasets.ERRORS,
}),
})
);
});
});
});
104 changes: 6 additions & 98 deletions static/app/views/dashboards/datasetConfig/errors.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import {doEventsRequest} from 'sentry/actionCreators/events';
import type {Client} from 'sentry/api';
import type {PageFilters} from 'sentry/types/core';
import type {TagCollection} from 'sentry/types/group';
import type {
EventsStats,
Expand All @@ -20,19 +17,18 @@ import {
getAggregations,
type QueryFieldValue,
} from 'sentry/utils/discover/fields';
import type {DiscoverQueryRequestParams} from 'sentry/utils/discover/genericDiscoverQuery';
import {doDiscoverQuery} from 'sentry/utils/discover/genericDiscoverQuery';
import {DiscoverDatasets} from 'sentry/utils/discover/types';
import type {AggregationKey} from 'sentry/utils/fields';
import type {MEPState} from 'sentry/utils/performance/contexts/metricsEnhancedSetting';
import type {OnDemandControlContext} from 'sentry/utils/performance/contexts/onDemandControl';
import useOrganization from 'sentry/utils/useOrganization';
import {getSeriesRequestData} from 'sentry/views/dashboards/datasetConfig/utils/getSeriesRequestData';
import type {Widget, WidgetQuery} from 'sentry/views/dashboards/types';
import {DisplayType} from 'sentry/views/dashboards/types';
import {eventViewFromWidget} from 'sentry/views/dashboards/utils';
import {transformEventsResponseToSeries} from 'sentry/views/dashboards/utils/transformEventsResponseToSeries';
import {EventsSearchBar} from 'sentry/views/dashboards/widgetBuilder/buildSteps/filterResultsStep/eventsSearchBar';
import {
useErrorsSeriesQuery,
useErrorsTableQuery,
} from 'sentry/views/dashboards/widgetCard/hooks/useErrorsWidgetQuery';
import {useResultsSearchBarDataProvider} from 'sentry/views/discover/results/resultsSearchQueryBuilder';
import type {FieldValueOption} from 'sentry/views/discover/table/queryField';
import {FieldValueKind} from 'sentry/views/discover/table/types';
Expand Down Expand Up @@ -123,29 +119,8 @@ export const ErrorsConfig: DatasetConfig<
DisplayType.TABLE,
DisplayType.TOP_N,
],
getTableRequest: (
api: Client,
_widget: Widget,
query: WidgetQuery,
organization: Organization,
pageFilters: PageFilters,
_onDemandControlContext?: OnDemandControlContext,
limit?: number,
cursor?: string,
referrer?: string,
_mepSetting?: MEPState | null
) => {
return getEventsRequest(
api,
query,
organization,
pageFilters,
limit,
cursor,
referrer
);
},
getSeriesRequest: getErrorsSeriesRequest,
useSeriesQuery: useErrorsSeriesQuery,
useTableQuery: useErrorsTableQuery,
transformTable: transformEventsResponseToTable,
transformSeries: transformEventsResponseToSeries,
filterAggregateParams,
Expand Down Expand Up @@ -183,52 +158,6 @@ function getCustomEventsFieldRenderer(field: string, meta: MetaType, widget?: Wi
return getFieldRenderer(field, meta, false);
}

function getEventsRequest(
api: Client,
query: WidgetQuery,
organization: Organization,
pageFilters: PageFilters,
limit?: number,
cursor?: string,
referrer?: string
) {
const url = `/organizations/${organization.slug}/events/`;
const eventView = eventViewFromWidget('', query, pageFilters);
const hasQueueFeature = organization.features.includes(
'visibility-dashboards-async-queue'
);

const params: DiscoverQueryRequestParams = {
per_page: limit,
cursor,
referrer,
dataset: DiscoverDatasets.ERRORS,
};

if (query.orderby) {
params.sort = typeof query.orderby === 'string' ? [query.orderby] : query.orderby;
}

return doDiscoverQuery<EventsTableData>(
api,
url,
{
...eventView.generateQueryStringObject(),
...params,
},
// Tries events request up to 10 times on rate limit
{
retry: hasQueueFeature
? // The queue will handle retries, so we don't need to retry here
undefined
: {
statusCodes: [429],
tries: 10,
},
}
);
}

// The y-axis options are a strict set of available aggregates
function filterYAxisOptions(_displayType: DisplayType) {
return (option: FieldValueOption) => {
Expand All @@ -237,24 +166,3 @@ function filterYAxisOptions(_displayType: DisplayType) {
);
};
}

function getErrorsSeriesRequest(
api: Client,
widget: Widget,
queryIndex: number,
organization: Organization,
pageFilters: PageFilters,
_onDemandControlContext?: OnDemandControlContext,
referrer?: string,
_mepSetting?: MEPState | null
) {
const requestData = getSeriesRequestData(
widget,
queryIndex,
organization,
pageFilters,
DiscoverDatasets.ERRORS,
referrer
);
return doEventsRequest<true>(api, requestData);
}
2 changes: 1 addition & 1 deletion static/app/views/dashboards/widgetCard/genericWidgetQueries.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ export function useGenericWidgetQueries<SeriesResponse, TableResponse>(
mepSetting,
samplingMode,
enabled: !isChartDisplay && !disabled && !propsLoading,
limit,
limit: limit ?? DEFAULT_TABLE_LIMIT,
cursor,
});

Expand Down
Loading
Loading