Add initial dashboard network protocol definition file #1274
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This `.proto` file defines a contract between the server `Aspire.Hosting` and client `Aspire.Dashboard`. It supports: - Getting basic information about the server (name and version). - Subscribing to resources, receiving both an initial snapshot and a stream of updates as they happen. - A heartbeat mechanism, to detect when the connection has dropped and allow prompting the user and/or reconnecting. - Support for arbitrary kinds of resources. Not limited to known types (project, container, executable). - Support for arbitrary commands on resources, intended for actions such as start/stop/refresh/restart/etc. The server defines the commands available for each resource, and the UI can show them. It's added to both the server and client projects, and code generation is enabled.
Turns out gRPC runs over HTTP/2 which includes a keep alive ping. We don't need to model those messages in our API thankfully.
Member
Author
|
gRPC uses HTTP/2 which has an option for keepalive pings, so we don't have to build heartbeats into the protocol, thankfully. |
drewnoakes
commented
Dec 8, 2023
drewnoakes
commented
Dec 8, 2023
drewnoakes
commented
Dec 8, 2023
JamesNK
reviewed
Dec 8, 2023
drewnoakes
commented
Dec 8, 2023
daniv-msft
reviewed
Dec 8, 2023
daniv-msft
reviewed
Dec 8, 2023
daniv-msft
reviewed
Dec 8, 2023
karolz-ms
reviewed
Dec 8, 2023
karolz-ms
reviewed
Dec 8, 2023
karolz-ms
reviewed
Dec 8, 2023
karolz-ms
reviewed
Dec 8, 2023
karolz-ms
reviewed
Dec 8, 2023
drewnoakes
force-pushed
the
add-resource-server-proto
branch
from
5620dd1 to
b834d50
Compare
karolz-ms
reviewed
Dec 11, 2023
karolz-ms
reviewed
Dec 11, 2023
karolz-ms
reviewed
Dec 11, 2023
JamesNK
reviewed
Dec 11, 2023
drewnoakes
force-pushed
the
add-resource-server-proto
branch
from
8921150 to
00c1d9b
Compare
This will be handled via OTLP.
JamesNK
reviewed
Dec 14, 2023
These have different fields.
This allows opening the file more conveniently, and the file to participate in find-in-files.
Member
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
kvenkatrajan
approved these changes
Dec 15, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This
.protofile defines a contract between the serverAspire.Hostingand clientAspire.Dashboard.It supports:
A heartbeat mechanism, to detect when the connection has dropped and allow prompting the user and/or reconnecting.It's added to both the server and client projects, and code generation is enabled.