Merge pull request #2 from coralogix/work-with-optional-dependencies

fix: Work with optional dependencies

Author: drewcorlin1

package-lock.json

@@ -37,12 +37,14 @@
     "esbuild": "0.21.x"
   },
   "devDependencies": {
+    "@fastify/rate-limit": "^9.1.0",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/sdk-node": "^0.54.0",
     "@types/mocha": "7.0.2",
     "@types/node": "18.6.5",
     "fastify": "4.15.0",
     "mocha": "7.2.0",
+    "mongodb": "5.9.2",
     "nyc": "15.1.0",
     "pino": "^8.19.0",
     "redis": "^4.7.0",

packages/esbuild-plugin-node/package.json

@@ -56,10 +56,20 @@ export function openTelemetryPlugin(
           return;
         }
 
-        const { path, extractedModule } = extractPackageAndModulePath(
-          args.path,
-          args.resolveDir
-        );
+        let path;
+        let extractedModule;
+
+        try {
+          const result = extractPackageAndModulePath(
+            args.path,
+            args.resolveDir
+          );
+          path = result.path;
+          extractedModule = result.extractedModule;
+        } catch (e) {
+          // Some libraries like `mongodb` require optional dependencies, which may not be present and their absence doesn't break the code
+          // Currently esbuild doesn't provide any better way to handle this in plugins: https://github.com/evanw/esbuild/issues/1127
+        }
 
         // If it's a local import, don't patch it
         if (!extractedModule) return;

packages/esbuild-plugin-node/src/plugin.ts

@@ -105,9 +105,12 @@ describe('Esbuild can instrument packages via a plugin', function () {
       )
     );
 
-    const traceId = getTraceId(stdOutLines, 'request handler - fastify');
+    const traceId = getTraceId(
+      stdOutLines,
+      'request handler - fastify -> @fastify/rate-limit'
+    );
 
-    assert.ok(traceId, 'console span output in stdout contains a traceId');
+    assert.ok(traceId, 'console span output in stdout contains a fastify span');
 
     const requestHandlerLogMessage = stdOutLines.find(line =>
       line.includes('Log message from handler')
@@ -121,7 +124,7 @@ describe('Esbuild can instrument packages via a plugin', function () {
   it('redis', async () => {
     const traceId = getTraceId(stdOutLines, 'redis-GET');
 
-    assert.ok(traceId, 'console span output in stdout contains a traceId');
+    assert.ok(traceId, 'console span output in stdout contains a redis span');
   });
 
   describe('graphql', () => {
@@ -140,4 +143,6 @@ describe('Esbuild can instrument packages via a plugin', function () {
       assert.ok(parseSpan, 'There is a span for query');
     });
   });
+
+  // TODO: Add tests for mongodb spans. This will require running a mongodb instance.
 });

packages/esbuild-plugin-node/test/plugin.test.ts

@@ -19,18 +19,34 @@ import { createClient } from 'redis';
 import fastify from 'fastify';
 import { graphql } from './graphql/adapter';
 import pino from 'pino';
+import { MongoClient } from 'mongodb';
+
+const redisClient = createClient({ url: process.env.REDIS_URL });
 
 export const server = fastify({
   logger: pino({}, pino.destination(1)),
   disableRequestLogging: true,
+}).register(require('@fastify/rate-limit'), {
+  // Use @fastify/rate-limit to avoid CodeQL "Missing rate limiting" error in CI
+  global: true,
+  max: 100,
+  timeWindow: '1 minute',
 });
-const redisClient = createClient({ url: process.env.REDIS_URL });
 
 server.get('/test', async req => {
   req.log.info({ hi: 'there' }, 'Log message from handler');
 
   await redisClient.get('key').catch(() => void 0);
 
+  try {
+    const mongoClient = await MongoClient.connect(`${process.env.MONGO_URL}`);
+    const db = mongoClient.db('sample-database');
+    const col = db.collection('sample-collection');
+    await col.insertOne({ hello: 'test' });
+  } catch (e) {
+    req.log.info('Error connecting to MongoDB');
+  }
+
   return { hi: 'there' };
 });