feat(firebase): add error handling and rename hooks to align with otel standards

Author: JPeer264

dev-packages/e2e-tests/test-applications/node-firebase/functions/src/index.ts

@@ -18,6 +18,10 @@ export const helloWorld = onRequest(async (request, response) => {
   response.send('Hello from Firebase!');
 });
 
+export const unhandeledError = onRequest(async (request, response) => {
+  throw new Error('There is an error!');
+});
+
 export const onCallSomething = onRequest(async (request, response) => {
   const data = {
     name: request.body?.name || 'Sample Document',

dev-packages/e2e-tests/test-applications/node-firebase/package.json

@@ -21,7 +21,8 @@
   },
   "devDependencies": {
     "@playwright/test": "~1.53.2",
-    "@sentry-internal/test-utils": "link:../../../test-utils"
+    "@sentry-internal/test-utils": "link:../../../test-utils",
+    "firebase": "^12.0.0"
   },
   "volta": {
     "extends": "../../package.json"

dev-packages/e2e-tests/test-applications/node-firebase/tests/functions.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from '@playwright/test';
-import { waitForTransaction } from '@sentry-internal/test-utils';
+import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
 
 test('should only call the function once without any extra calls', async () => {
   const serverTransactionPromise = waitForTransaction('node-firebase', span => {
@@ -15,6 +15,7 @@ test('should only call the function once without any extra calls', async () => {
     expect.objectContaining({
       trace: expect.objectContaining({
         data: {
+          'cloud.project_id': 'demo-functions',
           'faas.name': 'helloWorld',
           'faas.provider': 'firebase',
           'faas.trigger': 'http.request',
@@ -34,6 +35,35 @@ test('should only call the function once without any extra calls', async () => {
   );
 });
 
+test('should send failed transaction when the function fails', async () => {
+  const errorEventPromise = waitForError('node-firebase', () => true);
+  const serverTransactionPromise = waitForTransaction('node-firebase', span => {
+    return !!span.transaction;
+  });
+
+  await fetch(`http://localhost:5001/demo-functions/default/unhandeledError`);
+
+  const transactionEvent = await serverTransactionPromise;
+  const errorEvent = await errorEventPromise;
+
+  expect(transactionEvent.transaction).toEqual('firebase.function.http.request');
+  expect(transactionEvent.contexts?.trace?.trace_id).toEqual(errorEvent.contexts?.trace?.trace_id);
+  expect(errorEvent).toMatchObject({
+    exception: {
+      values: [
+        {
+          type: 'Error',
+          value: 'There is an error!',
+          mechanism: {
+            type: 'auto.firebase.otel.functions',
+            handled: false,
+          },
+        },
+      ],
+    },
+  });
+});
+
 test('should create a document and trigger onDocumentCreated and another with authContext', async () => {
   const serverTransactionPromise = waitForTransaction('node-firebase', span => {
     return span.transaction === 'firebase.function.http.request';
@@ -62,6 +92,7 @@ test('should create a document and trigger onDocumentCreated and another with au
   expect(transactionEvent.transaction).toEqual('firebase.function.http.request');
   expect(transactionEvent.contexts?.trace).toEqual({
     data: {
+      'cloud.project_id': 'demo-functions',
       'faas.name': 'onCallSomething',
       'faas.provider': 'firebase',
       'faas.trigger': 'http.request',
@@ -80,6 +111,7 @@ test('should create a document and trigger onDocumentCreated and another with au
   expect(transactionEvent.spans).toHaveLength(3);
   expect(transactionEventOnDocumentCreate.contexts?.trace).toEqual({
     data: {
+      'cloud.project_id': 'demo-functions',
       'faas.name': 'onDocumentCreate',
       'faas.provider': 'firebase',
       'faas.trigger': 'firestore.document.created',
@@ -98,6 +130,7 @@ test('should create a document and trigger onDocumentCreated and another with au
   expect(transactionEventOnDocumentCreate.spans).toHaveLength(2);
   expect(transactionEventOnDocumentWithAuthContextCreate.contexts?.trace).toEqual({
     data: {
+      'cloud.project_id': 'demo-functions',
       'faas.name': 'onDocumentCreateWithAuthContext',
       'faas.provider': 'firebase',
       'faas.trigger': 'firestore.document.created',

packages/node/src/integrations/tracing/firebase/firebase.ts

@@ -1,5 +1,5 @@
 import type { IntegrationFn } from '@sentry/core';
-import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
+import { captureException, defineIntegration, flush, SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
 import { addOriginToSpan, generateInstrumentOnce } from '@sentry/node-core';
 import { type FirebaseInstrumentationConfig, FirebaseInstrumentation } from './otel';
 
@@ -11,10 +11,23 @@ const config: FirebaseInstrumentationConfig = {
 
     span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'db.query');
   },
-  functionsSpanCreationHook: span => {
-    addOriginToSpan(span, 'auto.firebase.otel.functions');
+  functions: {
+    requestHook: span => {
+      addOriginToSpan(span, 'auto.firebase.otel.functions');
 
-    span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'http.request');
+      span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'http.request');
+    },
+    errorHook: async (_, error) => {
+      if (error) {
+        captureException(error, {
+          mechanism: {
+            type: 'auto.firebase.otel.functions',
+            handled: false,
+          },
+        });
+        await flush(2000);
+      }
+    },
   },
 };