feat: add host ping endpoint and automatic reconnection UI for disconnected terminals
Release / release (pull_request) Successful in 23s
Release / release (pull_request) Successful in 23s
This commit is contained in:
@@ -4,6 +4,7 @@ SSH web client — Flask backend: auth, MariaDB, encrypted identities, WebSocket
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import socket
|
||||||
|
|
||||||
if os.getenv("GEVENT_MONKEY_PATCH", "").lower() in ("1", "true", "yes"):
|
if os.getenv("GEVENT_MONKEY_PATCH", "").lower() in ("1", "true", "yes"):
|
||||||
from gevent import monkey
|
from gevent import monkey
|
||||||
@@ -1411,6 +1412,26 @@ def list_hosts():
|
|||||||
return jsonify({"items": rows})
|
return jsonify({"items": rows})
|
||||||
|
|
||||||
|
|
||||||
|
@app.route("/api/hosts/<int:hid>/ping", methods=["GET"])
|
||||||
|
@require_auth("read:hosts")
|
||||||
|
def ping_host(hid: int):
|
||||||
|
with db_cursor() as (_, cur):
|
||||||
|
cur.execute("SELECT hostname, port FROM ssh_hosts WHERE id = %s", (hid,))
|
||||||
|
row = cur.fetchone()
|
||||||
|
if not row:
|
||||||
|
return jsonify({"error": "not found"}), 404
|
||||||
|
|
||||||
|
up = False
|
||||||
|
try:
|
||||||
|
with socket.create_connection((row["hostname"], row["port"]), timeout=2.0):
|
||||||
|
up = True
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return jsonify({"up": up})
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@app.route("/api/tags", methods=["GET"])
|
@app.route("/api/tags", methods=["GET"])
|
||||||
@require_auth("read:hosts")
|
@require_auth("read:hosts")
|
||||||
def list_tags():
|
def list_tags():
|
||||||
|
|||||||
@@ -65,6 +65,11 @@ export const api = {
|
|||||||
return d.items;
|
return d.items;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
async pingHost(id: number): Promise<{ up: boolean }> {
|
||||||
|
const res = await fetch(`/api/hosts/${id}/ping`, { credentials: "include" });
|
||||||
|
return handle<{ up: boolean }>(res);
|
||||||
|
},
|
||||||
|
|
||||||
async listTags(): Promise<string[]> {
|
async listTags(): Promise<string[]> {
|
||||||
const res = await fetch("/api/tags", { credentials: "include" });
|
const res = await fetch("/api/tags", { credentials: "include" });
|
||||||
const d = await handle<{ items: string[] }>(res);
|
const d = await handle<{ items: string[] }>(res);
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import {
|
|||||||
watch,
|
watch,
|
||||||
nextTick,
|
nextTick,
|
||||||
} from "vue";
|
} from "vue";
|
||||||
|
import { api } from "@/api";
|
||||||
import { Terminal } from "@xterm/xterm";
|
import { Terminal } from "@xterm/xterm";
|
||||||
import { FitAddon } from "@xterm/addon-fit";
|
import { FitAddon } from "@xterm/addon-fit";
|
||||||
import "@xterm/xterm/css/xterm.css";
|
import "@xterm/xterm/css/xterm.css";
|
||||||
@@ -32,12 +33,14 @@ defineExpose({
|
|||||||
const termEl = ref<HTMLElement | null>(null);
|
const termEl = ref<HTMLElement | null>(null);
|
||||||
const status = ref("Connecting…");
|
const status = ref("Connecting…");
|
||||||
const connId = ref<string | null>(null);
|
const connId = ref<string | null>(null);
|
||||||
|
const serverBackOnline = ref(false);
|
||||||
|
|
||||||
let ws: WebSocket | null = null;
|
let ws: WebSocket | null = null;
|
||||||
let term: Terminal | null = null;
|
let term: Terminal | null = null;
|
||||||
let fit: FitAddon | null = null;
|
let fit: FitAddon | null = null;
|
||||||
let ro: ResizeObserver | null = null;
|
let ro: ResizeObserver | null = null;
|
||||||
let visibilityHandler: (() => void) | null = null;
|
let visibilityHandler: (() => void) | null = null;
|
||||||
|
let pingInterval: number | null = null;
|
||||||
|
|
||||||
function wsUrl(hostId: number): string {
|
function wsUrl(hostId: number): string {
|
||||||
const proto = location.protocol === "https:" ? "wss:" : "ws:";
|
const proto = location.protocol === "https:" ? "wss:" : "ws:";
|
||||||
@@ -85,6 +88,71 @@ function isControlMessage(raw: string): boolean {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function connectWs() {
|
||||||
|
serverBackOnline.value = false;
|
||||||
|
if (pingInterval) {
|
||||||
|
clearInterval(pingInterval);
|
||||||
|
pingInterval = null;
|
||||||
|
}
|
||||||
|
if (ws) {
|
||||||
|
ws.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
ws = new WebSocket(wsUrl(props.hostId));
|
||||||
|
ws.binaryType = "arraybuffer";
|
||||||
|
|
||||||
|
ws.onopen = () => {
|
||||||
|
status.value = "Handshaking…";
|
||||||
|
sendResize();
|
||||||
|
};
|
||||||
|
|
||||||
|
ws.onmessage = (ev) => {
|
||||||
|
if (!term) return;
|
||||||
|
if (typeof ev.data === "string") {
|
||||||
|
if (isControlMessage(ev.data)) return;
|
||||||
|
term.write(ev.data);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const u8 = new Uint8Array(ev.data as ArrayBuffer);
|
||||||
|
term.write(new TextDecoder().decode(u8));
|
||||||
|
};
|
||||||
|
|
||||||
|
ws.onerror = () => {
|
||||||
|
status.value = "WebSocket error";
|
||||||
|
};
|
||||||
|
|
||||||
|
ws.onclose = () => {
|
||||||
|
if (!connId.value) {
|
||||||
|
status.value = "Disconnected";
|
||||||
|
} else {
|
||||||
|
status.value = "Session ended";
|
||||||
|
}
|
||||||
|
|
||||||
|
pingInterval = window.setInterval(async () => {
|
||||||
|
try {
|
||||||
|
const { up } = await api.pingHost(props.hostId);
|
||||||
|
if (up) {
|
||||||
|
if (pingInterval) {
|
||||||
|
clearInterval(pingInterval);
|
||||||
|
pingInterval = null;
|
||||||
|
}
|
||||||
|
serverBackOnline.value = true;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
}, 5000);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function reconnect() {
|
||||||
|
term?.clear();
|
||||||
|
term?.focus();
|
||||||
|
connId.value = null;
|
||||||
|
status.value = "Connecting…";
|
||||||
|
connectWs();
|
||||||
|
}
|
||||||
|
|
||||||
onMounted(async () => {
|
onMounted(async () => {
|
||||||
await nextTick();
|
await nextTick();
|
||||||
if (!termEl.value) return;
|
if (!termEl.value) return;
|
||||||
@@ -121,36 +189,7 @@ onMounted(async () => {
|
|||||||
ro = new ResizeObserver(() => fitAndResize());
|
ro = new ResizeObserver(() => fitAndResize());
|
||||||
ro.observe(termEl.value);
|
ro.observe(termEl.value);
|
||||||
|
|
||||||
ws = new WebSocket(wsUrl(props.hostId));
|
connectWs();
|
||||||
ws.binaryType = "arraybuffer";
|
|
||||||
|
|
||||||
ws.onopen = () => {
|
|
||||||
status.value = "Handshaking…";
|
|
||||||
sendResize();
|
|
||||||
};
|
|
||||||
|
|
||||||
ws.onmessage = (ev) => {
|
|
||||||
if (!term) return;
|
|
||||||
if (typeof ev.data === "string") {
|
|
||||||
if (isControlMessage(ev.data)) return;
|
|
||||||
term.write(ev.data);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const u8 = new Uint8Array(ev.data as ArrayBuffer);
|
|
||||||
term.write(new TextDecoder().decode(u8));
|
|
||||||
};
|
|
||||||
|
|
||||||
ws.onerror = () => {
|
|
||||||
status.value = "WebSocket error";
|
|
||||||
};
|
|
||||||
|
|
||||||
ws.onclose = () => {
|
|
||||||
if (!connId.value) {
|
|
||||||
status.value = "Disconnected";
|
|
||||||
} else {
|
|
||||||
status.value = "Session ended";
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
visibilityHandler = () => {
|
visibilityHandler = () => {
|
||||||
if (document.visibilityState === "visible") {
|
if (document.visibilityState === "visible") {
|
||||||
@@ -162,6 +201,10 @@ onMounted(async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
onUnmounted(() => {
|
onUnmounted(() => {
|
||||||
|
if (pingInterval) {
|
||||||
|
clearInterval(pingInterval);
|
||||||
|
pingInterval = null;
|
||||||
|
}
|
||||||
if (visibilityHandler) {
|
if (visibilityHandler) {
|
||||||
document.removeEventListener("visibilitychange", visibilityHandler);
|
document.removeEventListener("visibilitychange", visibilityHandler);
|
||||||
visibilityHandler = null;
|
visibilityHandler = null;
|
||||||
@@ -197,6 +240,18 @@ watch(
|
|||||||
>
|
>
|
||||||
{{ status }}
|
{{ status }}
|
||||||
</div>
|
</div>
|
||||||
|
<div
|
||||||
|
v-if="serverBackOnline"
|
||||||
|
class="absolute bottom-4 right-4 z-20 flex items-center gap-3 rounded bg-slate-800 px-4 py-3 text-sm shadow-lg border border-slate-700"
|
||||||
|
>
|
||||||
|
<span class="text-slate-200">Server is back online</span>
|
||||||
|
<button
|
||||||
|
@click="reconnect"
|
||||||
|
class="rounded bg-emerald-600 px-3 py-1.5 font-medium text-white hover:bg-emerald-500 transition-colors"
|
||||||
|
>
|
||||||
|
Reconnect
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
<div
|
<div
|
||||||
ref="termEl"
|
ref="termEl"
|
||||||
class="h-full min-h-[320px] rounded-lg border border-slate-800 bg-[#0d1117] p-1"
|
class="h-full min-h-[320px] rounded-lg border border-slate-800 bg-[#0d1117] p-1"
|
||||||
|
|||||||
Reference in New Issue
Block a user