summaryrefslogtreecommitdiffstats
path: root/test/wpt/tests/fetch/metadata/tools/templates/window-history.sub.html
blob: 286d019887d46629e9c69dcc2643a21005f6ff65 (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
<!DOCTYPE html>
<!--
[%provenance%]
-->
<html lang="en">
  <meta charset="utf-8">
  {%- if subtests|length > 10 %}
  <meta name="timeout" content="long">
  {%- endif %}
  <title>HTTP headers on request for navigation via the HTML History API</title>
  <script src="/resources/testharness.js"></script>
  <script src="/resources/testharnessreport.js"></script>
  {%- if subtests|selectattr('userActivated')|list %}
  <script src="/resources/testdriver.js"></script>
  <script src="/resources/testdriver-vendor.js"></script>
  {%- endif %}
  <script src="/fetch/metadata/resources/helper.sub.js"></script>
  <body>
  <script>
  'use strict';

  const whenDone = (win) => {
    return new Promise((resolve) => {
      addEventListener('message', function handle(event) {
        if (event.source === win) {
          resolve();
          removeEventListener('message', handle);
        }
      });
    })
  };

  /**
   * Prime the UA's session history such that the location of the request is
   * immediately behind the current entry. Because the location may not be
   * same-origin with the current browsing context, this must be done via a
   * true navigation and not, e.g. the `history.pushState` API. The initial
   * navigation will alter the WPT server's internal state; in order to avoid
   * false positives, clear that state prior to initiating the second
   * navigation via `history.back`.
   */
  function induceBackRequest(url, test, clear) {
    const win = window.open(url);

    test.add_cleanup(() => win.close());

    return whenDone(win)
      .then(clear)
      .then(() => win.history.back())
      .then(() => whenDone(win));
  }

  /**
   * Prime the UA's session history such that the location of the request is
   * immediately ahead of the current entry. Because the location may not be
   * same-origin with the current browsing context, this must be done via a
   * true navigation and not, e.g. the `history.pushState` API. The initial
   * navigation will alter the WPT server's internal state; in order to avoid
   * false positives, clear that state prior to initiating the second
   * navigation via `history.forward`.
   */
  function induceForwardRequest(url, test, clear) {
    const win = window.open(messageOpenerUrl);

    test.add_cleanup(() => win.close());

    return whenDone(win)
      .then(() => win.location = url)
      .then(() => whenDone(win))
      .then(clear)
      .then(() => win.history.go(-2))
      .then(() => whenDone(win))
      .then(() => win.history.forward())
      .then(() => whenDone(win));
  }

  const messageOpenerUrl = new URL(
    '/fetch/metadata/resources/message-opener.html', location
  );
  // For these tests to function, replacement must *not* be enabled during
  // navigation. Assignment must therefore take place after the document has
  // completely loaded [1]. This event is not directly observable, but it is
  // scheduled as a task immediately following the global object's `load`
  // event [2]. By queuing a task during the dispatch of the `load` event,
  // navigation can be consistently triggered without replacement.
  //
  // [1] https://html.spec.whatwg.org/multipage/history.html#location-object-setter-navigate
  // [2] https://html.spec.whatwg.org/multipage/parsing.html#the-end
  const responseParams = {
    mime: 'text/html',
    body: `<script>
      window.addEventListener('load', () => {
        set`+`Timeout(() => location.assign('${messageOpenerUrl}'));
      });
    <`+`/script>`
  };
  {%- for subtest in subtests %}

  promise_test((t) => {
    const key = '{{uuid()}}';
    const url = makeRequestURL(key, [% subtest.origins %], responseParams);

    return induceBackRequest(url, t, () => retrieve(key))
      .then(() => retrieve(key))
      .then((headers) => {
        {%- if subtest.expected == none %}
          assert_not_own_property(headers, '[%subtest.headerName%]');
        {%- else %}
          assert_own_property(headers, '[%subtest.headerName%]');
          assert_array_equals(headers['[%subtest.headerName%]'], ['[%subtest.expected%]']);
        {%- endif %}
        });
  }, '[%subtest.headerName%] - [%subtest.description | pad("right", " - ")%]history.back[%subtest.api%][% " with user activation" if subtest.userActivated%]');

  promise_test((t) => {
    const key = '{{uuid()}}';
    const url = makeRequestURL(key, [% subtest.origins %], responseParams);

    return induceForwardRequest(url, t, () => retrieve(key))
      .then(() => retrieve(key))
      .then((headers) => {
        {%- if subtest.expected == none %}
          assert_not_own_property(headers, '[%subtest.headerName%]');
        {%- else %}
          assert_own_property(headers, '[%subtest.headerName%]');
          assert_array_equals(headers['[%subtest.headerName%]'], ['[%subtest.expected%]']);
        {%- endif %}
        });
  }, '[%subtest.headerName%] - [%subtest.description | pad("right", " - ")%]history.forward[%subtest.api%][% " with user activation" if subtest.userActivated%]');

  {%- endfor %}
  </script>
  </body>
</html>