forked from w3c/webdriver-bidi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.bs
8999 lines (6358 loc) · 293 KB
/
index.bs
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<pre class=metadata>
Title: WebDriver BiDi
Shortname: webdriver-bidi
Level: 1
Status: ED
Group: browser-testing-tools
URL: https://w3c.github.io/webdriver-bidi/
Repository: w3c/webdriver-bidi
No Editor: true
Abstract: This document defines the BiDirectional WebDriver Protocol, a mechanism for remote control of user agents.
Boilerplate: conformance no
Complain About: accidental-2119 yes, missing-example-ids yes
Default Ref Status: current
Indent: 2
Implementation Report: https://wpt.fyi/results/webdriver/tests/bidi
Test Suite: https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi
!Channel: <a href="https://www.w3.org/wiki/IRC">#webdriver on irc.w3.org</a>
!Wiki: <a href="https://www.w3.org/wiki/WebDriver">W3C WebDriver Wiki</a>
</pre>
<pre class=anchors>
spec: RFC6455; urlPrefix: https://tools.ietf.org/html/rfc6455
type: dfn
text: WebSocket URI; url: section-3
text: Establishes a WebSocket Connection; url: section-4.1
text: Server-Side Requirements; url: section-4.2
text: Reading the Client's Opening Handshake; url: section-4.2.1
text: %x1 denotes a text frame; url: section-5.2
text: Send a WebSocket Message; url: section-6.1
text: A WebSocket Message Has Been Received; url: section-6.2
text: Start The WebSocket Closing Handshake; url: section-7.1.2
text: The WebSocket Closing Handshake is Started; url: section-7.1.3
text: The WebSocket Connection is Closed; url: section-7.1.4
text: Fail the WebSocket Connection; url: section-7.1.7
text: Status Codes; url: section-7.4
text: Handling Errors in UTF-8-Encoded Data; url: section-8.1
spec: RFC8610; urlPrefix: https://tools.ietf.org/html/rfc8610
type: dfn
text: match a CDDL specification; url: appendix-C
spec: WEBDRIVER; urlPrefix: https://w3c.github.io/webdriver/
type: dfn
text: WebDriver new session algorithm; url: dfn-webdriver-new-session-algorithm
text: actions options; url: dfn-actions-options
text: active sessions; url: dfn-active-session
text: additional WebDriver capability; url: dfn-additional-webdriver-capability
text: additional capability deserialization algorithm; url: dfn-additional-capability-deserialization-algorithm
text: capability name; url: dfn-capability-name
text: close the session; url: dfn-close-the-session
text: create a session; url: dfn-create-a-session
text: dispatch actions; url: dfn-dispatch-actions
text: dispatch tick actions; url: dfn-dispatch-tick-actions
text: draw a bounding box from the framebuffer; url: dfn-draw-a-bounding-box-from-the-framebuffer
text: encode a canvas as Base64; url: dfn-encoding-a-canvas-as-base64
text: endpoint node; url: dfn-endpoint-node
text: error code; url: dfn-error-code
text: error; url: dfn-errors
text: extract an action sequence; url: dfn-extract-an-action-sequence
text: get a node; url: dfn-get-a-node
text: get or create a node reference; url: dfn-get-or-create-a-node-reference
text: getting a property; url: dfn-get-a-property
text: get element origin; url: dfn-get-element-origin
text: get the input state; url: dfn-get-the-input-state
text: http session; url: dfn-http-session
text: input cancel list; url: dfn-input-cancel-list
text: intermediary node; url: dfn-intermediary-node
text: invalid argument; url: dfn-invalid-argument
text: invalid session id; url: dfn-invalid-session-id
text: is element origin; url: dfn-is-element-origin
text: local end; url: dfn-local-ends
text: matched capability serialization algorithm; url: dfn-matched-capability-serialization-algorithm
text: maximum active sessions; url: dfn-maximum-active-sessions
text: no such alert; url: dfn-no-such-alert
text: no such element; url: dfn-no-such-element
text: no such frame; url: dfn-no-such-frame
text: parse a page range; url: dfn-parse-a-page-range
text: process capabilities; url: dfn-processing-capabilities
text: readiness state; url: dfn-readiness-state
text: remote end steps; url: dfn-remote-end-steps
text: remote end; url: dfn-remote-ends
text: reset the input state; url: dfn-reset-the-input-state
text: scroll into view; url: dfn-scrolls-into-view
text: session ID; url: dfn-session-id
text: session not created; url: dfn-session-not-created
text: session; url: dfn-sessions
text: set a property; url: dfn-set-a-property
text: success; url: dfn-success
text: try; url: dfn-try
text: trying; url: dfn-try
text: unable to capture screen; url: dfn-unable-to-capture-screen
text: unknown command; url: dfn-unknown-command
text: unknown error; url: dfn-unknown-error
text: unsupported operation; url: dfn-unsupported-operation
text: web element reference; url: dfn-web-element-reference
text: webdriver-active flag; url: dfn-webdriver-active-flag
text: window handle; url: dfn-window-handle
spec: CONSOLE; urlPrefix: https://console.spec.whatwg.org
type: dfn
text: formatter; url: formatter
text: formatting specifier; url: formatting-specifiers
text: printer; url: printer
spec: ECMASCRIPT; urlPrefix: https://tc39.es/ecma262/
type: dfn
text: Array; url: sec-array-objects
text: Await; url: await
text: BigInt; url: sec-bigint-constructor
text: boolean; url: sec-terms-and-definitions-boolean-value
text: Call; url: sec-call
text: Completion Record; url: sec-completion-record-specification-type
text: Construct; url: sec-construct
text: CreateArrayFromList; url: sec-createarrayfromlist
text: CreateArrayIterator; url: sec-createarrayiterator
text: CreateBuiltinFunction; url: sec-createbuiltinfunction
text: CreateListFromArrayLike; url: sec-createlistfromarraylike
text: CreateMapIterator; url: sec-createmapiterator
text: CreateSetIterator; url: sec-createsetiterator
text: Date; url: sec-date-constructor
text: Date Time String Format; url: sec-date-time-string-format
text: Date.toISOString; url: sec-date.prototype.toisostring
text: EnumerableOwnPropertyNames; url: sec-enumerableownpropertynames
text: Get; url: sec-get
text: GetIterator; url: sec-getiterator
text: HasProperty; url: sec-hasproperty
text: IsArray; url: sec-isarray
text: IsCallable; url: sec-iscallable
text: IsPromise; url: sec-ispromise
text: IsRegExp; url: sec-isregexp
text: IteratorToList; url: sec-iteratortolist
text: LengthOfArrayLike; url: sec-lengthofarraylike
text: Map; url: #sec-map-iterable; for: constructor
text: Number; url: sec-number-constructor
text: null; url: sec-null-value
text: Object; url: sec-object-objects
text: Object.fromEntries; url: sec-object.fromentries
text: ScriptEvaluation; url: sec-runtime-semantics-scriptevaluation
text: Set object; url: sec-set-objects
text: String; url: sec-string-constructor
text: StringToBigInt; url: sec-stringtobigint
text: StringToNumber; url: sec-stringtonumber
text: RegExp; url: sec-regexp-pattern-flags
text: ToString; url: sec-tostring
text: Type; url: sec-ecmascript-data-types-and-values
text: abrupt completion; url: sec-completion-record-specification-type
text: undefined; url: sec-undefined-value
text: current realm record; url: current-realm
text: internal slot; url: sec-object-internal-methods-and-internal-slots
text: primitive ECMAScript value; url: sec-primitive-value
text: realm; url: sec-code-realms
text: running execution context; url: running-execution-context
text: time value; url: sec-time-values-and-time-range
text: throw completion; url: sec-completion-record-specification-type
spec: GEOMETRY; urlPrefix: https://drafts.fxtf.org/geometry/
type: dfn
text: rectangle; url: rectangle
text: x coordinate; url: rectangle-x-coordinate
text: y coordinate; url: rectangle-y-coordinate
text: width dimension; url: rectangle-width-dimension
text: height dimension; url: rectangle-height-dimension
spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
type: dfn
text: 2D; url: canvas.html#concept-canvas-2d
text: 2D context creation algorithm; url: canvas.html#2d-context-creation-algorithm
text: a browsing context is discarded; url: window-object.html#a-browsing-context-is-discarded
text: active browsing context; url: document-sequences.html#nav-bc
text: active document; for: browsing context; url: document-sequences.html#active-document
text: active window; url: document-sequences.html#active-window
text: alert; url: timers-and-user-prompts.html#dom-alert
text: close; url: window-object.html#close-a-browsing-context
text: create a classic script; url: webappapis.html#creating-a-classic-script
text: create a new browsing context; url: browsers.html#creating-a-new-browsing-context
text: confirm; url: timers-and-user-prompts.html#dom-confirm
text: context mode; url: /canvas.html#offscreencanvas-context-mode
text: default classic script fetch options; url: webappapis.html#default-classic-script-fetch-options
text: environment settings object's Realm; url: webappapis.html#environment-settings-object's-realm
text: handled; url: webappapis.html#concept-error-handled
text: history handling behavior; url: browsing-the-web.html#history-handling-behavior
text: navigation id; url: browsing-the-web.html#navigation-id
text: parent; for:navigable; url: document-sequences.html#nav-parent
text: prompt; url: timers-and-user-prompts.html#dom-prompt
text: prompt to unload; url: browsing-the-web.html#prompt-to-unload-a-document
text: report an error; url: webappapis.html#report-the-error
text: remove a browsing context; url: browsers.html#bcg-remove
text: run the animation frame callbacks; url: imagebitmap-and-animations.html#run-the-animation-frame-callbacks
text: same origin domain; url: browsers.html#same-origin-domain
text: session history; url: history.html#session-history
text: set up a window environment settings object; url: window-object.html#set-up-a-window-environment-settings-object
text: set up a worker environment settings object; url: workers.html#set-up-a-worker-environment-settings-object
text: set up a worklet environment settings object; url: worklets.html#set-up-a-worklet-environment-settings-object
text: shared worker; url: workers.html#shared-workers
text: window open steps; url: window-object.html#window-open-steps
text: worker event loop; url: webappapis.html#worker-event-loop-2
text: worklet global scopes; url:worklets.html#concept-document-worklet-global-scopes
text: traversable navigable; url:document-sequences.html#traversable-navigable
text: system visibility state; url: document-sequences.html#system-visibility-state
text: focused area of the document; url: document-sequences.html#focused-area-of-the-document
text: visible; url: document-sequences.html#system-visibility-state
text: hidden; url: document-sequences.html#system-visibility-state
text: navigables; url: document-sequences.html#navigables
text: activation notification; url: interaction.html#activation-notification
spec: RESOURCE-TIMING; urlPrefix: https://w3c.github.io/resource-timing/
type: dfn
text: convert fetch timestamp; url: dfn-convert-fetch-timestamp
spec: HR-TIME; urlPrefix: https://w3c.github.io/hr-time/
type: dfn
text: get time origin timestamp; url: dfn-get-time-origin-timestamp
spec: RFC4648; urlPrefix: https://tools.ietf.org/html/rfc4648
type: dfn
text: Base64 Encode; url: section-4
spec: CSSOM-VIEW; urlPrefix: https://drafts.csswg.org/cssom-view/
type: dfn
text: visual viewport; url: #visual-viewport
</pre>
<pre class="biblio">
{
"SAME-SITE-COOKIES": {
"authors": ["Mike West", "Mark Goodwin"],
"href": "https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-cookie-same-site",
"publisher": "IETF",
"title": "Same-Site Cookies"
}
}
</pre>
<style>
var {
color: #cd5c5c
}
</style>
# Introduction # {#intro}
<em>This section is non-normative.</em>
[[WEBDRIVER|WebDriver]] defines a protocol for introspection and
remote control of user agents. This specification extends WebDriver by
introducing bidirectional communication. In place of the strict
command/response format of WebDriver, this permits events to stream
from the user agent to the controlling software, better matching the
evented nature of the browser DOM.
# Infrastructure # {#infrastructure}
This specification depends on the Infra Standard. [[!INFRA]]
Network protocol messages are defined using CDDL. [[!RFC8610]]
This specification defines a <dfn>wait queue</dfn> which is a [=/map=].
Issue: Surely there's a better mechanism for doing this "wait for an event" thing.
<div algorithm>
When an algorithm |algorithm| running [=in parallel=] <dfn>awaits</dfn> a set of
events |events|, and |resume id|:
1. Pause the execution of |algorithm|.
1. Assert: [=wait queue=] does not contain |resume id|.
1. Set [=wait queue=][|resume id|] to (|events|, |algorithm|).
</div>
<div algorithm>
To <dfn>resume</dfn> given |name|, |id| and |parameters|:
1. If [=wait queue=] does not contain |id|, return.
1. Let (|events|, |algorithm|) be [=wait queue=][|id|]
1. For each |event| in |events|:
1. If |event| equals |name|:
1. Remove |id| from [=wait queue=].
1. Resume running the steps in |algorithm| from the
point at which they were paused, passing |name| and |parameters| as the
result of the [=await=].
Issue: Should we have something like microtasks to ensure this runs
before any other tasks on the event loop?
</div>
# Protocol # {#protocol}
This section defines the basic concepts of the WebDriver BiDi
protocol. These terms are distinct from their representation at the
<a href=#transport>transport</a> layer.
The protocol is defined using a [[!RFC8610|CDDL]] definition. For the
convenience of implementors two separate CDDL definitions are defined; the
<dfn>remote end definition</dfn> which defines the format of messages produced
on the [=local end=] and consumed on the [=remote end=], and the <dfn>local end
definition</dfn> which defines the format of messages produced on the [=remote
end=] and consumed on the [=local end=]
## Definition ## {#protocol-definition}
Issue: Should this be an appendix?
This section gives the initial contents of the [=remote end definition=] and
[=local end definition=]. These are augmented by the definition fragments defined in
the remainder of the specification.
[=Remote end definition=]
<pre class="cddl remote-cddl">
Command = {
id: js-uint,
CommandData,
Extensible,
}
CommandData = (
BrowserCommand //
BrowsingContextCommand //
InputCommand //
NetworkCommand //
ScriptCommand //
SessionCommand
)
EmptyParams = {
Extensible
}
</pre>
[=Local end definition=]
<pre class="cddl local-cddl">
Message = (
CommandResponse /
ErrorResponse /
Event
)
CommandResponse = {
type: "success",
id: js-uint,
result: ResultData,
Extensible
}
ErrorResponse = {
type: "error",
id: js-uint / null,
error: ErrorCode,
message: text,
? stacktrace: text,
Extensible
}
ResultData = (
BrowsingContextResult /
EmptyResult /
NetworkResult /
ScriptResult /
SessionResult
)
EmptyResult = {
Extensible
}
Event = {
type: "event",
EventData,
Extensible
}
EventData = (
BrowsingContextEvent //
LogEvent //
NetworkEvent //
ScriptEvent
)
</pre>
[=Remote end definition=] and [=Local end definition=]
<pre class="cddl remote-cddl local-cddl">
Extensible = (*text => any)
js-int = -9007199254740991..9007199254740991
js-uint = 0..9007199254740991
</pre>
## Session ## {#session}
WebDriver BiDi extends the [=/session=] concept from [[WEBDRIVER|WebDriver]].
A [=/session=] has a <dfn>BiDi flag</dfn>, which is false unless otherwise
stated.
A <dfn>BiDi session</dfn> is a [=/session=] which has the [=BiDi flag=]
set to true.
<div algorithm>
The list of <dfn>active BiDi sessions</dfn> is given by:
1. Let |BiDi sessions| be a new [=/list=].
1. For each |session| in [=active sessions=]:
1. If |session| is a [=BiDi session=] append |session| to |BiDi sessions|.
1. Return |BiDi sessions|
</div>
## Modules ## {#protocol-modules}
The WebDriver BiDi protocol is organized into modules.
Each <dfn export>module</dfn> represents a collection of related
[=commands=] and [=events=] pertaining to a certain aspect of the user
agent. For example, a module might contain functionality for inspecting and
manipulating the DOM, or for script execution.
Each module has a <dfn>module name</dfn> which is a string. The
[=command name=] and [=event name=] for commands and events defined in the
module start with the [=module name=] followed by a period "<code>.</code>".
Modules which contain [=commands=] define [=remote end definition=]
fragments. These provide choices in the <code>CommandData</code> group for the
module's [=commands=], and can also define additional definition properties. They
can also define [=local end definition=] fragments that provide additional choices
in the <code>ResultData</code> group for the results of commands in the module.
Modules which contain events define [=local end definition=] fragments that are
choices in the <code>Event</code> group for the module's [=events=].
An implementation may define <dfn>extension modules</dfn>. These must have a
[=module name=] that contains a single colon "<code>:</code>" character. The
part before the colon is the prefix; this is typically the same for all
extension modules specific to a given implementation and should be unique for a
given implementation. Such modules extend the [=local end definition=] and [=remote
end definition=] providing additional groups as choices for the defined
[=commands=] and [=events=].
## Commands ## {#commands}
A <dfn export>command</dfn> is an asynchronous operation, requested by
the [=local end=] and run on the [=remote end=], resulting in either a
result or an error being returned to the [=local end=]. Multiple
commands can run at the same time, and commands can potentially be
long-running. As a consequence, commands can finish out-of-order.
Each [=command=] is defined by:
- A <dfn export for=command>command type</dfn> which is defined by a [=remote
end definition=] fragment containing a group. Each such group has two fields:
- <code>method</code> which is a string literal of the form <code>[module
name].[method name]</code>. This is the <dfn export for=command>command
name</dfn>.
- <code>params</code> which defines a mapping containing data that to be passed into
the command. The populated value of this map is the
<dfn export for=command>command parameters</dfn>.
- A <dfn export for=command>result type</dfn>, which is defined by a [=local
end definition=] fragment.
- A set of [=remote end steps=] which define the actions to take for a command
given a [=BiDi session=] and [=command parameters=] and return an
instance of the command [=result type=].
A command that can run without an active session is a <dfn>static
command</dfn>. Commands are not static commands unless stated in their
definition.
When commands are sent from the [=local end=] they have a command id. This is an
identifier used by the [=local end=] to identify the response from a particular
command. From the point of view of the [=remote end=] this identifier is opaque
and cannot be used internally to identify the command.
Note: This is because the command id is entirely controlled by the [=local end=]
and isn't necessarily unique over the course of a session. For example a [=local
end=] which ignores all responses could use the same command id for each command.
The <dfn export for=command>set of all command names</dfn> is a [=/set=] containing
all the defined [=command names=], including any belonging to [=extension
modules=].
## Errors ## {#errors}
WebDriver BiDi extends the set of [=error codes=] from [[WEBDRIVER|WebDriver]]
with the following additional codes:
<dl>
<dt><dfn>no such handle</dfn>
<dd>Tried to deserialize an unknown <code>RemoteObjectReference</code>.
<dt><dfn>no such intercept</dfn>
<dd>Tried to remove an unknown [=network intercept=].
<dt><dfn>no such node</dfn>
<dd>Tried to deserialize an unknown <code>SharedReference</code>.
<dt><dfn>no such request</dfn>
<dd>Tried to continue an unknown [=/request=].
<dt><dfn>no such script</dfn>
<dd>Tried to remove an unknown [=preload script=].
<dt><dfn>unable to close browser</dfn>
<dd>Tried to close the browser, but failed to do so.
</dl>
<pre class="cddl local-cddl">
ErrorCode = "invalid argument" /
"invalid session id" /
"move target out of bounds" /
"no such alert" /
"no such element" /
"no such frame" /
"no such handle" /
"no such intercept" /
"no such node" /
"no such request" /
"no such script" /
"session not created" /
"unable to capture screen" /
"unable to close browser" /
"unknown command" /
"unknown error" /
"unsupported operation"
</pre>
## Events ## {#events}
An <dfn export>event</dfn> is a notification, sent by the [=remote
end=] to the [=local end=], signaling that something of interest has
occurred on the [=remote end=].
- An <dfn export for=event>event type</dfn> is defined by a [=local
end definition=] fragment containing a group. Each such group has two fields:
- <code>method</code> which is a string literal of the form <code>[module
name].[event name]</code>. This is the <dfn export for=event>event
name</dfn>.
- <code>params</code> which defines a mapping containing event data. The
populated value of this map is the <dfn export for=command>event
parameters</code>.
- A <dfn export>remote end event trigger</dfn> which defines when the event is
triggered and steps to construct the [=event type=] data.
- Optionally, a set of <dfn>remote end subscribe steps</dfn>, which define
steps to take when a local end subscribes to an event. Where defined these
steps have an associated <dfn>subscribe priority</dfn> which is an integer
controlling the order in which the steps are run when multiple events are
enabled at once, with lower integers indicating steps that run earlier.
A [=BiDi session=] has a <dfn export for=event>global event set</dfn>
which is a [=/set=] containing the event names for events that are enabled for all
browsing contexts. This initially contains the [=event name=] for events that
are <dfn export for=event>in the default event set</dfn>.
A [=BiDi session=] has a <dfn export for=event>browsing context event
map</dfn>, which is a [=/map=] with [=/top-level browsing context=] keys and values
that are a [=/set=] of [=event name=]s for events that are enabled in the given
browsing context.
<div algorithm>
To obtain a list of <dfn>event enabled browsing contexts</dfn> given
|session| and |event name|:
1. Let |contexts| be an empty [=/set=].
1. For each |context| → |events| of |session|'s [=browsing context event map=]:
1. If |events| contains |event name|, append |context| to |contexts|
1. Return |contexts|.
</div>
<div algorithm>
The <dfn>set of sessions for which an event is enabled</dfn> given |event name| and
|browsing contexts| is:
1. Let |sessions| be a new [=/set=].
1. For each |session| in [=active BiDI sessions=]:
1. If [=event is enabled=] with |session|, |event name| and |browsing
contexts|, append |session| to |sessions|.
1. Return |sessions|
</div>
<div algorithm>
To determine if an <dfn>event is enabled</dfn> given |session|,
|event name| and |browsing contexts|:
Note: |browsing contexts| is a set because a [=shared worker=] can be associated
with multiple contexts.
1. Let |top-level browsing contexts| be an empty [=/set=].
1. For each |browsing context| of |browsing contexts|, append |browsing
context|'s [=top-level browsing context=] to |top-level browsing contexts|.
1. Let |event map| be the [=browsing context event map=] for |session|.
1. For each |browsing context| of |top-level browsing contexts|:
1. If |event map| [=map/contains=] |browsing context|, let |browsing context
events| be |event map|[|browsing context|]. Otherwise let |browsing
context events| be null.
1. If |browsing context events| is not null, and |browsing context events|
[=list/contains=] |event name|, return true.
1. If the [=global event set=] for |session| [=list/contains=] |event name| return
true.
1. Return false.
</div>
<div algorithm>
To <dfn>obtain a set of event names</dfn> given an |name|:
1. Let |events| be an empty [=/set=].
1. If |name| contains a U+002E (period):
1. If |name| is the [=event name=] for an event, append |name| to |events|
and return [=success=] with data |events|.
1. Return an [=error=] with [=error code=] [=invalid argument=]
1. Otherwise |name| is interpreted as representing all the events in a
module. If |name| is not a [=module name=] return an [=error=] with
[=error code=] [=invalid argument=].
1. Append the [=event name=] for each [=event=] in the module with name |name| to
|events|.
1. Return [=success=] with data |events|.
</div>
# Transport # {#transport}
Message transport is provided using the WebSocket protocol.
[[!RFC6455]]
Note: In the terms of the WebSocket protocol, the [=local end=] is the
client and the [=remote end=] is the server / remote host.
Note: The encoding of [=commands=] and [=events=] as messages is
similar to JSON-RPC, but this specification does not normatively
reference it. [[JSON-RPC]] The normative requirements on [=remote
ends=] are instead given as a precise processing model, while no
normative requirements are given for [=local ends=].
A <dfn>WebSocket listener</dfn> is a network endpoint that is able
to accept incoming [[!RFC6455|WebSocket]] connections.
A [=WebSocket listener=] has a <dfn for=listener>host</dfn>, a <dfn
for=listener>port</dfn>, a <dfn for=listener>secure flag</dfn>, and a
<dfn>list of WebSocket resources</dfn>.
When a [=WebSocket listener=] |listener| is created, a [=remote end=]
must start to listen for WebSocket connections on the host and port
given by |listener|'s [=listener/host=] and [=listener/port=]. If
|listener|'s [=listener/secure flag=] is set, then connections
established from |listener| must be TLS encrypted.
A [=remote end=] has a [=/set=] of [=WebSocket listeners=] <dfn>active
listeners</dfn>, which is initially empty.
A [=remote end=] has a [=/set=] of <dfn>WebSocket connections not associated with a
session</dfn>, which is initially empty.
A <dfn>WebSocket connection</dfn> is a network connection that follows the
requirements of the [[!RFC6455|WebSocket protocol]]
A [=BiDi session=] has a [=/set=] of <dfn>session WebSocket
connections</dfn> whose elements are [=WebSocket connections=]. This is
initially empty.
A [=BiDi session=] |session| is <dfn>associated with connection</dfn>
|connection| if |session|'s [=session WebSocket connections=] contains |connection|.
Note: Each [=WebSocket connection=] is associated with at most one [=BiDi
session=].
<div>
When a client [=establishes a WebSocket connection=] |connection| by
connecting to one of the set of [=active listeners=] |listener|, the
implementation must proceed according to the WebSocket [=server-side
requirements=], with the following steps run when deciding whether to
accept the incoming connection:
1. Let |resource name| be the resource name from [=reading the
client's opening handshake=]. If |resource name| is not in
|listener|'s [=list of WebSocket resources=], then stop
running these steps and act as if the requested service is not
available.
1. If |resource name| is the byte string "<code>/session</code>",
and the implementation [=supports BiDi-only sessions=]:
1. Run any other implementation-defined steps to decide if the
connection should be accepted, and if it is not stop running these
steps and act as if the requested service is not available.
1. Add the connection to [=WebSocket connections not associated with a
session=].
1. Return.
1. [=Get a session ID for a WebSocket resource=] with |resource name|
and let |session id| be that value. If |session id| is null then
stop running these steps and act as if the requested service is not
available.
1. If there is a [=/session=] in the list of [=active sessions=] with
|session id| as its [=session ID=] then let |session| be that
session. Otherwise stop running these steps and act as if the
requested service is not available.
1. Run any other implementation-defined steps to decide if the
connection should be accepted, and if it is not stop running these
steps and act as if the requested service is not available.
1. Otherwise append |connection| to |session|'s [=session WebSocket
connections=], and proceed with the WebSocket [=server-side requirements=]
when a server chooses to accept an incoming connection.
Issue: Do we support > 1 connection for a single session?
</div>
When [=a WebSocket message has been received=] for a [=WebSocket
connection=] |connection| with type |type| and data |data|, a [=remote
end=] must [=handle an incoming message=] given |connection|, |type|
and |data|.
When [=the WebSocket closing handshake is started=] or when [=the
WebSocket connection is closed=] for a [=WebSocket connection=]
|connection|, a [=remote end=] must [=handle a connection closing=]
given |connection|.
Note: Both conditions are needed because it is possible for a
WebSocket connection to be closed without a closing handshake.
<div algorithm>
To <dfn lt="construct a WebSocket resource name|constructing a
WebSocket resource name">construct a WebSocket resource name</dfn>
given a [=/session=] |session|:
1. If |session| is null, return "<code>/session</code>"
1. Return the result of concatenating the string "<code>/session/</code>"
with |session|'s [=session ID=].
</div>
<div algorithm>
To <dfn lt="construct a WebSocket URL|constructing a WebSocket
URL">construct a WebSocket URL</dfn> given a [=WebSocket listener=]
|listener| and [=/session=] |session|:
1. Let |resource name| be the result of [=constructing a WebSocket
resource name=] given |session|.
1. Return a [=WebSocket URI=] constructed with host set to
|listener|'s [=listener/host=], port set to |listener|'s
[=listener/port=], path set to |resource name|, following the wss-URI
construct if |listener|'s [=listener/secure flag=] is set and the ws-URL
construct otherwise.
</div>
<div algorithm>
To <dfn>get a session ID for a WebSocket resource</dfn>
given |resource name|:
1. If |resource name| doesn't begin with the byte string
"<code>/session/</code>", return null.
1. Let |session id| be the bytes in |resource name| following the
"<code>/session/</code>" prefix.
1. If |session id| is not the string representation of a
[[!RFC4122|UUID]], return null.
1. Return |session id|.
</div>
<div algorithm>
To <dfn>start listening for a WebSocket connection</dfn> given a
[=/session=] |session|:
1. If there is an existing [=WebSocket listener=] in [=active listeners=] which
the [=remote end=] would like to reuse, let |listener| be that
listener. Otherwise let |listener| be a new [=WebSocket listener=] with
[=implementation-defined=] [=listener/host=], [=listener/port=],
[=listener/secure flag=], and an empty [=list of WebSocket resources=].
1. Let |resource name| be the result of [=constructing a WebSocket
resource name=] given |session|.
1. Append |resource name| to the [=list of WebSocket resources=] for
|listener|.
1. [=set/Append=] |listener| to the [=remote end=]'s [=active
listeners=].
1. Return |listener|.
</div>
Note: An [=intermediary node=] handling multiple sessions can use one
or many WebSocket listeners. [[!WEBDRIVER|WebDriver]] defines that
an [=endpoint node=] supports at most one session at a time, so it's
expected to only have a single listener.
Note: For an [=endpoint node=] the [=listener/host=] in the above steps will
typically be "<code>localhost</code>".
<div algorithm>
To <dfn>handle an incoming message</dfn> given a [=WebSocket connection=]
|connection|, type |type| and data |data|:
1. If |type| is not [=%x1 denotes a text frame|text=], [=send an error
response=] given |connection|, null, and [=invalid argument=], and finally
return.
1. [=Assert=]: |data| is a [=scalar value string=], because the
WebSocket [=handling errors in UTF-8-encoded data=] would already
have [=fail the WebSocket connection|failed the WebSocket
connection=] otherwise.
Issue: Nothing seems to define what [=status codes|status code=]
is used for UTF-8 errors.
1. If there is a [=BiDi Session=] [=associated with connection=] |connection|,
let |session| be that session. Otherwise if |connection| is in [=WebSocket
connections not associated with a session=], let |session| be
null. Otherwise, return.
1. Let |parsed| be the result of [=parse JSON into Infra values|parsing JSON
into Infra values=] given |data|. If this throws an exception, then [=send
an error response=] given |connection|, null, and [=invalid argument=], and
finally return.
1. If |session| is not null and not in [=active sessions=] then return.
1. Match |parsed| against the [=remote end definition=]. If this results in a
match:
1. Let |matched| be the [=/map=] representing the matched data.
1. Assert: |matched| [=map/contains=] "<code>id</code>", "<code>method</code>", and
"<code>params</code>".
1. Let |command id| be |matched|["<code>id</code>"].
1. Let |method| be |matched|["<code>method</code>"]
1. Let |command| be the command with [=command name=] |method|.
1. If |session| is null and |command| is not a [=static command=], then
[=send an error response=] given |connection|, |command id|, and [=invalid
session id=], and return.
1. Run the following steps in parallel:
1. Let |result| be the result of running the [=remote end steps=] for
|command| given |session| and [=command parameters=]
|matched|["<code>params</code>"]
1. If |result| is an [=error=], then [=send an error response=] given
|connection|, |command id|, and |result|'s [=error code=], and finally
return.
1. Let |value| be |result|'s data.
1. Assert: |value| matches the definition for the [=result type=]
corresponding to the command with [=command name=] |method|.
1. If |method| is "<code>session.new</code>", let |session| be the entry in
the list of [=active sessions=] whose [=session ID=] is equal to the
"<code>sessionId</code>" property of |value|, [=set/append=]
|connection| to |session|'s [=session WebSocket connections=], and
remove |connection| from the [=WebSocket connections not associated with
a session=].
1. Let |response| be a new [=/map=] matching the <code>CommandResponse</code>
production in the [=local end definition=] with the <code>id</code>
field set to |command id| and the <code>value</code> field set to
|value|.
1. Let |serialized| be the result of [=serialize an infra value to JSON
bytes=] given |response|.
1. [=Send a WebSocket message=] comprised of |serialized| over
|connection|.
1. Otherwise:
1. Let |command id| be null.
1. If |parsed| is a [=/map=] and |parsed|["<code>id</code>"] exists and is an
integer greater than or equal to zero, set |command id| to that integer.
1. Let |error code| be [=invalid argument=].
1. If |parsed| is a [=/map=] and |parsed|["<code>method</code>"] exists and is a
string, but |parsed|["<code>method</code>"] is not in the [=set of all
command names=], set |error code| to [=unknown command=].
1. [=Send an error response=] given |connection|, |command id|, and
|error code|.
</div>
<div algorithm>
To <dfn>get related browsing contexts</dfn> given an [=script/settings object=]
|settings|:
1. Let |related browsing contexts| be an empty [=/set=]
1. If |settings|' [=relevant global object=] is a {{Window}}, append |settings|'
[=relevant global object=]'s <a>associated <code>Document</code></a>'s
[=Document/browsing context=] to |related browsing contexts|.
Otherwise if the [=realm/global object=] specified by |settings| is a
{{WorkerGlobalScope}}, for each |owner| in the [=realm/global object=]'s
[=owner set=], if |owner| is a [=Document=], append |owner|'s
[=Document/browsing context=] to |related browsing contexts|.
1. Return |related browsing contexts|.
</div>
<div algorithm> To <dfn export>emit an event</dfn> given |session|, and |body|:
1. [=Assert=]: |body| has [=map/size=] 2 and [=map/contains=] "<code>method</code>"
and "<code>params</code>".
1. Let |serialized| be the result of [=serialize an infra value to JSON
bytes=] given |body|.
1. [=list/For each=] |connection| in |session|'s [=session WebSocket connections=]:
1. [=Send a WebSocket message=] comprised of |serialized| over |connection|.
</div>
<div algorithm>
To <dfn>send an error response</dfn> given a [=WebSocket connection=]
|connection|, |command id|, and |error code|:
1. Let |error data| be a new [=/map=] matching the <code>ErrorResponse</code>
production in the [=local end definition=], with the <code>id</code> field
set to |command id|, the <code>error</code> field set to |error code|, the
<code>message</code> field set to an implementation-defined string
containing a human-readable definition of the error that occurred and the
<code>stacktrace</code> field optionally set to an implementation-defined
string containing a stack trace report of the active stack frames at the
time when the error occurred.
1. Let |response| be the result of [=serialize an infra value to JSON bytes=]
given |error data|.
Note: |command id| can be null, in which case the <code>id</code> field will
also be set to null, not omitted from |response|.
1. [=Send a WebSocket message=] comprised of |response| over |connection|.
</div>
<div algorithm>
To <dfn>handle a connection closing</dfn> given a [=WebSocket connection=]
|connection|:
1. If there is a [=BiDi session=] [=associated with connection=] |connection|:
1. Let |session| be the [=BiDi session=] [=associated with connection=]
|connection|.
1. Remove |connection| from |session|'s [=session WebSocket
connections=].