Remove schedule constraints from TaskRun to prevent db load issues when a schedule or instance is deleted

[ericallam]

Summary by CodeRabbit

• New Features

  • Enhanced schedule details retrieval to ensure more comprehensive information is shown for task runs.

• Refactor

  • Consolidated and simplified the logic for fetching schedule information and managing task schedules.

• Bug Fixes

  • Improved handling of scheduled tasks, including scenarios where associated organizations are removed, to prevent unintended updates.
  • Increased deletion accuracy for task schedules by using unique identifiers.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3dda9f8

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes refactor how schedule data is retrieved and handled across the application. Dedicated asynchronous functions (resolveSchedule) have been introduced in multiple presenters and routes to fetch schedule details using a scheduleId instead of embedding schedule data directly. Adjustments include revised deletion logic altering constraints from schedule friendly IDs to unique IDs, and a conditional return for deleted organizations in task triggers. Additionally, database migrations drop foreign key constraints and update the Prisma schema for TaskRun to remove the schedule instance relation.

Changes

File(s)	Change Summary
apps/webapp/app/presenters/v3/ApiRetrieveRunPresenter.server.ts apps/webapp/app/presenters/v3/SpanPresenter.server.ts apps/webapp/app/routes/resources.runs.$runParam.ts	Introduced new asynchronous resolveSchedule functions to retrieve schedule details using a scheduleId. Refactored schedule data handling by replacing direct selection with resolution logic in API and route handlers.
apps/webapp/app/v3/services/deleteTaskSchedule.server.ts	Modified deletion criteria to target the schedule based on its unique identifier (id) rather than its friendly ID.
apps/webapp/app/v3/services/triggerScheduledTask.server.ts	Added an additional check to detect if a task schedule's associated organization is deleted. If deleted, the function logs a debug message and exits early without updating the task schedule.
internal-packages/database/prisma/migrations/20250206170153_drop_task_schedule_foreign_key_constraints_on_task_run/migration.sql	Dropped foreign key constraints (TaskRun_scheduleId_fkey and TaskRun_scheduleInstanceId_fkey) from the "TaskRun" table, affecting referential integrity enforcement.
internal-packages/database/prisma/schema.prisma	Updated the TaskRun model by removing the scheduleInstance relation and modifying the scheduleId field to a simple string, thereby eliminating the direct relation to the TaskSchedule model.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Presenter
    participant ScheduleResolver
    participant Database

    Client->>Presenter: Request run data (with scheduleId)
    Presenter->>ScheduleResolver: Call resolveSchedule(scheduleId)
    ScheduleResolver->>Database: Query schedule details by scheduleId
    Database-->>ScheduleResolver: Return schedule info or undefined
    ScheduleResolver-->>Presenter: Return formatted schedule object
    Presenter-->>Client: Return run data with schedule details

Loading

Possibly related PRs

• fix: removing schedule instance no longer crashes #1430: The changes in the main PR and the retrieved PR are related as both introduce a resolveSchedule function to handle schedule data retrieval, albeit in different contexts and classes.
• fix: cleanup ttl expire run graphile jobs #1373: The changes in the main PR, which involve the introduction of a new resolveSchedule function and modifications to how schedule data is retrieved using scheduleId, are related to the changes in the retrieved PR, where a similar resolveSchedule function is introduced in the SpanPresenter class to handle schedule information.
• Move run ttl and delays from graphile to redis worker #1672: The changes in the main PR and the retrieved PR are related through the introduction of the resolveSchedule function in both the ApiRetrieveRunPresenter and SpanPresenter classes, which encapsulates the logic for fetching schedule details based on scheduleId.

Suggested Reviewers

• matt-aitken

Poem

In a meadow of code, I happily bound,
Hopping through functions where logic is found.
I nibble on carrots of refactored delight,
As schedules are resolved in the soft moonlight.
With each new change, my joy does abound—
A rabbit’s cheer in the code playground! 🐇

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

apps/webapp/app/presenters/v3/SpanPresenter.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.

apps/webapp/app/v3/services/triggerScheduledTask.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.

• 2 others

---

📜 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 f8bf3c6 and 3dda9f8.

📒 Files selected for processing (7)

• apps/webapp/app/presenters/v3/ApiRetrieveRunPresenter.server.ts (3 hunks)
• apps/webapp/app/presenters/v3/SpanPresenter.server.ts (3 hunks)
• apps/webapp/app/routes/resources.runs.$runParam.ts (3 hunks)
• apps/webapp/app/v3/services/deleteTaskSchedule.server.ts (1 hunks)
• apps/webapp/app/v3/services/triggerScheduledTask.server.ts (1 hunks)
• internal-packages/database/prisma/migrations/20250206170153_drop_task_schedule_foreign_key_constraints_on_task_run/migration.sql (1 hunks)
• internal-packages/database/prisma/schema.prisma (1 hunks)

✨ 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

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