diff --git a/.github/component_owners.yml b/.github/component_owners.yml index 1260ee8fc4..de29dcab29 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -38,6 +38,8 @@ components: - naseemkullah plugins/node/opentelemetry-instrumentation-knex: - rauno56 + plugins/node/opentelemetry-instrumentation-lru-memoizer: + - blumamir plugins/node/opentelemetry-instrumentation-memcached: - rauno56 plugins/node/opentelemetry-instrumentation-nestjs-core: diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md index 4fe4dcd039..37f850a03b 100644 --- a/metapackages/auto-instrumentations-node/README.md +++ b/metapackages/auto-instrumentations-node/README.md @@ -65,6 +65,7 @@ registerInstrumentations({ - [@opentelemetry/instrumentation-grpc](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-grpc) - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express) - [@opentelemetry/instrumentation-koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-koa) +- [@opentelemetry/instrumentation-lru-memoizer](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-lru-memoizer) - [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify) - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool) - [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql) diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json index e576d8325a..362724670f 100644 --- a/metapackages/auto-instrumentations-node/package.json +++ b/metapackages/auto-instrumentations-node/package.json @@ -64,6 +64,7 @@ "@opentelemetry/instrumentation-ioredis": "^0.30.0", "@opentelemetry/instrumentation-knex": "^0.29.0", "@opentelemetry/instrumentation-koa": "^0.30.0", + "@opentelemetry/instrumentation-lru-memoizer": "^0.29.0", "@opentelemetry/instrumentation-memcached": "^0.29.0", "@opentelemetry/instrumentation-mongodb": "^0.31.0", "@opentelemetry/instrumentation-mysql": "^0.30.0", diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index ba9d64473a..44163eaac8 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -33,6 +33,7 @@ import { HttpInstrumentation } from '@opentelemetry/instrumentation-http'; import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis'; import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex'; import { KoaInstrumentation } from '@opentelemetry/instrumentation-koa'; +import { LruMemoizerInstrumentation } from '@opentelemetry/instrumentation-lru-memoizer'; import { MemcachedInstrumentation } from '@opentelemetry/instrumentation-memcached'; import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb'; import { MySQL2Instrumentation } from '@opentelemetry/instrumentation-mysql2'; @@ -65,6 +66,7 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-ioredis': IORedisInstrumentation, '@opentelemetry/instrumentation-knex': KnexInstrumentation, '@opentelemetry/instrumentation-koa': KoaInstrumentation, + '@opentelemetry/instrumentation-lru-memoizer': LruMemoizerInstrumentation, '@opentelemetry/instrumentation-memcached': MemcachedInstrumentation, '@opentelemetry/instrumentation-mongodb': MongoDBInstrumentation, '@opentelemetry/instrumentation-mysql2': MySQL2Instrumentation, diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts index aecfd1fd49..20f15c1723 100644 --- a/metapackages/auto-instrumentations-node/test/utils.test.ts +++ b/metapackages/auto-instrumentations-node/test/utils.test.ts @@ -42,6 +42,7 @@ describe('utils', () => { '@opentelemetry/instrumentation-ioredis', '@opentelemetry/instrumentation-knex', '@opentelemetry/instrumentation-koa', + '@opentelemetry/instrumentation-lru-memoizer', '@opentelemetry/instrumentation-memcached', '@opentelemetry/instrumentation-mongodb', '@opentelemetry/instrumentation-mysql2', @@ -55,7 +56,7 @@ describe('utils', () => { '@opentelemetry/instrumentation-restify', '@opentelemetry/instrumentation-winston', ]; - assert.strictEqual(instrumentations.length, 29); + assert.strictEqual(instrumentations.length, 30); for (let i = 0, j = instrumentations.length; i < j; i++) { assert.strictEqual( instrumentations[i].instrumentationName, diff --git a/plugins/node/instrumentation-lru-memoizer/.eslintignore b/plugins/node/instrumentation-lru-memoizer/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/instrumentation-lru-memoizer/.eslintrc.js b/plugins/node/instrumentation-lru-memoizer/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/plugins/node/instrumentation-lru-memoizer/.npmignore b/plugins/node/instrumentation-lru-memoizer/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/instrumentation-lru-memoizer/.tav.yml b/plugins/node/instrumentation-lru-memoizer/.tav.yml new file mode 100644 index 0000000000..6402081ee1 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/.tav.yml @@ -0,0 +1,7 @@ +'lru-memoizer': + versions: ">=1.3 <3" + commands: + - npm test + + # Fix missing `contrib-test-utils` package + pretest: npm run --prefix ../../../ lerna:link diff --git a/plugins/node/instrumentation-lru-memoizer/LICENSE b/plugins/node/instrumentation-lru-memoizer/LICENSE new file mode 100644 index 0000000000..e50e8c80f9 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/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 [2022] 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 + + 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/plugins/node/instrumentation-lru-memoizer/README.md b/plugins/node/instrumentation-lru-memoizer/README.md new file mode 100644 index 0000000000..b76f1f5abf --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/README.md @@ -0,0 +1,57 @@ +# OpenTelemetry lru-memorizer Instrumentation for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for the [`lru-memorizer`](https://github.com/jfromaniello/lru-memoizer) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. + +If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-lru-memoizer +``` + +## Supported Versions + +- `>=1.3 <3` + +## Usage + +This instrumentation does not produce any telemetry data. It only bind the caller context to callbacks so downstream operations are recorded with the right context (traceId / parentSpanId / baggage / etc). The `lru-memoizer` package is a dependency for other packages such as [jwks-rsa](https://www.npmjs.com/package/jwks-rsa) + +To load a specific plugin, specify it in the registerInstrumentations's configuration: + +```js +const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node'); +const { LruMemoizerInstrumentation } = require('@opentelemetry/instrumentation-lru-memoizer'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new LruMemoizerInstrumentation(), + ], +}) +``` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-lru-memoizer +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-lru-memoizer.svg diff --git a/plugins/node/instrumentation-lru-memoizer/package.json b/plugins/node/instrumentation-lru-memoizer/package.json new file mode 100644 index 0000000000..73ebab47e4 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/package.json @@ -0,0 +1,64 @@ +{ + "name": "@opentelemetry/instrumentation-lru-memoizer", + "version": "0.29.0", + "description": "OpenTelemetry automatic instrumentation package for lru-memoizer", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "test": "ts-mocha -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/*.test.ts'", + "test-all-versions": "tav", + "tdd": "npm run test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version && lerna run version --scope @opentelemetry/instrumentation-lru-memoizer --include-dependencies", + "prewatch": "npm run precompile", + "prepare": "npm run compile", + "version:update": "node ../../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p ." + }, + "keywords": [ + "lru-memoizer", + "instrumentation", + "nodejs", + "opentelemetry", + "tracing" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.12.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@opentelemetry/contrib-test-utils": "^0.31.0", + "@types/lru-cache": "~4.0.0", + "@types/mocha": "8.2.3", + "@types/node": "16.11.21", + "expect": "25.5.0", + "gts": "3.1.0", + "lru-memoizer": "2.1.4", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "test-all-versions": "5.0.1", + "ts-mocha": "10.0.0", + "typescript": "4.3.5" + }, + "dependencies": { + "@opentelemetry/instrumentation": "^0.29.2" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-lru-memoizer#readme" +} diff --git a/plugins/node/instrumentation-lru-memoizer/src/index.ts b/plugins/node/instrumentation-lru-memoizer/src/index.ts new file mode 100644 index 0000000000..fc85cdf0f8 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/src/index.ts @@ -0,0 +1,21 @@ +/* + * Copyright The 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 LruMemoizerInstrumentation from './instrumentation'; + +export { LruMemoizerInstrumentation }; + +export default LruMemoizerInstrumentation; diff --git a/plugins/node/instrumentation-lru-memoizer/src/instrumentation.ts b/plugins/node/instrumentation-lru-memoizer/src/instrumentation.ts new file mode 100644 index 0000000000..b26d9468a3 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/src/instrumentation.ts @@ -0,0 +1,67 @@ +/* + * Copyright The 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 { context } from '@opentelemetry/api'; +import { + InstrumentationBase, + InstrumentationConfig, + InstrumentationNodeModuleDefinition, +} from '@opentelemetry/instrumentation'; +import { VERSION } from './version'; + +export default class LruMemoizerInstrumentation extends InstrumentationBase { + constructor(config?: InstrumentationConfig) { + super('@opentelemetry/instrumentation-lru-memoizer', VERSION, config); + } + + init(): InstrumentationNodeModuleDefinition[] { + return [ + new InstrumentationNodeModuleDefinition( + 'lru-memoizer', + ['>=1.3 <3'], + moduleExports => { + this._diag.debug('applying patch for lru-memoizer'); + + // moduleExports is a function which receives an options object, + // and returns a "memoizer" function upon invocation. + // We want to patch this "memoizer's" internal function + const asyncMemoizer = function (this: unknown) { + // This following function is invoked every time the user wants to get a (possible) memoized value + // We replace it with another function in which we bind the current context to the last argument (callback) + const origMemoizer = moduleExports.apply(this, arguments); + return function (this: unknown) { + const modifiedArguments = [...arguments]; + // last argument is the callback + const origCallback = modifiedArguments.pop(); + const callbackWithContext = + typeof origCallback === 'function' + ? context.bind(context.active(), origCallback) + : origCallback; + modifiedArguments.push(callbackWithContext); + return origMemoizer.apply(this, modifiedArguments); + }; + }; + + // sync function preserves context, but we still need to export it + // as the lru-memoizer package does + asyncMemoizer.sync = moduleExports.sync; + return asyncMemoizer; + }, + undefined // no need to disable as this instrumentation does not create any spans + ), + ]; + } +} diff --git a/plugins/node/instrumentation-lru-memoizer/test/index.test.ts b/plugins/node/instrumentation-lru-memoizer/test/index.test.ts new file mode 100644 index 0000000000..95969e8be8 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/test/index.test.ts @@ -0,0 +1,135 @@ +/* + * Copyright The 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 LruMemoizerInstrumentation from '../src'; +import { trace, context } from '@opentelemetry/api'; +import * as expect from 'expect'; + +import { registerInstrumentationTesting } from '@opentelemetry/contrib-test-utils'; + +registerInstrumentationTesting(new LruMemoizerInstrumentation()); + +import * as memoizer from 'lru-memoizer'; + +type MemoizerTestCallback = (err: Error, result: string) => void; + +describe('lru-memoizer instrumentation', () => { + describe('async', () => { + it('should invoke load callback with original context', done => { + const testTracer = trace + .getTracerProvider() + .getTracer('lru-memoize-testing'); + + let memoizerLoadCallback: MemoizerTestCallback; + const memoizedFoo = memoizer({ + load: (_param: unknown, callback: MemoizerTestCallback) => { + memoizerLoadCallback = callback; + }, + hash: () => 'bar', + } as any); + + testTracer.startActiveSpan('memoized invocation', () => { + const firstSpanContext = context.active(); + memoizedFoo({ foo: 'bar' }, (err, res) => { + expect(context.active()).toBe(firstSpanContext); + done(err); + }); + }); + + // we invoke the callback from outside of the above span's context. + // however, we expect that the callback is called with the context of the original invocation + memoizerLoadCallback!(null as any, 'result'); + }); + + it('should invoke callback with right context when serving 2 parallel async requestes', () => { + const testTracer = trace + .getTracerProvider() + .getTracer('lru-memoize-testing'); + + const ongoingMemoizerLoads: Function[] = []; + + const memoizedFoo = memoizer({ + load: (_param: unknown, callback: MemoizerTestCallback) => { + // don't call the cb yet, first invoke another call, + // to let it go into the internal "pendingLoad" queue + ongoingMemoizerLoads.push(callback); + }, + hash: () => 'bar', + } as any); + + testTracer.startActiveSpan('first request', () => { + const firstSpanContext = context.active(); + memoizedFoo({ foo: 'bar' }, (err, res) => { + expect(context.active()).toBe(firstSpanContext); + }); + }); + + testTracer.startActiveSpan('second request', () => { + const secondSpanContext = context.active(); + memoizedFoo({ foo: 'bar' }, (err, res) => { + expect(context.active()).toBe(secondSpanContext); + }); + }); + + expect(ongoingMemoizerLoads.length).toBe(1); + ongoingMemoizerLoads[0](null, 'result'); + }); + + it('should not throw when last argument is not callback', () => { + const memoizedFoo = memoizer({ + load: (callback: MemoizerTestCallback) => { + return 'foo'; + }, + hash: () => 'bar', + } as any); + + // this is not valid but we want to make sure it does not throw or act badly + memoizedFoo({ foo: 'bar' }, null as any); + }); + }); + + describe('sync', () => { + it('should not break sync memoizer', () => { + const memoizedFoo = memoizer.sync({ + load: (_params: any) => 'foo', + hash: () => 'bar', + } as any); + + const res = memoizedFoo({ foo: 'bar' }); + expect(res).toMatch('foo'); + }); + + it('should not break sync memoizer that return promise', done => { + const testTracer = trace + .getTracerProvider() + .getTracer('lru-memoize-testing'); + + const memoizedFoo = memoizer.sync({ + load: (_params: any) => Promise.resolve('foo'), + hash: () => 'bar', + } as any); + + testTracer.startActiveSpan('first request', () => { + const memoizerInvokeContext = context.active(); + const res = memoizedFoo({ foo: 'bar' }) as Promise; + res.then(val => { + expect(context.active()).toBe(memoizerInvokeContext); + expect(val).toMatch('foo'); // make sure it still works after patch + done(); + }); + }); + }); + }); +}); diff --git a/plugins/node/instrumentation-lru-memoizer/tsconfig.json b/plugins/node/instrumentation-lru-memoizer/tsconfig.json new file mode 100644 index 0000000000..5c3680dd33 --- /dev/null +++ b/plugins/node/instrumentation-lru-memoizer/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build", + "skipLibCheck": true + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/release-please-config.json b/release-please-config.json index 9328c8dd8e..5adc2a410e 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -35,6 +35,7 @@ "plugins/node/opentelemetry-instrumentation-ioredis": {}, "plugins/node/opentelemetry-instrumentation-knex": {}, "plugins/node/opentelemetry-instrumentation-koa": {}, + "plugins/node/opentelemetry-instrumentation-lru-memoizer": {}, "plugins/node/opentelemetry-instrumentation-memcached": {}, "plugins/node/opentelemetry-instrumentation-mongodb": {}, "plugins/node/opentelemetry-instrumentation-mysql": {},