From 8782af8dc7d9addf32a80dece5f14072af9cdc56 Mon Sep 17 00:00:00 2001
From: Sigrid Huemer <32902192+s1gr1d@users.noreply.github.com>
Date: Wed, 16 Oct 2024 17:07:03 +0200
Subject: [PATCH] test(nuxt): Use `sentry.server.config.ts` in E2E tests
 (#13999)

The E2E tests still used an `instrument` file in the `public` folder
(which is not the way to setup the SDK anymore) because
`import-in-the-middle/hook.mjs` was not available and threw an error. To
be able to properly test the setup with `sentry.server.config.ts`, a
function was added that copies the `import-in-the-middle` folder to the
build output to include all files.
---
 .../e2e-tests/test-applications/nuxt-3/copyIITM.bash      | 7 +++++++
 .../e2e-tests/test-applications/nuxt-3/nuxt.config.ts     | 6 ++++++
 .../e2e-tests/test-applications/nuxt-3/package.json       | 8 ++++++--
 .../test-applications/nuxt-3/playwright.config.ts         | 2 +-
 .../instrument.server.mjs => sentry.server.config.ts}     | 0
 .../e2e-tests/test-applications/nuxt-4/copyIITM.bash      | 7 +++++++
 .../e2e-tests/test-applications/nuxt-4/nuxt.config.ts     | 6 ++++++
 .../e2e-tests/test-applications/nuxt-4/package.json       | 8 ++++++--
 .../test-applications/nuxt-4/playwright.config.ts         | 2 +-
 .../instrument.server.mjs => sentry.server.config.ts}     | 0
 .../test-applications/nuxt-4/tests/errors.client.test.ts  | 2 +-
 .../test-applications/nuxt-4/tests/tracing.client.test.ts | 2 +-
 12 files changed, 42 insertions(+), 8 deletions(-)
 create mode 100644 dev-packages/e2e-tests/test-applications/nuxt-3/copyIITM.bash
 rename dev-packages/e2e-tests/test-applications/nuxt-3/{public/instrument.server.mjs => sentry.server.config.ts} (100%)
 create mode 100644 dev-packages/e2e-tests/test-applications/nuxt-4/copyIITM.bash
 rename dev-packages/e2e-tests/test-applications/nuxt-4/{public/instrument.server.mjs => sentry.server.config.ts} (100%)

diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/copyIITM.bash b/dev-packages/e2e-tests/test-applications/nuxt-3/copyIITM.bash
new file mode 100644
index 000000000000..0e04d001c968
--- /dev/null
+++ b/dev-packages/e2e-tests/test-applications/nuxt-3/copyIITM.bash
@@ -0,0 +1,7 @@
+# This script copies the `import-in-the-middle` content of the E2E test project root `node_modules` to the build output `node_modules`
+# For some reason, some files are missing in the output (like `hook.mjs`) and this is not reproducible in external, standalone projects.
+#
+# Things we tried (that did not fix the problem):
+# - Adding a resolution for `@vercel/nft` v0.27.0 (this worked in the standalone project)
+# - Also adding `@vercel/nft` v0.27.0 to pnpm `peerDependencyRules`
+cp -r node_modules/.pnpm/import-in-the-middle@1.*/node_modules/import-in-the-middle .output/server/node_modules/import-in-the-middle
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/nuxt.config.ts b/dev-packages/e2e-tests/test-applications/nuxt-3/nuxt.config.ts
index 0fcccd560af9..87e046ed39e9 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-3/nuxt.config.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-3/nuxt.config.ts
@@ -11,4 +11,10 @@ export default defineNuxtConfig({
       },
     },
   },
+  nitro: {
+    rollupConfig: {
+      // @sentry/... is set external to prevent bundling all of Sentry into the `runtime.mjs` file in the build output
+      external: [/@sentry\/.*/],
+    },
+  },
 });
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/package.json b/dev-packages/e2e-tests/test-applications/nuxt-3/package.json
index 7173aeaa4ce5..079beb8bfc86 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-3/package.json
+++ b/dev-packages/e2e-tests/test-applications/nuxt-3/package.json
@@ -3,10 +3,11 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "build": "nuxt build",
+    "build": "nuxt build && bash ./copyIITM.bash",
     "dev": "nuxt dev",
     "generate": "nuxt generate",
-    "preview": "NODE_OPTIONS='--import ./public/instrument.server.mjs' nuxt preview",
+    "preview": "nuxt preview",
+    "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
     "clean": "npx nuxi cleanup",
     "test": "playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
@@ -20,5 +21,8 @@
     "@nuxt/test-utils": "^3.14.1",
     "@playwright/test": "^1.44.1",
     "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "overrides": {
+    "@vercel/nft": "0.27.4"
   }
 }
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts b/dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts
index d1094993131d..aa1ff8e9743c 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-3/playwright.config.ts
@@ -12,7 +12,7 @@ const nuxtConfigOptions: ConfigOptions = {
  *  Like this: import { expect, test } from '@nuxt/test-utils/playwright' */
 
 const config = getPlaywrightConfig({
-  startCommand: `pnpm preview`,
+  startCommand: `pnpm start`,
   use: { ...nuxtConfigOptions },
 });
 
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/public/instrument.server.mjs b/dev-packages/e2e-tests/test-applications/nuxt-3/sentry.server.config.ts
similarity index 100%
rename from dev-packages/e2e-tests/test-applications/nuxt-3/public/instrument.server.mjs
rename to dev-packages/e2e-tests/test-applications/nuxt-3/sentry.server.config.ts
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/copyIITM.bash b/dev-packages/e2e-tests/test-applications/nuxt-4/copyIITM.bash
new file mode 100644
index 000000000000..0e04d001c968
--- /dev/null
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/copyIITM.bash
@@ -0,0 +1,7 @@
+# This script copies the `import-in-the-middle` content of the E2E test project root `node_modules` to the build output `node_modules`
+# For some reason, some files are missing in the output (like `hook.mjs`) and this is not reproducible in external, standalone projects.
+#
+# Things we tried (that did not fix the problem):
+# - Adding a resolution for `@vercel/nft` v0.27.0 (this worked in the standalone project)
+# - Also adding `@vercel/nft` v0.27.0 to pnpm `peerDependencyRules`
+cp -r node_modules/.pnpm/import-in-the-middle@1.*/node_modules/import-in-the-middle .output/server/node_modules/import-in-the-middle
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/nuxt.config.ts b/dev-packages/e2e-tests/test-applications/nuxt-4/nuxt.config.ts
index 90f26a8ea6b6..c00ba0d5d9ed 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-4/nuxt.config.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/nuxt.config.ts
@@ -13,4 +13,10 @@ export default defineNuxtConfig({
       },
     },
   },
+  nitro: {
+    rollupConfig: {
+      // @sentry/... is set external to prevent bundling all of Sentry into the `runtime.mjs` file in the build output
+      external: [/@sentry\/.*/],
+    },
+  },
 });
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/package.json b/dev-packages/e2e-tests/test-applications/nuxt-4/package.json
index 14e28d852c88..5e7bcd57af0e 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-4/package.json
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/package.json
@@ -3,10 +3,11 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "build": "nuxt build",
+    "build": "nuxt build && bash ./copyIITM.bash",
     "dev": "nuxt dev",
     "generate": "nuxt generate",
-    "preview": "NODE_OPTIONS='--import ./public/instrument.server.mjs' nuxt preview",
+    "preview": "nuxt preview",
+    "start": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
     "clean": "npx nuxi cleanup",
     "test": "playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
@@ -20,5 +21,8 @@
     "@nuxt/test-utils": "^3.14.2",
     "@playwright/test": "^1.44.1",
     "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "overrides": {
+    "@vercel/nft": "0.27.4"
   }
 }
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/playwright.config.ts b/dev-packages/e2e-tests/test-applications/nuxt-4/playwright.config.ts
index d1094993131d..aa1ff8e9743c 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-4/playwright.config.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/playwright.config.ts
@@ -12,7 +12,7 @@ const nuxtConfigOptions: ConfigOptions = {
  *  Like this: import { expect, test } from '@nuxt/test-utils/playwright' */
 
 const config = getPlaywrightConfig({
-  startCommand: `pnpm preview`,
+  startCommand: `pnpm start`,
   use: { ...nuxtConfigOptions },
 });
 
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/public/instrument.server.mjs b/dev-packages/e2e-tests/test-applications/nuxt-4/sentry.server.config.ts
similarity index 100%
rename from dev-packages/e2e-tests/test-applications/nuxt-4/public/instrument.server.mjs
rename to dev-packages/e2e-tests/test-applications/nuxt-4/sentry.server.config.ts
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/tests/errors.client.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-4/tests/errors.client.test.ts
index 1177218aebec..c887e255fe57 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-4/tests/errors.client.test.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/tests/errors.client.test.ts
@@ -1,4 +1,4 @@
-import { expect, test } from '@nuxt/test-utils/playwright';
+import { expect, test } from '@playwright/test';
 import { waitForError } from '@sentry-internal/test-utils';
 
 test.describe('client-side errors', async () => {
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.client.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.client.test.ts
index 871d8b19513c..9119e279e491 100644
--- a/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.client.test.ts
+++ b/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.client.test.ts
@@ -1,4 +1,4 @@
-import { expect, test } from '@nuxt/test-utils/playwright';
+import { expect, test } from '@playwright/test';
 import { waitForTransaction } from '@sentry-internal/test-utils';
 import type { Span } from '@sentry/nuxt';