summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/webrtc/RTCConfiguration-iceTransportPolicy.html
blob: ebc79048a3ae390b229fc9c73fb2535f21b3ceda (plain)
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
<!doctype html>
<meta name="timeout" content="long">
<title>RTCConfiguration iceTransportPolicy</title>
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="RTCConfiguration-helper.js"></script>
<script src="RTCPeerConnection-helper.js"></script>
<script>
  'use strict';

  // Test is based on the following editor draft:
  // https://w3c.github.io/webrtc-pc/archives/20170605/webrtc.html

  // The following helper function is called from RTCConfiguration-helper.js:
  //   config_test

  /*
    [Constructor(optional RTCConfiguration configuration)]
    interface RTCPeerConnection : EventTarget {
      RTCConfiguration                   getConfiguration();
      void                               setConfiguration(RTCConfiguration configuration);
      ...
    };

    dictionary RTCConfiguration {
      sequence<RTCIceServer>   iceServers;
      RTCIceTransportPolicy    iceTransportPolicy = "all";
    };

    enum RTCIceTransportPolicy {
      "relay",
      "all"
    };
   */

  test(() => {
    const pc = new RTCPeerConnection();
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection() should have default iceTransportPolicy all`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: undefined });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection({ iceTransportPolicy: undefined }) should have default iceTransportPolicy all`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: 'all' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection({ iceTransportPolicy: 'all' }) should succeed`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: 'relay' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'relay');
  }, `new RTCPeerConnection({ iceTransportPolicy: 'relay' }) should succeed`);

  /*
    4.3.2. Set a configuration
      8.  Set the ICE Agent's ICE transports setting to the value of
          configuration.iceTransportPolicy. As defined in [JSEP] (section 4.1.16.),
          if the new ICE transports setting changes the existing setting, no action
          will be taken until the next gathering phase. If a script wants this to
          happen immediately, it should do an ICE restart.
   */
  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: 'all' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');

    pc.setConfiguration({ iceTransportPolicy: 'relay' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'relay');
  }, `setConfiguration({ iceTransportPolicy: 'relay' }) with initial iceTransportPolicy all should succeed`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: 'relay' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'relay');

    pc.setConfiguration({ iceTransportPolicy: 'all' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `setConfiguration({ iceTransportPolicy: 'all' }) with initial iceTransportPolicy relay should succeed`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransportPolicy: 'relay' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'relay');

    // default value for iceTransportPolicy is all
    pc.setConfiguration({});
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `setConfiguration({}) with initial iceTransportPolicy relay should set new value to all`);

  config_test(makePc => {
    assert_throws_js(TypeError, () =>
      makePc({ iceTransportPolicy: 'invalid' }));
  }, `with invalid iceTransportPolicy should throw TypeError`);

  // "none" is in Blink and Gecko's IDL, but not in the spec.
  config_test(makePc => {
    assert_throws_js(TypeError, () =>
      makePc({ iceTransportPolicy: 'none' }));
  }, `with none iceTransportPolicy should throw TypeError`);

  config_test(makePc => {
    assert_throws_js(TypeError, () =>
      makePc({ iceTransportPolicy: null }));
  }, `with null iceTransportPolicy should throw TypeError`);

  // iceTransportPolicy is called iceTransports in Blink.
  test(() => {
    const pc = new RTCPeerConnection({ iceTransports: 'relay' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection({ iceTransports: 'relay' }) should have no effect`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransports: 'invalid' });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection({ iceTransports: 'invalid' }) should have no effect`);

  test(() => {
    const pc = new RTCPeerConnection({ iceTransports: null });
    assert_equals(pc.getConfiguration().iceTransportPolicy, 'all');
  }, `new RTCPeerConnection({ iceTransports: null }) should have no effect`);

  const getLines = (sdp, startsWith) =>
    sdp.split('\r\n').filter(l => l.startsWith(startsWith));

  const getUfrags = ({sdp}) => getLines(sdp, 'a=ice-ufrag:');

  promise_test(async t => {
    const offerer = new RTCPeerConnection({iceTransportPolicy: 'relay'});
    t.add_cleanup(() => offerer.close());

    offerer.addEventListener('icecandidate',
        e => assert_equals(e.candidate, null, 'Should get no ICE candidates'));

    offerer.addTransceiver('audio');
    await offerer.setLocalDescription();

    await waitForIceGatheringState(offerer, ['complete']);
  }, `iceTransportPolicy "relay" on offerer should prevent candidate gathering`);

  promise_test(async t => {
    const offerer = new RTCPeerConnection();
    const answerer = new RTCPeerConnection({iceTransportPolicy: 'relay'});
    t.add_cleanup(() => offerer.close());
    t.add_cleanup(() => answerer.close());

    answerer.addEventListener('icecandidate',
        e => assert_equals(e.candidate, null, 'Should get no ICE candidates'));

    offerer.addTransceiver('audio');
    const offer = await offerer.createOffer();
    await answerer.setRemoteDescription(offer);
    await answerer.setLocalDescription(await answerer.createAnswer());
    await waitForIceGatheringState(answerer, ['complete']);
  }, `iceTransportPolicy "relay" on answerer should prevent candidate gathering`);

  promise_test(async t => {
    const offerer = new RTCPeerConnection();
    const answerer = new RTCPeerConnection();
    t.add_cleanup(() => offerer.close());
    t.add_cleanup(() => answerer.close());

    offerer.addTransceiver('audio');

    exchangeIceCandidates(offerer, answerer);

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [oldUfrag] = getUfrags(offerer.localDescription);

    offerer.setConfiguration({iceTransportPolicy: 'relay'});

    offerer.addEventListener('icecandidate',
        e => assert_equals(e.candidate, null, 'Should get no ICE candidates'));

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      waitForIceStateChange(offerer, ['failed']),
      waitForIceStateChange(answerer, ['failed']),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [newUfrag] = getUfrags(offerer.localDescription);
    assert_not_equals(oldUfrag, newUfrag,
        'Changing iceTransportPolicy should prompt an ICE restart');
  }, `Changing iceTransportPolicy from "all" to "relay" causes an ICE restart which should fail, with no new candidates`);

  promise_test(async t => {
    const offerer = new RTCPeerConnection({iceTransportPolicy: 'relay'});
    const answerer = new RTCPeerConnection();
    t.add_cleanup(() => offerer.close());
    t.add_cleanup(() => answerer.close());

    offerer.addTransceiver('audio');

    exchangeIceCandidates(offerer, answerer);

    const checkNoCandidate =
        e => assert_equals(e.candidate, null, 'Should get no ICE candidates');

    offerer.addEventListener('icecandidate', checkNoCandidate);

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      waitForIceStateChange(offerer, ['failed']),
      waitForIceStateChange(answerer, ['failed']),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [oldUfrag] = getUfrags(offerer.localDescription);

    offerer.setConfiguration({iceTransportPolicy: 'all'});

    offerer.removeEventListener('icecandidate', checkNoCandidate);

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [newUfrag] = getUfrags(offerer.localDescription);
    assert_not_equals(oldUfrag, newUfrag,
        'Changing iceTransportPolicy should prompt an ICE restart');
  }, `Changing iceTransportPolicy from "relay" to "all" causes an ICE restart which should succeed`);

  promise_test(async t => {
    const offerer = new RTCPeerConnection();
    const answerer = new RTCPeerConnection();
    t.add_cleanup(() => offerer.close());
    t.add_cleanup(() => answerer.close());

    offerer.addTransceiver('audio');

    exchangeIceCandidates(offerer, answerer);

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [oldUfrag] = getUfrags(offerer.localDescription);

    offerer.setConfiguration({iceTransportPolicy: 'relay'});
    offerer.setConfiguration({iceTransportPolicy: 'all'});

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [newUfrag] = getUfrags(offerer.localDescription);
    assert_not_equals(oldUfrag, newUfrag,
        'Changing iceTransportPolicy should prompt an ICE restart');
  }, `Changing iceTransportPolicy from "all" to "relay", and back to "all" prompts an ICE restart`);

  promise_test(async t => {
    const offerer = new RTCPeerConnection();
    const answerer = new RTCPeerConnection();
    t.add_cleanup(() => offerer.close());
    t.add_cleanup(() => answerer.close());

    offerer.addTransceiver('audio');

    exchangeIceCandidates(offerer, answerer);

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [oldUfrag] = getUfrags(answerer.localDescription);

    answerer.setConfiguration({iceTransportPolicy: 'relay'});

    await Promise.all([
      exchangeOfferAnswer(offerer, answerer),
      listenToIceConnected(offerer),
      listenToIceConnected(answerer),
      waitForIceGatheringState(offerer, ['complete']),
      waitForIceGatheringState(answerer, ['complete'])
    ]);

    const [newUfrag] = getUfrags(answerer.localDescription);
    assert_equals(oldUfrag, newUfrag,
        'Changing iceTransportPolicy on answerer should not effect ufrag');
  }, `Changing iceTransportPolicy from "all" to "relay" on the answerer has no effect on a subsequent offer/answer`);

</script>