@contrast/route-coverage 1.22.1 → 1.23.1

package/lib/index.d.ts

@@ -24,9 +24,10 @@ export { RouteInfo };
 
 export interface RouteCoverage extends Installable {
   discover(info: RouteInfo): void;
-  delete(info: RouteInfo): void;
   discoveryFinished(): void;
-  observe(info: Pick<RouteInfo>): void;
+  queue(info: RouteInfo): void;
+  queuingFinished(): void;
+  observe(info: RouteInfo): void;
 }
 
 export interface Core {

package/lib/index.js

@@ -34,18 +34,38 @@ module.exports = function init(core) {
   const routeInfo = new Map();
   const recentlyObserved = new Set();
 
+  const routeQueue = new Map();
   const routeCoverage = core.routeCoverage = {
     discover(info) {
       routeInfo.set(routeIdentifier(info), info);
     },
 
-    delete(info) {
-      routeInfo.delete(routeIdentifier(info));
-    },
-
     discoveryFinished() {
       const routes = Array.from(routeInfo.values());
       messages.emit(Event.ROUTE_COVERAGE_DISCOVERY_FINISHED, routes);
+
+      this.discover = this.queue;
+      this.discoveryFinished = this.queuingFinished;
+    },
+
+    // See NODE-3548: routes defined "lazily" will be discovered here after startup, queued, and reported
+    queue(info) {
+      const id = routeIdentifier(info);
+      if (routeInfo.has(id)) return;
+
+      routeInfo.set(id, info);
+      routeQueue.set(id, info);
+      if (routeQueue.size === 1) {
+        setTimeout(() => {
+          this.discoveryFinished();
+        }, 10000);
+      }
+    },
+
+    queuingFinished() {
+      const routes = Array.from(routeQueue.values());
+      messages.emit(Event.ROUTE_COVERAGE_DISCOVERY_FINISHED, routes);
+      routeQueue.clear();
     },
 
     observe(info) {

package/lib/index.test.js

@@ -11,11 +11,12 @@ const { installsComponents } = require('@contrast/test/utils');
 const MODULES = ['express', 'fastify', 'hapi', 'koa'];
 
 describe('route coverage', function () {
-  let core, simulateRequestScope, routeCoverage;
+  let core, simulateRequestScope, routeCoverage, clock;
 
   beforeEach(function () {
     ({ core, simulateRequestScope } = initAssessFixture());
 
+    clock = sinon.useFakeTimers();
     sinon.spy(core.messages, 'emit');
 
     const moduleMock = (moduleName) => (deps) => {
@@ -59,6 +60,27 @@ describe('route coverage', function () {
         [eventA, eventB],
       );
     });
+
+    it('queues new events after initial discovery is finished', function () {
+      const eventA = { signature: 'hello', url: 'url', method: 'get' };
+      core.routeCoverage.discover(eventA);
+      core.routeCoverage.discoveryFinished();
+      expect(core.messages.emit).to.have.been.calledWith(
+        Event.ROUTE_COVERAGE_DISCOVERY_FINISHED,
+        [eventA],
+      );
+
+      const eventB = { signature: 'hello', url: 'url', method: 'post' };
+      core.routeCoverage.discover(eventA); // check that we dedupe routes discoverd on startup
+      core.routeCoverage.discover(eventB);
+      core.routeCoverage.discover(eventB); // check that we dedupe routes defined lazily
+      clock.tick(10000); //queuingFinished
+
+      expect(core.messages.emit).to.have.been.calledWith(
+        Event.ROUTE_COVERAGE_DISCOVERY_FINISHED,
+        [eventB],
+      );
+    });
   });
 
   describe('.observe()', function () {

package/lib/install/fastify.js

@@ -116,10 +116,6 @@ module.exports = function init(core) {
               },
             });
           });
-          server.addHook('onReady', (done) => {
-            routeCoverage.discoveryFinished();
-            return done();
-          });
         }
       }));
     }

package/lib/install/fastify.test.js

@@ -154,12 +154,6 @@ describe('route-coverage fastify', function () {
     expect(core.routeCoverage.discover).to.have.callCount(2);
   });
 
-  it('signals that discovery is finished when the onReady hook is triggered', function () {
-    serverMock.addHook.withArgs('onReady').yield(sinon.stub());
-
-    expect(core.routeCoverage.discoveryFinished).to.have.been.calledOnce;
-  });
-
   it('observes a route when the route handler is called', function () {
     const routeOptions = {
       method: 'GET',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/route-coverage",
-  "version": "1.22.1",
+  "version": "1.23.1",
   "description": "Handles route discovery and observation",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,12 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.23.0",
-    "@contrast/fn-inspect": "^4.3.0"
+    "@contrast/common": "1.24.0",
+    "@contrast/config": "1.31.0",
+    "@contrast/dep-hooks": "1.3.4",
+    "@contrast/fn-inspect": "^4.3.0",
+    "@contrast/logger": "1.8.5",
+    "@contrast/patcher": "1.7.5",
+    "@contrast/scopes": "1.4.2"
   }
 }