Add index get maybe latest version

[egoodwinx]

Background

Addressing: #6249
Added index for getMaybeLatestVersion

Description

Created postgres migration for schema_versions on target_id sorted by created_id.

Ran db:migrator and it ran successfully

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Chores
  • Enhanced backend performance by updating database indexing to boost query responsiveness and data retrieval speed.

Walkthrough

This change introduces a missing database index for the schema_versions.target_id field. A documentation file has been updated to note the addition, and a new migration file has been added to create the index on the target_id and created_at columns concurrently. The migration runner has been updated with an additional import to execute this new migration.

Changes

File(s)	Change Summary
.changeset/purple-dryers-develop.md	Documentation update noting the addition of an index on schema_versions.target_id, sorted by created_at.
packages/migrations/src/{actions/2025.02.27T00-00-00.improve-version-index-3.ts, run-pg-migrations.ts}	Introduces a new migration that creates a non-blocking index on target_id and created_at using CONCURRENTLY, and updates the migration runner to include this migration.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as Migration Runner
    participant Migration as Improve-Version-Index Migration
    participant DB as PostgreSQL Database

    Runner->>+Migration: Execute run() method
    Migration->>+DB: Run CREATE INDEX CONCURRENTLY SQL
    DB-->>-Migration: Return query result
    Migration-->>-Runner: Migration completed

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.changeset/purple-dryers-develop.md (1)

1-5: The changeset looks good but could benefit from more details.

The changeset correctly identifies the patch and describes the addition of the index, but it could be enhanced with more information such as:

• A reference to the GitHub issue Improve DB index for getMaybeLatestVersion database query #6249
• The performance impact of this change
• An example of the affected query pattern

---
'hive': patch
---

-Added missing index for postgres db field "schema_versions.target_id" sorted with "created_at"
+Added missing index for postgres db field "schema_versions.target_id" sorted with "created_at"
+
+This index improves the performance of the `getMaybeLatestVersion` function by optimizing queries that filter by target_id and sort by created_at.
+
+Fixes: https://github.com/graphql-hive/console/issues/6249

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0aadd6b and da85679.

📒 Files selected for processing (3)

• .changeset/purple-dryers-develop.md (1 hunks)
• packages/migrations/src/actions/2025.02.27T00-00-00.improve-version-index-3.ts (1 hunks)
• packages/migrations/src/run-pg-migrations.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`.changeset/**`: A special folder with the files created/man...

.changeset/**: A special folder with the files created/managed by Changesets tool.
In PRs that already includes this file, please make sure that the content of the markdown file includes:

• Full description of the change
• A link to the relevant GitHub issues (if any)
• Example with before/after
• If the change is of type major, please ensure that the content have content about migration with before/after.

• .changeset/purple-dryers-develop.md

🔇 Additional comments (2)

packages/migrations/src/run-pg-migrations.ts (1)

162-162: Import of new migration looks good.

The new migration is correctly added to the migrations array, maintaining the chronological order based on the date in the filename.

packages/migrations/src/actions/2025.02.27T00-00-00.improve-version-index-3.ts (1)

1-12: Migration implementation looks good.

The migration correctly:

1. Uses noTransaction: true which is required for CREATE INDEX CONCURRENTLY
2. Creates an index on target_id with created_at DESC which aligns with the goal of optimizing the getMaybeLatestVersion function
3. Names the index appropriately to reflect its purpose

[n1ru4l]

Running the following query with SET enable_seqscan = OFF;

explain SELECT 
  sv.*
FROM schema_versions as sv 
LEFT JOIN targets as t ON (t.id = sv.target_id) 
WHERE sv.target_id = gen_random_uuid() AND t.project_id = gen_random_uuid()
ORDER BY sv.created_at DESC 
LIMIT 1 

Without this index:

Limit  (cost=61.67..61.68 rows=1 width=379)
  ->  Sort  (cost=61.67..61.68 rows=1 width=379)
        Sort Key: sv.created_at DESC
        ->  Nested Loop  (cost=0.29..61.66 rows=1 width=379)
              ->  Index Scan using schema_versions_target_id on schema_versions sv  (cost=0.14..48.15 rows=1 width=379)
                    Filter: (target_id = gen_random_uuid())
              ->  Index Scan using targets_pkey on targets t  (cost=0.15..8.17 rows=1 width=16)
                    Index Cond: (id = sv.target_id)
                    Filter: (project_id = gen_random_uuid())

after:

Limit  (cost=61.67..61.68 rows=1 width=379)
  ->  Sort  (cost=61.67..61.68 rows=1 width=379)
        Sort Key: sv.created_at DESC
        ->  Nested Loop  (cost=0.29..61.66 rows=1 width=379)
              ->  Index Scan using idx_maybe_latest_version_id on schema_versions sv  (cost=0.14..48.15 rows=1 width=379)
                    Filter: (target_id = gen_random_uuid())
              ->  Index Scan using targets_pkey on targets t  (cost=0.15..8.17 rows=1 width=16)
                    Index Cond: (id = sv.target_id)
                    Filter: (project_id = gen_random_uuid())

I am not sure this index actually improves the performance here.