add sdk metadata test

Author: s1gr1d

packages/nuxt/package.json

@@ -41,10 +41,8 @@
     "@nuxt/kit": "^3.12.2"
   },
   "devDependencies": {
-    "@babel/types": "7.20.7",
     "@nuxt/module-builder": "0.8.0",
-    "nuxt": "^3.12.2",
-    "vite": "^5.0.10"
+    "nuxt": "^3.12.2"
   },
   "scripts": {
     "build": "run-p build:transpile build:types",

packages/nuxt/src/client/index.ts

@@ -0,0 +1,3 @@
+export * from '@sentry/vue';
+
+export { init } from './sdk';

packages/nuxt/src/client/sdk.ts

@@ -0,0 +1,20 @@
+import { applySdkMetadata } from '@sentry/core';
+import {init as initVue } from '@sentry/vue';
+import type { SentryVueOptions } from '../common/types';
+import type {Options } from '@sentry/types';
+
+/**
+ * Initializes the client-side of the Nuxt SDK
+ *
+ * @param options Configuration options for the SDK.
+ */
+export function init(options: SentryVueOptions): void {
+  const sentryOptions = {
+    ...options,
+  };
+
+  // Type cast to `Options` because Vue has slightly different options, but type is not highly relevant here
+  applySdkMetadata(sentryOptions as Options, 'nuxt', ['nuxt', 'vue']);
+
+  initVue(sentryOptions);
+}

packages/nuxt/src/common/types.ts

@@ -0,0 +1,3 @@
+import type {init} from '@sentry/vue';
+
+export type SentryVueOptions = Parameters<typeof init>[0] & object;

packages/nuxt/src/index.client.ts

@@ -0,0 +1 @@
+export * from './client';

packages/nuxt/src/module/index.ts renamed to packages/nuxt/src/module.ts

@@ -1,7 +1,7 @@
 import { type Resolver, addPlugin, createResolver, defineNuxtModule } from '@nuxt/kit';
-import type * as Sentry from '@sentry/vue';
+import type { SentryVueOptions } from './common/types';
 
-export type ModuleOptions = Parameters<typeof Sentry.init>[0] & object;
+export type ModuleOptions = SentryVueOptions;
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
@@ -22,7 +22,7 @@ export default defineNuxtModule<ModuleOptions>({
     if (resolver) {
       // Ignore because `.resolve` is a valid method of `Resolver`, but because of ts-ignore above, `Resolver` is recognized as any
       // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      addPlugin(resolver.resolve('runtime/client/plugin.js'));
+      addPlugin(resolver.resolve('runtime/plugins/sentry.client.js'));
     }
   },
 });

packages/nuxt/src/runtime/client/plugin.ts renamed to packages/nuxt/src/runtime/plugins/sentry.client.ts

@@ -1,6 +1,5 @@
-import { applySdkMetadata } from '@sentry/core';
-import * as Sentry from '@sentry/vue';
 import { defineNuxtPlugin, useRuntimeConfig } from 'nuxt/app';
+import { init } from '../../client';
 
 export default defineNuxtPlugin(nuxtApp => {
   const config = useRuntimeConfig();
@@ -10,9 +9,7 @@ export default defineNuxtPlugin(nuxtApp => {
 
   const sentryConfig = config.public.sentry || {};
 
-  applySdkMetadata(sentryConfig, 'nuxt', ['nuxt', 'vue']);
-
-  Sentry.init({
+  init({
     ...sentryConfig,
     app: nuxtApp.vueApp,
   });

packages/nuxt/test/client/sdk.test.ts

@@ -0,0 +1,38 @@
+import { SDK_VERSION } from '@sentry/vue';
+import * as SentryVue from '@sentry/vue';
+import { vi, describe, beforeEach } from 'vitest';
+import { init } from '../../src/client';
+
+const vueInit = vi.spyOn(SentryVue, 'init');
+
+describe('Nuxt CLient SDK', () => {
+  describe('init', () => {
+    beforeEach(() => {
+      vi.clearAllMocks();
+    });
+
+    it('adds Nuxt metadata to the SDK options', () => {
+      expect(vueInit).not.toHaveBeenCalled();
+
+      init({
+        dsn: 'https://[email protected]/1337',
+      });
+
+      const expectedMetadata = {
+        _metadata: {
+          sdk: {
+            name: 'sentry.javascript.nuxt',
+            version: SDK_VERSION,
+            packages: [
+              { name: 'npm:@sentry/nuxt', version: SDK_VERSION },
+              { name: 'npm:@sentry/vue', version: SDK_VERSION },
+            ],
+          },
+        },
+      };
+
+      expect(vueInit).toHaveBeenCalledTimes(1);
+      expect(vueInit).toHaveBeenLastCalledWith(expect.objectContaining(expectedMetadata));
+    });
+  });
+});

packages/nuxt/test/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.test.json"
+}

packages/nuxt/test/vitest.setup.ts

@@ -0,0 +1,8 @@
+export function setup() {}
+
+if (!globalThis.fetch) {
+  // @ts-expect-error - Needed for vitest to work with our fetch instrumentation
+  globalThis.Request = class Request {};
+  // @ts-expect-error - Needed for vitest to work with our fetch instrumentation
+  globalThis.Response = class Response {};
+}

packages/nuxt/vite.config.ts

@@ -2,4 +2,8 @@ import baseConfig from '../../vite/vite.config';
 
 export default {
   ...baseConfig,
+  test: {
+    environment: 'jsdom',
+    setupFiles: ['./test/vitest.setup.ts'],
+  },
 };