The Tor Browser: extensions/cookie/test/unit/test_domain_eviction.js@b8a032363ba2 (annotated)

extensions/cookie/test/unit/test_domain_eviction.js@b8a032363ba2 (annotated)

extensions/cookie/test/unit/test_domain_eviction.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* 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.
 let 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 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);
   do_check_eq(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);
   do_check_eq(countCookies("foo.baz", "baz.bar.foo.baz"), 40);
   setCookies("foo.baz", 20, futureExpiry);
   do_check_eq(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);
   do_check_eq(countCookies("horse.radish", "horse.radish"), 50);
   let enumerator = Services.cookiemgr.enumerator;
   while (enumerator.hasMoreElements()) {
     let cookie = enumerator.getNext().QueryInterface(Ci.nsICookie2);
     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.cookiemgr.add("captchart.com", "", "test100", "eviction",
     false, false, false, shortExpiry);
   do_timeout(2100, continue_test);
   yield;
   do_check_eq(countCookies("captchart.com", "captchart.com"), 50);
   Services.cookiemgr.add("captchart.com", "", "test200", "eviction",
     false, false, false, futureExpiry);
   do_check_eq(countCookies("captchart.com", "captchart.com"), 50);
   let enumerator = Services.cookiemgr.getCookiesFromHost("captchart.com");
   while (enumerator.hasMoreElements()) {
     let cookie = enumerator.getNext().QueryInterface(Ci.nsICookie2);
     do_check_true(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.cookiemgr.add(aHost, "", "test" + i, "eviction",
       false, false, false, aExpiry);
 }
 // count how many cookies are within domain 'aBaseDomain', using three
 // independent interface methods on nsICookieManager2:
 // 1) 'enumerator', an enumerator of all cookies;
 // 2) 'countCookiesFromHost', which returns the number of cookies within the
 //    base domain of 'aHost',
 // 3) 'getCookiesFromHost', which returns an enumerator of 2).
 function
 countCookies(aBaseDomain, aHost)
 {
   let enumerator = Services.cookiemgr.enumerator;
   // count how many cookies are within domain 'aBaseDomain' using the cookie
   // enumerator.
   let cookies = [];
   while (enumerator.hasMoreElements()) {
     let cookie = enumerator.getNext().QueryInterface(Ci.nsICookie2);
     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;
   do_check_eq(Services.cookiemgr.countCookiesFromHost(aBaseDomain),
     cookies.length);
   do_check_eq(Services.cookiemgr.countCookiesFromHost(aHost), cookies.length);
   enumerator = Services.cookiemgr.getCookiesFromHost(aHost);
   while (enumerator.hasMoreElements()) {
     let cookie = enumerator.getNext().QueryInterface(Ci.nsICookie2);
     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 enumerator");
     } else {
       do_throw("cookie host " + cookie.host + " not within domain " + aBaseDomain);
     }
   }
   do_check_eq(cookies.length, 0);
   return result;
 }