The live page lifecycle
Sequence Diagram from the Technical Manual.
Text version
- Note: At start-up, Routes creates both routes for my.page.js without importing it
- 1. Browser to PageRoute /my/: GET /my/
- Optional: First request
- 2. PageRoute /my/: initialise() imports my.page.js and sets isClassBasedRoute and isLive
- 3. PageRoute /my/: storeSessionNow(request, response)
- 4. PageRoute /my/ to KittenPage: new page (your kitten.Page subclass, or KittenPage with html() = default export)
- 5. KittenPage: id = kid-UUID
- 6. KittenPage: request and response set (which sets session)
- 7. KittenPage to kitten.pages: kitten.pages[id] = page
- 8. KittenPage to kitten.events: kittenPageCreate { id }
- 9. KittenPage to Child components: addChild() in your constructor
- Note: If your constructor ended the response, PageRoute starts the connection timer and stops here
- 10. PageRoute /my/ to KittenPage: html({ page, request, response }) as the page, stored as its _tagProps
- 11. KittenPage to PageRoute /my/: kitten.html
- 12. PageRoute /my/: renderHtml() adds ws-connect, and markRoot() adds data-kitten-component and id to the root
- 13. PageRoute /my/ to Browser: 200 text/html
- 14. PageRoute /my/: countStat('pages', path)
- 15. PageRoute /my/ to KittenPage: startConnectionTimer() when the response finishes or closes
- Note: If the page has not connected 10 s after its response finishes, the timer deletes kitten.pages[id]
- 16. Browser to PageSocketRoute /my/default.socket: WebSocket upgrade /my/default.socket?id=kid-UUID
- If: No session cookie
- 17. PageSocketRoute /my/default.socket to Browser: close, without the reload script
- Otherwise: No page with that id that this route rendered for this session
- 18. PageSocketRoute /my/default.socket to Browser: reload script, then close
- Otherwise: Page found
- Optional: Function-based page, first connection
- 19. PageSocketRoute /my/default.socket: import my.page.js and save its on… exports as eventHandlers
- 20. PageSocketRoute /my/default.socket: await request.ws(), ping every 30 s, add close handler
- 21. PageSocketRoute /my/default.socket: validate id, ws.id = id, bind eventHandlers to page, sockets.push(ws)
- If: Page already connected
- 22. PageSocketRoute /my/default.socket to KittenPage: replaceSocket(ws) closes the old socket, onConnect() is not called
- Otherwise: First connection
- 23. PageSocketRoute /my/default.socket to KittenPage: connect(ws, sockets, eventHandlers)
- 24. KittenPage: mix in eventHandlers, listen for message, create everyone and everyoneElse
- 25. KittenPage to Child components: _onConnect() calls onConnect({ page, request, response }) on page and descendants
- 26. KittenPage: listen for kittenSessionDelete on the session
- 27. KittenPage to kitten.events: kittenPageConnect and kittenPageConnect-id with { page }
- Optional: Function-based page, first connection
- 28. Browser to KittenPage: htmx message with HEADERS, data, _componentId, and _ownerId
- 29. KittenPage to kitten.events: kittenPageEvent and kittenPageEvent-id
- 30. KittenPage to Child components: onEventName(data, event, headers) on the first of the owner, the container, its ancestors, and the page that has it
- 31. Child components to KittenPage: update() calls page.send(html)
- 32. KittenPage to Browser: HTML with hx-swap-oob='morph'
- 33. Browser to PageSocketRoute /my/default.socket: socket closes
- 34. PageSocketRoute /my/default.socket: stop pinging and remove socket from sockets
- 35. PageSocketRoute /my/default.socket to KittenPage: _onDisconnect()
- 36. KittenPage to Child components: onDisconnect() on page and descendants, listeners removed
- 37. PageSocketRoute /my/default.socket to kitten.pages: delete kitten.pages[id]
- 38. PageSocketRoute /my/default.socket to kitten.events: kittenPageDelete { id } and kittenPageDelete-id