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 response 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, undefined);
 281     });
 282     it('collects response without writing, persists written data', function () {
 283       Dingus.setHeadHandler(req, res, ctx, true);
 284       res.write(Buffer.from('foo'));
 285       res.write('baz');
 286       res.write();
 287       res.end('quux');
 288       assert(!origWrite.called);
 289       assert(origEnd.called);
 290       assert.deepStrictEqual(ctx.responseBody, Buffer.from('foobazquux'));
 291     });
 292     it('ignores non-head method', function () {
 293       req.method = 'GET';
 294       Dingus.setHeadHandler(req, res, ctx);
 295       res.write(Buffer.from('foo'));
 296       res.end('bar');
 297       assert(origWrite.called);
 298       assert(origEnd.called);
 299     });
 300   }); // setHeadHandler
 301
 302   describe('addEncodingHeader', function () {
 303     let res, encoding;
 304     beforeEach(function () {
 305       res = {
 306         _headers: {},
 307         // eslint-disable-next-line security/detect-object-injection
 308         getHeader: (h) => res._headers[h],
 309         // eslint-disable-next-line security/detect-object-injection
 310         setHeader: (h, v) => res._headers[h] = v,
 311       };
 312     });
 313     it('adds', function () {
 314       encoding = 'gzip';
 315       Dingus.addEncodingHeader(res, encoding);
 316       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'gzip');
 317     });
 318     it('extends', function () {
 319       encoding = 'utf8';
 320       Dingus.addEncodingHeader(res, encoding);
 321       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'utf8');
 322       encoding = 'gzip';
 323       Dingus.addEncodingHeader(res, encoding);
 324       assert.strictEqual(res._headers[Enum.Header.ContentEncoding], 'gzip, utf8');
 325     });
 326   }); // addEncodingHeader
 327
 328   describe('dispatch', function () {
 329     let pathsByLengthOrig;
 330     let req, res, ctx;
 331     let stubHandler;
 332
 333     beforeEach(function () {
 334       req = {
 335         url: '/',
 336         method: 'GET',
 337         setHeader: sinon.stub(),
 338         getHeader: sinon.stub(),
 339       };
 340       res = {
 341         statusCode: 200,
 342         end: sinon.stub(),
 343         setHeader: sinon.stub(),
 344         hasHeader: sinon.stub(),
 345         getHeader: sinon.stub(),
 346         getHeaders: sinon.stub(),
 347       };
 348       ctx = {};
 349       pathsByLengthOrig = dingus.pathsByLength;
 350       sinon.spy(dingus, 'handlerMethodNotAllowed');
 351       sinon.spy(dingus, 'handlerNotFound');
 352       sinon.spy(dingus, 'handlerBadRequest');
 353       sinon.spy(dingus, 'handlerInternalServerError');
 354       stubHandler = sinon.stub();
 355     });
 356     afterEach(function () {
 357       dingus.pathsByLength = pathsByLengthOrig;
 358     });
 359
 360     it('calls handler', async function () {
 361       const urlPath = '/:id';
 362       const method = 'GET';
 363       dingus.on(method, urlPath, stubHandler);
 364       req.url = '/abc';
 365       req.method = method;
 366
 367       await dingus.dispatch(req, res, ctx);
 368       assert(stubHandler.called);
 369       assert(!dingus.handlerMethodNotAllowed.called);
 370       assert(!dingus.handlerNotFound.called);
 371     });
 372     it('calls handler without context', async function () {
 373       const urlPath = '/:id';
 374       const method = 'GET';
 375       dingus.on(method, urlPath, stubHandler);
 376       req.url = '/abc';
 377       req.method = method;
 378
 379       await dingus.dispatch(req, res);
 380       assert(stubHandler.called);
 381       assert(!dingus.handlerMethodNotAllowed.called);
 382       assert(!dingus.handlerNotFound.called);
 383     });
 384     it('calls fallback handler', async function () {
 385       const urlPath = '/abc/:id';
 386       const method = 'GET';
 387       dingus.on('*', urlPath, stubHandler);
 388       req.url = '/abc/def';
 389       req.method = method;
 390
 391       await dingus.dispatch(req, res, ctx);
 392       assert(stubHandler.called);
 393       assert(!dingus.handlerMethodNotAllowed.called);
 394       assert(!dingus.handlerNotFound.called);
 395     });
 396     it('handles error in handler', async function () {
 397       const urlPath = '/:id';
 398       const method = 'GET';
 399       dingus.on(method, urlPath, stubHandler);
 400       req.url = '/abc';
 401       req.method = method;
 402       stubHandler.rejects(new Error('blah'));
 403
 404       await dingus.dispatch(req, res, ctx);
 405       assert(stubHandler.called);
 406       assert(!dingus.handlerMethodNotAllowed.called);
 407       assert(!dingus.handlerNotFound.called);
 408     });
 409     it('calls unsupported method', async function () {
 410       const urlPath = '/:id';
 411       const method = 'POST';
 412       dingus.on('GET', urlPath, stubHandler);
 413       req.url = '/abc';
 414       req.method = method;
 415
 416       await dingus.dispatch(req, res, ctx);
 417       assert(!stubHandler.called);
 418       assert(dingus.handlerMethodNotAllowed.called);
 419       assert(!dingus.handlerNotFound.called);
 420     });
 421     it('does not lookup nonexistent path', async function () {
 422       req.url = '/foo/bar';
 423       req.method = 'GET';
 424
 425       await dingus.dispatch(req, res, ctx);
 426       assert(!stubHandler.called);
 427       assert(!dingus.handlerMethodNotAllowed.called);
 428       assert(dingus.handlerNotFound.called);
 429     });
 430     it('covers unhandled dingus exception', async function () {
 431       const expectedException = new DingusError('blah');
 432       sinon.stub(dingus.router, 'lookup').throws(expectedException);
 433
 434       await dingus.dispatch(req, res, ctx);
 435       assert(!stubHandler.called);
 436       assert(dingus.handlerInternalServerError.called);
 437     });
 438     it('covers other exception', async function () {
 439       const expectedException = new Error('blah');
 440       sinon.stub(dingus.router, 'lookup').throws(expectedException);
 441
 442       await dingus.dispatch(req, res, ctx);
 443       assert(!stubHandler.called);
 444       assert(dingus.handlerInternalServerError.called);
 445     });
 446     it('covers bad uri', async function () {
 447       req.url = '/%f';
 448
 449       await dingus.dispatch(req, res, ctx);
 450       assert(dingus.handlerBadRequest.called);
 451     });
 452     it('calls handler with additional arguments', async function () {
 453       dingus.on('GET', '/', stubHandler, 'foo', 'bar');
 454       await dingus.dispatch(req, res, ctx);
 455       assert(stubHandler.called);
 456       assert.strictEqual(stubHandler.args[0][3], 'foo');
 457       assert.strictEqual(stubHandler.args[0][4], 'bar');
 458     });
 459   }); // dispatch
 460
 461   describe('parseBody', function () {
 462     let ctx;
 463     beforeEach(function () {
 464       ctx = {};
 465     });
 466     it('does not parse unknown type', function () {
 467       try {
 468         dingus.parseBody('unknown/type', ctx);
 469         assert.fail(noExpectedException);
 470       } catch (e) {
 471         assert.strictEqual(e.statusCode, 415);
 472       }
 473     });
 474     it('parses json', function () {
 475       const src = { foo: 'bar' };
 476       ctx.rawBody = JSON.stringify(src);
 477       dingus.parseBody(Enum.ContentType.ApplicationJson, ctx);
 478       assert.deepStrictEqual(ctx.parsedBody, src);
 479     });
 480     it('handles unparsable json', function () {
 481       ctx.rawBody = 'not json';
 482       try {
 483         dingus.parseBody(Enum.ContentType.ApplicationJson, ctx);
 484         assert.fail(noExpectedException);
 485       } catch (e) {
 486         assert.strictEqual(e.statusCode, 400);
 487       }
 488     });
 489     it('parses form', function () {
 490       const expected = Object.assign(Object.create(null), {
 491         foo: 'bar',
 492       });
 493       ctx.rawBody = 'foo=bar';
 494       dingus.parseBody('application/x-www-form-urlencoded', ctx);
 495       assert.deepStrictEqual(ctx.parsedBody, expected);
 496     });
 497
 498   }); // parseBody
 499
 500   describe('bodyData', function () {
 501     let res, resEvents;
 502     beforeEach(function () {
 503       resEvents = {};
 504       res = {
 505         // eslint-disable-next-line security/detect-object-injection
 506         on: (ev, fn) => resEvents[ev] = fn,
 507       };
 508     });
 509     it('provides data', async function () {
 510       const p = dingus.bodyData(res);
 511       resEvents['data'](Buffer.from('foo'));
 512       resEvents['data'](Buffer.from('bar'));
 513       resEvents['end']();
 514       const result = await p;
 515       assert.strictEqual(result, 'foobar');
 516     });
 517     it('handles error', async function () {
 518       const p = dingus.bodyData(res);
 519       resEvents['error']('foo');
 520       try {
 521         await p;
 522         assert.fail(noExpectedException);
 523       } catch (e) {
 524         assert.strictEqual(e, 'foo');
 525       }
 526     });
 527     it('limits size', async function () {
 528       const p = dingus.bodyData(res, 8);
 529       resEvents['data'](Buffer.from('foobar'));
 530       resEvents['data'](Buffer.from('bazquux'));
 531       try {
 532         await p;
 533         assert.fail(noExpectedException);
 534       } catch (e) {
 535         assert.strictEqual(e.statusCode, 413);
 536       }
 537     });
 538   }); // bodyData
 539
 540   describe('ingestBody', function () {
 541     it('covers', async function () {
 542       const req = {};
 543       const res = {};
 544       const ctx = {};
 545       sinon.stub(dingus, 'bodyData').resolves('{"foo":"bar"}')
 546       sinon.stub(Dingus, 'getRequestContentType').returns(Enum.ContentType.ApplicationJson);
 547       await dingus.ingestBody(req, res, ctx);
 548       assert.deepStrictEqual(ctx.parsedBody, { foo: 'bar' });
 549     });
 550   }); // ingestBody
 551
 552   describe('setResponseType', function () {
 553     let req, res, ctx;
 554     let _sa; // Preserve strictAccept
 555     before(function () {
 556       _sa = dingus.strictAccept;
 557     });
 558     after(function () {
 559       dingus.strictAccept = _sa;
 560     });
 561     beforeEach(function () {
 562       ctx = {};
 563       req = {};
 564       res = {
 565         setHeader: sinon.stub(),
 566       };
 567       sinon.stub(Dingus, 'getResponseContentType').returns();
 568     });
 569     it('rejects missing', function () {
 570       dingus.strictAccept = true;
 571       try {
 572         dingus.setResponseType(['my/type'], req, res, ctx);
 573         assert.fail(noExpectedException);
 574       } catch (e) {
 575         assert.strictEqual(e.statusCode, 406, 'did not get expected status code');
 576       }
 577     });
 578     it('accepts missing', function () {
 579       dingus.strictAccept = false;
 580       dingus.setResponseType(['my/type'], req, res, ctx);
 581       assert.strictEqual(ctx.responseType, 'my/type');
 582     });
 583
 584   }); // setResponseType
 585
 586   describe('_readFileInfo', function () {
 587     let stat, data, statRes, dataRes, filename;
 588     beforeEach(function () {
 589       sinon.stub(fs.promises, 'stat');
 590       sinon.stub(fs.promises, 'readFile');
 591       statRes = {
 592         mtimeMs:1612553697186,
 593       };
 594       dataRes = 'data';
 595       filename = 'dummy.txt';
 596     });
 597     it('succeeds', async function () {
 598       fs.promises.stat.resolves(statRes);
 599       fs.promises.readFile.resolves('data');
 600       [stat, data] = await dingus._readFileInfo(filename);
 601       assert.deepStrictEqual(stat, statRes);
 602       assert.deepStrictEqual(data, dataRes);
 603     });
 604     it('returns null for non-existant file', async function () {
 605       const noEnt = {
 606         code: 'ENOENT',
 607       };
 608       fs.promises.stat.rejects(noEnt);
 609       fs.promises.readFile.rejects(noEnt);
 610       [stat, data] = await dingus._readFileInfo(filename);
 611       assert.strictEqual(stat, null);
 612       assert.strictEqual(data, null);
 613     });
 614     it('throws unexpected error', async function () {
 615       const expectedException = new Error('blah');
 616       fs.promises.stat.rejects(expectedException);
 617       await assert.rejects(async () => {
 618         await dingus._readFileInfo(filename);
 619       }, expectedException);
 620     });
 621   }); // _readFileInfo
 622
 623   describe('_serveFileMetaHeaders', function () {
 624     let res, directory, fileName;
 625     beforeEach(function () {
 626       sinon.stub(dingus, '_readFileInfo');
 627       res = {
 628         setHeader: sinon.stub(),
 629       };
 630       directory = '/path';
 631       fileName = 'filename';
 632     });
 633     it('covers no meta file', async function() {
 634       dingus._readFileInfo.resolves([null, null]);
 635       await dingus._serveFileMetaHeaders(res, directory, fileName);
 636       assert(!res.setHeader.called);
 637     });
 638     it('adds extra headers', async function () {
 639       dingus._readFileInfo.resolves([{}, Buffer.from(`Link: <https://example.com/>; rel="relation"
 640 X-Folded-Header: data
 641   data under
 642   the fold
 643 Content-Type: image/sgi
 644 `)]);
 645       await dingus._serveFileMetaHeaders(res, directory, fileName);
 646       assert(res.setHeader.called);
 647     });
 648   }); // _serveFileMetaHeaders
 649
 650   describe('serveFile', function () {
 651     const path = require('path');
 652     let ctx, req, res, directory, fileName, filestats;
 653     beforeEach(function () {
 654       directory = path.join(__dirname, '..', 'test-data');
 655       fileName = 'example.html';
 656       ctx = {};
 657       req = {
 658         _headers: {
 659           [Enum.Header.Accept]: undefined,
 660           [Enum.Header.IfModifiedSince]: undefined,
 661           [Enum.Header.AcceptEncoding]: undefined,
 662           [Enum.Header.IfNoneMatch]: undefined,
 663         },
 664         getHeader: (header) => {
 665           if (header in req._headers) {
 666             // eslint-disable-next-line security/detect-object-injection
 667             return req._headers[header];
 668           }
 669           assert.fail(`unexpected getHeader ${header}`);
 670         },
 671       };
 672       res = {
 673         end: sinon.stub(),
 674         getHeader: sinon.stub(),
 675         getHeaders: sinon.stub(),
 676         hasHeader: sinon.stub().returns(true),
 677         setHeader: sinon.stub(),
 678       };
 679       filestats = {
 680         dev: 39,
 681         mode: 33188,
 682         nlink: 1,
 683         uid: 1002,
 684         gid: 1002,
 685         rdev: 0,
 686         blksize: 512,
 687         ino: 897653,
 688         size: 8,
 689         blocks: 17,
 690         atimeMs: 1613253436842.815,
 691         mtimeMs: 1603485933192.861,
 692         ctimeMs: 1603485933192.861,
 693         birthtimeMs: 0,
 694         atime: '2021-02-13T21:57:16.843Z',
 695         mtime: '2020-10-23T13:45:33.193Z',
 696         ctime: '2020-10-23T13:45:33.193Z',
 697         birthtime: '1970-01-01T00:00:00.000Z',
 698       };
 699       sinon.stub(dingus, 'handlerNotFound');
 700       sinon.stub(fs.promises, 'stat').resolves(filestats);
 701       sinon.spy(fs.promises, 'readFile');
 702     });
 703     it('serves a file', async function () {
 704       await dingus.serveFile(req, res, ctx, directory, fileName);
 705       assert(fs.promises.readFile.called);
 706       assert(!dingus.handlerNotFound.called);
 707     });
 708     it('covers no meta headers', async function () {
 709       dingus.staticMetadata = false;
 710       await dingus.serveFile(req, res, ctx, directory, fileName);
 711       assert(fs.promises.readFile.called);
 712       assert(!dingus.handlerNotFound.called);
 713     });
 714     it('does not serve dot-file', async function () {
 715       fileName = '.example';
 716       await dingus.serveFile(req, res, ctx, directory, fileName);
 717       assert(!fs.promises.readFile.called);
 718       assert(dingus.handlerNotFound.called);
 719     });
 720     it('does not serve encoded navigation', async function () {
 721       fileName = '/example.html';
 722       await dingus.serveFile(req, res, ctx, directory, fileName);
 723       assert(!fs.promises.readFile.called);
 724       assert(dingus.handlerNotFound.called);
 725     });
 726     it('does not serve missing file', async function () {
 727       fileName = 'no-file.here';
 728       await dingus.serveFile(req, res, ctx, directory, fileName);
 729       assert(dingus.handlerNotFound.called);
 730     });
 731     it('requires directory be specified', async function () {
 732       await dingus.serveFile(req, res, ctx, '', fileName);
 733       assert(!fs.promises.readFile.called);
 734       assert(dingus.handlerNotFound.called);
 735     });
 736     it('covers fs error', async function () {
 737       const expectedException = new Error('blah');
 738       fs.promises.stat.restore();
 739       sinon.stub(fs.promises, 'stat').rejects(expectedException);
 740       try {
 741         await dingus.serveFile(req, res, ctx, directory, fileName);
 742         assert.fail('should have thrown');
 743       } catch (e) {
 744         assert.strictEqual(e, expectedException);
 745       }
 746     });
 747     it('caches by modified', async function () {
 748       req._headers[Enum.Header.IfModifiedSince] = 'Fri, 23 Oct 2020 23:11:16 GMT';
 749       await dingus.serveFile(req, res, ctx, directory, fileName);
 750       assert.strictEqual(res.statusCode, 304);
 751     });
 752     it('does not cache old modified', async function () {
 753       req._headers[Enum.Header.IfModifiedSince] = 'Fri, 23 Oct 2020 01:11:16 GMT';
 754       await dingus.serveFile(req, res, ctx, directory, fileName);
 755       assert.notStrictEqual(res.statusCode, 304);
 756       assert(!dingus.handlerNotFound.called);
 757     });
 758     it('caches ETag match', async function () {
 759       req._headers[Enum.Header.IfNoneMatch] = '"zPPQVfXV36sgXq4fRLdsm+7rRMb8IUfb/eJ6N6mnwWs"';
 760       await dingus.serveFile(req, res, ctx, directory, fileName);
 761       assert.strictEqual(res.statusCode, 304);
 762     });
 763     it('does not cache ETag non-match', async function () {
 764       req._headers[Enum.Header.IfNoneMatch] = '"foo", "bar"';
 765       await dingus.serveFile(req, res, ctx, directory, fileName);
 766       assert.notStrictEqual(res.statusCode, 304);
 767       assert(!dingus.handlerNotFound.called);
 768     });
 769     it('handles no possible encodings', async function () {
 770       req._headers[Enum.Header.AcceptEncoding] = '*;q=0';
 771       await assert.rejects(async () => {
 772         await dingus.serveFile(req, res, ctx, directory, fileName);
 773       }, {
 774         name: 'ResponseError',
 775       });
 776     });
 777     it('handles a valid encoding', async function () {
 778       req._headers[Enum.Header.AcceptEncoding] = 'gzip';
 779       await dingus.serveFile(req, res, ctx, directory, fileName);
 780       assert(res.end.called);
 781     });
 782     it('handles a valid encoding among others', async function () {
 783       req._headers[Enum.Header.AcceptEncoding] = 'flarp, br, gzip';
 784       fs.promises.stat.restore();
 785       sinon.stub(fs.promises, 'stat')
 786         .onCall(0).resolves(filestats) // identity file
 787         .onCall(1).resolves(null) // br encoding
 788         .onCall(2).resolves(filestats); // gzip encoding
 789       await dingus.serveFile(req, res, ctx, directory, fileName);
 790       assert(res.end.called);
 791     });
 792   }); // serveFile
 793
 794   describe('renderError', function () {
 795     let err;
 796     beforeEach(function () {
 797       err = {
 798         statusCode: '200',
 799         errorMessage: 'OK',
 800         details: 'hunkydorey',
 801       };
 802     });
 803     it('renders unknown type', function () {
 804       const contentType = 'unknown/type';
 805       const result = dingus.renderError(contentType, err);
 806       assert.deepStrictEqual(result, 'OK\r\nhunkydorey');
 807     });
 808     it('renders text', function () {
 809       const contentType = 'text/plain';
 810       const result = dingus.renderError(contentType, err);
 811       assert.deepStrictEqual(result, 'OK\r\nhunkydorey');
 812     });
 813     it('renders json', function () {
 814       const contentType = Enum.ContentType.ApplicationJson;
 815       const result = dingus.renderError(contentType, err);
 816       assert.deepStrictEqual(result, JSON.stringify(err));
 817     });
 818     it('renders html without details', function () {
 819       err = {
 820         statusCode: '201',
 821         errorMessage: 'Created',
 822       };
 823       const contentType = 'text/html';
 824       const result = dingus.renderError(contentType, err);
 825       assert.deepStrictEqual(result, `<!DOCTYPE html>
 826 <html lang="en">
 827   <head>
 828     <title>${err.statusCode} ${err.errorMessage}</title>
 829   </head>
 830   <body>
 831     <h1>${err.errorMessage}</h1>
 832   </body>
 833 </html>`);
 834     });
 835     it('renders html', function () {
 836       const contentType = 'text/html';
 837       const result = dingus.renderError(contentType, err);
 838       assert.deepStrictEqual(result, `<!DOCTYPE html>
 839 <html lang="en">
 840   <head>
 841     <title>${err.statusCode} ${err.errorMessage}</title>
 842   </head>
 843   <body>
 844     <h1>${err.errorMessage}</h1>
 845     <p>${err.details}</p>
 846   </body>
 847 </html>`);
 848     });
 849     it('renders html, multiple details', function () {
 850       const contentType = 'text/html';
 851       err.details = ['one detail', 'two detail'];
 852       const result = dingus.renderError(contentType, err);
 853       assert.deepStrictEqual(result, `<!DOCTYPE html>
 854 <html lang="en">
 855   <head>
 856     <title>${err.statusCode} ${err.errorMessage}</title>
 857   </head>
 858   <body>
 859     <h1>${err.errorMessage}</h1>
 860     <p>one detail</p>
 861     <p>two detail</p>
 862   </body>
 863 </html>`);
 864     });
 865   }); // renderError
 866
 867   describe('sendErrorResponse', function () {
 868     let ctx, req, res;
 869     beforeEach(function () {
 870       ctx = {};
 871       req = {};
 872       res = {
 873         end: sinon.stub(),
 874         getHeader: sinon.stub(),
 875         getHeaders: sinon.stub(),
 876         hasHeader: sinon.stub().returns(true),
 877         setHeader: sinon.stub(),
 878       };
 879       sinon.stub(dingus, 'renderError');
 880     });
 881     it('covers', function () {
 882       const err = {
 883         statusCode: 444,
 884       };
 885       dingus.sendErrorResponse(err, req, res, ctx);
 886       assert(res.end.called);
 887     });
 888   }); // sendErrorResponse
 889
 890   describe('proxyPrefix', function () {
 891     let req, res, ctx, stubHandler, pfxDingus;
 892     const pfx = '/pfx';
 893
 894     beforeEach(function () {
 895       pfxDingus = new Dingus(console, { proxyPrefix: pfx });
 896       req = {
 897         setHeader: sinon.stub(),
 898         getHeader: sinon.stub(),
 899       };
 900       res = {
 901         statusCode: 200,
 902         end: sinon.stub(),
 903         setHeader: sinon.stub(),
 904         getHeader: sinon.stub(),
 905       };
 906       ctx = {};
 907       sinon.stub(pfxDingus, 'handlerMethodNotAllowed');
 908       sinon.stub(pfxDingus, 'handlerNotFound');
 909       stubHandler = sinon.stub();
 910     });
 911     afterEach(function () {
 912       sinon.restore();
 913     });
 914
 915     it('handles prefixed route', async function () {
 916       const urlPath = '/:id';
 917       const method = 'GET';
 918       pfxDingus.on(method, urlPath, stubHandler);
 919       req.url = pfx + '/abc';
 920       req.method = method;
 921
 922       await pfxDingus.dispatch(req, res, ctx);
 923       assert(stubHandler.called);
 924       assert(!pfxDingus.handlerMethodNotAllowed.called);
 925       assert(!pfxDingus.handlerNotFound.called);
 926     });
 927     it('does not handle prefixed route', async function () {
 928       const urlPath = '/:id';
 929       const method = 'GET';
 930       pfxDingus.on(method, urlPath, stubHandler);
 931       req.url = '/wrongpfx/abc';
 932       req.method = method;
 933
 934       await pfxDingus.dispatch(req, res, ctx);
 935       assert(!stubHandler.called);
 936       assert(!pfxDingus.handlerMethodNotAllowed.called);
 937       assert(pfxDingus.handlerNotFound.called);
 938     });
 939   }); // proxyPrefix
 940
 941   describe('handlerRedirect', function () {
 942     let req, res, ctx;
 943     beforeEach(function () {
 944       req = {
 945         getHeader: sinon.stub(),
 946       };
 947       res = {
 948         setHeader: sinon.stub(),
 949         end: sinon.stub(),
 950       };
 951       ctx = {};
 952     });
 953     it('covers', async function () {
 954       await dingus.handlerRedirect(req, res, ctx);
 955       assert(res.setHeader.called);
 956       assert(res.end.called);
 957     });
 958     it('covers non-defaults', async function () {
 959       await dingus.handlerRedirect(req, res, ctx, 308);
 960       assert(res.setHeader.called);
 961       assert(res.end.called);
 962     });
 963   }); // handlerRedirect
 964
 965   describe('handlerGetStaticFile', function () {
 966     let req, res, ctx;
 967     beforeEach(function () {
 968       req = {
 969         getHeader: sinon.stub(),
 970       };
 971       res = {
 972         setHeader: sinon.stub(),
 973       };
 974       ctx = {
 975         params: {
 976           file: '',
 977         },
 978       };
 979       sinon.stub(dingus, 'serveFile');
 980     });
 981     it('covers', async function () {
 982       await dingus.handlerGetStaticFile(req, res, ctx);
 983       assert(dingus.serveFile.called);
 984     });
 985     it('covers specified file', async function () {
 986       await dingus.handlerGetStaticFile(req, res, ctx, 'file.txt');
 987       assert(dingus.serveFile.called);
 988     });
 989   }); // handlerGetStaticFile
 990 });