add better client sync schemes initialization,

add client sync scheme selects to localdb,
start on interrupt sync scheme implementation,
change sync endpoints to start with /sync/

config/template.localdb.json

@@ -87,6 +87,11 @@
 				"whitelist": true,
 				"display": true
 			}
+		},
+		"clientsync": {
+			"always": true,
+			"hash": true,
+			"interrupt": true
 		}
 	},
 	"users": {

package.json

@@ -7,10 +7,12 @@
 	"dependencies": {
 		"axios": "^1.3.2",
 		"body-parser": "^1.20.1",
+		"cookie": "^0.5.0",
 		"cookie-parser": "^1.4.6",
 		"cors": "^2.8.5",
 		"express": "^4.18.2",
-		"morgan": "^1.10.0"
+		"morgan": "^1.10.0",
+		"ws": "^8.13.0"
 	},
 	"devDependencies": {
 		"eslint": "^8.43.0",

src/clientsync.js

@@ -0,0 +1,69 @@
+import { WebSocketServer } from "ws";
+import * as cookie from "cookie";
+
+import { requestPVE } from "./pve.js";
+import { checkAuth, getObjectHash } from "./utils.js";
+
+// maps usernames to socket object(s)
+const userSocketMap = {};
+// maps proxmox resource ids to user(s) who can access the resource
+const resourceUserMap = {};
+
+export function setupClientSync (app, server, schemes) {
+	/**
+	 * GET - get list of supported synchronization schemes
+	 * responses:
+	 * - 200 : {always: boolean, hash: boolean, interrupt: boolean}
+	 */
+	app.get("/api/sync/schemes", async (req, res) => {
+		res.send(schemes);
+	});
+
+	if (schemes.hash) {
+		/**
+		 * GET - get hash of current cluster resources states
+		 * Client can use this endpoint to check for cluster state changes to avoid costly data transfers to the client.
+		 * responses:
+		 * - 401: {auth: false}
+		 * - 200: string
+		 */
+		app.get("/api/sync/hash", async (req, res) => {
+			// check auth
+			const auth = await checkAuth(req.cookies, res);
+			if (!auth) {
+				return;
+			}
+			// get current cluster resources
+			const status = (await requestPVE("/cluster/resources", "GET", req.cookies)).data.data;
+			// filter out just state information of resources that are needed
+			const resources = ["lxc", "qemu", "node"];
+			const state = {};
+			status.forEach((element) => {
+				if (resources.includes(element.type)) {
+					state[element.id] = element.status;
+				}
+			});
+			res.status(200).send(getObjectHash(state));
+		});
+	}
+	if (schemes.interrupt) {
+		const wsServer = new WebSocketServer({ noServer: true, path: "/api/sync/interrupt" });
+		wsServer.on("connection", (socket, username) => {
+			socket.on("message", (message) => {
+				console.log(message.toString());
+			});
+		});
+		server.on("upgrade", async (req, socket, head) => {
+			const cookies = cookie.parse(req.headers.cookie || "");
+			const auth = (await requestPVE("/version", "GET", cookies)).status === 200;
+			if (!auth) {
+				socket.destroy();
+			}
+			else {
+				wsServer.handleUpgrade(req, socket, head, (socket) => {
+					wsServer.emit("connection", socket, cookies.username);
+				});
+			}
+		});
+	}
+}

src/main.js

@@ -6,8 +6,9 @@ import morgan from "morgan";
 
 import { api } from "./package.js";
 import { requestPVE, handleResponse, getDiskInfo, getDeviceInfo, getNodeAvailDevices } from "./pve.js";
-import { checkAuth, approveResources, getUserResources, getObjectHash } from "./utils.js";
+import { checkAuth, approveResources, getUserResources } from "./utils.js";
 import { db, pveAPIToken, listenPort, hostname, domain } from "./db.js";
+import { setupClientSync } from "./clientsync.js";
 
 const app = express();
 app.use(bodyParser.urlencoded({ extended: true }));
@@ -1196,32 +1197,7 @@ app.delete(`/api/:node(${nodeRegexP})/:type(${typeRegexP})/:vmid(${vmidRegexP})/
 	await handleResponse(params.node, result, res);
 });
 
-/**
- * GET - get hash of current cluster resources states
- * Client can use this endpoint to check for cluster state changes to avoid costly data transfers to the client.
- * responses:
- * - 401: {auth: false}
- * - 200: string
- */
-app.get(`/api/cluster/statushash`, async (req, res) => {
-	// check auth
-	const auth = await checkAuth(req.cookies, res);
-	if (!auth) {
-		return;
-	}
-	// get current cluster resources
-	let status = (await requestPVE("/cluster/resources", "GET", req.cookies)).data.data;
-	// filter out just state information of resources that are needed
-	let resources = ["lxc", "qemu", "node"]; 
-	let state = {};
-	status.forEach((element) => {
-		if (resources.includes(element.type)) {
-			state[element.id] = element.status;
-		}
-	});
-	res.status(200).send(getObjectHash(state));
-});
-
-app.listen(listenPort, () => {
+const server = app.listen(listenPort, () => {
 	console.log(`proxmoxaas-api v${api.version} listening on port ${listenPort}`);
 });
+setupClientSync(app, server, db.getGlobalConfig().clientsync);

src/utils.js

@@ -94,7 +94,6 @@ export async function approveResources (req, username, request) {
 	return approved; // if all requested resources pass, allow
 }
 
-
 export function getObjectHash (object, alg = "sha256", format = "hex") {
 	const hash = createHash(alg);
 	hash.update(JSON.stringify(object, Object.keys(object).sort()));