Skip to content

Commit 96ea0be

Browse files
lowlighterlowlighter
authored
feat(plugins/languages): count verified commits using user's gpg keys (lowlighter#911)
1 parent e60d74a commit 96ea0be

File tree

5 files changed

+94
-3
lines changed

5 files changed

+94
-3
lines changed

‎source/plugins/languages/analyzers.mjs‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
11
import linguist from "linguist-js"
22

33
/**Indepth analyzer */
4-
export async function indepth({login, data, imports, repositories}, {skipped, categories, timeout}) {
4+
export async function indepth({login, data, imports, repositories, gpg}, {skipped, categories, timeout}) {
55
return new Promise(async (solve, reject) => {
66
//Timeout
77
if (Number.isFinite(timeout)) {
88
console.debug(`metrics/compute/${login}/plugins > languages > timeout set to ${timeout}m`)
99
setTimeout(() => reject(`Reached maximum execution time of ${timeout}m for analysis`), timeout * 60 * 1000)
1010
}
1111

12+
//GPG keys imports
13+
for (const {id, pub} of gpg) {
14+
const path = imports.paths.join(imports.os.tmpdir(), `${data.user.databaseId}.${id}.gpg`)
15+
console.debug(`metrics/compute/${login}/plugins > languages > saving gpg ${id} to ${path}`)
16+
try {
17+
await imports.fs.writeFile(path, pub)
18+
if (process.env.GITHUB_ACTIONS) {
19+
console.debug(`metrics/compute/${login}/plugins > languages > importing gpg ${id}`)
20+
await imports.run(`gpg --import ${path}`)
21+
}
22+
else
23+
console.debug(`metrics/compute/${login}/plugins > languages > skipping import of gpg ${id}`)
24+
}
25+
catch (error) {
26+
console.debug(`metrics/compute/${login}/plugins > languages > indepth > an error occured while importing gpg ${id}, skipping...`)
27+
}
28+
finally {
29+
//Cleaning
30+
console.debug(`metrics/compute/${login}/plugins > languages > indepth > cleaning ${path}`)
31+
await imports.fs.rm(path, {recursive:true, force:true})
32+
}
33+
}
34+
1235
//Compute repositories stats from fetched repositories
13-
const results = {total:0, lines:{}, stats:{}, colors:{}, commits:0, files:0, missed:0}
36+
const results = {total:0, lines:{}, stats:{}, colors:{}, commits:0, files:0, missed:0, verified:{signature:0}}
1437
for (const repository of repositories) {
1538
//Skip repository if asked
1639
if ((skipped.includes(repository.name.toLocaleLowerCase())) || (skipped.includes(`${repository.owner.login}/${repository.name}`.toLocaleLowerCase()))) {
@@ -170,6 +193,7 @@ async function analyze({login, imports, data}, {results, path, categories = ["pr
170193
console.debug(`metrics/compute/${login}/plugins > languages > indepth > repo seems empty or impossible to git log, skipping`)
171194
return
172195
}
196+
const pending = []
173197
for (let page = 0; ; page++) {
174198
try {
175199
console.debug(`metrics/compute/${login}/plugins > languages > indepth > processing commits ${page * per_page} from ${(page + 1) * per_page}`)
@@ -182,6 +206,14 @@ async function analyze({login, imports, data}, {results, path, categories = ["pr
182206
empty = false
183207
//Commits counter
184208
if (/^commit [0-9a-f]{40}$/.test(line)) {
209+
if (results.verified) {
210+
const sha = line.match(/[0-9a-f]{40}/)?.[0]
211+
if (sha) {
212+
pending.push(imports.run(`git verify-commit ${sha}`, {cwd:path, env:{LANG:"en_GB"}}, {log:false, prefixed:false})
213+
.then(() => results.verified.signature++)
214+
.catch(() => null))
215+
}
216+
}
185217
results.commits++
186218
return
187219
}
@@ -223,6 +255,7 @@ async function analyze({login, imports, data}, {results, path, categories = ["pr
223255
results.missed += per_page
224256
}
225257
}
258+
await Promise.allSettled(pending)
226259
results.files += edited.size
227260
}
228261

‎source/plugins/languages/index.mjs‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,29 @@ export default async function({login, data, imports, q, rest, account}, {enabled
7878

7979
//Indepth mode
8080
if (indepth) {
81+
//Fetch gpg keys (web-flow is GitHub's public key when making changes from web ui)
82+
const gpg = []
83+
try {
84+
for (const username of [login, "web-flow"]) {
85+
const {data:keys} = await rest.users.listGpgKeysForUser({username})
86+
gpg.push(...keys.map(({key_id:id, raw_key:pub, emails}) => ({id, pub, emails})))
87+
if (username === login) {
88+
for (const {email} of gpg.flatMap(({emails}) => emails)) {
89+
console.debug(`metrics/compute/${login}/plugins > languages > auto-adding ${email} to commits_authoring (fetched from gpg)`)
90+
data.shared["commits.authoring"].push(email)
91+
}
92+
}
93+
}
94+
}
95+
catch (error) {
96+
console.debug(`metrics/compute/${login}/plugins > languages > ${error}`)
97+
}
98+
99+
//Analyze languages
81100
try {
82101
console.debug(`metrics/compute/${login}/plugins > languages > switching to indepth mode (this may take some time)`)
83102
const existingColors = languages.colors
84-
Object.assign(languages, await indepth_analyzer({login, data, imports, repositories}, {skipped, categories, timeout}))
103+
Object.assign(languages, await indepth_analyzer({login, data, imports, repositories, gpg}, {skipped, categories, timeout}))
85104
Object.assign(languages.colors, existingColors)
86105
console.debug(`metrics/compute/${login}/plugins > languages > indepth analysis missed ${languages.missed} commits`)
87106
}

‎source/templates/classic/partials/languages.ejs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@
6666
<% } %>
6767
</div>
6868
<% } %>
69+
<% if (plugins.languages.verified?.signature) { %>
70+
<div class="row footnote">
71+
<div class="field">
72+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M9.585.52a2.678 2.678 0 00-3.17 0l-.928.68a1.178 1.178 0 01-.518.215L3.83 1.59a2.678 2.678 0 00-2.24 2.24l-.175 1.14a1.178 1.178 0 01-.215.518l-.68.928a2.678 2.678 0 000 3.17l.68.928c.113.153.186.33.215.518l.175 1.138a2.678 2.678 0 002.24 2.24l1.138.175c.187.029.365.102.518.215l.928.68a2.678 2.678 0 003.17 0l.928-.68a1.17 1.17 0 01.518-.215l1.138-.175a2.678 2.678 0 002.241-2.241l.175-1.138c.029-.187.102-.365.215-.518l.68-.928a2.678 2.678 0 000-3.17l-.68-.928a1.179 1.179 0 01-.215-.518L14.41 3.83a2.678 2.678 0 00-2.24-2.24l-1.138-.175a1.179 1.179 0 01-.518-.215L9.585.52zM7.303 1.728c.415-.305.98-.305 1.394 0l.928.68c.348.256.752.423 1.18.489l1.136.174c.51.078.909.478.987.987l.174 1.137c.066.427.233.831.489 1.18l.68.927c.305.415.305.98 0 1.394l-.68.928a2.678 2.678 0 00-.489 1.18l-.174 1.136a1.178 1.178 0 01-.987.987l-1.137.174a2.678 2.678 0 00-1.18.489l-.927.68c-.415.305-.98.305-1.394 0l-.928-.68a2.678 2.678 0 00-1.18-.489l-1.136-.174a1.178 1.178 0 01-.987-.987l-.174-1.137a2.678 2.678 0 00-.489-1.18l-.68-.927a1.178 1.178 0 010-1.394l.68-.928c.256-.348.423-.752.489-1.18l.174-1.136c.078-.51.478-.909.987-.987l1.137-.174a2.678 2.678 0 001.18-.489l.927-.68zM11.28 6.78a.75.75 0 00-1.06-1.06L7 8.94 5.78 7.72a.75.75 0 00-1.06 1.06l1.75 1.75a.75.75 0 001.06 0l3.75-3.75z"></path></svg>
73+
<%= plugins.languages.verified.signature %> commit<%= s(plugins.languages.verified.signature) %> verified by GPG
74+
</div>
75+
</div>
76+
<% } %>
6977
<% } %>
7078
</section>
7179
<% } %>

‎source/templates/classic/style.css‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,12 @@
271271
margin-right: 6px;
272272
}
273273

274+
.footnote {
275+
width: 100%;
276+
justify-content: flex-end;
277+
font-size: 12px;
278+
}
279+
274280
/* Follow-up */
275281
.followup.legend {
276282
font-size: 12px;

‎tests/mocks/api/github/rest/users/listGpgKeysForUser.mjs‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/**Mocked data */
2+
export default function({ faker }, target, that, [{ username }]) {
3+
console.debug("metrics/compute/mocks > mocking rest api result > rest.users.listGpgKeysForUser")
4+
return ({
5+
status: 200,
6+
url: `https://api.github.com/users/${username}/`,
7+
headers: {
8+
server: "GitHub.com",
9+
status: "200 OK",
10+
"x-oauth-scopes": "repo",
11+
},
12+
data: [
13+
{
14+
key_id: faker.datatype.hexaDecimal(16),
15+
raw_key: "-----BEGIN PGP PUBLIC KEY BLOCK-----\n(dummy content)\n-----END PGP PUBLIC KEY BLOCK-----",
16+
emails: [
17+
{
18+
email: faker.internet.email(),
19+
verified: true
20+
}
21+
]
22+
}
23+
],
24+
})
25+
}

0 commit comments

Comments
 (0)