sofka 0.20.0

A Kubernetes TUI, reimagined in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
use super::*;

impl App {
    // ----- detail / describe --------------------------------------------

    /// Remember which view a transient sub-view (logs/detail/diff) was opened
    /// from, so `esc` returns there (e.g. back to the xray tree, not the table).
    pub(super) fn set_return_mode(&mut self) {
        // A transient sub-view (logs/detail/events) opened from a list-style
        // view returns to that view, not the table underneath it.
        self.return_mode = match self.mode {
            Mode::Xray => Mode::Xray,
            Mode::Explain => Mode::Explain,
            _ => Mode::Table,
        };
        // Remember the selected row so we can land back on it.
        self.return_selection = self.selected_ref().map(row_key);
    }

    /// Re-select the row remembered by [`set_return_mode`], by identity, so the
    /// cursor returns to the same object even if the list shifted meanwhile.
    pub(super) fn restore_selection(&mut self) {
        let Some(key) = self.return_selection.take() else {
            return;
        };
        if let Some(i) = self.rows().iter().position(|o| row_key(o) == key) {
            self.table_state.select(Some(i));
        }
    }

    pub(super) fn open_detail(&mut self) {
        self.set_return_mode();
        let Some(obj) = self.selected_ref() else {
            return;
        };
        // Helm rows are backed by the raw storage Secret — `y` should show
        // the rendered chart manifest, not that Secret's own YAML.
        if matches!(self.kind_plural.as_str(), "helm" | "helmhistory") {
            match crate::helm::decode(obj) {
                Some(rel) => {
                    self.detail = Scrollable {
                        title: format!("{} v{} — manifest", rel.name, rel.revision),
                        lines: rel.manifest.lines().map(String::from).collect(),
                        ..Default::default()
                    };
                    self.mode = Mode::Detail;
                }
                None => self.flash_warn("could not decode this Helm release revision"),
            }
            return;
        }
        let title = obj.metadata.name.clone().unwrap_or_else(|| "object".into());
        self.detail = Scrollable {
            title: format!("{title} — YAML"),
            lines: self.object_yaml(obj).into(),
            ..Default::default()
        };
        self.mode = Mode::Detail;
    }

    /// Show the selected Secret with its `data` base64-decoded (k9s `x`), as
    /// it would appear in `stringData`. A plain [`Mode::Detail`] view, so `/`
    /// search and `c` copy work like every other single-document view.
    pub(super) fn open_decoded_secret(&mut self) {
        self.set_return_mode();
        let Some(obj) = self.selected_ref() else {
            return;
        };
        let Some(data) = obj.data.get("data").and_then(Value::as_object) else {
            self.flash_warn("secret has no data");
            return;
        };
        if data.is_empty() {
            self.flash_warn("secret has no data");
            return;
        }
        let mut lines: Vec<String> = Vec::new();
        for (key, value) in data {
            lines.extend(decoded_secret_entry(key, value));
        }
        let title = obj.metadata.name.clone().unwrap_or_else(|| "secret".into());
        self.detail = Scrollable {
            title: format!("{title} — decoded"),
            lines: lines.into(),
            ..Default::default()
        };
        self.mode = Mode::Detail;
    }

    /// Describe the selection via `kubectl describe`, off-thread so the UI loop
    /// keeps rendering. Falls back to the object's YAML if kubectl is missing
    /// or fails. The result arrives as `Msg::Detail`.
    pub(super) fn describe(&mut self) {
        self.set_return_mode();
        let Some(obj) = self.selected_ref() else {
            return;
        };
        // No `kubectl describe` for a Helm release's storage Secret — show
        // the rendered NOTES.txt instead, decoded synchronously (cheap, no
        // subprocess needed).
        if matches!(self.kind_plural.as_str(), "helm" | "helmhistory") {
            match crate::helm::decode(obj) {
                Some(rel) => {
                    let lines = if rel.notes.is_empty() {
                        vec!["<no notes>".to_string()]
                    } else {
                        rel.notes.lines().map(String::from).collect()
                    };
                    self.detail = Scrollable {
                        title: format!("{} v{} — notes", rel.name, rel.revision),
                        lines: lines.into(),
                        ..Default::default()
                    };
                    self.mode = Mode::Detail;
                }
                None => self.flash_warn("could not decode this Helm release revision"),
            }
            return;
        }
        let name = obj.metadata.name.clone().unwrap_or_default();
        let plural = self.kind_plural.clone();
        let ns = obj.metadata.namespace.clone();

        // Compute the YAML fallback up front while we hold the object; the
        // selection may change before the describe completes.
        let yaml = self.object_yaml(obj);
        let yaml_title = format!("{name} — YAML");

        let tx = self.tx.clone();
        let genr = self.generation;
        let mut argv = self.kubectl_base();
        argv.extend(["describe".to_string(), plural, name.clone()]);
        if let Some(ns) = &ns {
            argv.push("-n".into());
            argv.push(ns.clone());
        }
        self.flash = format!("describing {name}");
        self.flash_err = false;
        tokio::spawn(async move {
            let msg = match tokio::process::Command::new(&argv[0])
                .args(&argv[1..])
                .output()
                .await
            {
                Ok(out) if out.status.success() => Msg::Detail {
                    generation: genr,
                    title: format!("{name} — describe"),
                    lines: String::from_utf8_lossy(&out.stdout)
                        .lines()
                        .map(String::from)
                        .collect(),
                    warn: None,
                },
                Ok(out) => {
                    let err = String::from_utf8_lossy(&out.stderr);
                    Msg::Detail {
                        generation: genr,
                        title: yaml_title,
                        lines: yaml,
                        warn: Some(format!(
                            "kubectl describe failed ({}); showing YAML",
                            err.lines().next().unwrap_or("error")
                        )),
                    }
                }
                Err(_) => Msg::Detail {
                    generation: genr,
                    title: yaml_title,
                    lines: yaml,
                    warn: Some("kubectl not found; showing YAML".into()),
                },
            };
            let _ = tx.send(msg).await;
        });
    }

    /// Render an object as YAML lines, stamping its type if missing.
    pub(super) fn object_yaml(&self, obj: &DynamicObject) -> Vec<String> {
        let mut obj = obj.clone();
        if let Some(kind) = &self.kind
            && obj.types.is_none()
        {
            obj.types = Some(TypeMeta {
                api_version: kind.ar.api_version.clone(),
                kind: kind.ar.kind.clone(),
            });
        }
        serde_yaml::to_string(&obj)
            .unwrap_or_else(|e| format!("# error: {e}"))
            .lines()
            .map(String::from)
            .collect()
    }

    /// Diff the live object against its `last-applied-configuration`
    /// (k9s-style), or — when that annotation is absent, as it is for every
    /// Flux/Helm-managed object — against the previous revision this session's
    /// watch saw, so "what just changed?" has an answer on GitOps clusters.
    pub fn open_diff(&mut self) {
        self.set_return_mode();
        let Some(obj) = self.selected() else {
            return;
        };
        let name = obj.metadata.name.clone().unwrap_or_default();

        let last = obj
            .metadata
            .annotations
            .as_ref()
            .and_then(|a| a.get("kubectl.kubernetes.io/last-applied-configuration"))
            .cloned();

        let (baseline_yaml, baseline_label) = match last {
            Some(last_json) => {
                let yaml = serde_json::from_str::<Value>(&last_json)
                    .ok()
                    .and_then(|v| serde_yaml::to_string(&v).ok())
                    .unwrap_or(last_json);
                (yaml, "last-applied")
            }
            None => {
                let key = row_key(&obj);
                let Some(prev) = self.prev_revisions.get(&self.kind_plural, &key) else {
                    self.flash_warn(
                        "nothing to diff: no last-applied annotation, \
                         and no change seen this session",
                    );
                    return;
                };
                (diffable_yaml(prev.clone()), "session: previous")
            }
        };

        let live_yaml = diffable_yaml(obj);
        let lines = diff_lines(&baseline_yaml, &live_yaml);
        if lines.iter().all(|l| l.starts_with(' ')) {
            self.flash = format!("no diff: live matches {baseline_label}");
            self.flash_err = false;
            return; // nothing to show — stay on the current view
        }
        self.detail = Scrollable {
            title: format!("{name} — diff ({baseline_label} → live)"),
            lines: lines.into(),
            ..Default::default()
        };
        self.mode = Mode::Diff;
    }

    /// Live Events for the selected object, filtered by object UID when
    /// available. Uses the discovered `events` resource, so core/v1 Events are
    /// preferred but events.k8s.io clusters still work.
    pub(super) fn open_events(&mut self) {
        let Some(obj) = self.selected_ref() else {
            self.flash_warn("no selection for events");
            return;
        };
        let name = obj.metadata.name.clone().unwrap_or_default();
        let ns = obj.metadata.namespace.clone().unwrap_or_default();
        let uid = obj.metadata.uid.clone().filter(|u| !u.is_empty());
        self.open_events_for(name, ns, uid);
    }

    /// Live Events for an object identified by coordinates (rather than the
    /// current table selection), so the explain view can open the event stream
    /// for a blocking pod. `uid` scopes precisely when known; otherwise we fall
    /// back to a name(+namespace) selector.
    pub(super) fn open_events_for(&mut self, name: String, ns: String, uid: Option<String>) {
        self.set_return_mode();
        let Some(kind) = self.cluster.resolve("events") else {
            self.flash_warn("events kind unavailable");
            return;
        };

        let title = format!("{name} — events");
        let field = if kind.ar.group == "events.k8s.io" {
            "regarding"
        } else {
            "involvedObject"
        };
        let selector = uid
            .as_ref()
            .filter(|uid| !uid.is_empty())
            .map(|uid| format!("{field}.uid={uid}"))
            .unwrap_or_else(|| {
                let mut parts = vec![format!("{field}.name={name}")];
                if !ns.is_empty() {
                    parts.push(format!("{field}.namespace={ns}"));
                }
                parts.join(",")
            });

        self.stop_event_stream();
        let genr = self.event_gen;
        self.detail = Scrollable {
            title: title.clone(),
            lines: vec!["loading events…".into()].into(),
            ..Default::default()
        };
        self.flash = format!("events: {name}");
        self.flash_err = false;
        self.mode = Mode::Events;

        let client = self.cluster.client.clone();
        let tx = self.tx.clone();
        let ar = kind.ar.clone();
        let namespaced = kind.namespaced;
        let watch_ns = ns;
        let is_events_v1 = ar.group == "events.k8s.io";
        let handle = tokio::spawn(async move {
            let api: Api<DynamicObject> = if namespaced && !watch_ns.is_empty() {
                Api::namespaced_with(client, &watch_ns, &ar)
            } else {
                Api::all_with(client, &ar)
            };
            let cfg = watcher::Config::default().any_semantic().fields(&selector);
            let mut stream = watcher(api, cfg).boxed();
            let mut items: HashMap<String, DynamicObject> = HashMap::new();

            while let Some(event) = stream.next().await {
                match event {
                    Ok(watcher::Event::Init) => items.clear(),
                    Ok(watcher::Event::Apply(obj)) | Ok(watcher::Event::InitApply(obj)) => {
                        items.insert(row_key(&obj), obj);
                    }
                    Ok(watcher::Event::Delete(obj)) => {
                        items.remove(&row_key(&obj));
                    }
                    Ok(watcher::Event::InitDone) => {}
                    Err(e) => {
                        let _ = tx
                            .send(Msg::Events {
                                generation: genr,
                                title: title.clone(),
                                lines: vec![format!("error: {e}")],
                            })
                            .await;
                        continue;
                    }
                }

                if !send_event_snapshot(&tx, genr, &title, &items, is_events_v1).await {
                    break;
                }
            }
        });
        self.event_task = Some(handle);
    }

    pub(super) fn stop_event_stream(&mut self) {
        self.event_gen += 1;
        if let Some(task) = self.event_task.take() {
            task.abort();
        }
    }
}

/// Render an object as YAML cleaned for a readable side-by-side: no
/// managedFields, no last-applied annotation (it *is* one of the sides), and
/// no resourceVersion (it differs on every change — pure noise in a diff).
fn diffable_yaml(mut obj: DynamicObject) -> String {
    if let Some(ann) = obj.metadata.annotations.as_mut() {
        ann.remove("kubectl.kubernetes.io/last-applied-configuration");
    }
    obj.metadata.managed_fields = None;
    obj.metadata.resource_version = None;
    serde_yaml::to_string(&obj).unwrap_or_default()
}

/// Unified-diff lines (`-`/`+`/` ` prefixed) between two documents.
fn diff_lines(before: &str, after: &str) -> Vec<String> {
    use similar::{ChangeTag, TextDiff};
    let diff = TextDiff::from_lines(before, after);
    diff.iter_all_changes()
        .map(|change| {
            let sign = match change.tag() {
                ChangeTag::Delete => '-',
                ChangeTag::Insert => '+',
                ChangeTag::Equal => ' ',
            };
            format!("{sign}{}", change.value().trim_end_matches('\n'))
        })
        .collect()
}

/// Render one Secret `data` entry as stringData-style YAML lines: single-line
/// values inline (`key: value`), multiline ones as a literal block (`key: |`).
/// Values that aren't valid base64 or don't decode to UTF-8 text (TLS certs
/// in DER, random binary) get a placeholder instead of mojibake.
fn decoded_secret_entry(key: &str, value: &Value) -> Vec<String> {
    use base64::Engine;
    use base64::engine::general_purpose::STANDARD as BASE64;

    let Some(b64) = value.as_str() else {
        return vec![format!("{key}: <not a string>")];
    };
    let Ok(bytes) = BASE64.decode(b64) else {
        return vec![format!("{key}: <invalid base64>")];
    };
    let text = match String::from_utf8(bytes) {
        Ok(text) => text,
        Err(e) => return vec![format!("{key}: <binary: {} bytes>", e.as_bytes().len())],
    };
    let text = text.trim_end_matches('\n');
    if text.contains('\n') {
        let mut lines = vec![format!("{key}: |")];
        lines.extend(text.lines().map(|l| format!("  {l}")));
        lines
    } else {
        vec![format!("{key}: {text}")]
    }
}