Skip to content

feat(Codecov): Add tests for datePicker components #89341

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

Merged
merged 6 commits into from
Apr 14, 2025
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
145 changes: 145 additions & 0 deletions static/app/components/codecov/datePicker/datePicker.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
import {initializeOrg} from 'sentry-test/initializeOrg';
import {render, screen, userEvent} from 'sentry-test/reactTestingLibrary';

import {initializeUrlState} from 'sentry/actionCreators/pageFilters';
import {DatePicker} from 'sentry/components/codecov/datePicker/datePicker';
import OrganizationStore from 'sentry/stores/organizationStore';
import PageFiltersStore from 'sentry/stores/pageFiltersStore';

const {organization, router} = initializeOrg({
router: {
location: {
query: {},
pathname: '/codecov/tests',
},
params: {},
},
});

describe('DatePicker', function () {
beforeEach(() => {
PageFiltersStore.init();
OrganizationStore.init();

OrganizationStore.onUpdate(organization, {replace: true});
PageFiltersStore.onInitializeUrlState(
{
projects: [],
environments: [],
datetime: {
period: '7d',
start: null,
end: null,
utc: false,
},
},
new Set(['datetime'])
);
});

it('can change period', async function () {
render(<DatePicker />, {router});

await userEvent.click(screen.getByRole('button', {name: '7D', expanded: false}));
await userEvent.click(screen.getByRole('option', {name: 'Last 30 days'}));

expect(
screen.getByRole('button', {name: '30D', expanded: false})
).toBeInTheDocument();
expect(router.push).toHaveBeenCalledWith(
expect.objectContaining({query: {statsPeriod: '30d'}})
);
expect(PageFiltersStore.getState()).toEqual({
isReady: true,
shouldPersist: true,
desyncedFilters: new Set(),
pinnedFilters: new Set(['datetime']),
selection: {
datetime: {
period: '30d',
end: null,
start: null,
utc: false,
},
environments: [],
projects: [],
},
});
});

it('adjusts period if invalid', async function () {
PageFiltersStore.reset();
PageFiltersStore.onInitializeUrlState(
{
projects: [],
environments: [],
datetime: {
period: '123d',
start: null,
end: null,
utc: false,
},
},
new Set(['datetime'])
);

render(<DatePicker />, {router});

// Confirm selection changed to default Codecov period
const button = await screen.findByRole('button', {name: '24H', expanded: false});
expect(button).toBeInTheDocument();
expect(router.push).toHaveBeenCalledWith(
expect.objectContaining({query: {statsPeriod: '24h'}})
);
expect(PageFiltersStore.getState()).toEqual({
isReady: true,
shouldPersist: true,
desyncedFilters: new Set(),
pinnedFilters: new Set(['datetime']),
selection: {
datetime: {
period: '24h',
end: null,
start: null,
utc: false,
},
environments: [],
projects: [],
},
});
});

it('displays a desynced state message', async function () {
const {organization: desyncOrganization, router: desyncRouter} = initializeOrg({
router: {
location: {
query: {statsPeriod: '7d'},
pathname: '/codecov/test',
},
params: {},
},
});

PageFiltersStore.reset();
initializeUrlState({
memberProjects: [],
nonMemberProjects: [],
organization: desyncOrganization,
queryParams: {statsPeriod: '30d'},
router: desyncRouter,
shouldEnforceSingleProject: false,
});

render(<DatePicker />, {
router: desyncRouter,
organization: desyncOrganization,
});

await userEvent.click(screen.getByRole('button', {name: '30D', expanded: false}));
expect(screen.getByText('Filters Updated')).toBeInTheDocument();
expect(
screen.getByRole('button', {name: 'Restore Previous Values'})
).toBeInTheDocument();
expect(screen.getByRole('button', {name: 'Got It'})).toBeInTheDocument();
});
});
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import {useEffect} from 'react';

import {updateDateTime} from 'sentry/actionCreators/pageFilters';
import type {DateSelectorProps} from 'sentry/components/codecov/dateSelector';
import {DateSelector} from 'sentry/components/codecov/dateSelector';
import type {DateSelectorProps} from 'sentry/components/codecov/datePicker/dateSelector';
import {DateSelector} from 'sentry/components/codecov/datePicker/dateSelector';
import {DesyncedFilterMessage} from 'sentry/components/organizations/pageFilters/desyncedFilter';
import {t} from 'sentry/locale';
import usePageFilters from 'sentry/utils/usePageFilters';
import useRouter from 'sentry/utils/useRouter';

import {isValidCodecovRelativePeriod} from './utils';
import {isValidCodecovRelativePeriod} from '../utils';

Check warning on line 11 in static/app/components/codecov/datePicker/datePicker.tsx

View workflow job for this annotation

GitHub Actions / eslint

import statements should have an absolute path

const CODECOV_DEFAULT_RELATIVE_PERIOD = '24h';
export const CODECOV_DEFAULT_RELATIVE_PERIODS = {
Expand All @@ -32,7 +32,7 @@
const desynced = desyncedFilters.has('datetime');
const period = selection.datetime?.period;

// Adjusts to valid Codecov relative period
// Adjusts to valid Codecov relative period since Codecov only accepts a subset of dates other components accept, defined in CODECOV_DEFAULT_RELATIVE_PERIODS
useEffect(() => {
if (!isValidCodecovRelativePeriod(period)) {
const newTimePeriod = {period: CODECOV_DEFAULT_RELATIVE_PERIOD};
Expand Down
17 changes: 17 additions & 0 deletions static/app/components/codecov/datePicker/dateSelector.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import {render, screen} from 'sentry-test/reactTestingLibrary';

import {DateSelector} from 'sentry/components/codecov/datePicker/dateSelector';

describe('DateSelector', function () {
it('renders when given relative period', async function () {
render(<DateSelector relative="7d" />);
expect(await screen.findByRole('button', {name: '7D'})).toBeInTheDocument();
});

it('renders when given an invalid relative period', async function () {
render(<DateSelector relative="1y" />);
expect(
await screen.findByRole('button', {name: 'Invalid Period'})
).toBeInTheDocument();
});
});
16 changes: 16 additions & 0 deletions static/app/components/codecov/utils.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import {isValidCodecovRelativePeriod} from 'sentry/components/codecov/utils';

describe('isValidCodecovRelativePeriod', function () {
it('returns false for null relative periods', function () {
const period = null;
expect(isValidCodecovRelativePeriod(period)).toBe(false);
});
it('returns false for periods not belonging to the Codecov default relative periods', function () {
const period = '123d';
expect(isValidCodecovRelativePeriod(period)).toBe(false);
});
it('returns true for a valid relative period', function () {
const period = '7d';
expect(isValidCodecovRelativePeriod(period)).toBe(true);
});
});
6 changes: 5 additions & 1 deletion static/app/components/codecov/utils.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import {CODECOV_DEFAULT_RELATIVE_PERIODS} from './datePicker';
import {CODECOV_DEFAULT_RELATIVE_PERIODS} from './datePicker/datePicker';

// Date Picker Utils Start

/**
* Determines if a period is valid for a Codecov DatePicker component. A period is invalid if
Expand All @@ -15,3 +17,5 @@ export function isValidCodecovRelativePeriod(period: string | null): boolean {

return true;
}

// Date Picker Utils End
2 changes: 1 addition & 1 deletion static/app/views/codecov/tests/tests.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import styled from '@emotion/styled';

import {DatePicker} from 'sentry/components/codecov/datePicker';
import {DatePicker} from 'sentry/components/codecov/datePicker/datePicker';
import PageFilterBar from 'sentry/components/organizations/pageFilterBar';
import PageFiltersContainer from 'sentry/components/organizations/pageFilters/container';
import {space} from 'sentry/styles/space';
Expand Down
Loading