michael@0: //
michael@0: // Verify that the VALIDATE_NEVER and LOAD_FROM_CACHE flags override
michael@0: // heuristic query freshness as defined in RFC 2616 section 13.9
michael@0: //
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:     // RFC 2616 section 13.9 2nd paragraph - query-url should be validated
michael@0:     {url: "/freshness?a", server: "0", expected: "0"},
michael@0:     {url: "/freshness?a", server: "1", expected: "1"},
michael@0: 
michael@0:     // Setting the VALIDATE_NEVER flag should grab entry from cache
michael@0:     {url: "/freshness?a", server: "2", expected: "1",
michael@0:      flags: Components.interfaces.nsIRequest.VALIDATE_NEVER },
michael@0: 
michael@0:     // Finally, check that request is validated with no flags set
michael@0:     {url: "/freshness?a", server: "99", expected: "99"},
michael@0:     
michael@0:     
michael@0:     // RFC 2616 section 13.9 2nd paragraph - query-url should be validated
michael@0:     {url: "/freshness?b", server: "0", expected: "0"},
michael@0:     {url: "/freshness?b", server: "1", expected: "1"},
michael@0: 
michael@0:     // Setting the LOAD_FROM_CACHE flag also grab the entry from cache
michael@0:     {url: "/freshness?b", server: "2", expected: "1",
michael@0:      flags: Components.interfaces.nsIRequest.LOAD_FROM_CACHE },
michael@0: 
michael@0:     // Finally, check that request is validated with no flags set
michael@0:     {url: "/freshness?b", server: "99", expected: "99"},
michael@0: 
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:" +
michael@0:                               httpserver.identity.primaryPort +
michael@0:                               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 test = tests[index];
michael@0:     var channel = setupChannel(test.url, test.server);
michael@0:     if (test.flags) channel.loadFlags = test.flags;
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:         // this call happens in onStopRequest from the channel, and opening a
michael@0:         // new channel to the same url here is no good idea...  post it instead
michael@0:         do_timeout(1, 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: 
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: }