fix: Make channel endpoint backwards compatible and perform upsert if nonunique detected

[adityachoudhari26]

Summary by CodeRabbit

• New Features

  • Enhanced the deployment channel API to accept an optional parameter, offering greater flexibility in deployment version selection.

• Refactor

  • Simplified the creation and update process by automating conflict resolution, which now updates channel details when duplicates are encountered.

These improvements streamline how deployment version channels are managed and ensure seamless responses in JSON format.

[coderabbitai]

Walkthrough

The changes update the POST request handler in the release channels route. The new implementation leverages a revised schema that optionally accepts a releaseFilter field. Instead of checking for an existing channel, the code now uses an onConflictDoUpdate method to update the versionSelector when a conflict occurs based on deploymentId and name. Additionally, the handler derives the versionSelector value from either the provided versionSelector or the new releaseFilter. The method signature has been updated to reflect the new schema.

Changes

File(s)	Summary
apps/.../release-channels/route.ts	Updated POST request handler using a new schema with an optional releaseFilter; removed explicit existence check; added onConflictDoUpdate to manage conflicts and updated the method signature to use the new body type.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant A as API Server
    participant D as Database
    C->>A: POST /release-channels request
    A->>A: Parse request body using new schema (checks for versionSelector or releaseFilter)
    A->>D: Execute onConflictDoUpdate (update versionSelector on conflict)
    D-->>A: Return created/updated deployment version channel
    A-->>C: Send JSON response with channel details

Loading

Possibly related PRs

• fix: Post release channel route #201: Modifies POST request handling for deployment version channels, aligning with the function and file structure changes in this PR.
• fix: Update rbac for deployment version channel #378: Updates permission checks and POST request logic in the same file, directly related to the modifications in this PR.

Suggested reviewers

• zacharyblasczyk

Poem

I'm a rabbit on a coding spree,
Hopping through changes merrily.
OnConflictDoUpdate leads the way,
With releaseFilter bright as day.
Carrots and code — hip hip hooray!
🥕🐇

---

📜 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 43d4252 and 4d34d70.

📒 Files selected for processing (1)

• apps/webservice/src/app/api/v1/release-channels/route.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

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

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

• apps/webservice/src/app/api/v1/release-channels/route.ts

🧬 Code Definitions (1)

apps/webservice/src/app/api/v1/release-channels/route.ts (1)

apps/webservice/src/app/api/v1/environments/route.ts (1) (1)

• POST (25:90)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Typecheck
• GitHub Check: Lint
• GitHub Check: build (linux/amd64)

🔇 Additional comments (6)

apps/webservice/src/app/api/v1/release-channels/route.ts (6)

4-4: Import statements are properly added for the new functionality.

The added imports enable the new conflict resolution approach and support the extended schema requirements.

Also applies to: 8-8

---

14-16: Good approach to schema extension for backward compatibility.

The schema extends the existing createDeploymentVersionChannel schema with an optional releaseFilter field, allowing the endpoint to work with both new and old clients.

---

20-20: Body parser correctly updated to use the extended schema.

The parser now uses the extended schema which includes the optional releaseFilter field.

---

28-29: Correctly implementing backward compatibility.

The code properly handles both the legacy versionSelector and the new releaseFilter attribute, making the endpoint backward compatible as the PR title indicates.

---

31-47: Improved conflict resolution with onConflictDoUpdate.

The new implementation is more elegant and efficient than manually checking for existence:

1. Directly attempts to insert the record
2. If a conflict occurs (same deploymentId and name), updates the versionSelector field
3. Returns the first result using the takeFirst utility

This implements the "upsert" behavior as mentioned in the PR title.

---

48-48: Error handling seems appropriate.

The code properly catches any errors and returns a 500 status code with the error message.

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