waveterm/frontend/app/view/sysinfo/sysinfo.tsx
Sylvie Crowe b4b0222c9d
New Connections Configs (#1383)
This adds the following connections changes:
- connections can be hidden from the dropdown in our internal
connections.json config
- `wsh ssh` -i will write identity files to the internal
connections.json config for that connection
- the internal connections.json config will also be used to get identity
files when connecting
- the internal connections.json config allows setting theme, fontsize,
and font for specific connections
- successful connections (including those using wsh ssh) are saved to
the internal connections.json config
- the connections.json config will be used to help pre-populate the
dropdown list
- adds an item to the dropdown to edit the connections config in an
ephemeral block

---------

Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2024-12-05 10:02:07 -08:00

562 lines
20 KiB
TypeScript

// Copyright 2024, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0
import { getConnStatusAtom, globalStore, WOS } from "@/store/global";
import * as util from "@/util/util";
import * as Plot from "@observablehq/plot";
import clsx from "clsx";
import dayjs from "dayjs";
import * as htl from "htl";
import * as jotai from "jotai";
import * as React from "react";
import { useDimensionsWithExistingRef } from "@/app/hook/useDimensions";
import { waveEventSubscribe } from "@/app/store/wps";
import { RpcApi } from "@/app/store/wshclientapi";
import { TabRpcClient } from "@/app/store/wshrpcutil";
import { atoms } from "@/store/global";
import { OverlayScrollbarsComponent, OverlayScrollbarsComponentRef } from "overlayscrollbars-react";
import "./sysinfo.scss";
const DefaultNumPoints = 120;
type DataItem = {
ts: number;
[k: string]: number;
};
function defaultCpuMeta(name: string): TimeSeriesMeta {
return {
name: name,
label: "%",
miny: 0,
maxy: 100,
color: "var(--sysinfo-cpu-color)",
decimalPlaces: 0,
};
}
function defaultMemMeta(name: string, maxY: string): TimeSeriesMeta {
return {
name: name,
label: "GB",
miny: 0,
maxy: maxY,
color: "var(--sysinfo-mem-color)",
decimalPlaces: 1,
};
}
const PlotTypes: Object = {
CPU: function (dataItem: DataItem): Array<string> {
return ["cpu"];
},
Mem: function (dataItem: DataItem): Array<string> {
return ["mem:used"];
},
"CPU + Mem": function (dataItem: DataItem): Array<string> {
return ["cpu", "mem:used"];
},
"All CPU": function (dataItem: DataItem): Array<string> {
return Object.keys(dataItem)
.filter((item) => item.startsWith("cpu") && item != "cpu")
.sort((a, b) => {
const valA = parseInt(a.replace("cpu:", ""));
const valB = parseInt(b.replace("cpu:", ""));
return valA - valB;
});
},
};
const DefaultPlotMeta = {
cpu: defaultCpuMeta("CPU %"),
"mem:total": defaultMemMeta("Memory Total", "mem:total"),
"mem:used": defaultMemMeta("Memory Used", "mem:total"),
"mem:free": defaultMemMeta("Memory Free", "mem:total"),
"mem:available": defaultMemMeta("Memory Available", "mem:total"),
};
for (let i = 0; i < 32; i++) {
DefaultPlotMeta[`cpu:${i}`] = defaultCpuMeta(`Core ${i}`);
}
function convertWaveEventToDataItem(event: WaveEvent): DataItem {
const eventData: TimeSeriesData = event.data;
if (eventData == null || eventData.ts == null || eventData.values == null) {
return null;
}
const dataItem = { ts: eventData.ts };
for (const key in eventData.values) {
dataItem[key] = eventData.values[key];
}
return dataItem;
}
class SysinfoViewModel implements ViewModel {
viewType: string;
blockAtom: jotai.Atom<Block>;
termMode: jotai.Atom<string>;
htmlElemFocusRef: React.RefObject<HTMLInputElement>;
blockId: string;
viewIcon: jotai.Atom<string>;
viewText: jotai.Atom<string>;
viewName: jotai.Atom<string>;
dataAtom: jotai.PrimitiveAtom<Array<DataItem>>;
addInitialDataAtom: jotai.WritableAtom<unknown, [DataItem[]], void>;
addContinuousDataAtom: jotai.WritableAtom<unknown, [DataItem], void>;
incrementCount: jotai.WritableAtom<unknown, [], Promise<void>>;
loadingAtom: jotai.PrimitiveAtom<boolean>;
numPoints: jotai.Atom<number>;
metrics: jotai.Atom<string[]>;
connection: jotai.Atom<string>;
manageConnection: jotai.Atom<boolean>;
filterOutNowsh: jotai.Atom<boolean>;
connStatus: jotai.Atom<ConnStatus>;
plotMetaAtom: jotai.PrimitiveAtom<Map<string, TimeSeriesMeta>>;
endIconButtons: jotai.Atom<IconButtonDecl[]>;
plotTypeSelectedAtom: jotai.Atom<string>;
constructor(blockId: string, viewType: string) {
this.viewType = viewType;
this.blockId = blockId;
this.blockAtom = WOS.getWaveObjectAtom<Block>(`block:${blockId}`);
this.addInitialDataAtom = jotai.atom(null, (get, set, points) => {
const targetLen = get(this.numPoints) + 1;
try {
const newDataRaw = [...points];
if (newDataRaw.length == 0) {
return;
}
const latestItemTs = newDataRaw[newDataRaw.length - 1]?.ts ?? 0;
const cutoffTs = latestItemTs - 1000 * targetLen;
const blankItemTemplate = { ...newDataRaw[newDataRaw.length - 1] };
for (const key in blankItemTemplate) {
blankItemTemplate[key] = NaN;
}
const newDataFiltered = newDataRaw.filter((dataItem) => dataItem.ts >= cutoffTs);
if (newDataFiltered.length == 0) {
return;
}
const newDataWithGaps: Array<DataItem> = [];
if (newDataFiltered[0].ts > cutoffTs) {
const blankItemStart = { ...blankItemTemplate, ts: cutoffTs };
const blankItemEnd = { ...blankItemTemplate, ts: newDataFiltered[0].ts - 1 };
newDataWithGaps.push(blankItemStart);
newDataWithGaps.push(blankItemEnd);
}
newDataWithGaps.push(newDataFiltered[0]);
for (let i = 1; i < newDataFiltered.length; i++) {
const prevIdxItem = newDataFiltered[i - 1];
const curIdxItem = newDataFiltered[i];
const timeDiff = curIdxItem.ts - prevIdxItem.ts;
if (timeDiff > 2000) {
const blankItemStart = { ...blankItemTemplate, ts: prevIdxItem.ts + 1, blank: 1 };
const blankItemEnd = { ...blankItemTemplate, ts: curIdxItem.ts - 1, blank: 1 };
newDataWithGaps.push(blankItemStart);
newDataWithGaps.push(blankItemEnd);
}
newDataWithGaps.push(curIdxItem);
}
set(this.dataAtom, newDataWithGaps);
} catch (e) {
console.log("Error adding data to sysinfo", e);
}
});
this.addContinuousDataAtom = jotai.atom(null, (get, set, newPoint) => {
const targetLen = get(this.numPoints) + 1;
let data = get(this.dataAtom);
try {
const latestItemTs = newPoint?.ts ?? 0;
const cutoffTs = latestItemTs - 1000 * targetLen;
data.push(newPoint);
const newData = data.filter((dataItem) => dataItem.ts >= cutoffTs);
set(this.dataAtom, newData);
} catch (e) {
console.log("Error adding data to sysinfo", e);
}
});
this.plotMetaAtom = jotai.atom(new Map(Object.entries(DefaultPlotMeta)));
this.manageConnection = jotai.atom(true);
this.filterOutNowsh = jotai.atom(true);
this.loadingAtom = jotai.atom(true);
this.numPoints = jotai.atom((get) => {
const blockData = get(this.blockAtom);
const metaNumPoints = blockData?.meta?.["graph:numpoints"];
if (metaNumPoints == null || metaNumPoints <= 0) {
return DefaultNumPoints;
}
return metaNumPoints;
});
this.metrics = jotai.atom((get) => {
let plotType = get(this.plotTypeSelectedAtom);
const plotData = get(this.dataAtom);
try {
const metrics = PlotTypes[plotType](plotData[plotData.length - 1]);
if (metrics == null || !Array.isArray(metrics)) {
return ["cpu"];
}
return metrics;
} catch (e) {
return ["cpu"];
}
});
this.plotTypeSelectedAtom = jotai.atom((get) => {
const blockData = get(this.blockAtom);
const plotType = blockData?.meta?.["sysinfo:type"];
if (plotType == null || typeof plotType != "string") {
return "CPU";
}
return plotType;
});
this.viewIcon = jotai.atom((get) => {
return "chart-line"; // should not be hardcoded
});
this.viewName = jotai.atom((get) => {
return get(this.plotTypeSelectedAtom);
});
this.incrementCount = jotai.atom(null, async (get, set) => {
const meta = get(this.blockAtom).meta;
const count = meta.count ?? 0;
await RpcApi.SetMetaCommand(TabRpcClient, {
oref: WOS.makeORef("block", this.blockId),
meta: { count: count + 1 },
});
});
this.connection = jotai.atom((get) => {
const blockData = get(this.blockAtom);
const connValue = blockData?.meta?.connection;
if (util.isBlank(connValue)) {
return "local";
}
return connValue;
});
this.dataAtom = jotai.atom([]);
this.loadInitialData();
this.connStatus = jotai.atom((get) => {
const blockData = get(this.blockAtom);
const connName = blockData?.meta?.connection;
const connAtom = getConnStatusAtom(connName);
return get(connAtom);
});
}
async loadInitialData() {
globalStore.set(this.loadingAtom, true);
try {
const numPoints = globalStore.get(this.numPoints);
const connName = globalStore.get(this.connection);
const initialData = await RpcApi.EventReadHistoryCommand(TabRpcClient, {
event: "sysinfo",
scope: connName,
maxitems: numPoints,
});
if (initialData == null) {
return;
}
const newData = this.getDefaultData();
const initialDataItems: DataItem[] = initialData.map(convertWaveEventToDataItem);
// splice the initial data into the default data (replacing the newest points)
//newData.splice(newData.length - initialDataItems.length, initialDataItems.length, ...initialDataItems);
globalStore.set(this.addInitialDataAtom, initialDataItems);
} catch (e) {
console.log("Error loading initial data for sysinfo", e);
} finally {
globalStore.set(this.loadingAtom, false);
}
}
getSettingsMenuItems(): ContextMenuItem[] {
const fullConfig = globalStore.get(atoms.fullConfigAtom);
const termThemes = fullConfig?.termthemes ?? {};
const termThemeKeys = Object.keys(termThemes);
const plotData = globalStore.get(this.dataAtom);
termThemeKeys.sort((a, b) => {
return (termThemes[a]["display:order"] ?? 0) - (termThemes[b]["display:order"] ?? 0);
});
const fullMenu: ContextMenuItem[] = [];
let submenu: ContextMenuItem[];
if (plotData.length == 0) {
submenu = [];
} else {
submenu = Object.keys(PlotTypes).map((plotType) => {
const dataTypes = PlotTypes[plotType](plotData[plotData.length - 1]);
const currentlySelected = globalStore.get(this.plotTypeSelectedAtom);
const menuItem: ContextMenuItem = {
label: plotType,
type: "radio",
checked: currentlySelected == plotType,
click: async () => {
await RpcApi.SetMetaCommand(TabRpcClient, {
oref: WOS.makeORef("block", this.blockId),
meta: { "graph:metrics": dataTypes, "sysinfo:type": plotType },
});
},
};
return menuItem;
});
}
fullMenu.push({
label: "Plot Type",
submenu: submenu,
});
fullMenu.push({ type: "separator" });
return fullMenu;
}
getDefaultData(): DataItem[] {
// set it back one to avoid backwards line being possible
const numPoints = globalStore.get(this.numPoints);
const currentTime = Date.now() - 1000;
const points: DataItem[] = [];
for (let i = numPoints; i > -1; i--) {
points.push({ ts: currentTime - i * 1000 });
}
return points;
}
}
function makeSysinfoViewModel(blockId: string, viewType: string): SysinfoViewModel {
const sysinfoViewModel = new SysinfoViewModel(blockId, viewType);
return sysinfoViewModel;
}
const plotColors = ["#58C142", "#FFC107", "#FF5722", "#2196F3", "#9C27B0", "#00BCD4", "#FFEB3B", "#795548"];
type SysinfoViewProps = {
blockId: string;
model: SysinfoViewModel;
};
function resolveDomainBound(value: number | string, dataItem: DataItem): number | undefined {
if (typeof value == "number") {
return value;
} else if (typeof value == "string") {
return dataItem?.[value];
} else {
return undefined;
}
}
function SysinfoView({ model, blockId }: SysinfoViewProps) {
const connName = jotai.useAtomValue(model.connection);
const lastConnName = React.useRef(connName);
const connStatus = jotai.useAtomValue(model.connStatus);
const addContinuousData = jotai.useSetAtom(model.addContinuousDataAtom);
const loading = jotai.useAtomValue(model.loadingAtom);
React.useEffect(() => {
if (connStatus?.status != "connected") {
return;
}
if (lastConnName.current !== connName) {
lastConnName.current = connName;
model.loadInitialData();
}
}, [connStatus.status, connName]);
React.useEffect(() => {
const unsubFn = waveEventSubscribe({
eventType: "sysinfo",
scope: connName,
handler: (event) => {
const loading = globalStore.get(model.loadingAtom);
if (loading) {
return;
}
const dataItem = convertWaveEventToDataItem(event);
const prevData = globalStore.get(model.dataAtom);
const prevLastTs = prevData[prevData.length - 1]?.ts ?? 0;
if (dataItem.ts - prevLastTs > 2000) {
model.loadInitialData();
} else {
addContinuousData(dataItem);
}
},
});
console.log("subscribe to sysinfo", connName);
return () => {
unsubFn();
};
}, [connName]);
if (connStatus?.status != "connected") {
return null;
}
if (loading) {
return null;
}
return <SysinfoViewInner key={connStatus?.connection ?? "local"} blockId={blockId} model={model} />;
}
type SingleLinePlotProps = {
plotData: Array<DataItem>;
yval: string;
yvalMeta: TimeSeriesMeta;
blockId: string;
defaultColor: string;
title?: boolean;
sparkline?: boolean;
targetLen: number;
};
function SingleLinePlot({
plotData,
yval,
yvalMeta,
blockId,
defaultColor,
title = false,
sparkline = false,
targetLen,
}: SingleLinePlotProps) {
const containerRef = React.useRef<HTMLInputElement>();
const domRect = useDimensionsWithExistingRef(containerRef, 300);
const plotHeight = domRect?.height ?? 0;
const plotWidth = domRect?.width ?? 0;
const marks: Plot.Markish[] = [];
let decimalPlaces = yvalMeta?.decimalPlaces ?? 0;
let color = yvalMeta?.color;
if (!color) {
color = defaultColor;
}
marks.push(
() => htl.svg`<defs>
<linearGradient id="gradient-${blockId}-${yval}" gradientTransform="rotate(90)">
<stop offset="0%" stop-color="${color}" stop-opacity="0.7" />
<stop offset="100%" stop-color="${color}" stop-opacity="0" />
</linearGradient>
</defs>`
);
marks.push(
Plot.lineY(plotData, {
stroke: color,
strokeWidth: 2,
x: "ts",
y: yval,
})
);
// only add the gradient for single items
marks.push(
Plot.areaY(plotData, {
fill: `url(#gradient-${blockId}-${yval})`,
x: "ts",
y: yval,
})
);
if (title) {
marks.push(
Plot.text([yvalMeta.name], {
frameAnchor: "top-left",
dx: 4,
fill: "var(--grey-text-color)",
})
);
}
const labelY = yvalMeta?.label ?? "?";
marks.push(
Plot.ruleX(
plotData,
Plot.pointerX({ x: "ts", py: yval, stroke: "var(--grey-text-color)", strokeWidth: 1, strokeDasharray: 2 })
)
);
marks.push(
Plot.ruleY(
plotData,
Plot.pointerX({ px: "ts", y: yval, stroke: "var(--grey-text-color)", strokeWidth: 1, strokeDasharray: 2 })
)
);
marks.push(
Plot.tip(
plotData,
Plot.pointerX({
x: "ts",
y: yval,
fill: "var(--main-bg-color)",
anchor: "middle",
dy: -30,
title: (d) =>
`${dayjs.unix(d.ts / 1000).format("HH:mm:ss")} ${Number(d[yval]).toFixed(decimalPlaces)}${labelY}`,
textPadding: 3,
})
)
);
marks.push(
Plot.dot(
plotData,
Plot.pointerX({ x: "ts", y: yval, fill: color, r: 3, stroke: "var(--main-text-color)", strokeWidth: 1 })
)
);
let maxY = resolveDomainBound(yvalMeta?.maxy, plotData[plotData.length - 1]) ?? 100;
let minY = resolveDomainBound(yvalMeta?.miny, plotData[plotData.length - 1]) ?? 0;
let maxX = plotData[plotData.length - 1].ts;
let minX = maxX - targetLen * 1000;
const plot = Plot.plot({
axis: !sparkline,
x: {
grid: true,
label: "time",
tickFormat: (d) => `${dayjs.unix(d / 1000).format("HH:mm:ss")}`,
domain: [minX, maxX],
},
y: { label: labelY, domain: [minY, maxY] },
width: plotWidth,
height: plotHeight,
marks: marks,
});
React.useEffect(() => {
containerRef.current.append(plot);
return () => {
plot.remove();
};
}, [plot, plotWidth, plotHeight]);
return <div ref={containerRef} className="sysinfo-plot-content" />;
}
const SysinfoViewInner = React.memo(({ model }: SysinfoViewProps) => {
const plotData = jotai.useAtomValue(model.dataAtom);
const yvals = jotai.useAtomValue(model.metrics);
const plotMeta = jotai.useAtomValue(model.plotMetaAtom);
const osRef = React.useRef<OverlayScrollbarsComponentRef>();
const targetLen = jotai.useAtomValue(model.numPoints) + 1;
let title = false;
let cols2 = false;
if (yvals.length > 1) {
title = true;
}
if (yvals.length > 2) {
cols2 = true;
}
return (
<OverlayScrollbarsComponent
ref={osRef}
className="sysinfo-view"
options={{ scrollbars: { autoHide: "leave" } }}
>
<div className={clsx("sysinfo-inner", { "two-columns": cols2 })}>
{yvals.map((yval, idx) => {
return (
<SingleLinePlot
key={`plot-${model.blockId}-${yval}`}
plotData={plotData}
yval={yval}
yvalMeta={plotMeta.get(yval)}
blockId={model.blockId}
defaultColor={"var(--accent-color)"}
title={title}
targetLen={targetLen}
/>
);
})}
</div>
</OverlayScrollbarsComponent>
);
});
export { makeSysinfoViewModel, SysinfoView, SysinfoViewModel };