1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
import cache from 'webext-storage-cache';
import React from 'dom-chef';
import select from 'select-dom';
import {PlayIcon} from '@primer/octicons-react';
import {parseCron} from '@cheap-glitch/mi-cron';
import * as pageDetect from 'github-url-detection';
import features from '../feature-manager';
import * as api from '../github-helpers/api';
import {getRepo} from '../github-helpers';
import observe from '../helpers/selector-observer';
type WorkflowDetails = {
schedule?: string;
manuallyDispatchable: boolean;
};
function addTooltip(element: HTMLElement, tooltip: string): void {
const existingTooltip = element.getAttribute('aria-label');
if (existingTooltip) {
element.setAttribute('aria-label', existingTooltip + '.\n' + tooltip);
} else {
element.classList.add('tooltipped', 'tooltipped-s');
element.setAttribute('aria-label', tooltip);
}
}
const getWorkflowsDetails = cache.function(async (): Promise<Record<string, WorkflowDetails> | false> => {
const {repository: {workflowFiles}} = await api.v4(`
repository() {
workflowFiles: object(expression: "HEAD:.github/workflows") {
... on Tree {
entries {
name
object {
... on Blob {
text
}
}
}
}
}
}
`);
const workflows = workflowFiles?.entries ?? [];
if (workflows.length === 0) {
return false;
}
const details: Record<string, WorkflowDetails> = {};
for (const workflow of workflows) {
const workflowYaml: string = workflow.object.text;
const cron = /schedule[:\s-]+cron[:\s'"]+([^'"\n]+)/m.exec(workflowYaml);
details[workflow.name] = {
schedule: cron?.[1],
manuallyDispatchable: workflowYaml.includes('workflow_dispatch:'),
};
}
return details;
}, {
maxAge: {days: 1},
staleWhileRevalidate: {days: 10},
cacheKey: () => 'workflows:' + getRepo()!.nameWithOwner,
});
async function addIndicators(workflowListItem: HTMLAnchorElement): Promise<void> {
// Memoized above
const workflows = await getWorkflowsDetails();
if (!workflows) {
return; // Impossibru, for types only
}
if (select.exists('.octicon-stop', workflowListItem)) {
return;
}
const workflowName = workflowListItem.href.split('/').pop()!;
const workflow = workflows[workflowName];
if (!workflow) {
return;
}
if (workflow.manuallyDispatchable) {
workflowListItem.append(<PlayIcon className="ActionListItem-visual--trailing m-auto"/>);
addTooltip(workflowListItem, 'This workflow can be triggered manually');
}
if (!workflow.schedule) {
return;
}
const nextTime = parseCron.nextDate(workflow.schedule);
if (!nextTime) {
return;
}
const relativeTime = <relative-time datetime={String(nextTime)}/>;
select('.ActionList-item-label', workflowListItem)!.append(
<em>
(next {relativeTime})
</em>,
);
setTimeout(() => {
// The content of `relative-time` might not be immediately available
addTooltip(workflowListItem, 'Next run in ' + relativeTime.textContent!);
}, 500);
}
async function init(signal: AbortSignal): Promise<false | void> {
// Do it as soon as possible, before the page loads
const workflows = await getWorkflowsDetails();
if (!workflows) {
return false;
}
observe('a.ActionList-content', addIndicators, {signal});
}
void features.add(import.meta.url, {
include: [
pageDetect.isRepositoryActions,
],
awaitDomReady: false,
init,
});
/*
## Test URLs
Manual:
https://github.com/fregante/browser-extension-template/actions
Manual + scheduled:
https://github.com/fregante/eslint-formatters/actions
*/
|
