Merge branch 'main' into feat/octokit-types

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

package.json

@@ -88,7 +88,7 @@
     "@primer/css": "22.0.2",
     "@primer/octicons-react": "19.21.1",
     "@primer/primitives": "11.3.2",
-    "@primer/react": "38.6.1",
+    "@primer/react": "38.6.2",
     "@tailwindcss/postcss": "4.1.18",
     "@testing-library/jest-dom": "6.9.1",
     "@testing-library/react": "16.3.1",
@@ -135,7 +135,7 @@
     "webpack-cli": "6.0.1",
     "webpack-merge": "6.0.1"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].2",
   "pnpm": {
     "onlyBuiltDependencies": [
       "@biomejs/biome",

pnpm-lock.yaml

@@ -4,7 +4,7 @@ import type { User } from '../typesGitHub';
 export const mockGitifyUser: GitifyUser = {
   login: 'octocat',
   name: 'Mona Lisa Octocat',
-  id: 123456789,
+  id: '123456789',
   avatar: 'https://avatars.githubusercontent.com/u/583231?v=4' as Link,
 };
 

src/renderer/__mocks__/user-mocks.ts

@@ -204,7 +204,7 @@ export interface GitifyUser {
   login: string;
   name: string | null;
   avatar: Link | null;
-  id: number;
+  id: string;
 }
 
 export interface GitifyError {

src/renderer/types.ts

@@ -4,6 +4,27 @@ import type { GitifyNotification, GitifySubject, Link } from './types';
 
 // TODO: #828 Add explicit types for GitHub API response vs Gitify Notifications object
 
+export interface User {
+  login: string;
+  id: number;
+  node_id: string;
+  avatar_url: Link;
+  gravatar_url: Link;
+  url: Link;
+  html_url: Link;
+  followers_url: Link;
+  following_url: Link;
+  gists_url: Link;
+  starred_url: Link;
+  subscriptions_url: Link;
+  organizations_url: Link;
+  repos_url: Link;
+  events_url: Link;
+  received_events_url: Link;
+  type: UserType;
+  site_admin: boolean;
+}
+
 export type Notification = GitHubNotification &
   GitifyNotification & {
     reason: Reason;

src/renderer/typesGitHub.ts

@@ -9,7 +9,6 @@ import {
   mockNonCachedAuthHeaders,
 } from './__mocks__/request-mocks';
 import {
-  getAuthenticatedUser,
   getHtmlUrl,
   headNotifications,
   ignoreNotificationThreadSubscription,
@@ -29,17 +28,6 @@ describe('renderer/utils/api/client.ts', () => {
     jest.clearAllMocks();
   });
 
-  it('getAuthenticatedUser - should fetch authenticated user', async () => {
-    await getAuthenticatedUser(mockGitHubHostname, mockToken);
-
-    expect(axios).toHaveBeenCalledWith({
-      url: 'https://api.github.com/user',
-      headers: mockAuthHeaders,
-      method: 'GET',
-      data: {},
-    });
-  });
-
   it('headNotifications - should fetch notifications head', async () => {
     await headNotifications(mockGitHubHostname, mockToken);
 

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

@@ -14,40 +14,30 @@ import type {
   Notification,
   NotificationThreadSubscription,
   Release,
-  UserDetails,
 } from '../../typesGitHub';
 import { isAnsweredDiscussionFeatureSupported } from '../features';
 import { rendererLogError } from '../logger';
 import {
+  FetchAuthenticatedUserDetailsDocument,
+  type FetchAuthenticatedUserDetailsQuery,
   FetchDiscussionByNumberDocument,
   type FetchDiscussionByNumberQuery,
   FetchIssueByNumberDocument,
   type FetchIssueByNumberQuery,
   FetchPullRequestByNumberDocument,
   type FetchPullRequestByNumberQuery,
 } from './graphql/generated/graphql';
-import { apiRequestAuth, performGraphQLRequest } from './request';
+import {
+  apiRequestAuth,
+  type ExecutionResultWithHeaders,
+  performGraphQLRequest,
+} from './request';
 import {
   getGitHubAPIBaseUrl,
   getGitHubGraphQLUrl,
   getNumberFromUrl,
 } from './utils';
 
-/**
- * Get the authenticated user
- *
- * Endpoint documentation: https://docs.github.com/en/rest/users/users#get-the-authenticated-user
- */
-export function getAuthenticatedUser(
-  hostname: Hostname,
-  token: Token,
-): AxiosPromise<UserDetails> {
-  const url = getGitHubAPIBaseUrl(hostname);
-  url.pathname += 'user';
-
-  return apiRequestAuth(url.toString() as Link, 'GET', token);
-}
-
 /**
  * Perform a HEAD operation, used to validate that connectivity is established.
  *
@@ -187,6 +177,22 @@ export async function getHtmlUrl(url: Link, token: Token): Promise<string> {
   }
 }
 
+/**
+ * Fetch details of the currently authenticated GitHub user.
+ */
+export async function fetchAuthenticatedUserDetails(
+  hostname: Hostname,
+  token: Token,
+): Promise<ExecutionResultWithHeaders<FetchAuthenticatedUserDetailsQuery>> {
+  const url = getGitHubGraphQLUrl(hostname);
+
+  return performGraphQLRequest(
+    url.toString() as Link,
+    token,
+    FetchAuthenticatedUserDetailsDocument,
+  );
+}
+
 /**
  * Fetch GitHub Issue by Issue Number.
  */

src/renderer/utils/api/client.ts

@@ -19,12 +19,14 @@ type Documents = {
     "query FetchDiscussionByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $lastReplies: Int, $firstLabels: Int, $includeIsAnswered: Boolean!) {\n  repository(owner: $owner, name: $name) {\n    discussion(number: $number) {\n      ...DiscussionDetails\n    }\n  }\n}\n\nfragment DiscussionDetails on Discussion {\n  __typename\n  number\n  title\n  stateReason\n  isAnswered @include(if: $includeIsAnswered)\n  url\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      ...DiscussionCommentFields\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n}\n\nfragment CommentFields on DiscussionComment {\n  databaseId\n  createdAt\n  author {\n    ...AuthorFields\n  }\n  url\n}\n\nfragment DiscussionCommentFields on DiscussionComment {\n  ...CommentFields\n  replies(last: $lastReplies) {\n    totalCount\n    nodes {\n      ...CommentFields\n    }\n  }\n}": typeof types.FetchDiscussionByNumberDocument,
     "query FetchIssueByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    issue(number: $number) {\n      ...IssueDetails\n    }\n  }\n}\n\nfragment IssueDetails on Issue {\n  __typename\n  number\n  title\n  url\n  state\n  stateReason\n  milestone {\n    ...MilestoneFields\n  }\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      url\n      author {\n        ...AuthorFields\n      }\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n}": typeof types.FetchIssueByNumberDocument,
     "query FetchPullRequestByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int, $lastComments: Int, $lastReviews: Int, $firstClosingIssues: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      ...PullRequestDetails\n    }\n  }\n}\n\nfragment PullRequestDetails on PullRequest {\n  __typename\n  number\n  title\n  url\n  state\n  merged\n  isDraft\n  isInMergeQueue\n  milestone {\n    ...MilestoneFields\n  }\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      url\n      author {\n        ...AuthorFields\n      }\n    }\n  }\n  reviews(last: $lastReviews) {\n    totalCount\n    nodes {\n      ...PullRequestReviewFields\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n  closingIssuesReferences(first: $firstClosingIssues) {\n    nodes {\n      number\n    }\n  }\n}\n\nfragment PullRequestReviewFields on PullRequestReview {\n  state\n  author {\n    login\n  }\n}": typeof types.FetchPullRequestByNumberDocument,
+    "query FetchAuthenticatedUserDetails {\n  viewer {\n    id\n    name\n    login\n    avatarUrl\n  }\n}": typeof types.FetchAuthenticatedUserDetailsDocument,
 };
 const documents: Documents = {
     "fragment AuthorFields on Actor {\n  login\n  html_url: url\n  avatar_url: avatarUrl\n  type: __typename\n}\n\nfragment MilestoneFields on Milestone {\n  state\n  title\n}": types.AuthorFieldsFragmentDoc,
     "query FetchDiscussionByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $lastReplies: Int, $firstLabels: Int, $includeIsAnswered: Boolean!) {\n  repository(owner: $owner, name: $name) {\n    discussion(number: $number) {\n      ...DiscussionDetails\n    }\n  }\n}\n\nfragment DiscussionDetails on Discussion {\n  __typename\n  number\n  title\n  stateReason\n  isAnswered @include(if: $includeIsAnswered)\n  url\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      ...DiscussionCommentFields\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n}\n\nfragment CommentFields on DiscussionComment {\n  databaseId\n  createdAt\n  author {\n    ...AuthorFields\n  }\n  url\n}\n\nfragment DiscussionCommentFields on DiscussionComment {\n  ...CommentFields\n  replies(last: $lastReplies) {\n    totalCount\n    nodes {\n      ...CommentFields\n    }\n  }\n}": types.FetchDiscussionByNumberDocument,
     "query FetchIssueByNumber($owner: String!, $name: String!, $number: Int!, $lastComments: Int, $firstLabels: Int) {\n  repository(owner: $owner, name: $name) {\n    issue(number: $number) {\n      ...IssueDetails\n    }\n  }\n}\n\nfragment IssueDetails on Issue {\n  __typename\n  number\n  title\n  url\n  state\n  stateReason\n  milestone {\n    ...MilestoneFields\n  }\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      url\n      author {\n        ...AuthorFields\n      }\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n}": types.FetchIssueByNumberDocument,
     "query FetchPullRequestByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int, $lastComments: Int, $lastReviews: Int, $firstClosingIssues: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      ...PullRequestDetails\n    }\n  }\n}\n\nfragment PullRequestDetails on PullRequest {\n  __typename\n  number\n  title\n  url\n  state\n  merged\n  isDraft\n  isInMergeQueue\n  milestone {\n    ...MilestoneFields\n  }\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      url\n      author {\n        ...AuthorFields\n      }\n    }\n  }\n  reviews(last: $lastReviews) {\n    totalCount\n    nodes {\n      ...PullRequestReviewFields\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n  closingIssuesReferences(first: $firstClosingIssues) {\n    nodes {\n      number\n    }\n  }\n}\n\nfragment PullRequestReviewFields on PullRequestReview {\n  state\n  author {\n    login\n  }\n}": types.FetchPullRequestByNumberDocument,
+    "query FetchAuthenticatedUserDetails {\n  viewer {\n    id\n    name\n    login\n    avatarUrl\n  }\n}": types.FetchAuthenticatedUserDetailsDocument,
 };
 
 /**
@@ -43,6 +45,10 @@ export function graphql(source: "query FetchIssueByNumber($owner: String!, $name
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(source: "query FetchPullRequestByNumber($owner: String!, $name: String!, $number: Int!, $firstLabels: Int, $lastComments: Int, $lastReviews: Int, $firstClosingIssues: Int) {\n  repository(owner: $owner, name: $name) {\n    pullRequest(number: $number) {\n      ...PullRequestDetails\n    }\n  }\n}\n\nfragment PullRequestDetails on PullRequest {\n  __typename\n  number\n  title\n  url\n  state\n  merged\n  isDraft\n  isInMergeQueue\n  milestone {\n    ...MilestoneFields\n  }\n  author {\n    ...AuthorFields\n  }\n  comments(last: $lastComments) {\n    totalCount\n    nodes {\n      url\n      author {\n        ...AuthorFields\n      }\n    }\n  }\n  reviews(last: $lastReviews) {\n    totalCount\n    nodes {\n      ...PullRequestReviewFields\n    }\n  }\n  labels(first: $firstLabels) {\n    nodes {\n      name\n    }\n  }\n  closingIssuesReferences(first: $firstClosingIssues) {\n    nodes {\n      number\n    }\n  }\n}\n\nfragment PullRequestReviewFields on PullRequestReview {\n  state\n  author {\n    login\n  }\n}"): typeof import('./graphql').FetchPullRequestByNumberDocument;
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(source: "query FetchAuthenticatedUserDetails {\n  viewer {\n    id\n    name\n    login\n    avatarUrl\n  }\n}"): typeof import('./graphql').FetchAuthenticatedUserDetailsDocument;
 
 
 export function graphql(source: string) {

src/renderer/utils/api/graphql/generated/gql.ts

@@ -36083,6 +36083,11 @@ export type PullRequestReviewFieldsFragment = { __typename?: 'PullRequestReview'
     | { __typename?: 'User', login: string }
    | null };
 
+export type FetchAuthenticatedUserDetailsQueryVariables = Exact<{ [key: string]: never; }>;
+
+
+export type FetchAuthenticatedUserDetailsQuery = { __typename?: 'Query', viewer: { __typename?: 'User', id: string, name?: string | null, login: string, avatarUrl: any } };
+
 export class TypedDocumentString<TResult, TVariables>
   extends String
   implements DocumentTypeDecoration<TResult, TVariables>
@@ -36468,4 +36473,14 @@ fragment PullRequestReviewFields on PullRequestReview {
   author {
     login
   }
-}`) as unknown as TypedDocumentString<FetchPullRequestByNumberQuery, FetchPullRequestByNumberQueryVariables>;
+}`) as unknown as TypedDocumentString<FetchPullRequestByNumberQuery, FetchPullRequestByNumberQueryVariables>;
+export const FetchAuthenticatedUserDetailsDocument = new TypedDocumentString(`
+    query FetchAuthenticatedUserDetails {
+  viewer {
+    id
+    name
+    login
+    avatarUrl
+  }
+}
+    `) as unknown as TypedDocumentString<FetchAuthenticatedUserDetailsQuery, FetchAuthenticatedUserDetailsQueryVariables>;

src/renderer/utils/api/graphql/generated/graphql.ts

@@ -0,0 +1,8 @@
+query FetchAuthenticatedUserDetails {
+  viewer {
+    id
+    name
+    login
+    avatarUrl
+  }
+}