From 5e0d2c9749a28a20e0d25aef9fcc73f182a93e5a Mon Sep 17 00:00:00 2001 From: Valentin Marchaud Date: Thu, 20 Feb 2020 15:14:57 +0100 Subject: [PATCH] feat: add express plugin #666 (#685) * feat: add express plugin #666 * feat: set http.route attribute on http server span if possible * feat: add config to ignore express layers * chore: add documentation about express layer store --- .circleci/config.yml | 1 + README.md | 2 + .../opentelemetry-plugin-express/.npmignore | 4 + packages/opentelemetry-plugin-express/LICENSE | 201 ++++++++++++++++ .../opentelemetry-plugin-express/README.md | 76 ++++++ .../opentelemetry-plugin-express/package.json | 67 ++++++ .../src/express.ts | 220 ++++++++++++++++++ .../opentelemetry-plugin-express/src/index.ts | 17 ++ .../opentelemetry-plugin-express/src/types.ts | 94 ++++++++ .../opentelemetry-plugin-express/src/utils.ts | 156 +++++++++++++ .../src/version.ts | 18 ++ .../test/express.test.ts | 206 ++++++++++++++++ .../test/utils.test.ts | 147 ++++++++++++ .../tsconfig.json | 11 + .../opentelemetry-plugin-express/tslint.json | 4 + .../opentelemetry-plugin-http/src/http.ts | 1 + .../opentelemetry-plugin-http/src/utils.ts | 19 +- .../test/functionals/utils.test.ts | 23 ++ 18 files changed, 1266 insertions(+), 1 deletion(-) create mode 100644 packages/opentelemetry-plugin-express/.npmignore create mode 100644 packages/opentelemetry-plugin-express/LICENSE create mode 100644 packages/opentelemetry-plugin-express/README.md create mode 100644 packages/opentelemetry-plugin-express/package.json create mode 100644 packages/opentelemetry-plugin-express/src/express.ts create mode 100644 packages/opentelemetry-plugin-express/src/index.ts create mode 100644 packages/opentelemetry-plugin-express/src/types.ts create mode 100644 packages/opentelemetry-plugin-express/src/utils.ts create mode 100644 packages/opentelemetry-plugin-express/src/version.ts create mode 100644 packages/opentelemetry-plugin-express/test/express.test.ts create mode 100644 packages/opentelemetry-plugin-express/test/utils.test.ts create mode 100644 packages/opentelemetry-plugin-express/tsconfig.json create mode 100644 packages/opentelemetry-plugin-express/tslint.json diff --git a/.circleci/config.yml b/.circleci/config.yml index 2238b899fa..ce44fcb692 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -75,6 +75,7 @@ cache_2: &cache_2 - packages/opentelemetry-exporter-collector/node_modules - packages/opentelemetry-plugin-xml-http-request/node_modules - packages/opentelemetry-exporter-stackdriver-trace/node_modules + - packages/opentelemetry-plugin-express/node_modules node_unit_tests: &node_unit_tests resource_class: large diff --git a/README.md b/README.md index 6f938c90f8..5c7e9b787a 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,7 @@ OpenTelemetry can collect tracing data automatically using plugins. Vendors/User - [@opentelemetry/plugin-redis][otel-plugin-redis] - [@opentelemetry/plugin-ioredis][otel-plugin-ioredis] - [@opentelemetry/plugin-dns][otel-plugin-dns] - By default, this plugin is not loaded [#612](https://github.com/open-telemetry/opentelemetry-js/issues/612) +- [@opentelemetry/plugin-express][otel-plugin-express] - By default, this plugin is not loaded #### Web Plugins - [@opentelemetry/plugin-document-load][otel-plugin-document-load] @@ -194,6 +195,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [otel-plugin-redis]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-redis [otel-plugin-user-interaction]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-user-interaction [otel-plugin-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-xml-http-request +[otel-plugin-express]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-express [otel-shim-opentracing]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-shim-opentracing [otel-tracing]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing [otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-web diff --git a/packages/opentelemetry-plugin-express/.npmignore b/packages/opentelemetry-plugin-express/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/packages/opentelemetry-plugin-express/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/packages/opentelemetry-plugin-express/LICENSE b/packages/opentelemetry-plugin-express/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/packages/opentelemetry-plugin-express/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/opentelemetry-plugin-express/README.md b/packages/opentelemetry-plugin-express/README.md new file mode 100644 index 0000000000..d5e4ae220c --- /dev/null +++ b/packages/opentelemetry-plugin-express/README.md @@ -0,0 +1,76 @@ +# OpenTelemetry Express Instrumentation for Node.js +[![Gitter chat][gitter-image]][gitter-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for [`express`](https://github.com/expressjs/express). + +For automatic instrumentation see the +[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package. + +## Installation + +```bash +npm install --save @opentelemetry/plugin-express +``` +### Supported Versions + - `^4.0.0` + +## Usage + +OpenTelemetry Express Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems. + +To load a specific plugin (express in this case), specify it in the Node Tracer's configuration. +```js +const { NodeTracerProvider } = require('@opentelemetry/node'); + +const provider = new NodeTracerProvider({ + plugins: { + express: { + enabled: true, + // You may use a package name or absolute path to the file. + path: '@opentelemetry/plugin-express', + } + } +}); +``` + +To load all the [supported plugins](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules. +```js +const { NodeTracerProvider } = require('@opentelemetry/node'); + +const provider = new NodeTracerProvider(); +``` + +### Express Plugin Options + +Express plugin has few options available to choose from. You can set the following: + +| Options | Type | Description | +| ------- | ---- | ----------- | +| `ignoreLayers` | `IgnoreMatcher[]` | Express plugin will not trace all layers that match. | +| `ignoreLayersType`| `ExpressLayerType[]` | Express plugin will ignore the layers that match based on their type. | + +For reference, here are the three different layer type: + - `router` is the name of `express.Router()` + - `middleware` + - `request_handler` is the name for anything thats not a router or a middleware. + +## Useful links +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us on [gitter][gitter-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg +[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-plugin-express +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-express +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-plugin-express +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-express&type=dev diff --git a/packages/opentelemetry-plugin-express/package.json b/packages/opentelemetry-plugin-express/package.json new file mode 100644 index 0000000000..9358a48c2a --- /dev/null +++ b/packages/opentelemetry-plugin-express/package.json @@ -0,0 +1,67 @@ +{ + "name": "@opentelemetry/plugin-express", + "version": "0.4.0", + "description": "OpenTelemetry express automatic instrumentation package.", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "tdd": "yarn test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "check": "gts check", + "precompile": "tsc --version", + "version:update": "node ../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p .", + "fix": "gts fix", + "prepare": "npm run compile" + }, + "keywords": [ + "opentelemetry", + "express", + "nodejs", + "tracing", + "profiling", + "plugin" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.0.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/node": "^0.4.0", + "@opentelemetry/tracing": "^0.4.0", + "@types/express": "^4.17.2", + "@types/mocha": "^5.2.7", + "@types/node": "^12.7.2", + "@types/shimmer": "^1.0.1", + "codecov": "^3.6.1", + "express": "^4.17.1", + "gts": "^1.1.0", + "mocha": "^6.2.0", + "nyc": "^14.1.1", + "rimraf": "^3.0.0", + "ts-mocha": "^6.0.0", + "ts-node": "^8.3.0", + "tslint-consistent-codestyle": "^1.16.0", + "tslint-microsoft-contrib": "^6.2.0", + "typescript": "3.7.2" + }, + "dependencies": { + "@opentelemetry/core": "^0.4.0", + "@opentelemetry/api": "^0.4.0", + "shimmer": "^1.2.1" + } +} diff --git a/packages/opentelemetry-plugin-express/src/express.ts b/packages/opentelemetry-plugin-express/src/express.ts new file mode 100644 index 0000000000..6186b03696 --- /dev/null +++ b/packages/opentelemetry-plugin-express/src/express.ts @@ -0,0 +1,220 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { BasePlugin } from '@opentelemetry/core'; +import { Attributes } from '@opentelemetry/api'; +import * as express from 'express'; +import * as core from 'express-serve-static-core'; +import * as shimmer from 'shimmer'; +import { + ExpressLayer, + ExpressRouter, + AttributeNames, + PatchedRequest, + Parameters, + PathParams, + _LAYERS_STORE_PROPERTY, + ExpressPluginConfig, + ExpressLayerType, +} from './types'; +import { + getLayerMetadata, + storeLayerPath, + patchEnd, + isLayerIgnored, +} from './utils'; +import { VERSION } from './version'; + +/** + * This symbol is used to mark express layer as being already instrumented + * since its possible to use a given layer multiple times (ex: middlewares) + */ +export const kLayerPatched: unique symbol = Symbol('express-layer-patched'); + +/** Express instrumentation plugin for OpenTelemetry */ +export class ExpressPlugin extends BasePlugin { + static readonly component = 'express'; + readonly supportedVersions = ['^4.0.0']; + protected _config!: ExpressPluginConfig; + + constructor(readonly moduleName: string) { + super('@opentelemetry/plugin-express', VERSION); + } + + /** + * Patches Express operations. + */ + protected patch() { + this._logger.debug('Patching Express'); + + if (this._moduleExports === undefined || this._moduleExports === null) { + return this._moduleExports; + } + const routerProto = (this._moduleExports + .Router as unknown) as express.Router; + + this._logger.debug('patching express.Router.prototype.route'); + shimmer.wrap(routerProto, 'route', this._getRoutePatch.bind(this)); + + this._logger.debug('patching express.Router.prototype.use'); + shimmer.wrap(routerProto, 'use', this._getRouterUsePatch.bind(this)); + + this._logger.debug('patching express.Application.use'); + shimmer.wrap( + this._moduleExports.application, + 'use', + this._getAppUsePatch.bind(this) + ); + + return this._moduleExports; + } + + /** Unpatches all Express patched functions. */ + unpatch(): void { + const routerProto = (this._moduleExports + .Router as unknown) as express.Router; + shimmer.unwrap(routerProto, 'use'); + shimmer.unwrap(routerProto, 'route'); + shimmer.unwrap(this._moduleExports.application, 'use'); + } + + /** + * Get the patch for Router.route function + * @param original + */ + private _getRoutePatch(original: (path: PathParams) => express.IRoute) { + const plugin = this; + return function route_trace( + this: ExpressRouter, + ...args: Parameters + ) { + const route = original.apply(this, args); + const layer = this.stack[this.stack.length - 1] as ExpressLayer; + plugin._applyPatch( + layer, + typeof args[0] === 'string' ? args[0] : undefined + ); + return route; + }; + } + + /** + * Get the patch for Router.use function + * @param original + */ + private _getRouterUsePatch( + original: express.IRouterHandler & + express.IRouterMatcher + ) { + const plugin = this; + return function use( + this: express.Application, + ...args: Parameters + ) { + const route = original.apply(this, args); + const layer = this.stack[this.stack.length - 1] as ExpressLayer; + plugin._applyPatch( + layer, + typeof args[0] === 'string' ? args[0] : undefined + ); + return route; + // tslint:disable-next-line:no-any + } as any; + } + + /** + * Get the patch for Application.use function + * @param original + */ + private _getAppUsePatch( + original: core.ApplicationRequestHandler + ) { + const plugin = this; + return function use( + this: { _router: ExpressRouter }, + ...args: Parameters + ) { + const route = original.apply(this, args); + const layer = this._router.stack[this._router.stack.length - 1]; + plugin._applyPatch( + layer, + typeof args[0] === 'string' ? args[0] : undefined + ); + return route; + // tslint:disable-next-line:no-any + } as any; + } + + /** Patch each express layer to create span and propagate scope */ + private _applyPatch(layer: ExpressLayer, layerPath?: string) { + const plugin = this; + if (layer[kLayerPatched] === true) return; + layer[kLayerPatched] = true; + this._logger.debug('patching express.Router.Layer.handle'); + shimmer.wrap(layer, 'handle', function(original: Function) { + if (original.length === 4) return original; + + return function( + this: ExpressLayer, + req: PatchedRequest, + res: express.Response, + next: express.NextFunction + ) { + storeLayerPath(req, layerPath); + const route = (req[_LAYERS_STORE_PROPERTY] as string[]).join(''); + const attributes: Attributes = { + [AttributeNames.COMPONENT]: ExpressPlugin.component, + [AttributeNames.HTTP_ROUTE]: route.length > 0 ? route : undefined, + }; + const metadata = getLayerMetadata(layer, layerPath); + const type = metadata.attributes[ + AttributeNames.EXPRESS_TYPE + ] as ExpressLayerType; + // verify against the config if the layer should be ignored + if (isLayerIgnored(metadata.name, type, plugin._config)) { + return original.apply(this, arguments); + } + const span = plugin._tracer.startSpan(metadata.name, { + parent: plugin._tracer.getCurrentSpan(), + attributes: Object.assign(attributes, metadata.attributes), + }); + // verify we have a callback + let callbackIdx = Array.from(arguments).findIndex( + arg => typeof arg === 'function' + ); + let callbackHasBeenCalled = false; + if (callbackIdx >= 0) { + arguments[callbackIdx] = function() { + callbackHasBeenCalled = true; + if (!(req.route && arguments[0] instanceof Error)) { + (req[_LAYERS_STORE_PROPERTY] as string[]).pop(); + } + return patchEnd(span, plugin._tracer.bind(next))(); + }; + } + const result = original.apply(this, arguments); + // if the layer return a response, the callback will never + // be called, so we need to manually close the span + if (callbackHasBeenCalled === false) { + span.end(); + } + return result; + }; + }); + } +} + +export const plugin = new ExpressPlugin(ExpressPlugin.component); diff --git a/packages/opentelemetry-plugin-express/src/index.ts b/packages/opentelemetry-plugin-express/src/index.ts new file mode 100644 index 0000000000..4ef7578680 --- /dev/null +++ b/packages/opentelemetry-plugin-express/src/index.ts @@ -0,0 +1,17 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export * from './express'; diff --git a/packages/opentelemetry-plugin-express/src/types.ts b/packages/opentelemetry-plugin-express/src/types.ts new file mode 100644 index 0000000000..af7a0bc06e --- /dev/null +++ b/packages/opentelemetry-plugin-express/src/types.ts @@ -0,0 +1,94 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { kLayerPatched } from './express'; +import { Request } from 'express'; +import { PluginConfig, Attributes } from '@opentelemetry/api'; + +/** + * This const define where on the `request` object the plugin will mount the + * current stack of express layer. + * + * It is necessary because express doesnt store the different layers + * (ie: middleware, router etc) that it called to get to the current layer. + * Given that, the only way to know the route of a given layer is to + * store the path of where each previous layer has been mounted. + * + * ex: bodyParser > auth middleware > /users router > get /:id + * in this case the stack would be: ["/users", "/:id"] + * + * ex2: bodyParser > /api router > /v1 router > /users router > get /:id + * stack: ["/api", "/v1", "/users", ":id"] + * + */ +export const _LAYERS_STORE_PROPERTY = '__ot_middlewares'; + +export type Parameters = T extends (...args: infer T) => any ? T : unknown[]; +export type PatchedRequest = { + [_LAYERS_STORE_PROPERTY]?: string[]; +} & Request; +export type PathParams = string | RegExp | Array; + +// https://github.com/expressjs/express/blob/master/lib/router/index.js#L53 +export type ExpressRouter = { + params: { [key: string]: string }; + _params: string[]; + caseSensitive: boolean; + mergeParams: boolean; + strict: boolean; + stack: ExpressLayer[]; +}; + +// https://github.com/expressjs/express/blob/master/lib/router/layer.js#L33 +export type ExpressLayer = { + handle: Function; + [kLayerPatched]?: boolean; + name: string; + params: { [key: string]: string }; + path: string; + regexp: RegExp; +}; + +export type LayerMetadata = { + attributes: Attributes; + name: string; +}; + +// https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md#databases-client-calls +export enum AttributeNames { + COMPONENT = 'component', + HTTP_ROUTE = 'http.route', + EXPRESS_TYPE = 'express.type', + EXPRESS_NAME = 'express.name', +} + +export enum ExpressLayerType { + ROUTER = 'router', + MIDDLEWARE = 'middleware', + REQUEST_HANDLER = 'request_handler', +} + +export type IgnoreMatcher = string | RegExp | ((name: string) => boolean); + +/** + * Options available for the Express Plugin (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-express#express-plugin-options)) + */ +export interface ExpressPluginConfig extends PluginConfig { + /** Ingore specific based on their name */ + ignoreLayers?: IgnoreMatcher[]; + /** Ignore specific layers based on their type */ + ignoreLayersType?: ExpressLayerType[]; +} diff --git a/packages/opentelemetry-plugin-express/src/utils.ts b/packages/opentelemetry-plugin-express/src/utils.ts new file mode 100644 index 0000000000..1ec8e348f9 --- /dev/null +++ b/packages/opentelemetry-plugin-express/src/utils.ts @@ -0,0 +1,156 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { CanonicalCode, Span, Attributes } from '@opentelemetry/api'; +import { + ExpressLayer, + AttributeNames, + PatchedRequest, + _LAYERS_STORE_PROPERTY, + ExpressLayerType, + IgnoreMatcher, + ExpressPluginConfig, +} from './types'; + +/** + * Store layers path in the request to be able to construct route later + * @param request The request where + * @param [value] the value to push into the array + */ +export const storeLayerPath = (request: PatchedRequest, value?: string) => { + if (Array.isArray(request[_LAYERS_STORE_PROPERTY]) === false) { + Object.defineProperty(request, _LAYERS_STORE_PROPERTY, { + enumerable: false, + value: [], + }); + } + if (value === undefined) return; + (request[_LAYERS_STORE_PROPERTY] as string[]).push(value); +}; + +/** + * Parse express layer context to retrieve a name and attributes. + * @param layer Express layer + * @param [layerPath] if present, the path on which the layer has been mounted + */ +export const getLayerMetadata = ( + layer: ExpressLayer, + layerPath?: string +): { + attributes: Attributes; + name: string; +} => { + if (layer.name === 'router') { + return { + attributes: { + [AttributeNames.EXPRESS_NAME]: layerPath, + [AttributeNames.EXPRESS_TYPE]: ExpressLayerType.ROUTER, + }, + name: `router - ${layerPath}`, + }; + } else if (layer.name === 'bound dispatch') { + return { + attributes: { + [AttributeNames.EXPRESS_NAME]: layerPath ?? 'request handler', + [AttributeNames.EXPRESS_TYPE]: ExpressLayerType.REQUEST_HANDLER, + }, + name: 'request handler', + }; + } else { + return { + attributes: { + [AttributeNames.EXPRESS_NAME]: layer.name, + [AttributeNames.EXPRESS_TYPE]: ExpressLayerType.MIDDLEWARE, + }, + name: `middleware - ${layer.name}`, + }; + } +}; + +/** + * Ends a created span. + * @param span The created span to end. + * @param resultHandler A callback function. + */ +export const patchEnd = (span: Span, resultHandler: Function): Function => { + return function patchedEnd(this: {}, ...args: unknown[]) { + const error = args[0]; + if (error instanceof Error) { + span.setStatus({ + code: CanonicalCode.INTERNAL, + message: error.message, + }); + } else { + span.setStatus({ + code: CanonicalCode.OK, + }); + } + span.end(); + return resultHandler.apply(this, args); + }; +}; + +/** + * Check whether the given obj match pattern + * @param constant e.g URL of request + * @param obj obj to inspect + * @param pattern Match pattern + */ +const satisfiesPattern = ( + constant: string, + pattern: IgnoreMatcher +): boolean => { + if (typeof pattern === 'string') { + return pattern === constant; + } else if (pattern instanceof RegExp) { + return pattern.test(constant); + } else if (typeof pattern === 'function') { + return pattern(constant); + } else { + throw new TypeError('Pattern is in unsupported datatype'); + } +}; + +/** + * Check whether the given request is ignored by configuration + * It will not re-throw exceptions from `list` provided by the client + * @param constant e.g URL of request + * @param [list] List of ignore patterns + * @param [onException] callback for doing something when an exception has + * occurred + */ +export const isLayerIgnored = ( + name: string, + type: ExpressLayerType, + config?: ExpressPluginConfig +): boolean => { + if ( + Array.isArray(config?.ignoreLayersType) && + config?.ignoreLayersType?.includes(type) + ) { + return true; + } + if (Array.isArray(config?.ignoreLayers) === false) return false; + try { + for (const pattern of config!.ignoreLayers!) { + if (satisfiesPattern(name, pattern)) { + return true; + } + } + } catch (e) {} + + return false; +}; diff --git a/packages/opentelemetry-plugin-express/src/version.ts b/packages/opentelemetry-plugin-express/src/version.ts new file mode 100644 index 0000000000..2efbb00dcb --- /dev/null +++ b/packages/opentelemetry-plugin-express/src/version.ts @@ -0,0 +1,18 @@ +/*! + * Copyright 2019, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.3.2'; diff --git a/packages/opentelemetry-plugin-express/test/express.test.ts b/packages/opentelemetry-plugin-express/test/express.test.ts new file mode 100644 index 0000000000..231663f1b9 --- /dev/null +++ b/packages/opentelemetry-plugin-express/test/express.test.ts @@ -0,0 +1,206 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { NodeTracerProvider } from '@opentelemetry/node'; +import * as assert from 'assert'; +import * as express from 'express'; +import * as http from 'http'; +import { AddressInfo } from 'net'; +import { plugin } from '../src'; +import { NoopLogger } from '@opentelemetry/core'; +import { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/tracing'; +import { + AttributeNames, + ExpressPluginConfig, + ExpressLayerType, +} from '../src/types'; + +const httpRequest = { + get: (options: http.ClientRequestArgs | string) => { + return new Promise((resolve, reject) => { + return http.get(options, resp => { + let data = ''; + resp.on('data', chunk => { + data += chunk; + }); + resp.on('end', () => { + resolve(data); + }); + resp.on('error', err => { + reject(err); + }); + }); + }); + }, +}; + +describe('Express Plugin', () => { + const logger = new NoopLogger(); + const provider = new NodeTracerProvider(); + const memoryExporter = new InMemorySpanExporter(); + const spanProcessor = new SimpleSpanProcessor(memoryExporter); + provider.addSpanProcessor(spanProcessor); + const tracer = provider.getTracer('default'); + + before(() => { + plugin.enable(express, provider, logger); + }); + + afterEach(() => { + memoryExporter.reset(); + }); + + describe('Instrumenting normal get operations', () => { + it('should create a child span for middlewares', done => { + const rootSpan = tracer.startSpan('rootSpan'); + const app = express(); + app.use(express.json()); + app.use(function customMiddleware(req, res, next) { + for (let i = 0; i < 1000; i++) { + continue; + } + return next(); + }); + const router = express.Router(); + app.use('/toto', router); + router.get('/:id', (req, res, next) => { + return res.status(200).end(); + }); + const server = http.createServer(app); + server.listen(0, () => { + const port = (server.address() as AddressInfo).port; + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + tracer.withSpan(rootSpan, async () => { + await httpRequest.get(`http://localhost:${port}/toto/tata`); + rootSpan.end(); + assert( + memoryExporter + .getFinishedSpans() + .find(span => span.name.includes('customMiddleware')) !== + undefined + ); + assert( + memoryExporter + .getFinishedSpans() + .find(span => span.name.includes('query')) !== undefined + ); + assert( + memoryExporter + .getFinishedSpans() + .find(span => span.name.includes('jsonParser')) !== undefined + ); + const requestHandlerSpan = memoryExporter + .getFinishedSpans() + .find(span => span.name.includes('request handler')); + assert(requestHandlerSpan !== undefined); + assert( + requestHandlerSpan?.attributes[AttributeNames.COMPONENT] === + 'express' + ); + assert( + requestHandlerSpan?.attributes[AttributeNames.HTTP_ROUTE] === + '/toto/:id' + ); + assert( + requestHandlerSpan?.attributes[AttributeNames.EXPRESS_TYPE] === + 'request_handler' + ); + let exportedRootSpan = memoryExporter + .getFinishedSpans() + .find(span => span.name === 'rootSpan'); + assert(exportedRootSpan !== undefined); + server.close(); + return done(); + }); + }); + }); + }); + + describe('Instrumenting with specific config', () => { + it('should ignore specific middlewares based on config', done => { + plugin.disable(); + const config: ExpressPluginConfig = { + ignoreLayersType: [ExpressLayerType.MIDDLEWARE], + }; + plugin.enable(express, provider, logger, config); + const rootSpan = tracer.startSpan('rootSpan'); + const app = express(); + app.use(express.json()); + app.use(function customMiddleware(req, res, next) { + for (let i = 0; i < 1000; i++) { + continue; + } + return next(); + }); + const server = http.createServer(app); + server.listen(0, () => { + const port = (server.address() as AddressInfo).port; + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + tracer.withSpan(rootSpan, async () => { + await httpRequest.get(`http://localhost:${port}/toto/tata`); + rootSpan.end(); + assert.deepEqual( + memoryExporter + .getFinishedSpans() + .filter( + span => + span.attributes[AttributeNames.EXPRESS_TYPE] === + ExpressLayerType.MIDDLEWARE + ).length, + 0 + ); + let exportedRootSpan = memoryExporter + .getFinishedSpans() + .find(span => span.name === 'rootSpan'); + assert(exportedRootSpan !== undefined); + server.close(); + return done(); + }); + }); + }); + }); + + describe('Disabling plugin', () => { + it('should not create new spans', done => { + plugin.disable(); + const rootSpan = tracer.startSpan('rootSpan'); + const app = express(); + app.use(express.json()); + app.use(function customMiddleware(req, res, next) { + for (let i = 0; i < 1000; i++) { + continue; + } + return next(); + }); + const server = http.createServer(app); + server.listen(0, () => { + const port = (server.address() as AddressInfo).port; + assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); + tracer.withSpan(rootSpan, async () => { + await httpRequest.get(`http://localhost:${port}/toto/tata`); + rootSpan.end(); + assert.deepEqual(memoryExporter.getFinishedSpans().length, 1); + assert(memoryExporter.getFinishedSpans()[0] !== undefined); + server.close(); + return done(); + }); + }); + }); + }); +}); diff --git a/packages/opentelemetry-plugin-express/test/utils.test.ts b/packages/opentelemetry-plugin-express/test/utils.test.ts new file mode 100644 index 0000000000..fcc5eed180 --- /dev/null +++ b/packages/opentelemetry-plugin-express/test/utils.test.ts @@ -0,0 +1,147 @@ +/*! + * Copyright 2020, OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as utils from '../src/utils'; +import * as assert from 'assert'; +import { + ExpressLayerType, + ExpressPluginConfig, + ExpressLayer, + AttributeNames, +} from '../src/types'; + +describe('Utils', () => { + describe('isLayerIgnored()', () => { + it('should not fail with invalid config', () => { + assert.doesNotThrow(() => + utils.isLayerIgnored('', ExpressLayerType.MIDDLEWARE) + ); + assert.doesNotThrow(() => + utils.isLayerIgnored( + '', + ExpressLayerType.MIDDLEWARE, + {} as ExpressPluginConfig + ) + ); + assert.doesNotThrow(() => + utils.isLayerIgnored('', ExpressLayerType.MIDDLEWARE, { + ignoreLayersType: {}, + } as ExpressPluginConfig) + ); + assert.doesNotThrow(() => + utils.isLayerIgnored('', ExpressLayerType.MIDDLEWARE, { + ignoreLayersType: {}, + ignoreLayers: {}, + } as ExpressPluginConfig) + ); + }); + + it('should ignore based on type', () => { + assert.deepEqual( + utils.isLayerIgnored('', ExpressLayerType.MIDDLEWARE, { + ignoreLayersType: [ExpressLayerType.MIDDLEWARE], + }), + true + ); + assert.deepEqual( + utils.isLayerIgnored('', ExpressLayerType.ROUTER, { + ignoreLayersType: [ExpressLayerType.MIDDLEWARE], + }), + false + ); + }); + + it('should ignore based on the name', () => { + assert.deepEqual( + utils.isLayerIgnored('bodyParser', ExpressLayerType.MIDDLEWARE, { + ignoreLayers: ['bodyParser'], + }), + true + ); + assert.deepEqual( + utils.isLayerIgnored('bodyParser', ExpressLayerType.MIDDLEWARE, { + ignoreLayers: [(name: string) => name === 'bodyParser'], + }), + true + ); + assert.deepEqual( + utils.isLayerIgnored('bodyParser', ExpressLayerType.MIDDLEWARE, { + ignoreLayers: [/bodyParser/], + }), + true + ); + assert.deepEqual( + utils.isLayerIgnored('test', ExpressLayerType.ROUTER, { + ignoreLayers: ['bodyParser'], + }), + false + ); + }); + }); + + describe('getLayerMetadata()', () => { + it('should return router metadata', () => { + assert.deepEqual( + utils.getLayerMetadata( + { + name: 'router', + } as ExpressLayer, + '/test' + ), + { + attributes: { + [AttributeNames.EXPRESS_NAME]: '/test', + [AttributeNames.EXPRESS_TYPE]: 'router', + }, + name: `router - /test`, + } + ); + }); + + it('should return request handler metadata', () => { + assert.deepEqual( + utils.getLayerMetadata( + { + name: 'bound dispatch', + } as ExpressLayer, + '/:id' + ), + { + attributes: { + [AttributeNames.EXPRESS_NAME]: '/:id', + [AttributeNames.EXPRESS_TYPE]: 'request_handler', + }, + name: 'request handler', + } + ); + }); + + it('should return middleware metadata', () => { + assert.deepEqual( + utils.getLayerMetadata({ + name: 'bodyParser', + } as ExpressLayer), + { + attributes: { + [AttributeNames.EXPRESS_NAME]: 'bodyParser', + [AttributeNames.EXPRESS_TYPE]: 'middleware', + }, + name: 'middleware - bodyParser', + } + ); + }); + }); +}); diff --git a/packages/opentelemetry-plugin-express/tsconfig.json b/packages/opentelemetry-plugin-express/tsconfig.json new file mode 100644 index 0000000000..a2042cd68b --- /dev/null +++ b/packages/opentelemetry-plugin-express/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/packages/opentelemetry-plugin-express/tslint.json b/packages/opentelemetry-plugin-express/tslint.json new file mode 100644 index 0000000000..0710b135d0 --- /dev/null +++ b/packages/opentelemetry-plugin-express/tslint.json @@ -0,0 +1,4 @@ +{ + "rulesDirectory": ["node_modules/tslint-microsoft-contrib"], + "extends": ["../../tslint.base.js", "./node_modules/tslint-consistent-codestyle"] +} diff --git a/packages/opentelemetry-plugin-http/src/http.ts b/packages/opentelemetry-plugin-http/src/http.ts index d11b4b0708..1107311305 100644 --- a/packages/opentelemetry-plugin-http/src/http.ts +++ b/packages/opentelemetry-plugin-http/src/http.ts @@ -336,6 +336,7 @@ export class HttpPlugin extends BasePlugin { ); const attributes = utils.getIncomingRequestAttributesOnResponse( + request, response ); diff --git a/packages/opentelemetry-plugin-http/src/utils.ts b/packages/opentelemetry-plugin-http/src/utils.ts index d9b4b94fc0..ce7cea9f65 100644 --- a/packages/opentelemetry-plugin-http/src/utils.ts +++ b/packages/opentelemetry-plugin-http/src/utils.ts @@ -443,12 +443,24 @@ export const getIncomingRequestAttributes = ( * @param {(ServerResponse & { socket: Socket; })} response the response object */ export const getIncomingRequestAttributesOnResponse = ( + request: IncomingMessage, response: ServerResponse & { socket: Socket } ): Attributes => { const { statusCode, statusMessage, socket } = response; const { localAddress, localPort, remoteAddress, remotePort } = socket; + const { __ot_middlewares } = (request as unknown) as { + [key: string]: unknown; + }; + const route = Array.isArray(__ot_middlewares) + ? __ot_middlewares + .filter(path => path !== '/') + .map(path => { + return path[0] === '/' ? path : '/' + path; + }) + .join('') + : undefined; - return { + const attributes: Attributes = { [AttributeNames.NET_HOST_IP]: localAddress, [AttributeNames.NET_HOST_PORT]: localPort, [AttributeNames.NET_PEER_IP]: remoteAddress, @@ -456,4 +468,9 @@ export const getIncomingRequestAttributesOnResponse = ( [AttributeNames.HTTP_STATUS_CODE]: statusCode, [AttributeNames.HTTP_STATUS_TEXT]: (statusMessage || '').toUpperCase(), }; + + if (route !== undefined) { + attributes[AttributeNames.HTTP_ROUTE] = route; + } + return attributes; }; diff --git a/packages/opentelemetry-plugin-http/test/functionals/utils.test.ts b/packages/opentelemetry-plugin-http/test/functionals/utils.test.ts index 32cca55d05..8bfb673fcf 100644 --- a/packages/opentelemetry-plugin-http/test/functionals/utils.test.ts +++ b/packages/opentelemetry-plugin-http/test/functionals/utils.test.ts @@ -317,4 +317,27 @@ describe('Utility', () => { }); } }); + + describe('getIncomingRequestAttributesOnResponse()', () => { + it('should correctly parse the middleware stack if present', () => { + const request = { + __ot_middlewares: ['/test', '/toto', '/'], + }; + // @ts-ignore ignore error about invalid request types since we only want to + // check the parsing of the `__ot_middlewares` property + const attributes = utils.getIncomingRequestAttributesOnResponse(request, { + socket: {}, + }); + assert.deepEqual(attributes[AttributeNames.HTTP_ROUTE], '/test/toto'); + }); + it('should succesfully process without middleware stack', () => { + const request = {}; + // @ts-ignore ignore error about invalid request types since we only want to + // check the parsing of the `__ot_middlewares` property + const attributes = utils.getIncomingRequestAttributesOnResponse(request, { + socket: {}, + }); + assert.deepEqual(attributes[AttributeNames.HTTP_ROUTE], undefined); + }); + }); });