Skip to content

A modern, self-hosted backup solution for secure, encrypted backups across local and cloud storage.

feat: add dry run progress tracking

towfiqie9008b1aadec
diff --git a/backend/__tests__/managers/handlers/BackupHandler.test.ts b/backend/__tests__/managers/handlers/BackupHandler.test.ts
index dbeee33..976e4c0 100644
--- a/backend/__tests__/managers/handlers/BackupHandler.test.ts
+++ b/backend/__tests__/managers/handlers/BackupHandler.test.ts
@@ -585,12 +585,20 @@ describe('BackupHandler', () => {
mockRunResticCommand.mockResolvedValue(`line1\nline2\n${JSON.stringify(summary)}`);
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', baseOptions as any);
- const result = await handler['dryRunBackup']('plan-1', baseOptions, resticArgsAndEnv);
+ const result = await handler['dryRunBackup'](
+ 'plan-1',
+ 'backup-1',
+ baseOptions,
+ resticArgsAndEnv
+ );
expect(result).toEqual(summary);
expect(mockRunResticCommand).toHaveBeenCalledWith(
expect.arrayContaining(['--dry-run']),
- expect.any(Object)
+ expect.any(Object),
+ expect.any(Function),
+ expect.any(Function),
+ expect.any(Function)
);
});
@@ -599,7 +607,7 @@ describe('BackupHandler', () => {
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', baseOptions as any);
await expect(
- handler['dryRunBackup']('plan-1', baseOptions, resticArgsAndEnv)
+ handler['dryRunBackup']('plan-1', 'backup-1', baseOptions, resticArgsAndEnv)
).rejects.toThrow('Dry run failed');
});
@@ -609,11 +617,14 @@ describe('BackupHandler', () => {
const rescueOptions = { ...baseOptions, method: 'rescue' };
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', rescueOptions as any);
- await handler['dryRunBackup']('plan-1', rescueOptions, resticArgsAndEnv);
+ await handler['dryRunBackup']('plan-1', 'backup-1', rescueOptions, resticArgsAndEnv);
expect(mockRunResticCommand).toHaveBeenCalledWith(
expect.arrayContaining(['--one-file-system']),
- expect.any(Object)
+ expect.any(Object),
+ expect.any(Function),
+ expect.any(Function),
+ expect.any(Function)
);
});
});
@@ -1164,11 +1175,14 @@ describe('BackupHandler', () => {
mockRunResticCommand.mockResolvedValue(JSON.stringify(summary));
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', encryptedOptions as any);
- await handler['dryRunBackup']('plan-1', encryptedOptions, resticArgsAndEnv);
+ await handler['dryRunBackup']('plan-1', 'backup-1', encryptedOptions, resticArgsAndEnv);
expect(mockRunResticCommand).toHaveBeenCalledWith(
expect.any(Array),
- expect.objectContaining({ RESTIC_PASSWORD: 'test-encryption-key' })
+ expect.objectContaining({ RESTIC_PASSWORD: 'test-encryption-key' }),
+ expect.any(Function),
+ expect.any(Function),
+ expect.any(Function)
);
});
@@ -1177,11 +1191,14 @@ describe('BackupHandler', () => {
mockRunResticCommand.mockResolvedValue(JSON.stringify(summary));
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', baseOptions as any);
- await handler['dryRunBackup']('plan-1', baseOptions, resticArgsAndEnv);
+ await handler['dryRunBackup']('plan-1', 'backup-1', baseOptions, resticArgsAndEnv);
expect(mockRunResticCommand).toHaveBeenCalledWith(
expect.not.arrayContaining(['--one-file-system']),
- expect.any(Object)
+ expect.any(Object),
+ expect.any(Function),
+ expect.any(Function),
+ expect.any(Function)
);
});
@@ -1190,7 +1207,7 @@ describe('BackupHandler', () => {
const resticArgsAndEnv = handler.createResticBackupArgs('plan-1', baseOptions as any);
await expect(
- handler['dryRunBackup']('plan-1', baseOptions, resticArgsAndEnv)
+ handler['dryRunBackup']('plan-1', 'backup-1', baseOptions, resticArgsAndEnv)
).rejects.toThrow('Dry run failed');
});
});
diff --git a/backend/src/managers/ProgressManager.ts b/backend/src/managers/ProgressManager.ts
index a0eaddd..02fc4b9 100644
--- a/backend/src/managers/ProgressManager.ts
+++ b/backend/src/managers/ProgressManager.ts
@@ -177,7 +177,10 @@ export class ProgressManager {
let targetEvent: ProgressEvent | undefined;
for (let i = progress.events.length - 1; i >= 0; i--) {
const event = progress.events[i];
- if ((event.phase === 'backup' || event.phase === 'restore') && !event.completed) {
+ if (
+ (event.phase === 'backup' || event.phase === 'restore' || event.phase === 'pre-backup') &&
+ !event.completed
+ ) {
targetEvent = event;
break;
}
diff --git a/backend/src/managers/handlers/BackupHandler.ts b/backend/src/managers/handlers/BackupHandler.ts
index d9f6949..2e36efe 100644
--- a/backend/src/managers/handlers/BackupHandler.ts
+++ b/backend/src/managers/handlers/BackupHandler.ts
@@ -231,7 +231,7 @@ export class BackupHandler {
let dryRunSummary;
try {
- dryRunSummary = await this.dryRunBackup(planId, options, resticArgsAndEnv);
+ dryRunSummary = await this.dryRunBackup(planId, backupId, options, resticArgsAndEnv);
await this.updateProgress(
planId,
backupId,
@@ -643,6 +643,7 @@ export class BackupHandler {
*/
protected async dryRunBackup(
planId: string,
+ backupId: string,
options: Record<string, any>,
resticArgsAndEnv: ResticArgsAndEnv
): Promise<false | Record<string, any>> {
@@ -655,9 +656,16 @@ export class BackupHandler {
if (options.method === 'rescue') {
dryRunArgs.push('--one-file-system');
}
+ const handlers = this.createHandlers(planId, backupId);
try {
- const dryRunOutput = await runResticCommand(dryRunArgs, dryRunEnv);
- const outputLines = dryRunOutput.split('\n');
+ const dryRunOutput = await runResticCommand(
+ dryRunArgs,
+ dryRunEnv,
+ handlers.onProgress,
+ handlers.onError,
+ handlers.onComplete
+ );
+ const outputLines = dryRunOutput.split('\n').filter(line => line.trim() !== '');
const summaryLine = outputLines[outputLines.length - 1];
const dryRunSummary = JSON.parse(summaryLine);
return dryRunSummary;
diff --git a/backend/src/services/events/BackupEventService.ts b/backend/src/services/events/BackupEventService.ts
index fc31016..a805553 100644
--- a/backend/src/services/events/BackupEventService.ts
+++ b/backend/src/services/events/BackupEventService.ts
@@ -212,7 +212,7 @@ export class BackupEventService {
success: !!success,
ended: sql`(unixepoch())` as any,
completionStats: summaryData ? summaryData : null,
- ...(success ? { errorMsg: null } : {}),
+ ...(success ? { errorMsg: null } : {}),
};
const plan = await this.planStore.getById(planId);
diff --git a/frontend/src/components/Plan/BackupProgress/BackupProgress.module.scss b/frontend/src/components/Plan/BackupProgress/BackupProgress.module.scss
index 7d3d72d..2421521 100644
--- a/frontend/src/components/Plan/BackupProgress/BackupProgress.module.scss
+++ b/frontend/src/components/Plan/BackupProgress/BackupProgress.module.scss
@@ -116,6 +116,9 @@
color: #fff;
}
}
+ &.progressBarDryRun {
+ background-color: #b7cbf5;
+ }
}
}
}
diff --git a/frontend/src/components/Plan/BackupProgress/BackupProgress.tsx b/frontend/src/components/Plan/BackupProgress/BackupProgress.tsx
index 7f7843c..b97a937 100644
--- a/frontend/src/components/Plan/BackupProgress/BackupProgress.tsx
+++ b/frontend/src/components/Plan/BackupProgress/BackupProgress.tsx
@@ -37,11 +37,13 @@ const BackupProgress = ({ item, sourceId, sourceType, planId, type = 'backup' }:
const { data: progressData } =
type === 'backup' ? useGetBackupProgress({ id, sourceId, sourceType, planId }) : useGetRestoreProgress({ id, sourceId, sourceType, planId });
- console.log('#### data :', progressData);
-
const resticData = extractResticData(progressData);
const progressMessage = type === 'backup' ? generateBackupProgressMessage(progressData) : generateRestoreProgressMessage(progressData);
+ // Check if DryRun progress tracking phase
+ const actualBackupStarted = progressData?.events.find((e: any) => e.action === 'BACKUP_OPERATION_START' && e.resticData);
+ const isDryRun = type === 'backup' && !actualBackupStarted;
+
// Extract progress values from restic data or use defaults
const {
total_files_processed: total_files = resticData?.total_files || 0,
@@ -180,7 +182,7 @@ const BackupProgress = ({ item, sourceId, sourceType, planId, type = 'backup' }:
</div>
<div className={classes.progressBar}>
<div
- className={`${classes.progressBarFill} ${progressPercent > 3 ? classes.progressBarFilled : ''}`}
+ className={`${classes.progressBarFill} ${progressPercent > 3 ? classes.progressBarFilled : ''} ${isDryRun ? classes.progressBarDryRun : ''}`}
style={{ width: progressPercent + '%' }}
>
<span>{progressPercent}%</span>