π The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.
Vue dockergolangkanbanknowledge-baseknowledge-managementmarkdownnote-takingnotesnotes-appnotionnuxtnuxtjsoffline-firstoidcpwaselfhostedssovuevuejswiki
feat: add user settings inclusion to backup options and update related services
Smaug6739c4084261f526
diff --git a/backend/controllers/backup.controller.go b/backend/controllers/backup.controller.goindex 6c719a36..224e3093 100644--- a/backend/controllers/backup.controller.go+++ b/backend/controllers/backup.controller.go@@ -24,14 +24,6 @@ func NewBackupController(app *app.App) BackupController {}}-// CreateBackupRequest represents the request body for creating a backup-type CreateBackupRequest struct {- IncludeDocuments *bool `json:"include_documents"` // Include documents/notes content- IncludeFiles *bool `json:"include_files"` // Include uploaded files- IncludeMetadata *bool `json:"include_metadata"` // Include node metadata- LocalData any `json:"local_data"` // Include data stored by the client to the archive-}-// CreateBackup starts an asynchronous backup job// @Method POST// @Description Start a new backup job with specified options. Returns a job ID for tracking progress.@@ -43,18 +35,17 @@ func (ctr *Controller) CreateBackup(c *gin.Context) (int, any) {}// Parse request body for options- var req CreateBackupRequest+ var req types.BackupOptionsif err := c.ShouldBindJSON(&req); err != nil {// If no body provided, use default options- req = CreateBackupRequest{}+ req = types.BackupOptions{}}- // Build options from request (default to true if not specified)options := types.BackupOptions{- IncludeDocuments: req.IncludeDocuments == nil || *req.IncludeDocuments,- IncludeFiles: req.IncludeFiles == nil || *req.IncludeFiles,- IncludeMetadata: req.IncludeMetadata == nil || *req.IncludeMetadata,- LocalData: req.LocalData,+ IncludeDocuments: req.IncludeDocuments,+ IncludeFiles: req.IncludeFiles,+ IncludeMetadata: req.IncludeMetadata,+ IncludeSettings: req.IncludeSettings,}// Start async backupdiff --git a/backend/services/backup.service.go b/backend/services/backup.service.goindex f0c13e73..e4d6dffa 100644--- a/backend/services/backup.service.go+++ b/backend/services/backup.service.go@@ -22,7 +22,7 @@ import ()const (- backupVersion = "1.0.0"+ backupVersion = "1.1.0"backupExpiryHours = 24 // Backup files expire after 24 hoursmaxConcurrentFiles = 5 // Max concurrent file downloads for backup)@@ -40,20 +40,22 @@ type BackupService interface {}type backupService struct {- nodeRepo repositories.NodeRepository- jobs map[string]*types.BackupJob- userJobs map[types.Snowflake]string // Maps userId to current jobId- jobMutex sync.RWMutex- cancel map[string]context.CancelFunc+ nodeRepo repositories.NodeRepository+ userSettingsRepo repositories.UserSettingsRepository+ jobs map[string]*types.BackupJob+ userJobs map[types.Snowflake]string // Maps userId to current jobId+ jobMutex sync.RWMutex+ cancel map[string]context.CancelFunc}// NewBackupService creates a new backup service instance-func NewBackupService(nodeRepo repositories.NodeRepository) BackupService {+func NewBackupService(nodeRepo repositories.NodeRepository, userSettingsRepo repositories.UserSettingsRepository) BackupService {return &backupService{- nodeRepo: nodeRepo,- jobs: make(map[string]*types.BackupJob),- userJobs: make(map[types.Snowflake]string),- cancel: make(map[string]context.CancelFunc),+ nodeRepo: nodeRepo,+ userSettingsRepo: userSettingsRepo,+ jobs: make(map[string]*types.BackupJob),+ userJobs: make(map[types.Snowflake]string),+ cancel: make(map[string]context.CancelFunc),}}@@ -295,10 +297,18 @@ func (s *backupService) processBackup(ctx context.Context, job *types.BackupJob,default:}- if job.Options.LocalData != nil {- s.updateJobStatus(job, types.BackupStatusProcessing, 80, "Adding local data...", "")- if err := s.addJSONToZip(zipWriter, "local_data.json", job.Options.LocalData); err != nil {- s.updateJobStatus(job, types.BackupStatusFailed, 0, "", fmt.Sprintf("Failed to add local data: %v", err))+ // Fetch user settings if requested+ if job.Options.IncludeSettings {+ s.updateJobStatus(job, types.BackupStatusProcessing, 75, "Fetching user settings...", "")++ settings, err := s.userSettingsRepo.GetByUserID(job.UserID)+ if err != nil {+ s.updateJobStatus(job, types.BackupStatusFailed, 0, "", fmt.Sprintf("Failed to fetch user settings: %v", err))+ return+ }++ if err := s.addJSONToZip(zipWriter, "user_settings.json", settings); err != nil {+ s.updateJobStatus(job, types.BackupStatusFailed, 0, "", fmt.Sprintf("Failed to add user settings: %v", err))return}}@@ -321,6 +331,7 @@ func (s *backupService) processBackup(ctx context.Context, job *types.BackupJob,IncludeDocuments: job.Options.IncludeDocuments,IncludeFiles: job.Options.IncludeFiles,IncludeMetadata: job.Options.IncludeMetadata,+ IncludeSettings: job.Options.IncludeSettings,},Statistics: stats,}diff --git a/backend/services/manager.go b/backend/services/manager.goindex d52b192b..7c2ca940 100644--- a/backend/services/manager.go+++ b/backend/services/manager.go@@ -61,7 +61,7 @@ func (sm *ServiceManager) initializeServices(repos *repositories.RepositoryManagsm.Resource = NewResourceService(repos.Node, snowflake, minioClient, resourceConfig)// Initialize Backup Service- sm.Backup = NewBackupService(repos.Node)+ sm.Backup = NewBackupService(repos.Node, repos.UserSettings)// Initialize OIDC Servicesm.OIDC = NewOIDCService(repos.OIDCProvider, repos.User, sm.User, repos.Session, repos.Log, snowflake)diff --git a/backend/types/backup.go b/backend/types/backup.goindex eac31c4e..dac4f157 100644--- a/backend/types/backup.go+++ b/backend/types/backup.go@@ -20,16 +20,7 @@ type BackupOptions struct {IncludeDocuments bool `json:"include_documents"` // Include documents/notes contentIncludeFiles bool `json:"include_files"` // Include uploaded files (images, PDFs, etc.)IncludeMetadata bool `json:"include_metadata"` // Include node metadata- LocalData any `json:"local_data"` // Include data stored by the client to the archive-}--// DefaultBackupOptions returns the default backup options (everything included)-func DefaultBackupOptions() BackupOptions {- return BackupOptions{- IncludeDocuments: true,- IncludeFiles: true,- IncludeMetadata: true,- }+ IncludeSettings bool `json:"include_settings"` // Include user settings and preferences}// BackupJob represents an ongoing or completed backup jobdiff --git a/frontend/app/helpers/backups/index.ts b/frontend/app/helpers/backups/index.tsindex aeeba404..05f82e76 100644--- a/frontend/app/helpers/backups/index.ts+++ b/frontend/app/helpers/backups/index.ts@@ -1,5 +1,5 @@import type { FileEntry } from '@zip.js/zip.js';-import type { Manifest, ManifestExtended } from './types';+import type { Manifest } from './types';import type { DB_Node } from '~/stores';export async function readZipFile(file: File): Promise<FileEntry[]> {@@ -60,7 +60,7 @@ export async function handleBackupFile(file: File): Promise<{localData: object | null;}> {const entries = await readZipFile(file);- let manifest: ManifestExtended | null = null;+ let manifest: Manifest | null = null;let documents: DB_Node[] | null = null;let localData: object | null = null;for (const entry of entries) {@@ -68,7 +68,7 @@ export async function handleBackupFile(file: File): Promise<{manifest = await readBackupManifest(entry);} else if (entry.filename === 'documents.json') {documents = await readBackupDocuments(entry);- } else if (entry.filename === 'local_data.json') {+ } else if (entry.filename === 'user_settings.json') {localData = await readLocalData(entry);}}@@ -76,9 +76,7 @@ export async function handleBackupFile(file: File): Promise<{if (!manifest) {throw new Error('Manifest file is missing in the backup');}- if (localData) {- manifest.includeSettings = true; // Indicate that settings are included in the backup- }+return {manifest,documents,diff --git a/frontend/app/helpers/backups/types.ts b/frontend/app/helpers/backups/types.tsindex 3ad6969e..002cd99d 100644--- a/frontend/app/helpers/backups/types.ts+++ b/frontend/app/helpers/backups/types.ts@@ -5,7 +5,7 @@ export interface Manifest {include_documents: boolean;include_files: boolean;include_metadata: boolean;- local_data: object | null;+ include_settings: boolean;};statistics: {total_nodes: number;@@ -14,7 +14,3 @@ export interface Manifest {total_size_bytes: number;};}--export interface ManifestExtended extends Manifest {- includeSettings?: boolean;-}diff --git a/frontend/app/pages/dashboard/import/_components/ImportHeader.vue b/frontend/app/pages/dashboard/import/_components/ImportHeader.vueindex b2f77068..bde5fe63 100644--- a/frontend/app/pages/dashboard/import/_components/ImportHeader.vue+++ b/frontend/app/pages/dashboard/import/_components/ImportHeader.vue@@ -41,7 +41,7 @@<Icon name="layers" :size="14" />{{ t('import.header.metadata') }}</span>- <span class="badge" :class="{ active: manifest.includeSettings }">+ <span class="badge" :class="{ active: manifest.options.include_settings }"><Icon name="settings" :size="14" />{{ t('import.header.settings') }}</span>@@ -50,9 +50,9 @@</template><script setup lang="ts">-import type { ManifestExtended } from '~/helpers/backups/types';+import type { Manifest } from '~/helpers/backups/types';import { readableFileSize } from '~/helpers/resources';-defineProps<{ manifest: ManifestExtended; resetImport: () => void }>();+defineProps<{ manifest: Manifest; resetImport: () => void }>();const { t } = useI18nT();const { numericDate } = useDateFormatters();diff --git a/frontend/app/pages/dashboard/import/_components/ImportProgress.vue b/frontend/app/pages/dashboard/import/_components/ImportProgress.vueindex 3e865a44..cd1e588a 100644--- a/frontend/app/pages/dashboard/import/_components/ImportProgress.vue+++ b/frontend/app/pages/dashboard/import/_components/ImportProgress.vue@@ -59,8 +59,8 @@ const statusLabel = computed(() => {font-weight: 500;&.pending {- color: var(--yellow);- background: var(--yellow-bg);+ color: var(--orange);+ background: var(--orange-bg);}&.in_progress {diff --git a/frontend/app/pages/dashboard/import/_components/ImportTabs.vue b/frontend/app/pages/dashboard/import/_components/ImportTabs.vueindex f6fef98d..acf551f3 100644--- a/frontend/app/pages/dashboard/import/_components/ImportTabs.vue+++ b/frontend/app/pages/dashboard/import/_components/ImportTabs.vue@@ -4,7 +4,7 @@<button :class="{ active: activeTab === 'create' }" @click="activeTab = 'create'">{{ t('import.tabs.newDocuments') }} ({{ toCreate.length }})</button><button :class="{ active: activeTab === 'update' }" @click="activeTab = 'update'">{{ t('import.tabs.updates') }} ({{ toUpdate.length }})</button><button :class="{ active: activeTab === 'local' }" @click="activeTab = 'local'">- {{ t('import.tabs.localSettings') }} ({{ manifest?.includeSettings ? 1 : 0 }})+ {{ t('import.tabs.localSettings') }} ({{ manifest?.options.include_settings ? 1 : 0 }})</button></div>@@ -92,7 +92,7 @@<!-- Tab: Local Settings --><div v-if="activeTab === 'local'" class="tab-content">- <div v-if="!manifest.includeSettings" class="empty-state">+ <div v-if="!manifest.options.include_settings" class="empty-state"><Icon name="settings" :size="32" /><p>{{ t('import.tabs.noLocalSettings') }}</p></div>@@ -110,10 +110,10 @@<script setup lang="ts">import { getRoleName, resolveIcon } from '~/helpers/node';import type { DB_Node, ImportJob } from '~/stores';-import type { ManifestExtended } from '~/helpers/backups/types';+import type { Manifest } from '~/helpers/backups/types';const { t } = useI18nT();-const props = defineProps<{ manifest: ManifestExtended; toCreate: DB_Node[]; toUpdate: DB_Node[]; importJob: ImportJob }>();+const props = defineProps<{ manifest: Manifest; toCreate: DB_Node[]; toUpdate: DB_Node[]; importJob: ImportJob }>();const emit = defineEmits<{(e: 'import', type: 'create' | 'update', nodeIds: string[]): void;(e: 'importLocalSettings'): void;@@ -323,6 +323,8 @@ function importLocalSettings() {}.warning {+ display: flex;+ align-items: center;color: var(--red);}</style>diff --git a/frontend/app/pages/dashboard/settings/_views/backups.vue b/frontend/app/pages/dashboard/settings/_views/backups.vueindex d312cc0e..de62bfba 100644--- a/frontend/app/pages/dashboard/settings/_views/backups.vue+++ b/frontend/app/pages/dashboard/settings/_views/backups.vue@@ -125,7 +125,6 @@ const options = reactive({const { t } = useI18nT();const { numericDate } = useDateFormatters();const notifications = useNotifications();-const pref = usePreferencesStore();const currentJob = ref<BackupJob | null>(null);const pollingInterval = ref<ReturnType<typeof setInterval> | null>(null);@@ -164,7 +163,7 @@ async function startBackup() {const result = await makeRequest<{ job_id: string; message: string }>('backup', 'POST', {include_documents: options.includeDocuments,include_files: options.includeFiles,- local_data: options.includeSettings ? pref.preferences : null,+ include_settings: options.includeSettings,include_metadata: options.includeMetadata,});@@ -306,8 +305,8 @@ onUnmounted(() => {font-weight: 500;&.pending {- color: var(--yellow);- background: var(--yellow-bg);+ color: var(--orange);+ background: var(--orange-bg);}&.processing {diff --git a/frontend/app/stores/preferences/preferences.ts b/frontend/app/stores/preferences/preferences.tsindex 0e1728e2..45e643d7 100644--- a/frontend/app/stores/preferences/preferences.ts+++ b/frontend/app/stores/preferences/preferences.ts@@ -47,6 +47,15 @@ export const usePreferencesStore = defineStore('preferences', () => {};}+ function groupFromBackend(settings: Partial<BackendSettings>): Preferences {+ return {+ ...DEFAULT_PREFERENCES,+ ...settings.general,+ ...settings.editor,+ ...settings.advanced,+ } as Preferences;+ }+function mergeFromBackend(settings: BackendSettings) {const remote: Partial<Preferences> = {...settings.general,@@ -115,8 +124,8 @@ export const usePreferencesStore = defineStore('preferences', () => {savePreferences();}- function importPreferences(newPreferences: Partial<Preferences>) {- Object.assign(preferences, newPreferences);+ function importPreferences(newPreferences: Partial<BackendSettings>) {+ Object.assign(preferences, groupFromBackend(newPreferences));savePreferences();}