chain-studio/lib/data/system_actions.dart
flemming-it 3db7db7330
Some checks are pending
Security / Security check (push) Waiting to run
feat(studio): hub maintenance panel with reset action (v0.45.0)
UI parity with the platform CLI: `fai reset` (v0.10.93) is now
reachable from Settings. The panel shows the reset blurb plus
two checkboxes mirroring the CLI flags (Keep modules / Keep
audit log + saved flows), then a destructive-styled "Reset hub
state" button. Click goes through a confirm dialog before
SystemActions.faiReset is invoked.

After the CLI returns, Studio bounces its gRPC channel against
the same endpoint (the daemon restarts on the same channel +
port, so no Settings change needed) and reloads every panel:
channel status, system AI, MCP clients, n8n endpoints, registry
token. Output (success or failure) is shown in a copyable error
box so any unexpected stderr lands somewhere the operator can
paste from.

Sits at the bottom of the dialog under "HUB MAINTENANCE",
separated from the everyday config so a destructive button
doesn't crowd the day-to-day controls.

Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
2026-05-09 18:52:19 +02:00

211 lines
7.8 KiB
Dart

// System-level actions Studio invokes by spawning the `fai`
// binary or asking the OS to open a file. Used by Doctor's
// daemon-control + open-paths affordances so Windows operators
// who never touch a shell can restart the daemon, apply an
// update, or open a log file from inside the GUI.
//
// Cross-platform notes:
// - macOS uses `open` for files + URLs.
// - Linux uses `xdg-open`.
// - Windows uses `explorer` (file manager) and a quoted CLI
// call for processes.
//
// The `fai` binary is resolved from PATH first; falls back to
// `~/.fai/bin/fai` (Unix) or `%USERPROFILE%\.fai\bin\fai.exe`
// (Windows). The PowerShell installer puts both in PATH but
// some operators don't restart their shell after install — the
// fallback covers that case.
import 'dart:io';
class SystemActions {
SystemActions._();
/// Ask the OS to open [path] in the default handler. On macOS
/// this opens text files in TextEdit, configs in the registered
/// editor, etc. Returns true on a clean spawn (process exited
/// non-zero is still surfaced as false).
static Future<({bool ok, String stderr})> openInOs(String path) async {
if (path.isEmpty) {
return (ok: false, stderr: 'empty path');
}
final cmd = _openCommand();
try {
final r = await Process.run(cmd.executable, [...cmd.args, path]);
if (r.exitCode == 0) return (ok: true, stderr: '');
return (ok: false, stderr: r.stderr.toString().trim());
} catch (e) {
return (ok: false, stderr: e.toString());
}
}
/// Reveal [path] in the platform file manager. Works for binary
/// files (the SQLite audit DB, the PID file) where `openInOs`
/// would fall flat — macOS refuses to "open" a file with no
/// registered app. macOS uses `open -R`; Windows
/// `explorer /select,`; Linux falls back to opening the parent
/// directory because there is no portable reveal-and-highlight.
static Future<({bool ok, String stderr})> revealInOs(String path) async {
if (path.isEmpty) {
return (ok: false, stderr: 'empty path');
}
try {
final ProcessResult r;
if (Platform.isMacOS) {
r = await Process.run('open', ['-R', path]);
} else if (Platform.isWindows) {
// /select, requires no space after the comma; explorer
// returns 1 even on success, so don't gate on exitCode.
r = await Process.run('explorer', ['/select,$path']);
return (ok: true, stderr: '');
} else {
// Linux: open the containing directory in the default
// file manager. Best portable approximation.
final parent = File(path).parent.path;
r = await Process.run('xdg-open', [parent]);
}
if (r.exitCode == 0) return (ok: true, stderr: '');
return (ok: false, stderr: r.stderr.toString().trim());
} catch (e) {
return (ok: false, stderr: e.toString());
}
}
/// Convenience: reveal binary files, open directories /
/// text-shaped paths normally. Doctor's path rows use this so
/// the operator never has to know which strategy fits which
/// kind of file.
static Future<({bool ok, String stderr})> openOrReveal(
String path, {
required bool isDirectory,
}) async {
if (isDirectory) return openInOs(path);
return revealInOs(path);
}
/// Run a `fai daemon ...` subcommand and surface the captured
/// output. Used by Doctor's "Restart daemon" button.
static Future<({bool ok, String stdout, String stderr})> faiDaemon(
List<String> args,
) async {
return _runFai(['daemon', ...args]);
}
/// Run `fai update apply --channel <c>`. Long-running on a slow
/// network — caller should show a spinner.
static Future<({bool ok, String stdout, String stderr})> faiUpdateApply(
String channel,
) async {
return _runFai(['update', 'apply', '--channel', channel]);
}
/// Switch the active channel pointer at `~/.fai/current-channel`.
/// The CLI also restarts the daemon for the new channel, so the
/// caller does not need a follow-up restart.
static Future<({bool ok, String stdout, String stderr})> faiChannelSwitch(
String channel,
) async {
return _runFai(['channel', 'switch', channel]);
}
/// Install the platform-native autostart unit for [channel]
/// (launchd plist on macOS, systemd-user unit on Linux). On
/// Windows the platform CLI returns a "not supported" exit
/// status that the caller surfaces as an error message.
static Future<({bool ok, String stdout, String stderr})> faiDaemonEnable(
String channel,
) async {
return _runFai(['daemon', 'enable', '--channel', channel]);
}
/// Remove the autostart unit installed by [faiDaemonEnable].
static Future<({bool ok, String stdout, String stderr})> faiDaemonDisable(
String channel,
) async {
return _runFai(['daemon', 'disable', '--channel', channel]);
}
/// Run `fai reset --yes`. Wipes operator state with the same
/// safety net as the CLI: stops every daemon (including off-
/// channel orphans), atomically backs `~/.fai/` up, recreates
/// it with `bin/`, `channels/`, `config.yaml`, `current-channel`,
/// and `registry-token` preserved. The daemon restarts on the
/// active channel before the call returns.
///
/// Studio's gRPC channel goes down for ~1s while the daemon
/// restarts — caller should follow up with a reconnect.
static Future<({bool ok, String stdout, String stderr})> faiReset({
bool keepModules = false,
bool keepData = false,
}) async {
final args = <String>['reset', '--yes'];
if (keepModules) args.add('--keep-modules');
if (keepData) args.add('--keep-data');
return _runFai(args);
}
static Future<({bool ok, String stdout, String stderr})> _runFai(
List<String> args,
) async {
final exe = _faiExecutable();
if (exe == null) {
return (
ok: false,
stdout: '',
stderr: 'Could not locate the `fai` binary. Install via the '
'platform installer or set FAI_BIN to its full path.',
);
}
try {
final r = await Process.run(exe, args);
return (
ok: r.exitCode == 0,
stdout: r.stdout.toString(),
stderr: r.stderr.toString(),
);
} catch (e) {
return (ok: false, stdout: '', stderr: e.toString());
}
}
static ({String executable, List<String> args}) _openCommand() {
if (Platform.isMacOS) return (executable: 'open', args: const []);
if (Platform.isWindows) return (executable: 'explorer', args: const []);
return (executable: 'xdg-open', args: const []);
}
/// Locate the `fai` binary. Order: $FAI_BIN, PATH, fallback to
/// the canonical install location under the user's home dir.
static String? _faiExecutable() {
final fromEnv = Platform.environment['FAI_BIN'];
if (fromEnv != null && fromEnv.isNotEmpty && File(fromEnv).existsSync()) {
return fromEnv;
}
final isWindows = Platform.isWindows;
final fromPath = _whichFai(isWindows ? 'fai.exe' : 'fai');
if (fromPath != null) return fromPath;
final home = Platform.environment[isWindows ? 'USERPROFILE' : 'HOME'];
if (home == null || home.isEmpty) return null;
final fallback = isWindows
? '$home\\.fai\\bin\\fai.exe'
: '$home/.fai/bin/fai';
return File(fallback).existsSync() ? fallback : null;
}
/// Tiny PATH walker — we cannot rely on `which`/`where` being
/// reachable via Process.run on every platform.
static String? _whichFai(String name) {
final pathEnv = Platform.environment['PATH'];
if (pathEnv == null || pathEnv.isEmpty) return null;
final sep = Platform.isWindows ? ';' : ':';
final slash = Platform.isWindows ? '\\' : '/';
for (final dir in pathEnv.split(sep)) {
if (dir.isEmpty) continue;
final candidate = '$dir$slash$name';
if (File(candidate).existsSync()) return candidate;
}
return null;
}
}