permify icon indicating copy to clipboard operation
permify copied to clipboard

refactor: transaction fetching updated as bulk queries

Open ucatbas opened this issue 1 year ago • 1 comments

The transaction fetching logic is refactored to improve performance by implementing bulk queries for retrieving recent transactions and associated data changes. Previously transactions were fetched one by one or in smaller batches, which led to performance bottlenecks, especially when processing a large number of changes. This refactor optimizes the querying process and reduces the number of database calls.

Updates:

  • Bulk Query for Recent Transactions: This reduces round-trip time between the application and the database, improving overall performance.
  • Batch Processing for Changes: Eliminates repeated calls for individual transactions, reducing overhead and load on the database.
  • Performance Improvements: The getRecentXIDs and getBatchChanges methods are now optimized for high-throughput scenarios.

Summary by CodeRabbit

  • New Features

    • Enhanced transaction monitoring with support for batch processing of transaction IDs.
    • Implemented an exponential backoff strategy for improved efficiency in polling for changes.
    • Added new indexes to improve query performance on key database tables.
  • Bug Fixes

    • Improved handling of transaction ID retrieval to ensure accurate results with a specified limit.

ucatbas avatar Oct 18 '24 10:10 ucatbas

Walkthrough

The changes in the pull request focus on two main areas: the addition of new indexes in the PostgreSQL migration script and enhancements to the Watch struct in the internal/storage/postgres/watch.go file. The migration introduces two new indexes to improve query performance on the attributes and relation_tuples tables. Concurrent creation and rollback mechanisms are included. The Watch struct modifications implement an exponential backoff strategy and allow batch processing of transaction IDs, improving the efficiency of database change handling.

Changes

File Path Change Summary
internal/storage/postgres/migrations/20241018182912_add_watch_indexes.sql - Added two new indexes: idx_attributes_txid and idx_relation_tuples_txid for improved query performance.
- Included rollback mechanism for concurrent dropping of indexes.
internal/storage/postgres/watch.go - Added sleep variable of type *time.Timer for exponential backoff.
- Updated Watch method with maxSleepDuration and sleepDuration.
- Modified getRecentXIDs to include a limit parameter.
- Replaced getChanges with getBatchChanges, accepting a slice of types.XID8 values.
- Adjusted SQL queries to handle batch processing and added logging for transaction IDs.

Poem

🐇 In the land of code, where changes bloom,
A timer now ticks, dispelling the gloom.
Batch processing hops, like rabbits in play,
Fetching IDs swiftly, come what may.
With exponential waits, we’ll dance through the night,
In the world of Postgres, our future is bright! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 96315c44c8cdc2a0f3ca6bc2337f01569f285779 and f480205acb2f5ea9a03b19db6ff6cb35cceea425.

📒 Files selected for processing (1)
  • internal/storage/postgres/migrations/20241018182912_add_watch_indexes.sql (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • internal/storage/postgres/migrations/20241018182912_add_watch_indexes.sql

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 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.

coderabbitai[bot] avatar Oct 18 '24 10:10 coderabbitai[bot]