Add states and events url to Deployment protobuf#1761
Conversation
📝 WalkthroughWalkthroughAdded two new string fields ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @src/protos/io/defang/v1/fabric.proto:
- Around line 472-473: Deployment message fields states_url and events_url are
declared but never set or used; update the server-side ListDeployments handler
(where Deployment objects are built) to populate Deployment.states_url and
Deployment.events_url with the correct endpoints/URLs (e.g., per-deployment
state and event stream paths), and update any client code/tests that construct
or consume Deployment to use these fields instead of empty values;
alternatively, if these URLs are not needed, remove states_url and events_url
from the Deployment proto and all server/client/test references to avoid dead
contract surface. Ensure the change is applied consistently: set the fields in
the ListDeployments response builder (and any Create/Update responses), adjust
clients to read and use Deployment.states_url/Deployment.events_url, and
update/augment unit tests to assert the presence and correctness of these fields
(or remove proto fields and tests that reference them).
🧹 Nitpick comments (1)
src/protos/io/defang/v1/fabric.proto (1)
472-473: Consider adding inline documentation for the new URL fields.Adding comments would clarify the purpose and expected format of these URLs (e.g., what do the states and events URLs point to, are they absolute URLs, do they require authentication).
📝 Example documentation
DeploymentStatus status = 13; - string states_url = 14; - string events_url = 15; + string states_url = 14; // URL to access deployment state information + string events_url = 15; // URL to access deployment event logs
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
src/protos/io/defang/v1/fabric.pb.gois excluded by!**/*.pb.go
📒 Files selected for processing (1)
src/protos/io/defang/v1/fabric.proto
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Analyze (go)
- GitHub Check: go-test
🔇 Additional comments (1)
src/protos/io/defang/v1/fabric.proto (1)
472-473: LGTM! Field additions are syntactically correct and backward compatible.The new URL fields follow proper protobuf conventions with sequential field numbering and snake_case naming. The additions are backward compatible since proto3 fields are optional by default.
Description
To allow deployment to capture states and events.
Linked Issues
https://github.com/DefangLabs/defang-mvp/issues/2562
Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.