feat: version dependencies by adityachoudhari26 · Pull Request #627 · ctrlplanedev/ctrlplane

adityachoudhari26 · 2025-07-23T16:38:42Z

Summary by CodeRabbit

New Features
- Added support for specifying dependencies between deployment versions, allowing deployment versions to declare and manage dependencies on other versions.
- Enhanced API endpoints for creating and updating deployment versions to accept and return a new dependencies property.
- Extended OpenAPI schema and documentation to include version dependencies.
- Introduced logic to ensure releases are only created when version dependencies are satisfied.
Bug Fixes
- None.
Refactor
- Renamed form fields and schema properties from versionDependencies to dependencies for consistency.
- Modularized and streamlined database operations in deployment version creation and update flows.
Tests
- Added comprehensive end-to-end and unit tests to verify version dependency behaviors and API contract.
Documentation
- Updated OpenAPI and related schema documentation to reflect the new version dependency capabilities.

coderabbitai · 2025-07-23T16:38:48Z

Warning

Rate limit exceeded

@adityachoudhari26 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a066244 and aa2c3f1.

📒 Files selected for processing (3)

apps/webservice/src/app/api/v1/openapi.ts (2 hunks)
e2e/api/schema.ts (8 hunks)
openapi.v1.json (4 hunks)

Walkthrough

This change introduces support for deployment version dependencies across the API, database schema, rule engine, and end-to-end tests. It adds a VersionDependency schema, enables specifying dependencies in deployment version creation and update operations, implements dependency-aware rule evaluation, and provides comprehensive tests and helper utilities to verify dependency behavior and correct release triggering.

Changes

File(s) / Path(s)	Change Summary
`apps/webservice/src/app/api/v1/deployment-versions/route.ts`, `apps/webservice/src/app/api/v1/deployment-versions/[deploymentVersionId]/route.ts`	Refactored and modularized POST and PATCH handlers for deployment versions; added logic to handle dependencies and deep equality checks for deployment triggers.
`apps/webservice/src/app/api/v1/deployment-versions/openapi.ts`, `apps/webservice/src/app/api/v1/deployment-versions/[deploymentVersionId]/openapi.ts`, `apps/webservice/src/app/api/v1/openapi.ts`, `openapi.v1.json`	Added `VersionDependency` schema and `dependencies` property to deployment version schemas and request bodies in OpenAPI specs.
`e2e/api/schema.ts`	Updated schemas to add `VersionDependency` and propagate `dependencies` through deployment version types and operations; improved type specificity for variable values.
`e2e/tests/api/deployment-version.spec.ts`	Added test for creating deployment versions with dependencies.
`e2e/tests/api/version-dependency.spec.ts`, `e2e/tests/api/version-dependency.spec.yaml`	Added new end-to-end test suite and YAML spec for version dependency scenarios, including dependency satisfaction and release creation logic.
`packages/rule-engine/src/manager/version-manager-rules.ts`, `packages/rule-engine/src/manager/version-manager-rules/version-dependency.ts`, `packages/rule-engine/src/rules/version-dependency-rule.ts`	Implemented version dependency rule logic, including DB queries and integration with rule engine aggregation.
`apps/event-worker/src/workers/job-update/index.ts`, `apps/event-worker/src/workers/job-update/utils.ts`, `apps/event-worker/src/workers/job-update/trigger-dependent-targets.ts`	Refactored job update worker, extracted utilities, and added logic to trigger evaluation of dependent release targets when dependencies are satisfied.
`packages/db/src/schema/deployment-version.ts`	Added `VersionDependencyInsert` type and renamed schema property from `versionDependencies` to `dependencies`.
`apps/webservice/src/app/[workspaceSlug]/(app)/(deploy)/_components/deployment-version/CreateDeploymentVersion.tsx`	Renamed form field and related logic from `versionDependencies` to `dependencies` in deployment version creation UI.
`packages/api/src/router/deployment-version.ts`	Updated to use `input.dependencies` instead of `input.versionDependencies` for dependency handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Webservice
    participant DB
    participant RuleEngine
    participant EventWorker

    Client->>Webservice: POST/ PATCH /deployment-versions (with dependencies)
    Webservice->>DB: Upsert deployment version, metadata, dependencies
    Webservice->>RuleEngine: Evaluate rules (including VersionDependencyRule)
    RuleEngine->>DB: Fetch dependencies, check satisfaction
    RuleEngine-->>Webservice: Rule evaluation result
    Webservice-->>Client: Response (deployment version with dependencies)
    Note over Webservice,EventWorker: If dependencies satisfied and version changed
    Webservice->>EventWorker: Enqueue deployment trigger
    EventWorker->>DB: Fetch job, release target, dependencies
    EventWorker->>RuleEngine: Evaluate dependency satisfaction
    EventWorker->>EventWorker: Trigger dependent targets if satisfied

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Possibly related PRs

e2e ongoing coverage for job queuing #589: Also involves changes to version dependencies and job triggering logic, likely sharing code paths or concepts with this PR.

Suggested reviewers

jsbroks

Poem

In fields of code, dependencies bloom,
Linking versions, dispelling the gloom.
With rules and tests, the system grows,
Each deployment version now truly knows
What must be ready, and when to hop—
A rabbit’s delight, dependencies on top!
🐇✨

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch init-version-dependencies

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests 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.

coderabbitai

Actionable comments posted: 1

🔭 Outside diff range comments (1)

packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts (1)

1-74: Rename file to fix typo

The filename contains a typo: "version-depedency.ts" should be "version-dependency.ts" to maintain consistency with the class name and avoid confusion.

🧹 Nitpick comments (1)

packages/rule-engine/src/rules/version-dependency-rule.ts (1)
1-3: Remove unused lodash import

The lodash import is not used in this file.
 import type * as schema from "@ctrlplane/db/schema";
-import _ from "lodash";
 import { isPresent } from "ts-is-present";

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c6881a and 13825da.

📒 Files selected for processing (3)

packages/rule-engine/src/manager/version-manager-rules.ts (2 hunks)
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts (1 hunks)
packages/rule-engine/src/rules/version-dependency-rule.ts (1 hunks)

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (CLAUDE.md)

**/*.{ts,tsx}: Use TypeScript with explicit types (prefer interfaces for public APIs)
Import styles: Use named imports, group imports by source (std lib > external > internal)
Consistent type imports: import type { Type } from "module"
Prefer async/await over raw promises
Handle errors explicitly (use try/catch and typed error responses)

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

⚙️ CodeRabbit Configuration File

**/*.{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.

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

**/*.{js,jsx,ts,tsx,json,md,yml,yaml}

📄 CodeRabbit Inference Engine (CLAUDE.md)

Formatting: Prettier is used with @ctrlplane/prettier-config

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

🧠 Learnings (4)

📓 Common learnings

Learnt from: adityachoudhari26
PR: ctrlplanedev/ctrlplane#601
File: e2e/tests/api/policies/retry-policy.spec.ts:23-24
Timestamp: 2025-06-24T23:52:50.732Z
Learning: The user adityachoudhari26 prefers not to add null safety checks or defensive programming in test code, particularly in e2e tests, as they prioritize simplicity and focus on the main functionality being tested rather than comprehensive error handling within the test itself.

Learnt from: adityachoudhari26
PR: ctrlplanedev/ctrlplane#601
File: e2e/tests/api/policies/retry-policy.spec.ts:117-130
Timestamp: 2025-06-24T23:53:25.398Z
Learning: User adityachoudhari26 prefers to keep non-null assertions in e2e test code without extensive null safety checks, reasoning that test failures serve the same purpose of catching issues and the extra validation doesn't add much value in test contexts.

packages/rule-engine/src/manager/version-manager-rules.ts (2)

Learnt from: adityachoudhari26
PR: #604
File: packages/rule-engine/src/manager/version-manager.ts:124-139
Timestamp: 2025-06-30T21:19:43.866Z
Learning: In packages/rule-engine/src/manager/version-manager.ts, the findDesiredVersion method should use takeFirst (not takeFirstOrNull) because if a desiredVersionId is set but the query fails to find exactly one matching version, it indicates a data integrity or configuration issue that should fail loudly rather than be handled silently.

Learnt from: adityachoudhari26
PR: #579
File: packages/rule-engine/src/rules/concurrency-rule.ts:8-11
Timestamp: 2025-06-01T19:10:47.122Z
Learning: In packages/rule-engine/src/rules/concurrency-rule.ts, the ConcurrencyRule should remain simple without additional validation since database and Zod schemas already handle concurrency validation. The user prefers this rule to be "dumb" and just perform the comparison check rather than duplicating validation logic.

packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts (6)

Learnt from: adityachoudhari26
PR: #604
File: packages/rule-engine/src/manager/version-manager.ts:124-139
Timestamp: 2025-06-30T21:19:43.866Z
Learning: In packages/rule-engine/src/manager/version-manager.ts, the findDesiredVersion method should use takeFirst (not takeFirstOrNull) because if a desiredVersionId is set but the query fails to find exactly one matching version, it indicates a data integrity or configuration issue that should fail loudly rather than be handled silently.

Learnt from: adityachoudhari26
PR: #181
File: packages/api/src/router/deployment.ts:116-131
Timestamp: 2024-10-29T02:04:50.312Z
Learning: In packages/api/src/router/deployment.ts, the list.byDeploymentId procedure requires multiple database queries due to limitations of the releaseMatchesCondition function.

Learnt from: adityachoudhari26
PR: #579
File: packages/rule-engine/src/rules/concurrency-rule.ts:8-11
Timestamp: 2025-06-01T19:10:47.122Z
Learning: In packages/rule-engine/src/rules/concurrency-rule.ts, the ConcurrencyRule should remain simple without additional validation since database and Zod schemas already handle concurrency validation. The user prefers this rule to be "dumb" and just perform the comparison check rather than duplicating validation logic.

Learnt from: adityachoudhari26
PR: #500
File: packages/db/src/schema/job.ts:117-120
Timestamp: 2025-04-21T18:34:54.764Z
Learning: In the system's job schema, the relationship between job and releaseJob is a true one-to-one relationship - a release job should only ever point to one job and vice versa. The implementation uses one(releaseJob, ...) in the jobRelations to reflect this business rule.

Learnt from: adityachoudhari26
PR: #237
File: packages/api/src/router/job.ts:362-365
Timestamp: 2024-11-27T23:18:42.055Z
Learning: In the file packages/api/src/router/job.ts, the function releaseMatchesCondition returns undefined if the filter parameter is null. This behavior ensures that when constructing the query with and(...), the condition is omitted, allowing the query to function correctly even if there is no release channel associated with the environment.

Learnt from: adityachoudhari26
PR: #237
File: apps/webservice/src/app/[workspaceSlug]/(app)/_components/deployment-resource-drawer/DeploymentResourceDrawer.tsx:43-50
Timestamp: 2024-11-27T23:16:35.580Z
Learning: In DeploymentResourceDrawer.tsx, the isOpen variable already checks whether deploymentId, environmentId, and resourceId are non-null, so additional null checks in query enabled conditions are not necessary.

packages/rule-engine/src/rules/version-dependency-rule.ts (2)

Learnt from: adityachoudhari26
PR: #604
File: packages/rule-engine/src/manager/version-manager.ts:124-139
Timestamp: 2025-06-30T21:19:43.866Z
Learning: In packages/rule-engine/src/manager/version-manager.ts, the findDesiredVersion method should use takeFirst (not takeFirstOrNull) because if a desiredVersionId is set but the query fails to find exactly one matching version, it indicates a data integrity or configuration issue that should fail loudly rather than be handled silently.

Learnt from: adityachoudhari26
PR: #579
File: packages/rule-engine/src/rules/concurrency-rule.ts:8-11
Timestamp: 2025-06-01T19:10:47.122Z
Learning: In packages/rule-engine/src/rules/concurrency-rule.ts, the ConcurrencyRule should remain simple without additional validation since database and Zod schemas already handle concurrency validation. The user prefers this rule to be "dumb" and just perform the comparison check rather than duplicating validation logic.

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (CLAUDE.md)

**/*.{ts,tsx}: Use TypeScript with explicit types (prefer interfaces for public APIs)
Import styles: Use named imports, group imports by source (std lib > external > internal)
Consistent type imports: import type { Type } from "module"
Prefer async/await over raw promises
Handle errors explicitly (use try/catch and typed error responses)

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

⚙️ CodeRabbit Configuration File

**/*.{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.

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

**/*.{js,jsx,ts,tsx,json,md,yml,yaml}

📄 CodeRabbit Inference Engine (CLAUDE.md)

Formatting: Prettier is used with @ctrlplane/prettier-config

Files:

packages/rule-engine/src/manager/version-manager-rules.ts
packages/rule-engine/src/manager/version-manager-rules/version-depedency.ts
packages/rule-engine/src/rules/version-dependency-rule.ts

🧠 Learnings (4)

📓 Common learnings

Learnt from: adityachoudhari26
PR: ctrlplanedev/ctrlplane#601
File: e2e/tests/api/policies/retry-policy.spec.ts:23-24
Timestamp: 2025-06-24T23:52:50.732Z
Learning: The user adityachoudhari26 prefers not to add null safety checks or defensive programming in test code, particularly in e2e tests, as they prioritize simplicity and focus on the main functionality being tested rather than comprehensive error handling within the test itself.

Learnt from: adityachoudhari26
PR: ctrlplanedev/ctrlplane#601
File: e2e/tests/api/policies/retry-policy.spec.ts:117-130
Timestamp: 2025-06-24T23:53:25.398Z
Learning: User adityachoudhari26 prefers to keep non-null assertions in e2e test code without extensive null safety checks, reasoning that test failures serve the same purpose of catching issues and the extra validation doesn't add much value in test contexts.