refactor(auth): migrate to octokit/oauth-method library

Signed-off-by: Adam Setch <adam.setch@outlook.com>

Author: setchy

src/renderer/context/App.tsx

@@ -410,9 +410,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
    * authenticates via a predefined "Gitify" GitHub OAuth App.
    */
   const loginWithGitHubApp = useCallback(async () => {
-    const { authCode } = await performGitHubOAuth(
-      Constants.DEFAULT_AUTH_OPTIONS,
-    );
+    const { authCode } = await performGitHubOAuth();
     const token = await exchangeAuthCodeForAccessToken(authCode);
     const hostname = Constants.DEFAULT_AUTH_OPTIONS.hostname;
 

src/renderer/utils/auth/utils.test.ts

@@ -20,12 +20,17 @@ import type { AuthMethod } from './types';
 import * as authUtils from './utils';
 import { getNewOAuthAppURL, getNewTokenURL } from './utils';
 
-const exchangeWebFlowCodeMock = jest.fn();
 jest.mock('@octokit/oauth-methods', () => ({
   ...jest.requireActual('@octokit/oauth-methods'),
-  exchangeWebFlowCode: () => exchangeWebFlowCodeMock,
+  exchangeWebFlowCode: jest.fn(),
 }));
 
+import { exchangeWebFlowCode } from '@octokit/oauth-methods';
+
+const exchangeWebFlowCodeMock = exchangeWebFlowCode as jest.MockedFunction<
+  typeof exchangeWebFlowCode
+>;
+
 describe('renderer/utils/auth/utils.ts', () => {
   describe('authGitHub', () => {
     jest.spyOn(logger, 'rendererLogInfo').mockImplementation();
@@ -44,9 +49,7 @@ describe('renderer/utils/auth/utils.ts', () => {
           callback('gitify://auth?code=123-456');
         });
 
-      const res = await authUtils.performGitHubOAuth(
-        Constants.DEFAULT_AUTH_OPTIONS,
-      );
+      const res = await authUtils.performGitHubOAuth();
 
       expect(openExternalLinkSpy).toHaveBeenCalledTimes(1);
       expect(openExternalLinkSpy).toHaveBeenCalledWith(
@@ -103,8 +106,7 @@ describe('renderer/utils/auth/utils.ts', () => {
         });
 
       await expect(
-        async () =>
-          await authUtils.performGitHubOAuth(Constants.DEFAULT_AUTH_OPTIONS),
+        async () => await authUtils.performGitHubOAuth(),
       ).rejects.toEqual(
         new Error(
           "Oops! Something went wrong and we couldn't log you in using GitHub. Please try again. Reason: The redirect_uri is missing or invalid. Docs: https://docs.github.com/en/developers/apps/troubleshooting-oauth-errors",
@@ -133,15 +135,19 @@ describe('renderer/utils/auth/utils.ts', () => {
         authentication: {
           token: 'this-is-a-token',
         },
-      });
+      } as any);
 
-      const res = await authUtils.exchangeAuthCodeForAccessToken(authCode);
+      const res = await authUtils.exchangeAuthCodeForAccessToken(
+        authCode,
+        Constants.DEFAULT_AUTH_OPTIONS,
+      );
 
       expect(exchangeWebFlowCodeMock).toHaveBeenCalledWith({
         clientType: 'oauth-app',
         clientId: 'FAKE_CLIENT_ID_123',
         clientSecret: 'FAKE_CLIENT_SECRET_123',
         code: '123-456',
+        request: expect.any(Function),
       });
       expect(res).toBe('this-is-a-token');
     });

src/renderer/utils/auth/utils.ts

@@ -26,7 +26,7 @@ import { rendererLogError, rendererLogInfo, rendererLogWarn } from '../logger';
 import type { AuthMethod, AuthResponse, LoginOAuthAppOptions } from './types';
 
 export function performGitHubOAuth(
-  authOptions: LoginOAuthAppOptions,
+  authOptions: LoginOAuthAppOptions = Constants.DEFAULT_AUTH_OPTIONS,
 ): Promise<AuthResponse> {
   return new Promise((resolve, reject) => {
     const { url } = getWebFlowAuthorizationUrl({
@@ -80,7 +80,7 @@ export function performGitHubOAuth(
 
 export async function exchangeAuthCodeForAccessToken(
   authCode: AuthCode,
-  authOptions = Constants.DEFAULT_AUTH_OPTIONS,
+  authOptions: LoginOAuthAppOptions = Constants.DEFAULT_AUTH_OPTIONS,
 ): Promise<Token> {
   const { authentication } = await exchangeWebFlowCode({
     clientType: 'oauth-app',