git.squeep.com Git - squeep-api-dingus/blob - test/lib/dingus.js

   1 /* eslint-disable capitalized-comments */
   2 /* eslint-env mocha */
   3 'use strict';
   4
   5 const assert = require('assert');
   6 const sinon = require('sinon'); // eslint-disable-line node/no-unpublished-require
   7 const fs = require('fs');
   8
   9 const Dingus = require('../../lib/dingus');
  10 const { DingusError } = require('../../lib/errors');
  11 const Enum = require('../../lib/enum');
  12
  13 const noExpectedException = 'did not get expected exception';
  14
  15 describe('Dingus', function () {
  16   let dingus;
  17   beforeEach(function () {
  18     dingus = new Dingus();
  19   });
  20   afterEach(function () {
  21     sinon.restore();
  22   });
  23
  24   describe('constructor', function () {
  25     it('covers', function () {
  26       const d = new Dingus({}, {});
  27       assert(d);
  28       assert('log' in d.logger);
  29     });
  30   }); // constructor
  31
  32   describe('_normalizePath', function () {
  33     it('returns normal path', function () {
  34       const p = '/a/b/c';
  35       const r = dingus._normalizePath(p);
  36       assert.strictEqual(r, p);
  37     });
  38     it('returns normal path', function () {
  39       const p = '////a///b/./bar/..///c';
  40       const expected = '/a/b/c'
  41       const r = dingus._normalizePath(p);
  42       assert.strictEqual(r, expected);
  43     });
  44   }); // _normalizePath
  45
  46   describe('_splitUrl', function () {
  47     const nullObject = Object.create(null);
  48
  49     it('splits a simple path', function () {
  50       const p = '/a/b/c';
  51       const expected = {
  52         pathPart: p,
  53         queryParams: nullObject,
  54       };
  55       const r = dingus._splitUrl(p);
  56       assert.deepStrictEqual(r, expected);
  57     });
  58     it('splits a path with trailing slash preserved', function () {
  59       const p = '/a/b/c/';
  60       const expected = {
  61         pathPart: p,
  62         queryParams: nullObject,
  63       };
  64       const r = dingus._splitUrl(p);
  65       assert.deepStrictEqual(r, expected);
  66     });
  67     it('splits a path with trailing slash ignored', function () {
  68       const p = '/a/b/c/';
  69       const expected = {
  70         pathPart: p,
  71         queryParams: nullObject,
  72       };
  73       dingus.ignoreTrailingSlash = true;
  74       const r = dingus._splitUrl(p);
  75       assert.deepStrictEqual(r, expected);
  76     });
  77     it('splits a path with empty query string', function () {
  78       const p = '/a/b/c?';
  79       const expected = {
  80         pathPart: '/a/b/c',
  81         queryParams: nullObject,
  82       };
  83       const r = dingus._splitUrl(p);
  84       assert.deepStrictEqual(r, expected);
  85     });
  86     it('splits a path with query string', function () {
  87       const p = '/a/b/c?x=1&y=2&z';
  88       const expected = {
  89         pathPart: '/a/b/c',
  90         queryParams: Object.assign(Object.create(null), {
  91           x: '1',
  92           y: '2',
  93           z: '', // Subjective Editorial: disagree with the default querystring parser behavior here: null would be better than empty string, esp as result is null-prototyped object.
  94         }),
  95       };
  96       const r = dingus._splitUrl(p);
  97       assert.deepStrictEqual(r, expected);
  98     });
  99   }); // _splitUrl
 100
 101   describe('tagContext', function () {
 102     let req, res, ctx;
 103     beforeEach(function () {
 104       req = {
 105         getHeader: sinon.stub(),
 106         setHeader: sinon.stub(),
 107       };
 108       res = {
 109         getHeader: sinon.stub(),
 110         setHeader: sinon.stub(),
 111       };
 112       ctx = {};
 113     });
 114     it ('sets id in context', function () {
 115       const result = Dingus.tagContext(req, res, ctx);
 116       assert.strictEqual(ctx.requestId, result);
 117       assert(res.setHeader.called);
 118     });
 119     it ('sets provided header', function () {
 120       req.getHeader.onCall(0).returns('abc'); // X-Request-ID
 121       const result = Dingus.tagContext(req, res, ctx);
 122       assert.strictEqual(ctx.requestId, result);
 123       assert.strictEqual(res.setHeader.getCall(0).args[0], 'Request-ID');
 124       assert.strictEqual(res.setHeader.getCall(1).args[0], 'X-Request-ID');
 125       assert.strictEqual(res.setHeader.getCall(1).args[1], 'abc');
 126       assert.strictEqual(res.setHeader.callCount, 2);
 127     });
 128   }); // tagContext
 129
 130   describe('clientAddressContext', function () {
 131     let req, res, ctx;
 132     let _tp;
 133     before(function () {
 134       _tp = dingus.trustProxy;
 135     });
 136     after(function () {
 137       dingus.trustProxy = _tp;
 138     });
 139     beforeEach(function () {
 140       req = {
 141         getHeader: sinon.stub(),
 142         setHeader: sinon.stub(),
 143         connection: {},
 144       };
 145       res = {
 146         getHeader: sinon.stub(),
 147         setHeader: sinon.stub(),
 148       };
 149       ctx = {};
 150     });
 151     it ('covers untrusted proxy', function () {
 152       dingus.trustProxy = false;
 153       const expected = {
 154         clientAddress: '',
 155         clientProtocol: 'http',
 156       }
 157       dingus.clientAddressContext(req, res, ctx);
 158       assert.deepStrictEqual(ctx, expected);
 159       assert(!req.getHeader.called);
 160     });
 161     it ('covers missing', function () {
 162       dingus.trustProxy = true;
 163       const expected = {
 164         clientAddress: '::1',
 165         clientProtocol: 'https',
 166       }
 167       req.connection.remoteAddress = '::1';
 168       req.connection.encrypted = true;
 169       dingus.clientAddressContext(req, res, ctx);
 170       assert(req.getHeader.called);
 171       assert.deepStrictEqual(ctx, expected);
 172     });
 173   }); // clientAddressContext
 174
 175   describe('getRequestContentType', function () {
 176     let req;
 177     beforeEach(function () {
 178       req = {
 179         getHeader: sinon.stub(),
 180         setHeader: sinon.stub(),
 181       };
 182     });
 183     it('handles missing header', function () {
 184       const result = Dingus.getRequestContentType(req);
 185       assert.strictEqual(result, '');
 186     });
 187     it('parses simple type', function () {
 188       req.getHeader.onCall(0).returns(Enum.ContentType.ApplicationJson);
 189       const result = Dingus.getRequestContentType(req);
 190       assert.strictEqual(result, Enum.ContentType.ApplicationJson);
 191     });
 192     it('parses complex type', function () {
 193       req.getHeader.onCall(0).returns('application/json ; charset=UTF-8');
 194       const result = Dingus.getRequestContentType(req);
 195       assert.strictEqual(result, Enum.ContentType.ApplicationJson);
 196     });
 197   }); // getRequestContentType
 198
 199   describe('setResponseContentType', function () {
 200     let req, responseTypes;
 201     beforeEach(function () {
 202       responseTypes = [];
 203       req = {
 204         setHeader: sinon.stub(),
 205         getHeader: sinon.stub(),
 206       };
 207     });
 208     it('handles missing header', function () {
 209       const result = Dingus.getResponseContentType(responseTypes, req);
 210       assert.strictEqual(result, undefined);
 211     });
 212     it('behaves as expected', function () {
 213       responseTypes.push(Enum.ContentType.ApplicationJson);
 214       req.getHeader.onCall(0).returns('text, image/png;q=0.5, application/*;q=0.2, audio;q=0.1');
 215       const result = Dingus.getResponseContentType(responseTypes, req);
 216       assert.strictEqual(result, Enum.ContentType.ApplicationJson);
 217     });
 218   }); // setResponseContentType
 219
 220   describe('on', function () {
 221     let stubOn;
 222     beforeEach(function () {
 223       stubOn = sinon.stub(dingus.router, 'on');
 224     });
 225     it('covers', function () {
 226       dingus.on('GET', '/', () => {});
 227       assert(stubOn.called);
 228     });
 229   }); // on
 230
 231   describe('setEndBodyHandler', function () {
 232     let req, res, ctx, handler, origEnd, origWrite;
 233     beforeEach(function () {
 234       origEnd = sinon.stub();
 235       origWrite = sinon.stub();
 236       req = {};
 237       res = {
 238         write: origWrite,
 239         end: origEnd,
 240       };
 241       ctx = {};
 242       handler = sinon.stub();
 243     });
 244     it('collects body and handles', function () {
 245       Dingus.setEndBodyHandler(req, res, ctx, handler);
 246       res.write(Buffer.from('foo'));
 247       res.write('baz');
 248       res.write();
 249       res.end('quux');
 250       assert(origWrite.called);
 251       assert(origEnd.called);
 252       assert.deepStrictEqual(ctx.responseBody, Buffer.from('foobazquux'));
 253       assert(handler.called);
 254     });
 255   }); // setEndBodyHandler
 256
 257   describe('setHeadHandler', function () {
 258     let req, res, ctx, origEnd, origWrite;
 259     beforeEach(function () {
 260       origEnd = sinon.stub();
 261       origWrite = sinon.stub();
 262       req = {
 263         method: 'HEAD',
 264       };
 265       res = {
 266         end: origEnd,
 267         write: origWrite,
 268         setHeader: sinon.stub(),
 269       };
 270       ctx = {};
 271     });
 272     it('collects body without writing', function () {
 273       Dingus.setHeadHandler(req, res, ctx);
 274       res.write(Buffer.from('foo'));
 275       res.write('baz');
 276       res.write();
 277       res.end('quux');
 278       assert(!origWrite.called);
 279       assert(origEnd.called);
 280       assert.deepStrictEqual(ctx.responseBody, Buffer.from('foobazquux'));
 281     });
 282     it('ignores non-head method', function () {
 283       req.method = 'GET';
 284       Dingus.setHeadHandler(req, res, ctx);
 285       res.write(Buffer.from('foo'));
 286       res.end('bar');
 287       assert(origWrite.called);
 288       assert(origEnd.called);
 289     });
 290   }); // setHeadHandler
 291
 292   describe('addEncodingHeader', function () {
 293     let res, encoding;
 294     beforeEach(function () {
 295       res = {
 296         _headers: {},
 297         // eslint-disable-next-line security/detect-object-injection
 298         getHeader: (h) => res._headers[h],
 299         // eslint-disable-next-line security/detect-object-injection
 300         setHeader: (h, v) => res._headers[h] = v,
 301       };
 302     });
 303     it('adds', function () {
 304       encoding = 'gzip';
 305       Dingus.addEncodingHeader(res, encoding);
 306       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'gzip');
 307     });
 308     it('extends', function () {
 309       encoding = 'utf8';
 310       Dingus.addEncodingHeader(res, encoding);
 311       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'utf8');
 312       encoding = 'gzip';
 313       Dingus.addEncodingHeader(res, encoding);
 314       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'gzip, utf8');
 315     });
 316   }); // addEncodingHeader
 317
 318   describe('dispatch', function () {
 319     let pathsByLengthOrig;
 320     let req, res, ctx;
 321     let stubHandler;
 322
 323     beforeEach(function () {
 324       req = {
 325         url: '/',
 326         method: 'GET',
 327         setHeader: sinon.stub(),
 328         getHeader: sinon.stub(),
 329       };
 330       res = {
 331         statusCode: 200,
 332         end: sinon.stub(),
 333         setHeader: sinon.stub(),
 334         hasHeader: sinon.stub(),
 335         getHeader: sinon.stub(),
 336         getHeaders: sinon.stub(),
 337       };
 338       ctx = {};
 339       pathsByLengthOrig = dingus.pathsByLength;
 340       sinon.spy(dingus, 'handlerMethodNotAllowed');
 341       sinon.spy(dingus, 'handlerNotFound');
 342       sinon.spy(dingus, 'handlerBadRequest');
 343       sinon.spy(dingus, 'handlerInternalServerError');
 344       stubHandler = sinon.stub();
 345     });
 346     afterEach(function () {
 347       dingus.pathsByLength = pathsByLengthOrig;
 348     });
 349
 350     it('calls handler', async function () {
 351       const urlPath = '/:id';
 352       const method = 'GET';
 353       dingus.on(method, urlPath, stubHandler);
 354       req.url = '/abc';
 355       req.method = method;
 356
 357       await dingus.dispatch(req, res, ctx);
 358       assert(stubHandler.called);
 359       assert(!dingus.handlerMethodNotAllowed.called);
 360       assert(!dingus.handlerNotFound.called);
 361     });
 362     it('calls handler without context', async function () {
 363       const urlPath = '/:id';
 364       const method = 'GET';
 365       dingus.on(method, urlPath, stubHandler);
 366       req.url = '/abc';
 367       req.method = method;
 368
 369       await dingus.dispatch(req, res);
 370       assert(stubHandler.called);
 371       assert(!dingus.handlerMethodNotAllowed.called);
 372       assert(!dingus.handlerNotFound.called);
 373     });
 374     it('calls fallback handler', async function () {
 375       const urlPath = '/abc/:id';
 376       const method = 'GET';
 377       dingus.on('*', urlPath, stubHandler);
 378       req.url = '/abc/def';
 379       req.method = method;
 380
 381       await dingus.dispatch(req, res, ctx);
 382       assert(stubHandler.called);
 383       assert(!dingus.handlerMethodNotAllowed.called);
 384       assert(!dingus.handlerNotFound.called);
 385     });
 386     it('handles error in handler', async function () {
 387       const urlPath = '/:id';
 388       const method = 'GET';
 389       dingus.on(method, urlPath, stubHandler);
 390       req.url = '/abc';
 391       req.method = method;
 392       stubHandler.rejects(new Error('blah'));
 393
 394       await dingus.dispatch(req, res, ctx);
 395       assert(stubHandler.called);
 396       assert(!dingus.handlerMethodNotAllowed.called);
 397       assert(!dingus.handlerNotFound.called);
 398     });
 399     it('calls unsupported method', async function () {
 400       const urlPath = '/:id';
 401       const method = 'POST';
 402       dingus.on('GET', urlPath, stubHandler);
 403       req.url = '/abc';
 404       req.method = method;
 405
 406       await dingus.dispatch(req, res, ctx);
 407       assert(!stubHandler.called);
 408       assert(dingus.handlerMethodNotAllowed.called);
 409       assert(!dingus.handlerNotFound.called);
 410     });
 411     it('does not lookup nonexistent path', async function () {
 412       req.url = '/foo/bar';
 413       req.method = 'GET';
 414
 415       await dingus.dispatch(req, res, ctx);
 416       assert(!stubHandler.called);
 417       assert(!dingus.handlerMethodNotAllowed.called);
 418       assert(dingus.handlerNotFound.called);
 419     });
 420     it('covers unhandled dingus exception', async function () {
 421       const expectedException = new DingusError('blah');
 422       sinon.stub(dingus.router, 'lookup').throws(expectedException);
 423
 424       await dingus.dispatch(req, res, ctx);
 425       assert(!stubHandler.called);
 426       assert(dingus.handlerInternalServerError.called);
 427     });
 428     it('covers other exception', async function () {
 429       const expectedException = new Error('blah');
 430       sinon.stub(dingus.router, 'lookup').throws(expectedException);
 431
 432       await dingus.dispatch(req, res, ctx);
 433       assert(!stubHandler.called);
 434       assert(dingus.handlerInternalServerError.called);
 435     });
 436     it('covers bad uri', async function () {
 437       req.url = '/%f';
 438
 439       await dingus.dispatch(req, res, ctx);
 440       assert(dingus.handlerBadRequest.called);
 441     });
 442     it('calls handler with additional arguments', async function () {
 443       dingus.on('GET', '/', stubHandler, 'foo', 'bar');
 444       await dingus.dispatch(req, res, ctx);
 445       assert(stubHandler.called);
 446       assert.strictEqual(stubHandler.args[0][3], 'foo');
 447       assert.strictEqual(stubHandler.args[0][4], 'bar');
 448     });
 449   }); // dispatch
 450
 451   describe('parseBody', function () {
 452     let ctx;
 453     beforeEach(function () {
 454       ctx = {};
 455     });
 456     it('does not parse unknown type', function () {
 457       try {
 458         dingus.parseBody('unknown/type', ctx);
 459         assert.fail(noExpectedException);
 460       } catch (e) {
 461         assert.strictEqual(e.statusCode, 415);
 462       }
 463     });
 464     it('parses json', function () {
 465       const src = { foo: 'bar' };
 466       ctx.rawBody = JSON.stringify(src);
 467       dingus.parseBody(Enum.ContentType.ApplicationJson, ctx);
 468       assert.deepStrictEqual(ctx.parsedBody, src);
 469     });
 470     it('handles unparsable json', function () {
 471       ctx.rawBody = 'not json';
 472       try {
 473         dingus.parseBody(Enum.ContentType.ApplicationJson, ctx);
 474         assert.fail(noExpectedException);
 475       } catch (e) {
 476         assert.strictEqual(e.statusCode, 400);
 477       }
 478     });
 479     it('parses form', function () {
 480       const expected = Object.assign(Object.create(null), {
 481         foo: 'bar',
 482       });
 483       ctx.rawBody = 'foo=bar';
 484       dingus.parseBody('application/x-www-form-urlencoded', ctx);
 485       assert.deepStrictEqual(ctx.parsedBody, expected);
 486     });
 487
 488   }); // parseBody
 489
 490   describe('bodyData', function () {
 491     let res, resEvents;
 492     beforeEach(function () {
 493       resEvents = {};
 494       res = {
 495         // eslint-disable-next-line security/detect-object-injection
 496         on: (ev, fn) => resEvents[ev] = fn,
 497       };
 498     });
 499     it('provides data', async function () {
 500       const p = dingus.bodyData(res);
 501       resEvents['data'](Buffer.from('foo'));
 502       resEvents['data'](Buffer.from('bar'));
 503       resEvents['end']();
 504       const result = await p;
 505       assert.strictEqual(result, 'foobar');
 506     });
 507     it('handles error', async function () {
 508       const p = dingus.bodyData(res);
 509       resEvents['error']('foo');
 510       try {
 511         await p;
 512         assert.fail(noExpectedException);
 513       } catch (e) {
 514         assert.strictEqual(e, 'foo');
 515       }
 516     });
 517   }); // bodyData
 518
 519   describe('ingestBody', function () {
 520     it('covers', async function () {
 521       const req = {};
 522       const res = {};
 523       const ctx = {};
 524       sinon.stub(dingus, 'bodyData').resolves('{"foo":"bar"}')
 525       sinon.stub(Dingus, 'getRequestContentType').returns(Enum.ContentType.ApplicationJson);
 526       await dingus.ingestBody(req, res, ctx);
 527       assert.deepStrictEqual(ctx.parsedBody, { foo: 'bar' });
 528     });
 529   }); // ingestBody
 530
 531   describe('setResponseType', function () {
 532     let req, res, ctx;
 533     let _sa; // Preserve strictAccept
 534     before(function () {
 535       _sa = dingus.strictAccept;
 536     });
 537     after(function () {
 538       dingus.strictAccept = _sa;
 539     });
 540     beforeEach(function () {
 541       ctx = {};
 542       req = {};
 543       res = {
 544         setHeader: sinon.stub(),
 545       };
 546       sinon.stub(Dingus, 'getResponseContentType').returns();
 547     });
 548     it('rejects missing', function () {
 549       dingus.strictAccept = true;
 550       try {
 551         dingus.setResponseType(['my/type'], req, res, ctx);
 552         assert.fail(noExpectedException);
 553       } catch (e) {
 554         assert.strictEqual(e.statusCode, 406, 'did not get expected status code');
 555       }
 556     });
 557     it('accepts missing', function () {
 558       dingus.strictAccept = false;
 559       dingus.setResponseType(['my/type'], req, res, ctx);
 560       assert.strictEqual(ctx.responseType, 'my/type');
 561     });
 562
 563   }); // setResponseType
 564
 565   describe('_readFileInfo', function () {
 566     let stat, data, statRes, dataRes, filename;
 567     beforeEach(function () {
 568       sinon.stub(fs.promises, 'stat');
 569       sinon.stub(fs.promises, 'readFile');
 570       statRes = {
 571         mtimeMs:1612553697186,
 572       };
 573       dataRes = 'data';
 574       filename = 'dummy.txt';
 575     });
 576     it('succeeds', async function () {
 577       fs.promises.stat.resolves(statRes);
 578       fs.promises.readFile.resolves('data');
 579       [stat, data] = await dingus._readFileInfo(filename);
 580       assert.deepStrictEqual(stat, statRes);
 581       assert.deepStrictEqual(data, dataRes);
 582     });
 583     it('returns null for non-existant file', async function () {
 584       const noEnt = {
 585         code: 'ENOENT',
 586       };
 587       fs.promises.stat.rejects(noEnt);
 588       fs.promises.readFile.rejects(noEnt);
 589       [stat, data] = await dingus._readFileInfo(filename);
 590       assert.strictEqual(stat, null);
 591       assert.strictEqual(data, null);
 592     });
 593     it('throws unexpected error', async function () {
 594       const expectedException = new Error('blah');
 595       fs.promises.stat.rejects(expectedException);
 596       await assert.rejects(async () => {
 597         await dingus._readFileInfo(filename);
 598       }, expectedException);
 599     });
 600   }); // _readFileInfo
 601
 602   describe('_serveFileMetaHeaders', function () {
 603     let res, directory, fileName;
 604     beforeEach(function () {
 605       sinon.stub(dingus, '_readFileInfo');
 606       res = {
 607         setHeader: sinon.stub(),
 608       };
 609       directory = '/path';
 610       fileName = 'filename';
 611     });
 612     it('covers no meta file', async function() {
 613       dingus._readFileInfo.resolves([null, null]);
 614       await dingus._serveFileMetaHeaders(res, directory, fileName);
 615       assert(!res.setHeader.called);
 616     });
 617     it('adds extra headers', async function () {
 618       dingus._readFileInfo.resolves([{}, Buffer.from(`Link: <https://example.com/>; rel="relation"
 619 X-Folded-Header: data
 620   data under
 621   the fold
 622 Content-Type: image/sgi
 623 `)]);
 624       await dingus._serveFileMetaHeaders(res, directory, fileName);
 625       assert(res.setHeader.called);
 626     });
 627   }); // _serveFileMetaHeaders
 628
 629   describe('serveFile', function () {
 630     const path = require('path');
 631     let ctx, req, res, directory, fileName, filestats;
 632     beforeEach(function () {
 633       directory = path.join(__dirname, '..', 'test-data');
 634       fileName = 'example.html';
 635       ctx = {};
 636       req = {
 637         _headers: {
 638           [Enum.Header.Accept]: undefined,
 639           [Enum.Header.IfModifiedSince]: undefined,
 640           [Enum.Header.AcceptEncoding]: undefined,
 641           [Enum.Header.IfNoneMatch]: undefined,
 642         },
 643         getHeader: (header) => {
 644           if (header in req._headers) {
 645             // eslint-disable-next-line security/detect-object-injection
 646             return req._headers[header];
 647           }
 648           assert.fail(`unexpected getHeader ${header}`);
 649         },
 650       };
 651       res = {
 652         end: sinon.stub(),
 653         getHeader: sinon.stub(),
 654         getHeaders: sinon.stub(),
 655         hasHeader: sinon.stub().returns(true),
 656         setHeader: sinon.stub(),
 657       };
 658       filestats = {
 659         dev: 39,
 660         mode: 33188,
 661         nlink: 1,
 662         uid: 1002,
 663         gid: 1002,
 664         rdev: 0,
 665         blksize: 512,
 666         ino: 897653,
 667         size: 8,
 668         blocks: 17,
 669         atimeMs: 1613253436842.815,
 670         mtimeMs: 1603485933192.8610,
 671         ctimeMs: 1603485933192.8610,
 672         birthtimeMs: 0,
 673         atime: '2021-02-13T21:57:16.843Z',
 674         mtime: '2020-10-23T13:45:33.193Z',
 675         ctime: '2020-10-23T13:45:33.193Z',
 676         birthtime: '1970-01-01T00:00:00.000Z',
 677       };
 678       sinon.stub(dingus, 'handlerNotFound');
 679       sinon.stub(fs.promises, 'stat').resolves(filestats);
 680       sinon.spy(fs.promises, 'readFile');
 681     });
 682     it('serves a file', async function () {
 683       await dingus.serveFile(req, res, ctx, directory, fileName);
 684       assert(fs.promises.readFile.called);
 685       assert(!dingus.handlerNotFound.called);
 686     });
 687     it('covers no meta headers', async function () {
 688       dingus.staticMetadata = false;
 689       await dingus.serveFile(req, res, ctx, directory, fileName);
 690       assert(fs.promises.readFile.called);
 691       assert(!dingus.handlerNotFound.called);
 692     });
 693     it('does not serve dot-file', async function () {
 694       fileName = '.example';
 695       await dingus.serveFile(req, res, ctx, directory, fileName);
 696       assert(!fs.promises.readFile.called);
 697       assert(dingus.handlerNotFound.called);
 698     });
 699     it('does not serve encoded navigation', async function () {
 700       fileName = '/example.html';
 701       await dingus.serveFile(req, res, ctx, directory, fileName);
 702       assert(!fs.promises.readFile.called);
 703       assert(dingus.handlerNotFound.called);
 704     });
 705     it('does not serve missing file', async function () {
 706       fileName = 'no-file.here';
 707       await dingus.serveFile(req, res, ctx, directory, fileName);
 708       assert(dingus.handlerNotFound.called);
 709     });
 710     it('covers fs error', async function () {
 711       const expectedException = new Error('blah');
 712       fs.promises.stat.restore();
 713       sinon.stub(fs.promises, 'stat').rejects(expectedException);
 714       try {
 715         await dingus.serveFile(req, res, ctx, directory, fileName);
 716         assert.fail('should have thrown');
 717       } catch (e) {
 718         assert.strictEqual(e, expectedException);
 719       }
 720     });
 721     it('caches by modified', async function () {
 722       req._headers[Enum.Header.IfModifiedSince] = 'Fri, 23 Oct 2020 23:11:16 GMT';
 723       await dingus.serveFile(req, res, ctx, directory, fileName);
 724       assert.strictEqual(res.statusCode, 304);
 725     });
 726     it('does not cache old modified', async function () {
 727       req._headers[Enum.Header.IfModifiedSince] = 'Fri, 23 Oct 2020 01:11:16 GMT';
 728       await dingus.serveFile(req, res, ctx, directory, fileName);
 729       assert.notStrictEqual(res.statusCode, 304);
 730       assert(!dingus.handlerNotFound.called);
 731     });
 732     it('caches ETag match', async function () {
 733       req._headers[Enum.Header.IfNoneMatch] = '"zPPQVfXV36sgXq4fRLdsm+7rRMb8IUfb/eJ6N6mnwWs"';
 734       await dingus.serveFile(req, res, ctx, directory, fileName);
 735       assert.strictEqual(res.statusCode, 304);
 736     });
 737     it('does not cache ETag non-match', async function () {
 738       req._headers[Enum.Header.IfNoneMatch] = '"foo", "bar"';
 739       await dingus.serveFile(req, res, ctx, directory, fileName);
 740       assert.notStrictEqual(res.statusCode, 304);
 741       assert(!dingus.handlerNotFound.called);
 742     });
 743     it('handles no possible encodings', async function () {
 744       req._headers[Enum.Header.AcceptEncoding] = '*;q=0';
 745       await assert.rejects(async () => {
 746         await dingus.serveFile(req, res, ctx, directory, fileName);
 747       }, {
 748         name: 'ResponseError',
 749       });
 750     });
 751     it('handles a valid encoding', async function () {
 752       req._headers[Enum.Header.AcceptEncoding] = 'gzip';
 753       await dingus.serveFile(req, res, ctx, directory, fileName);
 754       assert(res.end.called);
 755     });
 756     it('handles a valid encoding among others', async function () {
 757       req._headers[Enum.Header.AcceptEncoding] = 'flarp, br, gzip';
 758       fs.promises.stat.restore();
 759       sinon.stub(fs.promises, 'stat')
 760         .onCall(0).resolves(filestats) // identity file
 761         .onCall(1).resolves(null) // br encoding
 762         .onCall(2).resolves(filestats); // gzip encoding
 763       await dingus.serveFile(req, res, ctx, directory, fileName);
 764       assert(res.end.called);
 765     });
 766   }); // serveFile
 767
 768   describe('renderError', function () {
 769     let err;
 770     beforeEach(function () {
 771       err = {
 772         statusCode: '200',
 773         errorMessage: 'OK',
 774         details: 'hunkydorey',
 775       };
 776     });
 777     it('renders unknown type', function () {
 778       const contentType = 'unknown/type';
 779       const result = dingus.renderError(contentType, err);
 780       assert.deepStrictEqual(result, 'OK\r\nhunkydorey');
 781     });
 782     it('renders text', function () {
 783       const contentType = 'text/plain';
 784       const result = dingus.renderError(contentType, err);
 785       assert.deepStrictEqual(result, 'OK\r\nhunkydorey');
 786     });
 787     it('renders json', function () {
 788       const contentType = Enum.ContentType.ApplicationJson;
 789       const result = dingus.renderError(contentType, err);
 790       assert.deepStrictEqual(result, JSON.stringify(err));
 791     });
 792     it('renders html without details', function () {
 793       err = {
 794         statusCode: '201',
 795         errorMessage: 'Created',
 796       };
 797       const contentType = 'text/html';
 798       const result = dingus.renderError(contentType, err);
 799       assert.deepStrictEqual(result, `<!DOCTYPE html>
 800 <html lang="en">
 801   <head>
 802     <title>${err.statusCode} ${err.errorMessage}</title>
 803   </head>
 804   <body>
 805     <h1>${err.errorMessage}</h1>
 806   </body>
 807 </html>`);
 808     });
 809     it('renders html', function () {
 810       const contentType = 'text/html';
 811       const result = dingus.renderError(contentType, err);
 812       assert.deepStrictEqual(result, `<!DOCTYPE html>
 813 <html lang="en">
 814   <head>
 815     <title>${err.statusCode} ${err.errorMessage}</title>
 816   </head>
 817   <body>
 818     <h1>${err.errorMessage}</h1>
 819     <p>${err.details}</p>
 820   </body>
 821 </html>`);
 822     });
 823     it('renders html, multiple details', function () {
 824       const contentType = 'text/html';
 825       err.details = ['one detail', 'two detail'];
 826       const result = dingus.renderError(contentType, err);
 827       assert.deepStrictEqual(result, `<!DOCTYPE html>
 828 <html lang="en">
 829   <head>
 830     <title>${err.statusCode} ${err.errorMessage}</title>
 831   </head>
 832   <body>
 833     <h1>${err.errorMessage}</h1>
 834     <p>one detail</p>
 835     <p>two detail</p>
 836   </body>
 837 </html>`);
 838     });
 839   }); // renderError
 840
 841   describe('sendErrorResponse', function () {
 842     let ctx, req, res;
 843     beforeEach(function () {
 844       ctx = {};
 845       req = {};
 846       res = {
 847         end: sinon.stub(),
 848         getHeader: sinon.stub(),
 849         getHeaders: sinon.stub(),
 850         hasHeader: sinon.stub().returns(true),
 851         setHeader: sinon.stub(),
 852       };
 853       sinon.stub(dingus, 'renderError');
 854     });
 855     it('covers', function () {
 856       const err = {
 857         statusCode: 444,
 858       };
 859       dingus.sendErrorResponse(err, req, res, ctx);
 860       assert(res.end.called);
 861     });
 862   }); // sendErrorResponse
 863
 864   describe('proxyPrefix', function () {
 865     let req, res, ctx, stubHandler, pfxDingus;
 866     const pfx = '/pfx';
 867
 868     beforeEach(function () {
 869       pfxDingus = new Dingus(console, { proxyPrefix: pfx });
 870       req = {
 871         setHeader: sinon.stub(),
 872         getHeader: sinon.stub(),
 873       };
 874       res = {
 875         statusCode: 200,
 876         end: sinon.stub(),
 877         setHeader: sinon.stub(),
 878         getHeader: sinon.stub(),
 879       };
 880       ctx = {};
 881       sinon.stub(pfxDingus, 'handlerMethodNotAllowed');
 882       sinon.stub(pfxDingus, 'handlerNotFound');
 883       stubHandler = sinon.stub();
 884     });
 885     afterEach(function () {
 886       sinon.restore();
 887     });
 888
 889     it('handles prefixed route', async function () {
 890       const urlPath = '/:id';
 891       const method = 'GET';
 892       pfxDingus.on(method, urlPath, stubHandler);
 893       req.url = pfx + '/abc';
 894       req.method = method;
 895
 896       await pfxDingus.dispatch(req, res, ctx);
 897       assert(stubHandler.called);
 898       assert(!pfxDingus.handlerMethodNotAllowed.called);
 899       assert(!pfxDingus.handlerNotFound.called);
 900     });
 901     it('does not handle prefixed route', async function () {
 902       const urlPath = '/:id';
 903       const method = 'GET';
 904       pfxDingus.on(method, urlPath, stubHandler);
 905       req.url = '/wrongpfx/abc';
 906       req.method = method;
 907
 908       await pfxDingus.dispatch(req, res, ctx);
 909       assert(!stubHandler.called);
 910       assert(!pfxDingus.handlerMethodNotAllowed.called);
 911       assert(pfxDingus.handlerNotFound.called);
 912     });
 913   }); // proxyPrefix
 914
 915   describe('handlerRedirect', function () {
 916     let req, res, ctx;
 917     beforeEach(function () {
 918       req = {
 919         getHeader: sinon.stub(),
 920       };
 921       res = {
 922         setHeader: sinon.stub(),
 923         end: sinon.stub(),
 924       };
 925       ctx = {};
 926     });
 927     it('covers', async function () {
 928       await dingus.handlerRedirect(req, res, ctx);
 929       assert(res.setHeader.called);
 930       assert(res.end.called);
 931     });
 932     it('covers non-defaults', async function () {
 933       await dingus.handlerRedirect(req, res, ctx, 308);
 934       assert(res.setHeader.called);
 935       assert(res.end.called);
 936     });
 937   }); // handlerRedirect
 938
 939   describe('handlerGetStaticFile', function () {
 940     let req, res, ctx;
 941     beforeEach(function () {
 942       req = {
 943         getHeader: sinon.stub(),
 944       };
 945       res = {
 946         setHeader: sinon.stub(),
 947       };
 948       ctx = {
 949         params: {
 950           file: '',
 951         },
 952       };
 953       sinon.stub(dingus, 'serveFile');
 954     });
 955     it('covers', async function () {
 956       await dingus.handlerGetStaticFile(req, res, ctx);
 957       assert(dingus.serveFile.called);
 958     });
 959     it('covers specified file', async function () {
 960       await dingus.handlerGetStaticFile(req, res, ctx, 'file.txt');
 961       assert(dingus.serveFile.called);
 962     });
 963   }); // handlerGetStaticFile
 964 });