Feat: Stack validation

Author: Its4Nik

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Run unit tests
         run: |
           export PAD_NEW_LINES=false
-          docker compose -f docker/docker-compose.unit-test.yaml up -d
+          docker compose -f docker/docker-compose.dev.yaml up -d
           bun test
 
       - name: Log unit test files

package.json

@@ -33,6 +33,7 @@
     "dockerode": "^4.0.6",
     "elysia": "latest",
     "elysia-remote-dts": "^1.0.3",
+    "js-yaml": "^4.1.0",
     "knip": "latest",
     "logestic": "^1.2.4",
     "split2": "^4.2.0",
@@ -43,6 +44,7 @@
     "@biomejs/biome": "1.9.4",
     "@types/bun": "latest",
     "@types/dockerode": "^3.3.39",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^22.15.29",
     "@types/split2": "^4.2.3",
     "bun-types": "latest",

src/core/database/database.ts

@@ -47,7 +47,8 @@ export function init() {
       version INTEGER NOT NULL,
       custom BOOLEAN NOT NULL,
       source TEXT NOT NULL,
-      compose_spec TEXT NOT NULL
+      compose_spec TEXT NOT NULL,
+      status TEXT NOT NULL
     );
 
     CREATE TABLE IF NOT EXISTS docker_hosts (

src/core/database/stacks.ts

@@ -1,25 +1,29 @@
 import type { stacks_config } from "~/typings/database";
-import type { Stack } from "~/typings/docker-compose";
 import { findObjectByKey } from "../utils/helpers";
 import { db } from "./database";
 import { executeDbOperation } from "./helper";
 
 const stmt = {
 	insert: db.prepare(`
     INSERT INTO stacks_config (
-      name, version, custom, source, compose_spec
-    ) VALUES (?, ?, ?, ?, ?)
+      name, version, custom, source, compose_spec, status
+    ) VALUES (?, ?, ?, ?, ?, ?)
   `),
 	selectAll: db.prepare(`
-    SELECT id, name, version, custom, source, compose_spec
+    SELECT id, name, version, custom, source, compose_spec, status
     FROM stacks_config
-    ORDER BY name DESC
+    ORDER BY id DESC
   `),
 	update: db.prepare(`
    	UPDATE stacks_config
    	SET name = ?, custom = ?, source = ?, compose_spec = ?
-    WHERE name = ?
+    WHERE id = ?
   `),
+	setStatus: db.prepare(`
+    UPDATE stacks_config
+    SET status = ?
+    WHERE id = ?
+    `),
 	delete: db.prepare("DELETE FROM stacks_config WHERE id = ?"),
 };
 
@@ -31,6 +35,7 @@ export function addStack(stack: stacks_config) {
 			stack.custom,
 			stack.source,
 			stack.compose_spec,
+			"active",
 		),
 	);
 
@@ -40,7 +45,7 @@ export function addStack(stack: stacks_config) {
 export function getStacks() {
 	return executeDbOperation("Get Stacks", () =>
 		stmt.selectAll.all(),
-	) as Stack[];
+	) as stacks_config[];
 }
 
 export function deleteStack(id: number) {
@@ -54,13 +59,27 @@ export function deleteStack(id: number) {
 }
 
 export function updateStack(stack: stacks_config) {
-	return executeDbOperation("Update Stack", () =>
+	return executeDbOperation("Update Stack", () => {
+		if (!stack.id) {
+			throw new Error("Stack ID needed");
+		}
 		stmt.update.run(
+			stack.id,
 			stack.version,
 			stack.custom,
 			stack.source,
 			stack.name,
 			stack.compose_spec,
-		),
-	);
+		);
+	});
+}
+
+export function setStackStatus(
+	stack: stacks_config,
+	status: "active" | "error" = "active",
+) {
+	if (!stack.id) {
+		throw new Error("Stack ID needed");
+	}
+	stmt.setStatus.run(status, stack.id);
 }

src/core/stacks/checker.ts

@@ -0,0 +1,47 @@
+import yaml from "js-yaml";
+import { dbFunctions } from "../database";
+import { logger } from "../utils/logger";
+
+const stacks = dbFunctions.getStacks();
+
+export async function checkStacks() {
+	logger.debug(`Checking ${stacks.length} stack(s)`);
+	for (const stack of stacks) {
+		try {
+			logger.debug(`Checking ${stack.id}`);
+			const composeFile = Bun.file(
+				`stacks/${stack.id}-${stack.name}/docker-compose.yaml`,
+			);
+
+			if (!(await composeFile.exists())) {
+				logger.error(`Stack (${stack.id} - ${stack.name}) has no compose file`);
+				dbFunctions.setStackStatus(stack, "error");
+				continue;
+			}
+
+			if (
+				stack.compose_spec !==
+				JSON.stringify(yaml.load(await composeFile.text()))
+			) {
+				logger.error(
+					`Stack (${stack.id} - ${stack.name}) does not match the saved compose file`,
+				);
+				logger.debug(`Database config: ${stack.compose_spec}`);
+				logger.debug(
+					`Compose config: ${JSON.stringify(
+						yaml.load(await composeFile.text()),
+					)}`,
+				);
+				dbFunctions.setStackStatus(stack, "error");
+				continue;
+			}
+
+			dbFunctions.setStackStatus(stack, "active");
+		} catch (error) {
+			const errorMsg = error instanceof Error ? error.message : String(error);
+			logger.error(errorMsg);
+		}
+	}
+
+	logger.info("Checked stacks");
+}

src/core/stacks/controller.ts

@@ -7,10 +7,11 @@ import { postToClient } from "~/routes/live-stacks";
 import type { stacks_config } from "~/typings/database";
 import type { ComposeSpec, Stack } from "~/typings/docker-compose";
 import { findObjectByKey } from "../utils/helpers";
+import { checkStacks } from "./checker";
 
 const wrapProgressCallback = (progressCallback?: (log: string) => void) => {
 	return progressCallback
-		? (chunk: Buffer, streamSource?: "stdout" | "stderr") => {
+		? (chunk: Buffer) => {
 				const log = chunk.toString();
 				progressCallback(log);
 			}
@@ -197,6 +198,8 @@ export async function deployStack(stack_config: stacks_config): Promise<void> {
 			},
 		});
 		throw new Error(errorMsg);
+	} finally {
+		await checkStacks();
 	}
 }
 
@@ -399,19 +402,3 @@ export async function getAllStacksStatus(): Promise<StacksStatus> {
 		throw new Error(errorMsg);
 	}
 }
-
-async function backupStack(stackId: number) {
-	if (!stackId) {
-		throw new Error("No Stack ID provided");
-	}
-
-	const stacks = dbFunctions.getStacks();
-
-	const stack = findObjectByKey(stacks, "id", stackId);
-
-	if (!stack) {
-		throw new Error(`No Stack with Id: ${stackId} found`);
-	}
-
-	const stack_path = `${stack.id}-${stack.name}`;
-}

src/index.ts

@@ -24,6 +24,7 @@ import { liveLogs } from "~/routes/live-logs";
 import { backendLogs } from "~/routes/logs";
 import { stackRoutes } from "~/routes/stacks";
 import type { config } from "~/typings/database";
+import { checkStacks } from "./core/stacks/checker";
 import { liveStacks } from "./routes/live-stacks";
 
 console.log("");
@@ -168,6 +169,8 @@ const initializeServer = async () => {
 			);
 		}
 
+		await checkStacks();
+
 		logger.info("Started server");
 		console.log("----- [ ############## ]");
 	} catch (error) {