feat: device code flow

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

Author: setchy

src/renderer/__mocks__/account-mocks.ts

@@ -14,7 +14,7 @@ export const mockGitHubAppAccount: Account = {
   platform: 'GitHub Cloud',
   method: 'GitHub App',
   token: 'token-987654321' as Token,
-  hostname: Constants.OAUTH_DEVICE_FLOW.hostname,
+  hostname: Constants.GITHUB_HOSTNAME,
   user: mockGitifyUser,
   hasRequiredScopes: true,
 };
@@ -23,7 +23,7 @@ export const mockPersonalAccessTokenAccount: Account = {
   platform: 'GitHub Cloud',
   method: 'Personal Access Token',
   token: 'token-123-456' as Token,
-  hostname: 'github.com' as Hostname,
+  hostname: Constants.GITHUB_HOSTNAME,
   user: mockGitifyUser,
   hasRequiredScopes: true,
 };
@@ -41,7 +41,7 @@ export const mockGitHubCloudAccount: Account = {
   platform: 'GitHub Cloud',
   method: 'Personal Access Token',
   token: 'token-123-456' as Token,
-  hostname: 'github.com' as Hostname,
+  hostname: Constants.GITHUB_HOSTNAME,
   user: mockGitifyUser,
   version: 'latest',
   hasRequiredScopes: true,

src/renderer/constants.ts

@@ -1,5 +1,4 @@
 import type { ClientID, Hostname, Link } from './types';
-import type { LoginOAuthDeviceOptions } from './utils/auth/types';
 
 export const Constants = {
   STORAGE_KEY: 'gitify-storage',
@@ -10,10 +9,9 @@ export const Constants = {
     ALTERNATE: ['read:user', 'notifications', 'public_repo'],
   },
 
-  OAUTH_DEVICE_FLOW: {
-    hostname: 'github.com' as Hostname,
-    clientId: process.env.OAUTH_CLIENT_ID as ClientID,
-  } satisfies LoginOAuthDeviceOptions,
+  GITHUB_HOSTNAME: 'github.com' as Hostname,
+
+  OAUTH_DEVICE_FLOW_CLIENT_ID: process.env.OAUTH_CLIENT_ID as ClientID,
 
   // GitHub Enterprise Cloud with Data Residency uses *.ghe.com domains
   GITHUB_ENTERPRISE_CLOUD_DATA_RESIDENCY_HOSTNAME: 'ghe.com',

src/renderer/context/App.test.tsx

@@ -14,7 +14,6 @@ import type {
   AuthState,
   ClientID,
   ClientSecret,
-  Hostname,
   SettingsState,
   Token,
 } from '../types';
@@ -324,7 +323,7 @@ describe('renderer/context/App.tsx', () => {
       act(() => {
         getContext().loginWithDeviceFlowComplete(
           'token' as Token,
-          'github.com' as Hostname,
+          Constants.GITHUB_HOSTNAME,
         );
       });
 
@@ -348,7 +347,7 @@ describe('renderer/context/App.tsx', () => {
         getContext().loginWithOAuthApp({
           clientId: 'id' as ClientID,
           clientSecret: 'secret' as ClientSecret,
-          hostname: 'github.com' as Hostname,
+          hostname: Constants.GITHUB_HOSTNAME,
         });
       });
 

src/renderer/context/App.tsx

@@ -85,7 +85,7 @@ export interface AppContextState {
   ) => Promise<Token | null>;
   loginWithDeviceFlowComplete: (
     token: Token,
-    hostname?: Hostname,
+    hostname: Hostname,
   ) => Promise<void>;
   loginWithOAuthApp: (data: LoginOAuthWebOptions) => Promise<void>;
   loginWithPersonalAccessToken: (
@@ -433,10 +433,7 @@ export const AppProvider = ({ children }: { children: ReactNode }) => {
    * Finalize device flow session.
    */
   const loginWithDeviceFlowComplete = useCallback(
-    async (
-      token: Token,
-      hostname: Hostname = Constants.OAUTH_DEVICE_FLOW.hostname,
-    ) => {
+    async (token: Token, hostname: Hostname) => {
       const updatedAuth = await addAccount(auth, 'GitHub App', token, hostname);
 
       persistAuth(updatedAuth);

src/renderer/routes/LoginWithOAuthApp.tsx

@@ -85,7 +85,7 @@ export const LoginWithOAuthAppRoute: FC = () => {
   const [isVerifyingCredentials, setIsVerifyingCredentials] = useState(false);
 
   const [formData, setFormData] = useState({
-    hostname: 'github.com' as Hostname,
+    hostname: Constants.GITHUB_HOSTNAME,
     clientId: '' as ClientID,
     clientSecret: '' as ClientSecret,
   } as IFormData);

src/renderer/routes/LoginWithPersonalAccessToken.tsx

@@ -78,7 +78,7 @@ export const LoginWithPersonalAccessTokenRoute: FC = () => {
   const [isVerifyingCredentials, setIsVerifyingCredentials] = useState(false);
 
   const [formData, setFormData] = useState({
-    hostname: 'github.com' as Hostname,
+    hostname: Constants.GITHUB_HOSTNAME,
     token: '' as Token,
   } as IFormData);
 

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

@@ -1,11 +1,13 @@
+import { Constants } from '../../constants';
+
 import type { Hostname } from '../../types';
 
 import { getGitHubAPIBaseUrl } from './utils';
 
 describe('renderer/utils/api/utils.ts', () => {
   describe('getGitHubAPIBaseUrl', () => {
     it('should generate a GitHub REST API url - non enterprise', () => {
-      const result = getGitHubAPIBaseUrl('github.com' as Hostname, 'rest');
+      const result = getGitHubAPIBaseUrl(Constants.GITHUB_HOSTNAME, 'rest');
 
       expect(result.toString()).toBe('https://api.github.com/');
     });
@@ -27,7 +29,7 @@ describe('renderer/utils/api/utils.ts', () => {
   });
 
   it('should generate a GitHub GraphQL url - non enterprise', () => {
-    const result = getGitHubAPIBaseUrl('github.com' as Hostname, 'graphql');
+    const result = getGitHubAPIBaseUrl(Constants.GITHUB_HOSTNAME, 'graphql');
 
     expect(result.toString()).toBe('https://api.github.com/');
   });

src/renderer/utils/auth/types.ts

@@ -13,11 +13,6 @@ export type PlatformType =
   | 'GitHub Enterprise Server'
   | 'GitHub Enterprise Cloud with Data Residency';
 
-export interface LoginOAuthDeviceOptions {
-  hostname: Hostname;
-  clientId: ClientID;
-}
-
 export interface LoginOAuthWebOptions {
   hostname: Hostname;
   clientId: ClientID;

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

@@ -557,7 +557,7 @@ describe('renderer/utils/auth/utils.ts', () => {
 
     it('should use default hostname if no accounts', () => {
       expect(authUtils.getPrimaryAccountHostname({ accounts: [] })).toBe(
-        Constants.OAUTH_DEVICE_FLOW.hostname,
+        Constants.GITHUB_HOSTNAME,
       );
     });
   });

src/renderer/utils/auth/utils.ts

@@ -29,7 +29,6 @@ import type {
   AuthResponse,
   DeviceFlowErrorResponse,
   DeviceFlowSession,
-  LoginOAuthDeviceOptions,
   LoginOAuthWebOptions,
 } from './types';
 
@@ -88,21 +87,19 @@ export function performGitHubWebOAuth(
   });
 }
 
-export async function startGitHubDeviceFlow(
-  authOptions: LoginOAuthDeviceOptions = Constants.OAUTH_DEVICE_FLOW,
-): Promise<DeviceFlowSession> {
+export async function startGitHubDeviceFlow(): Promise<DeviceFlowSession> {
   const deviceCode = await createDeviceCode({
     clientType: 'oauth-app' as const,
-    clientId: authOptions.clientId,
+    clientId: Constants.OAUTH_DEVICE_FLOW_CLIENT_ID,
     scopes: Constants.OAUTH_SCOPES.RECOMMENDED,
     request: request.defaults({
-      baseUrl: getGitHubAuthBaseUrl(authOptions.hostname).toString(),
+      baseUrl: getGitHubAuthBaseUrl(Constants.GITHUB_HOSTNAME).toString(),
     }),
   });
 
   return {
-    hostname: authOptions.hostname,
-    clientId: authOptions.clientId,
+    hostname: Constants.GITHUB_HOSTNAME,
+    clientId: Constants.OAUTH_DEVICE_FLOW_CLIENT_ID,
     deviceCode: deviceCode.data.device_code,
     userCode: deviceCode.data.user_code,
     verificationUri: deviceCode.data.verification_uri,
@@ -391,7 +388,7 @@ export function getAccountUUID(account: Account): AccountUUID {
  *  Return the primary (first) account hostname
  */
 export function getPrimaryAccountHostname(auth: AuthState) {
-  return auth.accounts[0]?.hostname ?? Constants.OAUTH_DEVICE_FLOW.hostname;
+  return auth.accounts[0]?.hostname ?? Constants.GITHUB_HOSTNAME;
 }
 
 export function hasAccounts(auth: AuthState) {