fix: delete deployment variables when you delete the deployment

[zacharyblasczyk]

Summary by CodeRabbit

• New Features
  • Deleting a deployment now automatically removes its related variable records, ensuring cleaner data integrity and reducing manual cleanup.
• Chores
  • Updated internal logs to record these database enhancements for improved system tracking and maintenance.

[coderabbitai]

Walkthrough

The changes update foreign key constraints in two database tables so that the deployment_id now references the id column in the public.deployment table with a cascade on delete behavior. The SQL script drops old constraints and adds the new ones with error handling for duplicate objects, while the TypeScript schema definitions are updated accordingly. Additionally, a new journal entry is appended to the meta file to record the migration.

Changes

Files	Change Summary
packages/db/drizzle/0076_kind_lady_ursula.sql, packages/db/src/schema/deployment-variables.ts	Updated foreign key constraints for deployment_id in deployment_variable and deployment_variable_set tables to reference public.deployment(id) with cascading delete behavior; SQL script adds constraints with exception handling and TypeScript schema definitions now include { onDelete: "cascade" }.
packages/db/drizzle/meta/_journal.json	Appended a new journal entry with index 76, version "7", a timestamp, tag "0076_kind_lady_ursula", and breakpoints set to true.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant DeploymentTable as "Deployment Table"
    participant VariableTable as "Variable Table"
    participant VariableSetTable as "Variable Set Table"
    
    Client->>DeploymentTable: Request deletion of deployment record
    DeploymentTable-->>VariableTable: Cascade delete related variable records
    DeploymentTable-->>VariableSetTable: Cascade delete related variable set records

Loading

Possibly related PRs

• fix: Create deployment endpoints #296: Addresses similar modifications involving the creation and deletion of deployments and their associated foreign key relationships.

Poem

In a burrow of code I cheerfully bound,
As foreign keys now cascade all around,
Constraints drop, new ones firmly in place,
Journal entries mark progress with grace,
A bunny hops with joy at each schema sound!
🐰🌟

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 57f0fd3 and 21ffaac.

📒 Files selected for processing (3)

• packages/db/drizzle/0076_kind_lady_ursula.sql (1 hunks)
• packages/db/drizzle/meta/_journal.json (1 hunks)
• packages/db/src/schema/deployment-variables.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{ts,tsx}`: **Note on Error Handling:** Avoid strict en...

**/*.{ts,tsx}: Note on Error Handling:
Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error handling. These are acceptable as long as they maintain clarity and predictability.

• packages/db/src/schema/deployment-variables.ts

🔇 Additional comments (4)

packages/db/drizzle/0076_kind_lady_ursula.sql (1)

1-15: LGTM - Well-structured migration for cascade deletion

The SQL migration correctly modifies the foreign key constraints on deployment_variable and deployment_variable_set tables to implement cascade deletion. This ensures that when a deployment is deleted, all associated deployment variables are automatically deleted as well, which matches the PR objective.

The SQL structure follows best practices:

• Drops existing constraints before adding new ones
• Uses proper error handling with the duplicate_object exception
• Includes statement breakpoints for better migration execution

packages/db/drizzle/meta/_journal.json (1)

536-543: LGTM - Proper journal entry for the migration

The new journal entry correctly tracks the migration with appropriate metadata:

• Sequential index (76)
• Consistent version (7)
• Timestamp for tracking
• Tag matching the migration filename
• Breakpoints flag consistent with other entries

packages/db/src/schema/deployment-variables.ts (2)

29-31: LGTM - TypeScript schema updated for cascade deletion

The change to include { onDelete: "cascade" } in the deploymentId reference ensures the TypeScript schema definition aligns with the SQL migration. This enables automatic deletion of deployment variables when their parent deployment is deleted.

---

110-112: LGTM - Consistent cascade deletion for deployment variable sets

The change correctly applies the same cascade deletion behavior to the deploymentVariableSet table, ensuring that variable set associations are also deleted when a deployment is removed.

✨ 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

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

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.