NodeSDK fails in strict mode with `Legacy octal escape is not permitted in strict mode` #3759

jankaifer · 2023-04-25T16:18:13Z

What happened?

Steps to Reproduce

Import NodeSDK in strict mode.

Expected Result

It should not fail.

Actual Result

When I run pnpm build, it fails. Logs below.

Additional Details

Reproduction: https://github.com/jankaifer/next-repro-otel-node-sdk-repro

OpenTelemetry Setup Code

import { NodeSDK } from "@opentelemetry/sdk-node";
import { SimpleSpanProcessor } from "@opentelemetry/sdk-trace-node";
import { ConsoleSpanExporter } from "@opentelemetry/sdk-trace-base";

const exporter = new ConsoleSpanExporter();

const sdk = new NodeSDK({
  spanProcessor: new SimpleSpanProcessor(exporter),
});
sdk.start();

package.json

{
  "private": true,
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  },
  "dependencies": {
    "@opentelemetry/sdk-node": "^0.38.0",
    "@opentelemetry/sdk-trace-base": "^1.12.0",
    "@opentelemetry/sdk-trace-node": "^1.12.0",
    "next": "canary",
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
  },
  "devDependencies": {
    "@types/node": "^18.11.13",
    "@types/react": "^18.0.26",
    "typescript": "^4.9.4"
  }
}

Relevant log output

./node_modules/.pnpm/[email protected]/node_modules/ansi-color/lib/ansi-color.js
Error: 
  × Legacy octal escape is not permitted in strict mode
    ╭─[/home/pearman/dev/playground/otel-node-sdk-repro/node_modules/.pnpm/[email protected]/node_modules/ansi-color/lib/ansi-color.js:32:1]
 32 │   var color_attrs = color.split("+");
 33 │   var ansi_str = "";
 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;
    ╰────

  × Legacy octal escape is not permitted in strict mode
    ╭─[/home/pearman/dev/playground/otel-node-sdk-repro/node_modules/.pnpm/[email protected]/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 │ };
    ╰────

Caused by:
    Syntax Error

Import trace for requested module:
./node_modules/.pnpm/[email protected]/node_modules/ansi-color/lib/ansi-color.js
./node_modules/.pnpm/[email protected]/node_modules/bufrw/annotated_buffer.js
./node_modules/.pnpm/[email protected]/node_modules/bufrw/interface.js
./node_modules/.pnpm/[email protected]/node_modules/bufrw/index.js
./node_modules/.pnpm/[email protected]/node_modules/thriftrw/index.js
./node_modules/.pnpm/[email protected]/node_modules/jaeger-client/dist/src/reporters/udp_sender.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/exporter-jaeger/build/src/types.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/exporter-jaeger/build/src/jaeger.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/exporter-jaeger/build/src/index.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/sdk-node/build/src/TracerProviderWithEnvExporter.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/sdk-node/build/src/sdk.js
./node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/sdk-node/build/src/index.js
./app/page.tsx

The text was updated successfully, but these errors were encountered:

jankaifer · 2023-04-25T16:19:40Z

cc @dyladan

jankaifer · 2023-04-25T16:25:58Z

The log makes it clear what causes the issue. The import order of packages is:

@opentelemetry/sdk-node
@opentelemetry/exporter-jaeger
jaeger-client
thriftrw
bufrw
ansi-color

I don't know where we can break this chain.

~~I'm unsure which dependency changed since I last tested @opentelemetry/sdk-node with next, but this is breaking for us, and it will force us to recommend using TraceExporter instead.~~

jankaifer · 2023-04-25T16:43:29Z

I couldn't reproduce the issue with the pages directory in next.
I'll investigate if we can make our setup less strict.

But it still would be useful to use up-to-date and maintained dependencies (ansi-color has one release 8 years ago).

pichlermarc · 2023-04-26T09:30:05Z

@jankaifer are you using the JaegerExporter? If not then this bug will be solved by the next release (see #3739) 🙂

For users of @opentelemetry/expoter-jaeger it will still persist, but we encourage everyone to move to OTLP as Jaeger now supports it natively.

jankaifer · 2023-04-26T09:36:47Z

No, we expect our users will use mostly OTLP.

Feel free to re-open the issue if you want to track this issue with export-jaeger, but it's solved for us. Thanks again.

tom-sherman · 2023-05-27T14:48:11Z

Hey @pichlermarc I'm also receiving this error with Next.js, see vercel/otel#8

I'm not using jaeger in my app code and AFAIA the @vercel/otel wrapper doesn't use this either. However even when ensuring I'm using v0.39 of the OTEL Node SDK I still get this error.

Any ideas?

I've also tried removing the Vercel wrapper and configuring OTEL directly, the code for that is below but I get the same issue.

import { trace, context } from '@opentelemetry/api';
import { NodeSDK } from '@opentelemetry/sdk-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { Resource } from '@opentelemetry/resources';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-node';

const sdk = new NodeSDK({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: 'next-app',
  }),
  spanProcessor: new SimpleSpanProcessor(new OTLPTraceExporter()),
});

sdk.start();

export const tracer = trace.getTracer('next-app-tracer');
export { context };

tom-sherman · 2023-05-27T14:55:13Z

@jankaifer How did you solve this in the app directory? Or could you only get it to work in the page directoy?

pichlermarc · 2023-05-30T05:47:12Z

@tom-sherman you're right, looks like this was not fixed by ~~#3752~~ #3739 . I'm reopening this issue.

pichlermarc · 2023-05-30T06:06:09Z

To fix this we'll have to either

make the dependency on @opentelemetry/exporter-jaeger optional in @opentelemetry/sdk-node
- this is potentially breaking for a lot of users (but @opentelemetry/sdk-node is experimental so breaking changes are to be expected), we could go a similar route as we will in the next release of @opentelemetry/instrumentation-grpc where we added a postinstall script to warn users of an upcoming breaking change chore(instrumentation-grpc): add 'grpc' deprecation notice postinstall script #3833
implement [exporter-jaeger] add support for using the JaegerExporter with bundling tools #3752 (comment)

luismiramirez · 2023-07-27T13:26:36Z

How's progress on this?

I have the same error on a Next.js app using @opentelemetry/sdk-node v0.41.1.

Is there a way to work around this? I can also lend a hand to work on the fix. I'm available at #otel-js in Slack.

Quickgs · 2023-08-11T12:45:17Z

Was blocked by this for a few weeks, eventually just bit the bullet and fixed it myself.

Forked ansi-color library and updated the octal escapes.

function setColor(str, color) {
  if (!color) return str;
  var color_attrs = color.split("+");
  var ansi_str = "";
  for (var i = 0, attr; attr = color_attrs[i]; i++) {
    ansi_str += "\x1b[" + ANSI_CODES[attr] + "m"; // \x1b is the hexadecimal representation for ESC (0o33 or \033 in octal)
  }
  ansi_str += str + "\x1b[" + ANSI_CODES["off"] + "m";
  return ansi_str;
}

Then set the following in package.json to override the reference.

"overrides": {
        "ansi-color": "<username>/commonjs-ansi-color-fixed#master"
    },

This solution requires that you have SSH for github cli setup so that NPM can access it if you have protected repositories.

maggiepint · 2023-08-14T20:04:34Z

@Quickgs - does this work in Next middleware on vercel? I tried doing basically exactly this and then I got a lot of upset that the node performance APIs were being called.

Quickgs · 2023-08-14T20:38:35Z

@Quickgs - does this work in Next middleware on vercel? I tried doing basically exactly this and then I got a lot of upset that the node performance APIs were being called.

I am unsure, I am invoking it within the instrumentation.ts special file in next13 hosted on an AWS pod and sending it to a Honeycomb collector.

tom-sherman · 2023-09-13T08:05:29Z

@maggiepint I don't think instrumentation is available in the Edge runtime, it's cloudflare workers based which doesn't allow eg. Accurate timings.

nirga · 2023-10-24T22:21:40Z

This is still happening to me with "@opentelemetry/sdk-node": "^0.44.0"

(Update: should be fixed with #4214)

Fix for `Legacy octal escape is not permitted in strict mode` Reference : open-telemetry/opentelemetry-js#3759 (comment)

jankaifer added bug Something isn't working triage labels Apr 25, 2023

jankaifer closed this as completed Apr 26, 2023

pichlermarc mentioned this issue Apr 26, 2023

[exporter-jaeger] add support for using the JaegerExporter with bundling tools #3752

Open

tom-sherman mentioned this issue May 27, 2023

Error with next build: Legacy octal escape is not permitted in strict mode vercel/otel#8

Open

pichlermarc reopened this May 30, 2023

pichlermarc added priority:p1 Bugs which cause problems in end-user applications such as crashes, data inconsistencies, etc pkg:sdk-node pkg:exporter-jaeger up-for-grabs Good for taking. Extra help will be provided by maintainers and removed triage labels May 30, 2023

luismiramirez mentioned this issue Jul 27, 2023

Next.js + Webpack incompatibility appsignal/appsignal-nodejs#928

Closed

4 tasks

pichlermarc mentioned this issue Aug 10, 2023

fix(sdk-node): move @opentelemetry/exporter-jaeger to dev dependencies #4049

Merged

4 tasks

pichlermarc closed this as completed in #4049 Sep 13, 2023

jstlaurent mentioned this issue Nov 15, 2023

[node-sdk] Missing @opentelemetry/exporter-jaeger raises an error on Next.js app #4297

Open

anubhavchaturvedi added a commit to anubhavchaturvedi/commonjs-ansi-color that referenced this issue May 7, 2024

Update ansi-color.js

b19f2cc

Fix for `Legacy octal escape is not permitted in strict mode` Reference : open-telemetry/opentelemetry-js#3759 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NodeSDK fails in strict mode with `Legacy octal escape is not permitted in strict mode` #3759

NodeSDK fails in strict mode with `Legacy octal escape is not permitted in strict mode` #3759

jankaifer commented Apr 25, 2023

jankaifer commented Apr 25, 2023

jankaifer commented Apr 25, 2023 •

edited

Loading

jankaifer commented Apr 25, 2023 •

edited

Loading

pichlermarc commented Apr 26, 2023

jankaifer commented Apr 26, 2023

tom-sherman commented May 27, 2023

tom-sherman commented May 27, 2023

pichlermarc commented May 30, 2023 •

edited

Loading

pichlermarc commented May 30, 2023 •

edited

Loading

luismiramirez commented Jul 27, 2023

Quickgs commented Aug 11, 2023 •

edited

Loading

maggiepint commented Aug 14, 2023

Quickgs commented Aug 14, 2023

tom-sherman commented Sep 13, 2023

nirga commented Oct 24, 2023 •

edited

Loading

NodeSDK fails in strict mode with Legacy octal escape is not permitted in strict mode #3759

NodeSDK fails in strict mode with Legacy octal escape is not permitted in strict mode #3759

Comments

jankaifer commented Apr 25, 2023

What happened?

Steps to Reproduce

Expected Result

Actual Result

Additional Details

OpenTelemetry Setup Code

package.json

Relevant log output

jankaifer commented Apr 25, 2023

jankaifer commented Apr 25, 2023 • edited Loading

jankaifer commented Apr 25, 2023 • edited Loading

pichlermarc commented Apr 26, 2023

jankaifer commented Apr 26, 2023

tom-sherman commented May 27, 2023

tom-sherman commented May 27, 2023

pichlermarc commented May 30, 2023 • edited Loading

pichlermarc commented May 30, 2023 • edited Loading

luismiramirez commented Jul 27, 2023

Quickgs commented Aug 11, 2023 • edited Loading

maggiepint commented Aug 14, 2023

Quickgs commented Aug 14, 2023

tom-sherman commented Sep 13, 2023

nirga commented Oct 24, 2023 • edited Loading

NodeSDK fails in strict mode with `Legacy octal escape is not permitted in strict mode` #3759

NodeSDK fails in strict mode with `Legacy octal escape is not permitted in strict mode` #3759

jankaifer commented Apr 25, 2023 •

edited

Loading

jankaifer commented Apr 25, 2023 •

edited

Loading

pichlermarc commented May 30, 2023 •

edited

Loading

pichlermarc commented May 30, 2023 •

edited

Loading

Quickgs commented Aug 11, 2023 •

edited

Loading

nirga commented Oct 24, 2023 •

edited

Loading