feat: Deployment worker

[adityachoudhari26]

Summary by CodeRabbit

• New Features

  • New deployment processing now automatically triggers workflow actions via event queuing when a deployment is created.

• Refactor

  • Improved deployment event type definitions to enhance data consistency and overall system reliability.

[coderabbitai]

Walkthrough

This pull request updates the deployment workflow by initializing the Channel.NewDeployment worker with the newDeploymentWorker function in the event worker and updating its type definition in the events package. In addition, an event queuing mechanism is added in the API deployment router to enqueue new deployments after hook creation.

Changes

File(s)	Change Summary
apps/.../index.ts packages/.../types.ts	Updated Channel.NewDeployment: In index.ts, replaced null with newDeploymentWorker; in types.ts, changed its type from an inferred type to schema.Deployment.
packages/.../deployment.ts	Added import of Channel and getQueue from @ctrlplane/events, and integrated a call to getQueue in the create mutation after inserting new hook and runbook.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant Router as hookRouter
    participant DB as Database
    participant Queue as Queue Service
    participant Worker as NewDeploymentWorker

    Client->>Router: Request new hook creation
    Router->>DB: Insert hook and runbook record
    Router->>Queue: Enqueue new deployment (getQueue)
    Queue->>Worker: Dispatch NewDeployment event

Loading

Possibly related PRs

• init event lib #440: Updates functionality related to the newDeploymentWorker in the new deployment file, complementing the changes introduced here.

Suggested reviewers

• jsbroks

Poem

I'm a little rabbit hopped with glee,
Code updates made all smooth and free,
New deployments dance in a queue so bright,
Functions and types now work just right,
With a twitch of my nose, I say hooray! 🐇✨
Happy coding in our burrow today!

---

📜 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 9ae134d and 5b43227.

📒 Files selected for processing (3)

• apps/event-worker/src/workers/index.ts (1 hunks)
• packages/api/src/router/deployment.ts (2 hunks)
• packages/events/src/types.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.

• packages/api/src/router/deployment.ts
• apps/event-worker/src/workers/index.ts
• packages/events/src/types.ts

🧬 Code Definitions (1)

apps/event-worker/src/workers/index.ts (2)

packages/events/src/types.ts (1)

• ChannelMap (24-30)

apps/event-worker/src/workers/new-deployment.ts (1)

• newDeploymentWorker (52-67)

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

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

🔇 Additional comments (5)

apps/event-worker/src/workers/index.ts (2)

7-7: Good addition of the newDeploymentWorker import

The import is correctly added to support the implementation of the Channel.NewDeployment worker.

---

15-15: Implementation of the previously null worker

Excellent change - replacing the null value with the actual worker implementation for NewDeployment channel. This properly initializes the worker that will process deployment events.

packages/api/src/router/deployment.ts (2)

16-16: Good addition of required imports

The imports for Channel and getQueue are properly added from the @ctrlplane/events module to support the new queuing functionality.

---

125-125: Well-placed event queue integration

The deployment is correctly enqueued after the hook and runbook creation but before the transaction completes. This ensures that deployment processing starts only after the database changes are committed.

The placement within the transaction ensures atomicity - if the queue addition fails, the entire transaction will be rolled back.

packages/events/src/types.ts (1)

25-25: Appropriate type definition update

The type for Channel.NewDeployment is updated to directly reference schema.Deployment, which provides a more concrete and maintainable type definition compared to the previous inferred type.

This change properly aligns with the implementation of the newDeploymentWorker in the event worker.

✨ 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 plan to trigger planning for file edits and PR creation.
• @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.