Next.js + Webpack incompatibility

[luismiramirez]

Root report

This was discovered after a customer reported an error related to the extension.node binary file throwing an error when being read by Next.js's Webpack.

I was able to get through that error by using a third-party loader for webpack that allows you to get Node binary files into the bundle.

Here's how the updated Next.js app config looks after adding the dependency to the project:

module.exports = {
  webpack: (config, _options) => {
    config.module.rules.push({
      test: /\.node$/i,
      loader: "node-loader",
    })
    return config
  }
}

---

Actual issue

After fixing the extension binary file, the app server logged this:

  x Legacy octal escape is not permitted in strict mode
    ,-[/Users/luismiramirez/code/winston-logging/node_modules/ansi-color/lib/ansi-color.js:34:1]
 34 |   for(var i=0, attr; attr = color_attrs[i]; i++) {
 35 |     ansi_str += "\033[" + ANSI_CODES[attr] + "m";
 36 |   }
 37 |   ansi_str += str + "\033[" + ANSI_CODES["off"] + "m";
    :                      ^^
 38 |   return ansi_str;
 39 | };
    `----

This comes from a package called ansi-color, which is the end of a dependency tree that starts from the @opentelemetry/sdk-node, which is a dependency of our integration.

• @opentelemetry/sdk-node
  • @opentelemetry/exporter-jaeger
    • jaeger-client
      • thriftrw
        • bufrw

Another user already reported this issue to the OpenTelemetry team at: open-telemetry/opentelemetry-js#3759. The OpenTelemetry team released a fix for this here: open-telemetry/opentelemetry-js#3739.

I updated our @opentelemetry/sdk-node dependency to the latest version with no success. Also found out that other users are in the same situation, so the issue still needs to be closed.

OpenTelemetry's team progress on the issue can be tracked here: open-telemetry/opentelemetry-js#3759.

---

ToDo

• Research if there's a way to work around this until OpenTelemetry releases a fix
• Implement it and publish
• Notify users of fix:
  • https://app.intercom.com/a/inbox/yzor8gyw/inbox/shared/all/conversation/16410700250112#part_id=comment-16410700250112-21909534813

[unflxw]

The next OpenTelemetry release (changelog) should remove the dependency on @opentelemetry/exporter-jaeger, nicely working around this whole problem for us.

There is a customer waiting on the fix that should be notified: Intercom link

[luismiramirez]

Awesome! I'll keep an eye on this to upgrade the dependencies as soon as it's released.

[unflxw]

Update: something went wrong with that fix -- a further fix was added by @luismiramirez in this PR, and it has now been merged. So the next OpenTelemetry version should include the fix.

[unflxw]

Update update: version 0.45.0 was released, which includes the fix. Let's update the dependencies to bring that in.

[unflxw]

We'll be bumping the dependency range on @opentelemetry/sdk-node in the next release to make sure no one runs into this issue going forward.

In the meantime, if you're affected by this issue, running npm update @opentelemetry/sdk-node should fix it.