tickets

11.2 KB

1. // project.hl — tickets.worldapi.org: THE MAP. Config, routes and WHO HEARS WHAT; the logic lives in lib/.
2. //
3. // WHERE THINGS ARE (one line per feature; README.md "Files" has the full list):
4. // tickets, their states and relations (parent / blocked-by) lib/tickets.hl (state names, page shapes: lib/tickets-helpers.hl)
5. // the history of a ticket (events) lib/events.hl
6. // projects, members, roles, slugs lib/projects.hl
7. // users, login through ident, API tokens, sessions lib/users.hl
8. // invites to a project (ident#22) lib/invites.hl
9. // connecting an app to a project (ticket #21) lib/connections.hl
10. // Markdown in text fields / the Markdown read view lib/markdown.hl / lib/mdview.hl
11. // the JSON API + /login/callback, /connect, /tickets/:ref lib/api.hl (plumbing: lib/api-helpers.hl, lib/jsoncheck.hl)
12. // the ticket #20 data migration (every start) lib/migrate.hl
13. // the ticket-file format of the import lib/import.hl (the import tool: tools/import.hl)
14. // shared small helpers (env, storage dir, URLs, sorting, Vienna time) lib/util.hl
15. // pages: shell, list, ticket, inbox, you, new project, settings, connect components/*.hl; CSS components/styles.hl
16. import WebFramework from 'hl:web'
17. import { env } from 'hl:proc'
19. import Styles from './components/styles.hl'
20. import { dark, darker } from './shared/tokens.hl'
21. import { migrateAll } from './lib/migrate.hl'
22. import { tagOf } from './lib/users.hl'
23. import { postTicket, getTicket, postComment, postState, postEdit, postAssign, postParent, postBlockers, getProjects, getInbox, getProject, postMembers, postMemberRemove, postInvites, connectExchange, projectConnections, projectDisconnect, connectStart, projectTickets, getProjectTicket, postProjectComment, postProjectState, postProjectEdit, postProjectAssign, postProjectParent, postProjectBlockers, oldTicketPage, oldProjectPage, oldProjectTicketPage, loginCallback } from './lib/api.hl'
25. import TicketList from './components/ticket_list.hl'
26. import Ticket from './components/ticket.hl'
27. import Inbox from './components/inbox.hl'
28. import You from './components/you.hl'
29. import NewProject from './components/new_project.hl'
30. import Settings from './components/settings.hl'
31. import Connect from './components/connect.hl'
33. static siteName = "tickets"
35. appTitle = siteName
36. styles = Styles
38. // ---- THE INSTALLABLE APP (mission 046), the same way calendar.worldapi.org does it: hl:web's own web app manifest
39. // (/__hl/manifest.webmanifest, linked from every head with the apple-touch-icon and theme-color) and service worker
40. // (/__hl/sw.js) from these settings — no JavaScript of ours. Icons in icons/ (icon.svg, a ticket stub, is the source;
41. // the PNGs and favicon.ico are rendered from it with rsvg-convert / magick, README "PWA"). The theme colour is the
42. // header's background (darker, as tracker), the splash background the page's (dark) — both off the tokens, not written out again.
43. appThemeColor = darker.value
44. appBackgroundColor = dark.value
45. appIcons = [
46. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'any' }
47. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'any' }
48. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'maskable' }
49. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'maskable' }
50. ]
51. appTouchIcon = '/icons/apple-touch-icon.png'
52. appFavicon = '/icons/icon.svg'
53. // OFFLINE: the shell and `/` — `/` IS the ticket list, so offline it shows the list as this browser last loaded it,
54. // and the shell (components/main.hl) says "You are offline". Its value-form emits are never queued. Other pages are
55. // not kept, except a project list (/<slug>, same component) this browser visited; the rest get hl:web's
56. // "Unavailable offline" page.
57. offline = [ TicketList ]
59. // ---- THE ROUTES: files, the function routes (lib/api.hl), the pages (components/) ----------------
60. routes = [
61. { pattern = "/favicon.ico" file = "./icons/favicon.ico" headers = { 'Cache-Control' = 'no-cache' } }
62. // the installable app (mission 046): the icons (manifest and service worker are hl:web's own, from appIcons / offline)
63. { pattern = "/icons/icon-192.png" file = "./icons/icon-192.png" headers = { 'Cache-Control' = 'no-cache' } }
64. { pattern = "/icons/icon-512.png" file = "./icons/icon-512.png" headers = { 'Cache-Control' = 'no-cache' } }
65. { pattern = "/icons/apple-touch-icon.png" file = "./icons/apple-touch-icon.png" headers = { 'Cache-Control' = 'no-cache' } }
66. { pattern = "/icons/icon.svg" file = "./icons/icon.svg" headers = { 'Cache-Control' = 'no-cache' } }
67. // the login button's return (ticket #7): it needs the request's session and the framework's session store, BY REFERENCE
68. { pattern = "/login/callback" function = (route, req) => { return loginCallback(route, &req, &server.sessions) } }
69. { pattern = "/login.js" file = "./login.js" headers = { 'Cache-Control' = 'no-cache' } }
70. // ticket #12 (mission 024): the Markdown editor <md-editor>, vendored from worldapi-components
71. { pattern = "/md-editor.js" file = "./shared/md-editor.js" headers = { 'Cache-Control' = 'no-cache' } }
72. { pattern = "/api/tickets" function = postTicket }
73. { pattern = "/api/tickets/:ref" function = getTicket }
74. { pattern = "/api/tickets/:ref/comments" function = postComment }
75. { pattern = "/api/tickets/:ref/state" function = postState }
76. { pattern = "/api/tickets/:ref/edit" function = postEdit }
77. { pattern = "/api/tickets/:ref/assign" function = postAssign }
78. { pattern = "/api/tickets/:ref/parent" function = postParent }
79. { pattern = "/api/tickets/:ref/blocked-by" function = postBlockers }
80. { pattern = "/api/projects" function = getProjects }
81. { pattern = "/api/inbox" function = getInbox }
82. { pattern = "/api/projects/:slug" function = getProject }
83. { pattern = "/api/projects/:slug/members" function = postMembers }
84. { pattern = "/api/projects/:slug/members/remove" function = postMemberRemove }
85. { pattern = "/api/projects/:slug/invites" function = postInvites }
86. { pattern = "/api/connect/exchange" function = connectExchange }
87. { pattern = "/api/projects/:slug/connections" function = projectConnections }
88. { pattern = "/api/projects/:slug/connections/remove" function = projectDisconnect }
89. { pattern = "/connect" function = connectStart }
90. { pattern = "/api/projects/:slug/tickets" function = projectTickets }
91. { pattern = "/api/projects/:slug/tickets/:number" function = getProjectTicket }
92. { pattern = "/api/projects/:slug/tickets/:number/comments" function = postProjectComment }
93. { pattern = "/api/projects/:slug/tickets/:number/state" function = postProjectState }
94. { pattern = "/api/projects/:slug/tickets/:number/edit" function = postProjectEdit }
95. { pattern = "/api/projects/:slug/tickets/:number/assign" function = postProjectAssign }
96. { pattern = "/api/projects/:slug/tickets/:number/parent" function = postProjectParent }
97. { pattern = "/api/projects/:slug/tickets/:number/blocked-by" function = postProjectBlockers }
98. { pattern = "/" component = TicketList }
99. { pattern = "/project/:projectName" component = TicketList }
100. { pattern = "/state/:stateSlug" component = TicketList }
101. { pattern = "/project/:projectName/state/:stateSlug" component = TicketList }
102. { pattern = "/inbox" component = Inbox }
103. { pattern = "/new-project" component = NewProject }
104. { pattern = "/connect/:nonce" component = Connect }
105. { pattern = "/projects/:projectSlug/settings" component = Settings }
106. { pattern = "/you" component = You }
107. // OLD PAGE URLS → 301 to the short ones (ticket #25): `/tickets/<old global number or uuid>`, `/projects/<slug>`,
108. // `/projects/<slug>/<number>`, `/projects/<slug>/tickets/<number>`
109. { pattern = "/tickets/:ref" function = oldTicketPage }
110. { pattern = "/projects/:slug" function = oldProjectPage }
111. { pattern = "/projects/:slug/:number" function = oldProjectTicketPage }
112. { pattern = "/projects/:slug/tickets/:number" function = oldProjectTicketPage }
113. // THE SHORT PAGE URLS (ticket #25): the project `/<slug>`, a ticket `/<slug>/<number>`. They match any first
114. // segment, so they come last — and below, after the construction, behind hl:web's own urls too (`lastPage`)
115. { pattern = "/:projectName" component = TicketList lastPage = true }
116. { pattern = "/:projectSlug/:ticketNumber" component = Ticket lastPage = true }
117. ]
119. // WHO GETS THE PUSH: tickets and events are public (reading needs no login). A frame
120. // reaches a connection only if a mounted component listens for it.
121. // `signedIn` / `signedOut` (ticket #7) go to the tabs of ONE session: the one whose login
122. // carries that random tag (session.data.tag, set at login) — every page of it switches to
123. // logged in / out without a reload.
124. audience = {
125. ticketCreated = (row, session) => { return true }
126. ticketEvent = (ticketId, ev, row, session) => { return true }
127. // ticket #4: the relation views (tickets-helpers.hl relationViewOf) of a ticket and its related ones
128. ticketsRelated = (views, session) => { return true }
129. // ticket #21: an app was connected / disconnected — the project page refreshes its line
130. connectionsChanged = (slug, session) => { return true }
131. signedIn = (tag, info, session) => { return tag != null && tagOf(session) == tag }
132. signedOut = (tag, session) => { return tag != null && tagOf(session) == tag }
133. }
135. sessionDir = env('TICKETS_SESSIONS') != null ? env('TICKETS_SESSIONS') : null
136. port = env('TICKETS_PORT') != null ? toNumber(env('TICKETS_PORT')) : 8350
137. // THE LISTENER's interface (mission 010, deploy to Byrodin): hl:web reads HL_HOST (or HOST)
138. // itself (hybriel#24): 127.0.0.1 on Byrodin behind nginx; unset = 0.0.0.0 (dev on Loreana).
139. // TICKETS_WATCH=0 turns the dev watcher off (the container: a deploy is an rsync + restart,
140. // half-copied .hl files must not be re-analysed); unset = on, as before.
141. watching = env('TICKETS_WATCH') != '0'
142. // THE MIGRATION of ticket #20 (lib/migrate.hl): idempotent, runs at every start
143. for (line of migrateAll()) { console.log('migrated: ' + line) }
144. server = new WebFramework(routes = routes, styles = styles, minify = true, port = port, watchMode = watching)
145. // THE SHORT PAGE URLS GO BEHIND hl:web's OWN (ticket #25). The first match answers, and hl:web APPENDS its urls
146. // (/__hl/app.css, /__hl/emit, /__hl/sw.js …, the component modules /components/<file>.hl) to the table while it is
147. // constructed: left where they are, `/:projectSlug/:ticketNumber` answered /__hl/app.css and /components/ticket.hl
148. // with a ticket page. They stay in the table above (hl:web serves the modules of the components routes mount, and
149. // the service worker knows them as pages) and are moved to the end of the router's table here — the one that
150. // answers requests and that the browser gets for its links. A first segment any route answers is a reserved slug
151. // (lib/projects.hl reservedSlugs; the gate checks both).
152. pagesFirst = []
153. pagesLast = []
154. for (r of server.router.routes) { if (r.lastPage == true) { pagesLast[] = r } else { pagesFirst[] = r } }
155. for (r of pagesLast) { pagesFirst[] = r }
156. server.router.routes = pagesFirst
158. // THE GLOBAL ERROR HANDLER (ticket #7): a plugin's failure — above all hl:fetch's refused /
159. // timed-out exchange with ident (users.hl exchangeCode, invites.hl) — arrives here instead of aborting the
160. // request with a 500 that shows source paths; the failed call yields null and the caller answers
161. // it ("ident did not answer"). Every absorbed error is logged.
162. on Error(e) { console.log('error absorbed: ' + e.message) }