[BUG]: Node.js v24 Compatibility

[tlhunter]

Node.js v24 changes some things that cause the tracer to break in weird ways. Mostly in the form of dropped spans or lost propagation as this relates to async hooks.

Fixing this requires migrating integration-specific code on a case-by-case basis. The changes are backwards compatible. As we merge fixes into the master branch each release slowly gains more compatibility. Our goal is to completely support Node.js v24 in the only currently-active tracer release line, v5.

Here is the progress:

• IDM > Integration: aws-sdk
  • Plugins / aws-sdk (latest) convert aws-sdk to runstores instead of asyncresource #5707
• IDM > Integration: GraphQL
  • Project / integration (latest) remove async storage from graphql #5966
• ??? > "automatic log submission"
  • Project / integration (latest) (pull_request)
• ??? > packages/dd-trace/test/proxy.spec.js > TracerProxy > uninitialized > init
  • Tracing / ubuntu (pull_request)
• Integrations: COMPLEX
  • aws-sdk.js:5 convert aws-sdk to runstores instead of asyncresource #5707
• Integrations: DB SQL
  • tedious.js:3 Migrating Tedious from Async Resource to runStores #5747
  • mariadb.js:7
  • mysql.js:5
  • mysql2.js:3
  • oracledb.js:3 remove async storage from oracledb #6217
  • pg.js:4 Migrating Postgres from AsyncResource to Diagnostics Channel - runStores #6189
• Integrations: DB OBJ
  • couchbase.js:8 remove async storage from couchbase #5948
  • elasticsearch.js:3
  • cassandra-driver.js:18 remove async storage from cassandra-driver #5949
  • ioredis.js:2 remove async storage from redis instrumentations #5921
  • iovalkey.js:2 remove async storage from redis instrumentations #5921
  • memcached.js:3
  • mongodb-core.js:5 chore(tracing): remove async storage from mongo plugins #5812
  • mongodb.js:2 chore(tracing): remove async storage from mongo plugins #5812
  • redis.js:6 remove async storage from redis instrumentations #5921
  • sharedb.js:3
• Integrations: DB ORM
  • knex.js:2 Remove Async Resource from knex #6241
  • mongoose.js:4 chore(tracing): remove async storage from mongo plugins #5812
  • sequelize.js:2 Remove AsyncResource from sequelize #6125
• Integrations: HTTP / FRAMEWORKS
  • fastify.js:3 remove async storage from fastify instrumentation #6215
  • body-parser.js:2 (NOT NEEDED???)
  • http2/server.js:3 remove async storage from http2 server instrumentation #5947
  • multer.js:2 (NOT NEEDED???)
  • graphql.js:5 remove async storage from graphql #5966
  • moleculer/client.js:2 remove async storage from moleculer #5956
  • moleculer/server.js:2 remove async storage from moleculer #5956
  • microgateway-core.js:2 remove async storage from microgateway-core #6185
• Integrations: ETC
  • child_process.js:4 remove async storage from child_process instrumentation #5960
  • generic-pool.js:2 (NOT NEEDED???)
  • limitd-client.js:2 (Not needed, PR remove async resource from limitd-client #6216 closed)
  • ldapjs.js:4 (Not needed, PR remove async storage from ldapjs #6218 closed)
• Integrations: MESSAGE PASSING
  • amqp10.js:3
  • amqplib.js:2
  • google-cloud-pubsub.js:9
  • kafkajs.js:11
  • rhea.js:5
• CI Visibility
  • cucumber.js:22
  • jest.js:16
  • mocha/main.js:23
  • mocha/utils.js:22
  • playwright.js:22
  • vitest.js:17
• CI Visibility
  • Project / integration-ci (latest, cucumber) (pull_request)
  • Project / integration-ci (latest, jest) (pull_request)
  • Project / integration-ci (latest, mocha) (pull_request)
  • Project / integration-ci (latest, selenium) (pull_request)
  • Project / integration-ci (oldest, cucumber) (pull_request)
  • Project / integration-ci (oldest, jest) (pull_request)
  • Project / integration-playwright (latest) (pull_request)
• AppSec
  • AppSec / next (latest, >=11.0.0 <13) (pull_request)
  • AppSec / next (latest, 13.2.0) (pull_request)
  • AppSec / ubuntu (pull_request)
• IDM/LP > Low level integrations
  • TCP
  • NET
• Debugger
  • (fix already in master)
• Profiling
  • Profiling / ubuntu (pull_request)

Closes #5946

[m-sanders]

This is interesting!

Do you have any documentation or recommended direction on the preferred method to instrument custom code where we're unable to wrap something with a tracer.trace()?

I am currently using the AsyncLocalStorage .enterWith() in a GraphQL Yoga plugin to instrument subscriptions but this is an internal API.

import { storage } from 'dd-trace/packages/datadog-core';

export function useDDTracer(options: TracingOptions): Plugin<PluginContext> {
  return {
    onSubscribe({ args, subscribeFn, setSubscribeFn, extendContext }) {
      const span = tracer.startSpan('graphql.subscribe', {
        childOf:
          tracer.scope().active() ?? web.getContext(args.contextValue.req),
      });

      // No native method to enter a span
      const oldStore = storage('legacy').getStore();
      const newStore = storage('legacy').getStore((span as any)._store);
      storage('legacy').enterWith({ ...newStore, span });

      setSubscribeFn(async (...execArgs) => {
        return await tracer
          .scope()
          .activate(span, () => subscribeFn(...execArgs));
      });

      return {
        onSubscribeError: ({ error }) => {
          span.finish();
          storage('legacy').enterWith(oldStore);
        },
        onSubscribeResult: (payload) => {
          span.finish();
          storage('legacy').enterWith(oldStore);
        },
      };
    },
  };
}

[BridgeAR]

@m-sanders I believe the latest dd-trace-js version supports GraphQL Yoga out of the box.
I guess that way there is no need for the custom instrumentation.

[m-sanders]

@m-sanders I believe the latest dd-trace-js version supports GraphQL Yoga out of the box. I guess that way there is no need for the custom instrumentation.

Interesting. Looking at the plugin code and test suite, I can definitely see that you do support it. I’ll need to dig into why it doesn’t work for our yoga setup 🤔 thanks.

[joeyhotz]

I also am having issues with yoga and dd-trace-js. Recently migrated from apollo server to yoga but spans are now missing after the migration. The project is on node 20, latest dd-trace version, latest yoga version.

[joeyhotz]

Just have seen this - perhaps related? #5882

[m-sanders]

Just have seen this - perhaps related? #5882

@joeyhotz I did as I reported the original issue ;)

I have upgraded to the latest dd-trace and I am still not seeing subscription spans with the graphql plugin. I am guessing there is a bug here with the plugin and Yoga.

[BridgeAR]

@m-sanders @joeyhotz thank you, could you please reach out to our support for this? I am already going to check internally, if someone could have a look at it before. Reaching out to the support will just give this a higher priority. Please provide as much information from your setup as possible while reporting it there.

[tlhunter]

I'm super confused by the discussion here. Does it have anything to do with Node.js v24 compatibility?

[m-sanders]

I'm super confused by the discussion here. Does it have anything to do with Node.js v24 compatibility?

I currently need to rely on an internal API that looks to now be being replaced as part of this work to add Node.js 24 support with tracing channels.

Do you have any documentation or recommended direction on the preferred method to instrument custom code where we're unable to wrap something with a tracer.trace()?

I am currently using the AsyncLocalStorage .enterWith() in a GraphQL Yoga plugin to instrument subscriptions but this is an internal API.

So relevant in the sense that some documentation and support for an .enterWith(..) like API would be much appreciated.

The suggestion is that the workaround is unnecessary and if it is necessary then it is a bug.

[joeyhotz]

still having issues here - has anyone found a workaround? seeing graphql spans is pretty important to us 😢

[IlyasShabi]

Multer & body-parser status

Multer and body-parser use streaming libraries (Busboy and raw-body) to parse incoming requests. These libraries attach listeners like on('data') and on('end') to handle the stream. The issue is that these listeners run later, long after the middleware returns. By that time, the original async context is gone and leading to lost context downstream.

Why using AsyncResource.bind()

AsyncResource.bind() It allows us to capture the exact async context that existed when the middleware ran

Replace AsyncResource with runStores

runStores works only when we have a synchronous code inside the callback, and async work created inside that frame, It does not work for streaming event listeners.

[rochdev]

@joeyhotz @m-sanders Support for GraphQL Yoga should be available out of the box in the latest version of dd-trace. If that is not working, please open a new issue as this is unrelated to Node 24.