Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

feat(frontend): useServerStream hook — one join/listen/cleanup dance (plan 77 E4)

Juan Denisa9e76cf31714
diff --git a/frontend/src/components/JobProgressModal.jsx b/frontend/src/components/JobProgressModal.jsx
index 69dffeef..cacb209c 100644
--- a/frontend/src/components/JobProgressModal.jsx
+++ b/frontend/src/components/JobProgressModal.jsx
@@ -1,8 +1,8 @@
-import { useEffect, useRef, useState } from 'react';
+import { useCallback, useEffect, useRef, useState } from 'react';
import Modal from './Modal';
import { Button } from '@/components/ui/button';
-import socketService from '../services/socket';
-import { rooms } from '@/constants/events';
+import { rooms, SOCKET_EVENTS } from '@/constants/events';
+import { useServerStream } from '@/hooks/useServerStream';
// Subscribes to a remote agent's job:<id> stream channel and renders
// the live log output. Used by PackagesTab and ServicesTab for
@@ -25,45 +25,31 @@ export default function JobProgressModal({
const [done, setDone] = useState(null); // null | { exitCode, error, extra }
const logEndRef = useRef(null);
- useEffect(() => {
- if (!open || !channel || !serverId) return;
- const room = rooms.serverChannel(serverId, channel);
- const socket = socketService.socket;
- if (!socket) {
- // Connect lazily — happens once per panel session normally.
- socketService.connect();
+ const onStream = useCallback((msg) => {
+ if (msg?.channel !== channel) return;
+ const ev = msg.data || {};
+ if (Array.isArray(ev.lines) && ev.lines.length) {
+ setLines((prev) => [...prev, ...ev.lines]);
+ } else if (ev.message) {
+ setLines((prev) => [...prev, ev.message]);
}
+ if (ev.phase === 'done') {
+ const exitCode = typeof ev.exit_code === 'number' ? ev.exit_code : null;
+ setDone({
+ exitCode,
+ error: ev.error || '',
+ extra: ev.extra || null,
+ });
+ if (onComplete) onComplete(ev);
+ }
+ }, [channel, onComplete]);
- const activeSocket = socketService.socket;
- if (!activeSocket) return;
-
- const onStream = (msg) => {
- if (msg?.channel !== channel) return;
- const ev = msg.data || {};
- if (Array.isArray(ev.lines) && ev.lines.length) {
- setLines((prev) => [...prev, ...ev.lines]);
- } else if (ev.message) {
- setLines((prev) => [...prev, ev.message]);
- }
- if (ev.phase === 'done') {
- const exitCode = typeof ev.exit_code === 'number' ? ev.exit_code : null;
- setDone({
- exitCode,
- error: ev.error || '',
- extra: ev.extra || null,
- });
- if (onComplete) onComplete(ev);
- }
- };
-
- activeSocket.emit('join_room', { room });
- activeSocket.on('server_stream', onStream);
-
- return () => {
- activeSocket.emit('leave_room', { room });
- activeSocket.off('server_stream', onStream);
- };
- }, [open, channel, serverId, onComplete]);
+ useServerStream(
+ serverId && channel ? rooms.serverChannel(serverId, channel) : null,
+ SOCKET_EVENTS.SERVER_STREAM,
+ onStream,
+ { enabled: open },
+ );
// Reset state on close so the next job starts fresh.
useEffect(() => {
diff --git a/frontend/src/components/serverdetail/CloudflaredTab.jsx b/frontend/src/components/serverdetail/CloudflaredTab.jsx
index c95f4560..b21cd393 100644
--- a/frontend/src/components/serverdetail/CloudflaredTab.jsx
+++ b/frontend/src/components/serverdetail/CloudflaredTab.jsx
@@ -218,15 +218,9 @@ const CloudflaredTab = ({ serverId, serverStatus }) => {
// server_stream room. We don't open the JobProgressModal
// because the login flow needs a different shape (a single
// big "Open URL" CTA, not a log tail).
- const { default: socketService } = await import('../../services/socket');
- if (!socketService.socket) socketService.connect();
- const sock = socketService.socket;
- if (!sock) {
- setLogin(null);
- toast.error('Socket not available');
- return;
- }
+ const { joinServerStream } = await import('../../hooks/useServerStream');
const room = rooms.serverChannel(serverId, channel);
+ let stopStream = () => {};
const onStream = (msg) => {
if (msg?.channel !== channel) return;
const ev = msg.data || {};
@@ -247,12 +241,10 @@ const CloudflaredTab = ({ serverId, serverStatus }) => {
loadStatus();
loadTunnels();
}
- sock.off('server_stream', onStream);
- sock.emit('leave_room', { room });
+ stopStream();
}
};
- sock.emit('join_room', { room });
- sock.on('server_stream', onStream);
+ stopStream = joinServerStream(room, 'server_stream', onStream);
} catch (err) {
toast.error(err.message || 'Failed to start login');
setLogin(null);
diff --git a/frontend/src/hooks/useServerStream.js b/frontend/src/hooks/useServerStream.js
new file mode 100644
index 00000000..15de3450
--- /dev/null
+++ b/frontend/src/hooks/useServerStream.js
@@ -0,0 +1,38 @@
+// useServerStream — the ONE join/listen/cleanup dance for socket rooms
+// (plan 77 E4). Components used to hand-roll connect + join_room + on(event)
+// + off/leave in slightly different ways (some forgot to re-join after a
+// reconnect, which silently kills the stream server-side). Both shapes live
+// here:
+//
+// useServerStream(room, event, handler, { enabled }) // effect-shaped
+// const stop = joinServerStream(room, event, handler); // imperative
+//
+// `handler` must be referentially stable across renders for the hook form
+// (wrap it in useCallback) or the room will be left/re-joined every render.
+import { useEffect } from 'react';
+
+import socketService from '@/services/socket';
+
+export function joinServerStream(room, event, handler) {
+ if (!socketService.socket) socketService.connect();
+ const sock = socketService.socket;
+ if (!sock || !room) return () => {};
+
+ const join = () => sock.emit('join_room', { room });
+ join(); // socket.io buffers this until connected
+ sock.on('connect', join); // rooms are lost server-side on reconnect
+ sock.on(event, handler);
+
+ return () => {
+ sock.off(event, handler);
+ sock.off('connect', join);
+ if (sock.connected) sock.emit('leave_room', { room });
+ };
+}
+
+export function useServerStream(room, event, handler, { enabled = true } = {}) {
+ useEffect(() => {
+ if (!enabled || !room) return undefined;
+ return joinServerStream(room, event, handler);
+ }, [room, event, handler, enabled]);
+}