tilestrata-proxy/test/index.js

A TileStrata plugin for proxying remote tiles

/* globals describe it */
var http = require('http');
var zlib = require('zlib');
var proxy = require('../index.js');
var tilestrata = require('tilestrata');
var assert = require('chai').assert;

describe('"tilestrata-proxy"', function() {
	it('should set "name"', function() {
		assert.equal(proxy('uri').name, 'proxy');
	});

	before(function(done) {
		var failCount = 0;
		http.createServer(function(req, res) {
			if (req.url === '/dummy-3-2-1.txt') {
				res.writeHead(200, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content');
			} else if (req.url === '/compressed.gzip') {
				res.writeHead(200, {
					'Content-Type': 'text/plain; charset=utf-8',
					'Content-Encoding': 'gzip',
				});
				var data = Buffer.from('The content', 'utf8');
				zlib.gzip(data, function(err, data) {
					if (err) throw err;
					res.end(data);
				});
			} else if (req.url === '/doesnotexist-3-2-1.txt') {
				res.writeHead(404, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content');
			} else if (req.url === '/subdomain-b-3-2-2.txt') {
				res.writeHead(200, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content');
			} else if (req.url === '/subdomain-array-world-3-2-1.txt') {
				res.writeHead(200, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content');
			} else if (req.url === '/fn.txt') {
				res.writeHead(200, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content');
			} else if (req.url === '/fail-2-times.txt') {
				if (failCount < 2) {
					++failCount;
					res.writeHead(500, {'Content-Type': 'text/plain; charset=utf-8'});
					res.end('Request failed');
					return;
				}
				res.writeHead(200, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('The content after ' + failCount + ' failures');
			} else if (req.url === '/fail.txt') {
				res.writeHead(500, {'Content-Type': 'text/plain; charset=utf-8'});
				res.end('Request failed');
				return;
			} else {
				throw new Error('Unexpected URL "' + req.url + '"');
			}
		}).listen(8889, function(err) {
			if (err) throw err;
			done();
		});
	});

	it('should decompress gzipped content by default', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf'); // no accept-encoding header
		req.headers['accept-encoding'] = 'gzip'; // should ignore
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/compressed.gzip'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 200);
				assert.equal(headers['content-type'], 'text/plain; charset=utf-8', 'Content-Type should be set correctly');
				assert.equal(headers['content-encoding'], undefined, 'Content-Encoding should be missing');
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should decompress gzipped content if decompress="client" and client doesn\'t send accept-encoding', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf'); // no accept-encoding
		server.layer('layer').route('tile.pbf').use(proxy({
			decompress: 'client',
			uri: 'http://localhost:8889/compressed.gzip'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 200);
				assert.equal(headers['content-type'], 'text/plain; charset=utf-8', 'Content-Type should be set correctly');
				assert.equal(headers['content-encoding'], undefined, 'Content-Encoding should be missing');
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should not decompress content if decompress="never"', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		req.headers['accept-encoding'] = 'gzip'; // should acknowledge
		server.layer('layer').route('tile.pbf').use(proxy({
			decompress: 'never',
			uri: 'http://localhost:8889/compressed.gzip'
		}));

		var expectedRawData = Buffer.from('The content', 'utf8');
		zlib.gzip(expectedRawData, function(err, expectedGzippedData) {
			if (err) throw err;
			server.initialize(function(err) {
				if (err) throw err;
				server.serve(req, false, function(status, buffer, headers) {
					assert.equal(status, 200);
					assert.equal(headers['content-type'], 'text/plain; charset=utf-8', 'Content-Type should be set correctly');
					assert.equal(headers['content-encoding'], 'gzip', 'Content-Encoding should not be modified');
					assert.equal(buffer.toString('hex'), expectedGzippedData.toString('hex'));
					done();
				});
			});
		});
	});
	it('should not decompress content if decompress="client" and client sends accept-encoding', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		req.headers['accept-encoding'] = 'gzip'; // should acknowledge
		server.layer('layer').route('tile.pbf').use(proxy({
			decompress: 'client',
			uri: 'http://localhost:8889/compressed.gzip'
		}));

		var expectedRawData = Buffer.from('The content', 'utf8');
		zlib.gzip(expectedRawData, function(err, expectedGzippedData) {
			if (err) throw err;
			server.initialize(function(err) {
				if (err) throw err;
				server.serve(req, false, function(status, buffer, headers) {
					assert.equal(status, 200);
					assert.equal(headers['content-type'], 'text/plain; charset=utf-8', 'Content-Type should be set correctly');
					assert.equal(headers['content-encoding'], 'gzip', 'Content-Encoding should not be modified');
					assert.equal(buffer.toString('hex'), expectedGzippedData.toString('hex'));
					done();
				});
			});
		});
	});
	it('should return remote content', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/dummy-{z}-{x}-{y}.txt'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 200);
				assert.equal(headers['content-type'], 'text/plain; charset=utf-8', 'Content-Type should be set correctly');
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should return remote content (with {s} subdomain)', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/2/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/subdomain-{s}-{z}-{x}-{y}.txt'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should return remote content (with {s} subdomain array)', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/subdomain-array-{s}-{z}-{x}-{y}.txt',
			subdomains: ['hello', 'world'],
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should return remote content (with function)', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/5/6/7/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: function(tile) {
				assert.equal(tile.z, 5, 'tile.z');
				assert.equal(tile.x, 6, 'tile.x');
				assert.equal(tile.y, 7, 'tile.y');
				return 'http://localhost:8889/fn.txt';
			},
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(buffer.toString('utf8'), 'The content');
				done();
			});
		});
	});
	it('should return 404 Not Found if function returns falsy value', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/5/6/7/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: function(tile) {
				return null;
			},
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 404, 'status');
				assert.equal(buffer.toString('utf8'), 'No proxy url defined for this tile');
				done();
			});
		});
	});
	it('should return error if remote fails', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/fail.txt'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 500);
				assert.equal(buffer.toString('utf8'), 'Received non-200 status from upstream (500)');
				done();
			});
		});
	});
	it('should allow retries', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/fail-2-times.txt',
			retries: 3,
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 200, 'status');
				assert.equal(buffer.toString('utf8'), 'The content after 2 failures');
				done();
			});
		});
	});
	it('should return proper status code', function(done) {
		this.timeout(5000);

		var server = new tilestrata.TileServer();
		var req = tilestrata.TileRequest.parse('/layer/3/2/1/tile.pbf');
		server.layer('layer').route('tile.pbf').use(proxy({
			uri: 'http://localhost:8889/doesnotexist-{z}-{x}-{y}.txt'
		}));

		server.initialize(function(err) {
			if (err) throw err;
			server.serve(req, false, function(status, buffer, headers) {
				assert.equal(status, 404);
				done();
			});
		});
	});
});