tickets

31.0 KB

1. // project.hl — tickets.worldapi.org: THE APP. Routes (pages + JSON API) and WHO HEARS WHAT.
2. import WebFramework from 'hl:web'
3. import { env } from 'hl:proc'
5. import Styles from './styles.hl'
6. import { ticketRows, ticketWithEvents, projectNames, projectByAnySlug, projectByRef, projectRecords, projectRowOf, createProject, updateProject, memberRows, setMemberRole, removeMember, userByRef, isAdminOf, roleOf, createTicket, addComment, changeState, assignTicket, editTicket, pageEventOf, stateOf, states, roles, inboxRows, ticketByRef, ticketAt, ticketHref, setParent, changeBlocker, relatedViews, addMember, projectSlugOf } from './store.hl'
7. import { migrateAll } from './migrate.hl'
8. import { createInvite, acceptedInvite } from './invites.hl'
9. import { Response } from 'hl:http1'
10. import { reply, fail, queryOf, readBody, refuse, unauthorized } from './api.hl'
11. import { userOfBearer, exchangeCode, ensureUser, userRecord } from './users.hl'
12. import { createRequest, connectionOfKey, personOf, exchangeConnectCode, connectionRows, disconnect } from './connections.hl'
13. import { randomBytes } from 'hl:crypto'
14. import { wantsMarkdown, markdownReply, listDocument, ticketDocument } from './mdview.hl'
16. import TicketList from './components/ticket_list.hl'
17. import Ticket from './components/ticket.hl'
18. import Inbox from './components/inbox.hl'
19. import You from './components/you.hl'
20. import NewProject from './components/new_project.hl'
21. import Settings from './components/settings.hl'
22. import Connect from './components/connect.hl'
24. static siteName = "tickets"
26. appTitle = siteName
27. styles = Styles
29. // ---- the JSON API (for the scheduler and a CLI) ----------------------------------------
30. // Every write pushes the same frames the web faces push, so an open browser follows an
31. // API write live. See README.md "API" for the shapes. Every POST body goes through
32. // readBody (api.hl): invalid JSON, unknown field, missing/empty required field, non-string
33. // value → 400.
34. // WRITES NEED A TOKEN (ticket #7): `Authorization: Bearer <token>` (users.hl; a logged-in user
35. // makes tokens on /you). No / bad / revoked token → 401, checked BEFORE the body. The author is
36. // the token's user; a body with `author` → 400 naming it. Reads stay public.
37. //
38. // THE MARKDOWN READ VIEW (ticket #6): `Accept: text/markdown` on the ticket GETs (the two lists,
39. // the two single-ticket forms) answers a compact Markdown document (mdview.hl); JSON otherwise,
40. // unchanged.
41. // EDITING (ticket #8): POST …/edit { subject?, summary? } — a member with the role edit or admin
42. // of the ticket's project → else 403; the history keeps the previous values.
43. //
44. // TWO WAYS TO NAME A TICKET (ticket #38): `/api/tickets/:ref` — :ref is the OLD global
45. // number of a migrated ticket (docs say "#38") or the ticket's UUID (`id`) — and the
46. // per-project form `/api/projects/:slug/tickets/:number`. Both answer the same shapes.
47. byRef = (route) => { return ticketByRef(route.params.ref) }
48. byNumber = (route) => { return ticketAt(route.params.slug, route.params.number) }
50. stateFilter = (q) => {
51. if (q.state == null || q.state == '') { return { state = null } }
52. let st = stateOf(q.state)
53. if (st == null) { return { bad = fail(400, 'unknown state — one of: ' + states.join(', ')) } }
54. return { state = st }
55. }
57. listTickets = (route, req) => {
58. if (req.method != 'GET') { return fail(405, 'GET only') }
59. // hl:http1 hands the parsed query string as `req.query`; the path carries none
60. let q = req.query != null ? req.query : queryOf(req.path)
61. let sf = stateFilter(q)
62. if (sf.bad != null) { return sf.bad }
63. let pr = q.project != null && q.project != '' ? q.project : null
64. let rows = ticketRows(pr, sf.state)
65. if (wantsMarkdown(req)) { return markdownReply(listDocument(rows, filterLabel(pr, sf.state))) }
66. return { tickets = rows }
67. }
69. // the filters of a list, for the Markdown heading ('' = none)
70. filterLabel = (project, state) => {
71. let parts = []
72. if (project != null) { parts.push('project ' + project) }
73. if (state != null) { parts.push('state ' + state) }
74. return parts.join(', ')
75. }
77. // the token's user of an API write, or null (→ 401)
78. apiUser = (req) => { return userOfBearer(req.headers['authorization']) }
80. // WHO WRITES, for the endpoints an app's KEY may also use (ticket #21: create a ticket, comment, change the state):
81. // { user } for a user's token, { conn } for a project key (connections.hl), null = 401 (checked before the body)
82. apiAuth = (req) => {
83. let h = req.headers['authorization']
84. let u = userOfBearer(h)
85. if (u != null) { return { user = u } }
86. let c = connectionOfKey(h)
87. return c != null ? { conn = c } : null
88. }
90. // the acting user inside project `projectId`: { user } or { response }. A key reaches ITS project only and names the
91. // person by `X-Tickets-Identity`; the project's roles then decide as for any user.
92. actorIn = (auth, req, projectId) => {
93. if (auth.user != null) { return { user = auth.user } }
94. if (projectId == null || auth.conn.project != projectId) { return { response = reply(403, { error = 'this key belongs to another project' field = '' }) } }
95. let a = personOf(req.headers['x-tickets-identity'])
96. if (a.error != null) { return { response = reply(403, { error = a.error field = '' }) } }
97. return { user = a.user }
98. }
100. // POST /api/tickets { project, … } and POST /api/projects/:slug/tickets { … }
101. createFromApi = (project, b, auth, req) => {
102. let pr = projectByRef(project)
103. let w = actorIn(auth, req, pr != null ? pr.id : null)
104. if (w.response != null) { return w.response }
105. let user = w.user
106. let r = createTicket(project, b.subject, b.summary, user, b.source, b.assignee)
107. if (r.forbidden == true) { return reply(403, { error = r.error field = r.field }) }
108. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
109. if (!r.existed) { emit client ticketCreated(r.ticket) }
110. return reply(r.existed ? 200 : 201, { ticket = r.ticket existed = r.existed })
111. }
113. postTicket = (route, req) => {
114. if (req.method == 'GET') { return listTickets(route, req) }
115. if (req.method != 'POST') { return fail(405, 'GET or POST') }
116. let u = apiAuth(req)
117. if (u == null) { return unauthorized() }
118. let rb = readBody(req, ['project' 'subject'], ['summary' 'source' 'assignee'])
119. if (rb.bad != null) { return refuse(rb.bad) }
120. return createFromApi(rb.body.project, rb.body, u, req)
121. }
123. projectTickets = (route, req) => {
124. let slug = route.params.slug
125. if (req.method == 'GET') {
126. if (projectByAnySlug(slug) == null) { return fail(404, 'no such project') }
127. let q = req.query != null ? req.query : queryOf(req.path)
128. let sf = stateFilter(q)
129. if (sf.bad != null) { return sf.bad }
130. let rows = ticketRows(slug, sf.state)
131. if (wantsMarkdown(req)) { return markdownReply(listDocument(rows, filterLabel(slug, sf.state))) }
132. return { tickets = rows }
133. }
134. if (req.method != 'POST') { return fail(405, 'GET or POST') }
135. let u = apiAuth(req)
136. if (u == null) { return unauthorized() }
137. let rb = readBody(req, ['subject'], ['summary' 'source' 'assignee'])
138. if (rb.bad != null) { return refuse(rb.bad) }
139. return createFromApi(slug, rb.body, u, req)
140. }
142. getOne = (t, req) => {
143. if (req.method != 'GET') { return fail(405, 'GET only') }
144. if (t == null) { return fail(404, 'no such ticket') }
145. let data = ticketWithEvents(t)
146. if (wantsMarkdown(req)) { return markdownReply(ticketDocument(data)) }
147. return data
148. }
150. commentOnTicket = (t, req) => {
151. if (req.method != 'POST') { return fail(405, 'POST only') }
152. let auth = apiAuth(req)
153. if (auth == null) { return unauthorized() }
154. let rb = readBody(req, ['text'], [])
155. if (rb.bad != null) { return refuse(rb.bad) }
156. if (t == null) { return fail(404, 'no such ticket') }
157. let w = actorIn(auth, req, t.project)
158. if (w.response != null) { return w.response }
159. let u = w.user
160. let b = rb.body
161. let r = addComment(t.id, u, b.text)
162. if (r.error == 'no such ticket') { return fail(404, r.error) }
163. if (r.forbidden == true) { return reply(403, { error = r.error field = r.field }) }
164. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
165. emit client ticketEvent(r.ticket.id, pageEventOf(r.event), r.ticket)
166. return reply(201, r)
167. }
169. stateOfTicket = (t, req) => {
170. if (req.method != 'POST') { return fail(405, 'POST only') }
171. let auth = apiAuth(req)
172. if (auth == null) { return unauthorized() }
173. let rb = readBody(req, ['state'], ['text'])
174. if (rb.bad != null) { return refuse(rb.bad) }
175. if (t == null) { return fail(404, 'no such ticket') }
176. let w = actorIn(auth, req, t.project)
177. if (w.response != null) { return w.response }
178. let u = w.user
179. let b = rb.body
180. let r = changeState(t.id, b.state, u, b.text)
181. if (r.error == 'no such ticket') { return fail(404, r.error) }
182. if (r.forbidden == true) { return reply(403, { error = r.error field = r.field }) }
183. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
184. emit client ticketEvent(r.ticket.id, pageEventOf(r.event), r.ticket)
185. if (r.assignEvent != null) { emit client ticketEvent(r.ticket.id, pageEventOf(r.assignEvent), r.ticket) }
186. emit client ticketsRelated(relatedViews(r.ticket.id, []))
187. return reply(201, r)
188. }
190. // POST …/assign { assignee } (ticket #20): a member's display name (or users id, or ident id); '' = nobody.
191. // Needs the role edit or admin → else 403.
192. assignOfTicket = (t, req) => {
193. if (req.method != 'POST') { return fail(405, 'POST only') }
194. let u = apiUser(req)
195. if (u == null) { return unauthorized() }
196. let rb = readBody(req, [], ['assignee'])
197. if (rb.bad != null) { return refuse(rb.bad) }
198. if (rb.body.assignee == null) { return refuse({ error = "field 'assignee' is required: a member's name, or an empty string for nobody" field = 'assignee' }) }
199. if (t == null) { return fail(404, 'no such ticket') }
200. let who = ''
201. if (rb.body.assignee.trim() != '') {
202. let f = userByRef(rb.body.assignee, t.project)
203. if (f.error != null) { return refuse({ error = f.error field = 'assignee' }) }
204. who = f.user.id
205. }
206. let r = assignTicket(t.id, u, who)
207. if (r.forbidden == true) { return reply(403, { error = r.error field = r.field }) }
208. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
209. emit client ticketEvent(r.ticket.id, pageEventOf(r.event), r.ticket)
210. return reply(201, r)
211. }
213. // POST …/edit { subject?, summary? } (ticket #8): the token's user must be the ticket's author
214. editOfTicket = (t, req) => {
215. if (req.method != 'POST') { return fail(405, 'POST only') }
216. let u = apiUser(req)
217. if (u == null) { return unauthorized() }
218. let rb = readBody(req, [], ['subject' 'summary'])
219. if (rb.bad != null) { return refuse(rb.bad) }
220. if (t == null) { return fail(404, 'no such ticket') }
221. let b = rb.body
222. let r = editTicket(t.id, u, b.subject, b.summary)
223. if (r.error == 'no such ticket') { return fail(404, r.error) }
224. if (r.forbidden == true) { return reply(403, { error = r.error }) }
225. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
226. emit client ticketEvent(r.ticket.id, pageEventOf(r.event), r.ticket)
227. emit client ticketsRelated(relatedViews(r.ticket.id, []))
228. return reply(201, r)
229. }
231. // RELATIONS (ticket #4, mission 017; store.hl "relations"): a ticket is named as
232. // `<project>#<number>` or by its UUID. Who may: a member with the role edit or admin in either ticket's project → else 403.
233. // POST …/parent { parent }: set the parent; `"parent": ""` removes it.
234. // POST …/blocked-by { add } or { remove }: this ticket is (no longer) blocked by that one.
235. // 201 { ticket, event (kind link) }; the ticket rows and every open page of the tickets involved follow.
236. linkReply = (r) => {
237. if (r.error == 'no such ticket') { return fail(404, r.error) }
238. if (r.forbidden == true) { return reply(403, { error = r.error }) }
239. if (r.error != null) { return refuse({ error = r.error field = r.field }) }
240. emit client ticketEvent(r.ticket.id, pageEventOf(r.event), r.ticket)
241. emit client ticketsRelated(r.related)
242. return reply(201, { ticket = r.ticket event = r.event })
243. }
245. parentOfTicket = (t, req) => {
246. if (req.method != 'POST') { return fail(405, 'POST only') }
247. let u = apiUser(req)
248. if (u == null) { return unauthorized() }
249. let rb = readBody(req, [], ['parent'])
250. if (rb.bad != null) { return refuse(rb.bad) }
251. if (rb.body.parent == null) { return refuse({ error = "field 'parent' is required: <project>#<number>, or an empty string to remove the parent" field = 'parent' }) }
252. if (t == null) { return fail(404, 'no such ticket') }
253. return linkReply(setParent(t.id, u, rb.body.parent))
254. }
256. blockersOfTicket = (t, req) => {
257. if (req.method != 'POST') { return fail(405, 'POST only') }
258. let u = apiUser(req)
259. if (u == null) { return unauthorized() }
260. let rb = readBody(req, [], ['add' 'remove'])
261. if (rb.bad != null) { return refuse(rb.bad) }
262. let b = rb.body
263. if ((b.add == null) == (b.remove == null)) { return refuse({ error = "give exactly one of 'add' or 'remove' (<project>#<number>)" field = b.add == null ? 'add' : 'remove' }) }
264. if (t == null) { return fail(404, 'no such ticket') }
265. let adding = b.add != null
266. return linkReply(changeBlocker(t.id, u, adding ? b.add : b.remove, adding, adding ? 'add' : 'remove'))
267. }
269. getTicket = (route, req) => { return getOne(byRef(route), req) }
270. postComment = (route, req) => { return commentOnTicket(byRef(route), req) }
271. postState = (route, req) => { return stateOfTicket(byRef(route), req) }
272. getProjectTicket = (route, req) => { return getOne(byNumber(route), req) }
273. postProjectComment = (route, req) => { return commentOnTicket(byNumber(route), req) }
274. postProjectState = (route, req) => { return stateOfTicket(byNumber(route), req) }
275. postAssign = (route, req) => { return assignOfTicket(byRef(route), req) }
276. postProjectAssign = (route, req) => { return assignOfTicket(byNumber(route), req) }
277. postEdit = (route, req) => { return editOfTicket(byRef(route), req) }
278. postProjectEdit = (route, req) => { return editOfTicket(byNumber(route), req) }
279. postParent = (route, req) => { return parentOfTicket(byRef(route), req) }
280. postProjectParent = (route, req) => { return parentOfTicket(byNumber(route), req) }
281. postBlockers = (route, req) => { return blockersOfTicket(byRef(route), req) }
282. postProjectBlockers = (route, req) => { return blockersOfTicket(byNumber(route), req) }
284. // ---- PROJECTS AND MEMBERS (ticket #20; store.hl) ---------------------------------------------------
285. // GET /api/projects → { projects (the slugs), details (title, slug, description, id …), states, roles }
286. // POST /api/projects { title, slug?, description? } → 201 { project, members } — any logged-in user opens
287. // a project and is its first admin; the slug is generated from the title unless given
288. // GET /api/projects/:slug → { project, members } (the slug may be an old one)
289. // POST /api/projects/:slug { title?, slug?, description? } → { project } — admin only; a new slug keeps the old one working
290. // POST /api/projects/:slug/members { user, role } — admin only: `user` = a display name, an ident id or a user id of someone
291. // who logged in here; sets (adds / changes) the role: use | edit | admin
292. // POST /api/projects/:slug/members/remove { user } — admin only
293. // POST /api/projects/:slug/invites { role, uses?, days?, email? } — admin only: an ident invite link → { url, id, expires, mailed }
294. // GET /api/inbox — the token's user: { pending, review }, the tickets assigned to them
295. getProjects = (route, req) => {
296. if (req.method == 'POST') { return postNewProject(req) }
297. if (req.method != 'GET') { return fail(405, 'GET or POST') }
298. let details = []
299. for (p of projectRecords()) { details.push(projectRowOf(p)) }
300. return { projects = projectNames() details = details states = states roles = roles }
301. }
303. // a refusal of the store: 403 when the role is missing, else 400
304. denied = (r) => {
305. if (r.forbidden == true) { return reply(403, { error = r.error field = r.field }) }
306. return refuse({ error = r.error field = r.field })
307. }
309. postNewProject = (req) => {
310. let u = apiUser(req)
311. if (u == null) { return unauthorized() }
312. let rb = readBody(req, ['title'], ['slug' 'description'])
313. if (rb.bad != null) { return refuse(rb.bad) }
314. let r = createProject(u, rb.body.title, rb.body.slug, rb.body.description)
315. if (r.error != null) { return denied(r) }
316. return reply(201, r)
317. }
319. getProject = (route, req) => {
320. let p = projectByAnySlug(route.params.slug)
321. if (req.method == 'GET') {
322. if (p == null) { return fail(404, 'no such project') }
323. return { project = projectRowOf(p) members = memberRows(p.id) }
324. }
325. if (req.method != 'POST') { return fail(405, 'GET or POST') }
326. let u = apiUser(req)
327. if (u == null) { return unauthorized() }
328. let rb = readBody(req, [], ['title' 'slug' 'description'])
329. if (rb.bad != null) { return refuse(rb.bad) }
330. if (p == null) { return fail(404, 'no such project') }
331. let r = updateProject(p.id, u, rb.body.title, rb.body.slug, rb.body.description)
332. if (r.error != null) { return denied(r) }
333. return reply(200, r)
334. }
336. postMembers = (route, req) => {
337. if (req.method != 'POST') { return fail(405, 'POST only') }
338. let p = projectByAnySlug(route.params.slug)
339. let u = apiUser(req)
340. if (u == null) { return unauthorized() }
341. let rb = readBody(req, ['user' 'role'], [])
342. if (rb.bad != null) { return refuse(rb.bad) }
343. if (p == null) { return fail(404, 'no such project') }
344. let f = userByRef(rb.body.user, null)
345. if (f.error != null) { return refuse({ error = f.error field = 'user' }) }
346. let r = setMemberRole(p.id, u, f.user.id, rb.body.role)
347. if (r.error != null) { return denied(r) }
348. return reply(200, r)
349. }
351. postMemberRemove = (route, req) => {
352. if (req.method != 'POST') { return fail(405, 'POST only') }
353. let p = projectByAnySlug(route.params.slug)
354. let u = apiUser(req)
355. if (u == null) { return unauthorized() }
356. let rb = readBody(req, ['user'], [])
357. if (rb.bad != null) { return refuse(rb.bad) }
358. if (p == null) { return fail(404, 'no such project') }
359. let f = userByRef(rb.body.user, p.id)
360. if (f.error != null) { return refuse({ error = f.error field = 'user' }) }
361. let r = removeMember(p.id, u, f.user.id)
362. if (r.error != null) { return denied(r) }
363. return reply(200, r)
364. }
366. // an invite is only for an admin; ident makes the link (invites.hl)
367. makeInvite = (p, u, role, uses, days, email) => {
368. if (!isAdminOf(p.id, u)) { return { error = 'only an admin of the project can invite' field = '' forbidden = true } }
369. if (!roles.includes(role)) { return { error = 'role must be one of: ' + roles.join(', ') field = 'role' } }
370. let n = uses == null ? 1 : toNumber(uses)
371. let d = days == null ? 7 : toNumber(days)
372. if (n == null || n < 1 || n > 1000) { return { error = "'uses' must be a number from 1 to 1000" field = 'uses' } }
373. if (d == null || d < 1 || d > 90) { return { error = "'days' must be a number from 1 to 90" field = 'days' } }
374. return createInvite(p.id, role, n, d, email)
375. }
376. postInvites = (route, req) => {
377. if (req.method != 'POST') { return fail(405, 'POST only') }
378. let p = projectByAnySlug(route.params.slug)
379. let u = apiUser(req)
380. if (u == null) { return unauthorized() }
381. let rb = readBody(req, ['role'], ['uses' 'days' 'email'])
382. if (rb.bad != null) { return refuse(rb.bad) }
383. if (p == null) { return fail(404, 'no such project') }
384. let b = rb.body
385. let r = makeInvite(p, u, b.role, b.uses, b.days, b.email)
386. if (r.error != null) { return denied(r) }
387. return reply(201, r)
388. }
390. getInbox = (route, req) => {
391. if (req.method != 'GET') { return fail(405, 'GET only') }
392. let u = apiUser(req)
393. if (u == null) { return unauthorized() }
394. return inboxRows(u)
395. }
397. // ---- CONNECTING AN APP (ticket #21; connections.hl) --------------------------------------------------
398. // GET /connect?app=&label=&return=&state= — the app sends the person here; the request is stored and the browser goes to
399. // the page /connect/<nonce> (components/connect.hl), where they pick or make a project and confirm.
400. // POST /api/connect/exchange { code } — the app's SERVER swaps the one-time code for the project's key:
401. // 200 { key, project (slug), title, api }; 400 for an unknown, used or expired code. The key is shown here ONCE.
402. // GET /api/projects/:slug/connections — who is connected (public, like the project page)
403. // POST /api/projects/:slug/connections/remove { id } — an admin disconnects; the key is dead at once
404. connectStart = (route, req) => {
405. if (req.method != 'GET') { return htmlPage(405, 'Connect', 'GET only') }
406. let q = req.query != null ? req.query : {}
407. let r = createRequest(q.app, q.label, q['return'], q.state)
408. if (r.error != null) { return htmlPage(400, 'Connect', r.error) }
409. let to = '/connect/' + r.nonce
410. return new Response('continue at ' + to, { status = 302 headers = { 'Location' = to 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
411. }
413. connectExchange = (route, req) => {
414. if (req.method != 'POST') { return fail(405, 'POST only') }
415. let rb = readBody(req, ['code'], [])
416. if (rb.bad != null) { return refuse(rb.bad) }
417. let r = exchangeConnectCode(rb.body.code)
418. if (r.error != null) { return refuse({ error = r.error field = 'code' }) }
419. emit client connectionsChanged(r.project)
420. return new Response(JSON.stringify(r), { status = 200 headers = { 'Content-Type' = 'application/json; charset=utf-8' 'Cache-Control' = 'no-store' } })
421. }
423. projectConnections = (route, req) => {
424. if (req.method != 'GET') { return fail(405, 'GET only') }
425. let p = projectByAnySlug(route.params.slug)
426. if (p == null) { return fail(404, 'no such project') }
427. return { connections = connectionRows(p.id) }
428. }
430. projectDisconnect = (route, req) => {
431. if (req.method != 'POST') { return fail(405, 'POST only') }
432. let p = projectByAnySlug(route.params.slug)
433. let u = apiUser(req)
434. if (u == null) { return unauthorized() }
435. let rb = readBody(req, ['id'], [])
436. if (rb.bad != null) { return refuse(rb.bad) }
437. if (p == null) { return fail(404, 'no such project') }
438. let r = disconnect(p.id, u, rb.body.id)
439. if (r.error != null) { return denied(r) }
440. emit client connectionsChanged(p.slug)
441. return reply(200, r)
442. }
444. // OLD PAGE URLS (`/tickets/<old global number>`, also `/tickets/<uuid>`) move for good
445. // to `/projects/<slug>/<number>`
446. oldTicketPage = (route, req) => {
447. let t = ticketByRef(route.params.ref)
448. if (t == null) { return new Response('no such ticket', { status = 404 headers = { 'Content-Type' = 'text/plain; charset=utf-8' } }) }
449. let to = ticketHref(projectSlugOf(t), t.number)
450. return new Response('moved to ' + to, { status = 301 headers = { 'Location' = to 'Content-Type' = 'text/plain; charset=utf-8' } })
451. }
453. // ---- THE LOGIN BUTTON'S RETURN (ticket #7; ident README "How apps use ident") -------------
454. // The shell's "Log in with ident" goes to <ident>/login?key=<IDENT_API_KEY>&return=
455. // <TICKETS_PUBLIC_URL>/login/callback; ident sends the browser back here with ?ident_code=.
456. // The code is exchanged SERVER SIDE (users.hl exchangeCode, key + secret) for the per-app
457. // identity id; its tickets user (made at the first login) goes into THIS browser's hl:web
458. // session (`req.session`, the cookie's — hybriel#11; minted here when the browser brought none), then → the
459. // page the login started from (`?next=`, ticket #10, safeNext) or `/`, where the shell asks
460. // for a display name if there is none yet.
461. // (The identity selector logs in through the shell's face `identLogin` instead — no reload.)
462. htmlPage = (status, title, text) => {
463. let body = '<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>tickets | ' + title + '</title><style>body{margin:0;padding:1.5rem 1rem;font:16px/1.5 system-ui,sans-serif;color:rgb(195, 200, 205);background:rgb(25, 30, 35)}main{max-width:34rem;margin:0 auto;display:grid;gap:1rem}h1{margin:0;font-size:1.3rem;color:rgb(245, 250, 255)}p{margin:0}a{color:#c586c0}.error{color:#f44747}</style></head><body><main><h1>' + title + '</h1><p id="error" class="error">' + text.replaceAll('&', '&amp;').replaceAll('<', '&lt;').replaceAll('>', '&gt;') + '</p><p><a id="home" href="/">back to the tickets</a></p></main></body></html>'
464. return new Response(body, { status = status headers = { 'Content-Type' = 'text/html; charset=utf-8' 'Cache-Control' = 'no-store' } })
465. }
467. // BACK TO THE PAGE (ticket #10): login.js puts `?next=<path + query of the page>` into the
468. // button's return URL. Only a same-origin PATH goes: it starts with ONE `/` (not `//`, no
469. // backslash — `/\host` is another host to some browsers), only URL-safe characters (no
470. // scheme, no spaces, no control characters), at most 500 chars, never /login/… itself.
471. // Anything else → `/`.
472. nextChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~/?&=%+,;@!$()*:'
473. safeNext = (want) => {
474. if (want == null || hlTypeName(want) != 'String' || want == '' || want.length > 500) { return '/' }
475. if (want.slice(0, 1) != '/' || want.slice(0, 2) == '//' || want.slice(0, 7) == '/login/') { return '/' }
476. let i = 0
477. while (i < want.length) {
478. if (!nextChars.includes(want[i])) { return '/' }
479. i = i + 1
480. }
481. return want
482. }
484. loginCallback = (route, req) => {
485. if (req.method != 'GET') { return htmlPage(405, 'Login failed', 'GET only') }
486. let q = req.query != null ? req.query : {}
487. let code = q.ident_code
488. if (code == null || code == '') { return htmlPage(400, 'Login failed', 'ident sent no login code') }
489. let x = exchangeCode(code)
490. if (x.error != null) { return htmlPage(400, 'Login failed', x.error) }
491. let u = ensureUser(x.identity)
492. if (u == null) { return htmlPage(500, 'Login failed', 'could not store the user') }
493. // an INVITE (ident#22, invites.hl): ident sends `invite=<id>` with the code; only when ident says this
494. // identity accepted it does the person join the project, with the invite's role
495. let joined = null
496. if (q.invite != null && q.invite != '') {
497. let a = acceptedInvite(q.invite, x.identity)
498. if (a.error != null) { return htmlPage(400, 'Invite failed', a.error) }
499. let jp = projectByRef(a.project)
500. if (jp == null || !roles.includes(a.role)) { return htmlPage(400, 'Invite failed', 'the invite is for a project or role that does not exist here') }
501. addMember(jp.id, u.id, a.role)
502. joined = jp
503. }
504. let s = req.session
505. let fresh = s == null
506. if (fresh) { s = server.sessions.mint() }
507. s.user = { id = u.id }
508. s.data.tag = randomBytes(16)
509. server.sessions.save(s)
510. let to = joined != null ? '/projects/' + joined.slug : safeNext(q.next)
511. let res = new Response('logged in', { status = 302 headers = { 'Location' = to 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
512. if (fresh) { res.headers['Set-Cookie'] = server.sessions.cookieHeader(s.id) }
513. return res
514. }
516. routes = [
517. { pattern = "/favicon.ico" direct = "" }
518. { pattern = "/login/callback" function = loginCallback }
519. { pattern = "/login.js" file = "./login.js" headers = { 'Cache-Control' = 'no-cache' } }
520. // ticket #12 (mission 024): the Markdown editor <md-editor>, vendored from worldapi-components
521. { pattern = "/md-editor.js" file = "./shared/md-editor.js" headers = { 'Cache-Control' = 'no-cache' } }
522. { pattern = "/api/tickets" function = postTicket }
523. { pattern = "/api/tickets/:ref" function = getTicket }
524. { pattern = "/api/tickets/:ref/comments" function = postComment }
525. { pattern = "/api/tickets/:ref/state" function = postState }
526. { pattern = "/api/tickets/:ref/edit" function = postEdit }
527. { pattern = "/api/tickets/:ref/assign" function = postAssign }
528. { pattern = "/api/tickets/:ref/parent" function = postParent }
529. { pattern = "/api/tickets/:ref/blocked-by" function = postBlockers }
530. { pattern = "/api/projects" function = getProjects }
531. { pattern = "/api/inbox" function = getInbox }
532. { pattern = "/api/projects/:slug" function = getProject }
533. { pattern = "/api/projects/:slug/members" function = postMembers }
534. { pattern = "/api/projects/:slug/members/remove" function = postMemberRemove }
535. { pattern = "/api/projects/:slug/invites" function = postInvites }
536. { pattern = "/api/connect/exchange" function = connectExchange }
537. { pattern = "/api/projects/:slug/connections" function = projectConnections }
538. { pattern = "/api/projects/:slug/connections/remove" function = projectDisconnect }
539. { pattern = "/connect" function = connectStart }
540. { pattern = "/api/projects/:slug/tickets" function = projectTickets }
541. { pattern = "/api/projects/:slug/tickets/:number" function = getProjectTicket }
542. { pattern = "/api/projects/:slug/tickets/:number/comments" function = postProjectComment }
543. { pattern = "/api/projects/:slug/tickets/:number/state" function = postProjectState }
544. { pattern = "/api/projects/:slug/tickets/:number/edit" function = postProjectEdit }
545. { pattern = "/api/projects/:slug/tickets/:number/assign" function = postProjectAssign }
546. { pattern = "/api/projects/:slug/tickets/:number/parent" function = postProjectParent }
547. { pattern = "/api/projects/:slug/tickets/:number/blocked-by" function = postProjectBlockers }
548. { pattern = "/" component = TicketList }
549. { pattern = "/project/:projectName" component = TicketList }
550. { pattern = "/projects/:projectName" component = TicketList }
551. { pattern = "/state/:stateSlug" component = TicketList }
552. { pattern = "/project/:projectName/state/:stateSlug" component = TicketList }
553. { pattern = "/inbox" component = Inbox }
554. { pattern = "/new-project" component = NewProject }
555. { pattern = "/connect/:nonce" component = Connect }
556. { pattern = "/projects/:projectSlug/settings" component = Settings }
557. { pattern = "/you" component = You }
558. { pattern = "/projects/:projectSlug/:ticketNumber" component = Ticket }
559. { pattern = "/tickets/:ref" function = oldTicketPage }
560. ]
562. // WHO GETS THE PUSH: tickets and events are public (reading needs no login). A frame
563. // reaches a connection only if a mounted component listens for it.
564. // `signedIn` / `signedOut` (ticket #7) go to the tabs of ONE session: the one whose login
565. // carries that random tag (session.data.tag, set at login) — every page of it switches to
566. // logged in / out without a reload.
567. tagOf = (session) => { return session != null && session.data != null ? session.data.tag : null }
568. audience = {
569. ticketCreated = (row, session) => { return true }
570. ticketEvent = (ticketId, ev, row, session) => { return true }
571. // ticket #4: the relation views (store.hl relationViewOf) of a ticket and its related ones
572. ticketsRelated = (views, session) => { return true }
573. // ticket #21: an app was connected / disconnected — the project page refreshes its line
574. connectionsChanged = (slug, session) => { return true }
575. signedIn = (tag, info, session) => { return tag != null && tagOf(session) == tag }
576. signedOut = (tag, session) => { return tag != null && tagOf(session) == tag }
577. }
579. sessionDir = env('TICKETS_SESSIONS') != null ? env('TICKETS_SESSIONS') : null
580. port = env('TICKETS_PORT') != null ? toNumber(env('TICKETS_PORT')) : 8350
581. // THE LISTENER's interface (mission 010, deploy to Byrodin): hl:web reads HL_HOST (or HOST)
582. // itself (hybriel#24): 127.0.0.1 on Byrodin behind nginx; unset = 0.0.0.0 (dev on Loreana).
583. // TICKETS_WATCH=0 turns the dev watcher off (the container: a deploy is an rsync + restart,
584. // half-copied .hl files must not be re-analysed); unset = on, as before.
585. watching = env('TICKETS_WATCH') != '0'
586. // THE MIGRATION of ticket #20 (migrate.hl): idempotent, runs at every start
587. for (line of migrateAll()) { console.log('migrated: ' + line) }
588. server = new WebFramework(routes = routes, styles = styles, minify = true, port = port, watchMode = watching)
590. // THE GLOBAL ERROR HANDLER (ticket #7): a plugin's failure — above all hl:fetch's refused /
591. // timed-out exchange with ident (users.hl exchangeCode) — arrives here instead of aborting the
592. // request with a 500 that shows source paths; the failed call yields null and the caller answers
593. // it ("ident did not answer"). Every absorbed error is logged.
594. on Error(e) { console.log('error absorbed: ' + e.message) }