feat(node): Add firebase integration #16719
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
size-limit report 📦
|
5f1a45a to
84c5d6a
Compare
84c5d6a to
ea8c176
Compare
|
@sentry review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
PR DescriptionThis pull request introduces a new Firebase integration for Sentry Node, enabling automatic instrumentation of Firebase Firestore operations. The goal is to provide out-of-the-box performance monitoring and tracing for applications using Firebase, allowing developers to quickly identify and resolve performance bottlenecks within their Firebase interactions. Click to see moreKey Technical ChangesThe key technical changes include:
Architecture DecisionsThe architectural decisions include:
Dependencies and InteractionsThis integration depends on the following:
The integration interacts with the Firebase Firestore service by intercepting calls to its API. It also interacts with the Sentry backend by sending transaction events containing the generated spans. Risk ConsiderationsThe potential risks and considerations include:
Notable Implementation DetailsNotable implementation details include:
|
packages/node/src/integrations/tracing/firebase/otel/firebaseInstrumentation.ts
Show resolved
Hide resolved
Comment on lines
+66
to
+67
| } | ||
| diag.error(error?.message); |
There was a problem hiding this comment.
The diag.error(error?.message) may not provide sufficient context. Consider logging the full error object or providing more descriptive error messages with operation context.
Suggested change
| } | |
| diag.error(error?.message); | |
| diag.error('Firebase Firestore span creation hook failed:', error); |
Comment on lines
+253
to
+258
| spanName: string, | ||
| reference: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>, | ||
| ): Span { | ||
| const span = tracer.startSpan(`${spanName} ${reference.path}`, { kind: SpanKind.CLIENT }); | ||
| addAttributes(span, reference); | ||
| span.setAttribute(ATTR_DB_OPERATION_NAME, spanName); |
There was a problem hiding this comment.
The function addAttributes could benefit from defensive coding to handle cases where reference.firestore.toJSON() returns undefined or throws an error.
Suggested change
| spanName: string, | |
| reference: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>, | |
| ): Span { | |
| const span = tracer.startSpan(`${spanName} ${reference.path}`, { kind: SpanKind.CLIENT }); | |
| addAttributes(span, reference); | |
| span.setAttribute(ATTR_DB_OPERATION_NAME, spanName); | |
| function addAttributes<AppModelType, DbModelType extends DocumentData>( | |
| span: Span, | |
| reference: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>, | |
| ): void { | |
| try { | |
| const firestoreApp: FirebaseApp = reference.firestore.app; | |
| const firestoreOptions: FirebaseOptions = firestoreApp.options; | |
| const json: { settings?: FirestoreSettings } = reference.firestore.toJSON() || {}; | |
| const settings: FirestoreSettings = json.settings || {}; |
Comment on lines
+259
to
+269
| return span; | ||
| } | ||
|
|
||
| function addAttributes<AppModelType, DbModelType extends DocumentData>( | ||
| span: Span, | ||
| reference: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>, | ||
| ): void { | ||
| const firestoreApp: FirebaseApp = reference.firestore.app; | ||
| const firestoreOptions: FirebaseOptions = firestoreApp.options; | ||
| const json: { settings?: FirestoreSettings } = reference.firestore.toJSON() || {}; | ||
| const settings: FirestoreSettings = json.settings || {}; |
There was a problem hiding this comment.
Consider sanitizing sensitive data from Firebase options before adding them as span attributes. ProjectId and appId may be acceptable, but other fields might contain sensitive information.
Suggested change
| return span; | |
| } | |
| function addAttributes<AppModelType, DbModelType extends DocumentData>( | |
| span: Span, | |
| reference: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>, | |
| ): void { | |
| const firestoreApp: FirebaseApp = reference.firestore.app; | |
| const firestoreOptions: FirebaseOptions = firestoreApp.options; | |
| const json: { settings?: FirestoreSettings } = reference.firestore.toJSON() || {}; | |
| const settings: FirestoreSettings = json.settings || {}; | |
| const attributes: SpanAttributes = { | |
| [ATTR_DB_COLLECTION_NAME]: reference.path, | |
| [ATTR_DB_NAMESPACE]: firestoreApp.name, | |
| [ATTR_DB_SYSTEM_NAME]: 'firebase.firestore', | |
| 'firebase.firestore.type': reference.type, | |
| 'firebase.firestore.options.projectId': firestoreOptions.projectId, | |
| // Consider if these should be included for security reasons | |
| // 'firebase.firestore.options.appId': firestoreOptions.appId, | |
| // 'firebase.firestore.options.messagingSenderId': firestoreOptions.messagingSenderId, | |
| // 'firebase.firestore.options.storageBucket': firestoreOptions.storageBucket, | |
| }; |
Comment on lines
+67
to
+72
| if (typeof filePathUpdateNotifierFirebaseTools !== 'string') { | ||
| throw new Error('no CONFIG_UPDATE_NOTIFIER_FIREBASE_TOOLS environment'); | ||
| } | ||
|
|
||
| try { | ||
| filePathFirebaseTools = JSON.parse(filePathFirebaseTools); |
There was a problem hiding this comment.
The JSON.parse calls should be wrapped in try-catch blocks to handle malformed environment variables gracefully.
Suggested change
| if (typeof filePathUpdateNotifierFirebaseTools !== 'string') { | |
| throw new Error('no CONFIG_UPDATE_NOTIFIER_FIREBASE_TOOLS environment'); | |
| } | |
| try { | |
| filePathFirebaseTools = JSON.parse(filePathFirebaseTools); | |
| try { | |
| filePathFirebaseTools = JSON.parse(filePathFirebaseTools); | |
| filePathUpdateNotifierFirebaseTools = JSON.parse(filePathUpdateNotifierFirebaseTools); | |
| } catch (parseError) { | |
| throw new Error(`Failed to parse Firebase configuration: ${parseError.message}`); | |
| } |
Comment on lines
+7
to
+22
| function createJsonFile(filePath, json) { | ||
| return new Promise((resolve, reject) => { | ||
| let content = JSON.stringify(json, null, 2); | ||
|
|
||
| // replace spaces with tabs | ||
| content = content.replace(/[ ]{2}/g, '\t'); | ||
|
|
||
| fs.mkdirSync(filePath.substring(0, filePath.lastIndexOf('/')), { recursive: true }); | ||
| fs.writeFile(filePath, content, function (err) { | ||
| if (err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(); | ||
| } | ||
| }); | ||
| }); |
There was a problem hiding this comment.
The file creation operations lack proper error handling and could benefit from atomic writes to prevent partial file corruption.
Suggested change
| function createJsonFile(filePath, json) { | |
| return new Promise((resolve, reject) => { | |
| let content = JSON.stringify(json, null, 2); | |
| // replace spaces with tabs | |
| content = content.replace(/[ ]{2}/g, '\t'); | |
| fs.mkdirSync(filePath.substring(0, filePath.lastIndexOf('/')), { recursive: true }); | |
| fs.writeFile(filePath, content, function (err) { | |
| if (err) { | |
| reject(err); | |
| } else { | |
| resolve(); | |
| } | |
| }); | |
| }); | |
| function createJsonFile(filePath, json) { | |
| return new Promise((resolve, reject) => { | |
| let content = JSON.stringify(json, null, 2); | |
| // replace spaces with tabs | |
| content = content.replace(/[ ]{2}/g, '\t'); | |
| const tempPath = filePath + '.tmp'; | |
| fs.mkdirSync(filePath.substring(0, filePath.lastIndexOf('/')), { recursive: true }); | |
| fs.writeFile(tempPath, content, function (err) { | |
| if (err) { | |
| reject(err); | |
| } else { | |
| fs.rename(tempPath, filePath, (renameErr) => { | |
| if (renameErr) { | |
| reject(renameErr); | |
| } else { | |
| resolve(); | |
| } | |
| }); | |
| } | |
| }); | |
| }); | |
| } |
dev-packages/e2e-tests/test-applications/node-firebase/tests/transactions.test.ts
Show resolved
Hide resolved
Comment on lines
+23
to
+25
|
|
||
| // Inlined types from 'firebase/firestore' | ||
| export interface DocumentData { |
There was a problem hiding this comment.
The DocumentData interface allows any field which could lead to type safety issues. Consider adding stricter typing or validation.
Suggested change
| // Inlined types from 'firebase/firestore' | |
| export interface DocumentData { | |
| export interface DocumentData { | |
| readonly [field: string]: unknown; // Use unknown instead of any for better type safety | |
| } |
Comment on lines
+43
to
+59
|
|
||
| cleanup() { | ||
| echo "Stopping services..." | ||
| # Gracefully stop background processes | ||
| echo "Terminating background services..." | ||
| if [[ -n "$firebase_pid" ]]; then | ||
| kill -SIGTERM "$firebase_pid" || echo "Failed to terminate Firebase process" | ||
| wait "$firebase_pid" 2>/dev/null | ||
| fi | ||
| if [[ -n "$nginx_pid" ]]; then | ||
| kill -SIGTERM "$nginx_pid" || echo "Failed to terminate Nginx process" | ||
| wait "$nginx_pid" 2>/dev/null | ||
| fi | ||
| if [[ -n "$npm_pid" ]]; then | ||
| kill -SIGTERM "$npm_pid" || echo "Failed to terminate NPM process" | ||
| wait "$npm_pid" 2>/dev/null | ||
| fi |
There was a problem hiding this comment.
The cleanup function could be more robust by adding timeouts for graceful shutdown and fallback to SIGKILL if processes don't respond.
Suggested change
| cleanup() { | |
| echo "Stopping services..." | |
| # Gracefully stop background processes | |
| echo "Terminating background services..." | |
| if [[ -n "$firebase_pid" ]]; then | |
| kill -SIGTERM "$firebase_pid" || echo "Failed to terminate Firebase process" | |
| wait "$firebase_pid" 2>/dev/null | |
| fi | |
| if [[ -n "$nginx_pid" ]]; then | |
| kill -SIGTERM "$nginx_pid" || echo "Failed to terminate Nginx process" | |
| wait "$nginx_pid" 2>/dev/null | |
| fi | |
| if [[ -n "$npm_pid" ]]; then | |
| kill -SIGTERM "$npm_pid" || echo "Failed to terminate NPM process" | |
| wait "$npm_pid" 2>/dev/null | |
| fi | |
| cleanup() { | |
| echo "Stopping services..." | |
| # Gracefully stop background processes with timeout | |
| echo "Terminating background services..." | |
| if [[ -n "$firebase_pid" ]]; then | |
| kill -SIGTERM "$firebase_pid" || echo "Failed to terminate Firebase process" | |
| # Wait with timeout | |
| (sleep 10; kill -SIGKILL "$firebase_pid" 2>/dev/null) & | |
| wait "$firebase_pid" 2>/dev/null | |
| fi |
Comment on lines
+230
to
+240
| }; | ||
| }; | ||
| } | ||
|
|
||
| function executeContextWithSpan<T>(span: Span, callback: () => T): T { | ||
| return context.with(trace.setSpan(context.active(), span), () => { | ||
| return safeExecuteInTheMiddle( | ||
| (): T => { | ||
| return callback(); | ||
| }, | ||
| err => { |
There was a problem hiding this comment.
The span.recordException call should be wrapped in a try-catch to prevent instrumentation from breaking the application if exception recording fails.
Suggested change
| }; | |
| }; | |
| } | |
| function executeContextWithSpan<T>(span: Span, callback: () => T): T { | |
| return context.with(trace.setSpan(context.active(), span), () => { | |
| return safeExecuteInTheMiddle( | |
| (): T => { | |
| return callback(); | |
| }, | |
| err => { | |
| err => { | |
| if (err) { | |
| try { | |
| span.recordException(err); | |
| } catch (recordError) { | |
| // Log but don't throw to prevent breaking the application | |
| diag.error('Failed to record exception on span:', recordError); | |
| } | |
| } | |
| span.end(); | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continued work on #13954
Resolves: #13678
Adds instrumentation for Firebase / Firestore queries.
Updates on top of #13954:
SEMANTIC_ATTRIBUTE_SENTRY_OPtodb.queryat all times