Fix typing, unify vite plugin options

Author: andreiborza

packages/solidstart/src/config/addInstrumentation.ts

@@ -11,9 +11,10 @@ import type { Nitro } from './types';
  * added to `app.config.ts` to enable building the instrumentation file.
  */
 export async function addInstrumentationFileToBuild(nitro: Nitro): Promise<void> {
-  const { buildDir, serverDir } = nitro.options.output;
-  const source = path.join(buildDir, 'build', 'ssr', 'instrument.server.js');
-  const destination = path.join(serverDir, 'instrument.server.mjs');
+  const buildDir = nitro.options.buildDir;
+  const serverDir = nitro.options.output.serverDir;
+  const source = path.resolve(buildDir, 'build', 'ssr', 'instrument.server.js');
+  const destination = path.resolve(serverDir, 'instrument.server.mjs');
 
   try {
     await fs.promises.access(source, fs.constants.F_OK);
@@ -44,9 +45,9 @@ export async function experimental_addInstrumentationFileTopLevelImportToServerE
 ): Promise<void> {
   // other presets ('node-server' or 'vercel') have an index.mjs
   const presetsWithServerFile = ['netlify'];
-  const instrumentationFile = path.join(serverDir, 'instrument.server.mjs');
+  const instrumentationFile = path.resolve(serverDir, 'instrument.server.mjs');
   const serverEntryFileName = presetsWithServerFile.includes(preset) ? 'server.mjs' : 'index.mjs';
-  const serverEntryFile = path.join(serverDir, serverEntryFileName);
+  const serverEntryFile = path.resolve(serverDir, serverEntryFileName);
 
   try {
     await fs.promises.access(instrumentationFile, fs.constants.F_OK);

packages/solidstart/src/config/index.ts

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

packages/solidstart/src/config/types.ts

@@ -1,3 +1,4 @@
+import type { defineConfig } from '@solidjs/start/config';
 // Types to avoid pulling in extra dependencies
 // These are non-exhaustive
 export type Nitro = {
@@ -11,12 +12,12 @@ export type Nitro = {
   };
 };
 
-export type SolidStartInlineConfig = {
-  server?: {
-    hooks?: {
-      close?: () => unknown;
-      'rollup:before'?: (nitro: Nitro) => unknown;
-    };
+export type SolidStartInlineConfig = Parameters<typeof defineConfig>[0];
+
+export type SolidStartInlineConfigNitroHooks = {
+  hooks?: {
+    close?: () => unknown;
+    'rollup:before'?: (nitro: Nitro) => unknown;
   };
 };
 

packages/solidstart/src/config/withSentry.ts

@@ -2,13 +2,18 @@ import {
   addInstrumentationFileToBuild,
   experimental_addInstrumentationFileTopLevelImportToServerEntry,
 } from './addInstrumentation';
-import type { SentrySolidStartConfigOptions, SolidStartInlineConfig } from './types';
+import type {
+  Nitro,
+  SentrySolidStartConfigOptions,
+  SolidStartInlineConfig,
+  SolidStartInlineConfigNitroHooks,
+} from './types';
 
 export const withSentry = (
   solidStartConfig: SolidStartInlineConfig = {},
   sentrySolidStartConfigOptions: SentrySolidStartConfigOptions = {},
 ): SolidStartInlineConfig => {
-  const server = solidStartConfig.server || {};
+  const server = (solidStartConfig.server || {}) as SolidStartInlineConfigNitroHooks;
   const hooks = server.hooks || {};
 
   let serverDir: string;
@@ -30,7 +35,7 @@ export const withSentry = (
             hooks.close();
           }
         },
-        async 'rollup:before'(nitro) {
+        async 'rollup:before'(nitro: Nitro) {
           serverDir = nitro.options.output.serverDir;
           buildPreset = nitro.options.preset;
 

packages/solidstart/src/index.server.ts

@@ -1,2 +1,3 @@
 export * from './server';
 export * from './vite';
+export * from './config';

packages/solidstart/src/index.types.ts

@@ -4,6 +4,7 @@
 export * from './client';
 export * from './server';
 export * from './vite';
+export * from './config';
 
 import type { Integration, Options, StackParser } from '@sentry/types';
 

packages/solidstart/src/vite/buildInstrumentationFile.ts

@@ -2,19 +2,19 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { consoleSandbox } from '@sentry/utils';
 import type { Plugin, UserConfig } from 'vite';
+import type { SentrySolidStartPluginOptions } from './types';
 
 /**
  * A Sentry plugin for SolidStart to build the server
  * `instrument.server.ts` file.
  */
-export function makeBuildInstrumentationFilePlugin(
-  instrumentationFilePath: string = './src/instrument.server.ts',
-): Plugin {
+export function makeBuildInstrumentationFilePlugin(options: SentrySolidStartPluginOptions = {}): Plugin {
   return {
     name: 'sentry-solidstart-build-instrumentation-file',
     apply: 'build',
     enforce: 'post',
     async config(config: UserConfig, { command }) {
+      const instrumentationFilePath = options.instrumentation || './src/instrument.server.ts';
       const router = (config as UserConfig & { router: { target: string; name: string; root: string } }).router;
       const build = config.build || {};
       const rollupOptions = build.rollupOptions || {};
@@ -38,7 +38,7 @@ export function makeBuildInstrumentationFilePlugin(
         return config;
       }
 
-      input.push(path.join(router.root, instrumentationFilePath));
+      input.push(path.resolve(router.root, instrumentationFilePath));
 
       return {
         ...config,

packages/solidstart/src/vite/sentrySolidStartVite.ts

@@ -9,7 +9,7 @@ import type { SentrySolidStartPluginOptions } from './types';
 export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions = {}): Plugin[] => {
   const sentryPlugins: Plugin[] = [];
 
-  sentryPlugins.push(makeBuildInstrumentationFilePlugin(options.instrumentation));
+  sentryPlugins.push(makeBuildInstrumentationFilePlugin(options));
 
   if (process.env.NODE_ENV !== 'development') {
     if (options.sourceMapsUploadOptions?.enabled ?? true) {

packages/solidstart/test/vite/buildInstrumentation.test.ts

@@ -47,18 +47,26 @@ describe('makeBuildInstrumentationFilePlugin()', () => {
 
   it('adds the instrumentation file for server builds', async () => {
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(viteConfig, { command: 'build' });
     expect(config.build.rollupOptions.input).toContain('/some/project/path/src/instrument.server.ts');
   });
 
   it('adds the correct instrumentation file', async () => {
-    const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin('./src/myapp/instrument.server.ts');
+    const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin({
+      instrumentation: './src/myapp/instrument.server.ts',
+    });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(viteConfig, { command: 'build' });
     expect(config.build.rollupOptions.input).toContain('/some/project/path/src/myapp/instrument.server.ts');
   });
 
   it("doesn't add the instrumentation file for server function builds", async () => {
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(
       {
         ...viteConfig,
@@ -74,6 +82,8 @@ describe('makeBuildInstrumentationFilePlugin()', () => {
 
   it("doesn't add the instrumentation file for client builds", async () => {
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(
       {
         ...viteConfig,
@@ -89,13 +99,17 @@ describe('makeBuildInstrumentationFilePlugin()', () => {
 
   it("doesn't add the instrumentation file when serving", async () => {
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(viteConfig, { command: 'serve' });
     expect(config.build.rollupOptions.input).not.toContain('/some/project/path/src/instrument.server.ts');
   });
 
   it("doesn't modify the config if the instrumentation file doesn't exist", async () => {
     fsAccessMock.mockRejectedValueOnce(undefined);
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(viteConfig, { command: 'build' });
     expect(config).toEqual(viteConfig);
   });
@@ -104,6 +118,8 @@ describe('makeBuildInstrumentationFilePlugin()', () => {
     const error = new Error("File doesn't exist.");
     fsAccessMock.mockRejectedValueOnce(error);
     const buildInstrumentationFilePlugin = makeBuildInstrumentationFilePlugin();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - this is always defined and always a function
     const config = await buildInstrumentationFilePlugin.config(viteConfig, { command: 'build' });
     expect(config).toEqual(viteConfig);
     expect(consoleWarnSpy).toHaveBeenCalledWith(