feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andreiborza wants to merge 1 commit into from
Closed

feat(solidstart): Add solidstart sentry vite plugin #13537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 11 additions & 71 deletions dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
return (
<SampleErrorBoundary>
{caughtError() && (
<Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
)}
<section class="bg-gray-100 text-gray-700 p-8">
<div class="flex flex-col items-start space-x-2">
<button
class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
id="caughtErrorBtn"
onClick={() => setCaughtError(true)}
>
Throw caught error
</button>
</div>
<div class="flex flex-col items-start space-x-2">
<button
class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
id="errorBtn"
onClick={() => {
throw new Error('Error thrown from Solid Start E2E test app');
}}
>
Throw uncaught error
</button>
</div>
</section>
</SampleErrorBoundary>
);
}

function Throw(props: { error: string }) {
onMount(() => {
throw new Error(props.error);
});
return null;
}

function SampleErrorBoundary(props: ParentProps) {
return (
<SentryErrorBoundary
fallback={(error, reset) => (
<section class="bg-gray-100 text-gray-700 p-8">
<h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
<div class="flex items-center space-x-2 mb-4">
<code>{error.message}</code>
</div>
<button
id="errorBoundaryResetBtn"
class="border rounded-lg px-2 border-gray-900"
onClick={() => {
setCount(count() + 1);
setCaughtError(false);
reset();
}}
>
Reset
</button>
</section>
)}
>
{props.children}
</SentryErrorBoundary>
<div class="flex flex-col items-start space-x-2">
<button
class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
id="errorBtn"
onClick={() => {
throw new Error('Uncaught error thrown from Solid Start E2E test app');
}}
>
Throw uncaught error
</button>
</div>
);
}
64 changes: 64 additions & 0 deletions dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
return (
<SampleErrorBoundary>
{caughtError() && (
<Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
)}
<section class="bg-gray-100 text-gray-700 p-8">
<div class="flex flex-col items-start space-x-2">
<button
class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
id="caughtErrorBtn"
onClick={() => setCaughtError(true)}
>
Throw caught error
</button>
</div>
</section>
</SampleErrorBoundary>
);
}

function Throw(props: { error: string }) {
onMount(() => {
throw new Error(props.error);
});
return null;
}

function SampleErrorBoundary(props: ParentProps) {
return (
<SentryErrorBoundary
fallback={(error, reset) => (
<section class="bg-gray-100 text-gray-700 p-8">
<h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
<div class="flex items-center space-x-2 mb-4">
<code>{error.message}</code>
</div>
<button
id="errorBoundaryResetBtn"
class="border rounded-lg px-2 border-gray-900"
onClick={() => {
setCount(count() + 1);
setCaughtError(false);
reset();
}}
>
Reset
</button>
</section>
)}
>
{props.children}
</SentryErrorBoundary>
);
}
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
<li>
<A href="/server-error">Server error</A>
</li>
<li>
<A href="/error-boundary">Error Boundary</A>
</li>
<li>
<A id="navLink" href="/users/5">
User 5
Expand Down
11 changes: 6 additions & 5 deletions dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
);
});

await page.goto('/client-error');
await page.goto('/error-boundary');
await page.locator('#caughtErrorBtn').click();
const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
},
],
},
transaction: '/client-error',
transaction: '/error-boundary',
});
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
);
});

await page.goto('/client-error');
await page.waitForTimeout(5000);
await page.goto('/error-boundary');
await page.locator('#caughtErrorBtn').click();
const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
},
],
},
transaction: '/client-error',
transaction: '/error-boundary',
});

const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
},
],
},
transaction: '/client-error',
transaction: '/error-boundary',
});
});
4 changes: 2 additions & 2 deletions dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
test('captures error thrown on click', async ({ page }) => {
const errorPromise = waitForError('solidstart', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
});

await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
values: [
{
type: 'Error',
value: 'Error thrown from Solid Start E2E test app',
value: 'Uncaught error thrown from Solid Start E2E test app',
mechanism: {
type: 'instrument',
handled: false,
Expand Down
1 change: 1 addition & 0 deletions packages/solidstart/.eslintrc.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
files: ['src/vite/**', 'src/server/**'],
rules: {
'@sentry-internal/sdk/no-optional-chaining': 'off',
'@sentry-internal/sdk/no-nullish-coalescing': 'off',
},
},
],
Expand Down
46 changes: 11 additions & 35 deletions packages/solidstart/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
// rest of your config
// ...

vite: {
build: {
sourcemap: true,
},
plugins: [
sentryVitePlugin({
sentrySolidStartVite({
org: process.env.SENTRY_ORG,
project: process.env.SENTRY_PROJECT,
authToken: process.env.SENTRY_AUTH_TOKEN,
debug: true,
}),
],
},
// ...
});
```
1 change: 1 addition & 0 deletions packages/solidstart/src/index.server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';
1 change: 1 addition & 0 deletions packages/solidstart/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down
1 change: 1 addition & 0 deletions packages/solidstart/src/vite/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';
18 changes: 18 additions & 0 deletions packages/solidstart/src/vite/sentrySolidStartVite.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
* Various Sentry vite plugins to be used for SolidStart.
*/
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
const sentryPlugins: Plugin[] = [];

if (process.env.NODE_ENV !== 'development') {
if (options.sourceMapsUploadOptions?.enabled ?? true) {
sentryPlugins.push(...makeSourceMapsVitePlugin(options));
}
}

return sentryPlugins;
};
57 changes: 57 additions & 0 deletions packages/solidstart/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
* A Sentry plugin for SolidStart to enable source maps and use
* @sentry/vite-plugin to automatically upload source maps to Sentry.
* @param {SourceMapsOptions} options
*/
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
return [
{
name: 'sentry-solidstart-source-maps',
apply: 'build',
enforce: 'post',
config(config) {
const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
if (debug && sourceMapsPreviouslyNotEnabled) {
// eslint-disable-next-line no-console
console.log('[Sentry SolidStart Plugin] Enabling source map generation');
if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.warn(
`[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
);
}
}
return {
...config,
build: {
...config.build,
sourcemap: true,
},
};
},
},
...sentryVitePlugin({
org: org ?? process.env.SENTRY_ORG,
project: project ?? process.env.SENTRY_PROJECT,
authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: sourceMapsUploadOptions?.telemetry ?? true,
sourcemaps: {
filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
},
_metaOptions: {
telemetry: {
metaFramework: 'solidstart',
},
},
debug: debug ?? false,
...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
}),
];
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(solidstart): Add solidstart sentry vite plugin#13537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

andreiborza
wants to merge
1
commit into

from

 Closed


feat(solidstart): Add solidstart sentry vite plugin
#13537
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


82 changes: 11 additions & 71 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/client-error.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,75 +1,15 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ClientErrorPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="errorBtn"
 onClick={() => {
 throw new Error('Uncaught error thrown from Solid Start E2E test app');
 }}
 >
 Throw uncaught error
 </button>
 </div>
 );
}

64 changes: 64 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/error-boundary.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
import * as Sentry from '@sentry/solidstart';
import type { ParentProps } from 'solid-js';
import { ErrorBoundary, createSignal, onMount } from 'solid-js';

const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

const [count, setCount] = createSignal(1);
const [caughtError, setCaughtError] = createSignal(false);

export default function ErrorBoundaryTestPage() {
 return (
 <SampleErrorBoundary>
 {caughtError() && (
 <Throw error={`Error ${count()} thrown from Sentry ErrorBoundary in Solid Start E2E test app`} />
 )}
 <section class="bg-gray-100 text-gray-700 p-8">
 <div class="flex flex-col items-start space-x-2">
 <button
 class="border rounded-lg px-2 mb-2 border-red-500 text-red-500 cursor-pointer"
 id="caughtErrorBtn"
 onClick={() => setCaughtError(true)}
 >
 Throw caught error
 </button>
 </div>
 </section>
 </SampleErrorBoundary>
 );
}

function Throw(props: { error: string }) {
 onMount(() => {
 throw new Error(props.error);
 });
 return null;
}

function SampleErrorBoundary(props: ParentProps) {
 return (
 <SentryErrorBoundary
 fallback={(error, reset) => (
 <section class="bg-gray-100 text-gray-700 p-8">
 <h1 class="text-2xl font-bold">Error Boundary Fallback</h1>
 <div class="flex items-center space-x-2 mb-4">
 <code>{error.message}</code>
 </div>
 <button
 id="errorBoundaryResetBtn"
 class="border rounded-lg px-2 border-gray-900"
 onClick={() => {
 setCount(count() + 1);
 setCaughtError(false);
 reset();
 }}
 >
 Reset
 </button>
 </section>
 )}
 >
 {props.children}
 </SentryErrorBoundary>
 );
}

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/solidstart/src/routes/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,9 @@ export default function Home() {
 <li>
 <A href="/server-error">Server error</A>
 </li>
 <li>
 <A href="/error-boundary">Error Boundary</A>
 </li>
 <li>
 <A id="navLink" href="/users/5">
 User 5
Expand Down

11 changes: 6 additions & 5 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errorboundary.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ test('captures an exception', async ({ page }) => {
 );
 });

 await page.goto('/client-error');
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const errorEvent = await errorEventPromise;

Expand All@@ -27,7 +27,7 @@ test('captures an exception', async ({ page }) => {
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

Expand All@@ -40,7 +40,8 @@ test('captures a second exception after resetting the boundary', async ({ page }
 );
 });

 await page.goto('/client-error');
 await page.waitForTimeout(5000);
 await page.goto('/error-boundary');
 await page.locator('#caughtErrorBtn').click();
 const firstErrorEvent = await firstErrorEventPromise;

Expand All@@ -57,7 +58,7 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });

 const secondErrorEventPromise = waitForError('solidstart', errorEvent => {
Expand DownExpand Up@@ -85,6 +86,6 @@ test('captures a second exception after resetting the boundary', async ({ page }
 },
 ],
 },
 transaction: '/client-error',
 transaction: '/error-boundary',
 });
});

4 changes: 2 additions & 2 deletions
dev-packages/e2e-tests/test-applications/solidstart/tests/errors.client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { waitForError } from '@sentry-internal/test-utils';
test.describe('client-side errors', () => {
 test('captures error thrown on click', async ({ page }) => {
 const errorPromise = waitForError('solidstart', async errorEvent => {
 return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Solid Start E2E test app';
 return errorEvent?.exception?.values?.[0]?.value === 'Uncaught error thrown from Solid Start E2E test app';
 });

 await page.goto(`/client-error`);
Expand All@@ -16,7 +16,7 @@ test.describe('client-side errors', () => {
 values: [
 {
 type: 'Error',
 value: 'Error thrown from Solid Start E2E test app',
 value: 'Uncaught error thrown from Solid Start E2E test app',
 mechanism: {
 type: 'instrument',
 handled: false,
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ module.exports = {
 files: ['src/vite/**', 'src/server/**'],
 rules: {
 '@sentry-internal/sdk/no-optional-chaining': 'off',
 '@sentry-internal/sdk/no-nullish-coalescing': 'off',
 },
 },
 ],
Expand Down

46 changes: 11 additions & 35 deletions
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,58 +157,34 @@ render(
);
```

# Sourcemaps and Releases
## Uploading Source Maps

To generate and upload source maps of your Solid Start app use our Vite bundler plugin.

1. Install the Sentry Vite plugin

```bash
# Using npm
npm install @sentry/vite-plugin --save-dev

# Using yarn
yarn add @sentry/vite-plugin --dev
```

2. Configure the vite plugin

To upload source maps you have to configure an auth token. Auth tokens can be passed to the plugin explicitly with the
`authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the
working directory when building your project. We recommend you add the auth token to your CI/CD environment as an
environment variable.
To upload source maps, add the `sentrySolidStartVite` plugin from `@sentry/solidstart` to your `app.config.ts` and
configure an auth token. Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a
`SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file in the working directory when
building your project. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our
[Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin).

```bash
// .env.sentry-build-plugin
SENTRY_AUTH_TOKEN=<your auth token>
SENTRY_ORG=<your org>
SENTRY_PROJECT=<your project name>
```

3. Finally, add the plugin to your `app.config.ts` file.

```javascript
```typescript
// app.config.ts
import { defineConfig } from '@solidjs/start/config';
import { sentryVitePlugin } from '@sentry/vite-plugin';
import { sentrySolidStartVite } from '@sentry/solidstart';

export default defineConfig({
 // rest of your config
 // ...

 vite: {
 build: {
 sourcemap: true,
 },
 plugins: [
sentryVitePlugin({
sentrySolidStartVite({
 org: process.env.SENTRY_ORG,
 project: process.env.SENTRY_PROJECT,
 authToken: process.env.SENTRY_AUTH_TOKEN,
 debug: true,
 }),
 ],
 },
 // ...
});
```

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
export * from './server';
export * from './vite';

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
// exports in this file - which we do below.
export * from './client';
export * from './server';
export * from './vite';

import type { Integration, Options, StackParser } from '@sentry/types';

Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/src/vite/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from './sentrySolidStartVite';

18 changes: 18 additions & 0 deletions
packages/solidstart/src/vite/sentrySolidStartVite.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import type { Plugin } from 'vite';
import { makeSourceMapsVitePlugin } from './sourceMaps';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * Various Sentry vite plugins to be used for SolidStart.
 */
export const sentrySolidStartVite = (options: SentrySolidStartPluginOptions): Plugin[] => {
 const sentryPlugins: Plugin[] = [];

 if (process.env.NODE_ENV !== 'development') {
 if (options.sourceMapsUploadOptions?.enabled ?? true) {
 sentryPlugins.push(...makeSourceMapsVitePlugin(options));
 }
 }

 return sentryPlugins;
};

57 changes: 57 additions & 0 deletions
packages/solidstart/src/vite/sourceMaps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import { sentryVitePlugin } from '@sentry/vite-plugin';
import type { Plugin } from 'vite';
import type { SentrySolidStartPluginOptions } from './types';

/**
 * A Sentry plugin for SolidStart to enable source maps and use
 * @sentry/vite-plugin to automatically upload source maps to Sentry.
 * @param {SourceMapsOptions} options
 */
export function makeSourceMapsVitePlugin(options: SentrySolidStartPluginOptions): Plugin[] {
 const { authToken, debug, org, project, sourceMapsUploadOptions } = options;
 return [
 {
 name: 'sentry-solidstart-source-maps',
 apply: 'build',
 enforce: 'post',
 config(config) {
 const sourceMapsPreviouslyNotEnabled = !config.build?.sourcemap;
 if (debug && sourceMapsPreviouslyNotEnabled) {
 // eslint-disable-next-line no-console
 console.log('[Sentry SolidStart Plugin] Enabling source map generation');
 if (!sourceMapsUploadOptions?.filesToDeleteAfterUpload) {
 // eslint-disable-next-line no-console
 console.warn(
 `[Sentry SolidStart PLugin] We recommend setting the \`sourceMapsUploadOptions.filesToDeleteAfterUpload\` option to clean up source maps after uploading.
[Sentry SolidStart Plugin] Otherwise, source maps might be deployed to production, depending on your configuration`,
 );
 }
 }
 return {
 ...config,
 build: {
 ...config.build,
 sourcemap: true,
 },
 };
 },
 },
 ...sentryVitePlugin({
 org: org ?? process.env.SENTRY_ORG,
 project: project ?? process.env.SENTRY_PROJECT,
 authToken: authToken ?? process.env.SENTRY_AUTH_TOKEN,
 telemetry: sourceMapsUploadOptions?.telemetry ?? true,
 sourcemaps: {
 filesToDeleteAfterUpload: sourceMapsUploadOptions?.filesToDeleteAfterUpload ?? undefined,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions?.sourcemaps,
 },
 _metaOptions: {
 telemetry: {
 metaFramework: 'solidstart',
 },
 },
 debug: debug ?? false,
 ...sourceMapsUploadOptions?.unstable_sentryVitePluginOptions,
 }),
 ];
}
Loading