feat(node): Add Hapi Integration by onurtemizkan · Pull Request #9539 · getsentry/sentry-javascript

onurtemizkan · 2023-11-13T10:40:55Z

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:

const Sentry = require('@sentry/node-experimental');

Sentry.init({
  dsn: '__DSN__',
  tracesSampleRate: 1.0,
});

const Hapi = require('@hapi/hapi');

const init = async () => {
    const server = Hapi.server({
        port: 3000,
        host: 'localhost'
    });

    await server.register(Sentry.hapiErrorPlugin)

    server.route({
        method: 'GET',
        path: '/',
        handler: (request, h) => {
            throw new Error('My Hapi Sentry error!');
        }
    });

    await server.start();
};

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

'use strict';

const Sentry = require('@sentry/node');
const Hapi = require('@hapi/hapi');


const init = async () => {
    const server = Hapi.server({
        port: 3000,
        host: 'localhost'
    });

    Sentry.init({
      dsn: '__DSN__',
      tracesSampleRate: 1.0,
      integrations: [
        new Sentry.Integrations.Hapi({server}),
      ],
      debug: true,
    });

    server.route({
        method: 'GET',
        path: '/',
        handler: (request, h) => {
            return 'Hello World!';
        }
    });

    await server.start();
};

mydea · 2023-11-14T08:38:02Z

packages/node/src/integrations/hapi.ts

@@ -0,0 +1,163 @@
+import type { Boom } from '@hapi/boom';


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!

Done 👍 21beab3

packages/e2e-tests/test-applications/node-hapi-app/event-proxy-server.ts

+      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);
+        },
+      );


github-actions · 2023-11-17T02:47:46Z

size-limit report 📦

Path	Size
@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%)

mydea · 2023-11-20T14:12:43Z

packages/node/src/integrations/hapi/index.ts

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


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

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

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

mydea · 2023-11-20T14:13:06Z

packages/node/src/integrations/hapi/index.ts

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


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

mydea · 2023-11-20T14:18:38Z

packages/node/src/integrations/hapi/types.ts

+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-namespace */
+
+// Vendored and simplified from:


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

mydea

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

onurtemizkan · 2023-11-24T09:37:35Z

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

mydea

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

onurtemizkan self-assigned this Nov 13, 2023

onurtemizkan force-pushed the onur/hapi-integration branch from 0b5d80c to ddc49b1 Compare November 13, 2023 13:12

mydea reviewed Nov 14, 2023

View reviewed changes

github-advanced-security bot found potential problems Nov 17, 2023

View reviewed changes

onurtemizkan force-pushed the onur/hapi-integration branch 3 times, most recently from 0729c7f to c5c9d9c Compare November 18, 2023 06:05

onurtemizkan marked this pull request as ready for review November 18, 2023 06:24

mydea reviewed Nov 20, 2023

View reviewed changes

onurtemizkan added 5 commits November 27, 2023 13:50

feat(node): Add Hapi Integration

53a460b

Vendor hapi / boom types.

3dddac1

Use vendored types.

b48d46a

Add E2E tests.

52a7f1d

Address review comments.

d8bb0e1

onurtemizkan force-pushed the onur/hapi-integration branch from 3561347 to d8bb0e1 Compare November 27, 2023 13:50

mydea approved these changes Dec 4, 2023

View reviewed changes

mydea merged commit c0c5eca into develop Dec 18, 2023

mydea deleted the onur/hapi-integration branch December 18, 2023 10:22

AbhiPrasad mentioned this pull request Dec 19, 2023

meta(changelog): Update changelog for 7.89.0 #9915

Merged

joshkel mentioned this pull request Mar 12, 2024

Error handling within Hapi Sentry integration #11069

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(node): Add Hapi Integration#9539

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

onurtemizkan commented Nov 13, 2023 •

edited

Loading

Uh oh!

mydea Nov 14, 2023

Uh oh!

onurtemizkan Nov 15, 2023

Uh oh!

Check failure

github-actions bot commented Nov 17, 2023 •

edited

Loading

Uh oh!

mydea Nov 20, 2023

Uh oh!

mydea Nov 22, 2023

Uh oh!

mydea Nov 20, 2023

Uh oh!

mydea Nov 20, 2023

Uh oh!

mydea left a comment

Uh oh!

onurtemizkan commented Nov 24, 2023

Uh oh!

mydea left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

onurtemizkan commented Nov 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mydea Nov 14, 2023

Choose a reason for hiding this comment

Uh oh!

onurtemizkan Nov 15, 2023

Choose a reason for hiding this comment

Uh oh!

Check failure

github-actions bot commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

mydea Nov 20, 2023

Choose a reason for hiding this comment

Uh oh!

mydea Nov 22, 2023

Choose a reason for hiding this comment

Uh oh!

mydea Nov 20, 2023

Choose a reason for hiding this comment

Uh oh!

mydea Nov 20, 2023

Choose a reason for hiding this comment

Uh oh!

mydea left a comment

Choose a reason for hiding this comment

Uh oh!

onurtemizkan commented Nov 24, 2023

Uh oh!

mydea left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

onurtemizkan commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 17, 2023 •

edited

Loading