From 64588105719442ac9894840aeca6308c6803a69e Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Thu, 18 Mar 2021 21:53:10 +0100 Subject: [PATCH] Add name to account model Add the name of the account that's connected to the control link on the web interface via an additional property on the ready payload for the control link. --- packages/lib/link/connectors.js | 2 +- packages/lib/schema.js | 7 +++++++ packages/master/master.js | 11 ++++++++-- packages/web_ui/src/components/SiteLayout.jsx | 2 ++ packages/web_ui/src/model/account.jsx | 20 ++++++++++++++++++- packages/web_ui/src/util/websocket.jsx | 13 +++++++++++- 6 files changed, 50 insertions(+), 5 deletions(-) diff --git a/packages/lib/link/connectors.js b/packages/lib/link/connectors.js index 91a6f995..1dd60cbe 100644 --- a/packages/lib/link/connectors.js +++ b/packages/lib/link/connectors.js @@ -401,7 +401,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector { } this._startedReconnect = null; this._connected = true; - this.emit("connect"); + this.emit("connect", data); } else if (type === "continue") { logger.verbose("SOCKET | resuming existing session"); diff --git a/packages/lib/schema.js b/packages/lib/schema.js index 7245a7fd..7ceea00e 100644 --- a/packages/lib/schema.js +++ b/packages/lib/schema.js @@ -102,6 +102,13 @@ const serverHandshake = ajv.compile({ properties: { "session_token": { type: "string" }, "heartbeat_interval": { type: "number" }, + "account": { + additionalProperties: false, + required: ["name"], + properties: { + "name": { type: "string" }, + }, + }, }, }, }, diff --git a/packages/master/master.js b/packages/master/master.js index 54ac0933..f82e2b31 100755 --- a/packages/master/master.js +++ b/packages/master/master.js @@ -1371,8 +1371,10 @@ class WebSocketServerConnector extends libLink.WebSocketBaseConnector { * * @param {string} sessionToken - * the session token to send to the client. + * @param {Object=} additionalData - + * extra properties to send along the ready message. */ - ready(sessionToken) { + ready(sessionToken, additionalData) { this._heartbeatInterval = masterConfig.get("master.heartbeat_interval"); this._socket.send(JSON.stringify({ seq: null, @@ -1380,6 +1382,7 @@ class WebSocketServerConnector extends libLink.WebSocketBaseConnector { data: { session_token: sessionToken, heartbeat_interval: this._heartbeatInterval, + ...additionalData, }, })); @@ -1650,6 +1653,7 @@ async function handleHandshake(message, socket, req, attachHandler) { let connector = new WebSocketServerConnector(socket, sessionId); activeConnectors.set(sessionId, connector); + let additionalReadyData = {}; if (type === "register_slave") { let connection = slaveConnections.get(data.id); if (connection) { @@ -1664,9 +1668,12 @@ async function handleHandshake(message, socket, req, attachHandler) { } else if (type === "register_control") { logger.verbose(`SOCKET | registered control from ${req.socket.remoteAddress}`); controlConnections.push(new ControlConnection(data, connector, user)); + additionalReadyData["account"] = { + name: user.name, + }; } - connector.ready(sessionToken); + connector.ready(sessionToken, additionalReadyData); } wss.on("connection", (socket, req) => { diff --git a/packages/web_ui/src/components/SiteLayout.jsx b/packages/web_ui/src/components/SiteLayout.jsx index bdfeedc9..fda48ca9 100644 --- a/packages/web_ui/src/components/SiteLayout.jsx +++ b/packages/web_ui/src/components/SiteLayout.jsx @@ -52,6 +52,8 @@ export default function SiteLayout(props) { } let accountMenu = + + { account.logOut(); }}>Log out ; diff --git a/packages/web_ui/src/model/account.jsx b/packages/web_ui/src/model/account.jsx index c6ab7cbe..e2b7631b 100644 --- a/packages/web_ui/src/model/account.jsx +++ b/packages/web_ui/src/model/account.jsx @@ -1,17 +1,35 @@ -import { useContext } from "react"; +import { useContext, useEffect, useState } from "react"; import { notifyErrorHandler } from "../util/notify"; import ControlContext from "../components/ControlContext"; /** * @typedef {Object} Account + * @property {?string} name - Name of the currently logged in account. * @property {function()} logout - Logs out of the web interface. */ export function useAccount() { let control = useContext(ControlContext); + let [name, setName] = useState(control.accountName); + + useEffect(() => { + function onConnect(data) { + setName(data.account.name); + } + function onClose() { + setName(null); + } + control.connector.on("connect", onConnect); + control.connector.on("close", onClose); + return () => { + control.connector.off("connect", onConnect); + control.connector.off("close", onClose); + }; + }, [control]); return { + name, logOut() { control.loggingOut = true; control.shutdown(notifyErrorHandler("Error logging out")); diff --git a/packages/web_ui/src/util/websocket.jsx b/packages/web_ui/src/util/websocket.jsx index 7c6815ea..f0611eb8 100644 --- a/packages/web_ui/src/util/websocket.jsx +++ b/packages/web_ui/src/util/websocket.jsx @@ -55,13 +55,24 @@ export class Control extends libLink.Link { */ this.loggingOut = false; + /** + * Name of the account this control link is connected as. + * @type {?string} + */ + this.accountName = null; + this.instanceLogHandlers = new Map(); - this.connector.on("connect", () => { + this.connector.on("connect", data => { + this.accountName = data.account.name; this.updateLogSubscriptions().catch(err => logger.error( `Unexpected error updating log subscriptions:\n${err.stack}` )); }); + + this.connector.on("close", () => { + this.accountName = null; + }); } async logMessageEventHandler(message) {