-
Notifications
You must be signed in to change notification settings - Fork 415
/
session.ts
261 lines (203 loc) · 7.09 KB
/
session.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
import { Adapter } from "./native/adapter"
import { BrowserAdapter } from "./native/browser_adapter"
import { FormSubmitObserver } from "../observers/form_submit_observer"
import { FrameRedirector } from "./frames/frame_redirector"
import { History } from "./drive/history"
import { LinkClickObserver } from "../observers/link_click_observer"
import { Location, Locatable } from "./location"
import { Navigator, NavigatorDelegate } from "./drive/navigator"
import { PageObserver } from "../observers/page_observer"
import { ScrollObserver } from "../observers/scroll_observer"
import { StreamMessage } from "./streams/stream_message"
import { StreamObserver } from "../observers/stream_observer"
import { Action, Position, StreamSource, isAction } from "./types"
import { dispatch } from "../util"
import { View } from "./drive/view"
import { Visit, VisitOptions } from "./drive/visit"
export type TimingData = {}
export class Session implements NavigatorDelegate {
readonly navigator = new Navigator(this)
readonly history = new History(this)
readonly view = new View(this)
adapter: Adapter = new BrowserAdapter(this)
readonly pageObserver = new PageObserver(this)
readonly linkClickObserver = new LinkClickObserver(this)
readonly formSubmitObserver = new FormSubmitObserver(this)
readonly scrollObserver = new ScrollObserver(this)
readonly streamObserver = new StreamObserver(this)
readonly frameRedirector = new FrameRedirector(document.documentElement)
enabled = true
progressBarDelay = 500
started = false
start() {
if (!this.started) {
this.pageObserver.start()
this.linkClickObserver.start()
this.formSubmitObserver.start()
this.scrollObserver.start()
this.streamObserver.start()
this.frameRedirector.start()
this.history.start()
this.started = true
this.enabled = true
}
}
disable() {
this.enabled = false
}
stop() {
if (this.started) {
this.pageObserver.stop()
this.linkClickObserver.stop()
this.formSubmitObserver.stop()
this.scrollObserver.stop()
this.streamObserver.stop()
this.frameRedirector.stop()
this.history.stop()
this.started = false
}
}
registerAdapter(adapter: Adapter) {
this.adapter = adapter
}
visit(location: Locatable, options: Partial<VisitOptions> = {}) {
this.navigator.proposeVisit(Location.wrap(location), options)
}
connectStreamSource(source: StreamSource) {
this.streamObserver.connectStreamSource(source)
}
disconnectStreamSource(source: StreamSource) {
this.streamObserver.disconnectStreamSource(source)
}
renderStreamMessage(message: StreamMessage | string) {
document.documentElement.appendChild(StreamMessage.wrap(message).fragment)
}
clearCache() {
this.view.clearSnapshotCache()
}
setProgressBarDelay(delay: number) {
this.progressBarDelay = delay
}
get location() {
return this.history.location
}
get restorationIdentifier() {
return this.history.restorationIdentifier
}
// History delegate
historyPoppedToLocationWithRestorationIdentifier(location: Location) {
if (this.enabled) {
this.navigator.proposeVisit(location, { action: "restore", historyChanged: true })
} else {
this.adapter.pageInvalidated()
}
}
// Scroll observer delegate
scrollPositionChanged(position: Position) {
this.history.updateRestorationData({ scrollPosition: position })
}
// Link click observer delegate
willFollowLinkToLocation(link: Element, location: Location) {
return this.linkIsVisitable(link)
&& this.locationIsVisitable(location)
&& this.applicationAllowsFollowingLinkToLocation(link, location)
}
followedLinkToLocation(link: Element, location: Location) {
const action = this.getActionForLink(link)
this.visit(location, { action })
}
// Navigator delegate
allowsVisitingLocation(location: Location) {
return this.applicationAllowsVisitingLocation(location)
}
visitProposedToLocation(location: Location, options: Partial<VisitOptions>) {
this.adapter.visitProposedToLocation(location, options)
}
visitStarted(visit: Visit) {
this.notifyApplicationAfterVisitingLocation(visit.location)
}
visitCompleted(visit: Visit) {
this.notifyApplicationAfterPageLoad(visit.getTimingMetrics())
}
// Form submit observer delegate
willSubmitForm(form: HTMLFormElement, submitter?: HTMLElement) {
return true
}
formSubmitted(form: HTMLFormElement, submitter?: HTMLElement) {
this.navigator.submitForm(form, submitter)
}
// Page observer delegate
pageBecameInteractive() {
this.view.lastRenderedLocation = this.location
this.notifyApplicationAfterPageLoad()
}
pageLoaded() {
}
pageInvalidated() {
this.adapter.pageInvalidated()
}
// Stream observer delegate
receivedMessageFromStream(message: StreamMessage) {
this.renderStreamMessage(message)
}
// View delegate
viewWillRender(newBody: HTMLBodyElement) {
this.notifyApplicationBeforeRender(newBody)
}
viewRendered() {
this.view.lastRenderedLocation = this.history.location
this.notifyApplicationAfterRender()
}
viewInvalidated() {
this.pageObserver.invalidate()
}
viewWillCacheSnapshot() {
this.notifyApplicationBeforeCachingSnapshot()
}
// Application events
applicationAllowsFollowingLinkToLocation(link: Element, location: Location) {
const event = this.notifyApplicationAfterClickingLinkToLocation(link, location)
return !event.defaultPrevented
}
applicationAllowsVisitingLocation(location: Location) {
const event = this.notifyApplicationBeforeVisitingLocation(location)
return !event.defaultPrevented
}
notifyApplicationAfterClickingLinkToLocation(link: Element, location: Location) {
return dispatch("turbo:click", { target: link, detail: { url: location.absoluteURL }, cancelable: true })
}
notifyApplicationBeforeVisitingLocation(location: Location) {
return dispatch("turbo:before-visit", { detail: { url: location.absoluteURL }, cancelable: true })
}
notifyApplicationAfterVisitingLocation(location: Location) {
return dispatch("turbo:visit", { detail: { url: location.absoluteURL } })
}
notifyApplicationBeforeCachingSnapshot() {
return dispatch("turbo:before-cache")
}
notifyApplicationBeforeRender(newBody: HTMLBodyElement) {
return dispatch("turbo:before-render", { detail: { newBody }})
}
notifyApplicationAfterRender() {
return dispatch("turbo:render")
}
notifyApplicationAfterPageLoad(timing: TimingData = {}) {
return dispatch("turbo:load", { detail: { url: this.location.absoluteURL, timing }})
}
// Private
getActionForLink(link: Element): Action {
const action = link.getAttribute("data-turbo-action")
return isAction(action) ? action : "advance"
}
linkIsVisitable(link: Element) {
const container = link.closest("[data-turbo]")
if (container) {
return container.getAttribute("data-turbo") != "false"
} else {
return true
}
}
locationIsVisitable(location: Location) {
return location.isPrefixedBy(this.view.getRootLocation()) && location.isHTML()
}
}