summaryrefslogtreecommitdiffstats
path: root/netwerk/test/unit/test_domain_eviction.js
blob: 58520c2daac205a323aa280bb61222ac41d8f914 (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

// Test that domain eviction occurs when the cookies per base domain limit is
// reached, and that expired cookies are evicted before live cookies.

"use strict";

var test_generator = do_run_test();

function run_test() {
  do_test_pending();
  do_run_generator(test_generator);
}

function continue_test() {
  do_run_generator(test_generator);
}

function* do_run_test() {
  // Set quotaPerHost to maxPerHost - 1, so there is only one cookie
  // will be evicted everytime.
  Services.prefs.setIntPref("network.cookie.quotaPerHost", 49);
  // Set the base domain limit to 50 so we have a known value.
  Services.prefs.setIntPref("network.cookie.maxPerHost", 50);

  let futureExpiry = Math.floor(Date.now() / 1000 + 1000);

  // test eviction under the 50 cookies per base domain limit. this means
  // that cookies for foo.com and bar.foo.com should count toward this limit,
  // while cookies for baz.com should not. there are several tests we perform
  // to make sure the base domain logic is working correctly.

  // 1) simplest case: set 100 cookies for "foo.bar" and make sure 50 survive.
  setCookies("foo.bar", 100, futureExpiry);
  Assert.equal(countCookies("foo.bar", "foo.bar"), 50);

  // 2) set cookies for different subdomains of "foo.baz", and an unrelated
  // domain, and make sure all 50 within the "foo.baz" base domain are counted.
  setCookies("foo.baz", 10, futureExpiry);
  setCookies(".foo.baz", 10, futureExpiry);
  setCookies("bar.foo.baz", 10, futureExpiry);
  setCookies("baz.bar.foo.baz", 10, futureExpiry);
  setCookies("unrelated.domain", 50, futureExpiry);
  Assert.equal(countCookies("foo.baz", "baz.bar.foo.baz"), 40);
  setCookies("foo.baz", 20, futureExpiry);
  Assert.equal(countCookies("foo.baz", "baz.bar.foo.baz"), 50);

  // 3) ensure cookies are evicted by order of lastAccessed time, if the
  // limit on cookies per base domain is reached.
  setCookies("horse.radish", 10, futureExpiry);

  // Wait a while, to make sure the first batch of cookies is older than
  // the second (timer resolution varies on different platforms).
  do_timeout(100, continue_test);
  yield;

  setCookies("tasty.horse.radish", 50, futureExpiry);
  Assert.equal(countCookies("horse.radish", "horse.radish"), 50);

  for (let cookie of Services.cookies.cookies) {
    if (cookie.host == "horse.radish") {
      do_throw("cookies not evicted by lastAccessed order");
    }
  }

  // Test that expired cookies for a domain are evicted before live ones.
  let shortExpiry = Math.floor(Date.now() / 1000 + 2);
  setCookies("captchart.com", 49, futureExpiry);
  Services.cookies.add(
    "captchart.com",
    "",
    "test100",
    "eviction",
    false,
    false,
    false,
    shortExpiry,
    {},
    Ci.nsICookie.SAMESITE_NONE,
    Ci.nsICookie.SCHEME_HTTPS
  );
  do_timeout(2100, continue_test);
  yield;

  Assert.equal(countCookies("captchart.com", "captchart.com"), 50);
  Services.cookies.add(
    "captchart.com",
    "",
    "test200",
    "eviction",
    false,
    false,
    false,
    futureExpiry,
    {},
    Ci.nsICookie.SAMESITE_NONE,
    Ci.nsICookie.SCHEME_HTTPS
  );
  Assert.equal(countCookies("captchart.com", "captchart.com"), 50);

  for (let cookie of Services.cookies.getCookiesFromHost("captchart.com", {})) {
    Assert.ok(cookie.expiry == futureExpiry);
  }

  do_finish_generator_test(test_generator);
}

// set 'aNumber' cookies with host 'aHost', with distinct names.
function setCookies(aHost, aNumber, aExpiry) {
  for (let i = 0; i < aNumber; ++i) {
    Services.cookies.add(
      aHost,
      "",
      "test" + i,
      "eviction",
      false,
      false,
      false,
      aExpiry,
      {},
      Ci.nsICookie.SAMESITE_NONE,
      Ci.nsICookie.SCHEME_HTTPS
    );
  }
}

// count how many cookies are within domain 'aBaseDomain', using three
// independent interface methods on nsICookieManager:
// 1) 'cookies', an array of all cookies;
// 2) 'countCookiesFromHost', which returns the number of cookies within the
//    base domain of 'aHost',
// 3) 'getCookiesFromHost', which returns an array of 2).
function countCookies(aBaseDomain, aHost) {
  // count how many cookies are within domain 'aBaseDomain' using the cookies
  // array.
  let cookies = [];
  for (let cookie of Services.cookies.cookies) {
    if (
      cookie.host.length >= aBaseDomain.length &&
      cookie.host.slice(cookie.host.length - aBaseDomain.length) == aBaseDomain
    ) {
      cookies.push(cookie);
    }
  }

  // confirm the count using countCookiesFromHost and getCookiesFromHost.
  let result = cookies.length;
  Assert.equal(
    Services.cookies.countCookiesFromHost(aBaseDomain),
    cookies.length
  );
  Assert.equal(Services.cookies.countCookiesFromHost(aHost), cookies.length);

  for (let cookie of Services.cookies.getCookiesFromHost(aHost, {})) {
    if (
      cookie.host.length >= aBaseDomain.length &&
      cookie.host.slice(cookie.host.length - aBaseDomain.length) == aBaseDomain
    ) {
      let found = false;
      for (let i = 0; i < cookies.length; ++i) {
        if (cookies[i].host == cookie.host && cookies[i].name == cookie.name) {
          found = true;
          cookies.splice(i, 1);
          break;
        }
      }

      if (!found) {
        do_throw("cookie " + cookie.name + " not found in master cookies");
      }
    } else {
      do_throw(
        "cookie host " + cookie.host + " not within domain " + aBaseDomain
      );
    }
  }

  Assert.equal(cookies.length, 0);

  return result;
}