Skip to content

fix(nextjs): Use globalThis for code injection #13132

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
Lms24 merged 2 commits into from
Jul 31, 2024
Merged

fix(nextjs): Use globalThis for code injection #13132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53a9521
fix: Use `globalThis` for code injection
timfish Jul 31, 2024
bd4c297
Fix test
timfish Jul 31, 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
10 changes: 3 additions & 7 deletions packages/nextjs/src/config/loaders/valueInjectionLoader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,9 @@ export default function valueInjectionLoader(this: LoaderThis<LoaderOptions>, us
// We do not want to cache injected values across builds
this.cacheable(false);

// Define some global proxy that works on server and on the browser.
let injectedCode =
'var _sentryCollisionFreeGlobalObject = typeof window != "undefined" ? window : typeof global != "undefined" ? global : typeof self != "undefined" ? self : {};\n';

Object.entries(values).forEach(([key, value]) => {
injectedCode += `_sentryCollisionFreeGlobalObject["${key}"] = ${JSON.stringify(value)};\n`;
});
const injectedCode = Object.entries(values)
.map(([key, value]) => `globalThis["${key}"] = ${JSON.stringify(value)};`)
.join('\n');

return `${injectedCode}\n${userCode}`;
}
16 changes: 2 additions & 14 deletions packages/sveltekit/src/vite/injectGlobalValues.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,9 @@ export function getGlobalValueInjectionCode(globalSentryValues: GlobalSentryValu
return '';
}

const sentryGlobal = '_global';

const globalCode = `var ${sentryGlobal} =
typeof window !== 'undefined' ?
window :
typeof globalThis !== 'undefined' ?
globalThis :
typeof global !== 'undefined' ?
global :
typeof self !== 'undefined' ?
self :
{};`;
const injectedValuesCode = Object.entries(globalSentryValues)
.map(([key, value]) => `${sentryGlobal}["${key}"] = ${JSON.stringify(value)};`)
.map(([key, value]) => `globalThis["${key}"] = ${JSON.stringify(value)};`)
.join('\n');

return `${globalCode}\n${injectedValuesCode}\n`;
return `${injectedValuesCode}\n`;
}
14 changes: 2 additions & 12 deletions packages/sveltekit/test/vite/injectGlobalValues.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,8 @@ describe('getGlobalValueInjectionCode', () => {
something: 'else',
__sentry_sveltekit_output_dir: '.svelte-kit/output',
});
expect(injectionCode).toEqual(`var _global =
typeof window !== 'undefined' ?
window :
typeof globalThis !== 'undefined' ?
globalThis :
typeof global !== 'undefined' ?
global :
typeof self !== 'undefined' ?
self :
{};
_global["something"] = "else";
_global["__sentry_sveltekit_output_dir"] = ".svelte-kit/output";
expect(injectionCode).toEqual(`globalThis["something"] = "else";
globalThis["__sentry_sveltekit_output_dir"] = ".svelte-kit/output";
`);

// Check that the code above is in fact valid and works as expected
Expand Down