feat: Rename ESM loader hooks to import and loader (#11498)

Author: Luca Forstner

dev-packages/e2e-tests/test-applications/esm-loader-node-express-app/package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "start": "node --import=@sentry/node/register src/app.mjs",
+    "start": "node --import=@sentry/node/import-hook src/app.mjs",
     "clean": "npx rimraf node_modules,pnpm-lock.yaml",
     "test:build": "pnpm install",
     "test:assert": "playwright test"

dev-packages/rollup-utils/code/otelEsmRegisterLoaderTemplate.js renamed to dev-packages/rollup-utils/code/otelEsmImportHookTemplate.js

@@ -1,2 +1,2 @@
-import { getFormat, getSource, load, resolve } from '@sentry/node/register';
+import { getFormat, getSource, load, resolve } from '@sentry/node/loader-hook';
 export { getFormat, getSource, load, resolve };

dev-packages/rollup-utils/code/otelEsmHooksLoaderTemplate.js renamed to dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js

@@ -0,0 +1 @@
+import '@sentry/node/import-hook';

dev-packages/rollup-utils/code/sentryNodeEsmHooksLoaderTemplate.js

@@ -151,23 +151,23 @@ export function makeOtelLoaders(outputFolder, hookVariant) {
     throw new Error('hookVariant is neither "otel" nor "sentry-node". Pick one.');
   }
 
-  const expectedRegisterLoaderLocation = `${outputFolder}/register.mjs`;
+  const expectedRegisterLoaderLocation = `${outputFolder}/import-hook.mjs`;
   const foundRegisterLoaderExport = Object.keys(packageDotJSON.exports ?? {}).some(key => {
     return packageDotJSON?.exports?.[key]?.import?.default === expectedRegisterLoaderLocation;
   });
   if (!foundRegisterLoaderExport) {
     throw new Error(
-      `You used the makeOtelLoaders() rollup utility without specifying the register loader inside \`exports[something].import.default\`. Please add "${expectedRegisterLoaderLocation}" as a value there (maybe check for typos - it needs to be "${expectedRegisterLoaderLocation}" exactly).`,
+      `You used the makeOtelLoaders() rollup utility without specifying the import hook inside \`exports[something].import.default\`. Please add "${expectedRegisterLoaderLocation}" as a value there (maybe check for typos - it needs to be "${expectedRegisterLoaderLocation}" exactly).`,
     );
   }
 
-  const expectedHooksLoaderLocation = `${outputFolder}/hook.mjs`;
+  const expectedHooksLoaderLocation = `${outputFolder}/loader-hook.mjs`;
   const foundHookLoaderExport = Object.keys(packageDotJSON.exports ?? {}).some(key => {
     return packageDotJSON?.exports?.[key]?.import?.default === expectedHooksLoaderLocation;
   });
   if (!foundHookLoaderExport) {
     throw new Error(
-      `You used the makeOtelLoaders() rollup utility without specifying the hook loader inside \`exports[something].import.default\`. Please add "${expectedHooksLoaderLocation}" as a value there (maybe check for typos - it needs to be "${expectedHooksLoaderLocation}" exactly).`,
+      `You used the makeOtelLoaders() rollup utility without specifying the loader hook inside \`exports[something].import.default\`. Please add "${expectedHooksLoaderLocation}" as a value there (maybe check for typos - it needs to be "${expectedHooksLoaderLocation}" exactly).`,
     );
   }
 
@@ -190,25 +190,25 @@ export function makeOtelLoaders(outputFolder, hookVariant) {
       input: path.join(
         __dirname,
         'code',
-        hookVariant === 'otel' ? 'otelEsmRegisterLoaderTemplate.js' : 'sentryNodeEsmRegisterLoaderTemplate.js',
+        hookVariant === 'otel' ? 'otelEsmImportHookTemplate.js' : 'sentryNodeEsmImportHookTemplate.js',
       ),
-      external: ['@opentelemetry/instrumentation/hook.mjs', '@sentry/node/register'],
+      external: /.*/,
       output: {
         format: 'esm',
-        file: path.join(outputFolder, 'register.mjs'),
+        file: path.join(outputFolder, 'import-hook.mjs'),
       },
     },
     // --loader hook
     {
       input: path.join(
         __dirname,
         'code',
-        hookVariant === 'otel' ? 'otelEsmHooksLoaderTemplate.js' : 'sentryNodeEsmHooksLoaderTemplate.js',
+        hookVariant === 'otel' ? 'otelEsmLoaderHookTemplate.js' : 'sentryNodeEsmLoaderHookTemplate.js',
       ),
-      external: ['@opentelemetry/instrumentation/hook.mjs', '@sentry/node/hook'],
+      external: /.*/,
       output: {
         format: 'esm',
-        file: path.join(outputFolder, 'hook.mjs'),
+        file: path.join(outputFolder, 'loader-hook.mjs'),
       },
     },
   ]);

dev-packages/rollup-utils/code/sentryNodeEsmRegisterLoaderTemplate.js renamed to dev-packages/rollup-utils/code/sentryNodeEsmImportHookTemplate.js

@@ -42,14 +42,14 @@
       "require": "./build/cjs/integration/middleware/index.js",
       "types": "./build/types/integration/middleware/index.types.d.ts"
     },
-    "./register": {
+    "./import": {
       "import": {
-        "default": "./build/register.mjs"
+        "default": "./build/import-hook.mjs"
       }
     },
-    "./hook": {
+    "./loader": {
       "import": {
-        "default": "./build/hook.mjs"
+        "default": "./build/loader-hook.mjs"
       }
     }
   },

dev-packages/rollup-utils/code/sentryNodeEsmLoaderHookTemplate.js

@@ -25,14 +25,14 @@
         "default": "./build/npm/cjs/index.js"
       }
     },
-    "./register": {
+    "./import": {
       "import": {
-        "default": "./build/register.mjs"
+        "default": "./build/import-hook.mjs"
       }
     },
-    "./hook": {
+    "./loader": {
       "import": {
-        "default": "./build/hook.mjs"
+        "default": "./build/loader-hook.mjs"
       }
     }
   },

dev-packages/rollup-utils/npmHelpers.mjs

@@ -26,14 +26,14 @@
         "default": "./build/cjs/index.js"
       }
     },
-    "./register": {
+    "./import": {
       "import": {
-        "default": "./build/register.mjs"
+        "default": "./build/import-hook.mjs"
       }
     },
-    "./hook": {
+    "./loader": {
       "import": {
-        "default": "./build/hook.mjs"
+        "default": "./build/loader-hook.mjs"
       }
     }
   },