Skip to content

feat: milestone indicator #1178

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 3 commits into from
Jun 4, 2024
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
238 changes: 141 additions & 97 deletions src/components/NotificationRow.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { fireEvent, render, screen } from '@testing-library/react';
import { shell } from 'electron';
import { mockAuth, mockSettings } from '../__mocks__/state-mocks';
import { AppContext } from '../context/App';
import type { UserType } from '../typesGitHub';
import type { Milestone, UserType } from '../typesGitHub';
import { mockSingleNotification } from '../utils/api/__mocks__/response-mocks';
import * as helpers from '../utils/helpers';
import { NotificationRow } from './NotificationRow';
Expand Down Expand Up @@ -64,111 +64,155 @@ describe('components/NotificationRow.tsx', () => {
expect(tree).toMatchSnapshot();
});

describe('rendering for notification comments count', () => {
it('should render when no comments', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = null;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
describe('notification pills / metrics', () => {
describe('linked issue pills', () => {
it('should render issues pill when linked to one issue/pr', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.linkedIssues = ['#1'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});

it('should render issues pill when linked to multiple issues/prs', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.linkedIssues = ['#1', '#2'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});
});

it('should render when 1 comment', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = 1;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
describe('comment pills', () => {
it('should render when no comments', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = null;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});

it('should render when 1 comment', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = 1;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});

it('should render when more than 1 comments', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = 2;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});
});

it('should render when more than 1 comments', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());
describe('label pills', () => {
it('should render labels pill', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.comments = 2;
const mockNotification = mockSingleNotification;
mockNotification.subject.labels = ['enhancement', 'good-first-issue'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};
const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});
});
});

describe('notification labels', () => {
it('should render labels metric when available', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.labels = ['enhancement', 'good-first-issue'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});
});

describe('linked issues/prs', () => {
it('should render when linked to one issue/pr', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.linkedIssues = ['#1'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});

it('should render when linked to multiple issues/prs', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.linkedIssues = ['#1', '#2'];

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
describe('milestone pills', () => {
it('should render open milestone pill', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.milestone = {
title: 'Milestone 1',
state: 'open',
} as Milestone;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});

it('should render closed milestone pill', async () => {
jest
.spyOn(global.Date, 'now')
.mockImplementation(() => new Date('2024').valueOf());

const mockNotification = mockSingleNotification;
mockNotification.subject.milestone = {
title: 'Milestone 1',
state: 'closed',
} as Milestone;

const props = {
notification: mockNotification,
hostname: 'github.com',
};

const tree = render(<NotificationRow {...props} />);
expect(tree).toMatchSnapshot();
});
});
});

Expand Down
19 changes: 19 additions & 0 deletions src/components/NotificationRow.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
CommentIcon,
FeedPersonIcon,
IssueClosedIcon,
MilestoneIcon,
ReadIcon,
TagIcon,
} from '@primer/octicons-react';
Expand Down Expand Up @@ -218,6 +219,24 @@ export const NotificationRow: FC<IProps> = ({ notification, hostname }) => {
</button>
</span>
)}
{notification.subject.milestone && (
<span
className="ml-1"
title={notification.subject.milestone.title}
>
<button type="button" className={Constants.PILL_CLASS_NAME}>
<MilestoneIcon
size={12}
className={
notification.subject.milestone.state === 'open'
? IconColor.GREEN
: IconColor.RED
}
aria-label={notification.subject.milestone.title}
/>
</button>
</span>
)}
</span>
</span>
</div>
Expand Down
Loading