ZacharyZhang-NY
a02b555e66
Sweep every first-party crate source (1956 .rs files) to the project comment guidelines: delete redundant restatements, decorative banners, change narration, and end-of-line comments; keep and tighten the crucial ones (invariants, bug rationale, SAFETY blocks, ported-source attribution). No functional code changed. Every edit is proven comment-only against the prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a separate doctest-fence check. Where removing a comment made rustfmt or clippy want to re-lay-out adjacent code, the minimal triggering comment is restored so code tokens stay byte-identical. Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy --workspace --all-targets (0 warnings). Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for these guidelines (flags banners, end-of-line comments, change narration, and commented-out code).
50 lines
2.2 KiB
Rust
50 lines
2.2 KiB
Rust
//! Handshake messages exchanged immediately after the WebSocket upgrade.
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::{ConnectionId, ConnectionKind, ServerId, UserId};
|
|
|
|
/// Bumped only for incompatible schema changes; additive changes go through
|
|
/// capability negotiation instead.
|
|
pub const PROTOCOL_VERSION: &str = "1.0.0";
|
|
|
|
/// First frame sent by the client after the WebSocket upgrade succeeds.
|
|
///
|
|
/// No session ids are carried at handshake time. The connection starts with
|
|
/// an empty bound-session set and binds sessions dynamically over its
|
|
/// lifetime via `register_session` / `unregister_session` JSON-RPC calls.
|
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
|
pub struct HelloMsg {
|
|
pub protocol_version: String,
|
|
pub kind: ConnectionKind,
|
|
/// Stable server identity, set only for [`ConnectionKind::ToolServer`]
|
|
/// connections, so the hub can identify the server without a separate
|
|
/// `register_server` call.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub server_id: Option<ServerId>,
|
|
/// One-line server description for `servers.list`.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub description: Option<String>,
|
|
/// Opaque metadata surfaced in `ServerInfo.metadata`.
|
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
|
pub metadata: Option<serde_json::Value>,
|
|
}
|
|
|
|
/// Computer hub's reply to [`HelloMsg`].
|
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
|
pub struct HelloAckMsg {
|
|
pub connection_id: ConnectionId,
|
|
/// Hub-derived user identity. The hub resolves this from the
|
|
/// upgrade credential (JWT `sub`, local-dev hash, etc.) so the
|
|
/// client never needs to announce it.
|
|
pub user_id: UserId,
|
|
pub computer_hub_version: String,
|
|
pub supported_protocol_versions: Vec<String>,
|
|
/// Optional JSON-RPC methods this hub supports beyond the base
|
|
/// protocol (wire method strings, e.g. `"session_attach_server"`).
|
|
/// Absent on hubs predating the field; additive, so clients gate
|
|
/// per-call fallbacks on membership instead of probing.
|
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
|
pub capabilities: Vec<String>,
|
|
}
|