feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing#13221

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

Merged
andreiborza merged 2 commits into from
Aug 5, 2024
Merged

feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing #13221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3dc3213
feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …
andreiborza Aug 4, 2024
89125a4
Update packages/solidstart/README.md
andreiborza Aug 5, 2024
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
34 changes: 33 additions & 1 deletion packages/solidstart/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
dsn: '__PUBLIC_DSN__',
integrations: [solidRouterBrowserTracingIntegration()],
tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
onBeforeResponse: [
sentryBeforeResponseMiddleware(),
// Add your other middleware handlers after `sentryBeforeResponseMiddleware`
],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
// ...
middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down
17 changes: 14 additions & 3 deletions packages/solidstart/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
"require": "./build/cjs/index.server.js"
}
},
"./middleware": {
"types": "./middleware.d.ts",
"import": {
"types": "./middleware.d.ts",
"default": "./build/esm/middleware.js"
},
"require": {
"types": "./middleware.d.ts",
"default": "./build/cjs/middleware.js"
}
},
"./solidrouter": {
"types": "./solidrouter.d.ts",
"browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:solidrouter",
"build:types": "run-s build:types:core build:types:subexports",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
"build:types:subexports": "tsc -p tsconfig.subexports-types.json",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
"clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
Expand Down
1 change: 1 addition & 0 deletions packages/solidstart/rollup.npm.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
'src/solidrouter.server.ts',
'src/client/solidrouter.ts',
'src/server/solidrouter.ts',
'src/middleware.ts',
],
// prevent this internal code from ending up in our built package (this doesn't happen automatially because
// the name doesn't match an SDK dependency)
Expand Down
61 changes: 61 additions & 0 deletions packages/solidstart/src/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
__sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

if (!sentryTrace) {
return html;
}

const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

if (baggage) {
metaTags.push(`<meta name="baggage" content="${baggage}">`);
}

const content = `<head>\n${metaTags.join('\n')}\n`;
return html.replace('<head>', content);
}

/**
* Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
* <meta> tags to a page on pageload to enable distributed tracing.
*/
export function sentryBeforeResponseMiddleware() {
return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
if (!response.body || response.__sentry_wrapped__) {
return;
}

// Ensure we don't double-wrap, in case a user has added the middleware twice
// e.g. once manually, once via the wizard
addNonEnumerableProperty(response, '__sentry_wrapped__', true);

const contentType = event.response.headers.get('content-type');
const isPageloadRequest = contentType && contentType.startsWith('text/html');

if (!isPageloadRequest) {
return;
}

const body = response.body as NodeJS.ReadableStream;
const decoder = new TextDecoder();
response.body = new ReadableStream({
start: async controller => {
for await (const chunk of body) {
const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
const modifiedHtml = addMetaTagToHead(html);
controller.enqueue(new TextEncoder().encode(modifiedHtml));
}
controller.close();
},
});
};
}
82 changes: 82 additions & 0 deletions packages/solidstart/test/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
describe('sentryBeforeResponseMiddleware', () => {
vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
'sentry-trace': '123',
baggage: 'abc',
});

const mockFetchEvent = {
request: {},
locals: {},
response: {
// mocks a pageload
headers: new Headers([['content-type', 'text/html']]),
},
nativeEvent: {},
};

let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

beforeEach(() => {
// h3 doesn't pass a proper Response object to the middleware
mockMiddlewareHTMLResponse = {
body: new Response('<head><meta charset="utf-8"></head>').body,
};
mockMiddlewareHTMLNoHeadResponse = {
body: new Response('<body>Hello World</body>').body,
};
mockMiddlewareJSONResponse = {
body: new Response('{"prefecture": "Kagoshima"}').body,
};
});

it('injects tracing meta tags into the response body', async () => {
const onBeforeResponse = sentryBeforeResponseMiddleware();
onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

// for testing convenience, we pass the body back into a proper response
// mockMiddlewareHTMLResponse has been modified by our middleware
const html = await new Response(mockMiddlewareHTMLResponse.body).text();
expect(html).toContain('<meta charset="utf-8">');
expect(html).toContain('<meta name="sentry-trace" content="123">');
expect(html).toContain('<meta name="baggage" content="abc">');
});

it('does not add meta tags if there is no head tag', async () => {
const onBeforeResponse = sentryBeforeResponseMiddleware();
onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
expect(html).toEqual('<body>Hello World</body>');
});

it('does not add tracing meta tags twice into the same response', async () => {
const onBeforeResponse1 = sentryBeforeResponseMiddleware();
onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

const onBeforeResponse2 = sentryBeforeResponseMiddleware();
onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

const html = await new Response(mockMiddlewareHTMLResponse.body).text();
expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
});

it('does not modify a non-HTML response', async () => {
const onBeforeResponse = sentryBeforeResponseMiddleware();
onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

const json = await new Response(mockMiddlewareJSONResponse.body).json();
expect(json).toEqual({
prefecture: 'Kagoshima',
});
});
});
});
1 change: 1 addition & 0 deletions ...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
"src/solidrouter.server.ts",
"src/server/solidrouter.ts",
"src/solidrouter.ts",
"src/middleware.ts",
],
// Without this, we cannot output into the root dir
"exclude": []
Expand Down
3 changes: 2 additions & 1 deletion packages/solidstart/tsconfig.types.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
"src/client/solidrouter.ts",
"src/solidrouter.server.ts",
"src/server/solidrouter.ts",
"src/solidrouter.ts"
"src/solidrouter.ts",
"src/middleware.ts",
]
}
, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}

, '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 sentry onBeforeResponse middleware to enable distributed tracing#13221

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

 Merged

andreiborza
merged 2 commits into

from

Aug 5, 2024
 Merged


feat(solidstart): Add sentry onBeforeResponse middleware to enable distributed tracing
#13221
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
3dc3213

feat(solidstart): Add sentry `onBeforeResponse` middleware to enable …


andreiborza Aug 4, 2024
89125a4

Update packages/solidstart/README.md


andreiborza Aug 5, 2024

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


34 changes: 33 additions & 1 deletion
packages/solidstart/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,10 +46,12 @@ Initialize the SDK in `entry-client.jsx`

```jsx
import * as Sentry from '@sentry/solidstart';
import { solidRouterBrowserTracingIntegration } from '@sentry/solidstart/solidrouter';
import { mount, StartClient } from '@solidjs/start/client';

Sentry.init({
 dsn: '__PUBLIC_DSN__',
 integrations: [solidRouterBrowserTracingIntegration()],
 tracesSampleRate: 1.0, // Capture 100% of the transactions
});

Expand All@@ -69,7 +71,37 @@ Sentry.init({
});
```

### 4. Run your application
### 4. Server instrumentation

Complete the setup by adding the Sentry middlware to your `src/middleware.ts` file:

```typescript
import { sentryBeforeResponseMiddleware } from '@sentry/solidstart/middleware';
import { createMiddleware } from '@solidjs/start/middleware';

export default createMiddleware({
 onBeforeResponse: [
 sentryBeforeResponseMiddleware(),
 // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
 ],
});
```

And don't forget to specify `./src/middleware.ts` in your `app.config.ts`:

```typescript
import { defineConfig } from '@solidjs/start/config';

export default defineConfig({
 // ...
 middleware: './src/middleware.ts',
});
```

The Sentry middleware enhances the data collected by Sentry on the server side by enabling distributed tracing between
the client and server.

### 5. Run your application

Then run your app

Expand Down

17 changes: 14 additions & 3 deletions
packages/solidstart/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,17 @@
 "require": "./build/cjs/index.server.js"
 }
 },
 "./middleware": {
 "types": "./middleware.d.ts",
 "import": {
 "types": "./middleware.d.ts",
 "default": "./build/esm/middleware.js"
 },
 "require": {
 "types": "./middleware.d.ts",
 "default": "./build/cjs/middleware.js"
 }
 },
 "./solidrouter": {
 "types": "./solidrouter.d.ts",
 "browser": {
Expand DownExpand Up@@ -87,15 +98,15 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "rollup -c rollup.npm.config.mjs",
 "build:types": "run-s build:types:core build:types:solidrouter",
 "build:types": "run-s build:types:core build:types:subexports",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:solidrouter": "tsc -p tsconfig.solidrouter-types.json",
 "build:types:subexports": "tsc -p tsconfig.subexports-types.json",
 "build:watch": "run-p build:transpile:watch build:types:watch",
 "build:dev:watch": "yarn build:watch",
 "build:transpile:watch": "rollup -c rollup.npm.config.mjs --watch",
 "build:types:watch": "tsc -p tsconfig.types.json --watch",
 "build:tarball": "npm pack",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts",
 "circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts && madge --circular src/solidrouter.client.ts && madge --circular src/solidrouter.server.ts && madge --circular src/solidrouter.ts && madge --circular src/middleware.ts",
 "clean": "rimraf build coverage sentry-solidstart-*.tgz ./*.d.ts ./*.d.ts.map ./client ./server",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
Expand Down

1 change: 1 addition & 0 deletions
packages/solidstart/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ export default makeNPMConfigVariants(
 'src/solidrouter.server.ts',
 'src/client/solidrouter.ts',
 'src/server/solidrouter.ts',
 'src/middleware.ts',
 ],
 // prevent this internal code from ending up in our built package (this doesn't happen automatially because
 // the name doesn't match an SDK dependency)
Expand Down

61 changes: 61 additions & 0 deletions
packages/solidstart/src/middleware.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
import { getTraceData } from '@sentry/core';
import { addNonEnumerableProperty } from '@sentry/utils';
import type { ResponseMiddleware } from '@solidjs/start/middleware';
import type { FetchEvent } from '@solidjs/start/server';

export type ResponseMiddlewareResponse = Parameters<ResponseMiddleware>[1] & {
 __sentry_wrapped__?: boolean;
};

function addMetaTagToHead(html: string): string {
 const { 'sentry-trace': sentryTrace, baggage } = getTraceData();

 if (!sentryTrace) {
 return html;
 }

 const metaTags = [`<meta name="sentry-trace" content="${sentryTrace}">`];

 if (baggage) {
 metaTags.push(`<meta name="baggage" content="${baggage}">`);
 }

 const content = `<head>\n${metaTags.join('\n')}\n`;
 return html.replace('<head>', content);
}

/**
 * Returns an `onBeforeResponse` solid start middleware handler that adds tracing data as
 * <meta> tags to a page on pageload to enable distributed tracing.
 */
export function sentryBeforeResponseMiddleware() {
 return async function onBeforeResponse(event: FetchEvent, response: ResponseMiddlewareResponse) {
 if (!response.body || response.__sentry_wrapped__) {
 return;
 }

 // Ensure we don't double-wrap, in case a user has added the middleware twice
 // e.g. once manually, once via the wizard
 addNonEnumerableProperty(response, '__sentry_wrapped__', true);

 const contentType = event.response.headers.get('content-type');
 const isPageloadRequest = contentType && contentType.startsWith('text/html');

 if (!isPageloadRequest) {
 return;
 }

 const body = response.body as NodeJS.ReadableStream;
 const decoder = new TextDecoder();
 response.body = new ReadableStream({
 start: async controller => {
 for await (const chunk of body) {
 const html = typeof chunk === 'string' ? chunk : decoder.decode(chunk, { stream: true });
 const modifiedHtml = addMetaTagToHead(html);
 controller.enqueue(new TextEncoder().encode(modifiedHtml));
 }
 controller.close();
 },
 });
 };
}

82 changes: 82 additions & 0 deletions
packages/solidstart/test/middleware.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
import * as SentryCore from '@sentry/core';
import { beforeEach, describe, it, vi } from 'vitest';
import { sentryBeforeResponseMiddleware } from '../src/middleware';
import type { ResponseMiddlewareResponse } from '../src/middleware';

describe('middleware', () => {
 describe('sentryBeforeResponseMiddleware', () => {
 vi.spyOn(SentryCore, 'getTraceData').mockReturnValue({
 'sentry-trace': '123',
 baggage: 'abc',
 });

 const mockFetchEvent = {
 request: {},
 locals: {},
 response: {
 // mocks a pageload
 headers: new Headers([['content-type', 'text/html']]),
 },
 nativeEvent: {},
 };

 let mockMiddlewareHTMLResponse: ResponseMiddlewareResponse;
 let mockMiddlewareHTMLNoHeadResponse: ResponseMiddlewareResponse;
 let mockMiddlewareJSONResponse: ResponseMiddlewareResponse;

 beforeEach(() => {
 // h3 doesn't pass a proper Response object to the middleware
 mockMiddlewareHTMLResponse = {
 body: new Response('<head><meta charset="utf-8"></head>').body,
 };
 mockMiddlewareHTMLNoHeadResponse = {
 body: new Response('<body>Hello World</body>').body,
 };
 mockMiddlewareJSONResponse = {
 body: new Response('{"prefecture": "Kagoshima"}').body,
 };
 });

 it('injects tracing meta tags into the response body', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLResponse);

 // for testing convenience, we pass the body back into a proper response
 // mockMiddlewareHTMLResponse has been modified by our middleware
 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html).toContain('<meta charset="utf-8">');
 expect(html).toContain('<meta name="sentry-trace" content="123">');
 expect(html).toContain('<meta name="baggage" content="abc">');
 });

 it('does not add meta tags if there is no head tag', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse(mockFetchEvent, mockMiddlewareHTMLNoHeadResponse);

 const html = await new Response(mockMiddlewareHTMLNoHeadResponse.body).text();
 expect(html).toEqual('<body>Hello World</body>');
 });

 it('does not add tracing meta tags twice into the same response', async () => {
 const onBeforeResponse1 = sentryBeforeResponseMiddleware();
 onBeforeResponse1(mockFetchEvent, mockMiddlewareHTMLResponse);

 const onBeforeResponse2 = sentryBeforeResponseMiddleware();
 onBeforeResponse2(mockFetchEvent, mockMiddlewareHTMLResponse);

 const html = await new Response(mockMiddlewareHTMLResponse.body).text();
 expect(html.match(/<meta name="sentry-trace" content="123">/g)).toHaveLength(1);
 expect(html.match(/<meta name="baggage" content="abc">/g)).toHaveLength(1);
 });

 it('does not modify a non-HTML response', async () => {
 const onBeforeResponse = sentryBeforeResponseMiddleware();
 onBeforeResponse({ ...mockFetchEvent, response: { headers: new Headers() } }, mockMiddlewareJSONResponse);

 const json = await new Response(mockMiddlewareJSONResponse.body).json();
 expect(json).toEqual({
 prefecture: 'Kagoshima',
 });
 });
 });
});

1 change: 1 addition & 0 deletions
...olidstart/tsconfig.solidrouter-types.json → ...solidstart/tsconfig.subexports-types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts",
 "src/middleware.ts",
 ],
 // Without this, we cannot output into the root dir
 "exclude": []
Expand Down

3 changes: 2 additions & 1 deletion
packages/solidstart/tsconfig.types.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
 "src/client/solidrouter.ts",
 "src/solidrouter.server.ts",
 "src/server/solidrouter.ts",
 "src/solidrouter.ts"
 "src/solidrouter.ts",
 "src/middleware.ts",
 ]
}