feat: public_repo alternate scopes (#1831)

gitify-app · Feb 13, 2025 · e04c9fe · e04c9fe
1 parent 1c8c17b
commit e04c9fe
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 32 deletions.
diff --git a/src/renderer/routes/Accounts.tsx b/src/renderer/routes/Accounts.tsx
@@ -31,7 +31,8 @@ import { Header } from '../components/primitives/Header';
 import { AppContext } from '../context/App';
 import { type Account, Size } from '../types';
 import {
-  formatRequiredScopes,
+  formatAlternateOAuthScopes,
+  formatRecommendedOAuthScopes,
   getAccountUUID,
   refreshAccount,
 } from '../utils/auth/utils';
@@ -194,8 +195,8 @@ export const AccountsRoute: FC = () => {
                   <Stack direction="horizontal" gap="condensed">
                     <IconButton
                       icon={AlertFillIcon}
-                      aria-label={`This account is missing one or more required scopes: [${formatRequiredScopes()}]`}
-                      variant="danger"
+                      aria-label={`This account is missing one or more required scopes: [${formatRecommendedOAuthScopes()}] or [${formatAlternateOAuthScopes()}]`}
+                      style={{ color: 'orange' }}
                       onClick={() => openDeveloperSettings(account)}
                       size="small"
                       data-testid="account-missing-scopes"

diff --git a/src/renderer/routes/LoginWithPersonalAccessToken.tsx b/src/renderer/routes/LoginWithPersonalAccessToken.tsx
@@ -27,7 +27,7 @@ import { AppContext } from '../context/App';
 import type { Hostname, Token } from '../types';
 import type { LoginPersonalAccessTokenOptions } from '../utils/auth/types';
 import {
-  formatRequiredScopes,
+  formatRecommendedOAuthScopes,
   getNewTokenURL,
   isValidHostname,
   isValidToken,
@@ -192,7 +192,7 @@ export const LoginWithPersonalAccessTokenRoute: FC = () => {
 
             <Text as="i" className="text-xs">
               The{' '}
-              <Tooltip text={formatRequiredScopes()} direction="se">
+              <Tooltip text={formatRecommendedOAuthScopes()} direction="se">
                 <Text as="u">required scopes</Text>
               </Tooltip>{' '}
               will be automatically selected for you.

diff --git a/src/renderer/routes/__snapshots__/Accounts.test.tsx.snap b/src/renderer/routes/__snapshots__/Accounts.test.tsx.snap
diff --git a/src/renderer/utils/auth/utils.ts b/src/renderer/utils/auth/utils.ts
@@ -30,7 +30,10 @@ export function authGitHub(
     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());
+    authUrl.searchParams.append(
+      'scope',
+      Constants.OAUTH_SCOPES.RECOMMENDED.toString(),
+    );
 
     openExternalLink(authUrl.toString() as Link);
 
@@ -175,9 +178,13 @@ export async function refreshAccount(account: Account): Promise<Account> {
       ?.split(',')
       .map((scope: string) => scope.trim());
 
-    account.hasRequiredScopes = Constants.AUTH_SCOPE.every((scope) =>
-      accountScopes.includes(scope),
-    );
+    account.hasRequiredScopes =
+      Constants.OAUTH_SCOPES.RECOMMENDED.every((scope) =>
+        accountScopes.includes(scope),
+      ) ||
+      Constants.OAUTH_SCOPES.ALTERNATE.every((scope) =>
+        accountScopes.includes(scope),
+      );
 
     if (!account.hasRequiredScopes) {
       logWarn(
@@ -232,7 +239,10 @@ export function getNewTokenURL(hostname: Hostname): Link {
     'description',
     `${APPLICATION.NAME} (Created on ${date})`,
   );
-  newTokenURL.searchParams.append('scopes', Constants.AUTH_SCOPE.join(','));
+  newTokenURL.searchParams.append(
+    'scopes',
+    Constants.OAUTH_SCOPES.RECOMMENDED.join(','),
+  );
 
   return newTokenURL.toString() as Link;
 }
@@ -282,6 +292,10 @@ export function hasMultipleAccounts(auth: AuthState) {
   return auth.accounts.length > 1;
 }
 
-export function formatRequiredScopes() {
-  return Constants.AUTH_SCOPE.join(', ');
+export function formatRecommendedOAuthScopes() {
+  return Constants.OAUTH_SCOPES.RECOMMENDED.join(', ');
+}
+
+export function formatAlternateOAuthScopes() {
+  return Constants.OAUTH_SCOPES.ALTERNATE.join(', ');
 }
diff --git a/src/renderer/utils/constants.ts b/src/renderer/utils/constants.ts
@@ -8,8 +8,11 @@ export const Constants = {
 
   NOTIFICATION_SOUND: 'clearly.mp3',
 
-  // GitHub OAuth
-  AUTH_SCOPE: ['read:user', 'notifications', 'repo'],
+  // GitHub OAuth Scopes
+  OAUTH_SCOPES: {
+    RECOMMENDED: ['read:user', 'notifications', 'repo'],
+    ALTERNATE: ['read:user', 'notifications', 'public_repo'],
+  },
 
   DEFAULT_AUTH_OPTIONS: {
     hostname: 'github.com' as Hostname,