netwerk/test/unit/test_bug468594.js

   1 //
   2 // This script emulates the test called "Freshness"
   3 // by Mark Nottingham, located at
   4 //
   5 // http://mnot.net/javascript/xmlhttprequest/cache.html
   6 //
   7 // The issue with Mr. Nottinghams page is that the server
   8 // always seems to send an Expires-header in the response,
   9 // breaking the finer details of the test. This script has
  10 // full control of response-headers, however, and can perform
  11 // the intended testing plus some extra stuff.
  12 //
  13 // Please see RFC 2616 section 13.2.1 6th paragraph for the
  14 // definition of "explicit expiration time" being used here.
  15
  16 "use strict";
  17
  18 const { HttpServer } = ChromeUtils.import("resource://testing-common/httpd.js");
  19
  20 var httpserver = new HttpServer();
  21 var index = 0;
  22 var tests = [
  23   { url: "/freshness", server: "0", expected: "0" },
  24   { url: "/freshness", server: "1", expected: "0" }, // cached
  25
  26   // RFC 2616 section 13.9 2nd paragraph says not to heuristically cache
  27   // querystring, but we allow it to maintain web compat
  28   { url: "/freshness?a", server: "2", expected: "2" },
  29   { url: "/freshness?a", server: "3", expected: "2" },
  30
  31   // explicit expiration dates in the future should be cached
  32   {
  33     url: "/freshness?b",
  34     server: "4",
  35     expected: "4",
  36     responseheader: "Expires: " + getDateString(1),
  37   },
  38   { url: "/freshness?b", server: "5", expected: "4" }, // cached due to Expires
  39
  40   {
  41     url: "/freshness?c",
  42     server: "6",
  43     expected: "6",
  44     responseheader: "Cache-Control: max-age=3600",
  45   },
  46   { url: "/freshness?c", server: "7", expected: "6" }, // cached due to max-age
  47
  48   // explicit expiration dates in the past should NOT be cached
  49   {
  50     url: "/freshness?d",
  51     server: "8",
  52     expected: "8",
  53     responseheader: "Expires: " + getDateString(-1),
  54   },
  55   { url: "/freshness?d", server: "9", expected: "9" },
  56
  57   {
  58     url: "/freshness?e",
  59     server: "10",
  60     expected: "10",
  61     responseheader: "Cache-Control: max-age=0",
  62   },
  63   { url: "/freshness?e", server: "11", expected: "11" },
  64
  65   { url: "/freshness", server: "99", expected: "0" }, // cached
  66 ];
  67
  68 function logit(i, data) {
  69   dump(
  70     tests[i].url +
  71       "\t requested [" +
  72       tests[i].server +
  73       "]" +
  74       " got [" +
  75       data +
  76       "] expected [" +
  77       tests[i].expected +
  78       "]"
  79   );
  80   if (tests[i].responseheader) {
  81     dump("\t[" + tests[i].responseheader + "]");
  82   }
  83   dump("\n");
  84 }
  85
  86 function setupChannel(suffix, value) {
  87   var chan = NetUtil.newChannel({
  88     uri: "http://localhost:" + httpserver.identity.primaryPort + suffix,
  89     loadUsingSystemPrincipal: true,
  90   });
  91   var httpChan = chan.QueryInterface(Ci.nsIHttpChannel);
  92   httpChan.requestMethod = "GET";
  93   httpChan.setRequestHeader("x-request", value, false);
  94   return httpChan;
  95 }
  96
  97 function triggerNextTest() {
  98   var channel = setupChannel(tests[index].url, tests[index].server);
  99   channel.asyncOpen(new ChannelListener(checkValueAndTrigger, null));
 100 }
 101
 102 function checkValueAndTrigger(request, data, ctx) {
 103   logit(index, data);
 104   Assert.equal(tests[index].expected, data);
 105
 106   if (index < tests.length - 1) {
 107     index++;
 108     triggerNextTest();
 109   } else {
 110     httpserver.stop(do_test_finished);
 111   }
 112 }
 113
 114 function run_test() {
 115   httpserver.registerPathHandler("/freshness", handler);
 116   httpserver.start(-1);
 117
 118   // clear cache
 119   evict_cache_entries();
 120   triggerNextTest();
 121
 122   do_test_pending();
 123 }
 124
 125 function handler(metadata, response) {
 126   var body = metadata.getHeader("x-request");
 127   response.setHeader("Content-Type", "text/plain", false);
 128   response.setHeader("Date", getDateString(0), false);
 129
 130   var header = tests[index].responseheader;
 131   if (header == null) {
 132     response.setHeader("Last-Modified", getDateString(-1), false);
 133   } else {
 134     var splitHdr = header.split(": ");
 135     response.setHeader(splitHdr[0], splitHdr[1], false);
 136   }
 137
 138   response.setStatusLine(metadata.httpVersion, 200, "OK");
 139   response.bodyOutputStream.write(body, body.length);
 140 }
 141
 142 function getDateString(yearDelta) {
 143   var months = [
 144     "Jan",
 145     "Feb",
 146     "Mar",
 147     "Apr",
 148     "May",
 149     "Jun",
 150     "Jul",
 151     "Aug",
 152     "Sep",
 153     "Oct",
 154     "Nov",
 155     "Dec",
 156   ];
 157   var days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
 158
 159   var d = new Date();
 160   return (
 161     days[d.getUTCDay()] +
 162     ", " +
 163     d.getUTCDate() +
 164     " " +
 165     months[d.getUTCMonth()] +
 166     " " +
 167     (d.getUTCFullYear() + yearDelta) +
 168     " " +
 169     d.getUTCHours() +
 170     ":" +
 171     d.getUTCMinutes() +
 172     ":" +
 173     d.getUTCSeconds() +
 174     " UTC"
 175   );
 176 }