move to virtual injection file

Author: Lms24

packages/sveltekit/src/server/utils.ts

@@ -1,5 +1,4 @@
 import type { DynamicSamplingContext, StackFrame, TraceparentData } from '@sentry/types';
-import type { InternalGlobal } from '@sentry/utils';
 import {
   baggageHeaderToDynamicSamplingContext,
   basename,
@@ -11,17 +10,7 @@ import {
 import type { RequestEvent } from '@sveltejs/kit';
 
 import { WRAPPED_MODULE_SUFFIX } from '../vite/autoInstrument';
-
-export type GlobalSentryValues = {
-  __sentry_sveltekit_output_dir?: string;
-};
-
-/**
- * Extend the `global` type with custom properties that are
- * injected by the SvelteKit SDK at build time.
- * @see packages/sveltekit/src/vite/sourcemaps.ts
- */
-export type GlobalWithSentryValues = InternalGlobal & GlobalSentryValues;
+import type { GlobalWithSentryValues } from '../vite/injectGLobalValues';
 
 /**
  * Takes a request event and extracts traceparent and DSC data
@@ -71,7 +60,7 @@ export function rewriteFramesIteratee(frame: StackFrame): StackFrame {
     let strippedFilename;
     if (svelteKitBuildOutDir) {
       strippedFilename = filename.replace(
-        new RegExp(`^.*${escapeStringForRegex(join(svelteKitBuildOutDir, 'server'))}`),
+        new RegExp(`^.*${escapeStringForRegex(join(svelteKitBuildOutDir, 'server'))}/`),
         '',
       );
     } else {

packages/sveltekit/src/vite/injectGlobalValues.ts

@@ -0,0 +1,41 @@
+import type { InternalGlobal } from '@sentry/utils';
+
+export type GlobalSentryValues = {
+  __sentry_sveltekit_output_dir?: string;
+};
+
+/**
+ * Extend the `global` type with custom properties that are
+ * injected by the SvelteKit SDK at build time.
+ * @see packages/sveltekit/src/vite/sourcemaps.ts
+ */
+export type GlobalWithSentryValues = InternalGlobal & GlobalSentryValues;
+
+export const VIRTUAL_GLOBAL_VALUES_FILE = '\0sentry-inject-global-values-file';
+
+/**
+ * @returns code that injects @param globalSentryValues into the global scope.
+ */
+export function getGlobalValueInjectionCode(globalSentryValues: GlobalSentryValues): string {
+  if (Object.keys(globalSentryValues).length === 0) {
+    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)};`)
+    .join('\n');
+
+  return `${globalCode}\n${injectedValuesCode}\n`;
+}

packages/sveltekit/src/vite/sourceMaps.ts

@@ -10,9 +10,10 @@ import * as path from 'path';
 import * as sorcery from 'sorcery';
 import type { Plugin } from 'vite';
 
-import type { GlobalSentryValues } from '../server/utils';
 import { WRAPPED_MODULE_SUFFIX } from './autoInstrument';
 import type { SupportedSvelteKitAdapters } from './detectAdapter';
+import type { GlobalSentryValues } from './injectGLobalValues';
+import { getGlobalValueInjectionCode, VIRTUAL_GLOBAL_VALUES_FILE } from './injectGLobalValues';
 import { getAdapterOutputDir, getHooksFileName, loadSvelteConfig } from './svelteConfig';
 
 // sorcery has no types, so these are some basic type definitions:
@@ -73,7 +74,7 @@ export async function makeCustomSentryVitePlugin(options?: CustomSentryVitePlugi
   const sentryPlugin: Plugin = sentryVitePlugin(mergedOptions);
 
   const { debug } = mergedOptions;
-  const { buildStart, resolveId, renderChunk } = sentryPlugin;
+  const { buildStart, renderChunk } = sentryPlugin;
 
   let isSSRBuild = true;
 
@@ -91,7 +92,6 @@ export async function makeCustomSentryVitePlugin(options?: CustomSentryVitePlugi
     // These hooks are copied from the original Sentry Vite plugin.
     // They're mostly responsible for options parsing and release injection.
     buildStart,
-    resolveId,
     renderChunk,
 
     // Modify the config to generate source maps
@@ -107,6 +107,27 @@ export async function makeCustomSentryVitePlugin(options?: CustomSentryVitePlugi
       };
     },
 
+    resolveId: (id, _importer, _ref) => {
+      if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
+        return {
+          id: VIRTUAL_GLOBAL_VALUES_FILE,
+          external: false,
+          moduleSideEffects: true,
+        };
+      }
+      // @ts-ignore - this hook exists on the plugin!
+      return sentryPlugin.resolveId(id, _importer, _ref);
+    },
+
+    load: id => {
+      if (id === VIRTUAL_GLOBAL_VALUES_FILE) {
+        return {
+          code: getGlobalValueInjectionCode(globalSentryValues),
+        };
+      }
+      return null;
+    },
+
     configResolved: config => {
       // The SvelteKit plugins trigger additional builds within the main (SSR) build.
       // We just need a mechanism to upload source maps only once.
@@ -122,10 +143,8 @@ export async function makeCustomSentryVitePlugin(options?: CustomSentryVitePlugi
       const isServerHooksFile = new RegExp(`/${escapeStringForRegex(serverHooksFile)}(.(js|ts|mjs|mts))?`).test(id);
 
       if (isServerHooksFile) {
-        const injectedCode = Object.entries(globalSentryValues)
-          .map(([key, value]) => `globalThis["${key}"] = ${JSON.stringify(value)};`)
-          .join('\n');
-        modifiedCode = `${code}\n${injectedCode}\n`;
+        const globalValuesImport = `; import "${VIRTUAL_GLOBAL_VALUES_FILE}";`;
+        modifiedCode = `${code}\n${globalValuesImport}\n`;
       }
       // @ts-ignore - this hook exists on the plugin!
       return sentryPlugin.transform(modifiedCode, id);

packages/sveltekit/test/vite/injectGlobalValues.test.ts

@@ -0,0 +1,34 @@
+import { getGlobalValueInjectionCode } from '../../src/vite/injectGlobalValues';
+
+describe('getGlobalValueInjectionCode', () => {
+  it('returns code that injects values into the global object', () => {
+    const injectionCode = getGlobalValueInjectionCode({
+      // @ts-ignore - just want to test this with multiple values
+      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";
+`);
+
+    // Check that the code above is in fact valid and works as expected
+    // The return value of eval here is the value of the last expression in the code
+    expect(eval(`${injectionCode}`)).toEqual('.svelte-kit/output');
+
+    delete globalThis.__sentry_sveltekit_output_dir;
+  });
+
+  it('returns empty string if no values are passed', () => {
+    expect(getGlobalValueInjectionCode({})).toEqual('');
+  });
+});

packages/sveltekit/test/vite/sourceMaps.test.ts

@@ -58,7 +58,7 @@ describe('makeCustomSentryVitePlugin()', () => {
       const plugin = await makeCustomSentryVitePlugin();
       // @ts-ignore this function exists!
       const transformedCode = await plugin.transform('foo', '/src/hooks.server.ts');
-      const expectedtransformedCode = 'foo\nglobalThis["__sentry_sveltekit_output_dir"] = ".svelte-kit/output";\n';
+      const expectedtransformedCode = 'foo\n; import "\0sentry-inject-global-values-file";\n';
       expect(mockedSentryVitePlugin.transform).toHaveBeenCalledWith(expectedtransformedCode, '/src/hooks.server.ts');
       expect(transformedCode).toEqual(expectedtransformedCode);
     });