chore(ME-4100): allow standalone services

[btoonk]

Summary by CodeRabbit

• New Features
  • Enhanced network state message to support standalone services
  • Added new service-related flags for standalone and deletion status

[coderabbitai]

Walkthrough

This pull request introduces modifications to the protocol buffer definitions related to network services. In common/messages.proto, a new field standalone_services is added to the NetworkStateMessage, allowing multiple Service instances to be included. Simultaneously, in device/device.proto, the Service message is expanded with two new boolean fields: standalone and delete, which provide additional metadata about service characteristics.

Changes

File	Change Summary
common/messages.proto	Added repeated Service standalone_services = 9; to NetworkStateMessage
device/device.proto	Added bool standalone = 15; and bool delete = 16; to Service message

Sequence Diagram

sequenceDiagram
    participant Client
    participant NetworkState
    participant ServiceManager
    
    Client->>NetworkState: Update Network State
    NetworkState->>ServiceManager: Include Standalone Services
    ServiceManager-->>NetworkState: Process Services
    NetworkState-->>Client: Confirm Update

Loading

Possibly related PRs

• chore(ME-3667): add service message #39: Introduces new Service message in device.proto
• ME-3905: include more socket details in device state #44: Adds new fields to Service message in common/messages.proto
• ME-3944: add a few missing service metadata fields to the device state #49: Expands service message structure in common/messages.proto

Suggested reviewers

• pedroandrade
• waltzofpearls
• adrianosela

Poem

🐰 Protocols dance, messages flow
New fields bloom where services grow
Standalone flags, delete with grace
Network state finds its rightful place
A rabbit's code, precise and bright! 🌟

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

device/device.proto (1)

65-67: LGTM! Consider adding field documentation.

The new fields align well with the PR objective to allow standalone services. The field numbers maintain backward compatibility.

Consider adding documentation comments to explain:

• When a service is considered standalone
• The lifecycle implications of the delete flag

Example:

   repeated border0.common.v1.IPAddressWithMetadata public_ips = 14;  
+  // standalone indicates whether this service can operate independently
   bool standalone = 15;
+  // delete marks this service for deletion in the next update
   bool delete = 16;

common/messages.proto (1)

70-70: LGTM! Consider adding field documentation.

The new field aligns well with the PR objective and maintains backward compatibility.

Consider adding documentation to explain the purpose and usage of standalone services:

   string network_resources_cidr_v6 = 8;
+  // standalone_services represents services that can operate independently of a network
   repeated Service standalone_services = 9;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15bed61 and a6880d6.

⛔ Files ignored due to path filters (7)

• common/messages.pb.go is excluded by !**/*.pb.go
• device/device.pb.go is excluded by !**/*.pb.go
• gen/kotlin/border0/common/v1/NetworkStateMessageKt.kt is excluded by !**/gen/**
• gen/kotlin/border0/common/v1/WireGuardPeerKt.kt is excluded by !**/gen/**
• gen/kotlin/border0/device/v1/ServiceKt.kt is excluded by !**/gen/**
• gen/swift/device.pb.swift is excluded by !**/gen/**
• gen/swift/messages.pb.swift is excluded by !**/gen/**

📒 Files selected for processing (2)

• common/messages.proto (1 hunks)
• device/device.proto (1 hunks)