nodulator/node_modules_bak/connect-cachify/test/connect-cachify-test.js

Complete NodeJS Framework for Restfull APIs

var cachify  = require('../lib/connect-cachify'),
    path     = require('path'),
    fs       = require('fs'),
    nodeunit = require('nodeunit'),
    step     = require('step');

// reset cachify's internal state to default
// settings...
var resetConfig = function () {
  cachify.setup({
    production: true,
    root: '.',
    debug: false
  });
};

var make_assets = function () { return {
  "/js/main.min.js": [
    "/js/lib/jquery.js",
    "/js/lib/jquery-foomatic.js",
    "/js/main.js",
    "/js/font-loader.js#with_fragment_id"
  ]}; };

function get_resp() {
  return {
    state: {},
    local: function (key, value) {
      this.state[key] = value;
    },
    setHeader: function (key, value) {
      this.state[key] = value;
      if (!this.state['header']) this.state['header'] = 0;
      this.state['header'] += 1;
    },
    on: function (name, cb) {
    }
  };
}

exports.setup = nodeunit.testCase({
  setUp: function (cb) {
    resetConfig();
    step(
      fs.mkdir('/tmp/js', this),
      function (err) {
        fs.mkdir('/tmp/js/lib', this);
      },
      function (err) {
        fs.writeFile('/tmp/js/main.min.js', "", "utf8", this);
      },
      function (err) {
        fs.writeFile('/tmp/js/lib/jquery.js', "", "utf8", this);
      },
      function (err) {
        fs.writeFile('/tmp/js/lib/jquery-foomatic.js', "", "utf8", this);
      },
      function (err) {
        fs.writeFile('/tmp/js/main.js', "", "utf8", this);
      },
      function (err) {
        fs.writeFile('/tmp/js/font-loader.js', "", "utf8", this);
      },
      function (err) {
        cb();
      }
    );
  },
  tearDown: function (cb) {
    step(
      fs.unlink('/tmp/js/main.js', this),
      function (err) {
        fs.unlink('/tmp/js/main.min.js', this);
      },
      function (err) {
        fs.unlink('/tmp/js/lib/jquery.js', this);
      },
      function (err) {
        fs.unlink('/tmp/js/lib/jquery-foomatic.js', this);
      },
      function (err) {
        fs.unlink('/tmp/js/font-loader.js', this);
      },
      function (err) {
        fs.rmdir('/tmp/js/lib', this);
      },
      function (err) {
        fs.rmdir('/tmp/js', this);
      },
      function (err) { cb(); }
    );
  },
  "No Config, no problem": function (test) {
    test.doesNotThrow(function () {
      cachify.setup();
    });
    test.done();
  },
  "Development mode with debug": function (test) {
    var assets = make_assets(),
        files,
        links,
        mddlwr;

    mddlwr = cachify.setup(assets, {
                             root: '/tmp',
                             production: false,
                             debug: true});

    links = cachify.cachify_js("/js/main.min.js").split('\n');
    test.equal(links[0], '<script src="/d41d8cd98f/js/lib/jquery.js"></script>',
              "debug option puts hash in all urls");

    links = cachify.cachify_js("/js/main.min.js",
        { defer: true }).split('\n');
    test.equal(links[0],
        '<script src="/d41d8cd98f/js/lib/jquery.js"></script>',
              "defer: true does not add defer attribute with production=false");

    links = cachify.cachify_js("/js/main.min.js",
        { async: true }).split('\n');
    test.equal(links[0],
        '<script src="/d41d8cd98f/js/lib/jquery.js"></script>',
              "async: true does not async attribute with production=false");

    files = cachify.cachify("/js/main.min.js", {tag_format: '<script src="%s" defer></script>'}).split('\n');
    test.equal(files[0], '<script src="/d41d8cd98f/js/lib/jquery.js" defer></script>');
    hints = cachify.cachify_prefetch("/js/main.min.js").split('\n');
    test.equal(hints[0], '<link rel="prefetch" href="/d41d8cd98f/js/lib/jquery.js">');
    test.done();
  },
  "Development mode": function (test) {
    var assets = make_assets(),
        req = {
          url: '/d41d8cd98f/js/main.min.js'
        },
        resp = get_resp(),
        mddlwr;
    mddlwr = cachify.setup(assets, {
                      root: '/tmp',
                      production: false
    });
    var links = cachify.cachify_js("/js/main.min.js").split('\n');
    test.equal(links.length, assets["/js/main.min.js"].length,
              "All script tags created");
    test.equal(links[0], '<script src="/js/lib/jquery.js"></script>',
              "No hashes in all urls during development");
    test.equal(links[3], '<script src="/js/font-loader.js#with_fragment_id"></script>',
              "Fragment identifier in URL is preserved");
    test.equal(cachify.uncached_resources.indexOf("/js/font-loader.js#with_fragment_id"), -1,
              "Fragment identifiers are never sent to server, search on disk for resource by removing fragment id");
    var files = cachify.cachify("/js/main.min.js").split('\n');
    test.equal(files.length, assets["/js/main.min.js"].length,
              "All urls created");
    test.equal(files[0], '/js/lib/jquery.js',
              "No hashes in all urls during development");
    var hints = cachify.cachify_prefetch("/js/main.min.js").split('\n');
    test.ok(hints.length, "Multiple link tags");
    test.equal(hints[0], '<link rel="prefetch" href="/js/lib/jquery.js">');
    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.header > 0);
      test.done();
    });
  },
  "Development mode with url query string": function (test) {
    var assets = make_assets(),
        mddlwr;
    mddlwr = cachify.setup(assets, {
      root: '/tmp',
      production: false
    });
    var links = cachify.cachify_js("/js/main.min.js?triedPassive=true").split('\n');
    test.equal(links.length, assets["/js/main.min.js"].length,
              "All script tags created");
    test.equal(links[0], '<script src="/js/lib/jquery.js?triedPassive=true"></script>',
              "No hashes in all urls during development");
    test.equal(links[3], '<script src="/js/font-loader.js?triedPassive=true#with_fragment_id"></script>',
              "Fragment identifier in URL is preserved");
    test.equal(cachify.uncached_resources.indexOf("/js/font-loader.js?triedPassive=true#with_fragment_id"), -1,
              "Fragment identifiers are never sent to server, search on disk for resource by removing fragment id");

    var files = cachify.cachify("/js/main.min.js?triedPassive=true").split('\n');
    test.equal(files.length, assets["/js/main.min.js"].length,
              "All urls created");
    test.equal(files[0], '/js/lib/jquery.js?triedPassive=true',
              "No hashes in all urls during development");

    var hints = cachify.cachify_prefetch("/js/main.min.js?triedPassive=true").split('\n');
    test.ok(hints.length, "Multiple link tags");
    test.equal(hints[0], '<link rel="prefetch" href="/js/lib/jquery.js?triedPassive=true">');
    test.done();
  },
  "Production mode": function (test) {
    var assets = make_assets(),
        req = {
          url: '/d41d8cd98f/js/main.min.js'
        },
        resp = get_resp(),
        mddlwr;
    mddlwr = cachify.setup(
        assets, {
          root: '/tmp'
    });
    var link = cachify.cachify_js("/js/main.min.js");
    test.equal(link, '<script src="/d41d8cd98f/js/main.min.js"></script>',
              "Hashes in all urls in production");

    links = cachify.cachify_js("/js/main.min.js",
        { defer: true }).split('\n');
    test.equal(links[0],
        '<script src="/d41d8cd98f/js/main.min.js" defer></script>',
              "defer: true adds defer attribute with production=true");

    links = cachify.cachify_js("/js/main.min.js",
        { async: true }).split('\n');
    test.equal(links[0],
        '<script src="/d41d8cd98f/js/main.min.js" async></script>',
              "async: true adds async attribute with production=true");

    var file = cachify.cachify("/js/main.min.js");
    test.equal(file, "/d41d8cd98f/js/main.min.js");
    var hint = cachify.cachify_prefetch("/js/main.min.js");
    test.equal(hint, '<link rel="prefetch" href="/d41d8cd98f/js/main.min.js">');
    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/js/main.min.js');
      test.done();
    });
  },
  "Production mode with url query string" : function (test) {
    var assets = make_assets(),
      req = {
        url: '/d41d8cd98f/js/main.min.js?triedPassive=true'
      },
      resp = get_resp(),
      mddlwr;
    mddlwr = cachify.setup(
      assets, {
        root: '/tmp'
      });

    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/js/main.min.js?triedPassive=true');
      test.done();
    });
  },
  "Production mode with absolute URL in prefix": function (test) {
    var assets = make_assets(),
        req = {
          url: '/v/d41d8cd98f/js/main.min.js'
        },
        resp = get_resp(),
        mddlwr;
    mddlwr = cachify.setup(
      assets, {
        root: '/tmp',
        prefix: 'http://example.com/v/'
      });
    var link = cachify.cachify_js("/js/main.min.js");
    test.equal(link, '<script src="http://example.com/v/d41d8cd98f/js/main.min.js"></script>',
              "Hashes in all urls in production");
    var file = cachify.cachify("/js/main.min.js");
    test.equal(file, "http://example.com/v/d41d8cd98f/js/main.min.js");
    var hint = cachify.cachify_prefetch("/js/main.min.js");
    test.equal(hint, '<link rel="prefetch" href="http://example.com/v/d41d8cd98f/js/main.min.js">');
    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/js/main.min.js');
      test.done();
    });
  },
  "Production mode with absolute URL in prefix and url query string" : function (test) {
    var assets = make_assets(),
      req = {
        url: '/v/d41d8cd98f/js/main.min.js?triedPassive=true'
      },
      resp = get_resp(),
      mddlwr;
    mddlwr = cachify.setup(
        assets, {
        root: '/tmp',
        prefix: 'http://example.com/v/'
      });
    
    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/js/main.min.js?triedPassive=true');
      test.done();
    });
  },
  "Custom prefix works with non-file assets": function (test) {
    var assets = make_assets(),
        req = {
          url: '/cachify/d41d8cd98f/other'
        },
        resp = get_resp(),
        mddlwr;

    mddlwr = cachify.setup(
        assets, {
          prefix: 'cachify',
          root: '/tmp'
        });
    var link = cachify.cachify_js("/other", {hash: 'd41d8cd98f'});
    test.equal(link, '<script src="/cachify/d41d8cd98f/other"></script>');

    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/other');
      test.done();
    });
  },
  "Custom prefix with non-file assets and url query string": function (test) {
    var assets = make_assets(),
      req = {
        url: '/cachify/d41d8cd98f/other?triedPassive=true'
      },
      resp = get_resp(),
      mddlwr;

    mddlwr = cachify.setup(
      assets, {
        prefix: 'cachify',
        root: '/tmp'
      });
    var link = cachify.cachify_js("/other", {hash: 'd41d8cd98f'});
    test.equal(link, '<script src="/cachify/d41d8cd98f/other"></script>');

    mddlwr(req, resp, function () {
      test.ok(resp.state.cachify_prefetch);
      test.ok(resp.state.cachify_js);
      test.ok(resp.state.cachify_css);
      test.ok(resp.state.cachify);
      test.ok(resp.state.header > 0);
      test.equal(req.url, '/other?triedPassive=true');
      test.done();
    });
  },
  "Production mode, mismatched checksum, not substituted": function (test) {
    var assets = make_assets(),
        req = {
          url: '/e41d8cd98f/js/main.min.js'
        },
        resp = get_resp(),
        mddlwr;
    mddlwr = cachify.setup(
        assets, {
          root: '/tmp'
    });
    // ensure that middleware does not re-write cachified urls that
    // don't match the current file contents.
    var before = req.url;
    mddlwr(req, resp, function () {
      test.ok(req.url == before);
      test.done();
    });
  },
  "Production - look up paths in url_to_paths table": function (test) {
    var assets = make_assets(),
        url_to_paths = {
          // This file is permanently part of the repo. It's md5 checksum, as
          // reported by md5, is d31da114e3ea4076b2acec51c328806c. The first 10
          // characters are d31da114e3.
          '/js/test-file.js': path.join(__dirname, 'test-data', 'test-file.js')
        },
        mddlwr = cachify.setup(assets, {
          url_to_paths: url_to_paths
        });

    // ensure cachify_js generates a cachified link in production.
    //
    // If the link comes back cachified, it means the url_to_paths table was
    // used to look up the actual file to generate the SHA.
    var link = cachify.cachify_js("/js/test-file.js");
    test.equal(link, '<script src="/d31da114e3/js/test-file.js"></script>');

    // ensure cachify generates the correct cachified path in production.
    var file = cachify.cachify("/js/test-file.js");
    test.equal(file, "/d31da114e3/js/test-file.js");

    // ensure the middleware responds to the cachified URL.
    var req = {
          url: '/d31da114e3/js/test-file.js'
        },
        resp = get_resp();

    mddlwr(req, resp, function () {
      // make sure the hash is stripped out so that another middleware can take
      // care of responding to the request.
      test.equal(req.url, '/js/test-file.js');
      test.done();
    });
  },
  "URLs without SHA won't be processed": function (test) {
    var assets = make_assets(),
        url_to_paths = {
          // This file is permanently part of the repo. It's md5 checksum, as
          // reported by md5, is d31da114e3ea4076b2acec51c328806c. The first 10
          // characters are d31da114e3.
          '/js/test-file.js': path.join(__dirname, 'test-data', 'test-file.js')
        },
        mddlwr = cachify.setup(assets, {
          url_to_paths: url_to_paths
        });

    // ensure the middleware responds to the cachified URL.
    var req = {
          url: '/some/unknown/code.js'
        },
        resp = get_resp();

    mddlwr(req, resp, function () {
      // Unknown paths do not get treated like SHAs and stripped.
      test.equal(req.url, '/some/unknown/code.js');
      test.done();
    });
  }

});