further type refactoring

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

Author: setchy

src/renderer/__mocks__/user-mocks.ts

@@ -19,14 +19,13 @@ export function createPartialMockUser(login: string): RawUser {
   return mockUser as RawUser;
 }
 
-export function createMockAuthorFragment(
+export function createMockNotificationUser(
   login: string,
 ): GitifyNotificationUser {
   return {
-    __typename: 'User',
     login: login,
-    htmlUrl: `https://github.com/${login}`,
-    avatarUrl: 'https://avatars.githubusercontent.com/u/583231?v=4',
+    htmlUrl: `https://github.com/${login}` as Link,
+    avatarUrl: 'https://avatars.githubusercontent.com/u/583231?v=4' as Link,
     type: 'User',
   };
 }

src/renderer/components/notifications/NotificationFooter.test.tsx

@@ -3,7 +3,7 @@ import userEvent from '@testing-library/user-event';
 
 import { renderWithAppContext } from '../../__helpers__/test-utils';
 import { mockGitHubCloudAccount } from '../../__mocks__/account-mocks';
-import type { Link, UserType } from '../../types';
+import type { GitifyNotificationUser, Link } from '../../types';
 import { mockSingleNotification } from '../../utils/api/__mocks__/response-mocks';
 import * as comms from '../../utils/comms';
 import { NotificationFooter } from './NotificationFooter';
@@ -83,7 +83,7 @@ describe('renderer/components/notifications/NotificationFooter.tsx', () => {
             htmlUrl: 'https://github.com/some-user' as Link,
             avatarUrl:
               'https://avatars.githubusercontent.com/u/123456789?v=4' as Link,
-            type: 'User' as UserType,
+            type: 'User' as GitifyNotificationUser['type'],
           },
           reviews: null,
         },

src/renderer/types.ts

@@ -3,7 +3,6 @@ import type { FC } from 'react';
 import type { OcticonProps } from '@primer/octicons-react';
 
 import type {
-  AuthorFieldsFragment,
   DiscussionStateReason,
   IssueState,
   IssueStateReason,
@@ -349,7 +348,19 @@ export interface GitifyOwner {
   type: UserType;
 }
 
-export type GitifyNotificationUser = AuthorFieldsFragment;
+/**
+ * Minimal notification user information.
+ */
+export interface GitifyNotificationUser {
+  /** Notification user login name */
+  login: string;
+  /**  Notification user avatar URL */
+  avatarUrl: Link;
+  /**  Notification user html URL */
+  htmlUrl: Link;
+  /** Notification user type (User, Organization, Bot, etc.) */
+  type: UserType;
+}
 
 export type GitifyMilestone = MilestoneFieldsFragment;
 

src/renderer/utils/links.test.ts

@@ -1,5 +1,5 @@
 import { mockGitHubCloudAccount } from '../__mocks__/account-mocks';
-import { createMockAuthorFragment } from '../__mocks__/user-mocks';
+import { createMockNotificationUser } from '../__mocks__/user-mocks';
 import { Constants } from '../constants';
 import type {
   GitifyNotificationUser,
@@ -75,7 +75,7 @@ describe('renderer/utils/links.ts', () => {
   });
 
   it('openUserProfile', () => {
-    const mockUser = createMockAuthorFragment(
+    const mockUser = createMockNotificationUser(
       'mock-user',
     ) as GitifyNotificationUser;
 

src/renderer/utils/notifications/handlers/commit.ts

@@ -8,6 +8,7 @@ import type {
   GitifyNotificationState,
   GitifyNotificationUser,
   GitifySubject,
+  Link,
   SettingsState,
 } from '../../../types';
 import { getCommit, getCommitComment } from '../../api/client';
@@ -41,8 +42,8 @@ class CommitHandler extends DefaultHandler {
 
       user = {
         login: commitComment.user.login,
-        avatarUrl: commitComment.user.avatar_url,
-        htmlUrl: commitComment.user.html_url,
+        avatarUrl: commitComment.user.avatar_url as Link,
+        htmlUrl: commitComment.user.html_url as Link,
         type: commitComment.user.type as GitifyNotificationUser['type'],
       };
     } else {
@@ -52,8 +53,8 @@ class CommitHandler extends DefaultHandler {
 
       user = {
         login: commit.author.login,
-        avatarUrl: commit.author.avatar_url,
-        htmlUrl: commit.author.html_url,
+        avatarUrl: commit.author.avatar_url as Link,
+        htmlUrl: commit.author.html_url as Link,
         type: commit.author.type as GitifyNotificationUser['type'],
       };
     }

src/renderer/utils/notifications/handlers/discussion.test.ts

@@ -6,7 +6,7 @@ import {
   createPartialMockNotification,
 } from '../../../__mocks__/notifications-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
-import { createMockAuthorFragment } from '../../../__mocks__/user-mocks';
+import { createMockNotificationUser } from '../../../__mocks__/user-mocks';
 import type { GitifyNotification } from '../../../types';
 import {
   type GitifyDiscussionState,
@@ -20,9 +20,9 @@ import type {
 } from '../../api/graphql/generated/graphql';
 import { discussionHandler } from './discussion';
 
-const mockAuthor = createMockAuthorFragment('discussion-author');
-const mockCommenter = createMockAuthorFragment('discussion-commenter');
-const mockReplier = createMockAuthorFragment('discussion-replier');
+const mockAuthor = createMockNotificationUser('discussion-author');
+const mockCommenter = createMockNotificationUser('discussion-commenter');
+const mockReplier = createMockNotificationUser('discussion-replier');
 
 describe('renderer/utils/notifications/handlers/discussion.ts', () => {
   describe('enrich', () => {

src/renderer/utils/notifications/handlers/issue.test.ts

@@ -6,7 +6,7 @@ import {
   createPartialMockNotification,
 } from '../../../__mocks__/notifications-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
-import { createMockAuthorFragment } from '../../../__mocks__/user-mocks';
+import { createMockNotificationUser } from '../../../__mocks__/user-mocks';
 import type { GitifyNotification } from '../../../types';
 import {
   type GitifyIssueState,
@@ -21,8 +21,8 @@ import type {
 } from '../../api/graphql/generated/graphql';
 import { issueHandler } from './issue';
 
-const mockAuthor = createMockAuthorFragment('issue-author');
-const mockCommenter = createMockAuthorFragment('issue-commenter');
+const mockAuthor = createMockNotificationUser('issue-author');
+const mockCommenter = createMockNotificationUser('issue-commenter');
 
 describe('renderer/utils/notifications/handlers/issue.ts', () => {
   describe('enrich', () => {

src/renderer/utils/notifications/handlers/pullRequest.test.ts

@@ -6,7 +6,7 @@ import {
   createPartialMockNotification,
 } from '../../../__mocks__/notifications-mocks';
 import { mockSettings } from '../../../__mocks__/state-mocks';
-import { createMockAuthorFragment } from '../../../__mocks__/user-mocks';
+import { createMockNotificationUser } from '../../../__mocks__/user-mocks';
 import type { GitifyNotification } from '../../../types';
 import {
   type GitifyPullRequestState,
@@ -21,8 +21,8 @@ import type {
 } from '../../api/graphql/generated/graphql';
 import { getLatestReviewForReviewers, pullRequestHandler } from './pullRequest';
 
-const mockAuthor = createMockAuthorFragment('some-author');
-const mockCommenter = createMockAuthorFragment('some-commenter');
+const mockAuthor = createMockNotificationUser('some-author');
+const mockCommenter = createMockNotificationUser('some-commenter');
 
 describe('renderer/utils/notifications/handlers/pullRequest.ts', () => {
   let mockNotification: GitifyNotification;

src/renderer/utils/notifications/handlers/release.ts

@@ -37,8 +37,8 @@ class ReleaseHandler extends DefaultHandler {
     const user: GitifyNotificationUser = release.author
       ? {
           login: release.author.login,
-          avatarUrl: release.author.avatar_url,
-          htmlUrl: release.author.html_url,
+          avatarUrl: release.author.avatar_url as Link,
+          htmlUrl: release.author.html_url as Link,
           type: release.author.type as GitifyNotificationUser['type'],
         }
       : null;

src/renderer/utils/notifications/handlers/utils.test.ts

@@ -1,9 +1,9 @@
-import { createMockAuthorFragment } from '../../../__mocks__/user-mocks';
+import { createMockNotificationUser } from '../../../__mocks__/user-mocks';
 import { formatForDisplay, getNotificationAuthor } from './utils';
 
 describe('renderer/utils/notifications/handlers/utils.ts', () => {
   describe('getNotificationAuthor', () => {
-    const mockAuthor = createMockAuthorFragment('some-author');
+    const mockAuthor = createMockNotificationUser('some-author');
 
     it('returns null when all users are null', () => {
       const result = getNotificationAuthor([null, null]);