Add display name to common service

[pedroandrade]

Description

Add display name to services common package

Summary by CodeRabbit

• New Features
  • Added a new optional display name field for services, allowing for more descriptive service information.

[coderabbitai]

Walkthrough

A new optional string field named display_name with tag number 13 was added to the Service message in the common/messages.proto protobuf schema. No other changes were made to the file or message definitions.

Changes

Cohort / File(s)	Change Summary
Protobuf Schema Update common/messages.proto	Added optional display_name (string, tag 13) to the Service message.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: add display name to golang protobuf #57: Adds a display_name field to a Service message in a different protobuf file, suggesting related but distinct schema enhancements.

Suggested reviewers

• waltzofpearls

Poem

A field called display_name hops in with grace,
Now every Service can show its face.
Just a string, but oh what cheer,
For clarity’s sake, it now appears!
🐰✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ME-4926-add-display-name-to-common-services

---

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

Support

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

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.

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9861c75 and bc5efaf.

⛔ Files ignored due to path filters (3)

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

📒 Files selected for processing (1)

• common/messages.proto (1 hunks)

[coderabbitai]

💡 Verification agent

❓ Verification inconclusive

optional keyword missing – current field has no presence tracking

The PR description and AI summary both state that display_name should be an optional field.
In proto3, presence tracking for singular scalars (so that you can tell unset vs empty string) is only available when the field is declared with the optional keyword:

optional string display_name = 13;

Declaring it without optional (as in the current diff) turns it into a regular scalar with no presence information; clients cannot distinguish "" from not provided, which is often undesirable for UI-facing “display name” semantics.

-  string display_name = 13;
+  optional string display_name = 13;

Confirm that all language targets used in your tool-chain are on protobuf ≥ 3.15 (released 2020-12) where optional is supported; otherwise code-gen will fail.

---

Add optional to display_name for presence tracking

The display_name field in common/messages.proto needs the optional keyword so that clients can distinguish “unset” from an empty string. Without it, proto3 treats the field as a regular scalar with no presence information.

File: common/messages.proto (around line 114)

Suggested change:

-  string display_name = 13;
+  optional string display_name = 13;

• After updating, ensure your proto compiler and all language generators are using protobuf >= 3.15 (optional fields were introduced in v3.15.0) to avoid code-gen failures.

🤖 Prompt for AI Agents

In common/messages.proto around line 114, the string field display_name lacks
the optional keyword, which is needed for presence tracking to distinguish unset
from empty string values. Modify the field declaration to include the optional
keyword before string, making it "optional string display_name = 13;". After
this change, verify that the protobuf compiler and all language generators used
are version 3.15 or higher to support optional fields and prevent code
generation errors.

[th3wingman]

🚢