feat(nuxt): Make dynamic import() wrapping default#13958

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
s1gr1d merged 5 commits into from
Oct 17, 2024
Merged

feat(nuxt): Make dynamic import() wrapping default #13958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
200ba3a
feat(nuxt): Make dynamic `import()` wrapping default
s1gr1d Oct 11, 2024
4ffcaa8
delete --import
s1gr1d Oct 11, 2024
3c1829f
fix dev mode
s1gr1d Oct 14, 2024
aa74914
fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)
s1gr1d Oct 15, 2024
f0577d2
rename option
s1gr1d Oct 16, 2024
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
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nuxt-3/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
"dev": "nuxt dev",
"generate": "nuxt generate",
"preview": "nuxt preview",
"start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
"start": "node .output/server/index.mjs",
"clean": "npx nuxi cleanup",
"test": "playwright test",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nuxt-4/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
"dev": "nuxt dev",
"generate": "nuxt generate",
"preview": "nuxt preview",
"start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
"start": "node .output/server/index.mjs",
"clean": "npx nuxi cleanup",
"test": "playwright test",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down
15 changes: 9 additions & 6 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
debug?: boolean;

/**
* Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
* However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
* Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
* necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
*
* If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
* If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
* server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
* to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
*
* **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
* **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
* This would initialize Sentry twice on the server-side and this leads to unexpected issues.
*
* @default false
* @default true
*/
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

/**
* Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down
46 changes: 31 additions & 15 deletions packages/nuxt/src/module.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
},
},
defaults: {},
setup(moduleOptions, nuxt) {
setup(moduleOptionsParam, nuxt) {
const moduleOptions = {
...moduleOptionsParam,
dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
};

const moduleDirResolver = createResolver(import.meta.url);
const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
const serverConfigFile = findDefaultSdkInitFile('server');

if (serverConfigFile) {
// Inject the server-side Sentry config file with a side effect import
addPluginTemplate({
mode: 'server',
filename: 'sentry-server-config.mjs',
getContents: () =>
`import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
'import { defineNuxtPlugin } from "#imports"\n' +
'export default defineNuxtPlugin(() => {})',
});
if (moduleOptions.dynamicImportForServerEntry === false) {
// Inject the server-side Sentry config file with a side effect import
addPluginTemplate({
mode: 'server',
filename: 'sentry-server-config.mjs',
getContents: () =>
`import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
'import { defineNuxtPlugin } from "#imports"\n' +
'export default defineNuxtPlugin(() => {})',
});
}

addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
}
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

nuxt.hooks.hook('nitro:init', nitro => {
if (serverConfigFile && serverConfigFile.includes('.server.config')) {
addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
if (moduleOptions.dynamicImportForServerEntry === false) {
addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

if (moduleOptions.experimental_basicServerTracing) {
addSentryTopImport(moduleOptions, nitro);
} else {
if (moduleOptions.debug) {
const serverDirResolver = createResolver(nitro.options.output.serverDir);
const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
);
});
}
} else {
addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

if (moduleOptions.debug) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.log(
'[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
);
});
}
}
}
});
Expand Down
57 changes: 3 additions & 54 deletions packages/nuxt/src/vite/addServerConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
});
}

/**
* Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
* This is necessary for environments where modifying the node option `--import` is not possible.
* However, only limited tracing instrumentation is supported when doing this.
*/
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
nitro.hooks.hook('close', () => {
// other presets ('node-server' or 'vercel') have an index.mjs
const presetsWithServerFile = ['netlify'];
const entryFileName =
typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
? nitro.options.rollupConfig?.output.entryFileNames
: presetsWithServerFile.includes(nitro.options.preset)
? 'server.mjs'
: 'index.mjs';

const serverDirResolver = createResolver(nitro.options.output.serverDir);
const entryFilePath = serverDirResolver.resolve(entryFileName);

try {
fs.readFile(entryFilePath, 'utf8', (err, data) => {
const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
if (moduleOptions.debug) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
);
});
}
});
});
} catch (err) {
if (moduleOptions.debug) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
err,
);
});
}
}
});
}

/**
* This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
* and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
: resolution.id
// Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
.concat(SENTRY_WRAPPED_ENTRY)
.concat(
exportedFunctions?.length
? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
: '',
);
.concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
.concat(QUERY_END_INDICATOR);
}
return null;
},
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
// `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
`import(${JSON.stringify(entryId)});\n` +
// By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
"import 'import-in-the-middle/hook.mjs'\n" +
"import 'import-in-the-middle/hook.mjs';\n" +
`${reExportedFunctions}\n`
);
}
Expand Down
7 changes: 4 additions & 3 deletions packages/nuxt/src/vite/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
return match && match[1]
? match[1]
.split(',')
.filter(param => param !== '' && param !== 'default')
.filter(param => param !== '')
// Sanitize, as code could be injected with another rollup plugin
.map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
: [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
return functionNames.reduce(
(functionsCode, currFunctionName) =>
functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
` const res = await import(${JSON.stringify(entryId)});\n` +
` return res.${currFunctionName}.call(this, ...args);\n` +
'}\n',
'}\n' +
`export { reExport as ${currFunctionName} };\n`,
),
'',
);
Expand Down
29 changes: 25 additions & 4 deletions packages/nuxt/test/vite/utils.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
it('strips the Sentry query part from the path', () => {
const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
const result = removeSentryQueryFromPath(url);
const result2 = removeSentryQueryFromPath(url2);
expect(result).toBe('/example/path');
expect(result2).toBe('/example/path');
});

it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
it.each([
[`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
[`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
[`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
[
`${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
const result2 = constructFunctionReExport(query2, entryId);

const expected = `
export async function foo(...args) {
async function reExport(...args) {
const res = await import("./module");
return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
const res = await import("./module");
return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
expect(result.trim()).toBe(expected.trim());
expect(result2.trim()).toBe(expected.trim());
});

it('constructs re-export code for a "default" query parameters and entry ID', () => {
const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
const entryId = './index';
const result = constructFunctionReExport(query, entryId);

const expected = `
async function reExport(...args) {
const res = await import("./index");
return res.default.call(this, ...args);
}
export { reExport as default };
`;
expect(result.trim()).toBe(expected.trim());
});

it('returns an empty string if the query string is empty', () => {
const query = '';
const entryId = './module';
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(nuxt): Make dynamic import() wrapping default#13958

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

s1gr1d
merged 5 commits into

from

Oct 17, 2024
 Merged


feat(nuxt): Make dynamic import() wrapping default
#13958
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
200ba3a

feat(nuxt): Make dynamic `import()` wrapping default


s1gr1d Oct 11, 2024
4ffcaa8

delete --import


s1gr1d Oct 11, 2024
3c1829f

fix dev mode


s1gr1d Oct 14, 2024
aa74914

fix(nuxt): Re-export 'default' exports with rollup plugin (#13984)


s1gr1d Oct 15, 2024
f0577d2

rename option


s1gr1d Oct 16, 2024

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


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-3/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/nuxt-4/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
 "dev": "nuxt dev",
 "generate": "nuxt generate",
 "preview": "nuxt preview",
 "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
 "start": "node .output/server/index.mjs",
 "clean": "npx nuxi cleanup",
 "test": "playwright test",
 "test:build": "pnpm install && npx playwright install && pnpm build",
Expand Down

15 changes: 9 additions & 6 deletions
packages/nuxt/src/common/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,19 @@ export type SentryNuxtModuleOptions = {
 debug?: boolean;

 /**
 * Enabling basic server tracing can be used for environments where modifying the node option `--import` is not possible.
 * However, enabling this option only supports limited tracing instrumentation. Only http traces will be collected (but no database-specific traces etc.).
 * Wraps the server entry file with a dynamic `import()`. This will make it possible to preload Sentry and register
 * necessary hooks before other code runs. (Node docs: https://nodejs.org/api/module.html#enabling)
 *
 * If this option is `true`, the Sentry SDK will import the Sentry server config at the top of the server entry file to load the SDK on the server.
 * If this option is `false`, the Sentry SDK won't wrap the server entry file with `import()`. Not wrapping the
 * server entry file will disable Sentry on the server-side. When you set this option to `false`, make sure
 * to add the Sentry server config with the node `--import` CLI flag to enable Sentry on the server-side.
 *
 * **DO NOT** enable this option if you've already added the node option `--import` in your node start script. This would initialize Sentry twice on the server-side and leads to unexpected issues.
 * **DO NOT** add the node CLI flag `--import` in your node start script, when `dynamicImportForServerEntry` is set to `true` (default).
 * This would initialize Sentry twice on the server-side and this leads to unexpected issues.
 *
 * @default false
 * @default true
 */
experimental_basicServerTracing?: boolean;
dynamicImportForServerEntry?: boolean;

 /**
 * Options to be passed directly to the Sentry Rollup Plugin (`@sentry/rollup-plugin`) and Sentry Vite Plugin (`@sentry/vite-plugin`) that ship with the Sentry Nuxt SDK.
Expand Down

46 changes: 31 additions & 15 deletions
packages/nuxt/src/module.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as path from 'path';
import { addPlugin, addPluginTemplate, addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
import { consoleSandbox } from '@sentry/utils';
import type { SentryNuxtModuleOptions } from './common/types';
import { addSentryTopImport, addServerConfigToBuild } from './vite/addServerConfig';
import { addDynamicImportEntryFileWrapper, addServerConfigToBuild } from './vite/addServerConfig';
import { setupSourceMaps } from './vite/sourceMaps';
import { findDefaultSdkInitFile } from './vite/utils';

Expand All@@ -17,7 +17,12 @@ export default defineNuxtModule<ModuleOptions>({
 },
 },
 defaults: {},
 setup(moduleOptions, nuxt) {
 setup(moduleOptionsParam, nuxt) {
 const moduleOptions = {
 ...moduleOptionsParam,
 dynamicImportForServerEntry: moduleOptionsParam.dynamicImportForServerEntry !== false, // default: true
 };

 const moduleDirResolver = createResolver(import.meta.url);
 const buildDirResolver = createResolver(nuxt.options.buildDir);

Expand DownExpand Up@@ -48,15 +53,17 @@ export default defineNuxtModule<ModuleOptions>({
 const serverConfigFile = findDefaultSdkInitFile('server');

 if (serverConfigFile) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 if (moduleOptions.dynamicImportForServerEntry === false) {
 // Inject the server-side Sentry config file with a side effect import
 addPluginTemplate({
 mode: 'server',
 filename: 'sentry-server-config.mjs',
 getContents: () =>
 `import "${buildDirResolver.resolve(`/${serverConfigFile}`)}"\n` +
 'import { defineNuxtPlugin } from "#imports"\n' +
 'export default defineNuxtPlugin(() => {})',
 });
 }

 addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 }
Expand All@@ -67,11 +74,9 @@ export default defineNuxtModule<ModuleOptions>({

 nuxt.hooks.hook('nitro:init', nitro => {
 if (serverConfigFile && serverConfigFile.includes('.server.config')) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);
 if (moduleOptions.dynamicImportForServerEntry === false) {
 addServerConfigToBuild(moduleOptions, nuxt, nitro, serverConfigFile);

 if (moduleOptions.experimental_basicServerTracing) {
 addSentryTopImport(moduleOptions, nitro);
 } else {
 if (moduleOptions.debug) {
 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const serverConfigPath = serverDirResolver.resolve('sentry.server.config.mjs');
Expand All@@ -86,6 +91,17 @@ export default defineNuxtModule<ModuleOptions>({
 );
 });
 }
 } else {
 addDynamicImportEntryFileWrapper(nitro, serverConfigFile);

 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 '[Sentry] Wrapping the server entry file with a dynamic `import()`, so Sentry can be preloaded before the server initializes.',
 );
 });
 }
 }
 }
 });
Expand Down

57 changes: 3 additions & 54 deletions
packages/nuxt/src/vite/addServerConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,54 +74,6 @@ export function addServerConfigToBuild(
 });
}

/**
 * Adds the Sentry server config import at the top of the server entry file to load the SDK on the server.
 * This is necessary for environments where modifying the node option `--import` is not possible.
 * However, only limited tracing instrumentation is supported when doing this.
 */
export function addSentryTopImport(moduleOptions: SentryNuxtModuleOptions, nitro: Nitro): void {
 nitro.hooks.hook('close', () => {
 // other presets ('node-server' or 'vercel') have an index.mjs
 const presetsWithServerFile = ['netlify'];
 const entryFileName =
 typeof nitro.options.rollupConfig?.output.entryFileNames === 'string'
 ? nitro.options.rollupConfig?.output.entryFileNames
 : presetsWithServerFile.includes(nitro.options.preset)
 ? 'server.mjs'
 : 'index.mjs';

 const serverDirResolver = createResolver(nitro.options.output.serverDir);
 const entryFilePath = serverDirResolver.resolve(entryFileName);

 try {
 fs.readFile(entryFilePath, 'utf8', (err, data) => {
 const updatedContent = `import './${SERVER_CONFIG_FILENAME}.mjs';\n${data}`;

 fs.writeFile(entryFilePath, updatedContent, 'utf8', () => {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.log(
 `[Sentry] Successfully added the Sentry import to the server entry file "\`${entryFilePath}\`"`,
 );
 });
 }
 });
 });
 } catch (err) {
 if (moduleOptions.debug) {
 consoleSandbox(() => {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry] An error occurred when trying to add the Sentry import to the server entry file "\`${entryFilePath}\`":`,
 err,
 );
 });
 }
 }
 });
}

/**
 * This function modifies the Rollup configuration to include a plugin that wraps the entry file with a dynamic import (`import()`)
 * and adds the Sentry server config with the static `import` declaration.
Expand DownExpand Up@@ -187,11 +139,8 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 : resolution.id
 // Concatenates the query params to mark the file (also attaches names of re-exports - this is needed for serverless functions to re-export the handler)
 .concat(SENTRY_WRAPPED_ENTRY)
 .concat(
 exportedFunctions?.length
 ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')).concat(QUERY_END_INDICATOR)
 : '',
 );
 .concat(exportedFunctions?.length ? SENTRY_FUNCTIONS_REEXPORT.concat(exportedFunctions.join(',')) : '')
 .concat(QUERY_END_INDICATOR);
 }
 return null;
 },
Expand All@@ -211,7 +160,7 @@ function wrapEntryWithDynamicImport(resolvedSentryConfigPath: string): InputPlug
 // `import()` can be used for any code that should be run after the hooks are registered (https://nodejs.org/api/module.html#enabling)
 `import(${JSON.stringify(entryId)});\n` +
 // By importing "import-in-the-middle/hook.mjs", we can make sure this file wil be included, as not all node builders are including files imported with `module.register()`.
 "import 'import-in-the-middle/hook.mjs'\n" +
 "import 'import-in-the-middle/hook.mjs';\n" +
 `${reExportedFunctions}\n`
 );
 }
Expand Down

7 changes: 4 additions & 3 deletions
packages/nuxt/src/vite/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ export function extractFunctionReexportQueryParameters(query: string): string[]
 return match && match[1]
 ? match[1]
 .split(',')
 .filter(param => param !== '' && param !== 'default')
 .filter(param => param !== '')
 // Sanitize, as code could be injected with another rollup plugin
 .map((str: string) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
 : [];
Expand All@@ -72,10 +72,11 @@ export function constructFunctionReExport(pathWithQuery: string, entryId: string
 return functionNames.reduce(
 (functionsCode, currFunctionName) =>
 functionsCode.concat(
`export async function ${currFunctionName}(...args) {\n` +
'async function reExport(...args) {\n' +
 ` const res = await import(${JSON.stringify(entryId)});\n` +
 ` return res.${currFunctionName}.call(this, ...args);\n` +
 '}\n',
 '}\n' +
 `export { reExport as ${currFunctionName} };\n`,
 ),
 '',
 );
Expand Down

29 changes: 25 additions & 4 deletions
packages/nuxt/test/vite/utils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,8 +71,11 @@ describe('findDefaultSdkInitFile', () => {
describe('removeSentryQueryFromPath', () => {
 it('strips the Sentry query part from the path', () => {
 const url = `/example/path${SENTRY_WRAPPED_ENTRY}${SENTRY_FUNCTIONS_REEXPORT}foo,${QUERY_END_INDICATOR}`;
 const url2 = `/example/path${SENTRY_WRAPPED_ENTRY}${QUERY_END_INDICATOR}`;
 const result = removeSentryQueryFromPath(url);
 const result2 = removeSentryQueryFromPath(url2);
 expect(result).toBe('/example/path');
 expect(result2).toBe('/example/path');
 });

 it('returns the same path if the specific query part is not present', () => {
Expand All@@ -85,7 +88,7 @@ describe('removeSentryQueryFromPath', () => {
describe('extractFunctionReexportQueryParameters', () => {
 it.each([
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar']],
 [`${SENTRY_FUNCTIONS_REEXPORT}foo,bar,default${QUERY_END_INDICATOR}`, ['foo', 'bar', 'default']],
 [
 `${SENTRY_FUNCTIONS_REEXPORT}foo,a.b*c?d[e]f(g)h|i\\\\j(){hello},${QUERY_END_INDICATOR}`,
 ['foo', 'a\\.b\\*c\\?d\\[e\\]f\\(g\\)h\\|i\\\\\\\\j\\(\\)\\{hello\\}'],
Expand All@@ -108,18 +111,36 @@ describe('constructFunctionReExport', () => {
 const result2 = constructFunctionReExport(query2, entryId);

 const expected = `
export async function foo(...args) {
async function reExport(...args) {
 const res = await import("./module");
 return res.foo.call(this, ...args);
}
export async function bar(...args) {
export { reExport as foo };
async function reExport(...args) {
 const res = await import("./module");
 return res.bar.call(this, ...args);
}`;
}
export { reExport as bar };
`;
 expect(result.trim()).toBe(expected.trim());
 expect(result2.trim()).toBe(expected.trim());
 });

 it('constructs re-export code for a "default" query parameters and entry ID', () => {
 const query = `${SENTRY_FUNCTIONS_REEXPORT}default${QUERY_END_INDICATOR}}`;
 const entryId = './index';
 const result = constructFunctionReExport(query, entryId);

 const expected = `
async function reExport(...args) {
 const res = await import("./index");
 return res.default.call(this, ...args);
}
export { reExport as default };
`;
 expect(result.trim()).toBe(expected.trim());
 });

 it('returns an empty string if the query string is empty', () => {
 const query = '';
 const entryId = './module';
Expand Down