Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix uncaught postgres error #2635

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Fix uncaught postgres error #2635

merged 1 commit into from
Dec 10, 2024

Conversation

roy-dydx
Copy link
Contributor

@roy-dydx roy-dydx commented Dec 9, 2024

Changelist

  • Fixes comlink crashes
  • Fixes comlink cold start issue

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error handling for compliance status data retrieval to prevent server crashes and improve response clarity.
  • Chores

    • Updated import statements to include new error handling utilities.
    • Made the error handling function publicly accessible for improved maintainability.

@roy-dydx roy-dydx requested a review from a team as a code owner December 9, 2024 22:18
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Warning

Rate limit exceeded

@roy-dydx has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0799e5d and c14037f.

📒 Files selected for processing (2)
  • indexer/services/comlink/src/lib/compliance-and-geo-check.ts (2 hunks)
  • indexer/services/comlink/src/lib/helpers.ts (1 hunks)

Walkthrough

The changes in this pull request focus on enhancing the error handling of the complianceAndGeoCheck middleware function within compliance-and-geo-check.ts. The implementation now includes a try-catch block around the asynchronous operation that retrieves compliance status data, allowing for the management of potential errors. In case of an error, the function calls handleInternalServerError to log the issue and respond appropriately. The import statement for handleInternalServerError has also been updated to reflect its new usage. Additionally, the handleInternalServerError function in helpers.ts has been made exportable, improving the overall error handling structure.

Changes

File Path Change Summary
indexer/services/comlink/src/lib/compliance-and-geo-check.ts Added error handling to complianceAndGeoCheck middleware with a try-catch block; updated import statement to include handleInternalServerError.
indexer/services/comlink/src/lib/helpers.ts Changed handleInternalServerError from private to exported; clarified error handling logic in handleControllerError.

Suggested reviewers

  • dydxwill

🐇 In the land of code where errors may creep,
A middleware's guard now helps us to keep.
With try-catch in place, our worries take flight,
Handling errors with care, making everything right.
So hop along, friends, to a future so bright! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
indexer/services/comlink/src/lib/compliance-and-geo-check.ts (1)

53-57: Consider cold start reliability improvements.

While using a read replica is good for performance, it might cause issues during cold starts due to replication lag. Consider:

  1. Adding a fallback to the primary database if the read replica query fails
  2. Setting an appropriate transaction isolation level to ensure consistent reads

Example implementation:

 const updatedStatus: ComplianceStatusFromDatabase[] = await ComplianceStatusTable.findAll(
   { address: [address] },
   [],
-  { readReplica: true },
+  { 
+    readReplica: true,
+    fallbackToMaster: true,
+    isolationLevel: 'READ COMMITTED'
+  },
 );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fc5ff36 and 4e18bf9.

📒 Files selected for processing (1)
  • indexer/services/comlink/src/lib/compliance-and-geo-check.ts (2 hunks)
🔇 Additional comments (2)
indexer/services/comlink/src/lib/compliance-and-geo-check.ts (2)

17-20: LGTM: Import changes align with new error handling.

The addition of handleInternalServerError import is appropriate for the new error handling implementation.


52-80: LGTM: Proper error handling implementation.

The try-catch block with handleInternalServerError appropriately handles potential PostgreSQL errors, preventing uncaught exceptions.

@roy-dydx roy-dydx force-pushed the roy/uncaughtpostgres branch from 4e18bf9 to 0799e5d Compare December 9, 2024 22:26
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
indexer/services/comlink/src/lib/helpers.ts (2)

Line range hint 85-106: LGTM! The error handling implementation looks robust.

The exported handleInternalServerError function provides comprehensive error handling with:

  • Development-specific console logging
  • Structured error logging with context (location, message, stack trace, request params)
  • Standardized 500 response

However, consider adding request headers to the logged information for better debugging capabilities.

 logger.error({
   at,
   message,
   error,
   stacktrace: error.stack,
   params: JSON.stringify(req.params),
   query: JSON.stringify(req.query),
+  headers: JSON.stringify(req.headers),
 });

Line range hint 85-106: Consider adding postgres-specific error handling.

Given that this PR aims to fix uncaught postgres errors, consider enhancing the error handling to specifically identify and handle postgres errors (e.g., connection issues, constraint violations) with appropriate status codes and messages.

 export function handleInternalServerError(
   at: string,
   message: string,
   error: Error,
   req: express.Request,
   res: express.Response,
 ): express.Response {
+  // Check for postgres-specific errors
+  if (error.name === 'SequelizeConnectionError') {
+    logger.error({
+      at,
+      message: 'Database connection error',
+      error,
+      stacktrace: error.stack,
+    });
+    return res.status(503).json({
+      errors: [{
+        msg: 'Database temporarily unavailable',
+      }],
+    });
+  }
+
   if (config.isDevelopment()) {
     // eslint-disable-next-line no-console
     console.error(error);
   }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4e18bf9 and 0799e5d.

📒 Files selected for processing (2)
  • indexer/services/comlink/src/lib/compliance-and-geo-check.ts (2 hunks)
  • indexer/services/comlink/src/lib/helpers.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • indexer/services/comlink/src/lib/compliance-and-geo-check.ts
🔇 Additional comments (1)
indexer/services/comlink/src/lib/helpers.ts (1)

Line range hint 85-106: Security review: Error handling implementation follows best practices.

The error handling correctly:

  • Logs detailed error information internally
  • Returns sanitized error messages to clients
  • Only exposes additional details in development mode

@roy-dydx roy-dydx force-pushed the roy/uncaughtpostgres branch from 0799e5d to c14037f Compare December 9, 2024 22:32
@roy-dydx roy-dydx merged commit 1b03acb into main Dec 10, 2024
16 checks passed
@roy-dydx roy-dydx deleted the roy/uncaughtpostgres branch December 10, 2024 18:44
@roy-dydx
Copy link
Contributor Author

@Mergifyio backport release/indexer/v7.x

Copy link
Contributor

mergify bot commented Dec 10, 2024

backport release/indexer/v7.x

✅ Backports have been created

@roy-dydx
Copy link
Contributor Author

https://github.com/Mergifyio backport release/indexer/v8.x

Copy link
Contributor

mergify bot commented Dec 10, 2024

backport release/indexer/v8.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Dec 10, 2024
(cherry picked from commit 1b03acb)
mergify bot pushed a commit that referenced this pull request Dec 10, 2024
(cherry picked from commit 1b03acb)
roy-dydx added a commit that referenced this pull request Dec 10, 2024
roy-dydx added a commit that referenced this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants