Prune commentary and stale Rust port notes

app-rust/src/client/config.rs

@@ -1,30 +1,8 @@
-//! What a Rust client needs to reach one enrolled server: host, port and
-//! bearer token. Mirrors the shape `ServerConfig.kt`/`Api.kt`'s
-//! `handleEnrollment` parses out of an `aiapp://enroll?host=H&port=P&token=T`
-//! deep link -- the exact link `wg-app-link`'s `enroll` module mints and
-//! `app/ui-sandbox.sh`'s banner prints, so any Rust client can enrol from
-//! the same text a phone would scan as a QR, with no second format
-//! invented for it (RUST.md's E4).
-//!
-//! [`EnrollmentStore`] persists one of these as JSON, owner-only, in a
-//! directory the caller names -- `$XDG_CONFIG_HOME/ai-app-desktop` for the
-//! desktop app, the app-private files directory on Android. **Which**
-//! directory is the only part left to the platform: the format, the file
-//! mode and the "nothing saved yet is not an error" answer are the same on
-//! both, and were written twice before this.
-//!
-//! JSON rather than the project's usual RON: `wg-app-link`'s RON house
-//! rules (`format`) are for configs a person hand-edits, and this file
-//! never is one -- only the app itself writes or reads it.
-
 use base64::Engine;
 use serde::{Deserialize, Serialize};
 use std::io;
 use std::path::{Path, PathBuf};
 
-/// One enrolled server: reachable at `https://{host}:{port}`, authenticated
-/// with `token` as a bearer header.
-///
 /// `ca_pem` is the trust anchor to pin, when the link carried one (the
 /// `ca` parameter, `wg_app_link::enroll::ca_param`). It is optional
 /// because an app built on the machine its server runs on pins the CA at
@@ -37,19 +15,11 @@ pub struct EnrolledServer {
     pub host: String,
     pub port: u16,
     pub token: String,
-    /// `#[serde(default)]` so an enrollment saved before this field
-    /// existed still loads, as the enrolled server it always was.
     #[serde(default)]
     pub ca_pem: Option<String>,
 }
 
 impl EnrolledServer {
-    /// Parses `aiapp://enroll?host=H&port=P&token=T[&ca=B]` (query order
-    /// does not matter; unrecognised keys are ignored). `token` is
-    /// percent-decoded, since `ui-sandbox.sh` encodes it precisely because
-    /// a raw token can contain `+`, which turns into a space if left to a
-    /// naive splitter.
-    ///
     /// `ca` is base64url of the certificate's DER and is rebuilt into PEM
     /// here, because that is what every consumer of it wants
     /// (`UreqTransport::new`, and the file a person points `curl --cacert`
@@ -99,13 +69,11 @@ impl EnrolledServer {
         })
     }
 
-    /// Where a `crate::client::api::UreqTransport` reaches this server.
     pub fn base_url(&self) -> String {
         format!("https://{}:{}", self.host, self.port)
     }
 }
 
-/// The `ca` parameter (base64url of DER, unpadded) as a PEM certificate.
 fn pem_from_link_param(ca: &str) -> Result<String, String> {
     let der = base64::engine::general_purpose::URL_SAFE_NO_PAD
         .decode(ca.as_bytes())
@@ -140,9 +108,6 @@ impl EnrollmentStore {
         self.dir.join("enrollment.json")
     }
 
-    /// Writes `server` under `dir`, creating it if needed, and sets the
-    /// file owner-only -- it carries a bearer token, the same reason
-    /// `server/`'s own token store is 0600.
     pub fn save(&self, server: &EnrolledServer) -> io::Result<()> {
         std::fs::create_dir_all(&self.dir)?;
         let path = self.file();
@@ -157,10 +122,6 @@ impl EnrollmentStore {
         Ok(())
     }
 
-    /// `Ok(None)` when nothing has been enrolled yet, rather than an error
-    /// -- "not enrolled" is an ordinary first-run state, not a failure
-    /// (UI_RULES' "a deliberate choice is not a problem to report" applies
-    /// just as well to a file that simply hasn't been written yet).
     pub fn load(&self) -> io::Result<Option<EnrolledServer>> {
         let path = self.file();
         match std::fs::read(&path) {
@@ -232,8 +193,6 @@ mod tests {
 
     #[test]
     fn a_percent_encoded_token_is_decoded() {
-        // ui-sandbox.sh's own reason for encoding: a raw '+' would
-        // otherwise arrive as a space.
         let server =
             EnrolledServer::parse_link("aiapp://enroll?host=h&port=1&token=a%2Bb%2Fc").unwrap();
         assert_eq!(server.token, "a+b/c");
@@ -248,9 +207,6 @@ mod tests {
         );
     }
 
-    /// The CA travels as base64url of the DER and comes back out as the
-    /// PEM every consumer of it wants -- the same round trip
-    /// `wg_app_link::enroll::ca_param` mints.
     #[test]
     fn a_ca_in_the_link_comes_back_as_pem() {
         let der = [0x30u8, 0x82, 0x01, 0xfb, 0x3e, 0x7f];
@@ -276,16 +232,12 @@ mod tests {
         );
     }
 
-    /// A link with no `ca` is an ordinary link, not a broken one: an app
-    /// that pins at build time mints and reads exactly these.
     #[test]
     fn no_ca_parameter_is_none_not_an_error() {
         let server = EnrolledServer::parse_link("aiapp://enroll?host=h&port=1&token=t").unwrap();
         assert_eq!(server.ca_pem, None);
     }
 
-    /// The half that cannot be noticed later: a `ca` that does not decode
-    /// must fail the link rather than enrolling with nothing pinned.
     #[test]
     fn a_ca_that_does_not_decode_fails_the_link() {
         let err =
@@ -314,7 +266,6 @@ mod tests {
         assert_eq!(EnrollmentStore::new(dir.path()).load().unwrap(), None);
     }
 
-    /// An enrollment written before `ca_pem` existed still loads.
     #[test]
     fn an_enrollment_without_a_ca_still_loads() {
         let dir = tempfile::tempdir().unwrap();