feat: add MongoDB full instance backup and restore by Prathamesh-chougale-17 · Pull Request #152 · Skyfay/DBackup

Prathamesh-chougale-17 · 2026-08-20T05:15:30Z

Summary

add a backward-compatible MongoDB Backup Scope setting with Selected Databases as the default
create Full Instance backups with one native mongodump archive containing all databases, users, and custom roles
restore Full Instance archives through metadata-verified, fail-closed handling without database mapping or renaming
document destructive restore behavior, credential continuity, permissions, and replica-set consistency limits
preserve existing jobs and backup files as Selected Databases

Validation

TypeScript: node --max-old-space-size=4096 node_modules/typescript/bin/tsc --noEmit
focused MongoDB adapter, runner, job API, analyzer, and restore tests: 164 passed
one unrelated existing Windows-only SQLite path assertion expects POSIX separators; feature-specific restore tests pass

Copilot

Pull request overview

Adds MongoDB Full Instance backup and restore support across the runner, adapters, API routes, UI, Prisma schema, and documentation - introducing a backward-compatible backupScope concept defaulting to Selected Databases.

Changes:

Add MongoDB backupScope (Selected Databases vs Full Instance) with DB schema + job validation and UI controls.
Implement Full Instance dump/restore behavior using native mongodump/mongorestore archive handling with sidecar-driven safety gates.
Extend analyze/restore APIs and broaden unit test coverage around scope behavior and error handling.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/unit/services/restore-pipeline.test.ts	Adds restore pipeline tests ensuring Full Instance restores ignore mapping and fail closed when metadata is missing or mismatched.
tests/unit/services/job-service.test.ts	Updates job creation expectations to include default `backupScope`.
tests/unit/runner/steps/02-dump.test.ts	Adds test ensuring stale DB selections are ignored for Full Instance metadata generation.
tests/unit/lib/storage-analyze-route.test.ts	Adds test to detect Full Instance MongoDB backups via metadata sidecar.
tests/unit/lib/jobs-route-errors.test.ts	Adds API route tests verifying ValidationError handling and preserving 409 duplicate-name behavior.
tests/unit/adapters/database/mongodb/restore.test.ts	Adds restore tests for Full Instance (no namespace filters) and privileged credentials usage.
tests/unit/adapters/database/mongodb/dump.test.ts	Adds dump tests for Full Instance single-archive behavior and legacy URI path stripping.
tests/unit/adapters/database/mongodb/args.test.ts	Adds unit tests for `buildFullInstanceConnectionArgs` URI rewriting rules.
src/services/restore/types.ts	Extends restore input to include optional MongoDB `backupScope` hint from analyzer/UI.
src/services/restore/pipeline.ts	Enforces sidecar verification for Full Instance restores and disables mapping/renaming for confirmed Full Instance archives.
src/services/jobs/job-service.ts	Persists `backupScope` on jobs and validates Full Instance constraints (MongoDB-only, no directory sources).
src/lib/runner/steps/03-upload.ts	Writes MongoDB `backupScope` into backup metadata sidecar during upload.
src/lib/runner/steps/02-dump.ts	Threads job `backupScope` into MongoDB dump config and clears DB selection for Full Instance dumps.
src/lib/core/mongodb-backup-scope.ts	Introduces MongoDB backup scope enum + normalization helper.
src/lib/core/interfaces.ts	Extends `BackupMetadata` to optionally include MongoDB `backupScope`.
src/lib/adapters/database/mongodb/restore.ts	Adds `backupScope` handling, improves credential selection for command args, and uses AdapterError on failures.
src/lib/adapters/database/mongodb/dump.ts	Implements Full Instance dump path using native `mongodump --archive` with validation for empty output.
src/lib/adapters/database/mongodb/args.ts	Adds URI rewriting helper to remove path DB while preserving authSource semantics for Full Instance dumps.
src/components/dashboard/jobs/job-form.tsx	Adds MongoDB Backup Scope selector, validation, and hides DB picker for Full Instance.
src/app/dashboard/storage/restore/restore-client.tsx	Plumbs analyzed `backupScope` into restore requests and disables mapping/renaming UI for Full Instance restores with stronger warnings.
src/app/api/storage/[id]/restore/route.ts	Parses and validates MongoDB `backupScope` in restore requests.
src/app/api/storage/[id]/analyze/route.ts	Surfaces `backupScope: FULL_INSTANCE` from metadata sidecar to drive restore UI behavior.
src/app/api/jobs/route.ts	Validates `backupScope` on create and maps service-layer ValidationError to 400.
src/app/api/jobs/[id]/route.ts	Validates optional `backupScope` on update and maps service-layer ValidationError to 400.
prisma/schema.prisma	Adds `backupScope` column to Job model with default `SELECTED_DATABASES`.
prisma/migrations/20260819090000_add_mongodb_backup_scope/migration.sql	Adds the Job `backupScope` column in SQLite.
docs/user-guide/sources/mongodb.md	Documents new scopes, Full Instance behavior, and destructive restore safety considerations.
docs/changelog.md	Adds vNEXT entry for MongoDB Full Instance backup/restore feature.

Suppressed comments (1)

src/services/restore/pipeline.ts:462

This decompression guard runs for any truthy compressionMeta, including 'NONE', which unnecessarily sets the stage to DECOMPRESSING and logs a decompression step even though getDecompressionStream('NONE') returns null. Guard against 'NONE' here as well to keep stages/logs accurate even if future code paths set compressionMeta to 'NONE'.

        if (compressionMeta) {

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+                if (!seekableArchive && metadata.compression) {
                    compressionMeta = metadata.compression;
                    log(`Detected ${compressionMeta} compression.`, 'info');
                }


Copilot

Pull request overview

Copilot reviewed 32 out of 33 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

pnpm-lock.yaml: Generated file

Suppressed comments (1)

Dockerfile:335

The Docker build check that imports server external packages does not await Promise.all(...), so Node can exit before any import() runs. This can silently skip the verification that the standalone output contains the required dependencies.

RUN node --check custom-server.js && \
    prisma --version && \
    node -e 'Promise.all(["@aws-sdk/lib-storage", "@microsoft/microsoft-graph-client", "dockerode", "dropbox", "googleapis", "mssql", "ssh2", "ssh2-sftp-client"].map(async (dependency) => { try { await import(dependency); console.log(`${dependency}: available`) } catch (error) { console.error(`${dependency}: ${error.code ?? error.message}`); process.exitCode = 1 } }))' && \
    node -e 'require("@prisma/client"); require("sharp")' && \

+                const metadata = JSON.parse(metaContent) as BackupMetadata;
+                const parsedMetadataScope = MongoDBBackupScopeSchema.safeParse(metadata.backupScope);
+                const metadataScope = parsedMetadataScope.success
+                    ? parsedMetadataScope.data
+                    : "SELECTED_DATABASES";
+
+                if (fullInstanceExpected && metadataScope !== "FULL_INSTANCE") {
+                    throw new RestoreError(
+                        "The selected file is not confirmed as a MongoDB Full Instance backup. The restore was stopped before changing the target.",
+                        { executionId, sourcePath: file },
+                    );
+                }
+                backupScope = metadataScope === "FULL_INSTANCE" ? "FULL_INSTANCE" : undefined;



Copilot

Pull request overview

Copilot reviewed 32 out of 33 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

pnpm-lock.yaml: Generated file

Suppressed comments (2)

src/services/jobs/job-service.ts:367

In updateJob, destination validation currently only runs when sourceId or sources are included. A request that updates destinations only will skip validateJobDestinations, allowing invalid or empty destination updates to bypass server-side validation.

        if (sourceId !== undefined || sources !== undefined) {
            await this.validateJobSources(id, sourceId !== undefined ? (sourceId || null) : undefined, sources);
            await this.validateJobDestinations(destinations);
        }
        if (sourceId !== undefined || sources !== undefined || backupScope !== undefined) {

Dockerfile:335

This Docker build check starts an async Promise.all without awaiting it. Node may exit before the imports resolve, so missing dependencies might not fail the image build as intended.

RUN node --check custom-server.js && \
    prisma --version && \
    node -e 'Promise.all(["@aws-sdk/lib-storage", "@microsoft/microsoft-graph-client", "dockerode", "dropbox", "googleapis", "mssql", "ssh2", "ssh2-sftp-client"].map(async (dependency) => { try { await import(dependency); console.log(`${dependency}: available`) } catch (error) { console.error(`${dependency}: ${error.code ?? error.message}`); process.exitCode = 1 } }))' && \
    node -e 'require("@prisma/client"); require("sharp")' && \

        let seekableArchive = false;
+        let backupScope: BackupMetadata['backupScope'] = undefined;

+        const tempMetaPath = path.join(getTempDir(), "meta_" + Date.now() + ".json");


Prathamesh-chougale-17 added 3 commits August 19, 2026 19:35

Add MongoDB full instance backup and restore support

0744229

fix: harden MongoDB full instance workflows

6b44a50

docs: link MongoDB full instance pull request

0c21969

Prathamesh-chougale-17 marked this pull request as ready for review August 20, 2026 05:16

Copilot AI lite review requested due to automatic review settings August 20, 2026 05:16

Copilot started reviewing on behalf of Prathamesh-chougale-17 August 20, 2026 05:17 View session

Copilot AI reviewed Aug 20, 2026

View reviewed changes

Comment thread src/services/restore/pipeline.ts Outdated

Comment on lines 232 to 235

if (!seekableArchive && metadata.compression) {

compressionMeta = metadata.compression;

log(`Detected ${compressionMeta} compression.`, 'info');

}

Harden Docker builds and handle uncompressed restores

3134ebd

Prathamesh-chougale-17 requested a lite review from Copilot August 20, 2026 20:24

Copilot AI reviewed Aug 20, 2026

View reviewed changes

Fail closed on unconfirmed Full Instance restore metadata

9340548

Prathamesh-chougale-17 requested a lite review from Copilot August 20, 2026 20:46

Copilot AI reviewed Aug 20, 2026

View reviewed changes

Comment thread src/services/restore/pipeline.ts

let seekableArchive = false;

let backupScope: BackupMetadata['backupScope'] = undefined;

const tempMetaPath = path.join(getTempDir(), "meta_" + Date.now() + ".json");

Copilot started reviewing on behalf of Prathamesh-chougale-17 August 20, 2026 23:27 View session

Copilot started reviewing on behalf of Prathamesh-chougale-17 August 20, 2026 23:42 View session

Navigation Menu

feat: add MongoDB full instance backup and restore - #152

feat: add MongoDB full instance backup and restore#152
Prathamesh-chougale-17 wants to merge 5 commits into
Skyfay:mainfrom
Prathamesh-chougale-17:main

Prathamesh-chougale-17 commented Aug 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Prathamesh-chougale-17 commented Aug 20, 2026

Summary

Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants