feat: partial success warning status (#74)

* feat: report partial backups with warnings

* chore: rebase

* chore: remove un-used size prop

app/server/core/events.ts

@@ -22,7 +22,7 @@ interface ServerEvents {
 		scheduleId: number;
 		volumeName: string;
 		repositoryName: string;
-		status: "success" | "error" | "stopped";
+		status: "success" | "error" | "stopped" | "warning";
 	}) => void;
 	"volume:mounted": (data: { volumeName: string }) => void;
 	"volume:unmounted": (data: { volumeName: string }) => void;

app/server/db/schema.ts

@@ -85,7 +85,7 @@ export const backupSchedulesTable = sqliteTable("backup_schedules_table", {
 	excludePatterns: text("exclude_patterns", { mode: "json" }).$type<string[]>().default([]),
 	includePatterns: text("include_patterns", { mode: "json" }).$type<string[]>().default([]),
 	lastBackupAt: int("last_backup_at", { mode: "number" }),
-	lastBackupStatus: text("last_backup_status").$type<"success" | "error" | "in_progress">(),
+	lastBackupStatus: text("last_backup_status").$type<"success" | "error" | "in_progress" | "warning">(),
 	lastBackupError: text("last_backup_error"),
 	nextBackupAt: int("next_backup_at", { mode: "number" }),
 	createdAt: int("created_at", { mode: "number" }).notNull().default(sql`(unixepoch())`),

app/server/modules/backups/backups.dto.ts

@@ -25,7 +25,7 @@ const backupScheduleSchema = type({
 	excludePatterns: "string[] | null",
 	includePatterns: "string[] | null",
 	lastBackupAt: "number | null",
-	lastBackupStatus: "'success' | 'error' | 'in_progress' | null",
+	lastBackupStatus: "'success' | 'error' | 'in_progress' | 'warning' | null",
 	lastBackupError: "string | null",
 	nextBackupAt: "number | null",
 	createdAt: "number",

app/server/modules/backups/backups.service.ts

@@ -236,7 +236,7 @@ const executeBackup = async (scheduleId: number, manual = false) => {
 			backupOptions.include = schedule.includePatterns;
 		}
 
-		await restic.backup(repository.config, volumePath, {
+		const { exitCode } = await restic.backup(repository.config, volumePath, {
 			...backupOptions,
 			compressionMode: repository.compressionMode ?? "auto",
 			onProgress: (progress) => {
@@ -258,24 +258,28 @@ const executeBackup = async (scheduleId: number, manual = false) => {
 			.update(backupSchedulesTable)
 			.set({
 				lastBackupAt: Date.now(),
-				lastBackupStatus: "success",
+				lastBackupStatus: exitCode === 0 ? "success" : "warning",
 				lastBackupError: null,
 				nextBackupAt: nextBackupAt,
 				updatedAt: Date.now(),
 			})
 			.where(eq(backupSchedulesTable.id, scheduleId));
 
-		logger.info(`Backup completed successfully for volume ${volume.name} to repository ${repository.name}`);
+		if (exitCode !== 0) {
+			logger.warn(`Backup completed with warnings for volume ${volume.name} to repository ${repository.name}`);
+		} else {
+			logger.info(`Backup completed successfully for volume ${volume.name} to repository ${repository.name}`);
+		}
 
 		serverEvents.emit("backup:completed", {
 			scheduleId,
 			volumeName: volume.name,
 			repositoryName: repository.name,
-			status: "success",
+			status: exitCode === 0 ? "success" : "warning",
 		});
 
 		notificationsService
-			.sendBackupNotification(scheduleId, "success", {
+			.sendBackupNotification(scheduleId, exitCode === 0 ? "success" : "warning", {
 				volumeName: volume.name,
 				repositoryName: repository.name,
 			})

app/server/modules/events/events.controller.ts

@@ -41,7 +41,7 @@ export const eventsController = new Hono().get("/", (c) => {
 			scheduleId: number;
 			volumeName: string;
 			repositoryName: string;
-			status: "success" | "error" | "stopped";
+			status: "success" | "error" | "stopped" | "warning";
 		}) => {
 			stream.writeSSE({
 				data: JSON.stringify(data),

app/server/modules/notifications/notifications.service.ts

@@ -291,6 +291,7 @@ const sendBackupNotification = async (
 				case "success":
 					return assignment.notifyOnSuccess;
 				case "failure":
+				case "warning":
 					return assignment.notifyOnFailure;
 				default:
 					return false;
@@ -367,7 +368,7 @@ function buildNotificationMessage(
 
 		case "success":
 			return {
-				title: "✅ Backup Completed Successfully",
+				title: "✅ Backup Completed successfully",
 				body: [
 					`Volume: ${context.volumeName}`,
 					`Repository: ${context.repositoryName}`,
@@ -381,9 +382,26 @@ function buildNotificationMessage(
 					.join("\n"),
 			};
 
+		case "warning":
+			return {
+				title: "! Backup completed with warnings",
+				body: [
+					`Volume: ${context.volumeName}`,
+					`Repository: ${context.repositoryName}`,
+					context.duration ? `Duration: ${Math.round(context.duration / 1000)}s` : null,
+					context.filesProcessed !== undefined ? `Files: ${context.filesProcessed}` : null,
+					context.bytesProcessed ? `Size: ${context.bytesProcessed}` : null,
+					context.snapshotId ? `Snapshot: ${context.snapshotId}` : null,
+					context.error ? `Warning: ${context.error}` : null,
+					`Time: ${date} - ${time}`,
+				]
+					.filter(Boolean)
+					.join("\n"),
+			};
+
 		case "failure":
 			return {
-				title: "❌ Backup Failed",
+				title: "❌ Backup failed",
 				body: [
 					`Volume: ${context.volumeName}`,
 					`Repository: ${context.repositoryName}`,

app/server/utils/errors.ts

@@ -17,3 +17,25 @@ export const toMessage = (err: unknown): string => {
 	const message = err instanceof Error ? err.message : String(err);
 	return sanitizeSensitiveData(message);
 };
+
+const resticErrorCodes: Record<number, string> = {
+	1: "Command failed: An error occurred while executing the command.",
+	2: "Go runtime error: A runtime error occurred in the Go program.",
+	3: "Backup could not read all files: Some files could not be read during backup.",
+	10: "Repository not found: The specified repository could not be found.",
+	11: "Failed to lock repository: Unable to acquire a lock on the repository. Try to run doctor on the repository.",
+	12: "Wrong repository password: The provided password for the repository is incorrect.",
+	130: "Backup interrupted: The backup process was interrupted.",
+};
+
+export class ResticError extends Error {
+	code: number;
+
+	constructor(code: number, stderr: string) {
+		const message = resticErrorCodes[code] || `Unknown restic error with code ${code}`;
+		super(`${message}\n${stderr}`);
+
+		this.code = code;
+		this.name = "ResticError";
+	}
+}

app/server/utils/restic.ts

@@ -10,6 +10,7 @@ import { cryptoUtils } from "./crypto";
 import type { RetentionPolicy } from "../modules/backups/backups.dto";
 import { safeSpawn } from "./spawn";
 import type { CompressionMode, RepositoryConfig } from "~/schemas/restic";
+import { ResticError } from "./errors";
 
 const backupOutputSchema = type({
 	message_type: "'summary'",
@@ -313,34 +314,41 @@ const backup = async (
 				streamProgress(data);
 			}
 		},
-		onStderr: (error) => {
-			logger.error(error.trim());
-		},
 		finally: async () => {
 			includeFile && (await fs.unlink(includeFile).catch(() => {}));
 			await cleanupTemporaryKeys(config, env);
 		},
 	});
 
-	if (res.exitCode !== 0) {
-		logger.error(`Restic backup failed: ${res.stderr}`);
+	if (res.exitCode === 3) {
+		logger.error(`Restic backup encountered read errors: ${res.stderr.toString()}`);
+	}
+
+	if (res.exitCode !== 0 && res.exitCode !== 3) {
+		logger.error(`Restic backup failed: ${res.stderr.toString()}`);
 		logger.error(`Command executed: restic ${args.join(" ")}`);
 
-		throw new Error(`Restic backup failed: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	const lastLine = stdout.trim();
-	const resSummary = JSON.parse(lastLine ?? "{}");
+	let summaryLine = "";
+	try {
+		const resSummary = JSON.parse(lastLine ?? "{}");
+		summaryLine = resSummary;
+	} catch (_) {
+		logger.warn("Failed to parse restic backup output JSON summary.", lastLine);
+		summaryLine = "{}";
+	}
 
-	const result = backupOutputSchema(resSummary);
+	const result = backupOutputSchema(summaryLine);
 
 	if (result instanceof type.errors) {
 		logger.error(`Restic backup output validation failed: ${result}`);
-
-		throw new Error(`Restic backup output validation failed: ${result}`);
+		return { result: null, exitCode: res.exitCode };
 	}
 
-	return result;
+	return { result, exitCode: res.exitCode };
 };
 
 const restoreOutputSchema = type({
@@ -404,7 +412,7 @@ const restore = async (
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic restore failed: ${res.stderr}`);
-		throw new Error(`Restic restore failed: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	const stdout = res.text();
@@ -517,7 +525,7 @@ const forget = async (config: RepositoryConfig, options: RetentionPolicy, extra:
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic forget failed: ${res.stderr}`);
-		throw new Error(`Restic forget failed: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	return { success: true };
@@ -535,7 +543,7 @@ const deleteSnapshot = async (config: RepositoryConfig, snapshotId: string) => {
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic snapshot deletion failed: ${res.stderr}`);
-		throw new Error(`Failed to delete snapshot: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	return { success: true };
@@ -585,7 +593,7 @@ const ls = async (config: RepositoryConfig, snapshotId: string, path?: string) =
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic ls failed: ${res.stderr}`);
-		throw new Error(`Restic ls failed: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	// The output is a stream of JSON objects, first is snapshot info, rest are file/dir nodes
@@ -636,7 +644,7 @@ const unlock = async (config: RepositoryConfig) => {
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic unlock failed: ${res.stderr}`);
-		throw new Error(`Restic unlock failed: ${res.stderr}`);
+		throw new ResticError(res.exitCode, res.stderr.toString());
 	}
 
 	logger.info(`Restic unlock succeeded for repository: ${repoUrl}`);
@@ -697,7 +705,7 @@ const repairIndex = async (config: RepositoryConfig) => {
 
 	if (res.exitCode !== 0) {
 		logger.error(`Restic repair index failed: ${stderr}`);
-		throw new Error(`Restic repair index failed: ${stderr}`);
+		throw new ResticError(res.exitCode, stderr);
 	}
 
 	logger.info(`Restic repair index completed for repository: ${repoUrl}`);

app/server/utils/spawn.ts

@@ -41,9 +41,8 @@ export const safeSpawn = (params: Params) => {
 		child.stderr.on("data", (data) => {
 			if (callbacks.onStderr) {
 				callbacks.onStderr(data.toString());
-			} else {
-				stderrData += data.toString();
 			}
+			stderrData += data.toString();
 		});
 
 		child.on("error", async (error) => {