12870266872

Committed 20 Jan 2025 02:34PM UTC coverage: 87.063% (-0.2%) from 87.3%

Build # 12870266872

Build Type

push

github

Committed by

web-flow

Commit Message

feat: error tray icon (#1742)

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

Run Details

584 of 657 branches covered (88.89%)

Branch coverage included in aggregate %.

18 of 21 new or added lines in 3 files covered. (85.71%)

2 existing lines in 1 file now uncovered.

1657 of 1917 relevant lines covered (86.44%)

22.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.65

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

import { BrowserWindow } from '@electron/remote';
import { format } from 'date-fns';
import semver from 'semver';

import { APPLICATION } from '../../../shared/constants';
import { logError, logWarn } from '../../../shared/logger';
import type {
  Account,
  AuthCode,
  AuthState,
  ClientID,
  GitifyUser,
  Hostname,
  Link,
  Token,
} from '../../types';
import type { UserDetails } from '../../typesGitHub';
import { getAuthenticatedUser } from '../api/client';
import { apiRequest } from '../api/request';
import { Constants } from '../constants';
import { getPlatformFromHostname } from '../helpers';
import type { AuthMethod, AuthResponse, AuthTokenResponse } from './types';

// TODO - Refactor our OAuth2 flow to use system browser and local app gitify://callback - see #485 #561 #654
export function authGitHub(
  authOptions = Constants.DEFAULT_AUTH_OPTIONS,
): Promise<AuthResponse> {
  return new Promise((resolve, reject) => {
    // Build the OAuth consent page URL
    const authWindow = new BrowserWindow({
      width: 548,
      height: 736,
      show: true,
    });

    const authUrl = new URL(`https://${authOptions.hostname}`);
    authUrl.pathname = '/login/oauth/authorize';
    authUrl.searchParams.append('client_id', authOptions.clientId);
    authUrl.searchParams.append('scope', Constants.AUTH_SCOPE.toString());

    const session = authWindow.webContents.session;
    session.clearStorageData();

    authWindow.loadURL(authUrl.toString());

    const handleCallback = (url: Link) => {
      const raw_code = /code=([^&]*)/.exec(url) || null;
      const authCode =
        raw_code && raw_code.length > 1 ? (raw_code[1] as AuthCode) : null;
      const error = /\?error=(.+)$/.exec(url);
      if (authCode || error) {
        // Close the browser if code found or error
        authWindow.destroy();
      }
      // If there is a code, proceed to get token from github
      if (authCode) {
        resolve({ authCode, authOptions });
      } else if (error) {
        reject(
          "Oops! Something went wrong and we couldn't " +
            'log you in using GitHub. Please try again.',
        );
      }
    };

    // If "Done" button is pressed, hide "Loading"
    authWindow.on('close', () => {
      authWindow.destroy();
    });

    authWindow.webContents.on(
      'did-fail-load',
      (_event, _errorCode, _errorDescription, validatedURL) => {
        if (validatedURL.includes(authOptions.hostname)) {
          authWindow.destroy();
          reject(
            `Invalid Hostname. Could not load https://${authOptions.hostname}/.`,
          );
        }
      },
    );

    authWindow.webContents.on('will-redirect', (event, url) => {
      event.preventDefault();
      handleCallback(url as Link);
    });

    authWindow.webContents.on('will-navigate', (event, url) => {
      event.preventDefault();
      handleCallback(url as Link);
    });
  });
}

export async function getUserData(
  token: Token,
  hostname: Hostname,
): Promise<GitifyUser> {
  const response: UserDetails = (await getAuthenticatedUser(hostname, token))
    .data;

  return {
    id: response.id,
    login: response.login,
    name: response.name,
    avatar: response.avatar_url,
  };
}

export async function getToken(
  authCode: AuthCode,
  authOptions = Constants.DEFAULT_AUTH_OPTIONS,
): Promise<AuthTokenResponse> {
  const url =
    `https://${authOptions.hostname}/login/oauth/access_token` as Link;
  const data = {
    client_id: authOptions.clientId,
    client_secret: authOptions.clientSecret,
    code: authCode,
  };

  const response = await apiRequest(url, 'POST', data);
  return {
    hostname: authOptions.hostname,
    token: response.data.access_token,
  };
}

export async function addAccount(
  auth: AuthState,
  method: AuthMethod,
  token: Token,
  hostname: Hostname,
): Promise<AuthState> {
  let newAccount = {
    hostname: hostname,
    method: method,
    platform: getPlatformFromHostname(hostname),
    token: token,
  } as Account;

  newAccount = await refreshAccount(newAccount);

  return {
    accounts: [...auth.accounts, newAccount],
  };
}

export function removeAccount(auth: AuthState, account: Account): AuthState {
  const updatedAccounts = auth.accounts.filter(
    (a) => a.token !== account.token,
  );

  return {
    accounts: updatedAccounts,
  };
}

export async function refreshAccount(account: Account): Promise<Account> {
  try {
    const res = await getAuthenticatedUser(account.hostname, account.token);

    // Refresh user data
    account.user = {
      id: res.data.id,
      login: res.data.login,
      name: res.data.name,
      avatar: res.data.avatar_url,
    };

    account.version = extractHostVersion(
      res.headers['x-github-enterprise-version'],
    );

    const accountScopes = res.headers['x-oauth-scopes']
      ?.split(',')
      .map((scope: string) => scope.trim());

    account.hasRequiredScopes = Constants.AUTH_SCOPE.every((scope) =>
      accountScopes.includes(scope),
    );

    if (!account.hasRequiredScopes) {
      logWarn(
        'refreshAccount',
        `account for user ${account.user.login} is missing required scopes`,
      );
    }
  } catch (err) {
    logError(
      'refreshAccount',
      `failed to refresh account for user ${account.user.login}`,
      err,
    );
  }

  return account;
}

export function extractHostVersion(version: string | null): string {
  if (version) {
    return semver.valid(semver.coerce(version));
  }

  return 'latest';
}

export function getDeveloperSettingsURL(account: Account): Link {
  const settingsURL = new URL(`https://${account.hostname}`);

  switch (account.method) {
    case 'GitHub App':
      settingsURL.pathname =
        '/settings/connections/applications/27a352516d3341cee376';
      break;
    case 'OAuth App':
      settingsURL.pathname = '/settings/developers';
      break;
    case 'Personal Access Token':
      settingsURL.pathname = '/settings/tokens';
      break;
    default:
      settingsURL.pathname = '/settings';
      break;
  }
  return settingsURL.toString() as Link;
}

export function getNewTokenURL(hostname: Hostname): Link {
  const date = format(new Date(), 'PP p');
  const newTokenURL = new URL(`https://${hostname}/settings/tokens/new`);
  newTokenURL.searchParams.append(
    'description',
    `${APPLICATION.NAME} (Created on ${date})`,
  );
  newTokenURL.searchParams.append('scopes', Constants.AUTH_SCOPE.join(','));

  return newTokenURL.toString() as Link;
}

export function getNewOAuthAppURL(hostname: Hostname): Link {
  const date = format(new Date(), 'PP p');
  const newOAuthAppURL = new URL(
    `https://${hostname}/settings/applications/new`,
  );
  newOAuthAppURL.searchParams.append(
    'oauth_application[name]',
    `${APPLICATION.NAME} (Created on ${date})`,
  );
  newOAuthAppURL.searchParams.append(
    'oauth_application[url]',
    'https://www.gitify.io',
  );
  newOAuthAppURL.searchParams.append(
    'oauth_application[callback_url]',
    'https://www.gitify.io/callback',
  );

  return newOAuthAppURL.toString() as Link;
}

export function isValidHostname(hostname: Hostname) {
  return /^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}$/i.test(
    hostname,
  );
}

export function isValidClientId(clientId: ClientID) {
  return /^[A-Z0-9_]{20}$/i.test(clientId);
}

export function isValidToken(token: Token) {
  return /^[A-Z0-9_]{40}$/i.test(token);
}

export function getAccountUUID(account: Account): string {
  return btoa(`${account.hostname}-${account.user.id}-${account.method}`);
}

export function hasAccounts(auth: AuthState) {
  return auth.accounts.length > 0;
}

export function hasMultipleAccounts(auth: AuthState) {
  return auth.accounts.length > 1;
}

1	import { BrowserWindow } from '@electron/remote';	64✔
2	import { format } from 'date-fns';	64✔
3	import semver from 'semver';	64✔
4
5	import { APPLICATION } from '../../../shared/constants';	64✔
6	import { logError, logWarn } from '../../../shared/logger';	64✔
7	import type {
8	Account,
9	AuthCode,
10	AuthState,
11	ClientID,
12	GitifyUser,
13	Hostname,
14	Link,
15	Token,
16	} from '../../types';
17	import type { UserDetails } from '../../typesGitHub';
18	import { getAuthenticatedUser } from '../api/client';	64✔
19	import { apiRequest } from '../api/request';	64✔
20	import { Constants } from '../constants';	64✔
21	import { getPlatformFromHostname } from '../helpers';	64✔
22	import type { AuthMethod, AuthResponse, AuthTokenResponse } from './types';
23
24	// TODO - Refactor our OAuth2 flow to use system browser and local app gitify://callback - see #485 #561 #654
25	export function authGitHub(	64✔
26	authOptions = Constants.DEFAULT_AUTH_OPTIONS,	2✔
27	): Promise<AuthResponse> {
28	return new Promise((resolve, reject) => {	4✔
29	// Build the OAuth consent page URL
30	const authWindow = new BrowserWindow({	4✔
31	width: 548,
32	height: 736,
33	show: true,
34	});
35
36	const authUrl = new URL(`https://${authOptions.hostname}`);	4✔
37	authUrl.pathname = '/login/oauth/authorize';	4✔
38	authUrl.searchParams.append('client_id', authOptions.clientId);	4✔
39	authUrl.searchParams.append('scope', Constants.AUTH_SCOPE.toString());	4✔
40
41	const session = authWindow.webContents.session;	4✔
42	session.clearStorageData();	4✔
43
44	authWindow.loadURL(authUrl.toString());	4✔
45
46	const handleCallback = (url: Link) => {	4✔
47	const raw_code = /code=([^&]*)/.exec(url) \|\| null;	4✔
48	const authCode =
49	raw_code && raw_code.length > 1 ? (raw_code[1] as AuthCode) : null;	4✔
50	const error = /\?error=(.+)$/.exec(url);	4✔
51	if (authCode \|\| error) {	4✔
52	// Close the browser if code found or error
53	authWindow.destroy();	4✔
54	}
55	// If there is a code, proceed to get token from github
56	if (authCode) {	4✔
57	resolve({ authCode, authOptions });	2✔
58	} else if (error) {	2✔
59	reject(	2✔
60	"Oops! Something went wrong and we couldn't " +
61	'log you in using GitHub. Please try again.',
62	);
63	}
64	};
65
66	// If "Done" button is pressed, hide "Loading"
67	authWindow.on('close', () => {	4✔
68	authWindow.destroy();	×
69	});
70
71	authWindow.webContents.on(	4✔
72	'did-fail-load',
73	(_event, _errorCode, _errorDescription, validatedURL) => {
74	if (validatedURL.includes(authOptions.hostname)) {	×
75	authWindow.destroy();	×
76	reject(	×
77	`Invalid Hostname. Could not load https://${authOptions.hostname}/.`,
78	);
79	}
80	},
81	);
82
83	authWindow.webContents.on('will-redirect', (event, url) => {	4✔
84	event.preventDefault();	4✔
85	handleCallback(url as Link);	4✔
86	});
87
88	authWindow.webContents.on('will-navigate', (event, url) => {	4✔
89	event.preventDefault();	×
90	handleCallback(url as Link);	×
91	});
92	});
93	}
94
95	export async function getUserData(	64✔
96	token: Token,
97	hostname: Hostname,
98	): Promise<GitifyUser> {
99	const response: UserDetails = (await getAuthenticatedUser(hostname, token))	10✔
100	.data;
101
102	return {	10✔
103	id: response.id,
104	login: response.login,
105	name: response.name,
106	avatar: response.avatar_url,
107	};
108	}
109
110	export async function getToken(	64✔
111	authCode: AuthCode,
112	authOptions = Constants.DEFAULT_AUTH_OPTIONS,	2✔
113	): Promise<AuthTokenResponse> {
114	const url =
115	`https://${authOptions.hostname}/login/oauth/access_token` as Link;	4✔
116	const data = {	4✔
117	client_id: authOptions.clientId,
118	client_secret: authOptions.clientSecret,
119	code: authCode,
120	};
121
122	const response = await apiRequest(url, 'POST', data);	4✔
123	return {	2✔
124	hostname: authOptions.hostname,
125	token: response.data.access_token,
126	};
127	}
128
129	export async function addAccount(	64✔
130	auth: AuthState,
131	method: AuthMethod,
132	token: Token,
133	hostname: Hostname,
134	): Promise<AuthState> {
135	let newAccount = {	10✔
136	hostname: hostname,
137	method: method,
138	platform: getPlatformFromHostname(hostname),
139	token: token,
140	} as Account;
141
142	newAccount = await refreshAccount(newAccount);	10✔
143
144	return {	8✔
145	accounts: [...auth.accounts, newAccount],
146	};
147	}
148
149	export function removeAccount(auth: AuthState, account: Account): AuthState {	64✔
150	const updatedAccounts = auth.accounts.filter(	4✔
151	(a) => a.token !== account.token,	8✔
152	);
153
154	return {	4✔
155	accounts: updatedAccounts,
156	};
157	}
158
159	export async function refreshAccount(account: Account): Promise<Account> {	64✔
160	try {	12✔
161	const res = await getAuthenticatedUser(account.hostname, account.token);	12✔
162
163	// Refresh user data
164	account.user = {	8✔
165	id: res.data.id,
166	login: res.data.login,
167	name: res.data.name,
168	avatar: res.data.avatar_url,
169	};
170
171	account.version = extractHostVersion(	8✔
172	res.headers['x-github-enterprise-version'],
173	);
174
175	const accountScopes = res.headers['x-oauth-scopes']	8✔
176	?.split(',')
177	.map((scope: string) => scope.trim());	×
178
179	account.hasRequiredScopes = Constants.AUTH_SCOPE.every((scope) =>	8✔
180	accountScopes.includes(scope),	8✔
181	);
182
UNCOV 183	if (!account.hasRequiredScopes) {	×
UNCOV 184	logWarn(	×
185	'refreshAccount',
186	`account for user ${account.user.login} is missing required scopes`,
187	);
188	}
189	} catch (err) {
190	logError(	10✔
191	'refreshAccount',
192	`failed to refresh account for user ${account.user.login}`,
193	err,
194	);
195	}
196
197	return account;	10✔
198	}
199
200	export function extractHostVersion(version: string \| null): string {	64✔
201	if (version) {	28✔
202	return semver.valid(semver.coerce(version));	22✔
203	}
204
205	return 'latest';	6✔
206	}
207
208	export function getDeveloperSettingsURL(account: Account): Link {	64✔
209	const settingsURL = new URL(`https://${account.hostname}`);	12✔
210
211	switch (account.method) {	12✔
212	case 'GitHub App':
213	settingsURL.pathname =	2✔
214	'/settings/connections/applications/27a352516d3341cee376';
215	break;	2✔
216	case 'OAuth App':
217	settingsURL.pathname = '/settings/developers';	2✔
218	break;	2✔
219	case 'Personal Access Token':
220	settingsURL.pathname = '/settings/tokens';	6✔
221	break;	6✔
222	default:
223	settingsURL.pathname = '/settings';	2✔
224	break;	2✔
225	}
226	return settingsURL.toString() as Link;	12✔
227	}
228
229	export function getNewTokenURL(hostname: Hostname): Link {	64✔
230	const date = format(new Date(), 'PP p');	6✔
231	const newTokenURL = new URL(`https://${hostname}/settings/tokens/new`);	6✔
232	newTokenURL.searchParams.append(	6✔
233	'description',
234	`${APPLICATION.NAME} (Created on ${date})`,
235	);
236	newTokenURL.searchParams.append('scopes', Constants.AUTH_SCOPE.join(','));	6✔
237
238	return newTokenURL.toString() as Link;	6✔
239	}
240
241	export function getNewOAuthAppURL(hostname: Hostname): Link {	64✔
242	const date = format(new Date(), 'PP p');	6✔
243	const newOAuthAppURL = new URL(	6✔
244	`https://${hostname}/settings/applications/new`,
245	);
246	newOAuthAppURL.searchParams.append(	6✔
247	'oauth_application[name]',
248	`${APPLICATION.NAME} (Created on ${date})`,
249	);
250	newOAuthAppURL.searchParams.append(	6✔
251	'oauth_application[url]',
252	'https://www.gitify.io',
253	);
254	newOAuthAppURL.searchParams.append(	6✔
255	'oauth_application[callback_url]',
256	'https://www.gitify.io/callback',
257	);
258
259	return newOAuthAppURL.toString() as Link;	6✔
260	}
261
262	export function isValidHostname(hostname: Hostname) {	64✔
263	return /^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}$/i.test(	56✔
264	hostname,
265	);
266	}
267
268	export function isValidClientId(clientId: ClientID) {	64✔
269	return /^[A-Z0-9_]{20}$/i.test(clientId);	20✔
270	}
271
272	export function isValidToken(token: Token) {	64✔
273	return /^[A-Z0-9_]{40}$/i.test(token);	26✔
274	}
275
276	export function getAccountUUID(account: Account): string {	64✔
277	return btoa(`${account.hostname}-${account.user.id}-${account.method}`);	54✔
278	}
279
280	export function hasAccounts(auth: AuthState) {	64✔
281	return auth.accounts.length > 0;	24✔
282	}
283
284	export function hasMultipleAccounts(auth: AuthState) {	64✔
285	return auth.accounts.length > 1;	82✔
286	}

gitify-app / gitify / 12870266872

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous