Skip to content

test(logs): Remove useLocation mocks, custom contexts #94837

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+82 −142
Open

test(logs): Remove useLocation mocks, custom contexts #94837

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
47 changes: 12 additions & 35 deletions static/app/views/explore/logs/index.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,9 @@ import {initializeOrg} from 'sentry-test/initializeOrg';
import {render, screen, userEvent, waitFor} from 'sentry-test/reactTestingLibrary';

import PageFiltersStore from 'sentry/stores/pageFiltersStore';
import {OrganizationContext} from 'sentry/views/organizationContext';

import LogsPage from './index';

function ProviderWrapper({
children,
organization,
}: {
children: React.ReactNode;
organization: any;
}) {
return (
<OrganizationContext.Provider value={organization}>
{children}
</OrganizationContext.Provider>
);
}

const BASE_FEATURES = ['ourlogs-enabled'];

describe('LogsPage', function () {
Expand Down Expand Up @@ -118,16 +103,12 @@ describe('LogsPage', function () {
});

it('should call APIs as expected', async function () {
render(
<ProviderWrapper organization={organization}>
<LogsPage />
</ProviderWrapper>,
{
initialRouterConfig: {
location: `/organizations/${organization.slug}/explore/logs/`,
},
}
);
render(<LogsPage />, {
organization,
initialRouterConfig: {
location: `/organizations/${organization.slug}/explore/logs/`,
},
});

await waitFor(() => {
expect(eventTableMock).toHaveBeenCalled();
Expand Down Expand Up @@ -171,16 +152,12 @@ describe('LogsPage', function () {
},
});

render(
<ProviderWrapper organization={newOrganization}>
<LogsPage />
</ProviderWrapper>,
{
initialRouterConfig: {
location: `/organizations/${newOrganization.slug}/explore/logs/`,
},
}
);
render(<LogsPage />, {
organization: newOrganization,
initialRouterConfig: {
location: `/organizations/${newOrganization.slug}/explore/logs/`,
},
});

await waitFor(() => {
expect(screen.getByTestId('logs-table')).toBeInTheDocument();
Expand Down
48 changes: 22 additions & 26 deletions static/app/views/explore/logs/logsAutoRefresh.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import React from 'react';
import {LocationFixture} from 'sentry-fixture/locationFixture';
import {LogFixture} from 'sentry-fixture/log';
import {OrganizationFixture} from 'sentry-fixture/organization';
import {ProjectFixture} from 'sentry-fixture/project';
Expand All @@ -14,16 +13,11 @@ import {

import PageFiltersStore from 'sentry/stores/pageFiltersStore';
import {LogsAnalyticsPageSource} from 'sentry/utils/analytics/logsAnalyticsEvent';
import {useLocation} from 'sentry/utils/useLocation';
import {LogsPageDataProvider} from 'sentry/views/explore/contexts/logs/logsPageData';
import * as logsPageParams from 'sentry/views/explore/contexts/logs/logsPageParams';
import {LogsPageParamsProvider} from 'sentry/views/explore/contexts/logs/logsPageParams';
import {AutorefreshToggle} from 'sentry/views/explore/logs/logsAutoRefresh';
import {OurLogKnownFieldKey} from 'sentry/views/explore/logs/types';
import {OrganizationContext} from 'sentry/views/organizationContext';

jest.mock('sentry/utils/useLocation');
const mockedUsedLocation = jest.mocked(useLocation);

describe('LogsAutoRefresh', () => {
const setAutoRefresh = jest.fn();
Expand All @@ -33,6 +27,17 @@ describe('LogsAutoRefresh', () => {

const projects = [ProjectFixture()];

const initialRouterConfig = {
location: {
pathname: `/organizations/${organization.slug}/explore/logs/`,
query: {
// Toggle is disabled if sort is not a timestamp.
'logs.sort_bys': '-timestamp',
},
},
route: '/organizations/:orgId/explore/logs/',
};

const mockLogsData = [
LogFixture({
[OurLogKnownFieldKey.ORGANIZATION_ID]: Number(organization.id),
Expand All @@ -45,15 +50,6 @@ describe('LogsAutoRefresh', () => {
MockApiClient.clearMockResponses();
cleanup();

// Toggle is disabled if sort is not a timestamp.
mockedUsedLocation.mockReturnValue(
LocationFixture({
query: {
'logs.sort_bys': '-timestamp',
},
})
);

// Init PageFiltersStore to make pageFiltersReady true (otherwise logs query won't fire)
PageFiltersStore.init();
PageFiltersStore.onInitializeUrlState(
Expand Down Expand Up @@ -82,15 +78,15 @@ describe('LogsAutoRefresh', () => {
cleanup();
});

const renderWithProviders = (children: React.ReactNode) => {
const renderWithProviders = (
children: React.ReactNode,
options: Parameters<typeof render>[1]
) => {
return render(
<OrganizationContext.Provider value={organization}>
<LogsPageParamsProvider
analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}
>
<LogsPageDataProvider>{children}</LogsPageDataProvider>
</LogsPageParamsProvider>
</OrganizationContext.Provider>
<LogsPageParamsProvider analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}>
<LogsPageDataProvider>{children}</LogsPageDataProvider>
</LogsPageParamsProvider>,
options
);
};

Expand All @@ -103,7 +99,7 @@ describe('LogsAutoRefresh', () => {

it('renders correctly with time-based sort', () => {
const mockApi = mockApiCall();
renderWithProviders(<AutorefreshToggle />);
renderWithProviders(<AutorefreshToggle />, {initialRouterConfig, organization});

const toggleLabel = screen.getByText('Auto-refresh');
expect(toggleLabel).toBeInTheDocument();
Expand All @@ -116,7 +112,7 @@ describe('LogsAutoRefresh', () => {

it('calls setAutoRefresh when toggled', async () => {
const mockApi = mockApiCall();
renderWithProviders(<AutorefreshToggle />);
renderWithProviders(<AutorefreshToggle />, {initialRouterConfig, organization});

const toggleSwitch = screen.getByRole('checkbox', {name: 'Auto-refresh'});

Expand All @@ -130,7 +126,7 @@ describe('LogsAutoRefresh', () => {
const mockApi = mockApiCall();
jest.spyOn(logsPageParams, 'useLogsAutoRefresh').mockReturnValue(true);

renderWithProviders(<AutorefreshToggle />);
renderWithProviders(<AutorefreshToggle />, {initialRouterConfig, organization});

const toggleSwitch = screen.getByRole('checkbox', {name: 'Auto-refresh'});
expect(toggleSwitch).toBeChecked();
Expand Down
49 changes: 22 additions & 27 deletions static/app/views/explore/logs/logsTab.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
import {LocationFixture} from 'sentry-fixture/locationFixture';

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

import PageFiltersStore from 'sentry/stores/pageFiltersStore';
import ProjectsStore from 'sentry/stores/projectsStore';
import {LogsAnalyticsPageSource} from 'sentry/utils/analytics/logsAnalyticsEvent';
import {useLocation} from 'sentry/utils/useLocation';
import {LogsPageDataProvider} from 'sentry/views/explore/contexts/logs/logsPageData';
import {
LOGS_FIELDS_KEY,
Expand All @@ -19,10 +16,6 @@ import {AlwaysPresentLogFields} from 'sentry/views/explore/logs/constants';
import {LogsTabContent} from 'sentry/views/explore/logs/logsTab';
import {TraceItemDataset} from 'sentry/views/explore/types';
import type {PickableDays} from 'sentry/views/explore/utils';
import {OrganizationContext} from 'sentry/views/organizationContext';

jest.mock('sentry/utils/useLocation');
const mockUseLocation = jest.mocked(useLocation);

const datePageFilterProps: PickableDays = {
defaultPeriod: '7d' as const,
Expand All @@ -47,18 +40,29 @@ describe('LogsTabContent', function () {

function ProviderWrapper({children}: {children: React.ReactNode}) {
return (
<OrganizationContext.Provider value={organization}>
<LogsPageParamsProvider
analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}
>
<TraceItemAttributeProvider traceItemType={TraceItemDataset.LOGS} enabled>
<LogsPageDataProvider>{children}</LogsPageDataProvider>
</TraceItemAttributeProvider>
</LogsPageParamsProvider>
</OrganizationContext.Provider>
<LogsPageParamsProvider analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}>
<TraceItemAttributeProvider traceItemType={TraceItemDataset.LOGS} enabled>
<LogsPageDataProvider>{children}</LogsPageDataProvider>
</TraceItemAttributeProvider>
</LogsPageParamsProvider>
);
}

const initialRouterConfig = {
location: {
pathname: `/organizations/${organization.slug}/explore/logs/`,
query: {
start: '2025-04-10T14%3A37%3A55',
end: '2025-04-10T20%3A04%3A51',
project: project.id,
[LOGS_FIELDS_KEY]: ['message', 'sentry.message.parameters.0'],
[LOGS_SORT_BYS_KEY]: ['sentry.message.parameters.0'],
[LOGS_QUERY_KEY]: 'severity:error',
},
},
route: '/organizations/:orgId/explore/logs/',
};

beforeEach(function () {
MockApiClient.clearMockResponses();

Expand All @@ -79,16 +83,6 @@ describe('LogsTabContent', function () {
new Set()
);

mockUseLocation.mockReturnValue(
LocationFixture({
pathname: `/organizations/${organization.slug}/explore/logs/?end=2025-04-10T20%3A04%3A51&project=${project.id}&start=2025-04-10T14%3A37%3A55`,
query: {
[LOGS_FIELDS_KEY]: ['message', 'sentry.message.parameters.0'],
[LOGS_SORT_BYS_KEY]: ['sentry.message.parameters.0'],
[LOGS_QUERY_KEY]: 'severity:error',
},
})
);
eventTableMock = MockApiClient.addMockResponse({
url: `/organizations/${organization.slug}/events/`,
method: 'GET',
Expand Down Expand Up @@ -185,7 +179,8 @@ describe('LogsTabContent', function () {
render(
<ProviderWrapper>
<LogsTabContent {...datePageFilterProps} />
</ProviderWrapper>
</ProviderWrapper>,
{initialRouterConfig, organization}
);

expect(eventTableMock).toHaveBeenCalledWith(
Expand Down
71 changes: 26 additions & 45 deletions static/app/views/explore/logs/tables/logsAggregateTable.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
import React from 'react';
import {ThemeProvider} from '@emotion/react';
import {LocationFixture} from 'sentry-fixture/locationFixture';

import {initializeOrg} from 'sentry-test/initializeOrg';
import {makeTestQueryClient} from 'sentry-test/queryClient';
import {render, screen, within} from 'sentry-test/reactTestingLibrary';

import PageFiltersStore from 'sentry/stores/pageFiltersStore';
import ProjectsStore from 'sentry/stores/projectsStore';
import {LogsAnalyticsPageSource} from 'sentry/utils/analytics/logsAnalyticsEvent';
import {QueryClientProvider} from 'sentry/utils/queryClient';
import {useLocation} from 'sentry/utils/useLocation';
import {
LOGS_AGGREGATE_FN_KEY,
LOGS_AGGREGATE_PARAM_KEY,
Expand All @@ -21,39 +14,23 @@ import {
} from 'sentry/views/explore/contexts/logs/logsPageParams';
import {LOGS_AGGREGATE_SORT_BYS_KEY} from 'sentry/views/explore/contexts/logs/sortBys';
import * as useLogsQueryModule from 'sentry/views/explore/logs/useLogsQuery';
import {OrganizationContext} from 'sentry/views/organizationContext';

import {LogsAggregateTable} from './logsAggregateTable';

jest.mock('sentry/views/explore/logs/useLogsQuery');

jest.mock('sentry/utils/useLocation');
const mockUseLocation = jest.mocked(useLocation);

const queryClient = makeTestQueryClient();

describe('LogsAggregateTable', () => {
const {organization, project} = initializeOrg({
organization: {
features: ['ourlogs-enabled'],
},
});
function createWrapper() {
return function Wrapper({children}: {children?: React.ReactNode}) {
return (
<QueryClientProvider client={queryClient}>
<OrganizationContext.Provider value={organization}>
<ThemeProvider theme={{}}>
<LogsPageParamsProvider
analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}
>
{children}
</LogsPageParamsProvider>
</ThemeProvider>
</OrganizationContext.Provider>
</QueryClientProvider>
);
};
function LogsAggregateTableWithParamsProvider() {
return (
<LogsPageParamsProvider analyticsPageSource={LogsAnalyticsPageSource.EXPLORE_LOGS}>
<LogsAggregateTable />
</LogsPageParamsProvider>
);
}

ProjectsStore.loadInitialData([project]);
Expand All @@ -72,22 +49,26 @@ describe('LogsAggregateTable', () => {
},
new Set()
);
const initialRouterConfig = {
location: {
pathname: `/organizations/${organization.slug}/explore/logs/`,
query: {
project: project.id,
start: '2025-04-10T14%3A37%3A55',
end: '2025-04-10T20%3A04%3A51',
[LOGS_AGGREGATE_SORT_BYS_KEY]: '-p99(severity_number)',
[LOGS_QUERY_KEY]: 'test',
[LOGS_GROUP_BY_KEY]: 'message.template',
[LOGS_AGGREGATE_FN_KEY]: 'p99',
[LOGS_AGGREGATE_PARAM_KEY]: 'severity_number',
[LOGS_FIELDS_KEY]: ['timestamp', 'message'],
},
},
route: '/organizations/:orgId/explore/logs/',
};

beforeEach(function () {
MockApiClient.clearMockResponses();
mockUseLocation.mockReturnValue(
LocationFixture({
pathname: `/organizations/${organization.slug}/explore/logs/?end=2025-04-10T20%3A04%3A51&project=${project.id}&start=2025-04-10T14%3A37%3A55`,
query: {
[LOGS_AGGREGATE_SORT_BYS_KEY]: '-p99(severity_number)',
[LOGS_QUERY_KEY]: 'test',
[LOGS_GROUP_BY_KEY]: 'message.template',
[LOGS_AGGREGATE_FN_KEY]: 'p99',
[LOGS_AGGREGATE_PARAM_KEY]: 'severity_number',
[LOGS_FIELDS_KEY]: ['timestamp', 'message'],
},
})
);
});

it('renders loading state', () => {
Expand All @@ -97,7 +78,7 @@ describe('LogsAggregateTable', () => {
data: null,
pageLinks: undefined,
});
render(<LogsAggregateTable />, {wrapper: createWrapper()});
render(<LogsAggregateTableWithParamsProvider />, {initialRouterConfig});
expect(screen.getByLabelText('Aggregates')).toBeInTheDocument();
});

Expand All @@ -108,7 +89,7 @@ describe('LogsAggregateTable', () => {
data: null,
pageLinks: undefined,
});
render(<LogsAggregateTable />, {wrapper: createWrapper()});
render(<LogsAggregateTableWithParamsProvider />, {initialRouterConfig});
expect(screen.getByTestId('error-indicator')).toBeInTheDocument();
});

Expand Down Expand Up @@ -136,7 +117,7 @@ describe('LogsAggregateTable', () => {
},
pageLinks: undefined,
});
render(<LogsAggregateTable />, {wrapper: createWrapper()});
render(<LogsAggregateTableWithParamsProvider />, {initialRouterConfig});
const rows = screen.getAllByTestId('grid-body-row');
expect(rows).toHaveLength(3);
const expected = [
Expand Down
Loading
Loading