mapped-versionator.test.js

var request = require('request')
var versionator = require('../')
var appEngine = require('connect')

describe('versionator', function() {
  describe('#createMapped', function() {
    it('throws an error if no map is passed', function() {
      ;(function() {
        versionator.createMapped()
      }.should.throw('A hash map of paths is required'))
    })

    it('returns a middleware function', function() {
      versionator.createMapped({}).middleware.should.be.type('function')
    })

    describe('#versionPath', function() {
      it('should inject the mapped url correctly', function() {
        var mapped = versionator.createMapped({
          '/js/test.js': '/js/HASH/test.js'
        })
        mapped.versionPath('/js/test.js').should.eql('/js/HASH/test.js')
      })

      it('should mapped URLs with numbers', function() {
        var mapped = versionator.createMapped({
          '/js/1test.js': '/js/HASH/1test.js',
          '/js/a-1test.js': '/js/HASH/a-1test.js'
        })
        mapped.versionPath('/js/1test.js').should.eql('/js/HASH/1test.js')
        mapped.versionPath('/js/a-1test.js').should.eql('/js/HASH/a-1test.js')
      })

      it('should mapped URLs with hyphens', function() {
        var mapped = versionator.createMapped({
          '/js/test-bar.js': '/js/HASH/test-bar.js'
        })
        mapped.versionPath('/js/test-bar.js').should.eql('/js/HASH/test-bar.js')
      })

      it('should mapped URLs with querystring', function() {
        var mapped = versionator.createMapped({
          '/js/test-bar.js': '/js/HASH/test-bar.js'
        })
        mapped
          .versionPath('/js/test-bar.js?test=1')
          .should.eql('/js/HASH/test-bar.js?test=1')
      })

      it('should mapped URLs with hash', function() {
        var mapped = versionator.createMapped({
          '/js/test-bar.js': '/js/HASH/test-bar.js'
        })
        mapped
          .versionPath('/js/test-bar.js#hashy')
          .should.eql('/js/HASH/test-bar.js#hashy')
      })

      it('should mapped URLs with querystring and hash', function() {
        var mapped = versionator.createMapped({
          '/js/test-bar.js': '/js/HASH/test-bar.js'
        })
        mapped
          .versionPath('/js/test-bar.js?test=1#hashy')
          .should.eql('/js/HASH/test-bar.js?test=1#hashy')
      })

      it('should accept a modified map', function() {
        var mapped = versionator.createMapped({
          '/js/test.js': '/js/HASH/test.js'
        })
        mapped.modifyMap({ '/js/test.js': '/js/OTHERHASH/test.js' })
        mapped.versionPath('/js/test.js').should.eql('/js/OTHERHASH/test.js')
      })
      it('strings without a "/" will be encoded correctly', function() {
        var mapped = versionator.createMapped({
          '/js/test.js': '/js/HASH/test.js'
        })
        mapped
          .versionPath('Hello this is an odd path')
          .should.eql('Hello%20this%20is%20an%20odd%20path')
      })
      it('strings with a hash and no match will be encoded correctly', function() {
        var mapped = versionator.createMapped({
          '/js/test.js': '/js/HASH/test.js'
        })
        mapped
          .versionPath('/test/ing#hashparam')
          .should.eql('/test/ing#hashparam')
      })

      it('should convert all URLs in an array', function() {
        var mapped = versionator.createMapped({
          '/js/test.js': '/js/HASH/test.js',
          '/js/foo/test.js': '/js/foo/HASH/test.js'
        })
        mapped
          .versionPath(['/js/test.js', '/js/foo/test.js'])
          .should.eql(['/js/HASH/test.js', '/js/foo/HASH/test.js'])
      })

      it('should return an empty array when passed an empty url', function() {
        var basic = versionator.createBasic('v0.0.0')
        basic.versionPath([]).should.eql([])
      })
    })
  })

  describe('mapped middleware', function() {
    function startServer(map, port) {
      var mapped = versionator.createMapped(map)
      var app = appEngine()
        .use(mapped.middleware)
        .use(function(req, res) {
          res.setHeader('x-url', req.url)
          res.end(req.url)
        })

      return { app: app.listen(port), mapped: mapped }
    }

    it('req.url is unchanged if no version match is found', function(done) {
      var app = startServer({}, 9900).app

      request('http://localhost:9900/images/sprite.png', function(
        ignoreError,
        response,
        data
      ) {
        data.should.eql('/images/sprite.png')
        app.close()
        done()
      })
    })

    it('should allow GET', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request.get(
        'http://localhost:9901/images/VERSIONHASH/sprite.png',
        function(ignoreError, response, data) {
          data.should.eql('/images/sprite.png')
          app.close()
          done()
        }
      )
    })

    it('should allow HEAD', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request.head(
        'http://localhost:9901/images/VERSIONHASH/sprite.png',
        function(ignoreError, response) {
          response.headers['x-url'].should.eql('/images/sprite.png')
          app.close()
          done()
        }
      )
    })

    it('should not map POST', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request.post(
        'http://localhost:9901/images/VERSIONHASH/sprite.png',
        function(ignoreError, response) {
          response.headers['x-url'].should.eql('/images/VERSIONHASH/sprite.png')
          app.close()
          done()
        }
      )
    })

    it('req.url mapped url is mapped correctly', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request('http://localhost:9901/images/VERSIONHASH/sprite.png', function(
        ignoreError,
        response,
        data
      ) {
        data.should.eql('/images/sprite.png')
        app.close()
        done()
      })
    })

    it('req.url mapped url (with query string) is mapped correctly', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request(
        'http://localhost:9901/images/VERSIONHASH/sprite.png?key=val',
        function(ignoreError, response, data) {
          data.should.eql('/images/sprite.png?key=val')
          app.close()
          done()
        }
      )
    })

    it('req.url mapped url with query string and #hash is mapped correctly', function(done) {
      var app = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9901
      ).app

      request(
        'http://localhost:9901/images/VERSIONHASH/sprite.png?key=val#hashy',
        function(ignoreError, response, data) {
          // #hash isn't sent to the server, so you shouldn't see it.
          data.should.eql('/images/sprite.png?key=val')
          app.close()
          done()
        }
      )
    })

    it('req.url mapped url is mapped correctly after hash change', function(done) {
      var appObj = startServer(
        { '/images/sprite.png': '/images/VERSIONHASH/sprite.png' },
        9902
      )
      var app = appObj.app
      var mapped = appObj.mapped

      mapped.modifyMap({ '/images/sprite.png': '/images/OTHERHASH/sprite.png' })

      request('http://localhost:9902/images/OTHERHASH/sprite.png', function(
        ignoreError,
        response,
        data
      ) {
        data.should.eql('/images/sprite.png')
        app.close()
        done()
      })
    })
  })
})