feat(solidstart): Add withSentry config wrapper

[andreiborza]

This PR adds a withSentry wrapper for SolidStart's config to build and place instrument.server.ts alongside the server build output so that it doesn't have to be placed in /public anymore to be discoverable.

It also adds an experimental option to top level import instrument.server.ts in the server entry file for platforms that currently do not support --import, overriding the start command or setting scoped NODE_OPTIONS (e.g. Vercel, Netlify (free version)).

The configuration now looks like this:

// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentrySolidStartVite, withSentry } from '@sentry/solidstart';

export default defineConfig(withSentry({
  // ...
  middleware: './src/middleware.ts',
  vite: {
    plugins: [
      sentrySolidStartVite({
        org: process.env.SENTRY_ORG,
        project: process.env.SENTRY_PROJECT,
        authToken: process.env.SENTRY_AUTH_TOKEN,
        // optional: if your `instrument.server.ts` file is not located inside `src`
        instrumentation: './mypath/instrument.server.ts'
      }),
    ],
  },
  // ...
}, { experimental_basicServerTracing: true }));

Note to reviewers
Unfortunately, we need both withSentry and sentrySolidStartVite because SolidStart's config allows the vite configuration to be a function that gets the current build target (i.e.server, client, server-fns) passed in and we cannot add our plugin first for this case as the function would have to be executed (and thus run all predefined plugins) before we can add our plugin.

The sentrySolidStartVite plugin is now automatically added by withSentry.

Closes: #13785

[andreiborza]

I'm investigating my claim in the note to reviewers. I might be wrong here and we can simplify to just using withSentry.

[s1gr1d]

m: The option is instrumentation right? You could add this here, so it is clear where the path can be specified.

[andreiborza]

Thanks, I updated the readme to make this clearer.

[s1gr1d]

L: I would restructure this a little bit at it is hard to follow when reading it first. The first sentence says it relies on running the file as early as possible but the explanation for this comes later.

The proposed structure: do this -> why to do this -> what it does.

Suggested change

	Sentry relies on running `instrument.server.ts` as early as possible. Add the `sentrySolidStartVite` plugin from
	`@sentry/solidstart` to your `app.config.ts`. This takes care of building `instrument.server.ts` and placing it
	alongside the server entry file.
	Add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your plugins in `app.config.ts`. Sentry relies on running `instrument.server.ts` as early as possible. The `sentrySolidStartVite` plugin builds the `instrument.server.ts` file and places it alongside the server entry file.

[andreiborza]

Thanks. I updated the readme and removed some of this explanation in favor of simplicity. Maybe this is better kept in the docs.

[s1gr1d]

Suggested change

	directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment
	directory when building your project. We recommend adding the auth token to your CI/CD environment as an environment

[andreiborza]

Thanks, updated.

[codecov]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
231	1	230	8

View the full list of 1 ❄️ flaky tests

errorboundary.test.ts captures an exception

Flake rate in main: 29.41% (Passed 12 times, Failed 5 times)

Stack Traces | 30s run time

errorboundary.test.ts:4:1 captures an exception

To view individual test run time comparison to the main branch, go to the Test Analytics Dashboard

[andreiborza]

Closing this for now as it needs to be reworked, using dynamic import instead of top-level-import of the instrumentation file to get around deploy platform restrictions of not being able to --import at the right time.