michael@0: //
michael@0: // Tests if a response with an Expires-header in the past
michael@0: // and Cache-Control: max-age  in the future works as
michael@0: // specified in RFC 2616 section 14.9.3 by letting max-age
michael@0: // take precedence
michael@0: 
michael@0: Cu.import("resource://testing-common/httpd.js");
michael@0: const BUGID = "203271";
michael@0: 
michael@0: var httpserver = new HttpServer();
michael@0: var index = 0;
michael@0: var tests = [
michael@0:     // original problem described in bug#203271
michael@0:     {url: "/precedence", server: "0", expected: "0",
michael@0:      responseheader: [ "Expires: " + getDateString(-1),
michael@0:                        "Cache-Control: max-age=3600"]},
michael@0: 
michael@0:     {url: "/precedence?0", server: "0", expected: "0",
michael@0:      responseheader: [ "Cache-Control: max-age=3600",
michael@0:                        "Expires: " + getDateString(-1)]},
michael@0: 
michael@0:     // max-age=1s, expires=1 year from now
michael@0:     {url: "/precedence?1", server: "0", expected: "0",
michael@0:      responseheader: [ "Expires: " + getDateString(1),
michael@0:                        "Cache-Control: max-age=1"]},
michael@0: 
michael@0:     // expires=now
michael@0:     {url: "/precedence?2", server: "0", expected: "0",
michael@0:      responseheader: [ "Expires: " + getDateString(0)]},
michael@0: 
michael@0:     // max-age=1s
michael@0:     {url: "/precedence?3", server: "0", expected: "0",
michael@0:      responseheader: ["Cache-Control: max-age=1"]},
michael@0: 
michael@0:     // The test below is the example from
michael@0:     //
michael@0:     //         https://bugzilla.mozilla.org/show_bug.cgi?id=203271#c27
michael@0:     //
michael@0:     //  max-age=2592000s (1 month), expires=1 year from now, date=1 year ago
michael@0:     {url: "/precedence?4", server: "0", expected: "0",
michael@0:      responseheader: [ "Cache-Control: private, max-age=2592000",
michael@0:                        "Expires: " + getDateString(+1)],
michael@0:      explicitDate: getDateString(-1)},
michael@0: 
michael@0:     // The two tests below are also examples of clocks really out of synch
michael@0:     // max-age=1s, date=1 year from now
michael@0:     {url: "/precedence?5", server: "0", expected: "0",
michael@0:      responseheader: [ "Cache-Control: max-age=1"],
michael@0:      explicitDate: getDateString(1)},
michael@0: 
michael@0:     // max-age=60s, date=1 year from now
michael@0:     {url: "/precedence?6", server: "0", expected: "0",
michael@0:      responseheader: [ "Cache-Control: max-age=60"],
michael@0:      explicitDate: getDateString(1)},
michael@0: 
michael@0:     // this is just to get a pause of 3s to allow cache-entries to expire
michael@0:     {url: "/precedence?999", server: "0", expected: "0", delay: "3000"},
michael@0: 
michael@0:     // Below are the cases which actually matters
michael@0:     {url: "/precedence", server: "1", expected: "0"}, // should be cached
michael@0:      
michael@0:     {url: "/precedence?0", server: "1", expected: "0"}, // should be cached
michael@0: 
michael@0:     {url: "/precedence?1", server: "1", expected: "1"}, // should have expired
michael@0: 
michael@0:     {url: "/precedence?2", server: "1", expected: "1"}, // should have expired
michael@0: 
michael@0:     {url: "/precedence?3", server: "1", expected: "1"}, // should have expired
michael@0: 
michael@0:     {url: "/precedence?4", server: "1", expected: "1"}, // should have expired
michael@0: 
michael@0:     {url: "/precedence?5", server: "1", expected: "1"}, // should have expired
michael@0:     
michael@0:     {url: "/precedence?6", server: "1", expected: "0"}, // should be cached
michael@0: 
michael@0: ];
michael@0: 
michael@0: function logit(i, data, ctx) {
michael@0:     dump("requested [" + tests[i].server + "] " +
michael@0:          "got [" + data + "] " +
michael@0:          "expected [" + tests[i].expected + "]");
michael@0: 
michael@0:     if (tests[i].responseheader)
michael@0:         dump("\t[" + tests[i].responseheader + "]");
michael@0:     dump("\n");
michael@0:     // Dump all response-headers
michael@0:     dump("\n===================================\n")
michael@0:     ctx.visitResponseHeaders({
michael@0:         visitHeader: function(key, val) {
michael@0:             dump("\t" + key + ":"+val + "\n");
michael@0:         }}
michael@0:     );
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 + suffix,
michael@0:                               "", null);
michael@0:     var httpChan = chan.QueryInterface(Components.interfaces.nsIHttpChannel);
michael@0:     httpChan.requestMethod = "GET"; // default value, just being paranoid...
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, channel), null);
michael@0: }
michael@0: 
michael@0: function checkValueAndTrigger(request, data, ctx) {
michael@0:     logit(index, data, ctx);
michael@0:     do_check_eq(tests[index].expected, data);
michael@0: 
michael@0:     if (index < tests.length - 1) {
michael@0:         var delay = tests[index++].delay;
michael@0:         if (delay) {
michael@0:             do_timeout(delay, triggerNextTest);
michael@0:         } else {
michael@0:             triggerNextTest();
michael@0:         }
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("/precedence", handler);
michael@0:     httpserver.start(-1);
michael@0: 
michael@0:     // clear cache
michael@0:     evict_cache_entries();
michael@0: 
michael@0:     triggerNextTest();
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: 
michael@0:     var date = tests[index].explicitDate;
michael@0:     if (date == undefined) {
michael@0:         response.setHeader("Date", getDateString(0), false);
michael@0:     } else {
michael@0:         response.setHeader("Date", date, false);
michael@0:     }
michael@0: 
michael@0:     var header = tests[index].responseheader;
michael@0:     if (header == undefined) {
michael@0:         response.setHeader("Last-Modified", getDateString(-1), false);
michael@0:     } else {
michael@0:         for (var i = 0; i < header.length; i++) {
michael@0:             var splitHdr = header[i].split(": ");
michael@0:             response.setHeader(splitHdr[0], splitHdr[1], false);
michael@0:         }
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', 'Jul', 'Aug',
michael@0:                   '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: }