Skip to content

feat(nextjs): Mute webpack warnings about critical dependencies inside @opentelemetry/instrumentation #11810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 26, 2024
Merged

feat(nextjs): Mute webpack warnings about critical dependencies inside @opentelemetry/instrumentation #11810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 3 additions & 18 deletions dev-packages/e2e-tests/test-applications/nextjs-app-dir/assert-build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,9 @@ const buildStdout = fs.readFileSync('.tmp_build_stdout', 'utf-8');
const buildStderr = fs.readFileSync('.tmp_build_stderr', 'utf-8');

// Assert that there was no funky build time warning when we are on a stable (pinned) version
// if (nextjsVersion !== 'latest' && nextjsVersion !== 'canary') {
// assert.doesNotMatch(buildStderr, /Import trace for requested module/); // This is Next.js/Webpack speech for "something is off"
// }
// Note(lforst): I disabled this for the time being to figure out OTEL + Next.js - Next.js is currently complaining about a critical import in the @opentelemetry/instrumentation package. E.g:
// --- Start logs ---
// ./node_modules/@prisma/instrumentation/node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js
// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js
// Critical dependency: the request of a dependency is an expression
// Import trace for requested module:
// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/instrumentation.js
// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/node/index.js
// ./node_modules/@opentelemetry/instrumentation/build/esm/platform/index.js
// ./node_modules/@opentelemetry/instrumentation/build/esm/index.js
// ./node_modules/@sentry/node/cjs/index.js
// ./node_modules/@sentry/nextjs/cjs/server/index.js
// ./node_modules/@sentry/nextjs/cjs/index.server.js
// ./app/page.tsx
// --- End logs ---
if (nextjsVersion !== 'latest' && nextjsVersion !== 'canary') {
assert.doesNotMatch(buildStderr, /Import trace for requested module/); // This is Next.js/Webpack speech for "something is off"
}

// Assert that all static components stay static and all dynamic components stay dynamic
assert.match(buildStdout, /○ \/client-component/);
Expand Down
1 change: 1 addition & 0 deletions packages/nextjs/src/config/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,7 @@ export type WebpackConfigObject = {
output: { filename: string; path: string };
target: string;
context: string;
ignoreWarnings?: { module?: RegExp }[]; // Note: The interface for `ignoreWarnings` is larger but we only need this. See https://webpack.js.org/configuration/other-options/#ignorewarnings
resolve?: {
modules?: string[];
alias?: { [key: string]: string | boolean };
Expand Down
13 changes: 13 additions & 0 deletions packages/nextjs/src/config/webpack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ export function constructWebpackConfigFunction(
// Add a loader which will inject code that sets global values
addValueInjectionLoader(newConfig, userNextConfig, userSentryOptions, buildContext);

if (isServer) {
addOtelWarningIgnoreRule(newConfig);
}

let pagesDirPath: string | undefined;
const maybePagesDirPath = path.join(projectDir, 'pages');
const maybeSrcPagesDirPath = path.join(projectDir, 'src', 'pages');
Expand Down Expand Up @@ -726,3 +730,12 @@ function getRequestAsyncStorageModuleLocation(

return undefined;
}

function addOtelWarningIgnoreRule(newConfig: WebpackConfigObjectWithModuleRules): void {
const ignoreRule = { module: /@opentelemetry\/instrumentation/ };
if (newConfig.ignoreWarnings === undefined) {
newConfig.ignoreWarnings = [ignoreRule];
} else if (Array.isArray(newConfig.ignoreWarnings)) {
newConfig.ignoreWarnings.push(ignoreRule);
}
}