@contrast/route-coverage 1.45.1 → 1.45.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -23,11 +23,13 @@ import { Scopes } from '@contrast/scopes';
23
23
  export { RouteInfo };
24
24
 
25
25
  export interface RouteCoverage extends Installable {
26
+ _normalizedUrlMapper: any;
26
27
  discover(info: RouteInfo): void;
27
28
  discoveryFinished(): void;
28
29
  queue(info: RouteInfo): void;
29
30
  queuingFinished(): void;
30
31
  observe(info: RouteInfo): void;
32
+ uriPathToNormalizedUrl(uriPath: string): string;
31
33
  }
32
34
 
33
35
  export interface Core {
package/lib/index.js CHANGED
@@ -44,8 +44,11 @@ module.exports = function init(core) {
44
44
  },
45
45
 
46
46
  discover(info) {
47
+ const id = routeIdentifier(info.method, info.signature);
48
+ if (routeInfo.get(id)) return;
49
+
47
50
  logger.trace({ info }, 'Discovered new route:');
48
- routeInfo.set(routeIdentifier(info.method, info.signature), info);
51
+ routeInfo.set(id, info);
49
52
  this._normalizedUrlMapper.handleDiscover(info);
50
53
 
51
54
  },
@@ -67,7 +70,7 @@ module.exports = function init(core) {
67
70
  if (routeQueue.size === 1) {
68
71
  setTimeout(() => {
69
72
  this.discoveryFinished();
70
- }, 10000);
73
+ }, 10_000);
71
74
  }
72
75
  },
73
76
 
@@ -99,16 +102,12 @@ module.exports = function init(core) {
99
102
  route.method = info.method;
100
103
  route.url = info.url;
101
104
  const store = scopes.sources.getStore();
102
- if (store && !store.route) {
103
- store.route = route;
104
- }
105
105
 
106
+ if (store) store.route = route;
106
107
  if (recentlyObserved.has(route.signature)) return;
107
108
 
108
109
  recentlyObserved.add(route.signature);
109
-
110
110
  logger.trace({ info }, 'Observed route:');
111
-
112
111
  // these events need source correlation
113
112
  messages.emit(Event.ROUTE_COVERAGE_OBSERVATION, {
114
113
  ...route,
@@ -122,7 +121,6 @@ module.exports = function init(core) {
122
121
  },
123
122
  };
124
123
 
125
- require('./install/http')(core);
126
124
  require('./install/express')(core);
127
125
  require('./install/fastify')(core);
128
126
  require('./install/graphql')(core);
@@ -130,5 +128,13 @@ module.exports = function init(core) {
130
128
  require('./install/koa')(core);
131
129
  require('./install/restify')(core);
132
130
 
131
+ messages.on(Event.SERVER_LISTENING, () => {
132
+ // we wait to report in timers event loop phase, this way we can
133
+ // have components respond to this synchronously to finalize discovery
134
+ setImmediate(() => {
135
+ core.routeCoverage.discoveryFinished();
136
+ });
137
+ });
138
+
133
139
  return routeCoverage;
134
140
  };
@@ -14,6 +14,22 @@
14
14
  */
15
15
  'use strict';
16
16
 
17
+ const { AsyncLocalStorage } = require('node:async_hooks');
18
+ const {
19
+ get,
20
+ set,
21
+ isString,
22
+ Event,
23
+ primordials: {
24
+ ArrayPrototypeJoin,
25
+ StringPrototypeSubstring,
26
+ StringPrototypeToLowerCase,
27
+ StringPrototypeReplace,
28
+ }
29
+ } = require('@contrast/common');
30
+ const { funcInfo } = require('@contrast/fn-inspect');
31
+ const Core = require('@contrast/core/lib/ioc/core');
32
+
17
33
  const METHODS = [
18
34
  'all',
19
35
  'get',
@@ -24,233 +40,506 @@ const METHODS = [
24
40
  'options',
25
41
  'head',
26
42
  ];
27
- const framework = 'express';
28
- const { patchType, createSignature } = require('../../utils/route-info');
29
- const {
30
- isString,
31
- primordials: {
32
- ArrayPrototypeJoin,
33
- ArrayPrototypeSlice,
34
- StringPrototypeSplit,
35
- StringPrototypeToLowerCase,
36
- StringPrototypeReplace,
37
- StringPrototypeSlice,
38
- PathBasename
39
- }
40
- } = require('@contrast/common');
41
- const { match } = require('path-to-regexp');
42
- const fnInspect = require('@contrast/fn-inspect');
43
-
44
- module.exports = function init(core) {
45
-
46
- const discovered = [];
47
- const routerMap = new Map();
48
- const { patcher, depHooks, routeCoverage } = core;
49
-
50
- const removeTrailingSlash = (url) => (url.endsWith('/') && url !== '/') ? StringPrototypeSlice.call(url, 0, -1) : url;
51
- const format = (url) => Array.isArray(url)
52
- ? `/[${ArrayPrototypeJoin.call(url)}]`
53
- : removeTrailingSlash(url); // remove trailing slash
54
- const isRouter = (layer) => layer?.name && StringPrototypeToLowerCase.call(layer.name) === 'router';
55
-
56
- function getFnName({ method, file, lineNumber, column }) {
57
- if (method) return method;
58
- if (!file) return '(anonymous)';
59
- const base = PathBasename(file);
60
- return `(anonymous ${base} ${lineNumber}:${column})`;
61
- }
43
+ const componentName = 'routeCoverage.express5';
44
+ const kMetaKey = Symbol('cs_meta');
45
+ const enumerable = false;
62
46
 
63
- function createRouteInfo(url, method, obj, fn) {
64
- const fnInfo = fnInspect.funcInfo(fn);
65
- const fnName = getFnName(fnInfo);
66
- const originalUrl = url;
67
- url = format(url);
68
- return {
69
- url,
70
- method,
71
- fnName,
72
- framework,
73
- originalUrl,
74
- normalizedUrl: url,
75
- signature: createSignature(url, method, obj, fnName)
76
- };
77
- }
47
+ module.exports = Core.makeComponent({
48
+ name: componentName,
49
+ factory: (core) => new ExpressInstrumentation(core),
50
+ });
51
+
52
+ class ExpressInstrumentation {
53
+ constructor(core) {
54
+ // decorate
55
+ set(core, componentName, this);
78
56
 
79
- function updateRouteInfo(prefix, routeInfo) {
80
- const { url, normalizedUrl, fnName, method, addedPrefix = '' } = routeInfo;
81
- const updatedUrl = removeTrailingSlash(prefix + url);
82
- const updatedNormalizedUrl = removeTrailingSlash(prefix + normalizedUrl);
83
- const updatedAddedPrefix = removeTrailingSlash(prefix + addedPrefix);
84
- const updatedSignature = createSignature(updatedUrl, method, 'router', fnName);
85
- return {
86
- ...routeInfo,
87
- url: updatedUrl,
88
- addedPrefix: updatedAddedPrefix,
89
- normalizedUrl: updatedNormalizedUrl,
90
- signature: updatedSignature
91
- };
57
+ this.core = core;
58
+ this.methodScope = new AsyncLocalStorage();
59
+ this.handleScope = new AsyncLocalStorage();
92
60
  }
93
61
 
94
- function discover(routeInfo) {
95
- const { url, normalizedUrl, signature, method, framework } = routeInfo;
96
- if (!url || !normalizedUrl || !signature || !method || !framework) return;
97
- routeCoverage.discover({
98
- url,
99
- normalizedUrl,
100
- signature,
101
- method,
102
- framework
103
- });
62
+ install() {
63
+ const self = this;
64
+ const { core, handleScope, methodScope } = this;
65
+ const patchType = 'route-coverage-express';
66
+ const name = 'express-5';
104
67
 
105
- // Used to match urls during route observation
106
- let urlToMatch = routeInfo.normalizedUrl;
107
- if (Array.isArray(routeInfo.originalUrl)) {
108
- const prefix = routeInfo?.addedPrefix || '';
109
- urlToMatch = routeInfo.originalUrl.map(seg => prefix + seg);
110
- }
111
- const matchUrl = match(urlToMatch);
112
- routeInfo.match = matchUrl;
68
+ //
69
+ // discovery instrumentation
70
+ //
113
71
 
114
- discovered.push(routeInfo);
115
- }
72
+ core.depHooks.resolve({ name: 'express', version: '5' }, (express) => {
73
+ // wrap router and app methods in "method scope" to capture info to help build signatures.
74
+ // express has a number of APIs that work at different levels of abstraction, and we need to patch
75
+ // all of them. the scopes let us know what top-level APIs are being called by application code.
76
+ [...METHODS, 'use', 'route'].forEach((method) => {
77
+ // then setup app and router to run in method scopes
78
+ core.patcher.patch(express.application, method, {
79
+ name: `express.application.${method}`,
80
+ patchType: `${patchType}-discovery`,
81
+ around(next, data) {
82
+ if (methodScope.getStore()) return next();
83
+ return methodScope.run({ method, args: data.args, type: 'app' }, next);
84
+ }
85
+ });
116
86
 
117
- function wrapForObservation(handler, routeInfo, isRouter = false) {
118
- const handlerInfo = fnInspect.funcInfo(handler);
119
- const handlerName = getFnName(handlerInfo);
120
- return patcher.patch(handler, {
121
- name: 'handler',
122
- patchType,
123
- post(data) {
124
- const [req] = data.args;
125
- const [url] = StringPrototypeSplit.call(req.originalUrl, '?');
126
- const method = StringPrototypeToLowerCase.call(req.method);
127
- if (url && method) {
128
- if (isRouter) {
129
- for (const route of discovered) {
130
- if (route.match(url) && route.fnName === handlerName) {
131
- const { signature, normalizedUrl } = route;
132
- routeCoverage.observe({ url, method, signature, framework, normalizedUrl });
133
- break;
134
- }
135
- }
136
- } else {
137
- const { signature, normalizedUrl } = routeInfo;
138
- routeCoverage.observe({ url, method, signature, framework, normalizedUrl });
87
+ core.patcher.patch(express.Router.prototype, method, {
88
+ name: `express.Router.prototype.${method}`,
89
+ patchType: `${patchType}-discovery`,
90
+ around(next, data) {
91
+ if (methodScope.getStore()) return next();
92
+ return methodScope.run({ method, args: data.args, type: 'router' }, next);
139
93
  }
140
- }
141
- }
142
- });
143
- }
94
+ });
95
+ });
144
96
 
145
- return core.routeCoverage.express5 = {
146
- install() {
147
- depHooks.resolve({ name: 'express', version: '5' }, (express) => {
148
- METHODS.forEach((method) => {
149
- patcher.patch(express.application, method, {
150
- name: `express.application.${method}`,
151
- patchType,
152
- pre(data) {
153
- const [path, ...args] = data.args;
154
- if ((!isString(path) && !Array.isArray(path)) || path === '') return;
97
+ // app[method] and router[method] end up calling this
98
+ // Append metadata to the created Route object at layer.route.
99
+ // we also patch the returned Route's methods for building signatures
100
+ core.patcher.patch(express.Router.prototype, 'route', {
101
+ name: 'express.Route',
102
+ patchType: `${patchType}-discovery`,
103
+ post(data) {
104
+ const { result } = data;
105
+ const methodStore = methodScope.getStore();
106
+ const meta = {
107
+ paths: ExpressInstrumentation.normalizePaths(data.args[0]),
108
+ method: methodStore?.method,
109
+ type: methodStore?.type || 'route',
110
+ };
155
111
 
156
- const fns = args.flat(Infinity);
157
- for (let i = 0; i < fns.length; i++) {
158
- if (typeof fns[i] !== 'function') continue;
159
- const routeInfo = createRouteInfo(path, method, 'app', fns[i]);
112
+ Object.defineProperty(result, kMetaKey, {
113
+ enumerable,
114
+ value: meta
115
+ });
160
116
 
161
- discover(routeInfo);
162
- fns[i] = wrapForObservation(fns[i], routeInfo);
163
- }
164
- data.args.splice(1, fns.length, ...fns);
117
+ // patch route instance methods we do that here when we have
118
+ // todo move to prototype to help w/ memory
119
+ METHODS.forEach((method) => {
120
+ if (result[method]) {
121
+ core.patcher.patch(result, method, {
122
+ name: `express.Router.prototype.route${method}`,
123
+ patchType: `${patchType}-discovery`,
124
+ pre(data) {
125
+ data._stackIdx = data.obj.stack?.length;
126
+ },
127
+ post(data) {
128
+ if (data.obj.stack?.length > data._stackIdx) {
129
+ for (let i = data._stackIdx; i < data.obj.stack.length; i++) {
130
+ const layer = data.obj.stack[i];
131
+ const methodStore = methodScope.getStore();
132
+ const meta = {
133
+ type: methodStore?.type || 'route',
134
+ method: methodStore?.method == 'all' ? 'all' : method,
135
+ };
136
+
137
+ Object.defineProperty(layer, kMetaKey, {
138
+ enumerable,
139
+ value: meta,
140
+ });
141
+ }
142
+ }
143
+ },
144
+ });
165
145
  }
166
146
  });
167
147
 
168
- patcher.patch(express.Router.prototype, method, {
169
- name: `express.Router.prototype.${method}`,
170
- patchType,
171
- pre(data) {
172
- const Router = data.obj;
173
- const [path, ...args] = data.args;
174
- if (!isString(path) && !Array.isArray(path)) return;
175
-
176
- const fns = args.flat(Infinity);
177
- const routes = routerMap.get(Router) || [];
178
- for (let i = 0; i < fns.length; i++) {
179
- if (typeof fns[i] !== 'function') continue;
180
- const routeInfo = createRouteInfo(path, method, 'router', fns[i]);
148
+ return result;
149
+ },
150
+ });
181
151
 
182
- fns[i] = wrapForObservation(fns[i], routeInfo, true);
152
+ core.patcher.patch(express.Router.prototype, 'use', {
153
+ name: `${name}.Router.prototype.use`,
154
+ patchType: `${patchType}-discovery`,
155
+ pre(data) {
156
+ data._stackLength = data.obj.stack?.length;
157
+ },
158
+ post(data) {
159
+ if (data.obj.stack.length > data._stackLength) {
160
+ for (let i = data._stackLength; i < data.obj.stack.length; i++) {
161
+ const layer = data.obj.stack[i];
162
+ const paths = ExpressInstrumentation.normalizePaths(data.args[0]);
163
+ const methodStore = methodScope.getStore();
164
+ const meta = {
165
+ paths,
166
+ method: 'use',
167
+ type: methodStore?.type || 'router',
168
+ };
183
169
 
184
- routes.push(routeInfo);
185
- data.args.splice(1, fns.length, ...fns);
170
+ if (layer) {
171
+ Object.defineProperty(layer, kMetaKey, {
172
+ enumerable: false,
173
+ value: meta
174
+ });
186
175
  }
187
- routerMap.set(Router, routes);
188
176
  }
177
+ }
178
+ },
179
+ });
180
+
181
+ return core.patcher.patch(express, {
182
+ name: 'express-5.application',
183
+ patchType: `${patchType}-discovery`,
184
+ post(data) {
185
+ const app = data.result;
186
+ core.messages.on(Event.SERVER_LISTENING, () => {
187
+ if (!app.router.stack[0]) {
188
+ core.logger.debug('no routes detected in express router stack');
189
+ return;
190
+ }
191
+ self.handleDiscovery(app);
189
192
  });
190
- });
193
+ return app;
194
+ }
195
+ });
196
+ });
191
197
 
192
- let appRouter;
193
- patcher.patch(express.application, 'use', {
194
- name: 'express.application.use',
195
- patchType,
196
- pre(data) {
197
- appRouter = data.obj.router;
198
-
199
- const arg0 = data.args[0];
200
- const prefix = (Array.isArray(arg0) || isString(arg0)) ? arg0 : undefined;
201
- const args = prefix ? ArrayPrototypeSlice.call(data.args, 1) : data.args;
202
- const fns = args.flat(Infinity);
203
- for (let i = 0; i < fns.length; i++) {
204
- if (isRouter(fns[i])) {
205
- let routes = routerMap.get(fns[i]);
206
- if (routes) {
207
- if (prefix) routes = routes.map(route => updateRouteInfo(prefix, route));
208
- routes.forEach((route) => discover(route));
198
+ core.depHooks.resolve({ name: 'express', version: '5' }, (express) => {
199
+ core.patcher.patch(express.application, 'handle', {
200
+ name: 'express.application.handle',
201
+ patchType: `${patchType}-discovery`,
202
+ around(next, data) {
203
+ // wrap request handling in "handle scope". the scope's store data
204
+ // helps for building observation templates as routing occurs
205
+ const store = {
206
+ matchIdx: -1,
207
+ templateSegments: [],
208
+ };
209
+ return handleScope.run(store, next);
210
+ }
211
+ });
212
+ });
213
+
214
+ //
215
+ // observation instrumentation
216
+ //
217
+
218
+ // when Layer.match gets called, matchers functions run underneath. the API doesn't present a really clean
219
+ // way to instrument, so we're using scopes. we reference the scope's store in the instrumented matcher
220
+ // functions so we can correlate a matcher that succeeds to its corresponding route template segment.
221
+ core.depHooks.resolve({ name: 'router', file: 'lib/layer.js', version: '2' }, (Layer) => {
222
+ core.patcher.patch(Layer.prototype, 'match', {
223
+ name: 'Layer.prototype.match',
224
+ patchType: `${patchType}-observation`,
225
+ pre(data) {
226
+ data._store = handleScope.getStore();
227
+ if (!data._store) return;
228
+
229
+ // we check in post hook whether any matcher instrumentation reset this in scope.
230
+ // matchers will set this to a number only if multiple matchers run and one succeeds.
231
+ // use the index of that matcher to get associated template segment from the metadata.
232
+ data._store.matcherIdx = null;
233
+ // save reference to metadata source
234
+ data[kMetaKey] = data.obj[kMetaKey] || data.obj.route?.[kMetaKey];
235
+ },
236
+ post(data) {
237
+ // whenever a layer matches, save the corresponding
238
+ // template segment metadata in the handle scope store
239
+ const { result } = data;
240
+ if (!result || !data._store || !data[kMetaKey]?.paths) return;
241
+
242
+ let template;
243
+ if (data._store.matcherIdx != null) {
244
+ template = data[kMetaKey].paths[data._store.matcherIdx];
245
+ } else {
246
+ template = data[kMetaKey].paths[0];
247
+ }
248
+
249
+ // if the layer matches, we know to push corresponding path to store's template segments.
250
+ // we pop this value from the array in hook to all `next` callbacks below.
251
+ data._store.templateSegments.push(template);
252
+ }
253
+ });
254
+
255
+ // patch the `next` callback of every Layer's request handler.
256
+ // we pop the value from the stack of route template segments being managed.
257
+ core.patcher.patch(Layer.prototype, 'handleRequest', {
258
+ name: 'Layer.prototype.handleRequest',
259
+ patchType: `${patchType}-observation`,
260
+ pre(data) {
261
+ const next = data.args[2];
262
+ const meta = data.obj[kMetaKey] || data.obj.route?.[kMetaKey];
263
+ if (meta?.paths) {
264
+ const store = handleScope.getStore();
265
+ // this runs often and there's no need to use patcher here. monkey patch directly to optimize
266
+ data.args[2] = function(...args) {
267
+ if (store) store.templateSegments.pop();
268
+ const ret = next(...args);
269
+ return ret;
270
+ };
271
+ }
272
+ }
273
+ });
274
+
275
+ // instrument the Layer constructor. this will allow us to patch
276
+ // created matchers to help us build observation template from metadata.
277
+ // if matcher was successful we store index of it in handle scope.
278
+ return core.patcher.patch(Layer, {
279
+ name: 'router.Layer',
280
+ patchType: `${patchType}-observation`,
281
+ pre(data) {
282
+ data._methodScope = methodScope.getStore();
283
+ },
284
+ post(data) {
285
+ const instance = data.result;
286
+ // only instrument matchers if the Layer is being instantiated within method scope, and
287
+ // if there are multiple matchers and we need the index to correlate to tempate segment
288
+ if (data._methodScope && instance.matchers.length > 1) {
289
+ for (let i = 0; i < instance.matchers.length; i++) {
290
+ const matcher = instance.matchers[i];
291
+ instance.matchers[i] = function(...args) {
292
+ const result = matcher.apply(this, args);
293
+ if (result) {
294
+ const store = handleScope.getStore();
295
+ if (store) store.matcherIdx = i;
209
296
  }
210
- } else if (prefix && typeof fns[i] === 'function') {
211
- const routeInfo = createRouteInfo(prefix, 'use', 'app', fns[i]);
212
- discover(routeInfo);
213
- fns[i] = wrapForObservation(fns[i], routeInfo);
214
- }
297
+ return result;
298
+ };
215
299
  }
216
- data.args.splice(prefix ? 1 : 0, fns.length, ...fns);
217
300
  }
218
- });
219
- patcher.patch(express.Router.prototype, 'use', {
220
- name: 'express.Router.prototype.use',
221
- patchType,
222
- pre(data) {
223
- const Router = data.obj;
224
- const isAppRouter = Router === appRouter;
225
- if (isAppRouter) return;
226
-
227
- let routerRoutes = routerMap.get(Router) || [];
228
-
229
- const arg0 = data.args[0];
230
- let prefix = (Array.isArray(arg0) || isString(arg0)) ? arg0 : undefined;
231
- const args = prefix ? ArrayPrototypeSlice.call(data.args, 1) : data.args;
232
- const fns = args.flat(Infinity);
233
-
234
- for (let i = 0; i < fns.length; i++) {
235
- const selfNested = fns[i] === Router;
236
- if (isRouter(fns[i])) {
237
- let routes = routerMap.get(fns[i]) || [];
238
- if (prefix) {
239
- if (selfNested) prefix = StringPrototypeReplace.call(prefix, '/', '/*');
240
- routes = routes.map(route => updateRouteInfo(prefix, route));
301
+ // patch handle to report observation when called. it checks handle
302
+ // scope to get current request's template to match with discovery info
303
+ core.patcher.patch(instance, 'handle', {
304
+ name: 'router.Layer.handle',
305
+ patchType: `${patchType}-observation`,
306
+ pre(data) {
307
+ if (instance[kMetaKey]?.observables) {
308
+ const store = handleScope.getStore();
309
+ if (store) {
310
+ const method = StringPrototypeToLowerCase.call(data.args[0].method || '');
311
+ const template = ArrayPrototypeJoin.call(store.templateSegments, '') || '/';
312
+
313
+ if (instance[kMetaKey]?.observables?.[template]) {
314
+ self.observe({
315
+ url: data.args[0].originalUrl,
316
+ normalizedUrl: template,
317
+ method,
318
+ signature: instance[kMetaKey].observables[template],
319
+ });
320
+ } else {
321
+ core.logger.error({
322
+ // url: data.args[0].originalUrl, // this would need masking to log
323
+ method,
324
+ template,
325
+ observables: instance[kMetaKey]?.observables,
326
+ }, 'unable to map route template to signature');
327
+ }
241
328
  }
242
- routerRoutes = selfNested ? routes : routerRoutes.concat(routes);
243
- } else if (prefix && typeof fns[i] === 'function') {
244
- const routeInfo = createRouteInfo(prefix, 'use', 'router', fns[i]);
245
- routerRoutes.push(routeInfo);
246
- fns[i] = wrapForObservation(fns[i], routeInfo);
247
329
  }
330
+ },
331
+ });
332
+ },
333
+ });
334
+ });
335
+ }
336
+
337
+ discover(info) {
338
+ const { method, observables } = info;
339
+ if (!method || !observables) return;
340
+
341
+ for (const [normalizedUrl, signature] of Object.entries(observables)) {
342
+ this.core.routeCoverage.discover({
343
+ url: normalizedUrl,
344
+ normalizedUrl,
345
+ method,
346
+ signature,
347
+ framework: 'express',
348
+ });
349
+ }
350
+ }
351
+
352
+ observe(info) {
353
+ this.core.routeCoverage.observe({ framework: 'express', ...info });
354
+ }
355
+
356
+ /**
357
+ * Traverse the application's router "stack" and generate route discovery events
358
+ * using layer/route metadata that was appended by methods like router.post().
359
+ * @param {object} app express instance
360
+ */
361
+ handleDiscovery(app) {
362
+ const self = this;
363
+ const router = app.router || app._router;
364
+
365
+ // traverse fn executes this callback when visiting Layer instances
366
+ this.traverse(router, (path, key, value, target, state) => {
367
+ if (value.stack?.length > 0 || value.route) return;
368
+
369
+ // get metadata for this Layer
370
+ // metadata is on Layers within stacks and on Routes instances.
371
+ const metas = [];
372
+ for (let i = 0; i < path.length; i++) {
373
+ const seg = path[i];
374
+ if (Number.isFinite((Number(seg))) || seg == 'route') {
375
+ const metaPath = ArrayPrototypeJoin.call(path.slice(0, i + 1), '.');
376
+ const layerOrRoute = get(router, metaPath);
377
+ if (layerOrRoute?.[kMetaKey]) {
378
+ metas.push(layerOrRoute[kMetaKey]);
379
+ }
380
+ }
381
+ }
382
+
383
+ // mounted routers aren't discoverable since they themselves don't
384
+ // represent routes, they dispatch to sub routers/route handlers.
385
+ if (value.name != 'router' && value.handle?.name != 'router') {
386
+ // `value` is a terminal Layer with observable signatures.
387
+ // emit discovery after appending metadata.
388
+ if (value[kMetaKey]) {
389
+ if (!value[kMetaKey].observables) {
390
+ value[kMetaKey].observables = {};
391
+ }
392
+ Object.assign(value[kMetaKey].observables, this.generateObservables(metas, value.handle));
393
+ self.discover(value[kMetaKey]);
394
+ }
395
+ }
396
+ });
397
+ }
398
+
399
+ /**
400
+ * Traverses the top-level app's routing stack and executes the provided callback when
401
+ * visiting nodes. The callback is invoked only to visit Layer instances, objects and
402
+ * functions, since these are the only 2 types that could have our metadata attached.
403
+ */
404
+ traverse(target, cb, path = [], data = new Map()) {
405
+ loopKeys: for (const key in target) {
406
+ path.push(key);
407
+
408
+ // only visit Layer instances
409
+ const maybeLayer = target[key];
410
+ if (
411
+ maybeLayer?.constructor?.name == 'Layer' &&
412
+ !maybeLayer?.stack?.length
413
+ ) {
414
+ //
415
+ let _data = data.get(maybeLayer);
416
+ if (!_data) {
417
+ _data = { path: [...path] };
418
+ data.set(maybeLayer, _data);
419
+ }
420
+
421
+ // you can mount a router on itself
422
+ // prevent infinitely recursing into self-mounted routers
423
+ if (path.length > _data.path.length) {
424
+ let isNested = true;
425
+ loopPaths: for (let idx = 0; idx < _data.path.length; idx++) {
426
+ if (path[idx] != _data.path[idx]) {
427
+ isNested = false;
428
+ break loopPaths;
248
429
  }
249
- routerMap.set(Router, routerRoutes);
250
- data.args.splice(prefix ? 1 : 0, fns.length, ...fns);
251
430
  }
252
- });
253
- });
431
+ if (isNested) {
432
+ // todo: we don't support recursive router discovery/observation case atm
433
+ // stop to avoid infinite traversal
434
+ path.pop();
435
+ continue loopKeys;
436
+ }
437
+ }
438
+
439
+ const halt = cb(path, key, maybeLayer, target) === false;
440
+ if (halt) return;
441
+ }
442
+
443
+ // might be able to fine-tune this a bit more
444
+ if (typeof maybeLayer == 'object' || typeof maybeLayer == 'function') {
445
+ this.traverse(maybeLayer, cb, path, data);
446
+ }
447
+
448
+ path.pop();
254
449
  }
255
- };
256
- };
450
+ }
451
+
452
+ generateObservables(metas, handler) {
453
+ const { core } = this;
454
+ handler = core.patcher.unwrap(handler);
455
+
456
+ let type = '';
457
+ let method = '';
458
+ let templates = [];
459
+ const info = funcInfo(handler);
460
+
461
+ // ignore 3rd-party mw/handlers
462
+ if (info.file?.includes?.('node_modules')) {
463
+ return null;
464
+ }
465
+
466
+ let file = info.file ?
467
+ StringPrototypeReplace.call(info.file, core.appInfo.app_dir, '') :
468
+ '';
469
+ if (file.length > 30) {
470
+ file = `...${StringPrototypeSubstring.call(file, file.length - 40)}`;
471
+ }
472
+ const handlerName = info.method || handler.name || 'anonymous';
473
+ const formattedHandler = (file && Number.isFinite(info.lineNumber) && Number.isFinite(info.column)) ?
474
+ `[${handlerName} ${file} ${info.lineNumber}:${info.column}]` :
475
+ `[Function: ${handlerName}]`; // what util.inspect(handler) would return
476
+
477
+ // loop backwards
478
+ for (let i = metas.length - 1; i >= 0; i--) {
479
+ const meta = metas[i];
480
+ // use the most recent `type` and `method` used when building routes, so don't overwrite if set
481
+ if (!type && meta.type) type = meta.type;
482
+ if (!method && meta.method) method = meta.method;
483
+
484
+ // builds out all possible template combinations that the Layer is able to handle during routing
485
+ if (Array.isArray(meta.paths)) {
486
+ if (!templates.length) {
487
+ templates = [...meta.paths];
488
+ } else {
489
+ const _t = [];
490
+ for (const templateSegment of meta.paths) {
491
+ for (const templateAcc of templates) {
492
+ _t.push(`${templateSegment}${templateAcc}`);
493
+ }
494
+ }
495
+ templates = [..._t];
496
+ }
497
+ }
498
+ }
499
+
500
+ // build signature lookup based on each template (normalizeUri)
501
+ const map = templates.reduce((acc, routeTemplate) => {
502
+ if (!routeTemplate) routeTemplate = '/';
503
+ if (routeTemplate?.includes?.('typecheck')) {
504
+ // console.dir({ info, template });
505
+ }
506
+ acc[routeTemplate] = `${type}.${method}('${routeTemplate}', ${formattedHandler})`;
507
+ return acc;
508
+ }, {});
509
+
510
+ return map;
511
+ }
512
+
513
+ static normalizePathSegment(value) {
514
+ if (!value || value == '/') {
515
+ // app.[method](handler) and app.[method]('/', handler) are the same so default to empty string
516
+ return '';
517
+ }
518
+ if (value instanceof RegExp) {
519
+ const rxString = value.toString();
520
+ // todo: figure out best way to represent regexp in route template
521
+ return `/[${StringPrototypeSubstring.call(rxString, 1, rxString.length - 1)}]`;
522
+ }
523
+ return value;
524
+ }
525
+
526
+ static normalizePaths(paths) {
527
+ const ret = [];
528
+
529
+ // same as mounting as /
530
+ if (typeof paths == 'function') {
531
+ // default to ''
532
+ ret.push('');
533
+ } else if (isString(paths)) {
534
+ ret.push(ExpressInstrumentation.normalizePathSegment(paths));
535
+ } else if (Array.isArray(paths)) {
536
+ paths = paths.flat(Infinity).filter((v) => typeof v !== 'function');
537
+ if (paths.length) ret.push(...paths.map(ExpressInstrumentation.normalizePathSegment));
538
+ else ret.push('');
539
+ } else if (paths instanceof RegExp) {
540
+ ret.push(ExpressInstrumentation.normalizePathSegment(paths));
541
+ }
542
+
543
+ return ret;
544
+ }
545
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contrast/route-coverage",
3
- "version": "1.45.1",
3
+ "version": "1.45.2",
4
4
  "description": "Handles route discovery and observation",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -20,14 +20,14 @@
20
20
  "test": "bash ../scripts/test.sh"
21
21
  },
22
22
  "dependencies": {
23
- "@contrast/common": "1.34.1",
24
- "@contrast/config": "1.49.1",
25
- "@contrast/dep-hooks": "1.23.1",
23
+ "@contrast/common": "1.34.2",
24
+ "@contrast/config": "1.49.2",
25
+ "@contrast/core": "1.54.2",
26
+ "@contrast/dep-hooks": "1.23.2",
26
27
  "@contrast/fn-inspect": "^4.3.0",
27
- "@contrast/logger": "1.27.1",
28
- "@contrast/patcher": "1.26.1",
29
- "@contrast/scopes": "1.24.1",
30
- "semver": "^7.6.0",
31
- "path-to-regexp": "^8.2.0"
28
+ "@contrast/logger": "1.27.2",
29
+ "@contrast/patcher": "1.26.2",
30
+ "@contrast/scopes": "1.24.2",
31
+ "semver": "^7.6.0"
32
32
  }
33
33
  }
@@ -1,44 +0,0 @@
1
- /*
2
- * Copyright: 2025 Contrast Security, Inc
3
- * Contact: support@contrastsecurity.com
4
- * License: Commercial
5
-
6
- * NOTICE: This Software and the patented inventions embodied within may only be
7
- * used as part of Contrast Security’s commercial offerings. Even though it is
8
- * made available through public repositories, use of this Software is subject to
9
- * the applicable End User Licensing Agreement found at
10
- * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
11
- * between Contrast Security and the End User. The Software may not be reverse
12
- * engineered, modified, repackaged, sold, redistributed or otherwise used in a
13
- * way not consistent with the End User License Agreement.
14
- */
15
- 'use strict';
16
-
17
- module.exports = function init(core) {
18
- const { depHooks, patcher, routeCoverage } = core;
19
-
20
- let handled;
21
-
22
- return core.routeCoverage.http = {
23
- install() {
24
- [['http', '*'], ['https', '*'], ['spdy', '<5']].forEach(([name, version]) => {
25
- depHooks.resolve({ name, version }, (_export) => {
26
- if (!_export?.Server?.prototype) return;
27
-
28
- patcher.patch(_export.Server.prototype, 'listen', {
29
- name: `${name}.Server.prototype.listen`,
30
- patchType: 'route-coverage',
31
- post(data) {
32
- data.result?.on('listening', () => {
33
- if (!handled) {
34
- handled = true;
35
- routeCoverage.discoveryFinished();
36
- }
37
- });
38
- }
39
- });
40
- });
41
- });
42
- }
43
- };
44
- };