Replace unmaintained mock-express-response with node-mocks-http

Author: diox

package.json

@@ -300,6 +300,7 @@
     "mock-express-request": "^0.2.0",
     "mock-express-response": "^0.3.0",
     "node-fetch": "^3.3.2",
+    "node-mocks-http": "1.17.2",
     "nodemon": "^3.1.10",
     "pino-devtools": "^2.8.0",
     "pino-pretty": "^13.1.1",

tests/unit/amo/middleware/test_HstsMiddleware.js

@@ -1,14 +1,13 @@
-import MockExpressRequest from 'mock-express-request';
-import MockExpressResponse from 'mock-express-response';
+import httpMocks from 'node-mocks-http';
 
 import { hsts } from 'amo/middleware';
 
 describe(__filename, () => {
   it('provides the expected HSTS headers', () => {
     const middleware = hsts();
     const nextSpy = sinon.stub();
-    const req = new MockExpressRequest();
-    const res = new MockExpressResponse();
+    const req = httpMocks.createRequest();
+    const res = httpMocks.createResponse();
 
     middleware(req, res, nextSpy);
 

tests/unit/amo/middleware/test_cspMiddleware.js

@@ -1,5 +1,4 @@
-import MockExpressRequest from 'mock-express-request';
-import MockExpressResponse from 'mock-express-response';
+import httpMocks from 'node-mocks-http';
 import parse from 'content-security-policy-parser';
 
 import { csp } from 'amo/middleware';
@@ -122,8 +121,8 @@ describe(__filename, () => {
       const config = require('config');
       const middleware = csp({ _config: config });
       const nextSpy = sinon.stub();
-      const req = new MockExpressRequest();
-      const res = new MockExpressResponse();
+      const req = httpMocks.createRequest();
+      const res = httpMocks.createResponse();
       middleware(req, res, nextSpy);
       const cspHeader = res.get('content-security-policy');
       const policy = parse(cspHeader);
@@ -140,8 +139,8 @@ describe(__filename, () => {
       const middleware = csp({ _config: getFakeConfig({ CSP: false }), _log });
 
       const nextSpy = sinon.stub();
-      const req = new MockExpressRequest();
-      const res = new MockExpressResponse();
+      const req = httpMocks.createRequest();
+      const res = httpMocks.createResponse();
 
       middleware(req, res, nextSpy);
 
@@ -157,8 +156,8 @@ describe(__filename, () => {
       const middleware = csp({ _config: getFakeConfig({ CSP: false }), _log });
 
       const nextSpy = sinon.stub();
-      const req = new MockExpressRequest();
-      const res = new MockExpressResponse();
+      const req = httpMocks.createRequest();
+      const res = httpMocks.createResponse();
 
       middleware(req, res, nextSpy);
 

tests/unit/amo/middleware/test_frameguardMiddleware.js

@@ -1,5 +1,4 @@
-import MockExpressRequest from 'mock-express-request';
-import MockExpressResponse from 'mock-express-response';
+import httpMocks from 'node-mocks-http';
 
 import { frameguard } from 'amo/middleware';
 
@@ -17,8 +16,8 @@ describe(__filename, () => {
     const conf = require('config');
     const middleware = frameguard({ _config: conf });
     const nextSpy = sinon.stub();
-    const req = new MockExpressRequest();
-    const res = new MockExpressResponse();
+    const req = httpMocks.createRequest();
+    const res = httpMocks.createResponse();
     middleware(req, res, nextSpy);
     expect(res.get('x-frame-options')).toEqual('DENY');
     sinon.assert.calledOnce(nextSpy);

tests/unit/amo/middleware/test_requestId.js

@@ -1,16 +1,15 @@
 /**
  * @jest-environment node
  */
-import MockExpressRequest from 'mock-express-request';
-import MockExpressResponse from 'mock-express-response';
+import httpMocks from 'node-mocks-http';
 
 import { AMO_REQUEST_ID_HEADER } from 'amo/constants';
 import requestId from 'amo/middleware/requestId';
 
 describe(__filename, () => {
   function _requestId({
-    req = new MockExpressRequest(),
-    res = new MockExpressResponse(),
+    req = httpMocks.createRequest(),
+    res = httpMocks.createResponse(),
     next = sinon.stub(),
     _httpContext = {
       set: sinon.stub(),
@@ -20,7 +19,7 @@ describe(__filename, () => {
   }
 
   it('adds a generated request ID to the HTTP context and response', () => {
-    const res = new MockExpressResponse();
+    const res = httpMocks.createResponse();
     const next = sinon.stub();
     const _httpContext = {
       set: sinon.stub(),
@@ -38,8 +37,8 @@ describe(__filename, () => {
   });
 
   it('uses the request ID from the request when available', () => {
-    const req = new MockExpressRequest();
-    const res = new MockExpressResponse();
+    const req = httpMocks.createRequest();
+    const res = httpMocks.createResponse();
     const _httpContext = {
       set: sinon.stub(),
     };
@@ -54,7 +53,7 @@ describe(__filename, () => {
   });
 
   it('ensures the request has AMO_REQUEST_ID_HEADER', () => {
-    const req = new MockExpressRequest();
+    const req = httpMocks.createRequest();
     expect(req.get(AMO_REQUEST_ID_HEADER)).not.toBeDefined();
 
     _requestId({ req });

tests/unit/amo/utils/test_server.js

@@ -1,7 +1,8 @@
 import path from 'path';
+import EventEmitter from 'events';
 
 import fs from 'fs-extra';
-import MockExpressResponse from 'mock-express-response';
+import httpMocks from 'node-mocks-http';
 
 import {
   viewFrontendVersionHandler,
@@ -19,16 +20,16 @@ describe(__filename, () => {
       const _config = getFakeConfig({ basePath });
       const handler = viewFrontendVersionHandler({ _config });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse({
+        eventEmitter: EventEmitter,
+      });
       handler(null, res);
 
-      res.on('finish', () => {
+      res.on('end', () => {
         expect(res.statusCode).toEqual(200);
-        expect(res.get('content-type')).toEqual(
-          'application/json; charset=utf-8',
-        );
+        expect(res.get('content-type')).toEqual('application/json');
         expect(res.get('access-control-allow-origin')).toEqual('*');
-        expect(res._getJSON()).toMatchObject(versionJson);
+        expect(res._getJSONData()).toMatchObject(versionJson);
 
         done();
       });
@@ -50,11 +51,13 @@ describe(__filename, () => {
       );
       const handler = viewFrontendVersionHandler({ _config });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse({
+        eventEmitter: EventEmitter,
+      });
       handler(null, res);
 
-      res.on('finish', () => {
-        expect(res._getJSON()).toMatchObject({
+      res.on('end', () => {
+        expect(res._getJSONData()).toMatchObject({
           ...versionJson,
           experiments,
           feature_flags: {
@@ -73,10 +76,12 @@ describe(__filename, () => {
 
       const handler = viewFrontendVersionHandler({ _config, _log });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse({
+        eventEmitter: EventEmitter,
+      });
       handler(null, res);
 
-      res.on('finish', () => {
+      res.on('end', () => {
         expect(res.statusCode).toEqual(415);
         sinon.assert.calledOnce(_log.error);
 
@@ -94,7 +99,7 @@ describe(__filename, () => {
       const _fetch = jest.fn().mockResolvedValue({ status: 200 });
       const handler = viewHeartbeatHandler({ _config, _fetch });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse();
       await handler(null, res);
 
       expect(_fetch).toHaveBeenCalledWith(
@@ -107,7 +112,7 @@ describe(__filename, () => {
       const _fetch = jest.fn().mockResolvedValue({ status: 400 });
       const handler = viewHeartbeatHandler({ _fetch });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse();
       await handler(null, res);
 
       expect(res.statusCode).toEqual(500);
@@ -117,7 +122,7 @@ describe(__filename, () => {
       const _fetch = jest.fn().mockRejectedValue();
       const handler = viewHeartbeatHandler({ _fetch });
 
-      const res = new MockExpressResponse();
+      const res = httpMocks.createResponse();
       await handler(null, res);
 
       expect(res.statusCode).toEqual(500);

yarn.lock

@@ -2182,7 +2182,7 @@ abort-controller@^3.0.0:
   dependencies:
     event-target-shim "^5.0.0"
 
-accepts@^1.3.4:
+accepts@^1.3.4, accepts@^1.3.7:
   version "1.3.8"
   resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.8.tgz#0bf0be125b67014adcb0b0921e62db7bffe16b2e"
   integrity sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==
@@ -3309,7 +3309,7 @@ confusing-browser-globals@^1.0.10:
   resolved "https://registry.yarnpkg.com/confusing-browser-globals/-/confusing-browser-globals-1.0.11.tgz#ae40e9b57cdd3915408a2805ebd3a5585608dc81"
   integrity sha512-JsPKdmh8ZkmnHxDk55FZ1TqVLvEQTvoByJZRN9jzI0UjxK/QgAmsphz7PGtqgPieQZ/CQcHWXCR7ATDNhGe+YA==
 
-content-disposition@^0.5.2:
+content-disposition@^0.5.2, content-disposition@^0.5.3:
   version "0.5.4"
   resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.4.tgz#8b82b4efac82512a02bb0b1dcec9d2c5e8eb5bfe"
   integrity sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==
@@ -3818,7 +3818,7 @@ [email protected], depd@^2.0.0, depd@~2.0.0:
   resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df"
   integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==
 
-depd@^1.1.1, depd@~1.1.2:
+depd@^1.1.0, depd@^1.1.1, depd@~1.1.2:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9"
   integrity sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==
@@ -7438,6 +7438,11 @@ meow@^10.1.5:
     type-fest "^1.2.2"
     yargs-parser "^20.2.9"
 
+merge-descriptors@^1.0.1:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.3.tgz#d80319a65f3c7935351e5cfdac8f9318504dbed5"
+  integrity sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==
+
 merge-descriptors@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-2.0.0.tgz#ea922f660635a2249ee565e0449f951e6b603808"
@@ -7500,6 +7505,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/mime/-/mime-2.6.0.tgz#a2a682a95cd4d0cb1d6257e28f83da7e35800367"
   integrity sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg==
 
+mime@^1.3.4:
+  version "1.6.0"
+  resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1"
+  integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==
+
 mimic-fn@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b"
@@ -7714,6 +7724,22 @@ node-int64@^0.4.0:
   resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"
   integrity sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==
 
+[email protected]:
+  version "1.17.2"
+  resolved "https://registry.yarnpkg.com/node-mocks-http/-/node-mocks-http-1.17.2.tgz#e947d9b94defb13e3775414a8200c848f6b2fc74"
+  integrity sha512-HVxSnjNzE9NzoWMx9T9z4MLqwMpLwVvA0oVZ+L+gXskYXEJ6tFn3Kx4LargoB6ie7ZlCLplv7QbWO6N+MysWGA==
+  dependencies:
+    accepts "^1.3.7"
+    content-disposition "^0.5.3"
+    depd "^1.1.0"
+    fresh "^0.5.2"
+    merge-descriptors "^1.0.1"
+    methods "^1.1.2"
+    mime "^1.3.4"
+    parseurl "^1.3.3"
+    range-parser "^1.2.0"
+    type-is "^1.6.18"
+
 node-releases@^2.0.19:
   version "2.0.19"
   resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.19.tgz#9e445a52950951ec4d177d843af370b411caf314"
@@ -10848,7 +10874,7 @@ type-fest@^3.0.0:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-3.4.0.tgz#64a35b7748ab4a96b3e0c324475ea66643c5f9df"
   integrity sha512-PEPg6RHlB9cFwoTMNENNrQFL0cXX04voWr2UPwQBJ3pVs7Mt8Y1oLWdUeMdGEwZE8HFFlujq8gS9enmyiQ8pLg==
 
-type-is@^1.6.15:
+type-is@^1.6.15, type-is@^1.6.18:
   version "1.6.18"
   resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131"
   integrity sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==