9018073193

Committed 09 May 2024 01:31PM UTC coverage: 96.431% (+0.01%) from 96.421%

Build # 9018073193

Build Type

Pull #1092

github

Committed by

web-flow

Commit Message

Merge 9eda7dbfc into c5b33a990

Pull Request Pull Request #1092: feat: delay notification removal

Run Details

390 of 402 branches covered (97.01%)

Branch coverage included in aggregate %.

12 of 13 new or added lines in 5 files covered. (92.31%)

1 existing line in 1 file now uncovered.

1015 of 1055 relevant lines covered (96.21%)

19.24 hits per line

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

98.4

/src/utils/helpers.ts

import type { AuthState } from '../types';
import type {
  Discussion,
  DiscussionComment,
  Notification,
} from '../typesGitHub';
import { openExternalLink } from '../utils/comms';
import { getHtmlUrl, searchDiscussions } from './api/client';
import { Constants } from './constants';
import { getCheckSuiteAttributes, getWorkflowRunAttributes } from './subject';

export function isGitHubLoggedIn(accounts: AuthState): boolean {
  return accounts.token != null;
}

export function getTokenForHost(hostname: string, accounts: AuthState): string {
  const isEnterprise = isEnterpriseHost(hostname);

  if (isEnterprise) {
    return accounts.enterpriseAccounts.find((obj) => obj.hostname === hostname)
      .token;
  }

  return accounts.token;
}

export function isEnterpriseHost(hostname: string): boolean {
  return !hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname);
}

export function generateNotificationReferrerId(
  notificationId: string,
  userId: number,
): string {
  const buffer = Buffer.from(
    `018:NotificationThread${notificationId}:${userId}`,
  );
  return buffer.toString('base64');
}

export function getCheckSuiteUrl(notification: Notification): string {
  const filters = [];

  const checkSuiteAttributes = getCheckSuiteAttributes(notification);

  if (checkSuiteAttributes?.workflowName) {
    filters.push(
      `workflow:"${checkSuiteAttributes.workflowName.replaceAll(' ', '+')}"`,
    );
  }

  if (checkSuiteAttributes?.status) {
    filters.push(`is:${checkSuiteAttributes.status}`);
  }

  if (checkSuiteAttributes?.branchName) {
    filters.push(`branch:${checkSuiteAttributes.branchName}`);
  }

  return actionsURL(notification.repository.html_url, filters);
}

export function getWorkflowRunUrl(notification: Notification): string {
  const filters = [];

  const workflowRunAttributes = getWorkflowRunAttributes(notification);

  if (workflowRunAttributes?.status) {
    filters.push(`is:${workflowRunAttributes.status}`);
  }

  return actionsURL(notification.repository.html_url, filters);
}

/**
 * Construct a GitHub Actions URL for a repository with optional filters.
 */
export function actionsURL(repositoryURL: string, filters: string[]): string {
  const url = new URL(repositoryURL);
  url.pathname += '/actions';

  if (filters.length > 0) {
    url.searchParams.append('query', filters.join('+'));
  }

  // Note: the GitHub Actions UI cannot handle encoded '+' characters.
  return url.toString().replace(/%2B/g, '+');
}

async function getDiscussionUrl(
  notification: Notification,
  token: string,
): Promise<string> {
  const url = new URL(notification.repository.html_url);
  url.pathname += '/discussions';

  const discussion = await fetchDiscussion(notification, token);

  if (discussion) {
    url.href = discussion.url;

    const comments = discussion.comments.nodes;

    const latestComment = getLatestDiscussionComment(comments);

    if (latestComment) {
      url.hash = `#discussioncomment-${latestComment.databaseId}`;
    }
  }

  return url.toString();
}

export async function fetchDiscussion(
  notification: Notification,
  token: string,
): Promise<Discussion | null> {
  try {
    const response = await searchDiscussions(notification, token);

    let discussions =
      response.data?.data.search.nodes.filter(
        (discussion) => discussion.title === notification.subject.title,
      ) || [];

    if (discussions.length > 1) {
      discussions = discussions.filter(
        (discussion) => discussion.viewerSubscription === 'SUBSCRIBED',
      );
    }

    return discussions[0];
  } catch (err) {}
}

export function getLatestDiscussionComment(
  comments: DiscussionComment[],
): DiscussionComment | null {
  if (!comments || comments.length === 0) {
    return null;
  }

  // Return latest reply if available
  if (comments[0].replies.nodes.length === 1) {
    return comments[0].replies.nodes[0];
  }

  // Return latest comment if no replies
  return comments[0];
}

export async function generateGitHubWebUrl(
  notification: Notification,
  accounts: AuthState,
): Promise<string> {
  const url = new URL(notification.repository.html_url);
  const token = getTokenForHost(notification.hostname, accounts);

  if (notification.subject.latest_comment_url) {
    url.href = await getHtmlUrl(notification.subject.latest_comment_url, token);
  } else if (notification.subject.url) {
    url.href = await getHtmlUrl(notification.subject.url, token);
  } else {
    // Perform any specific notification type handling (only required for a few special notification scenarios)
    switch (notification.subject.type) {
      case 'CheckSuite':
        url.href = getCheckSuiteUrl(notification);
        break;
      case 'Discussion':
        url.href = await getDiscussionUrl(notification, token);
        break;
      case 'RepositoryInvitation':
        url.pathname += '/invitations';
        break;
      case 'WorkflowRun':
        url.href = getWorkflowRunUrl(notification);
        break;
      default:
        break;
    }
  }

  url.searchParams.set(
    'notification_referrer_id',
    generateNotificationReferrerId(notification.id, accounts.user?.id),
  );

  return url.toString();
}

export function formatForDisplay(text: string[]): string {
  if (!text) {
    return '';
  }

  return text
    .join(' ')
    .replace(/([a-z])([A-Z])/g, '$1 $2') // Add space between lowercase character followed by an uppercase character
    .replace(/_/g, ' ') // Replace underscores with spaces
    .replace(/\w+/g, (word) => {
      // Convert to proper case (capitalize first letter of each word)
      return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
    });
}

export async function openInBrowser(
  notification: Notification,
  accounts: AuthState,
) {
  const url = await generateGitHubWebUrl(notification, accounts);

  openExternalLink(url);
}

1	import type { AuthState } from '../types';
2	import type {
3	Discussion,
4	DiscussionComment,
5	Notification,
6	} from '../typesGitHub';
7	import { openExternalLink } from '../utils/comms';	36✔
8	import { getHtmlUrl, searchDiscussions } from './api/client';	36✔
9	import { Constants } from './constants';	36✔
10	import { getCheckSuiteAttributes, getWorkflowRunAttributes } from './subject';	36✔
11
12	export function isGitHubLoggedIn(accounts: AuthState): boolean {	36✔
13	return accounts.token != null;	20✔
14	}
15
16	export function getTokenForHost(hostname: string, accounts: AuthState): string {	36✔
17	const isEnterprise = isEnterpriseHost(hostname);	90✔
18
19	if (isEnterprise) {	90✔
20	return accounts.enterpriseAccounts.find((obj) => obj.hostname === hostname)	18✔
21	.token;
22	}
23
24	return accounts.token;	72✔
25	}
26
27	export function isEnterpriseHost(hostname: string): boolean {	36✔
28	return !hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname);	238✔
29	}
30
31	export function generateNotificationReferrerId(	36✔
32	notificationId: string,
33	userId: number,
34	): string {
35	const buffer = Buffer.from(	36✔
36	`018:NotificationThread${notificationId}:${userId}`,
37	);
38	return buffer.toString('base64');	36✔
39	}
40
41	export function getCheckSuiteUrl(notification: Notification): string {	36✔
42	const filters = [];	14✔
43
44	const checkSuiteAttributes = getCheckSuiteAttributes(notification);	14✔
45
46	if (checkSuiteAttributes?.workflowName) {	14✔
47	filters.push(	10✔
48	`workflow:"${checkSuiteAttributes.workflowName.replaceAll(' ', '+')}"`,
49	);
50	}
51
52	if (checkSuiteAttributes?.status) {	14✔
53	filters.push(`is:${checkSuiteAttributes.status}`);	8✔
54	}
55
56	if (checkSuiteAttributes?.branchName) {	14✔
57	filters.push(`branch:${checkSuiteAttributes.branchName}`);	10✔
58	}
59
60	return actionsURL(notification.repository.html_url, filters);	14✔
61	}
62
63	export function getWorkflowRunUrl(notification: Notification): string {	36✔
64	const filters = [];	6✔
65
66	const workflowRunAttributes = getWorkflowRunAttributes(notification);	6✔
67
68	if (workflowRunAttributes?.status) {	6✔
69	filters.push(`is:${workflowRunAttributes.status}`);	2✔
70	}
71
72	return actionsURL(notification.repository.html_url, filters);	6✔
73	}
74
75	/**
76	* Construct a GitHub Actions URL for a repository with optional filters.
77	*/
78	export function actionsURL(repositoryURL: string, filters: string[]): string {	36✔
79	const url = new URL(repositoryURL);	20✔
80	url.pathname += '/actions';	20✔
81
82	if (filters.length > 0) {	20✔
83	url.searchParams.append('query', filters.join('+'));	12✔
84	}
85
86	// Note: the GitHub Actions UI cannot handle encoded '+' characters.
87	return url.toString().replace(/%2B/g, '+');	20✔
88	}
89
90	async function getDiscussionUrl(
91	notification: Notification,
92	token: string,
93	): Promise<string> {
94	const url = new URL(notification.repository.html_url);	6✔
95	url.pathname += '/discussions';	6✔
96
97	const discussion = await fetchDiscussion(notification, token);	6✔
98
99	if (discussion) {	6✔
100	url.href = discussion.url;	2✔
101
102	const comments = discussion.comments.nodes;	2✔
103
104	const latestComment = getLatestDiscussionComment(comments);	2✔
105
106	if (latestComment) {	2✔
107	url.hash = `#discussioncomment-${latestComment.databaseId}`;	2✔
108	}
109	}
110
111	return url.toString();	6✔
112	}
113
114	export async function fetchDiscussion(	36✔
115	notification: Notification,
116	token: string,
117	): Promise<Discussion \| null> {
118	try {	22✔
119	const response = await searchDiscussions(notification, token);	22✔
120
121	let discussions =
122	response.data?.data.search.nodes.filter(	22!
123	(discussion) => discussion.title === notification.subject.title,	22✔
124	) \|\| [];
125
126	if (discussions.length > 1) {	20✔
127	discussions = discussions.filter(	4✔
128	(discussion) => discussion.viewerSubscription === 'SUBSCRIBED',	8✔
129	);
130	}
131
132	return discussions[0];	20✔
133	} catch (err) {}
134	}
135
136	export function getLatestDiscussionComment(	36✔
137	comments: DiscussionComment[],
138	): DiscussionComment \| null {
139	if (!comments \|\| comments.length === 0) {	18✔
140	return null;	14✔
141	}
142
143	// Return latest reply if available
144	if (comments[0].replies.nodes.length === 1) {	4✔
145	return comments[0].replies.nodes[0];	2✔
146	}
147
148	// Return latest comment if no replies
149	return comments[0];	2✔
150	}
151
152	export async function generateGitHubWebUrl(	36✔
153	notification: Notification,
154	accounts: AuthState,
155	): Promise<string> {
156	const url = new URL(notification.repository.html_url);	42✔
157	const token = getTokenForHost(notification.hostname, accounts);	42✔
158
159	if (notification.subject.latest_comment_url) {	42✔
160	url.href = await getHtmlUrl(notification.subject.latest_comment_url, token);	10✔
161	} else if (notification.subject.url) {	32✔
162	url.href = await getHtmlUrl(notification.subject.url, token);	2✔
163	} else {
164	// Perform any specific notification type handling (only required for a few special notification scenarios)
165	switch (notification.subject.type) {	30✔
166	case 'CheckSuite':
167	url.href = getCheckSuiteUrl(notification);	14✔
168	break;	14✔
169	case 'Discussion':
170	url.href = await getDiscussionUrl(notification, token);	6✔
171	break;	6✔
172	case 'RepositoryInvitation':
173	url.pathname += '/invitations';	2✔
174	break;	2✔
175	case 'WorkflowRun':
176	url.href = getWorkflowRunUrl(notification);	6✔
177	break;	6✔
178	default:
179	break;	2✔
180	}
181	}
182
183	url.searchParams.set(	34✔
184	'notification_referrer_id',
185	generateNotificationReferrerId(notification.id, accounts.user?.id),
186	);
187
188	return url.toString();	34✔
189	}
190
191	export function formatForDisplay(text: string[]): string {	36✔
192	if (!text) {	28✔
193	return '';	2✔
194	}
195
196	return text	26✔
197	.join(' ')
198	.replace(/([a-z])([A-Z])/g, '$1 $2') // Add space between lowercase character followed by an uppercase character
199	.replace(/_/g, ' ') // Replace underscores with spaces
200	.replace(/\w+/g, (word) => {
201	// Convert to proper case (capitalize first letter of each word)
202	return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();	52✔
203	});
204	}
205
206	export async function openInBrowser(	36✔
207	notification: Notification,
208	accounts: AuthState,
209	) {
210	const url = await generateGitHubWebUrl(notification, accounts);	8✔
211
UNCOV 212	openExternalLink(url);	×
213	}

gitify-app / gitify / 9018073193

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