feat(subject): support enriched commit notification details (#1017)

Author: setchy

src/typesGithub.ts

@@ -272,6 +272,76 @@ export interface PullRequest {
   changed_files: number;
 }
 
+export interface Commit {
+  sha: string;
+  node_id: string;
+  commit: {
+    author: CommitUser;
+    committer: CommitUser;
+    message: string;
+    tree: {
+      sha: string;
+      url: string;
+    };
+    url: string;
+    comment_count: number;
+    verification: {
+      verified: boolean;
+      reason: string;
+      signature: string | null;
+      payload: string | null;
+    };
+  };
+  url: string;
+  html_url: string;
+  comments_url: string;
+  author: User;
+  committer: User;
+  parents: CommitParent[];
+  stats: {
+    total: number;
+    additions: number;
+    deletions: number;
+  };
+  files: CommitFiles[];
+}
+
+interface CommitUser {
+  name: string;
+  email: string;
+  date: string;
+}
+
+interface CommitParent {
+  sha: string;
+  url: string;
+  html_url: string;
+}
+
+interface CommitFiles {
+  sha: string;
+  filename: string;
+  status: string;
+  additions: number;
+  deletions: number;
+  changes: number;
+  blob_url: string;
+  raw_url: string;
+  contents_url: string;
+  patch: string;
+}
+export interface CommitComments {
+  url: string;
+  html_url: string;
+  issue_url: string;
+  id: number;
+  node_id: string;
+  user: User;
+  created_at: string;
+  updated_at: string;
+  body: string;
+}
+
 export interface Issue {
   url: string;
   repository_url: string;

src/utils/subject.test.ts

@@ -138,6 +138,65 @@ describe('utils/subject.ts', () => {
   });
 
   describe('getGitifySubjectDetails', () => {
+    describe('Commits', () => {
+      it('get commit commenter', async () => {
+        const mockNotification = {
+          ...mockedSingleNotification,
+          subject: {
+            title: 'This is a commit with comments',
+            url: 'https://api.github.com/repos/manosim/notifications-test/commits/d2a86d80e3d24ea9510d5de6c147e53c30f313a8',
+            latest_comment_url:
+              'https://api.github.com/repos/manosim/notifications-test/comments/141012658',
+            type: 'Commit' as SubjectType,
+          },
+        };
+
+        nock('https://api.github.com')
+          .get(
+            '/repos/manosim/notifications-test/commits/d2a86d80e3d24ea9510d5de6c147e53c30f313a8',
+          )
+          .reply(200, { author: { login: 'some-author' } });
+
+        nock('https://api.github.com')
+          .get('/repos/manosim/notifications-test/comments/141012658')
+          .reply(200, { user: { login: 'some-commenter' } });
+
+        const result = await getGitifySubjectDetails(
+          mockNotification,
+          mockAccounts.token,
+        );
+
+        expect(result.state).toBeNull();
+        expect(result.user).toEqual({ login: 'some-commenter' });
+      });
+
+      it('get commit without commenter', async () => {
+        const mockNotification = {
+          ...mockedSingleNotification,
+          subject: {
+            title: 'This is a commit with comments',
+            url: 'https://api.github.com/repos/manosim/notifications-test/commits/d2a86d80e3d24ea9510d5de6c147e53c30f313a8',
+            latest_comment_url: null,
+            type: 'Commit' as SubjectType,
+          },
+        };
+
+        nock('https://api.github.com')
+          .get(
+            '/repos/manosim/notifications-test/commits/d2a86d80e3d24ea9510d5de6c147e53c30f313a8',
+          )
+          .reply(200, { author: { login: 'some-author' } });
+
+        const result = await getGitifySubjectDetails(
+          mockNotification,
+          mockAccounts.token,
+        );
+
+        expect(result.state).toBeNull();
+        expect(result.user).toEqual({ login: 'some-author' });
+      });
+    });
+
     describe('Discussions', () => {
       it('answered discussion state', async () => {
         const mockNotification = {

src/utils/subject.ts

@@ -1,6 +1,7 @@
 import type {
   CheckSuiteAttributes,
   CheckSuiteStatus,
+  Commit,
   DiscussionStateType,
   GitifySubject,
   Issue,
@@ -23,6 +24,8 @@ export async function getGitifySubjectDetails(
   switch (notification.subject.type) {
     case 'CheckSuite':
       return getGitifySubjectForCheckSuite(notification);
+    case 'Commit':
+      return getGitifySubjectForCommit(notification, token);
     case 'Discussion':
       return await getGitifySubjectForDiscussion(notification, token);
     case 'Issue':
@@ -91,6 +94,31 @@ function getGitifySubjectForCheckSuite(
   };
 }
 
+async function getGitifySubjectForCommit(
+  notification: Notification,
+  token: string,
+): Promise<GitifySubject> {
+  try {
+    const commit: Commit = (
+      await apiRequestAuth(notification.subject.url, 'GET', token)
+    ).data;
+
+    const commitCommentUser = await getLatestCommentUser(notification, token);
+
+    return {
+      state: null,
+      user: {
+        login: commitCommentUser?.login ?? commit.author.login,
+        html_url: commitCommentUser?.html_url ?? commit.author.html_url,
+        avatar_url: commitCommentUser?.avatar_url ?? commit.author.avatar_url,
+        type: commitCommentUser?.type ?? commit.author.type,
+      },
+    };
+  } catch (err) {
+    console.error('Issue subject retrieval failed');
+  }
+}
+
 async function getGitifySubjectForDiscussion(
   notification: Notification,
   token: string,