feat(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security
, '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(node): Add Hapi Integration - #9539

Merged
mydea merged 5 commits into
developfrom
onur/hapi-integration
Dec 18, 2023
Merged

feat(node): Add Hapi Integration#9539
mydea merged 5 commits into
developfrom
onur/hapi-integration

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Nov 13, 2023

Copy link
Copy Markdown
Contributor

Resolves: #9344

Adds a new node integration for Hapi framework.

Also exports a Hapi plugin to capture errors when the tracing instrumentation from node-experimental is used.

Can be used with node-experimental (Sample Error Event) like:

constSentry=require('@sentry/node-experimental');Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,});constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});awaitserver.register(Sentry.hapiErrorPlugin)server.route({method: 'GET',path: '/',handler: (request,h)=>{thrownewError('My Hapi Sentry error!');}});awaitserver.start();};

Also can be used from @sentry/node with tracing (Errored Transaction, Successful Transaction) and error tracking (Event) like:

'use strict';constSentry=require('@sentry/node');constHapi=require('@hapi/hapi');constinit=async()=>{constserver=Hapi.server({port: 3000,host: 'localhost'});Sentry.init({dsn: '__DSN__',tracesSampleRate: 1.0,integrations: [newSentry.Integrations.Hapi({server}),],debug: true,});server.route({method: 'GET',path: '/',handler: (request,h)=>{return'Hello World!';}});awaitserver.start();};

@onurtemizkanonurtemizkan self-assigned this Nov 13, 2023
@@ -0,0 +1,163 @@
import type { Boom } from '@hapi/boom';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not/cannot use types like these, as then we need to add hapi as a dependency 😬 let's just inline the types we need in here!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍 21beab3

Comment on lines +68 to +99
const sentryRequest = https.request(
sentryIngestUrl,
{ headers: proxyRequest.headers, method: proxyRequest.method },
sentryResponse => {
sentryResponse.addListener('data', (chunk: Buffer) => {
proxyResponse.write(chunk, 'binary');
sentryResponseChunks.push(chunk);
});

sentryResponse.addListener('end', () => {
eventCallbackListeners.forEach(listener => {
const rawSentryResponseBody = Buffer.concat(sentryResponseChunks).toString();

const data: SentryRequestCallbackData = {
envelope: parseEnvelope(proxyRequestBody, new TextEncoder(), new TextDecoder()),
rawProxyRequestBody: proxyRequestBody,
rawSentryResponseBody,
sentryResponseStatusCode: sentryResponse.statusCode,
};

listener(Buffer.from(JSON.stringify(data)).toString('base64'));
});
proxyResponse.end();
});

sentryResponse.addListener('error', err => {
throw err;
});

proxyResponse.writeHead(sentryResponse.statusCode || 500, sentryResponse.headers);
},
);

Check failure

Code scanning / CodeQL

Server-side request forgery

The [URL](1) of this request depends on a [user-provided value](2).
@github-actions

github-actionsBot commented Nov 17, 2023

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)66.02 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)56.21 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)31.19 KB (0%)
@sentry/browser - Webpack (gzipped)21.4 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)62.65 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)29.47 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)21.55 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)197.27 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)89.15 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)64.12 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)32.12 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)66.43 KB (0%)
@sentry/react - Webpack (gzipped)21.45 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)83.16 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)48.32 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)16.19 KB (0%)

@onurtemizkan
onurtemizkanforce-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9cCompareNovember 18, 2023 06:05
@onurtemizkan
onurtemizkan marked this pull request as ready for review November 18, 2023 06:24
}

function sendErrorToSentry(errorData: object): void {
captureException(errorData, scope => {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: if we merge #9590 first, update this later!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, merged this in yet, so we can refactor this to this instead:

captureException(errorData,{mechanism: {type: 'hapi',handled: false,data: {function: 'hapiErrorPlugin',},}});


export const hapiErrorPlugin = {
name: 'SentryHapiErrorPlugin',
version: '0.0.1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this SDK_VERSION, which we can import from core?

/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */

// Vendored and simplified from:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we possibly add the versions here we vendored from, may make future updating easier? 😅

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small comments, but overall this looks great! nice E2E tests 🎉

@onurtemizkan

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @mydea. I updated the PR 👍

@mydeamydea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

back from my vacation, this looks great, thank you!

@mydea
mydea merged commit c0c5eca into developDec 18, 2023
@mydea
mydea deleted the onur/hapi-integration branch December 18, 2023 10:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Supportability of the Hapi Framework Integration

3 participants

@onurtemizkan@mydea@github-advanced-security