feat(cloud-sync): add selective backup and restore

This commit is contained in:
_Mr丶s ゛😁® authored and GitHub committed 2026-09-28 21:23:15 +08:00
1 parent e432304dbc
commit a75d343666
23 files changed
+2427 -216

No files matched your search

@@ -74,6 +74,49 @@ describe("WebDAV sync HTTP API", () => {
});
});
it("requests a selectable catalog and sends the selected snapshot items", async () => {
const fetchMock = stubFetch({ connections: [{ id: "db-1", label: "Production" }] });
const { cloudSyncLocalCatalog, webdavSyncInspect, webdavSyncUpload, webdavSyncDownload } = await import("@/lib/backend/http");
const editorSettings = { theme: "dark" };
const catalog = await cloudSyncLocalCatalog(editorSettings);
expect(catalog.connections).toEqual([{ id: "db-1", label: "Production" }]);
expect(lastCall(fetchMock)).toEqual({ url: "/api/cloud-sync/catalog/local", body: { editorSettings } });
await webdavSyncInspect(config, "sync-password");
expect(lastCall(fetchMock)).toEqual({
url: "/api/cloud-sync/webdav/inspect",
body: { config, secretsPassphrase: "sync-password" },
});
const selection = {
connections: ["db-1"],
connectionSecrets: ["db-1"],
tunnelProfiles: [],
tunnelSecrets: [],
savedSqlFolders: [],
savedSqlFiles: [],
desktopSettings: ["iconTheme"],
editorSettings: ["theme"],
aiConfigs: [],
pluginUiStorage: [],
sidebarLayout: false,
pinnedTreeNodeIds: false,
includeSecrets: true,
syncCredentials: false,
};
await webdavSyncUpload(config, editorSettings, "sync-password", true, selection);
expect(lastCall(fetchMock)).toEqual({
url: "/api/cloud-sync/webdav/upload",
body: { config, editorSettings, secretsPassphrase: "sync-password", includeSecrets: true, selection },
});
await webdavSyncDownload(config, "sync-password", true, selection);
expect(lastCall(fetchMock)).toEqual({
url: "/api/cloud-sync/webdav/download",
body: { config, secretsPassphrase: "sync-password", restoreSecrets: true, selection },
});
});
it("accepts the migration cleanup endpoint's empty 204 response", async () => {
const fetchMock = vi.fn().mockResolvedValue(new Response(null, { status: 204 }));
vi.stubGlobal("fetch", fetchMock);
+7
View File
@@ -420,6 +420,8 @@ export const forgetWebdavSavedPassword = forward("forgetWebdavSavedPassword");
export const webdavSyncSecretsStatus = forward("webdavSyncSecretsStatus");
export const saveWebdavSyncSecretsPreference = forward("saveWebdavSyncSecretsPreference");
export const forgetWebdavSyncSecretsPassphrase = forward("forgetWebdavSyncSecretsPassphrase");
export const cloudSyncLocalCatalog = forward("cloudSyncLocalCatalog");
export const webdavSyncInspect = forward("webdavSyncInspect");
export const webdavSyncUpload = forward("webdavSyncUpload");
export const webdavSyncDownload = forward("webdavSyncDownload");
export const snippetSyncTest = forward("snippetSyncTest");
@@ -427,6 +429,7 @@ export const snippetTokenStatus = forward("snippetTokenStatus");
export const saveSnippetSavedToken = forward("saveSnippetSavedToken");
export const forgetSnippetSavedToken = forward("forgetSnippetSavedToken");
export const snippetSyncSettings = forward("snippetSyncSettings");
export const snippetSyncInspect = forward("snippetSyncInspect");
export const saveSnippetSyncId = forward("saveSnippetSyncId");
export const retrySnippetLegacyCleanup = forward("retrySnippetLegacyCleanup");
export const snippetSyncUpload = forward("snippetSyncUpload");
@@ -996,6 +999,10 @@ export type {
WebDavConfig,
WebDavPasswordStatus,
WebDavSyncSummary,
SyncCatalogItem,
PluginUiStorageItemRef,
SyncSelection,
SyncSnapshotCatalog,
WebDavDownloadResult,
SnippetProvider,
SnippetSyncConfig,
+23 -5
View File
@@ -2,6 +2,7 @@ import type { MongoDumpFormat, MongoDumpSourceInput, MongoDumpCatalog, MongoRest
import type { MongoRestoreUpload, MongoSourceReadOptions } from "./mongodbDumpTypes";
import type { UserSkillRootSettings, UserSkillsListResult, UserSkillsReadResult } from "@/types/userSkills";
import type { DatabaseBackupCommand, DatabaseBackupBackgroundStatus } from "@/lib/backup/backgroundDatabaseBackup";
import type { PluginUiStorageItemRef, SyncCatalogItem, SyncSelection, SyncSnapshotCatalog } from "@/lib/backend/tauri";
export function databaseBackupCommand<T = unknown>(command: DatabaseBackupCommand): Promise<T> {
return post("/api/database-backups", command);
@@ -2443,6 +2444,8 @@ export interface WebDavSyncSummary {
appVersion?: string;
}
export type { PluginUiStorageItemRef, SyncCatalogItem, SyncSelection, SyncSnapshotCatalog };
export interface WebDavDownloadResult {
summary: WebDavSyncSummary;
editorSettings?: unknown;
@@ -2528,17 +2531,26 @@ export async function forgetWebdavSyncSecretsPassphrase(): Promise<void> {
return post("/api/cloud-sync/webdav/forget-sync-secrets-passphrase", {});
}
export async function webdavSyncUpload(config: WebDavConfig, editorSettings?: unknown, secretsPassphrase?: string, includeSecrets = false): Promise<WebDavSyncSummary> {
export async function cloudSyncLocalCatalog(editorSettings?: unknown): Promise<SyncSnapshotCatalog> {
return post("/api/cloud-sync/catalog/local", { editorSettings });
}
export async function webdavSyncInspect(config: WebDavConfig, secretsPassphrase?: string): Promise<SyncSnapshotCatalog> {
return post("/api/cloud-sync/webdav/inspect", { config, secretsPassphrase });
}
export async function webdavSyncUpload(config: WebDavConfig, editorSettings?: unknown, secretsPassphrase?: string, includeSecrets = false, selection?: SyncSelection): Promise<WebDavSyncSummary> {
return post("/api/cloud-sync/webdav/upload", {
config,
editorSettings,
secretsPassphrase,
includeSecrets,
selection,
});
}
export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase?: string, restoreSecrets = true): Promise<WebDavDownloadResult> {
return post("/api/cloud-sync/webdav/download", { config, secretsPassphrase, restoreSecrets });
export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase?: string, restoreSecrets = true, selection?: SyncSelection): Promise<WebDavDownloadResult> {
return post("/api/cloud-sync/webdav/download", { config, secretsPassphrase, restoreSecrets, selection });
}
export async function snippetSyncTest(config: SnippetSyncConfig): Promise<void> {
@@ -2569,22 +2581,28 @@ export async function retrySnippetLegacyCleanup(config: SnippetSyncConfig): Prom
return post("/api/cloud-sync/snippet/retry-legacy-cleanup", { config });
}
export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, snippetPassphrase?: string, includeSecrets = false, secretsPassphrase?: string): Promise<SnippetSyncSummary> {
export async function snippetSyncInspect(config: SnippetSyncConfig, snippetPassphrase?: string, secretsPassphrase?: string): Promise<SyncSnapshotCatalog> {
return post("/api/cloud-sync/snippet/inspect", { config, snippetPassphrase, secretsPassphrase });
}
export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, snippetPassphrase?: string, includeSecrets = false, secretsPassphrase?: string, selection?: SyncSelection): Promise<SnippetSyncSummary> {
return post("/api/cloud-sync/snippet/upload", {
config,
editorSettings,
snippetPassphrase,
includeSecrets,
secretsPassphrase,
selection,
});
}
export async function snippetSyncDownload(config: SnippetSyncConfig, snippetPassphrase?: string, restoreSecrets = false, secretsPassphrase?: string): Promise<SnippetDownloadResult> {
export async function snippetSyncDownload(config: SnippetSyncConfig, snippetPassphrase?: string, restoreSecrets = false, secretsPassphrase?: string, selection?: SyncSelection): Promise<SnippetDownloadResult> {
return post("/api/cloud-sync/snippet/download", {
config,
snippetPassphrase,
restoreSecrets,
secretsPassphrase,
selection,
});
}
+69 -6
View File
@@ -389,6 +389,55 @@ export interface WebDavSyncSummary {
appVersion?: string;
}
export interface SyncCatalogItem {
id: string;
label: string;
}
export interface PluginUiStorageItemRef {
pluginId: string;
key: string;
pluginName?: string;
}
export interface SyncSelection {
connections?: string[];
connectionSecrets?: string[];
tunnelProfiles?: string[];
tunnelSecrets?: string[];
savedSqlFolders?: string[];
savedSqlFiles?: string[];
desktopSettings?: string[];
editorSettings?: string[];
aiConfigs?: string[];
pluginUiStorage?: PluginUiStorageItemRef[];
sidebarLayout?: boolean;
pinnedTreeNodeIds?: boolean;
includeSecrets: boolean;
syncCredentials: boolean;
}
export interface SyncSnapshotCatalog {
exportedAt: string;
appVersion: string;
hasEncryptedSecrets: boolean;
connections: SyncCatalogItem[];
connectionSecrets: string[];
tunnelProfiles: SyncCatalogItem[];
tunnelSecrets: string[];
savedSqlFolders: SyncCatalogItem[];
savedSqlFiles: SyncCatalogItem[];
desktopSettings: SyncCatalogItem[];
editorSettings: SyncCatalogItem[];
aiConfigs: SyncCatalogItem[];
aiConfigsLocked: boolean;
pluginUiStorage: PluginUiStorageItemRef[];
pluginUiStorageLocked: boolean;
hasSidebarLayout: boolean;
hasPinnedTreeNodeIds: boolean;
selection?: SyncSelection;
}
export interface WebDavDownloadResult {
summary: WebDavSyncSummary;
editorSettings?: unknown;
@@ -1061,17 +1110,26 @@ export async function forgetWebdavSyncSecretsPassphrase(): Promise<void> {
return invoke("forget_webdav_sync_secrets_passphrase");
}
export async function webdavSyncUpload(config: WebDavConfig, editorSettings?: unknown, secretsPassphrase?: string, includeSecrets = false): Promise<WebDavSyncSummary> {
export async function cloudSyncLocalCatalog(editorSettings?: unknown): Promise<SyncSnapshotCatalog> {
return invoke("cloud_sync_local_catalog", { editorSettings });
}
export async function webdavSyncInspect(config: WebDavConfig, secretsPassphrase?: string): Promise<SyncSnapshotCatalog> {
return invoke("webdav_sync_inspect", { config, secretsPassphrase });
}
export async function webdavSyncUpload(config: WebDavConfig, editorSettings?: unknown, secretsPassphrase?: string, includeSecrets = false, selection?: SyncSelection): Promise<WebDavSyncSummary> {
return invoke("webdav_sync_upload", {
config,
editorSettings,
secretsPassphrase,
includeSecrets,
selection,
});
}
export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase?: string, restoreSecrets = true): Promise<WebDavDownloadResult> {
return invoke("webdav_sync_download", { config, secretsPassphrase, restoreSecrets });
export async function webdavSyncDownload(config: WebDavConfig, secretsPassphrase?: string, restoreSecrets = true, selection?: SyncSelection): Promise<WebDavDownloadResult> {
return invoke("webdav_sync_download", { config, secretsPassphrase, restoreSecrets, selection });
}
export async function snippetSyncTest(config: SnippetSyncConfig): Promise<void> {
@@ -1102,18 +1160,23 @@ export async function retrySnippetLegacyCleanup(config: SnippetSyncConfig): Prom
return invoke("retry_snippet_legacy_cleanup", { config });
}
export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, snippetPassphrase?: string, includeSecrets = false, secretsPassphrase?: string): Promise<SnippetSyncSummary> {
export async function snippetSyncInspect(config: SnippetSyncConfig, snippetPassphrase?: string, secretsPassphrase?: string): Promise<SyncSnapshotCatalog> {
return invoke("snippet_sync_inspect", { config, snippetPassphrase, secretsPassphrase });
}
export async function snippetSyncUpload(config: SnippetSyncConfig, editorSettings?: unknown, snippetPassphrase?: string, includeSecrets = false, secretsPassphrase?: string, selection?: SyncSelection): Promise<SnippetSyncSummary> {
return invoke("snippet_sync_upload", {
config,
editorSettings,
snippetPassphrase,
includeSecrets,
secretsPassphrase,
selection,
});
}
export async function snippetSyncDownload(config: SnippetSyncConfig, snippetPassphrase?: string, restoreSecrets = false, secretsPassphrase?: string): Promise<SnippetDownloadResult> {
return invoke("snippet_sync_download", { config, snippetPassphrase, restoreSecrets, secretsPassphrase });
export async function snippetSyncDownload(config: SnippetSyncConfig, snippetPassphrase?: string, restoreSecrets = false, secretsPassphrase?: string, selection?: SyncSelection): Promise<SnippetDownloadResult> {
return invoke("snippet_sync_download", { config, snippetPassphrase, restoreSecrets, secretsPassphrase, selection });
}
export async function loadPinnedTreeNodeIds(): Promise<string[]> {
@@ -1,7 +1,8 @@
import type { WebDavConfig } from "@/lib/backend/api";
import type { SyncSelection, WebDavConfig } from "@/lib/backend/api";
import { safeLocalStorageGet, safeLocalStorageSet } from "@/lib/backend/safeStorage";
export const WEB_DAV_AUTO_UPLOAD_STORAGE_KEYS = ["dbx-webdav-endpoint", "dbx-webdav-username", "dbx-webdav-remote-path", "dbx-webdav-auto-upload-enabled", "dbx-webdav-auto-upload-interval-minutes"] as const;
export const WEB_DAV_BACKUP_SELECTION_STORAGE_KEY = "dbx-webdav-backup-selection";
export const WEB_DAV_AUTO_UPLOAD_STORAGE_KEYS = ["dbx-webdav-endpoint", "dbx-webdav-username", "dbx-webdav-remote-path", "dbx-webdav-auto-upload-enabled", "dbx-webdav-auto-upload-interval-minutes", WEB_DAV_BACKUP_SELECTION_STORAGE_KEY] as const;
export const DEFAULT_WEB_DAV_REMOTE_PATH = "DBX/sync/snapshot.json";
export const DEFAULT_WEB_DAV_AUTO_UPLOAD_INTERVAL_MINUTES = 30;
@@ -43,3 +44,20 @@ export function writeWebDavAutoUploadFields(config: WebDavConfig, autoUpload: {
safeLocalStorageSet("dbx-webdav-auto-upload-enabled", String(autoUpload.enabled));
safeLocalStorageSet("dbx-webdav-auto-upload-interval-minutes", String(normalizedWebDavAutoUploadInterval(autoUpload.intervalMinutes)));
}
export function readWebDavBackupSelection(): SyncSelection | undefined {
const serialized = safeLocalStorageGet(WEB_DAV_BACKUP_SELECTION_STORAGE_KEY);
if (!serialized) return undefined;
try {
const selection = JSON.parse(serialized) as SyncSelection;
if (typeof selection !== "object" || selection === null || typeof selection.includeSecrets !== "boolean") return undefined;
return selection;
} catch {
return undefined;
}
}
export function writeWebDavBackupSelection(selection: SyncSelection) {
safeLocalStorageSet(WEB_DAV_BACKUP_SELECTION_STORAGE_KEY, JSON.stringify(selection));
if (typeof window !== "undefined") window.dispatchEvent(new Event("dbx:webdav-auto-upload-config-changed"));
}