tickets

6.6 KB

1. // lib/events.hl — THE HISTORY OF A TICKET: an append-only event per change. Statics only, the server realm.
2. // eventsTable pk @id index @ticket APPEND ONLY: { ticket (ticket @id), seq
3. // (1, 2, … per ticket), kind, author, user?, text, from, to, created, oldId? }
4. // kind = 'created' | 'comment' | 'state' | 'edit' | 'link' | 'assign'
5. // 'assign' (ticket #20): { assignee (users @id, '' = unassigned), previous (users @id, '') }
6. // 'link' (ticket #4, mission 017): { linkKind ('parent' | 'blockedBy'), action
7. // ('set' | 'removed'), other, otherProject, otherNumber, previous?, previousProject?,
8. // previousNumber? } — on the CHILD / the BLOCKED ticket (the one whose relation changed).
9. // 'edit' (ticket #8, mission 014): { oldSubject, oldSummary, subject, summary } —
10. // the values before AND after; the ticket record then carries the new ones.
11. // `user` (users @id, users.hl) since ticket #7: the event's author is that
12. // user's CURRENT display name; `author` keeps the name at writing time.
13. // tickets.hl writes the events (putEvent) together with the ticket record; this file shapes and reads them.
14. import { MPackDB } from 'hl:mpackdb'
15. import { storageDir, countOf, localStamp, ticketHref } from './util.hl'
16. import { nameOfUser } from './users.hl'
17. import { projectSlugOf } from './projects.hl'
18. import { slugOf } from './tickets-helpers.hl'
19. import { markdownBlocks } from './markdown.hl'
21. static eventsTable = new MPackDB(file = storageDir + '/events.db', primaryKey = '@id', indexes = ['@ticket'])
23. // ---- writing -------------------------------------------------------------------------------------
24. // appends one event record (built field by field by tickets.hl); answers its id, or null (eventsError says why)
25. static putEvent = (rec) => { return eventsTable.put(rec) }
26. static eventsError = () => { return eventsTable.lastError() }
27. // the API row of a stored event
28. static eventRowAt = (eventId, t) => { return eventRowOf(eventsTable.fetch(eventId), t) }
30. // ---- reading -------------------------------------------------------------------------------------
31. // the history of a ticket (a record), oldest first: by stored time, then seq
32. static historyOf = (t) => {
33. out = []
34. all = eventsTable.find('ticket', t.id)
35. if (countOf(all) == 0) { return out }
36. for (e of all) { out.push(eventRowOf(e, t)) }
37. let i = 1
38. while (i < out.length) {
39. let cur = out[i]
40. let j = i - 1
41. while (j >= 0 && (out[j].createdMs > cur.createdMs || (out[j].createdMs == cur.createdMs && out[j].seq > cur.seq))) {
42. out[j + 1] = out[j]
43. j = j - 1
44. }
45. out[j + 1] = cur
46. i = i + 1
47. }
48. return out
49. }
51. // a ticket from before the login has no createdBy: the free-text author of its 'created' event
52. static creatorNameOf = (t) => {
53. all = eventsTable.find('ticket', t.id)
54. if (countOf(all) == 0) { return '' }
55. for (e of all) { if (e.kind == 'created') { return e.author != null ? e.author : '' } }
56. return ''
57. }
59. // ---- the shapes ----------------------------------------------------------------------------------
60. static eventRowOf = (e, t) => {
61. let kind = e.kind
62. // computed BEFORE the literal: inside a literal that has an `id` entry, a called function's
63. // parameter named `id` read that entry instead (mission 011, reported as a Hybriel issue)
64. who = e.user != null ? nameOfUser(e.user) : e.author
65. let label = kind == 'created' ? 'opened the ticket' : (kind == 'state' ? 'changed the state' : (kind == 'edit' ? 'edited the ticket' : 'commented'))
66. if (kind == 'link') { label = linkLabelOf(e) }
67. let assignedTo = ''
68. let assignedWas = ''
69. if (kind == 'assign') {
70. assignedTo = e.assignee != null && e.assignee != '' ? nameOfUser(e.assignee) : ''
71. assignedWas = e.previous != null && e.previous != '' ? nameOfUser(e.previous) : ''
72. label = assignedTo != '' ? 'assigned the ticket to ' + assignedTo : 'unassigned the ticket' + (assignedWas != '' ? ' (was ' + assignedWas + ')' : '')
73. }
74. row = {
75. id = e.id
76. ticket = e.ticket
77. project = t != null ? projectSlugOf(t) : ''
78. number = t != null ? t.number : 0
79. seq = e.seq != null ? e.seq : 0
80. kind = kind
81. author = who
82. userId = e.user != null ? e.user : ''
83. text = e.text != null ? e.text : ''
84. hasText = e.text != null && e.text != ''
85. from = e.from != null ? e.from : ''
86. to = e.to != null ? e.to : ''
87. toSlug = slugOf(e.to)
88. isState = kind == 'state'
89. isComment = kind == 'comment'
90. isCreated = kind == 'created'
91. label = label
92. when = localStamp(e.created)
93. createdMs = e.created
94. }
95. // ticket #8: only an edit event carries these (the JSON of every other event is unchanged)
96. if (kind == 'edit') {
97. row.isEdit = true
98. row.oldSubject = e.oldSubject != null ? e.oldSubject : ''
99. row.oldSummary = e.oldSummary != null ? e.oldSummary : ''
100. row.newSubject = e.subject != null ? e.subject : ''
101. row.newSummary = e.summary != null ? e.summary : ''
102. row.subjectChanged = row.oldSubject != row.newSubject
103. row.summaryChanged = row.oldSummary != row.newSummary
104. }
105. // ticket #4: only a link event carries these
106. if (kind == 'link') {
107. row.isLink = true
108. row.linkKind = e.linkKind
109. row.linkAction = e.action
110. row.otherRef = e.otherProject + ' #' + e.otherNumber
111. row.otherHref = ticketHref(e.otherProject, e.otherNumber)
112. row.previousRef = e.previous != null ? e.previousProject + ' #' + e.previousNumber : ''
113. }
114. // ticket #20: only an assign event carries these
115. if (kind == 'assign') {
116. row.isAssign = true
117. row.assignee = assignedTo
118. row.previousAssignee = assignedWas
119. }
120. return row
121. }
123. // "set the parent to ident.worldapi.org #1", "removed the blocker tickets.worldapi.org #6", …
124. static linkLabelOf = (e) => {
125. other = e.otherProject + ' #' + e.otherNumber
126. if (e.linkKind == 'parent') {
127. if (e.action == 'removed') { return 'removed the parent ' + other }
128. was = e.previous != null ? ' (was ' + e.previousProject + ' #' + e.previousNumber + ')' : ''
129. return 'set the parent to ' + other + was
130. }
131. if (e.action == 'removed') { return 'removed the blocker ' + other }
132. return 'marked it blocked by ' + other
133. }
135. // THE PAGE'S EVENT ROW (ticket #6): the API row + its text as Markdown blocks (`md`), and for an
136. // edit the previous summary's blocks (`oldSummaryMd`) and the new one's (`summaryMd`, the ticket
137. // page takes it over live). Only pages and pushes carry these — the JSON API does not.
138. static pageEventOf = (ev) => {
139. out = {}
140. for (k of ev.keys()) { out[k] = ev[k] }
141. out.md = markdownBlocks(ev.text)
142. if (ev.isEdit == true) {
143. out.oldSummaryMd = markdownBlocks(ev.oldSummary)
144. out.summaryMd = markdownBlocks(ev.newSummary)
145. }
146. return out
147. }
148. static pageEventsOf = (evs) => {
149. out = []
150. for (ev of evs) { out.push(pageEventOf(ev)) }
151. return out
152. }