Skip to content

Commit 33aafc8

Browse files
setchysetchy
committed
refactor: use octokit client
Signed-off-by: Adam Setch <adam.setch@outlook.com>
1 parent db7c353 commit 33aafc8

15 files changed

Lines changed: 304 additions & 281 deletions

File tree

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@
152152
"*": "biome check --no-errors-on-unmatched",
153153
"*.{js,ts,tsx}": "pnpm test --findRelatedTests --passWithNoTests --updateSnapshot"
154154
}
155-
}
155+
}

‎src/renderer/context/App.tsx‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import type {
3636
LoginPersonalAccessTokenOptions,
3737
} from '../utils/auth/types';
3838

39-
import { headNotifications } from '../utils/api/client';
39+
import { clearOctokitClientCache } from '../utils/api/octokit';
4040
import {
4141
addAccount,
4242
exchangeAuthCodeForAccessToken,
@@ -436,8 +436,8 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
436436
*/
437437
const loginWithPersonalAccessToken = useCallback(
438438
async ({ token, hostname }: LoginPersonalAccessTokenOptions) => {
439-
const encryptedToken = (await encryptValue(token)) as Token;
440-
await headNotifications(hostname, encryptedToken);
439+
// const encryptedToken = (await encryptValue(token)) as Token;
440+
// await headNotifications(hostname, encryptedToken);
441441

442442
const updatedAuth = await addAccount(
443443
auth,
@@ -457,6 +457,9 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
457457

458458
const updatedAuth = removeAccount(auth, account);
459459

460+
// Clear Octokit client cache when removing account
461+
clearOctokitClientCache();
462+
460463
persistAuth(updatedAuth);
461464
},
462465
[auth, removeAccountNotifications, persistAuth],

‎src/renderer/hooks/useNotifications.ts‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,7 @@ export const useNotifications = (): NotificationsState => {
143143
try {
144144
await Promise.all(
145145
readNotifications.map((notification) =>
146-
markNotificationThreadAsRead(notification.account,
147-
notification.id,
148-
149-
),
146+
markNotificationThreadAsRead(notification.account, notification.id),
150147
),
151148
);
152149

@@ -182,10 +179,7 @@ export const useNotifications = (): NotificationsState => {
182179
try {
183180
await Promise.all(
184181
doneNotifications.map((notification) =>
185-
markNotificationThreadAsDone(notification.account,
186-
notification.id,
187-
188-
),
182+
markNotificationThreadAsDone(notification.account, notification.id),
189183
),
190184
);
191185

@@ -218,7 +212,6 @@ export const useNotifications = (): NotificationsState => {
218212
await ignoreNotificationThreadSubscription(
219213
notification.account,
220214
notification.id,
221-
222215
);
223216

224217
if (state.settings.markAsDoneOnUnsubscribe) {

‎src/renderer/utils/api/client.test.ts‎

Lines changed: 25 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ import { mockToken } from '../../__mocks__/state-mocks';
77

88
import { Constants } from '../../constants';
99

10-
import type { Hostname, Link, SettingsState } from '../../types';
10+
import type { Link, SettingsState } from '../../types';
1111
import type { GitHubGraphQLResponse } from './graphql/types';
1212

1313
import {
14-
fetchAuthenticatedUserDetails,
1514
fetchDiscussionByNumber,
1615
fetchIssueByNumber,
1716
fetchNotificationDetailsForList,
@@ -24,8 +23,6 @@ import {
2423
markNotificationThreadAsRead,
2524
} from './client';
2625
import {
27-
FetchAuthenticatedUserDetailsDocument,
28-
type FetchAuthenticatedUserDetailsQuery,
2926
FetchDiscussionByNumberDocument,
3027
type FetchDiscussionByNumberQuery,
3128
FetchIssueByNumberDocument,
@@ -36,7 +33,6 @@ import {
3633
import * as octokitModule from './octokit';
3734
import * as apiRequests from './request';
3835

39-
const mockGitHubHostname = 'github.com' as Hostname;
4036
const mockThreadId = '1234';
4137

4238
describe('renderer/utils/api/client.ts', () => {
@@ -76,7 +72,7 @@ describe('renderer/utils/api/client.ts', () => {
7672
});
7773

7874
it('headNotifications - should fetch notifications head', async () => {
79-
await headNotifications(mockGitHubHostname, mockToken);
75+
await headNotifications(mockGitHubCloudAccount);
8076

8177
// expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
8278
// 'HEAD',
@@ -177,10 +173,7 @@ describe('renderer/utils/api/client.ts', () => {
177173
});
178174

179175
it('markNotificationThreadAsRead - should mark notification thread as read', async () => {
180-
await markNotificationThreadAsRead(mockGitHubCloudAccount,
181-
mockThreadId,
182-
183-
);
176+
await markNotificationThreadAsRead(mockGitHubCloudAccount, mockThreadId);
184177

185178
// expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
186179
// 'PATCH',
@@ -191,10 +184,7 @@ describe('renderer/utils/api/client.ts', () => {
191184
});
192185

193186
it('markNotificationThreadAsDone - should mark notification thread as done', async () => {
194-
await markNotificationThreadAsDone(mockGitHubCloudAccount,
195-
mockThreadId,
196-
197-
);
187+
await markNotificationThreadAsDone(mockGitHubCloudAccount, mockThreadId);
198188

199189
// expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
200190
// 'DELETE',
@@ -205,9 +195,9 @@ describe('renderer/utils/api/client.ts', () => {
205195
});
206196

207197
it('ignoreNotificationThreadSubscription - should ignore notification thread subscription', async () => {
208-
await ignoreNotificationThreadSubscription(mockGitHubCloudAccount,
198+
await ignoreNotificationThreadSubscription(
199+
mockGitHubCloudAccount,
209200
mockThreadId,
210-
211201
);
212202

213203
// expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
@@ -222,7 +212,6 @@ describe('renderer/utils/api/client.ts', () => {
222212
await getHtmlUrl(
223213
mockGitHubCloudAccount,
224214
'https://api.github.com/repos/gitify-app/notifications-test/issues/785' as Link,
225-
226215
);
227216

228217
// expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
@@ -232,25 +221,25 @@ describe('renderer/utils/api/client.ts', () => {
232221
// );
233222
});
234223

235-
it('fetchAuthenticatedUserDetails calls performGraphQLRequest with correct args', async () => {
236-
const performGraphQLRequestSpy = jest.spyOn(
237-
apiRequests,
238-
'performGraphQLRequest',
239-
);
240-
241-
performGraphQLRequestSpy.mockResolvedValue({
242-
data: {},
243-
headers: {},
244-
} as GitHubGraphQLResponse<FetchAuthenticatedUserDetailsQuery>);
245-
246-
await fetchAuthenticatedUserDetails(mockGitHubHostname, mockToken);
247-
248-
expect(performGraphQLRequestSpy).toHaveBeenCalledWith(
249-
'https://api.github.com/graphql',
250-
mockToken,
251-
FetchAuthenticatedUserDetailsDocument,
252-
);
253-
});
224+
// it('fetchAuthenticatedUserDetails calls performGraphQLRequest with correct args', async () => {
225+
// const performGraphQLRequestSpy = jest.spyOn(
226+
// apiRequests,
227+
// 'performGraphQLRequest',
228+
// );
229+
230+
// performGraphQLRequestSpy.mockResolvedValue({
231+
// data: {},
232+
// headers: {},
233+
// } as GitHubGraphQLResponse<FetchAuthenticatedUserDetailsQuery>);
234+
235+
// await fetchAuthenticatedUserDetails(mockGitHubCloudAccount);
236+
237+
// expect(performGraphQLRequestSpy).toHaveBeenCalledWith(
238+
// 'https://api.github.com/graphql',
239+
// mockToken,
240+
// FetchAuthenticatedUserDetailsDocument,
241+
// );
242+
// });
254243

255244
it('fetchDiscussionByNumber calls performGraphQLRequest with correct args', async () => {
256245
const performGraphQLRequestSpy = jest.spyOn(

‎src/renderer/utils/api/client.ts‎

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1+
import type { OctokitResponse } from '@octokit/plugin-paginate-rest/dist-types/types';
2+
13
import { Constants } from '../../constants';
24

35
import type {
46
Account,
57
GitifyNotification,
6-
Hostname,
78
Link,
89
SettingsState,
9-
Token,
1010
} from '../../types';
1111
import type { GitHubGraphQLResponse } from './graphql/types';
1212
import type {
@@ -36,19 +36,17 @@ import {
3636
import { MergeQueryBuilder } from './graphql/MergeQueryBuilder';
3737
import { createOctokitClient } from './octokit';
3838
import { performGraphQLRequest, performGraphQLRequestString } from './request';
39-
import { getGitHubGraphQLUrl, getNumberFromUrl } from './utils';
40-
import { OctokitResponse } from '@octokit/plugin-paginate-rest/dist-types/types';
39+
import { getNumberFromUrl } from './utils';
4140

4241
/**
4342
* Perform a HEAD operation, used to validate that connectivity is established.
4443
*
4544
* Endpoint documentation: https://docs.github.com/en/rest/activity/notifications
4645
*/
4746
export async function headNotifications(
48-
hostname: Hostname,
49-
token: Token,
47+
account: Account,
5048
): Promise<HeadNotificationsResponse> {
51-
const octokit = await createOctokitClient(hostname, token);
49+
const octokit = await createOctokitClient(account);
5250

5351
await octokit.rest.activity.listNotificationsForAuthenticatedUser({
5452
per_page: 1,
@@ -64,7 +62,7 @@ export async function listNotificationsForAuthenticatedUser(
6462
account: Account,
6563
settings: SettingsState,
6664
): Promise<ListNotificationsForAuthenticatedUserResponse> {
67-
const octokit = await createOctokitClient(account.hostname, account.token);
65+
const octokit = await createOctokitClient(account);
6866

6967
if (settings.fetchAllNotifications) {
7068
// Fetch all pages using Octokit's pagination
@@ -107,7 +105,7 @@ export async function markNotificationThreadAsRead(
107105
account: Account,
108106
threadId: string,
109107
): Promise<MarkNotificationThreadAsReadResponse> {
110-
const octokit = await createOctokitClient(account.hostname, account.token);
108+
const octokit = await createOctokitClient(account);
111109

112110
const response = await octokit.rest.activity.markThreadAsRead({
113111
thread_id: Number(threadId),
@@ -128,7 +126,7 @@ export async function markNotificationThreadAsDone(
128126
account: Account,
129127
threadId: string,
130128
): Promise<MarkNotificationThreadAsDoneResponse> {
131-
const octokit = await createOctokitClient(account.hostname, account.token);
129+
const octokit = await createOctokitClient(account);
132130

133131
const response = await octokit.rest.activity.markThreadAsDone({
134132
thread_id: Number(threadId),
@@ -146,7 +144,7 @@ export async function ignoreNotificationThreadSubscription(
146144
account: Account,
147145
threadId: string,
148146
): Promise<IgnoreNotificationThreadSubscriptionResponse> {
149-
const octokit = await createOctokitClient(account.hostname, account.token);
147+
const octokit = await createOctokitClient(account);
150148

151149
const response = await octokit.rest.activity.setThreadSubscription({
152150
thread_id: Number(threadId),
@@ -165,7 +163,7 @@ export async function getCommit(
165163
account: Account,
166164
url: Link,
167165
): Promise<GetCommitResponse> {
168-
const octokit = await createOctokitClient(account.hostname, account.token);
166+
const octokit = await createOctokitClient(account);
169167

170168
// Perform a generic GET request using Octokit's request method
171169
const response = await octokit.request('GET {+url}', {
@@ -184,7 +182,7 @@ export async function getCommitComment(
184182
account: Account,
185183
url: Link,
186184
): Promise<GetCommitCommentResponse> {
187-
const octokit = await createOctokitClient(account.hostname, account.token);
185+
const octokit = await createOctokitClient(account);
188186

189187
// Perform a generic GET request using Octokit's request method
190188
const response = await octokit.request('GET {+url}', {
@@ -203,7 +201,7 @@ export async function getRelease(
203201
account: Account,
204202
url: Link,
205203
): Promise<GetReleaseResponse> {
206-
const octokit = await createOctokitClient(account.hostname, account.token);
204+
const octokit = await createOctokitClient(account);
207205

208206
// Perform a generic GET request using Octokit's request method
209207
const response = await octokit.request('GET {+url}', {
@@ -220,7 +218,7 @@ export async function getHtmlUrl(
220218
account: Account,
221219
url: Link,
222220
): Promise<GitHubHtmlUrlResponse> {
223-
const octokit = await createOctokitClient(account.hostname, account.token);
221+
const octokit = await createOctokitClient(account);
224222

225223
// Perform a generic GET request using Octokit's request method
226224
const response = await octokit.request('GET {+url}', {
@@ -230,15 +228,14 @@ export async function getHtmlUrl(
230228
return response.data as GitHubHtmlUrlResponse;
231229
}
232230

233-
234231
/**
235232
* Follow GitHub Response URL
236233
*/
237234
export async function followUrl<TResult>(
238235
account: Account,
239236
url: Link,
240237
): Promise<TResult> {
241-
const octokit = await createOctokitClient(account.hostname, account.token);
238+
const octokit = await createOctokitClient(account);
242239

243240
// Perform a generic GET request using Octokit's request method
244241
const response = await octokit.request('GET {+url}', {
@@ -252,12 +249,11 @@ export async function followUrl<TResult>(
252249
* Fetch details of the currently authenticated GitHub user.
253250
*/
254251
export async function fetchAuthenticatedUserDetails(
255-
hostname: Hostname,
256-
token: Token,
252+
account: Account,
257253
): Promise<OctokitResponse<GetAuthenticatedUserResponse>> {
258-
const octokit = await createOctokitClient(hostname, token);
254+
const octokit = await createOctokitClient(account);
259255

260-
const response = await octokit.rest.users.getAuthenticated()
256+
const response = await octokit.rest.users.getAuthenticated();
261257

262258
return response;
263259
}
@@ -268,12 +264,10 @@ export async function fetchAuthenticatedUserDetails(
268264
export async function fetchDiscussionByNumber(
269265
notification: GitifyNotification,
270266
): Promise<GitHubGraphQLResponse<FetchDiscussionByNumberQuery>> {
271-
const url = getGitHubGraphQLUrl(notification.account.hostname);
272267
const number = getNumberFromUrl(notification.subject.url);
273268

274269
return performGraphQLRequest(
275-
url.toString() as Link,
276-
notification.account.token,
270+
notification.account,
277271
FetchDiscussionByNumberDocument,
278272
{
279273
owner: notification.repository.owner.login,
@@ -295,12 +289,10 @@ export async function fetchDiscussionByNumber(
295289
export async function fetchIssueByNumber(
296290
notification: GitifyNotification,
297291
): Promise<GitHubGraphQLResponse<FetchIssueByNumberQuery>> {
298-
const url = getGitHubGraphQLUrl(notification.account.hostname);
299292
const number = getNumberFromUrl(notification.subject.url);
300293

301294
return performGraphQLRequest(
302-
url.toString() as Link,
303-
notification.account.token,
295+
notification.account,
304296
FetchIssueByNumberDocument,
305297
{
306298
owner: notification.repository.owner.login,
@@ -318,12 +310,10 @@ export async function fetchIssueByNumber(
318310
export async function fetchPullByNumber(
319311
notification: GitifyNotification,
320312
): Promise<GitHubGraphQLResponse<FetchPullRequestByNumberQuery>> {
321-
const url = getGitHubGraphQLUrl(notification.account.hostname);
322313
const number = getNumberFromUrl(notification.subject.url);
323314

324315
return performGraphQLRequest(
325-
url.toString() as Link,
326-
notification.account.token,
316+
notification.account,
327317
FetchPullRequestByNumberDocument,
328318
{
329319
owner: notification.repository.owner.login,
@@ -399,11 +389,8 @@ export async function fetchNotificationDetailsForList(
399389
const query = builder.getGraphQLQuery();
400390
const variables = builder.getGraphQLVariables();
401391

402-
const url = getGitHubGraphQLUrl(notifications[0].account.hostname);
403-
404392
const response = await performGraphQLRequestString(
405-
url.toString() as Link,
406-
notifications[0].account.token,
393+
notifications[0].account,
407394
query,
408395
variables,
409396
);

0 commit comments

Comments
 (0)