Skip to content

feat: support discussion state types #827

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
merged 10 commits into from
Feb 29, 2024
Merged

feat: support discussion state types #827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fb397bd
feat: support discussion states
setchy Feb 26, 2024
c6414a3
feat: support discussion states
setchy Feb 26, 2024
a704180
feat: add test coverage
setchy Feb 26, 2024
c0e4705
feat: add test coverage
setchy Feb 26, 2024
ffec197
feat: add test coverage
setchy Feb 26, 2024
1beb3dc
refactor graphql search interface to be generic.
setchy Feb 27, 2024
b1d5b3a
add tests for answered discussion
setchy Feb 27, 2024
11e777d
refactor mocks out
setchy Feb 27, 2024
22be07c
refactor mocks out
setchy Feb 27, 2024
a02248d
Merge branch 'main' into feature/discussion-state-types
setchy Feb 29, 2024
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
429 changes: 258 additions & 171 deletions src/__mocks__/mockedData.ts
View file
Open in desktop

Large diffs are not rendered by default.

217 changes: 206 additions & 11 deletions src/hooks/useNotifications.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ import axios from 'axios';
import nock from 'nock';

import { mockAccounts, mockSettings } from '../__mocks__/mock-state';
import { mockedUser } from '../__mocks__/mockedData';
import {
mockedDiscussionNotifications,
mockedUser,
} from '../__mocks__/mockedData';
import { AuthState } from '../types';
import { useNotifications } from './useNotifications';

Expand Down Expand Up @@ -191,28 +194,43 @@ describe('hooks/useNotifications.ts', () => {
const notifications = [
{
id: 1,
title: 'This is a notification.',
subject: { type: 'Issue', url: 'https://api.github.com/1' },
subject: {
title: 'This is a notification.',
type: 'Issue',
url: 'https://api.github.com/1',
},
},
{
id: 2,
title: 'A merged PR.',
subject: { type: 'PullRequest', url: 'https://api.github.com/2' },
subject: {
title: 'A merged PR.',
type: 'PullRequest',
url: 'https://api.github.com/2',
},
},
{
id: 3,
title: 'A closed PR.',
subject: { type: 'PullRequest', url: 'https://api.github.com/3' },
subject: {
title: 'A closed PR.',
type: 'PullRequest',
url: 'https://api.github.com/3',
},
},
{
id: 4,
title: 'A draft PR.',
subject: { type: 'PullRequest', url: 'https://api.github.com/4' },
subject: {
title: 'A draft PR.',
type: 'PullRequest',
url: 'https://api.github.com/4',
},
},
{
id: 5,
title: 'A draft PR.',
subject: { type: 'PullRequest', url: 'https://api.github.com/5' },
subject: {
title: 'A draft PR.',
type: 'PullRequest',
url: 'https://api.github.com/5',
},
},
];

Expand Down Expand Up @@ -266,6 +284,183 @@ describe('hooks/useNotifications.ts', () => {
result.current.notifications[0].notifications[4].subject.state,
).toBe('draft');
});

it('should fetch discussion notifications with success - with colors', async () => {
const accounts: AuthState = {
...mockAccounts,
enterpriseAccounts: [],
user: mockedUser,
};

nock('https://api.github.com')
.get('/notifications?participating=false')
.reply(200, mockedDiscussionNotifications);

nock('https://api.github.com')
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is an answered discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: null,
isAnswered: true,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is a duplicate discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: 'DUPLICATE',
isAnswered: false,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is an open discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: null,
isAnswered: false,
},
},
{
node: {
title: 'This is an open discussion',
viewerSubscription: 'IGNORED',
stateReason: null,
isAnswered: false,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is nm outdated discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: 'OUTDATED',
isAnswered: false,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is a reopened discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: 'REOPENED',
isAnswered: false,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'This is a resolved discussion',
viewerSubscription: 'SUBSCRIBED',
stateReason: 'RESOLVED',
isAnswered: false,
},
},
],
},
},
})
.post('/graphql')
.reply(200, {
data: {
search: {
edges: [
{
node: {
title: 'unknown search result',
viewerSubscription: 'SUBSCRIBED',
stateReason: null,
isAnswered: false,
},
},
],
},
},
});

const { result } = renderHook(() => useNotifications(true));

act(() => {
result.current.fetchNotifications(accounts, {
...mockSettings,
colors: true,
});
});

expect(result.current.isFetching).toBe(true);

await waitFor(() => {
expect(result.current.notifications[0].hostname).toBe('github.com');
});

const resultNotifications = result.current.notifications[0];

expect(resultNotifications.notifications.length).toBe(7);
expect(resultNotifications.notifications[0].subject.state).toBe(
'ANSWERED',
);
expect(resultNotifications.notifications[1].subject.state).toBe(
'DUPLICATE',
);
expect(resultNotifications.notifications[2].subject.state).toBe('OPEN');
expect(resultNotifications.notifications[3].subject.state).toBe(
'OUTDATED',
);
expect(resultNotifications.notifications[4].subject.state).toBe(
'REOPENED',
);
expect(resultNotifications.notifications[5].subject.state).toBe(
'RESOLVED',
);
expect(resultNotifications.notifications[6].subject.state).toBe('OPEN');
});
});
});

Expand Down
70 changes: 42 additions & 28 deletions src/hooks/useNotifications.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
getEnterpriseAccountToken,
generateGitHubAPIUrl,
isEnterpriseHost,
getDiscussionState,
} from '../utils/helpers';
import { removeNotification } from '../utils/remove-notification';
import {
Expand Down Expand Up @@ -130,12 +131,6 @@ export const useNotifications = (colors: boolean): NotificationsState => {
notifications: await axios.all<Notification>(
accountNotifications.notifications.map(
async (notification: Notification) => {
if (
notification.subject.type !== 'PullRequest' &&
notification.subject.type !== 'Issue'
) {
return notification;
}
const isEnterprise = isEnterpriseHost(
accountNotifications.hostname,
);
Expand All @@ -146,28 +141,47 @@ export const useNotifications = (colors: boolean): NotificationsState => {
)
: accounts.token;

const cardinalData = (
await apiRequestAuth(
notification.subject.url,
'GET',
token,
)
).data;

const state =
cardinalData.state === 'closed'
? cardinalData.state_reason ||
(cardinalData.merged && 'merged') ||
'closed'
: (cardinalData.draft && 'draft') || 'open';

return {
...notification,
subject: {
...notification.subject,
state,
},
};
switch (notification.subject.type) {
case 'Discussion':
const discussionState = await getDiscussionState(
notification,
token,
);

return {
...notification,
subject: {
...notification.subject,
state: discussionState,
},
};
case 'Issue':
case 'PullRequest':
const cardinalData = (
await apiRequestAuth(
notification.subject.url,
'GET',
token,
)
).data;

const state =
cardinalData.state === 'closed'
? cardinalData.state_reason ||
(cardinalData.merged && 'merged') ||
'closed'
: (cardinalData.draft && 'draft') || 'open';

return {
...notification,
subject: {
...notification.subject,
state,
},
};
default:
return notification;
}
},
),
),
Expand Down
Loading