This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch CAMEL-26700-about in repository https://gitbox.apache.org/repos/asf/camel.git
commit 30757422daf2a047f05b5b7b5578a6b7177a583c Author: Claus Ibsen <[email protected]> AuthorDate: Sat Nov 7 10:58:59 2026 +0100 CAMEL-26700: camel-jbang - an About view in the Overview: what an integration does and what has happened The Overview gets two views, switched with v: About, shown when one integration runs, and Integrations (the table). About is built from the analysis of the sources (ProjectOverview) and the status, without an AI: a header with what it is and its purpose (the comment at the top of its main file, else the descriptions of its routes), what comes in, its routes with the routes called with direct (↳) or handed off with seda (⇢) under their caller, and what goes out. Under it the last 5 minutes from the timeline the integration records (the exchanges, how they ended, the error that happened most and when) with the counts since it started, what to watch, and where to go next: 4 the Timeline, 5 the Diagram, 2 the source. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Claus Ibsen <[email protected]> --- .../dsl/jbang/core/commands/tui/AboutView.java | 577 +++++++++++++++++++++ .../dsl/jbang/core/commands/tui/OverviewTab.java | 70 +++ .../src/main/resources/tui/help/overview.md | 17 + .../dsl/jbang/core/commands/tui/AboutViewTest.java | 136 +++++ .../core/commands/tui/MonitorTabRefreshTest.java | 2 +- .../core/commands/tui/OverviewTabRenderTest.java | 36 +- .../tui/OverviewTabThroughputRenderTest.java | 8 +- 7 files changed, 824 insertions(+), 22 deletions(-) diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutView.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutView.java new file mode 100644 index 000000000000..62b9089acde6 --- /dev/null +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutView.java @@ -0,0 +1,577 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.dsl.jbang.core.commands.tui; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Set; +import java.util.function.Consumer; + +import dev.tamboui.layout.Constraint; +import dev.tamboui.layout.Layout; +import dev.tamboui.layout.Rect; +import dev.tamboui.style.Style; +import dev.tamboui.terminal.Frame; +import dev.tamboui.text.Line; +import dev.tamboui.text.Span; +import dev.tamboui.text.Text; +import dev.tamboui.widgets.block.Block; +import dev.tamboui.widgets.block.BorderType; +import dev.tamboui.widgets.block.Borders; +import dev.tamboui.widgets.paragraph.Paragraph; +import org.apache.camel.dsl.jbang.core.commands.ai.ProjectOverview; +import org.apache.camel.dsl.jbang.core.commands.ai.ProjectRoutes; +import org.apache.camel.util.TimeUtils; + +/** + * About an integration (Overview ▸ About, CAMEL-26700): what it does at a glance and without an AI, and what has + * happened. A header with what it is and its purpose (the comment at the top of its main file, else the descriptions of + * its routes), then what comes in, its routes (the routes called with direct or seda under the route that calls them) + * and what goes out, from the analysis of its sources ({@link ProjectOverview}). Under it, the last minutes from the + * timeline the integration records, which the Timeline tab (4) shows second by second, and what to watch. + */ +final class AboutView { + + // how often the sources are read again, to see a change + private static final long RELOAD_MILLIS = 10_000; + private static final int HAPPENED_SECONDS = 300; + private static final String BLOCKS = " ▁▂▃▄▅▆▇█"; + + private final MonitorContext ctx; + private volatile ProjectOverview.Overview overview; + private volatile String purpose; + private volatile String purposeFrom; + private volatile boolean loading; + private volatile String error; + private Path dir; + private long loadedAt; + + AboutView(MonitorContext ctx) { + this.ctx = ctx; + } + + /** Reads the sources of the integration in the background, again when they may have changed. */ + private void load(IntegrationInfo info, Consumer<Runnable> onRenderThread) { + Path d = info.directory != null ? Path.of(info.directory) : null; + long now = System.currentTimeMillis(); + boolean same = d != null && d.equals(dir); + if (d == null || loading || same && now - loadedAt < RELOAD_MILLIS) { + if (d == null) { + error = "No source directory for this integration"; + } + return; + } + if (!same) { + overview = null; + purpose = null; + error = null; + } + dir = d; + loadedAt = now; + loading = true; + Thread t = new Thread(() -> { + try { + ProjectOverview.Overview o = ProjectOverview.analyze(d, ArchitectureView.catalog()); + String[] p = purpose(d, o); + onRenderThread.accept(() -> { + overview = o; + purpose = p != null ? p[0] : null; + purposeFrom = p != null ? p[1] : null; + error = o.flows().isEmpty() ? "No routes found in " + d : null; + loading = false; + }); + } catch (Exception e) { + onRenderThread.accept(() -> { + error = "Cannot read the sources: " + e.getMessage(); + loading = false; + }); + } + }, "CamelTuiAbout"); + t.setDaemon(true); + t.start(); + } + + void render(Frame frame, Rect area, IntegrationInfo info) { + load(info, Runnable::run); + ProjectOverview.Overview o = overview; + int width = area.width(); + List<Line> head = new ArrayList<>(); + head.add(Line.from(Span.raw(" "), Span.raw(meta(info, o)), + Span.styled(info.vanishing ? " ○ stopped" : " ● running", + info.vanishing ? Theme.muted() : Theme.success()))); + if (purpose != null) { + for (String l : wrap(purpose, Math.max(20, width - 6), 2)) { + head.add(Line.from(Span.styled(" " + l, Style.EMPTY.bold()))); + } + head.add(Line.from(Span.styled(" " + purposeFrom, Theme.muted()))); + } else if (o != null) { + head.add(Line.from(Span.styled(" No description yet: a comment at the top of " + mainFile(o) + + " says what it does, or ask the AI (Shift+F8 on a route)", + Theme.muted()))); + } else { + head.add(Line.from(Span.styled(error != null ? " " + error : " Reading the sources…", Theme.muted()))); + } + + List<Line> in = new ArrayList<>(); + List<Line> routes = new ArrayList<>(); + List<Line> out = new ArrayList<>(); + if (o != null) { + columns(o, info, in, routes, out); + } + int columnRows = Math.max(1, Math.max(in.size(), Math.max(routes.size(), out.size()))); + List<Line> strips = strips(info, width); + int headHeight = head.size() + 2; + int available = Math.max(3, area.height() - headHeight - strips.size()); + int columnHeight = Math.min(columnRows + 2, available); + + List<Rect> rows = Layout.vertical() + .constraints(Constraint.length(headHeight), Constraint.length(columnHeight), Constraint.fill()) + .split(area); + frame.renderWidget(Paragraph.builder().text(Text.from(head)) + .block(block(" " + (info.name != null ? info.name : info.pid) + " ")).build(), rows.get(0)); + List<Rect> cols = Layout.horizontal() + .constraints(Constraint.percentage(28), Constraint.percentage(42), Constraint.percentage(30)) + .split(rows.get(1)); + frame.renderWidget(Paragraph.builder().text(Text.from(in)).block(block(" In ")).build(), cols.get(0)); + frame.renderWidget(Paragraph.builder().text(Text.from(routes)).block(block(" Routes ")).build(), cols.get(1)); + frame.renderWidget(Paragraph.builder().text(Text.from(out)).block(block(" Out ")).build(), cols.get(2)); + frame.renderWidget(Paragraph.builder().text(Text.from(strips)).build(), rows.get(2)); + } + + private static String meta(IntegrationInfo info, ProjectOverview.Overview o) { + StringBuilder sb = new StringBuilder(); + if (info.camelVersion != null) { + sb.append("Camel ").append(info.camelVersion); + } + if (info.platform != null) { + sb.append(" · ").append(info.platform); + } + if (info.profile != null) { + sb.append(" · ").append(info.profile); + } + if (o != null) { + sb.append(" · ").append(o.files().size()).append(o.files().size() == 1 ? " file" : " files"); + if (o.files().size() == 1) { + sb.append(" (").append(o.files().get(0)).append(')'); + } + } + sb.append(" · ").append(info.routes.size()).append(info.routes.size() == 1 ? " route" : " routes"); + if (info.uptime > 0) { + // the time it started + sb.append(" · up ").append(TimeUtils.printSince(info.uptime)); + } + return sb.toString(); + } + + private static String mainFile(ProjectOverview.Overview o) { + return o.files().isEmpty() ? "the main file" : o.files().get(0); + } + + // ---- In, Routes, Out ---- + + private static void columns( + ProjectOverview.Overview o, IntegrationInfo info, List<Line> in, List<Line> routes, List<Line> out) { + Map<String, Long> totals = new LinkedHashMap<>(); + for (RouteInfo r : info.routes) { + if (r.routeId != null) { + totals.put(r.routeId, r.total); + } + } + for (ProjectOverview.EntryPoint e : o.entryPoints()) { + Long total = e.route() != null ? totals.get(e.route()) : null; + // a consumer by the kind of system it consumes from (its scheme) + String kind = "consumer".equals(e.kind()) && e.label().indexOf(':') > 0 + ? e.label().substring(0, e.label().indexOf(':')) : e.kind(); + in.add(Line.from(Span.raw(" " + icon(kind) + " "), Span.styled(e.label(), Style.EMPTY.bold()), + Span.styled(total != null ? " " + total : "", Theme.success()))); + } + if (in.isEmpty()) { + in.add(Line.from(Span.styled(" nothing from outside", Theme.muted()))); + } + + // the routes that something else in the integration calls go under their caller + Map<String, List<ProjectOverview.Link>> calledBy = new LinkedHashMap<>(); + Set<String> called = new LinkedHashSet<>(); + for (ProjectOverview.Link l : o.links()) { + if (("call".equals(l.kind()) || "async".equals(l.kind())) && !l.from().equals(l.to())) { + calledBy.computeIfAbsent(l.from(), k -> new ArrayList<>()).add(l); + called.add(l.to()); + } + } + Set<String> shown = new LinkedHashSet<>(); + for (ProjectRoutes.Route r : o.flows()) { + if (!called.contains(r.key())) { + routeLines(o, r, 0, null, calledBy, totals, shown, routes); + } + } + // what is left: routes called only by routes in a cycle + for (ProjectRoutes.Route r : o.flows()) { + if (!shown.contains(r.key())) { + routeLines(o, r, 0, null, calledBy, totals, shown, routes); + } + } + + Set<String> systems = new LinkedHashSet<>(); + for (ProjectOverview.SystemUse s : o.systems()) { + if ("in".equals(s.direction())) { + continue; + } + String key = s.uri() + "|" + s.direction(); + if (systems.add(key)) { + out.add(Line.from(Span.raw(" " + icon(s.category()) + " "), Span.styled(shortUri(s.uri()), Style.EMPTY.bold()), + Span.styled(" " + s.direction(), Theme.muted()))); + out.add(Line.from(Span.styled(" from " + s.route(), Theme.muted()))); + } + } + if (out.isEmpty()) { + out.add(Line.from(Span.styled(" nothing outside the integration", Theme.muted()))); + } + } + + private static void routeLines( + ProjectOverview.Overview o, ProjectRoutes.Route r, int depth, String how, + Map<String, List<ProjectOverview.Link>> calledBy, Map<String, Long> totals, Set<String> shown, + List<Line> lines) { + if (!shown.add(r.key()) || depth > 6) { + return; + } + List<Span> spans = new ArrayList<>(); + spans.add(Span.raw(" " + " ".repeat(depth) + (how != null ? how + " " : ""))); + spans.add(Span.styled(r.id() != null ? r.id() : r.key(), Style.EMPTY.bold())); + String from = r.from() != null ? r.from().scheme() : r.kind(); + spans.add(Span.styled(" " + from + " → " + r.steps() + (r.steps() == 1 ? " step" : " steps"), Theme.muted())); + Long total = totals.get(r.id()); + if (total != null) { + spans.add(Span.styled(" " + total, Theme.success())); + } + lines.add(Line.from(spans)); + for (ProjectOverview.Link l : calledBy.getOrDefault(r.key(), List.of())) { + ProjectRoutes.Route target = o.route(l.to()); + if (target != null) { + // ↳ a call that waits for the route, ⇢ a hand-off that does not + routeLines(o, target, depth + 1, "call".equals(l.kind()) ? "↳" : "⇢", calledBy, totals, shown, lines); + } + } + } + + private static String icon(String kind) { + String k = kind != null ? kind.toLowerCase(Locale.ROOT) : ""; + if (k.contains("file") || k.contains("storage") || k.equals("ftp") || k.equals("sftp") || k.equals("s3")) { + return "📁"; + } + if (k.contains("kafka") || k.contains("jms") || k.contains("amqp") || k.contains("mqtt") || k.equals("seda")) { + return "📨"; + } + return switch (k) { + case "schedule" -> "⏱"; + case "http" -> "🌐"; + case "file" -> "📁"; + case "messaging" -> "📨"; + case "database" -> "🗄"; + case "mail" -> "✉"; + default -> "•"; + }; + } + + private static String shortUri(String uri) { + if (uri == null) { + return ""; + } + int q = uri.indexOf('?'); + return q > 0 ? uri.substring(0, q) : uri; + } + + // ---- what has happened, and what to watch ---- + + private List<Line> strips(IntegrationInfo info, int width) { + List<Line> lines = new ArrayList<>(); + lines.add(happened(info, width)); + List<Span> watch = new ArrayList<>(); + watch.add(Span.styled(" Watch ", Theme.muted())); + if (info.errorCount > 0) { + watch.add(Span.styled("✗ " + info.errorCount + (info.errorCount == 1 ? " error" : " errors"), Theme.error())); + watch.add(Span.styled(" (9 Errors)", Theme.muted())); + } else { + watch.add(Span.styled("no errors", Theme.success())); + } + long stopped = info.routes.stream().filter(r -> r.state != null && !"Started".equals(r.state)).count(); + if (stopped > 0) { + watch.add(Span.raw(" · ")); + watch.add(Span.styled(stopped + (stopped == 1 ? " route not started" : " routes not started"), + Theme.warning())); + } + long inflight = info.routes.stream().mapToLong(r -> r.inflight).sum(); + if (inflight > 0) { + watch.add(Span.raw(" · " + inflight + " in flight")); + } + lines.add(Line.from(watch)); + lines.add(Line.from(Span.styled(" Next ", Theme.muted()), Span.styled(" 4 ", Theme.hintKey()), + Span.raw(" what happened, per second "), Span.styled(" 5 ", Theme.hintKey()), + Span.raw(" diagram "), Span.styled(" 2 ", Theme.hintKey()), Span.raw(" source "), + Span.styled(" v ", Theme.hintKey()), Span.raw(" all integrations"))); + return lines; + } + + /** + * The last minutes from the timeline the integration records: how many exchanges, how they ended, the errors, and + * when it was busy, as one line. The Timeline tab (4) has them second by second. + */ + private Line happened(IntegrationInfo info, int width) { + List<Span> spans = new ArrayList<>(); + spans.add(Span.styled(" Last 5m ", Theme.muted())); + long end = ctx.timeline.endSecond(info.pid); + if (end < 0) { + spans.add(Span.styled("nothing recorded yet (the timeline dev console records it, as camel run does)", + Theme.muted())); + return Line.from(spans); + } + List<String> order = info.routes.stream().map(r -> r.routeId).filter(id -> id != null).toList(); + List<Timeline.RouteSeries> series = ctx.timeline.routes(info.pid, order, end, HAPPENED_SECONDS); + long[] perSecond = new long[HAPPENED_SECONDS]; + long completed = 0; + long recovered = 0; + long handled = 0; + long failed = 0; + for (Timeline.RouteSeries r : series) { + completed += r.total(r.completed()); + recovered += r.total(r.recovered()); + handled += r.total(r.handled()); + failed += r.total(r.failed()); + for (int i = 0; i < HAPPENED_SECONDS; i++) { + perSecond[i] += Math.max(0, r.completed()[i]) + Math.max(0, r.recovered()[i]) + + Math.max(0, r.handled()[i]) + Math.max(0, r.failed()[i]); + } + } + spans.add(Span.styled(spark(perSecond, 30), Theme.info())); + long done = completed + recovered + handled + failed; + spans.add(Span.raw(" " + done + (done == 1 ? " exchange" : " exchanges"))); + if (recovered > 0) { + spans.add(Span.styled(" · " + recovered + " recovered", Theme.warning())); + } + if (handled > 0) { + spans.add(Span.styled(" · " + handled + " handled", Style.EMPTY.fg(Theme.ACCENT))); + } + if (failed > 0) { + spans.add(Span.styled(" · " + failed + " failed", Theme.error())); + } + // the cause that happened most, with when it last did + Timeline.CauseSeries top = null; + long topTotal = 0; + int last = -1; + for (Timeline.CauseSeries c : ctx.timeline.causes(info.pid, end, HAPPENED_SECONDS)) { + long t = 0; + for (long v : c.values()) { + t += v; + } + if (t > topTotal) { + top = c; + topTotal = t; + for (int i = c.values().length - 1; i >= 0; i--) { + if (c.values()[i] > 0) { + last = i; + break; + } + } + } + } + if (top != null) { + long ago = HAPPENED_SECONDS - 1 - last; + spans.add(Span.raw(" · ")); + spans.add(Span.styled((top.rule() != null ? "🎲 " : "") + top.label() + " ×" + topTotal, Theme.error())); + spans.add(Span.styled(" (last " + (ago > 0 ? ChaosTab.shortTime(ago * 1000) + " ago" : "now") + ")", + Theme.muted())); + } + if (done == 0) { + long lastActive = ctx.timeline.lastActive(info.pid); + spans.add(Span.styled(lastActive >= 0 + ? " (the last exchange " + ChaosTab.shortTime((end - lastActive) * 1000) + " ago)" + : " (quiet)", Theme.muted())); + } + // what the routes that something starts did since the integration started, as their counters say + Set<String> entry = new LinkedHashSet<>(); + ProjectOverview.Overview o = overview; + if (o != null) { + o.entryPoints().forEach(e -> entry.add(e.route())); + } + long total = 0; + long totalFailed = 0; + long totalHandled = 0; + for (RouteInfo r : info.routes) { + if (entry.isEmpty() || entry.contains(r.routeId)) { + total += r.total; + totalFailed += r.failed; + totalHandled += r.failuresHandled; + } + } + if (total > done) { + spans.add(Span.styled(" · since it started: " + total + (total == 1 ? " exchange" : " exchanges") + + (totalHandled > 0 ? ", " + totalHandled + " handled" : "") + + (totalFailed > 0 ? ", " + totalFailed + " failed" : ""), + Theme.muted())); + } + return Line.from(spans); + } + + /** The values as a sparkline of the given width, a character taking the sum of its seconds. */ + static String spark(long[] values, int width) { + long[] col = new long[width]; + long max = 0; + for (int i = 0; i < values.length; i++) { + int c = (int) ((long) i * width / values.length); + col[c] += values[i]; + } + for (long v : col) { + max = Math.max(max, v); + } + StringBuilder sb = new StringBuilder(width); + for (long v : col) { + int level = max == 0 || v == 0 ? 0 : (int) Math.max(1, Math.round(v * 8.0 / max)); + sb.append(BLOCKS.charAt(level)); + } + return sb.toString(); + } + + // ---- the purpose line ---- + + /** + * What the integration does, in the words of its author: the comment at the top of a route file (the files in the + * order of the analysis), else the descriptions of the routes that something outside starts. Returns the text and + * where it comes from, or null. + */ + static String[] purpose(Path dir, ProjectOverview.Overview o) { + for (String file : o.files()) { + try { + String text = leadingComment(file, Files.readString(dir.resolve(file), StandardCharsets.UTF_8)); + if (text != null) { + return new String[] { text, "from the comment at the top of " + file }; + } + } catch (IOException e) { + // an unreadable file has no comment + } + } + List<String> descriptions = new ArrayList<>(); + Set<String> entryRoutes = new LinkedHashSet<>(); + o.entryPoints().forEach(e -> entryRoutes.add(e.route())); + for (ProjectRoutes.Route r : o.flows()) { + if (r.hasDescription() && entryRoutes.contains(r.key())) { + descriptions.add(r.description()); + } + } + for (ProjectRoutes.Route r : o.flows()) { + if (r.hasDescription() && !entryRoutes.contains(r.key()) && descriptions.size() < 2) { + descriptions.add(r.description()); + } + } + if (!descriptions.isEmpty()) { + return new String[] { + String.join(" ", descriptions.subList(0, Math.min(2, descriptions.size()))), + "from the descriptions of the routes" }; + } + return null; + } + + /** + * The comment a file starts with: the {@code #} lines of YAML, the Javadoc or {@code //} lines before the class of + * Java, the first {@code <!-- -->} of XML. A license header is no description. + */ + static String leadingComment(String file, String content) { + String text = null; + if (file.endsWith(".yaml") || file.endsWith(".yml")) { + StringBuilder sb = new StringBuilder(); + for (String line : content.lines().toList()) { + String l = line.strip(); + if (l.startsWith("#")) { + sb.append(l.replaceFirst("^#+\\s?", "")).append(' '); + } else if (!l.isEmpty() || !sb.isEmpty()) { + break; + } + } + text = sb.toString(); + } else if (file.endsWith(".java")) { + int cls = content.indexOf(" class "); + String before = cls > 0 ? content.substring(0, cls) : content; + int doc = before.lastIndexOf("/**"); + if (doc >= 0) { + int end = before.indexOf("*/", doc); + text = end > 0 ? before.substring(doc + 3, end).replaceAll("(?m)^\\s*\\*\\s?", " ") : null; + } else { + StringBuilder sb = new StringBuilder(); + for (String line : before.lines().toList()) { + String l = line.strip(); + if (l.startsWith("//") && !l.startsWith("///") && !l.startsWith("//DEPS") + && !l.startsWith("//JAVA")) { + sb.append(l.substring(2).strip()).append(' '); + } + } + text = sb.toString(); + } + } else if (file.endsWith(".xml")) { + int start = content.indexOf("<!--"); + int end = start >= 0 ? content.indexOf("-->", start) : -1; + text = end > 0 ? content.substring(start + 4, end) : null; + } + if (text == null) { + return null; + } + // a Javadoc tag ends the description + int tag = text.indexOf(" @"); + if (tag > 0) { + text = text.substring(0, tag); + } + text = text.replaceAll("\\s+", " ").strip(); + if (text.isEmpty() || text.contains("Licensed to the Apache") || text.contains("SPDX-License")) { + return null; + } + return text.length() > 300 ? text.substring(0, 297) + "…" : text; + } + + static List<String> wrap(String text, int width, int maxLines) { + List<String> lines = new ArrayList<>(); + StringBuilder sb = new StringBuilder(); + for (String word : text.split(" ")) { + if (sb.length() + word.length() + 1 > width && !sb.isEmpty()) { + lines.add(sb.toString()); + sb.setLength(0); + if (lines.size() == maxLines) { + String lastLine = lines.remove(maxLines - 1); + lines.add(lastLine.length() > width - 1 ? lastLine.substring(0, width - 1) + "…" : lastLine + " …"); + return lines; + } + } + if (!sb.isEmpty()) { + sb.append(' '); + } + sb.append(word); + } + if (!sb.isEmpty()) { + lines.add(sb.toString()); + } + return lines; + } + + private static Block block(String title) { + return Block.builder().borderType(BorderType.ROUNDED).borders(Borders.ALL).title(title).build(); + } +} diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTab.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTab.java index fa7f6b6c6048..bd81789db959 100644 --- a/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTab.java +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTab.java @@ -110,6 +110,9 @@ class OverviewTab extends AbstractTab { private String lastIntegrationPid; int chartMode = CHART_SINGLE; private int bottomPanelHeight = 16; + // Overview ▸ About (CAMEL-26700): what the integration does and what has happened; null until the user picks a view + private final AboutView about; + private Boolean aboutChosen; private final DragSplit vSplit = new DragSplit(); private String sort = "name"; @@ -129,6 +132,7 @@ class OverviewTab extends AbstractTab { Set<String> stoppingPids, Runnable onPidChanged) { super(ctx); + this.about = new AboutView(ctx); this.throughputHistory = metrics.getThroughputHistory(); this.failedHistory = metrics.getFailedHistory(); this.cpuLoadAvg = metrics.getCpuLoadAvg(); @@ -140,8 +144,70 @@ class OverviewTab extends AbstractTab { this.actions = actions; } + /** The integration About is about: the selected one, else the only one running; null when none. */ + private IntegrationInfo aboutIntegration() { + IntegrationInfo sel = ctx.findSelectedIntegration(); + if (sel != null) { + return sel; + } + List<IntegrationInfo> infos = sortedInfos(); + return infos.size() == 1 ? infos.get(0) : null; + } + + /** Whether About shows: the view the user picked, else About when one integration runs. */ + boolean showsAbout() { + if (ctx.isInfraSelected()) { + return false; + } + boolean wanted = aboutChosen != null ? aboutChosen : sortedInfos().size() == 1; + return wanted && aboutIntegration() != null; + } + + /** Shows the table of the integrations, as the user does with v. */ + OverviewTab showIntegrations() { + aboutChosen = false; + return this; + } + + @Override + public SubViewBar.Spec subViewBar() { + if (sortedInfos().isEmpty()) { + return null; + } + boolean shows = showsAbout(); + return new SubViewBar.Spec( + "v", List.of( + new SubViewBar.View("About", shows, aboutIntegration() != null, () -> aboutChosen = true), + new SubViewBar.View("Integrations", !shows, true, () -> aboutChosen = false)), + List.of(), false); + } + + @Override + public void refreshWhileVisible() { + // the last minutes of the timeline, for what has happened + DataRefreshService data = ctx.dataService; + if (showsAbout() && data != null) { + List<Long> pids = data.selectedPidAsList(); + if (pids.isEmpty() && aboutIntegration() != null) { + pids = List.of(Long.parseLong(aboutIntegration().pid)); + } + data.refreshTimelineData(pids); + } + } + @Override public boolean handleKeyEvent(KeyEvent ke) { + if (ke.isChar('v') && !sortedInfos().isEmpty()) { + aboutChosen = !showsAbout(); + if (aboutChosen && ctx.selectedPid == null && aboutIntegration() != null) { + ctx.selectedPid = aboutIntegration().pid; + } + return true; + } + if (showsAbout()) { + // About has no table: the keys of the table do not apply + return false; + } if (ke.isChar('s')) { if (infraFocused) { infraSortIndex = (infraSortIndex + 1) % INFRA_SORT_COLUMNS.length; @@ -274,6 +340,10 @@ class OverviewTab extends AbstractTab { if (infraCount == 0) { infraFocused = false; } + if (showsAbout()) { + about.render(frame, area, aboutIntegration()); + return; + } if (ctx.selectedPid == null && !infraFocused) { // no integration selected: no row marked as if one were (the header and info panel say none is) diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/resources/tui/help/overview.md b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/resources/tui/help/overview.md index 9005bff65a4d..0da66155ea0d 100644 --- a/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/resources/tui/help/overview.md +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/main/resources/tui/help/overview.md @@ -3,6 +3,23 @@ The Overview tab shows all running Camel integrations at a glance. Select an integration to monitor it in detail on the other tabs. +## About and Integrations + +The Overview has two views, switched with **v**: + +- **About** — what the selected integration does and what has happened, + shown when one integration runs. A header with what it is and its + purpose (the comment at the top of its main file, else the + descriptions of its routes); what comes **In** (timers, HTTP, + consumers), its **Routes** (a route called with `direct:` sits under + its caller with `↳`, one handed off with `seda:` with `⇢`) and what + goes **Out**, from its sources; then the **Last 5m** from the timeline + it records (the exchanges, how they ended, the error that happened + most), what to **Watch**, and where to go **Next**: **4** the + Timeline second by second, **5** the Diagram, **2** the source. +- **Integrations** — the table of all running integrations below, shown + when several run. + ## Integration List Each row represents one running Camel integration: diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutViewTest.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutViewTest.java new file mode 100644 index 000000000000..83fa15bbdaa2 --- /dev/null +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/AboutViewTest.java @@ -0,0 +1,136 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.dsl.jbang.core.commands.tui; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import dev.tamboui.buffer.Buffer; +import dev.tamboui.layout.Rect; +import dev.tamboui.terminal.Frame; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.awaitility.Awaitility.await; + +/** + * Overview ▸ About (CAMEL-26700): what an integration does, from its sources, and what has happened, from its timeline. + */ +class AboutViewTest { + + private static final long T0 = 1_800_000_000_000L; + + @TempDir + Path dir; + + private static String render(AboutView about, IntegrationInfo info) { + Rect area = new Rect(0, 0, 160, 30); + Buffer buffer = Buffer.empty(area); + about.render(Frame.forTesting(buffer), area, info); + return TuiTestHelper.bufferToString(buffer); + } + + @Test + void thePurposeIsTheCommentAtTheTopOfTheFile() { + assertThat(AboutView.leadingComment("orders.camel.yaml", """ + # Each order id is accepted once. + # An accepted order is enriched with its customer. + + - route: + id: orders + """)).isEqualTo("Each order id is accepted once. An accepted order is enriched with its customer."); + assertThat(AboutView.leadingComment("Shop.java", """ + //DEPS org.apache.camel:camel-http + import org.apache.camel.builder.RouteBuilder; + + /** + * A small shop: every order is reserved and paid. + * + * @author someone + */ + public class Shop extends RouteBuilder { + """)).isEqualTo("A small shop: every order is reserved and paid."); + assertThat(AboutView.leadingComment("routes.xml", "<?xml version=\"1.0\"?>\n<!-- Copies the files. -->\n<routes/>")) + .isEqualTo("Copies the files."); + // a license is no description + assertThat(AboutView.leadingComment("a.yaml", "# Licensed to the Apache Software Foundation (ASF)\n- route:")) + .isNull(); + assertThat(AboutView.leadingComment("a.yaml", "- route:\n id: a")).isNull(); + } + + @Test + void aLongPurposeIsWrapped() { + assertThat(AboutView.wrap("one two three four five six", 10, 2)).containsExactly("one two", "three fou…"); + assertThat(AboutView.wrap("short", 10, 2)).containsExactly("short"); + } + + @Test + void aSparklineSumsItsSeconds() { + assertThat(AboutView.spark(new long[] { 0, 0, 2, 2, 0, 8 }, 3)).isEqualTo(" ▄█"); + } + + @Test + void aboutAnIntegrationWithWhatHasHappened() throws Exception { + Files.writeString(dir.resolve("shop.camel.yaml"), """ + # Every order is checked against the stock and shipped. + - route: + id: orders + from: + uri: timer:orders + parameters: + period: 500 + steps: + - to: direct:stock + - to: http://localhost:8765/ship + - route: + id: stock + from: + uri: direct:stock + steps: + - log: checked + """); + IntegrationInfo info = new IntegrationInfo(); + info.pid = "1234"; + info.name = "shop"; + info.camelVersion = "4.24.0"; + info.directory = dir.toString(); + for (String id : List.of("orders", "stock")) { + RouteInfo r = new RouteInfo(); + r.routeId = id; + r.state = "Started"; + r.total = 120; + info.routes.add(r); + } + MonitorContext ctx = new MonitorContext(new AtomicReference<>(List.of(info)), new AtomicReference<>(List.of())); + ctx.timeline.merge("1234", TimelineTabRenderTest.outage(T0 / 1000 + 59, 60, 0).json(), true); + AboutView about = new AboutView(ctx); + + await().atMost(20, TimeUnit.SECONDS).untilAsserted(() -> { + String screen = render(about, info); + assertThat(screen).contains("Every order is checked against the stock and shipped.") + .contains("from the comment at the top of shop.camel.yaml"); + assertThat(screen).contains(" In ").contains("timer:orders").contains(" Routes ").contains("orders") + .contains("↳ stock").contains(" Out ").contains("localhost:8765/ship").contains("from orders"); + assertThat(screen).contains("Last 5m").contains("30 handled") + .contains("HttpOperationFailedException 503 ×30").contains("Watch").contains("Next"); + }); + } +} diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/MonitorTabRefreshTest.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/MonitorTabRefreshTest.java index 9539d689d842..203766147231 100644 --- a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/MonitorTabRefreshTest.java +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/MonitorTabRefreshTest.java @@ -123,7 +123,7 @@ class MonitorTabRefreshTest { @Test void escOnTheOverviewTabDeselectsTheIntegration() { OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); assertThat(tab.handleEscape()).isTrue(); assertThat(ctx.selectedPid).isNull(); diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabRenderTest.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabRenderTest.java index 57cc57dadf15..3e16f4a1d3e9 100644 --- a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabRenderTest.java +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabRenderTest.java @@ -76,7 +76,7 @@ class OverviewTabRenderTest { info.state = 5; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); String rendered = TuiTestHelper.renderToString(tab, 160, 30); assertTrue(rendered.contains("PID"), "Should show PID header"); @@ -92,7 +92,7 @@ class OverviewTabRenderTest { info.ago = "2m0s"; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); JsonObject data = tab.getTableDataAsJson(); JsonObject row = (JsonObject) ((JsonArray) data.get("rows")).get(0); @@ -107,7 +107,7 @@ class OverviewTabRenderTest { info.state = 5; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); String rendered = TuiTestHelper.renderToString(tab, 160, 30); assertTrue(rendered.contains("1234"), "Should render PID"); @@ -122,7 +122,7 @@ class OverviewTabRenderTest { // overrides fg colors to WHITE. ctx.selectedPid = null; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); Buffer buffer = Buffer.empty(area); @@ -142,7 +142,7 @@ class OverviewTabRenderTest { // overrides fg colors to WHITE. ctx.selectedPid = null; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); Buffer buffer = Buffer.empty(area); @@ -162,7 +162,7 @@ class OverviewTabRenderTest { // overrides fg colors to WHITE. ctx.selectedPid = null; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); Buffer buffer = Buffer.empty(area); @@ -186,7 +186,7 @@ class OverviewTabRenderTest { MonitorContext ctx2 = new MonitorContext(data, infraData); OverviewTab tab = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); String rendered = TuiTestHelper.renderToString(tab, 160, 30); assertTrue(rendered.contains("test-app"), "Should render first integration"); @@ -198,7 +198,7 @@ class OverviewTabRenderTest { info.state = 5; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); String rendered = TuiTestHelper.renderToString(tab, 160, 30); assertTrue(rendered.contains("NAME▼") || rendered.contains("NAME▲"), @@ -210,7 +210,7 @@ class OverviewTabRenderTest { info.state = 5; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); tab.handleKeyEvent(KeyEvent.ofChar('s', KeyModifiers.NONE)); String rendered = TuiTestHelper.renderToString(tab, 160, 30); @@ -221,7 +221,7 @@ class OverviewTabRenderTest { @Test void renderFooterHints() { OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); List<Span> footerSpans = new ArrayList<>(); tab.renderFooter(footerSpans); @@ -241,7 +241,7 @@ class OverviewTabRenderTest { // overrides fg colors to WHITE. ctx.selectedPid = null; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); Buffer buffer = Buffer.empty(area); @@ -269,7 +269,8 @@ class OverviewTabRenderTest { ctx2.selectedPid = "1234"; boolean[] pidChanged = { false }; - OverviewTab tab = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> pidChanged[0] = true); + OverviewTab tab + = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> pidChanged[0] = true).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); renderOnce(tab, area); @@ -297,7 +298,7 @@ class OverviewTabRenderTest { ctx2.selectedPid = "1234"; OverviewTab tab = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); String rendered = TuiTestHelper.renderToString(tab, 160, 30); assertTrue(rendered.contains("Dev/Infra Services"), "Should show infra panel title"); @@ -325,7 +326,7 @@ class OverviewTabRenderTest { metrics.getThroughputHistory().put("1000", new LinkedList<>(List.of(1L, 2L, 3L))); OverviewTab tab = new OverviewTab(ctx2, metrics, new HashSet<>(), () -> { - }); + }).showIntegrations(); // a short content area: what is left of a 34-row terminal with the log pinned String rendered = TuiTestHelper.renderToString(tab, 150, 22); @@ -349,7 +350,8 @@ class OverviewTabRenderTest { ctx2.selectedPid = "1234"; boolean[] pidChanged = { false }; - OverviewTab tab = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> pidChanged[0] = true); + OverviewTab tab + = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> pidChanged[0] = true).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); renderOnce(tab, area); @@ -368,7 +370,7 @@ class OverviewTabRenderTest { info.state = 5; OverviewTab tab = new OverviewTab(ctx, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); assertFalse(tab.infraFocused); tab.handleKeyEvent(KeyEvent.ofKey(KeyCode.TAB, KeyModifiers.NONE)); @@ -389,7 +391,7 @@ class OverviewTabRenderTest { ctx2.selectedPid = "1234"; OverviewTab tab = new OverviewTab(ctx2, new MetricsCollector(), new HashSet<>(), () -> { - }); + }).showIntegrations(); Rect area = new Rect(0, 0, 160, 30); renderOnce(tab, area); diff --git a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabThroughputRenderTest.java b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabThroughputRenderTest.java index f0c348aa2cb8..986fc0138596 100644 --- a/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabThroughputRenderTest.java +++ b/dsl/camel-jbang/camel-jbang-plugin-tui/src/test/java/org/apache/camel/dsl/jbang/core/commands/tui/OverviewTabThroughputRenderTest.java @@ -89,7 +89,7 @@ class OverviewTabThroughputRenderTest { failedHistory.put("1234", fHistory); OverviewTab tab = new OverviewTab(ctx, metrics, new HashSet<>(), () -> { - }); + }).showIntegrations(); tab.chartMode = OverviewTab.CHART_ALL; String rendered = TuiTestHelper.renderToString(tab, 160, 40); @@ -114,7 +114,7 @@ class OverviewTabThroughputRenderTest { failedHistory.put("1234", new LinkedList<>(history)); OverviewTab tab = new OverviewTab(ctx, metrics, new HashSet<>(), () -> { - }); + }).showIntegrations(); tab.chartMode = OverviewTab.CHART_ALL; String rendered = TuiTestHelper.renderToString(tab, 160, 40); @@ -143,7 +143,7 @@ class OverviewTabThroughputRenderTest { failedHistory.put("1234", fHistory); OverviewTab tab = new OverviewTab(ctx, metrics, new HashSet<>(), () -> { - }); + }).showIntegrations(); tab.chartMode = OverviewTab.CHART_ALL; String rendered = TuiTestHelper.renderToString(tab, 160, 40); @@ -173,7 +173,7 @@ class OverviewTabThroughputRenderTest { failedHistory.put("1234", fHistory); OverviewTab tab = new OverviewTab(ctx, metrics, new HashSet<>(), () -> { - }); + }).showIntegrations(); tab.chartMode = OverviewTab.CHART_ALL; String rendered = TuiTestHelper.renderToString(tab, 160, 40);
