michael@0: //
michael@0: // This script emulates the test called "Freshness"
michael@0: // by Mark Nottingham, located at
michael@0: //
michael@0: // http://mnot.net/javascript/xmlhttprequest/cache.html
michael@0: //
michael@0: // The issue with Mr. Nottinghams page is that the server
michael@0: // always seems to send an Expires-header in the response,
michael@0: // breaking the finer details of the test. This script has
michael@0: // full control of response-headers, however, and can perform
michael@0: // the intended testing plus some extra stuff.
michael@0: //
michael@0: // Please see RFC 2616 section 13.2.1 6th paragraph for the
michael@0: // definition of "explicit expiration time" being used here.
michael@0: 
michael@0: Cu.import("resource://testing-common/httpd.js");
michael@0: 
michael@0: var httpserver = new HttpServer();
michael@0: var index = 0;
michael@0: var tests = [
michael@0:     {url: "/freshness",   server: "0", expected: "0"},
michael@0:     {url: "/freshness",   server: "1", expected: "0"}, // cached
michael@0: 
michael@0:     // RFC 2616 section 13.9 2nd paragraph
michael@0:     {url: "/freshness?a", server: "2", expected: "2"},
michael@0:     {url: "/freshness?a", server: "3", expected: "3"},
michael@0: 
michael@0:     // explicit expiration dates in the future should be cached
michael@0:     {url: "/freshness?b", server: "4", expected: "4",
michael@0:      responseheader: "Expires: "+getDateString(1)},
michael@0:     {url: "/freshness?b", server: "5", expected: "4"},// cached due to Expires
michael@0:     
michael@0:     {url: "/freshness?c", server: "6", expected: "6",
michael@0:      responseheader: "Cache-Control: max-age=3600"},
michael@0:     {url: "/freshness?c", server: "7", expected: "6"}, // cached due to max-age
michael@0: 
michael@0:     // explicit expiration dates in the past should NOT be cached
michael@0:     {url: "/freshness?d", server: "8", expected: "8",
michael@0:      responseheader: "Expires: "+getDateString(-1)},
michael@0:     {url: "/freshness?d", server: "9", expected: "9"},
michael@0:     
michael@0:     {url: "/freshness?e", server: "10", expected: "10",
michael@0:      responseheader: "Cache-Control: max-age=0"},
michael@0:     {url: "/freshness?e", server: "11", expected: "11"},
michael@0: 
michael@0:     {url: "/freshness",   server: "99", expected: "0"}, // cached
michael@0: ];
michael@0: 
michael@0: function logit(i, data) {
michael@0:     dump(tests[i].url + "\t requested [" + tests[i].server + "]" +
michael@0:          " got [" + data + "] expected [" + tests[i].expected + "]");
michael@0:     if (tests[i].responseheader)
michael@0:         dump("\t[" + tests[i].responseheader + "]");
michael@0:     dump("\n");
michael@0: }
michael@0: 
michael@0: function setupChannel(suffix, value) {
michael@0:     var ios = Components.classes["@mozilla.org/network/io-service;1"].
michael@0:                          getService(Ci.nsIIOService);
michael@0:     var chan = ios.newChannel("http://localhost:" + httpserver.identity.primaryPort + suffix, "", null);
michael@0:     var httpChan = chan.QueryInterface(Components.interfaces.nsIHttpChannel);
michael@0:     httpChan.requestMethod = "GET";
michael@0:     httpChan.setRequestHeader("x-request", value, false);
michael@0:     return httpChan;
michael@0: }
michael@0: 
michael@0: function triggerNextTest() {
michael@0:     var channel = setupChannel(tests[index].url, tests[index].server);
michael@0:     channel.asyncOpen(new ChannelListener(checkValueAndTrigger, null),null);
michael@0: }
michael@0: 
michael@0: function checkValueAndTrigger(request, data, ctx) {
michael@0:     logit(index, data);
michael@0:     do_check_eq(tests[index].expected, data);
michael@0: 
michael@0:     if (index < tests.length-1) {
michael@0:         index++;
michael@0:         triggerNextTest();
michael@0:     } else {
michael@0:         httpserver.stop(do_test_finished);
michael@0:     }
michael@0: }
michael@0: 
michael@0: function run_test() {
michael@0:     httpserver.registerPathHandler("/freshness", handler);
michael@0:     httpserver.start(-1);
michael@0: 
michael@0:     // clear cache
michael@0:     evict_cache_entries();
michael@0:     triggerNextTest();
michael@0: 
michael@0:     do_test_pending();
michael@0: }
michael@0: 
michael@0: function handler(metadata, response) {
michael@0:     var body = metadata.getHeader("x-request");
michael@0:     response.setHeader("Content-Type", "text/plain", false);
michael@0:     response.setHeader("Date", getDateString(0), false);
michael@0:     
michael@0:     var header = tests[index].responseheader;
michael@0:     if (header == null) {
michael@0:         response.setHeader("Last-Modified", getDateString(-1), false);
michael@0:     } else {
michael@0:         var splitHdr = header.split(": ");
michael@0:         response.setHeader(splitHdr[0], splitHdr[1], false);
michael@0:     }
michael@0:     
michael@0:     response.setStatusLine(metadata.httpVersion, 200, "OK");
michael@0:     response.bodyOutputStream.write(body, body.length);
michael@0: }
michael@0:  
michael@0: function getDateString(yearDelta) {
michael@0:     var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
michael@0:                   'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
michael@0:     var days = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
michael@0: 
michael@0:     var d = new Date();
michael@0:     return days[d.getUTCDay()] + ", " +
michael@0:             d.getUTCDate() + " " +
michael@0:             months[d.getUTCMonth()] + " " +
michael@0:             (d.getUTCFullYear() + yearDelta) + " " +
michael@0:             d.getUTCHours() + ":" + d.getUTCMinutes() +":" +
michael@0:             d.getUTCSeconds() + " UTC";
michael@0: }