Skip to content

refactor(api): request and client types #2545

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
setchy merged 8 commits into from
Jan 22, 2026
Merged

refactor(api): request and client types #2545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
811af9e
refactor(api): request function typing
setchy Jan 20, 2026
24f2d24
refactor(api): request function typing
setchy Jan 20, 2026
eb4d560
refactor(api): request function typing
setchy Jan 20, 2026
9cc842d
refactor(api): request function typing
setchy Jan 20, 2026
5431011
Merge branch 'main' into refactor/api-request-shape-2
setchy Jan 22, 2026
a9bed25
Merge branch 'main' into refactor/api-request-shape-2
setchy Jan 22, 2026
0ba28fa
Merge branch 'main' into refactor/api-request-shape-2
setchy Jan 22, 2026
bcdcb60
Merge branch 'main' into refactor/api-request-shape-2
setchy Jan 22, 2026
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
12 changes: 6 additions & 6 deletions src/renderer/context/App.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,6 @@ describe('renderer/context/App.tsx', () => {
});

describe('authentication methods', () => {
const apiRequestAuthSpy = jest.spyOn(apiRequests, 'apiRequestAuth');

it('should call loginWithGitHubApp', async () => {
const { button } = renderContextButton('loginWithGitHubApp');

Expand All @@ -207,7 +205,9 @@ describe('renderer/context/App.tsx', () => {
});

it('should call loginWithPersonalAccessToken', async () => {
apiRequestAuthSpy.mockResolvedValueOnce(null);
const performAuthenticatedRESTRequestSpy = jest
.spyOn(apiRequests, 'performAuthenticatedRESTRequest')
.mockResolvedValueOnce(null);

const { button } = renderContextButton('loginWithPersonalAccessToken', {
hostname: 'github.com' as Hostname,
Expand All @@ -220,10 +220,10 @@ describe('renderer/context/App.tsx', () => {
expect(mockFetchNotifications).toHaveBeenCalledTimes(1),
);

expect(apiRequestAuthSpy).toHaveBeenCalledTimes(1);
expect(apiRequestAuthSpy).toHaveBeenCalledWith(
'https://api.github.com/notifications',
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledTimes(1);
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'HEAD',
'https://api.github.com/notifications',
'encrypted',
);
});
Expand Down
186 changes: 82 additions & 104 deletions src/renderer/utils/api/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
import axios, { type AxiosPromise, type AxiosResponse } from 'axios';

import { mockGitHubCloudAccount } from '../../__mocks__/account-mocks';
import {
mockGitHubCloudGitifyNotifications,
mockPartialGitifyNotification,
} from '../../__mocks__/notifications-mocks';
import { mockToken } from '../../__mocks__/state-mocks';
import {
mockAuthHeaders,
mockNonCachedAuthHeaders,
} from './__mocks__/request-mocks';

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

import type { Hostname, Link, SettingsState, Token } from '../../types';
import type { GitHubGraphQLResponse } from './graphql/types';

import * as logger from '../../utils/logger';
import {
fetchAuthenticatedUserDetails,
fetchDiscussionByNumber,
Expand All @@ -39,7 +33,6 @@ import {
FetchPullRequestByNumberDocument,
type FetchPullRequestByNumberQuery,
} from './graphql/generated/graphql';
import type { ExecutionResultWithHeaders } from './request';
import * as apiRequests from './request';

jest.mock('axios');
Expand All @@ -48,96 +41,110 @@ const mockGitHubHostname = 'github.com' as Hostname;
const mockThreadId = '1234';

describe('renderer/utils/api/client.ts', () => {
const performAuthenticatedRESTRequestSpy = jest.spyOn(
apiRequests,
'performAuthenticatedRESTRequest',
);

afterEach(() => {
jest.clearAllMocks();
});

it('headNotifications - should fetch notifications head', async () => {
await headNotifications(mockGitHubHostname, mockToken);

expect(axios).toHaveBeenCalledWith({
url: 'https://api.github.com/notifications',
headers: mockNonCachedAuthHeaders,
method: 'HEAD',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'HEAD',
'https://api.github.com/notifications',
mockToken,
);
});

describe('listNotificationsForAuthenticatedUser', () => {
it('should list only participating notifications for user', async () => {
const mockSettings: Partial<SettingsState> = {
participating: true,
fetchReadNotifications: false,
fetchAllNotifications: false,
};

await listNotificationsForAuthenticatedUser(
mockGitHubCloudAccount,
mockSettings as SettingsState,
);

expect(axios).toHaveBeenCalledWith({
url: 'https://api.github.com/notifications?participating=true&all=false',
headers: mockNonCachedAuthHeaders,
method: 'GET',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'GET',
'https://api.github.com/notifications?participating=true&all=false',
mockGitHubCloudAccount.token,
{},
false,
);
});

it('should list participating and watching notifications for user', async () => {
const mockSettings: Partial<SettingsState> = {
participating: false,
fetchReadNotifications: false,
fetchAllNotifications: false,
};

await listNotificationsForAuthenticatedUser(
mockGitHubCloudAccount,
mockSettings as SettingsState,
);

expect(axios).toHaveBeenCalledWith({
url: 'https://api.github.com/notifications?participating=false&all=false',
headers: mockNonCachedAuthHeaders,
method: 'GET',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'GET',
'https://api.github.com/notifications?participating=false&all=false',
mockGitHubCloudAccount.token,
{},
false,
);
});

it('should include all=true when fetchReadNotifications is enabled', async () => {
it('should list read and done notifications for user', async () => {
const mockSettings: Partial<SettingsState> = {
participating: false,
fetchReadNotifications: true,
fetchAllNotifications: false,
};

await listNotificationsForAuthenticatedUser(
mockGitHubCloudAccount,
mockSettings as SettingsState,
);

expect(axios).toHaveBeenCalledWith({
url: 'https://api.github.com/notifications?participating=false&all=true',
headers: mockNonCachedAuthHeaders,
method: 'GET',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'GET',
'https://api.github.com/notifications?participating=false&all=true',
mockGitHubCloudAccount.token,
{},
false,
);
});

it('should include all=false when fetchReadNotifications is disabled', async () => {
it('should unpaginate notifications list for user', async () => {
performAuthenticatedRESTRequestSpy.mockImplementation();

const mockSettings: Partial<SettingsState> = {
participating: false,
fetchReadNotifications: false,
fetchAllNotifications: true,
};

await listNotificationsForAuthenticatedUser(
mockGitHubCloudAccount,
mockSettings as SettingsState,
);

expect(axios).toHaveBeenCalledWith({
url: 'https://api.github.com/notifications?participating=false&all=false',
headers: mockNonCachedAuthHeaders,
method: 'GET',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'GET',
'https://api.github.com/notifications?participating=false&all=false',
mockGitHubCloudAccount.token,
{},
true,
);
});
});

Expand All @@ -148,12 +155,12 @@ describe('renderer/utils/api/client.ts', () => {
mockToken,
);

expect(axios).toHaveBeenCalledWith({
url: `https://api.github.com/notifications/threads/${mockThreadId}`,
headers: mockAuthHeaders,
method: 'PATCH',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'PATCH',
`https://api.github.com/notifications/threads/${mockThreadId}`,
mockToken,
{},
);
});

it('markNotificationThreadAsDone - should mark notification thread as done', async () => {
Expand All @@ -163,12 +170,12 @@ describe('renderer/utils/api/client.ts', () => {
mockToken,
);

expect(axios).toHaveBeenCalledWith({
url: `https://api.github.com/notifications/threads/${mockThreadId}`,
headers: mockAuthHeaders,
method: 'DELETE',
data: {},
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'DELETE',
`https://api.github.com/notifications/threads/${mockThreadId}`,
mockToken,
{},
);
});

it('ignoreNotificationThreadSubscription - should ignore notification thread subscription', async () => {
Expand All @@ -178,54 +185,25 @@ describe('renderer/utils/api/client.ts', () => {
mockToken,
);

expect(axios).toHaveBeenCalledWith({
url: `https://api.github.com/notifications/threads/${mockThreadId}/subscription`,
headers: mockAuthHeaders,
method: 'PUT',
data: { ignored: true },
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'PUT',
`https://api.github.com/notifications/threads/${mockThreadId}/subscription`,
mockToken,
{ ignored: true },
);
});

describe('getHtmlUrl', () => {
it('should return the HTML URL', async () => {
const apiRequestAuthSpy = jest.spyOn(apiRequests, 'apiRequestAuth');

const requestPromise = Promise.resolve({
data: {
html_url:
'https://github.com/gitify-app/notifications-test/issues/785',
},
} as AxiosResponse) as AxiosPromise;

apiRequestAuthSpy.mockResolvedValue(requestPromise);

const result = await getHtmlUrl(
'https://api.github.com/repos/gitify-app/notifications-test/issues/785' as Link,
'123' as Token,
);
expect(result).toBe(
'https://github.com/gitify-app/notifications-test/issues/785',
);
});

it('should handle error', async () => {
const rendererLogErrorSpy = jest
.spyOn(logger, 'rendererLogError')
.mockImplementation();

const apiRequestAuthSpy = jest.spyOn(apiRequests, 'apiRequestAuth');

const mockError = new Error('Test error');

apiRequestAuthSpy.mockRejectedValue(mockError);

await getHtmlUrl(
'https://api.github.com/repos/gitify-app/gitify/issues/785' as Link,
'123' as Token,
);
it('getHtmlUrl - should return the HTML URL', async () => {
await getHtmlUrl(
'https://api.github.com/repos/gitify-app/notifications-test/issues/785' as Link,
'123' as Token,
);

expect(rendererLogErrorSpy).toHaveBeenCalledTimes(1);
});
expect(performAuthenticatedRESTRequestSpy).toHaveBeenCalledWith(
'GET',
'https://api.github.com/repos/gitify-app/notifications-test/issues/785',
'123',
);
});

it('fetchAuthenticatedUserDetails calls performGraphQLRequest with correct args', async () => {
Expand All @@ -237,7 +215,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<FetchAuthenticatedUserDetailsQuery>);
} as GitHubGraphQLResponse<FetchAuthenticatedUserDetailsQuery>);

await fetchAuthenticatedUserDetails(mockGitHubHostname, mockToken);

Expand All @@ -263,7 +241,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<FetchDiscussionByNumberQuery>);
} as GitHubGraphQLResponse<FetchDiscussionByNumberQuery>);

await fetchDiscussionByNumber(mockNotification);

Expand Down Expand Up @@ -298,7 +276,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<FetchIssueByNumberQuery>);
} as GitHubGraphQLResponse<FetchIssueByNumberQuery>);

await fetchIssueByNumber(mockNotification);

Expand Down Expand Up @@ -331,7 +309,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<FetchPullRequestByNumberQuery>);
} as GitHubGraphQLResponse<FetchPullRequestByNumberQuery>);

await fetchPullByNumber(mockNotification);

Expand Down Expand Up @@ -367,7 +345,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestStringSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<unknown>);
} as GitHubGraphQLResponse<unknown>);

await fetchNotificationDetailsForList([mockNotification]);

Expand All @@ -383,7 +361,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestStringSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<unknown>);
} as GitHubGraphQLResponse<unknown>);

await fetchNotificationDetailsForList([]);

Expand All @@ -399,7 +377,7 @@ describe('renderer/utils/api/client.ts', () => {
performGraphQLRequestStringSpy.mockResolvedValue({
data: {},
headers: {},
} as ExecutionResultWithHeaders<unknown>);
} as GitHubGraphQLResponse<unknown>);

await fetchNotificationDetailsForList(mockGitHubCloudGitifyNotifications);

Expand Down
Loading
Loading