From 86a4b3966504507afd6c3adbb6a1246cafd39d83 Mon Sep 17 00:00:00 2001 From: Mohamed Bassem Date: Sat, 29 Nov 2025 14:53:31 +0000 Subject: feat: Add automated bookmark backup feature (#2182) * feat: Add automated bookmark backup system Implements a comprehensive automated backup feature for user bookmarks with the following capabilities: Database Schema: - Add backupSettings table to store user backup preferences (enabled, frequency, retention) - Add backups table to track backup records with status and metadata - Add BACKUP asset type for storing compressed backup files - Add migration 0066_add_backup_tables.sql Background Workers: - Implement BackupSchedulingWorker cron job (runs daily at midnight UTC) - Create BackupWorker to process individual backup jobs - Deterministic scheduling spreads backup jobs across 24 hours based on user ID hash - Support for daily and weekly backup frequencies - Automated retention cleanup to delete old backups based on user settings Export & Compression: - Reuse existing export functionality for bookmark data - Compress exports using Node.js built-in zlib (gzip level 9) - Store compressed backups as assets with proper metadata - Track backup size and bookmark count for statistics tRPC API: - backups.getSettings - Retrieve user backup configuration - backups.updateSettings - Update backup preferences - backups.list - List all user backups with metadata - backups.get - Get specific backup details - backups.delete - Delete a backup - backups.download - Download backup file (base64 encoded) - backups.triggerBackup - Manually trigger backup creation UI Components: - BackupSettings component with configuration form - Enable/disable automatic backups toggle - Frequency selection (daily/weekly) - Retention period configuration (1-365 days) - Backup list table with download and delete actions - Manual backup trigger button - Display backup stats (size, bookmark count, status) - Added backups page to settings navigation Technical Details: - Uses Restate queue system for distributed job processing - Implements idempotency keys to prevent duplicate backups - Background worker concurrency: 2 jobs at a time - 10-minute timeout for large backup exports - Proper error handling and logging throughout - Type-safe implementation with Zod schemas * refactor: simplify backup settings and asset handling - Move backup settings from separate table to user table columns - Update BackupSettings model to use static methods with users table - Remove download mutation in favor of direct asset links - Implement proper quota checks using QuotaService.checkStorageQuota - Update UI to use new property names and direct asset downloads - Update shared types to match new schema Key changes: - backupSettingsTable removed, settings now in users table - Backup downloads use direct /api/assets/{id} links - Quota properly validated before creating backup assets - Cleaner separation of concerns in tRPC models * migration * use zip instead of gzip * fix drizzle * fix settings * streaming json * remove more dead code * add e2e tests * return backup * poll for backups * more fixes * more fixes * fix test * fix UI * fix delete asset * fix ui * redirect for backup download * cleanups * fix idempotency * fix tests * add ratelimit * add error handling for background backups * i18n * model changes --------- Co-authored-by: Claude --- packages/open-api/lib/backups.ts | 149 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 packages/open-api/lib/backups.ts (limited to 'packages/open-api/lib') diff --git a/packages/open-api/lib/backups.ts b/packages/open-api/lib/backups.ts new file mode 100644 index 00000000..0ad29057 --- /dev/null +++ b/packages/open-api/lib/backups.ts @@ -0,0 +1,149 @@ +import { + extendZodWithOpenApi, + OpenAPIRegistry, +} from "@asteasolutions/zod-to-openapi"; +import { z } from "zod"; + +import { zBackupSchema } from "@karakeep/shared/types/backups"; + +import { BearerAuth } from "./common"; +import { ErrorSchema } from "./errors"; + +export const registry = new OpenAPIRegistry(); +extendZodWithOpenApi(z); + +export const BackupIdSchema = registry.registerParameter( + "BackupId", + z.string().openapi({ + param: { + name: "backupId", + in: "path", + }, + example: "ieidlxygmwj87oxz5hxttoc8", + }), +); + +registry.registerPath({ + method: "get", + path: "/backups", + description: "Get all backups", + summary: "Get all backups", + tags: ["Backups"], + security: [{ [BearerAuth.name]: [] }], + responses: { + 200: { + description: "Object with all backups data.", + content: { + "application/json": { + schema: z.object({ + backups: z.array(zBackupSchema), + }), + }, + }, + }, + }, +}); + +registry.registerPath({ + method: "post", + path: "/backups", + description: "Trigger a new backup", + summary: "Trigger a new backup", + tags: ["Backups"], + security: [{ [BearerAuth.name]: [] }], + responses: { + 201: { + description: "Backup created successfully", + content: { + "application/json": { + schema: zBackupSchema, + }, + }, + }, + }, +}); + +registry.registerPath({ + method: "get", + path: "/backups/{backupId}", + description: "Get backup by its id", + summary: "Get a single backup", + tags: ["Backups"], + security: [{ [BearerAuth.name]: [] }], + request: { + params: z.object({ backupId: BackupIdSchema }), + }, + responses: { + 200: { + description: "Object with backup data.", + content: { + "application/json": { + schema: zBackupSchema, + }, + }, + }, + 404: { + description: "Backup not found", + content: { + "application/json": { + schema: ErrorSchema, + }, + }, + }, + }, +}); + +registry.registerPath({ + method: "get", + path: "/backups/{backupId}/download", + description: "Download backup file", + summary: "Download a backup", + tags: ["Backups"], + security: [{ [BearerAuth.name]: [] }], + request: { + params: z.object({ backupId: BackupIdSchema }), + }, + responses: { + 200: { + description: "Backup file (zip archive)", + content: { + "application/zip": { + schema: z.instanceof(Blob), + }, + }, + }, + 404: { + description: "Backup not found", + content: { + "application/json": { + schema: ErrorSchema, + }, + }, + }, + }, +}); + +registry.registerPath({ + method: "delete", + path: "/backups/{backupId}", + description: "Delete backup by its id", + summary: "Delete a backup", + tags: ["Backups"], + security: [{ [BearerAuth.name]: [] }], + request: { + params: z.object({ backupId: BackupIdSchema }), + }, + responses: { + 204: { + description: "No content - the backup was deleted", + }, + 404: { + description: "Backup not found", + content: { + "application/json": { + schema: ErrorSchema, + }, + }, + }, + }, +}); -- cgit v1.2.3-70-g09d2