9615725933

Committed 21 Jun 2024 03:04PM UTC coverage: 96.177% (-0.8%) from 97.005%

Build # 9615725933

Build Type

Pull #1304

github

Committed by

web-flow

Commit Message

Merge 6f2de40c0 into a8dc8eea5

Pull Request Pull Request #1304: feat: new filters route

Run Details

493 of 514 branches covered (95.91%)

Branch coverage included in aggregate %.

12 of 19 new or added lines in 4 files covered. (63.16%)

16 existing lines in 1 file now uncovered.

1268 of 1317 relevant lines covered (96.28%)

24.76 hits per line

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

94.64

/src/utils/helpers.ts

import { formatDistanceToNowStrict, parseISO } from 'date-fns';
import { defaultSettings } from '../context/App';
import type { Hostname, Link, SettingsState } from '../types';
import type { Notification } from '../typesGitHub';
import { getHtmlUrl, getLatestDiscussion } from './api/client';
import type { PlatformType } from './auth/types';
import { Constants } from './constants';
import {
  getCheckSuiteAttributes,
  getLatestDiscussionComment,
  getWorkflowRunAttributes,
} from './subject';

export function getPlatformFromHostname(hostname: string): PlatformType {
  return hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname)
    ? 'GitHub Cloud'
    : 'GitHub Enterprise Server';
}

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

export function generateNotificationReferrerId(
  notification: Notification,
): string {
  const buffer = Buffer.from(
    `018:NotificationThread${notification.id}:${notification.account.user.id}`,
  );
  return buffer.toString('base64');
}

export function getCheckSuiteUrl(notification: Notification): Link {
  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): Link {
  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[]): Link {
  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, '+') as Link;
}

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

  const discussion = await getLatestDiscussion(notification);

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

    const latestComment = getLatestDiscussionComment(discussion.comments.nodes);

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

  return url.toString() as Link;
}

export async function generateGitHubWebUrl(
  notification: Notification,
): Promise<Link> {
  const url = new URL(notification.repository.html_url);

  if (notification.subject.latest_comment_url) {
    url.href = await getHtmlUrl(
      notification.subject.latest_comment_url,
      notification.account.token,
    );
  } else if (notification.subject.url) {
    url.href = await getHtmlUrl(
      notification.subject.url,
      notification.account.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);
        break;
      case 'RepositoryInvitation':
        url.pathname += '/invitations';
        break;
      case 'WorkflowRun':
        url.href = getWorkflowRunUrl(notification);
        break;
      default:
        break;
    }
  }

  url.searchParams.set(
    'notification_referrer_id',
    generateNotificationReferrerId(notification),
  );

  return url.toString() as Link;
}

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 function formatNotificationUpdatedAt(
  notification: Notification,
): string {
  try {
    return formatDistanceToNowStrict(parseISO(notification.updated_at), {
      addSuffix: true,
    });
  } catch (e) {}

  return '';
}

export function getFilterCount(settings: SettingsState): number {
  let count = 0;

  if (settings.filterReasons !== defaultSettings.filterReasons) {
    count += settings.filterReasons.split(',').length;
  }

  if (settings.showBots !== defaultSettings.showBots) {
    count += 1;
  }

  return count;
}

1	import { formatDistanceToNowStrict, parseISO } from 'date-fns';	50✔
2	import { defaultSettings } from '../context/App';	50✔
3	import type { Hostname, Link, SettingsState } from '../types';
4	import type { Notification } from '../typesGitHub';
5	import { getHtmlUrl, getLatestDiscussion } from './api/client';	50✔
6	import type { PlatformType } from './auth/types';
7	import { Constants } from './constants';	50✔
8	import {	50✔
9	getCheckSuiteAttributes,
10	getLatestDiscussionComment,
11	getWorkflowRunAttributes,
12	} from './subject';
13
14	export function getPlatformFromHostname(hostname: string): PlatformType {	50✔
15	return hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname)	16✔
16	? 'GitHub Cloud'
17	: 'GitHub Enterprise Server';
18	}
19
20	export function isEnterpriseHost(hostname: Hostname): boolean {	50✔
21	return !hostname.endsWith(Constants.DEFAULT_AUTH_OPTIONS.hostname);	110✔
22	}
23
24	export function generateNotificationReferrerId(	50✔
25	notification: Notification,
26	): string {
27	const buffer = Buffer.from(	36✔
28	`018:NotificationThread${notification.id}:${notification.account.user.id}`,
29	);
30	return buffer.toString('base64');	36✔
31	}
32
33	export function getCheckSuiteUrl(notification: Notification): Link {	50✔
34	const filters = [];	14✔
35
36	const checkSuiteAttributes = getCheckSuiteAttributes(notification);	14✔
37
38	if (checkSuiteAttributes?.workflowName) {	14✔
39	filters.push(	10✔
40	`workflow:"${checkSuiteAttributes.workflowName.replaceAll(' ', '+')}"`,
41	);
42	}
43
44	if (checkSuiteAttributes?.status) {	14✔
45	filters.push(`is:${checkSuiteAttributes.status}`);	8✔
46	}
47
48	if (checkSuiteAttributes?.branchName) {	14✔
49	filters.push(`branch:${checkSuiteAttributes.branchName}`);	10✔
50	}
51
52	return actionsURL(notification.repository.html_url, filters);	14✔
53	}
54
55	export function getWorkflowRunUrl(notification: Notification): Link {	50✔
56	const filters = [];	6✔
57
58	const workflowRunAttributes = getWorkflowRunAttributes(notification);	6✔
59
60	if (workflowRunAttributes?.status) {	6✔
61	filters.push(`is:${workflowRunAttributes.status}`);	2✔
62	}
63
64	return actionsURL(notification.repository.html_url, filters);	6✔
65	}
66
67	/**
68	* Construct a GitHub Actions URL for a repository with optional filters.
69	*/
70	export function actionsURL(repositoryURL: string, filters: string[]): Link {	50✔
71	const url = new URL(repositoryURL);	20✔
72	url.pathname += '/actions';	20✔
73
74	if (filters.length > 0) {	20✔
75	url.searchParams.append('query', filters.join('+'));	12✔
76	}
77
78	// Note: the GitHub Actions UI cannot handle encoded '+' characters.
79	return url.toString().replace(/%2B/g, '+') as Link;	20✔
80	}
81
82	async function getDiscussionUrl(notification: Notification): Promise<Link> {
83	const url = new URL(notification.repository.html_url);	6✔
84	url.pathname += '/discussions';	6✔
85
86	const discussion = await getLatestDiscussion(notification);	6✔
87
88	if (discussion) {	6✔
89	url.href = discussion.url;	2✔
90
91	const latestComment = getLatestDiscussionComment(discussion.comments.nodes);	2✔
92
93	if (latestComment) {	2✔
94	url.hash = `#discussioncomment-${latestComment.databaseId}`;	2✔
95	}
96	}
97
98	return url.toString() as Link;	6✔
99	}
100
101	export async function generateGitHubWebUrl(	50✔
102	notification: Notification,
103	): Promise<Link> {
104	const url = new URL(notification.repository.html_url);	44✔
105
106	if (notification.subject.latest_comment_url) {	44✔
107	url.href = await getHtmlUrl(	12✔
108	notification.subject.latest_comment_url,
109	notification.account.token,
110	);
111	} else if (notification.subject.url) {	32✔
112	url.href = await getHtmlUrl(	2✔
113	notification.subject.url,
114	notification.account.token,
115	);
116	} else {
117	// Perform any specific notification type handling (only required for a few special notification scenarios)
118	switch (notification.subject.type) {	30✔
119	case 'CheckSuite':
120	url.href = getCheckSuiteUrl(notification);	14✔
121	break;	14✔
122	case 'Discussion':
123	url.href = await getDiscussionUrl(notification);	6✔
124	break;	6✔
125	case 'RepositoryInvitation':
126	url.pathname += '/invitations';	2✔
127	break;	2✔
128	case 'WorkflowRun':
129	url.href = getWorkflowRunUrl(notification);	6✔
130	break;	6✔
131	default:
132	break;	2✔
133	}
134	}
135
136	url.searchParams.set(	34✔
137	'notification_referrer_id',
138	generateNotificationReferrerId(notification),
139	);
140
141	return url.toString() as Link;	34✔
142	}
143
144	export function formatForDisplay(text: string[]): string {	50✔
145	if (!text) {	68✔
146	return '';	2✔
147	}
148
149	return text	66✔
150	.join(' ')
151	.replace(/([a-z])([A-Z])/g, '$1 $2') // Add space between lowercase character followed by an uppercase character
152	.replace(/_/g, ' ') // Replace underscores with spaces
153	.replace(/\w+/g, (word) => {
154	// Convert to proper case (capitalize first letter of each word)
155	return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();	130✔
156	});
157	}
158
159	export function formatNotificationUpdatedAt(	50✔
160	notification: Notification,
161	): string {
162	try {	64✔
163	return formatDistanceToNowStrict(parseISO(notification.updated_at), {	64✔
164	addSuffix: true,
165	});
166	} catch (e) {}
167
168	return '';	4✔
169	}
170
171	export function getFilterCount(settings: SettingsState): number {	50✔
172	let count = 0;	26✔
173
174	if (settings.filterReasons !== defaultSettings.filterReasons) {	26!
NEW 175	count += settings.filterReasons.split(',').length;	×
176	}
177
178	if (settings.showBots !== defaultSettings.showBots) {	26!
NEW 179	count += 1;	×
180	}
181
182	return count;	26✔
183	}

gitify-app / gitify / 9615725933

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