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

Improve worker deployment queries #1616

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Improve worker deployment queries #1616

merged 3 commits into from
Jan 15, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Jan 15, 2025

When dequeuing runs, and in a couple of other places, we get details about the current worker deployment.

These queries were using findUnique and includes, which is a VERY BAD thing to do with Prisma because it changes the queries it produces to very bad ones when run concurrently.

Also we were selecting a lot of columns we don't need.

This PR changes to findFirst and only selecting relevant columns, for big query performance improvements.

Summary by CodeRabbit

  • Performance Optimization
    • Refined data retrieval strategy for worker deployments.
    • Optimized data structure for task handling by introducing a slimmer type.
    • Improved data fetching efficiency and reduced unnecessary data transfer.

Copy link

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: 6067088

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Jan 15, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The changes in the workerDeployment.server.ts file focus on refactoring data retrieval strategies in Prisma queries. The primary modification involves transitioning from include to select clauses, which allows for more precise and explicit field selection when fetching data. This approach changes how related data is retrieved and structured, potentially optimizing query performance and reducing unnecessary data transfer. Additionally, the TestTaskPresenter.server.ts file has been updated to utilize the new BackgroundWorkerTaskSlim type.

Changes

File Change Summary
apps/webapp/app/v3/models/workerDeployment.server.ts - Replaced include with select in Prisma queries
- Modified findCurrentWorkerDeployment to use findFirst instead of findUnique
- Updated return type of findCurrentWorkerFromEnvironment to use Pick type
- Explicitly specified fields for data retrieval
- Added new type BackgroundWorkerTaskSlim
apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts - Added import for BackgroundWorkerTaskSlim
- Changed type of task variable from `BackgroundWorkerTask

Poem

🐰 Queries dance with selective grace,
Select replaces include's embrace
Fields picked with precision's might
Performance leaps to a new height
A rabbit's code, lean and bright! 🔍

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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

pkg-pr-new bot commented Jan 15, 2025

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1616

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1616

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1616

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1616

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1616

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1616

commit: 6067088

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

🧹 Nitpick comments (1)
apps/webapp/app/v3/models/workerDeployment.server.ts (1)

Line range hint 112-137: Consider transitioning remaining queries to use select

For consistency with the PR's objectives and other changes, consider updating these queries to use select instead of include. This would maintain the pattern of explicit field selection and potentially improve query performance.

-    include: {
-      deployment: true,
-      tasks: true,
-    },
+    select: {
+      id: true,
+      friendlyId: true,
+      version: true,
+      sdkVersion: true,
+      cliVersion: true,
+      supportsLazyAttempts: true,
+      deployment: {
+        select: {
+          id: true,
+          imageReference: true,
+          version: true,
+        }
+      },
+      tasks: {
+        select: {
+          id: true,
+          friendlyId: true,
+          slug: true,
+          filePath: true,
+          exportName: true,
+          triggerSource: true,
+          machineConfig: true,
+          maxDurationInSeconds: true,
+        }
+      },
+    },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 74692a2 and 6067088.

📒 Files selected for processing (2)
  • apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts (2 hunks)
  • apps/webapp/app/v3/models/workerDeployment.server.ts (5 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 (buildjet-8vcpu-ubuntu-2204 - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (buildjet-8vcpu-ubuntu-2204 - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
apps/webapp/app/v3/models/workerDeployment.server.ts (4)

11-22: Well-defined type for optimized task data retrieval!

The BackgroundWorkerTaskSlim type effectively defines the minimal set of fields needed for task operations, which aligns well with the PR's goal of optimizing queries.


25-51: Excellent use of explicit field selection!

The transition from include to select with explicit field selection will help Prisma generate more efficient queries, reducing unnecessary data fetching.


Line range hint 57-82: Good transition to findFirst with optimized field selection!

The change from findUnique to findFirst along with explicit field selection aligns perfectly with the PR's performance optimization goals.


89-92: Precise return type definition!

The use of Pick to specify exact fields improves type safety and documents the function's output contract clearly.

apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts (1)

6-9: Clean type integration!

The integration of BackgroundWorkerTaskSlim type is well done, maintaining type safety while benefiting from the optimized field selection.

Also applies to: 119-119

@matt-aitken matt-aitken merged commit 5eb30d0 into main Jan 15, 2025
11 checks passed
@matt-aitken matt-aitken deleted the dequeue-performance branch January 15, 2025 20:34
@coderabbitai coderabbitai bot mentioned this pull request Jan 21, 2025
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.

1 participant