feat(node): Add lru-memoizer instrumentation (#13796)

Resolves: #13309 

Adds integration for `lru-memoizer` using
[@opentelemetry/instrumentation-lru-memoizer](https://www.npmjs.com/package/@opentelemetry/instrumentation-lru-memoizer).

This instrumentation does not create any spans. It only assigns the span
context into memoized callbacks used in `lru-memoizer`'s `load`.

Ported a test case from the original implementation and tested manually
to validate.

Author: onurtemizkan

dev-packages/node-integration-tests/package.json

@@ -51,6 +51,7 @@
     "http-terminator": "^3.2.0",
     "ioredis": "^5.4.1",
     "kafkajs": "2.2.4",
+    "lru-memoizer": "2.3.0",
     "mongodb": "^3.7.3",
     "mongodb-memory-server-global": "^7.6.3",
     "mongoose": "^5.13.22",

dev-packages/node-integration-tests/suites/tracing/lru-memoizer/scenario.js

@@ -0,0 +1,47 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+});
+
+// Stop the process from exiting before the transaction is sent
+setInterval(() => {}, 1000);
+
+const run = async () => {
+  // Test ported from the OTEL implementation:
+  // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0d6ebded313bb75b5a0e7a6422206c922daf3943/plugins/node/instrumentation-lru-memoizer/test/index.test.ts#L28
+  const memoizer = require('lru-memoizer');
+
+  let memoizerLoadCallback;
+  const memoizedFoo = memoizer({
+    load: (_param, callback) => {
+      memoizerLoadCallback = callback;
+    },
+    hash: () => 'bar',
+  });
+
+  Sentry.startSpan({ op: 'run' }, async span => {
+    const outerSpanContext = span.spanContext();
+
+    memoizedFoo({ foo: 'bar' }, () => {
+      const innerContext = Sentry.getActiveSpan().spanContext();
+
+      // The span context should be the same as the outer span
+      // Throwing an error here will cause the test to fail
+      if (outerSpanContext !== innerContext) {
+        throw new Error('Outer and inner span context should match');
+      }
+    });
+
+    span.end();
+  });
+
+  // Invoking the load callback outside the span
+  memoizerLoadCallback();
+};
+
+run();

dev-packages/node-integration-tests/suites/tracing/lru-memoizer/test.ts

@@ -0,0 +1,29 @@
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+describe('lru-memoizer', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('keeps outer context inside the memoized inner functions', done => {
+    createRunner(__dirname, 'scenario.js')
+      // We expect only one transaction and nothing else.
+      // A failed test will result in an error event being sent to Sentry.
+      // Which will fail this suite.
+      .expect({
+        transaction: {
+          transaction: '<unknown>',
+          contexts: {
+            trace: expect.objectContaining({
+              op: 'run',
+              data: expect.objectContaining({
+                'sentry.op': 'run',
+                'sentry.origin': 'manual',
+              }),
+            }),
+          },
+        },
+      })
+      .start(done);
+  });
+});

packages/astro/src/index.server.ts

@@ -72,6 +72,7 @@ export {
   lastEventId,
   linkedErrorsIntegration,
   localVariablesIntegration,
+  lruMemoizerIntegration,
   makeNodeTransport,
   metrics,
   modulesIntegration,

packages/aws-serverless/src/index.ts

@@ -91,6 +91,7 @@ export {
   genericPoolIntegration,
   graphqlIntegration,
   kafkaIntegration,
+  lruMemoizerIntegration,
   mongoIntegration,
   mongooseIntegration,
   mysqlIntegration,

packages/bun/src/index.ts

@@ -112,6 +112,7 @@ export {
   genericPoolIntegration,
   graphqlIntegration,
   kafkaIntegration,
+  lruMemoizerIntegration,
   mongoIntegration,
   mongooseIntegration,
   mysqlIntegration,

packages/google-cloud-serverless/src/index.ts

@@ -91,6 +91,7 @@ export {
   genericPoolIntegration,
   graphqlIntegration,
   kafkaIntegration,
+  lruMemoizerIntegration,
   mongoIntegration,
   mongooseIntegration,
   mysqlIntegration,

packages/node/package.json

@@ -82,6 +82,7 @@
     "@opentelemetry/instrumentation-ioredis": "0.43.0",
     "@opentelemetry/instrumentation-kafkajs": "0.3.0",
     "@opentelemetry/instrumentation-koa": "0.43.0",
+    "@opentelemetry/instrumentation-lru-memoizer": "0.40.0",
     "@opentelemetry/instrumentation-mongodb": "0.47.0",
     "@opentelemetry/instrumentation-mongoose": "0.42.0",
     "@opentelemetry/instrumentation-mysql": "0.41.0",

packages/node/src/index.ts

@@ -15,6 +15,7 @@ export { expressIntegration, expressErrorHandler, setupExpressErrorHandler } fro
 export { fastifyIntegration, setupFastifyErrorHandler } from './integrations/tracing/fastify';
 export { graphqlIntegration } from './integrations/tracing/graphql';
 export { kafkaIntegration } from './integrations/tracing/kafka';
+export { lruMemoizerIntegration } from './integrations/tracing/lrumemoizer';
 export { mongoIntegration } from './integrations/tracing/mongo';
 export { mongooseIntegration } from './integrations/tracing/mongoose';
 export { mysqlIntegration } from './integrations/tracing/mysql';

packages/node/src/integrations/tracing/index.ts

@@ -11,6 +11,7 @@ import { graphqlIntegration, instrumentGraphql } from './graphql';
 import { hapiIntegration, instrumentHapi } from './hapi';
 import { instrumentKafka, kafkaIntegration } from './kafka';
 import { instrumentKoa, koaIntegration } from './koa';
+import { instrumentLruMemoizer, lruMemoizerIntegration } from './lrumemoizer';
 import { instrumentMongo, mongoIntegration } from './mongo';
 import { instrumentMongoose, mongooseIntegration } from './mongoose';
 import { instrumentMysql, mysqlIntegration } from './mysql';
@@ -45,6 +46,7 @@ export function getAutoPerformanceIntegrations(): Integration[] {
     kafkaIntegration(),
     dataloaderIntegration(),
     amqplibIntegration(),
+    lruMemoizerIntegration(),
   ];
 }
 
@@ -61,6 +63,7 @@ export function getOpenTelemetryInstrumentationToPreload(): (((options?: any) =>
     instrumentHapi,
     instrumentKafka,
     instrumentKoa,
+    instrumentLruMemoizer,
     instrumentNest,
     instrumentMongo,
     instrumentMongoose,