gitoria

12.6 KB

1. // tickets.hl — THE TICKETS OF A REPO (gitoria#10, gitoria#18; CONCEPT "/tickets"). The tickets are NOT stored in
2. // gitoria: they live in a tickets.worldapi.org project the repo's OWNER connected in the repo's settings
3. // (docs: antcolony-docs/docs/tickets-connect-apps.md). The connect flow:
4. // 1. /settings/connect (project.hl) sends the owner's browser to <tickets>/connect?app=gitoria&label=<slug>&return=…&state=…
5. // 2. tickets brings them back to /settings/connected?code=…&state=… (the state is the nonce of step 1, kept in the session)
6. // 3. exchangeConnect(code): POST <tickets>/api/connect/exchange { code } → { key, project, title, api }, from THIS server.
7. // The key is stored per repo (repos.hl, mpackdb) and never sent to a page.
8. // Every write then carries `Authorization: Bearer <key>` and `X-Tickets-Identity: <ident id of the person>`: the person
9. // (not gitoria) is the author, under the project's roles. Reads need no key.
10. // Links both ways: "#12" in a commit subject or a pull request title links ticket 12 (refParts); a push posts
11. // "mentioned in commit …" on that ticket, and a merged `|||PR` whose title says "fixes #12" sets ticket 12 to review (notifyPush).
12. // Config (environment, or `.env` beside project.hl — never printed): GITORIA_TICKETS_URL, default https://tickets.worldapi.org
13. import { fetch } from 'hl:fetch'
14. import { MPackDB } from 'hl:mpackdb'
15. import { now } from 'hl:time'
16. import { envOr, plainError, storageDir, firstOf, countOfList, userRecord, publicUrl, repoOrigin } from './users.hl'
17. import { repoBySlug } from './repos.hl'
18. import { gitRaw, tabs, isHexId, pullsNow } from './git.hl'
20. static NL = "
21. "
23. static ticketsRaw = envOr('GITORIA_TICKETS_URL', 'https://tickets.worldapi.org')
24. static ticketsUrl = ticketsRaw.endsWith('/') ? ticketsRaw.slice(0, ticketsRaw.length - 1) : ticketsRaw
25. static maxRows = 200
26. static agent = 'gitoria.worldapi.org (tickets)'
28. // what was already told to tickets (a push arrives again with the same commits): one row per `<slug> <what> <sha> <n>`
29. static seenTable = new MPackDB(file = storageDir + '/ticketlinks.db', primaryKey = '@id', indexes = ['!key'])
31. // ---- the connect flow ------------------------------------------------------------------------------
32. static connectHref = (slug, state) => {
33. let back = repoOrigin(slug) + '/settings/connected'
34. return ticketsUrl + '/connect?app=gitoria&label=' + encodeURIComponent(slug) + '&return=' + encodeURIComponent(back) + '&state=' + encodeURIComponent(state)
35. }
37. static isCode = (s) => {
38. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > 200) { return false }
39. let i = 0
40. while (i < s.length) {
41. let c = s.charCodeAt(i)
42. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 122) || (c >= 65 && c <= 90) || c == 45 || c == 95)) { return false }
43. i = i + 1
44. }
45. return true
46. }
48. // the code tickets sent back → { key, project, title, api } | { error }
49. static exchangeConnect = (code) => {
50. if (!isCode(code)) { return { error = 'that is not a code from tickets' } }
51. let r = fetch(ticketsUrl + '/api/connect/exchange', { method = 'POST' json = { code = code } headers = { 'user-agent' = agent } timeoutMs = 10000 })
52. if (r == null || r.status == null || r.status == 0) { return { error = 'tickets.worldapi.org did not answer' } }
53. let j = r.json()
54. if (r.status != 200 || j == null || j.key == null || j.project == null || j.api == null) {
55. return { error = 'tickets.worldapi.org refused the connection (' + r.status + (j != null && j.error != null ? ': ' + j.error : '') + ')' }
56. }
57. if (hlTypeName(j.key) != 'String' || !j.key.startsWith('tktc_') || hlTypeName(j.api) != 'String' || !j.api.startsWith(ticketsUrl + '/api/projects/')) { return { error = 'tickets.worldapi.org sent an answer gitoria does not understand' } }
58. return { key = j.key project = '' + j.project title = j.title != null ? '' + j.title : '' + j.project api = j.api }
59. }
61. // ---- reading ---------------------------------------------------------------------------------------
62. // the project of a connected repo (the server-side record has the key): { key, api, project } or null
63. static connectionOf = (slug) => {
64. let r = repoBySlug(slug)
65. if (r == null || r.tktKey == null || r.tktKey == '' || r.tktApi == null || r.tktApi == '') { return null }
66. return { key = r.tktKey api = r.tktApi project = r.tktProject title = r.tktTitle }
67. }
69. static ticketHref = (project, n) => { return ticketsUrl + '/projects/' + project + '/' + n }
71. // one row for the page (a state's words are shown as tickets writes them)
72. static viewOf = (t) => {
73. return { number = t.number subject = t.subject state = t.state stateSlug = t.stateSlug created = t.created updated = t.updated url = ticketsUrl + t.href }
74. }
76. // the repo's tickets, newest update first (tickets' order): { tickets, count, truncated, project, url } or { error }
77. static loadTickets = (slug) => {
78. let c = connectionOf(slug)
79. if (c == null) { return { error = 'not connected' } }
80. let r = fetch(c.api + '/tickets', { method = 'GET' headers = { 'user-agent' = agent } timeoutMs = 10000 })
81. if (r == null || r.status == null || r.status == 0) { return { error = 'tickets.worldapi.org did not answer' } }
82. let base = { project = c.project url = ticketsUrl + '/projects/' + c.project }
83. let j = r.status == 200 ? r.json() : null
84. if (j == null || j.tickets == null) { return { error = 'tickets.worldapi.org answered ' + r.status } }
85. let out = []
86. for (t of j.tickets) { if (out.length < maxRows) { out.push(viewOf(t)) } }
87. base.tickets = out
88. base.count = j.tickets.length
89. base.truncated = j.tickets.length > out.length
90. return base
91. }
93. // ---- writing (as a person) ---------------------------------------------------------------------------
94. static writeHeaders = (c, identity) => {
95. return { 'user-agent' = agent 'authorization' = 'Bearer ' + c.key 'x-tickets-identity' = identity }
96. }
98. static whyOf = (r) => {
99. let j = r.json()
100. return j != null && j.error != null ? ': ' + j.error : ''
101. }
103. // open a ticket for a repo as the person with this ident id: { ticket } or { error, field }
104. static openTicket = (slug, identity, subject, summary) => {
105. let s = subject == null ? '' : ('' + subject).trim()
106. if (s == '') { return { error = 'the ticket needs a subject' field = 'subject' } }
107. let bad = plainError(s, 200, 'the subject')
108. if (bad != null) { return { error = bad field = 'subject' } }
109. let body = summary == null ? '' : ('' + summary).trim()
110. if (body.length > 20000) { return { error = 'the text is too long (at most 20000 characters)' field = 'summary' } }
111. let c = connectionOf(slug)
112. if (c == null) { return { error = 'this repository is not connected to a tickets project (see Settings)' field = '' } }
113. let r = fetch(c.api + '/tickets', { method = 'POST' json = { subject = s summary = body } headers = writeHeaders(c, identity) timeoutMs = 10000 })
114. if (r == null || r.status == null || r.status == 0) { return { error = 'tickets.worldapi.org did not answer' field = '' } }
115. let j = r.json()
116. if ((r.status != 201 && r.status != 200) || j == null || j.ticket == null) {
117. if (r.status == 403) { return { error = 'tickets refused: log in to tickets.worldapi.org once, choose a display name there, and check you may edit this project' + whyOf(r) field = '' } }
118. return { error = 'tickets.worldapi.org refused the ticket (' + r.status + whyOf(r).slice(0, 200) + ')' field = '' }
119. }
120. return { ticket = viewOf(j.ticket) }
121. }
123. // a comment on ticket n as a person → true when tickets took it, or answered it with a refusal (no retry then)
124. static commentTicket = (c, identity, n, text) => {
125. let r = fetch(c.api + '/tickets/' + n + '/comments', { method = 'POST' json = { text = text } headers = writeHeaders(c, identity) timeoutMs = 10000 })
126. return r != null && r.status != null && r.status > 0 && r.status < 500
127. }
129. static stateTicket = (c, identity, n, state, text) => {
130. let r = fetch(c.api + '/tickets/' + n + '/state', { method = 'POST' json = { state = state text = text } headers = writeHeaders(c, identity) timeoutMs = 10000 })
131. return r != null && r.status != null && r.status > 0 && r.status < 500
132. }
134. // ---- "#12" in a text ---------------------------------------------------------------------------------
135. static isDigitCode = (c) => { return c >= 48 && c <= 57 }
136. static isWordCode = (c) => { return (c >= 48 && c <= 57) || (c >= 65 && c <= 90) || (c >= 97 && c <= 122) || c == 95 }
138. // every `#N` of a text (N = 1–9 digits, not glued to a word before it): [{ at, len, n }]
139. static refsOf = (text) => {
140. let out = []
141. if (text == null || hlTypeName(text) != 'String') { return out }
142. let i = 0
143. while (i < text.length) {
144. if (text[i] == '#' && (i == 0 || !isWordCode(text.charCodeAt(i - 1)))) {
145. let j = i + 1
146. while (j < text.length && j - i - 1 < 9 && isDigitCode(text.charCodeAt(j))) { j = j + 1 }
147. let stop = j >= text.length || !isWordCode(text.charCodeAt(j))
148. if (j > i + 1 && stop && text.slice(i + 1, i + 2) != '0') { out.push({ at = i len = j - i n = toNumber(text.slice(i + 1, j)) }) }
149. i = j
150. } else {
151. i = i + 1
152. }
153. }
154. return out
155. }
157. // a text as pieces for a View: [{ text, href, isLink, isText }] — `#N` becomes a link when the repo is connected
158. static refParts = (text, project) => {
159. let out = []
160. let t = text == null ? '' : '' + text
161. let refs = project == null || project == '' ? [] : refsOf(t)
162. let pos = 0
163. for (x of refs) {
164. if (x.at > pos) { out.push({ text = t.slice(pos, x.at) href = '' isLink = false isText = true }) }
165. out.push({ text = t.slice(x.at, x.at + x.len) href = ticketHref(project, x.n) isLink = true isText = false })
166. pos = x.at + x.len
167. }
168. if (pos < t.length || out.length == 0) { out.push({ text = t.slice(pos) href = '' isLink = false isText = true }) }
169. return out
170. }
172. // the numbers a text says it fixes: "fixes #3", "closes #4, #5"? — only the word directly before `#N` counts
173. static fixedBy = (text) => {
174. let out = []
175. let t = text == null ? '' : ('' + text).toLowerCase()
176. for (x of refsOf(t)) {
177. let before = t.slice(0, x.at).trimEnd()
178. let ok = false
179. for (w of ['fix', 'fixes', 'fixed', 'close', 'closes', 'closed', 'resolve', 'resolves', 'resolved']) {
180. if (before.endsWith(w) && (before.length == w.length || !isWordCode(before.charCodeAt(before.length - w.length - 1)))) { ok = true }
181. }
182. if (ok && !out.includes(x.n)) { out.push(x.n) }
183. }
184. return out
185. }
187. // the commit list of a code page with pieces for the subjects (the View draws links from `parts`)
188. static withRefParts = (data, project) => {
189. if (data == null || data.isMessage) { return data }
190. let d = data
191. d.subjectParts = refParts(d.subject, project)
192. let cs = []
193. for (c of d.commits) {
194. let q = c
195. q.parts = refParts(c.subject, project)
196. cs.push(q)
197. }
198. d.commits = cs
199. return d
200. }
202. static withPullParts = (list, project) => {
203. let out = []
204. for (p of list) {
205. let q = p
206. q.parts = refParts(p.title, project)
207. out.push(q)
208. }
209. return out
210. }
212. // ---- after a push or a merge: tell tickets ---------------------------------------------------------------
213. static seen = (key) => { return countOfList(seenTable.find('key', key)) > 0 }
214. static markSeen = (key) => { seenTable.put({ key = key created = now() }) }
216. // The recent commits of every branch that name a ticket: "mentioned in commit …" as a comment on it, once per
217. // commit and ticket. `quiet` only marks them (the moment of connecting: old history is not announced).
218. // Then every MERGED pull request whose title says "fixes #N" sets ticket N to review, once. The person is the repo's
219. // owner (pushes and merges are the owner's). Failures are silent (the push has succeeded); a refusal by tickets is not retried.
220. static notifyPush = (slug, quiet) => {
221. let c = connectionOf(slug)
222. let repo = repoBySlug(slug)
223. if (c == null || repo == null) { return null }
224. let owner = userRecord(repo.owner)
225. if (owner == null || owner.identity == null) { return null }
226. let lg = gitRaw(slug, ['log', '-100', '--branches', '--format=%H%x09%s'])
227. if (lg != null && lg.exit == 0) {
228. for (l of lg.lines) {
229. let f = tabs(l)
230. if (f.length >= 2 && isHexId(f[0])) {
231. let sub = f.slice(1).join(' ')
232. for (x of refsOf(sub)) {
233. let key = slug + ' commit ' + f[0] + ' ' + x.n
234. if (!seen(key)) {
235. if (quiet || commentTicket(c, owner.identity, x.n, 'Mentioned in commit [' + f[0].slice(0, 8) + '](' + repoOrigin(slug) + '/commit/' + f[0] + ') of ' + slug + ':' + NL + NL + '> ' + sub)) { markSeen(key) }
236. }
237. }
238. }
239. }
240. }
241. let got = pullsNow(slug, repo.branch != null ? repo.branch : '')
242. if (got != null && !got.isMessage) {
243. for (p of got.pulls) {
244. if (p.isMerged) {
245. for (n of fixedBy(p.title)) {
246. let key = slug + ' pr ' + p.sha + ' ' + n
247. if (!seen(key)) {
248. if (quiet || stateTicket(c, owner.identity, n, 'review', 'Fixed by the merged pull request [' + p.title + '](' + repoOrigin(slug) + '/commit/' + p.sha + ') of ' + slug + '.')) { markSeen(key) }
249. }
250. }
251. }
252. }
253. }
254. return null
255. }