Skip to content

Schedules list performance #1938

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

Merged
merged 2 commits into from
Apr 17, 2025
Merged

Schedules list performance #1938

merged 2 commits into from
Apr 17, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Apr 17, 2025

Added some indexes to improve the performance of the Schedules page/list function

These should be run before we deploy to avoid Prisma applying them non-concurrently and blocking db updates:

-- CreateIndex
CREATE INDEX CONCURRENTLY IF NOT EXISTS "TaskSchedule_projectId_idx" ON "TaskSchedule" ("projectId");

-- CreateIndex
CREATE INDEX CONCURRENTLY IF NOT EXISTS "TaskSchedule_projectId_createdAt_idx" ON "TaskSchedule" ("projectId", "createdAt" DESC);

Summary by CodeRabbit

  • New Features

    • Schedule lists now display the creation timestamp for each item and show the most recently created schedules first.
  • Performance Improvements

    • Improved loading speed and responsiveness of schedule lists, especially for projects with many schedules.

Copy link

changeset-bot bot commented Apr 17, 2025

⚠️ No Changeset found

Latest commit: a378a2a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Apr 17, 2025

Walkthrough

The changes introduce enhancements to the retrieval and indexing of TaskSchedule records. The backend query now includes the createdAt field and sorts results by this timestamp in descending order, ensuring the most recently created schedules appear first. Corresponding database schema and migration updates add two indexes to the TaskSchedule table: one on projectId and another composite index on projectId and createdAt (descending). These adjustments aim to optimize query performance for dashboard list views.

Changes

File(s) Change Summary
apps/webapp/app/presenters/v3/ScheduleListPresenter.server.ts Added createdAt to selected columns and ordered query results by createdAt descending.
internal-packages/database/prisma/migrations/.../migration.sql Added two indexes: one on projectId and one composite on projectId, createdAt DESC to the table.
internal-packages/database/prisma/schema.prisma Declared the new indexes on the TaskSchedule model for dashboard optimization.

Sequence Diagram(s)

sequenceDiagram
    participant WebApp
    participant Presenter
    participant Database

    WebApp->>Presenter: Request TaskSchedule list
    Presenter->>Database: Query TaskSchedule (selects createdAt, orders by createdAt DESC)
    Database-->>Presenter: Return ordered TaskSchedule records
    Presenter-->>WebApp: Return schedule list (with createdAt)
Loading

Poem

Schedules now sparkle with time on their side,
Indexed and sorted, they elegantly glide.
With queries sped up and order restored,
The dashboard’s delight cannot be ignored!
🐇✨

— A rabbit, hopping through the code

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 33e7b68 and a378a2a.

📒 Files selected for processing (3)
  • apps/webapp/app/presenters/v3/ScheduleListPresenter.server.ts (2 hunks)
  • internal-packages/database/prisma/migrations/20250417135530_task_schedule_dashboard_indexes/migration.sql (1 hunks)
  • internal-packages/database/prisma/schema.prisma (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
internal-packages/database/prisma/schema.prisma (1)

2936-2938: Excellent index additions for list performance optimization.

The added indexes on projectId and the composite index on projectId and createdAt(sort: Desc) are well-designed for the dashboard list view. Using these indexes will optimize query performance when filtering schedules by project and sorting by creation date.

apps/webapp/app/presenters/v3/ScheduleListPresenter.server.ts (2)

166-166: Good addition of createdAt to the select clause.

Including the createdAt field in the select clause correctly supports the new sorting functionality, making it available for the UI if needed.


210-212: Well-aligned ordering with the new database index.

Adding the explicit ordering by createdAt in descending order properly leverages the new composite index created on the TaskSchedule table. This change will improve query performance when retrieving sorted schedules.

internal-packages/database/prisma/migrations/20250417135530_task_schedule_dashboard_indexes/migration.sql (1)

1-5: Well-designed database migration for non-blocking index creation.

This migration script is excellent for several reasons:

  1. Using CREATE INDEX CONCURRENTLY prevents table locks during index creation, which is critical for production environments
  2. The IF NOT EXISTS clause makes the migration more robust
  3. The indexes align perfectly with the query patterns in the ScheduleListPresenter
  4. The descending sort order on createdAt matches the sorting needs of the UI

As noted in the PR description, you should run these commands before deployment to prevent Prisma from applying them non-concurrently.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@matt-aitken matt-aitken merged commit 5597291 into main Apr 17, 2025
12 checks passed
@matt-aitken matt-aitken deleted the schedules-list-performance branch April 17, 2025 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants