Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Add background vault sync flow for non-critical transactons (#1404)

Leendert de Borsta313cfade29b
diff --git a/apps/server/AliasVault.Client/Main/Components/Folders/FolderPill.razor b/apps/server/AliasVault.Client/Main/Components/Folders/FolderPill.razor
index 497a32265..2446f9061 100644
--- a/apps/server/AliasVault.Client/Main/Components/Folders/FolderPill.razor
+++ b/apps/server/AliasVault.Client/Main/Components/Folders/FolderPill.razor
@@ -1,7 +1,7 @@
@using AliasVault.Client.Main.Models
@* FolderPill component - displays a folder as a compact clickable pill *@
-<button @onclick="OnClick" class="inline-flex items-center gap-2 px-5 py-3 text-sm rounded-lg bg-gray-100 dark:bg-gray-700/50 hover:bg-gray-200 dark:hover:bg-gray-600/50 transition-colors focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-1 dark:focus:ring-offset-gray-800">
+<button @onclick="OnClick" class="inline-flex items-center gap-2 px-5 py-2.5 text-sm rounded-lg bg-gray-100 dark:bg-gray-700/50 hover:bg-gray-200 dark:hover:bg-gray-600/50 transition-colors focus:outline-none focus:ring-2 focus:ring-orange-500 focus:ring-offset-1 dark:focus:ring-offset-gray-800">
<svg class="w-4 h-4 text-orange-500 flex-shrink-0" viewBox="0 0 24 24" fill="currentColor">
<path d="M10 4H4a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-8l-2-2z"/>
</svg>
diff --git a/apps/server/AliasVault.Client/Main/Layout/DbStatusIndicator.razor b/apps/server/AliasVault.Client/Main/Layout/DbStatusIndicator.razor
index bb3d131c8..a0844bb5b 100644
--- a/apps/server/AliasVault.Client/Main/Layout/DbStatusIndicator.razor
+++ b/apps/server/AliasVault.Client/Main/Layout/DbStatusIndicator.razor
@@ -4,10 +4,10 @@
@inject IStringLocalizerFactory LocalizerFactory
<div class="ms-1 items-center flex">
- <SmallLoadingIndicator Title="@SharedLocalizer["SyncVaultData"]" Spinning="@Loading">
- @if (!Loading)
+ <SmallLoadingIndicator Title="@GetStatusTitle()" Spinning="@IsSyncing">
+ @if (!IsSyncing)
{
- <button class="absolute p-2 hover:bg-gray-200 rounded-2xl" id="vault-refresh-btn" @onclick="OnRefreshClick">
+ <button class="absolute p-2 hover:bg-gray-200 dark:hover:bg-gray-700 rounded-2xl" id="vault-refresh-btn" @onclick="OnRefreshClick">
<svg xmlns="http://www.w3.org/2000/svg" class="h-4 w-4 text-gray-400" viewBox="0 0 20 20" fill="currentColor">
<path fill-rule="evenodd" d="M4 2a1 1 0 011 1v2.101a7.002 7.002 0 0111.601 2.566 1 1 0 11-1.885.666A5.002 5.002 0 005.999 7H9a1 1 0 010 2H4a1 1 0 01-1-1V3a1 1 0 011-1zm.008 9.057a1 1 0 011.276.61A5.002 5.002 0 0014.001 13H11a1 1 0 110-2h5a1 1 0 011 1v5a1 1 0 11-2 0v-2.101a7.002 7.002 0 01-11.601-2.566 1 1 0 01.61-1.276z" clip-rule="evenodd" />
</svg>
@@ -19,9 +19,7 @@
@code {
private IStringLocalizer SharedLocalizer => LocalizerFactory.Create("SharedResources", "AliasVault.Client");
- private bool Loading { get; set; } = false;
- private string LoadingIndicatorMessage { get; set; } = "";
- private bool DatabaseLoading { get; set; } = false;
+ private bool IsSyncing { get; set; }
/// <summary>
/// Dispose method.
@@ -36,8 +34,7 @@
{
await base.OnInitializedAsync();
DbService.GetState().StateChanged += OnDatabaseStateChanged;
-
- UpdateLoadingIndicatorMessage();
+ UpdateSyncState();
}
/// <summary>
@@ -50,37 +47,50 @@
private async void OnDatabaseStateChanged(object? sender, DbServiceState.DatabaseState newState)
{
- await InvokeAsync(StateHasChanged);
-
- UpdateLoadingIndicatorMessage();
+ await InvokeAsync(() =>
+ {
+ UpdateSyncState();
+ StateHasChanged();
+ });
- if (newState.Status == DbServiceState.DatabaseStatus.SavingToServer)
+ // Show loading indicator for at least 0.5 seconds when syncing to server
+ if (newState.Status is DbServiceState.DatabaseStatus.SavingToServer or DbServiceState.DatabaseStatus.BackgroundSyncPending)
{
- // Show loading indicator for at least 0.5 seconds even if the save operation is faster.
- await ShowLoadingIndicatorAsync();
+ await ShowSyncIndicatorAsync();
}
}
- private void UpdateLoadingIndicatorMessage()
+ private void UpdateSyncState()
{
- var currentState = DbService.GetState().CurrentState;
+ var currentStatus = DbService.GetState().CurrentState.Status;
+ IsSyncing = currentStatus is DbServiceState.DatabaseStatus.SavingToServer
+ or DbServiceState.DatabaseStatus.BackgroundSyncPending
+ or DbServiceState.DatabaseStatus.Loading;
+ }
- var message = currentState.Status.ToString();
- if (currentState.Message != string.Empty)
+ private string GetStatusTitle()
+ {
+ var currentStatus = DbService.GetState().CurrentState.Status;
+ return currentStatus switch
{
- message = currentState.Message;
- }
-
- LoadingIndicatorMessage = "Vault status: " + message + " - " + currentState.LastUpdated;
- StateHasChanged();
+ DbServiceState.DatabaseStatus.BackgroundSyncPending => SharedLocalizer["SyncingChanges"],
+ DbServiceState.DatabaseStatus.SavingToServer => SharedLocalizer["SyncVaultData"],
+ DbServiceState.DatabaseStatus.Loading => SharedLocalizer["LoadingVault"],
+ _ => SharedLocalizer["SyncVaultData"],
+ };
}
- private async Task ShowLoadingIndicatorAsync()
+ private async Task ShowSyncIndicatorAsync()
{
- Loading = true;
- StateHasChanged();
+ IsSyncing = true;
+ await InvokeAsync(StateHasChanged);
await Task.Delay(800);
- Loading = false;
- StateHasChanged();
+
+ // Only hide if we're back to ready state
+ if (DbService.GetState().CurrentState.Status == DbServiceState.DatabaseStatus.Ready)
+ {
+ IsSyncing = false;
+ await InvokeAsync(StateHasChanged);
+ }
}
}
diff --git a/apps/server/AliasVault.Client/Main/Pages/Items/Home.razor b/apps/server/AliasVault.Client/Main/Pages/Items/Home.razor
index b07b51c28..696a2b8cd 100644
--- a/apps/server/AliasVault.Client/Main/Pages/Items/Home.razor
+++ b/apps/server/AliasVault.Client/Main/Pages/Items/Home.razor
@@ -475,10 +475,10 @@ else
{
if (Folders.Count > 0)
{
- return "inline-flex items-center gap-1.5 px-5 py-3 text-sm rounded-lg transition-colors focus:outline-none text-gray-500 dark:text-gray-400 hover:text-orange-600 dark:hover:text-orange-400 hover:bg-gray-100 dark:hover:bg-gray-700/50";
+ return "inline-flex items-center gap-1.5 px-5 py-2.5 text-sm rounded-lg transition-colors focus:outline-none text-gray-500 dark:text-gray-400 hover:text-orange-600 dark:hover:text-orange-400 hover:bg-gray-100 dark:hover:bg-gray-700/50";
}
- return "inline-flex items-center gap-1.5 px-5 py-3 text-sm rounded-lg transition-colors focus:outline-none text-gray-400 dark:text-gray-500 border border-dashed border-gray-300 dark:border-gray-600 hover:border-orange-400 dark:hover:border-orange-500 hover:text-orange-600 dark:hover:text-orange-400";
+ return "inline-flex items-center gap-1.5 px-5 py-2.5 text-sm rounded-lg transition-colors focus:outline-none text-gray-400 dark:text-gray-500 border border-dashed border-gray-300 dark:border-gray-600 hover:border-orange-400 dark:hover:border-orange-500 hover:text-orange-600 dark:hover:text-orange-400";
}
/// <summary>
diff --git a/apps/server/AliasVault.Client/Resources/SharedResources.en.resx b/apps/server/AliasVault.Client/Resources/SharedResources.en.resx
index d66cc2386..9951de98a 100644
--- a/apps/server/AliasVault.Client/Resources/SharedResources.en.resx
+++ b/apps/server/AliasVault.Client/Resources/SharedResources.en.resx
@@ -315,4 +315,12 @@
<value>Sync vault data</value>
<comment>Tooltip text for sync vault data button</comment>
</data>
+ <data name="SyncingChanges" xml:space="preserve">
+ <value>Syncing changes...</value>
+ <comment>Status text when background sync is in progress</comment>
+ </data>
+ <data name="LoadingVault" xml:space="preserve">
+ <value>Loading vault...</value>
+ <comment>Status text when vault is being loaded</comment>
+ </data>
</root>
\ No newline at end of file
diff --git a/apps/server/AliasVault.Client/Services/Database/DbService.cs b/apps/server/AliasVault.Client/Services/Database/DbService.cs
index cd370dcc5..f705a18d5 100644
--- a/apps/server/AliasVault.Client/Services/Database/DbService.cs
+++ b/apps/server/AliasVault.Client/Services/Database/DbService.cs
@@ -298,6 +298,59 @@ public sealed class DbService : IDisposable
return success;
}
+ /// <summary>
+ /// Saves the database to the remote server in the background without blocking the caller.
+ /// The local database state is immediately persisted (in-memory), and the server sync happens asynchronously.
+ /// If the sync fails, a notification is shown to the user.
+ /// </summary>
+ /// <remarks>
+ /// This method is useful for operations where blocking the UI is undesirable, such as
+ /// folder creation, settings changes, etc. The local mutation is considered immediately
+ /// successful, and server sync happens in the background.
+ /// </remarks>
+ public void SaveDatabaseInBackground()
+ {
+ // Set state to indicate background sync is pending
+ _state.UpdateState(DbServiceState.DatabaseStatus.BackgroundSyncPending);
+
+ // Fire and forget the background save operation
+ _ = Task.Run(async () =>
+ {
+ try
+ {
+ // Make sure a public/private RSA encryption key exists before saving the database.
+ await GetOrCreateEncryptionKeyAsync();
+
+ var encryptedBase64String = await GetEncryptedDatabaseBase64String();
+
+ // Update state to show we're actively syncing
+ _state.UpdateState(DbServiceState.DatabaseStatus.SavingToServer);
+
+ // Save to webapi.
+ var success = await SaveToServerAsync(encryptedBase64String);
+ if (success)
+ {
+ _logger.LogInformation("Database successfully saved to server (background sync).");
+ _state.UpdateState(DbServiceState.DatabaseStatus.Ready);
+ }
+ else
+ {
+ _logger.LogWarning("Background sync to server failed.");
+ _globalNotificationService.AddErrorMessage(
+ "Failed to sync changes to server. Your changes are saved locally and will be synced on next refresh.");
+ _state.UpdateState(DbServiceState.DatabaseStatus.Ready);
+ }
+ }
+ catch (Exception ex)
+ {
+ _logger.LogError(ex, "Error during background database sync.");
+ _globalNotificationService.AddErrorMessage(
+ "Failed to sync changes to server. Your changes are saved locally and will be synced on next refresh.");
+ _state.UpdateState(DbServiceState.DatabaseStatus.Ready);
+ }
+ });
+ }
+
/// <summary>
/// Export the in-memory SQLite database to a base64 string.
/// </summary>
diff --git a/apps/server/AliasVault.Client/Services/Database/DbServiceState.cs b/apps/server/AliasVault.Client/Services/Database/DbServiceState.cs
index bae735843..de09e6678 100644
--- a/apps/server/AliasVault.Client/Services/Database/DbServiceState.cs
+++ b/apps/server/AliasVault.Client/Services/Database/DbServiceState.cs
@@ -74,6 +74,12 @@ public sealed class DbServiceState
/// Database is saving to server.
/// </summary>
SavingToServer,
+
+ /// <summary>
+ /// Database has local changes pending background sync to server.
+ /// Used for non-blocking mutations where UI doesn't wait for server sync.
+ /// </summary>
+ BackgroundSyncPending,
}
/// <summary>
@@ -156,7 +162,7 @@ public sealed class DbServiceState
/// <returns>Bool.</returns>
public bool IsInitialized()
{
- return Status is DatabaseStatus.Ready or DatabaseStatus.SavingToServer;
+ return Status is DatabaseStatus.Ready or DatabaseStatus.SavingToServer or DatabaseStatus.BackgroundSyncPending;
}
}
}
diff --git a/apps/server/AliasVault.Client/Services/FolderService.cs b/apps/server/AliasVault.Client/Services/FolderService.cs
index 3fea40c3d..6ca82c7c8 100644
--- a/apps/server/AliasVault.Client/Services/FolderService.cs
+++ b/apps/server/AliasVault.Client/Services/FolderService.cs
@@ -17,6 +17,7 @@ using Microsoft.EntityFrameworkCore;
/// <summary>
/// Service class for Folder operations.
+/// All mutations use background sync to avoid blocking the UI.
/// </summary>
public sealed class FolderService(DbService dbService)
{
@@ -57,11 +58,11 @@ public sealed class FolderService(DbService dbService)
}
/// <summary>
- /// Create a new folder.
+ /// Create a new folder. Syncs to server in background without blocking UI.
/// </summary>
/// <param name="name">The folder name.</param>
/// <param name="parentFolderId">Optional parent folder ID.</param>
- /// <returns>The created folder ID, or empty Guid on failure.</returns>
+ /// <returns>The created folder ID.</returns>
public async Task<Guid> CreateAsync(string name, Guid? parentFolderId = null)
{
var context = await dbService.GetDbContextAsync();
@@ -78,21 +79,18 @@ public sealed class FolderService(DbService dbService)
};
context.Folders.Add(folder);
-
- if (!await dbService.SaveDatabaseAsync())
- {
- return Guid.Empty;
- }
+ await context.SaveChangesAsync();
+ dbService.SaveDatabaseInBackground();
return folder.Id;
}
/// <summary>
- /// Update a folder's name.
+ /// Update a folder's name. Syncs to server in background without blocking UI.
/// </summary>
/// <param name="folderId">The folder ID.</param>
/// <param name="name">The new folder name.</param>
- /// <returns>True if successful.</returns>
+ /// <returns>True if folder was found and updated.</returns>
public async Task<bool> UpdateAsync(Guid folderId, string name)
{
var context = await dbService.GetDbContextAsync();
@@ -109,14 +107,18 @@ public sealed class FolderService(DbService dbService)
folder.Name = name;
folder.UpdatedAt = DateTime.UtcNow;
- return await dbService.SaveDatabaseAsync();
+ await context.SaveChangesAsync();
+ dbService.SaveDatabaseInBackground();
+
+ return true;
}
/// <summary>
/// Delete a folder, moving its items to root (FolderId = null).
+ /// Syncs to server in background without blocking UI.
/// </summary>
/// <param name="folderId">The folder ID.</param>
- /// <returns>True if successful.</returns>
+ /// <returns>True if folder was found and deleted.</returns>
public async Task<bool> DeleteAsync(Guid folderId)
{
var context = await dbService.GetDbContextAsync();
@@ -147,14 +149,18 @@ public sealed class FolderService(DbService dbService)
folder.IsDeleted = true;
folder.UpdatedAt = currentDateTime;
- return await dbService.SaveDatabaseAsync();
+ await context.SaveChangesAsync();
+ dbService.SaveDatabaseInBackground();
+
+ return true;
}
/// <summary>
/// Delete a folder and all its contents (move items to trash).
+ /// Syncs to server in background without blocking UI.
/// </summary>
/// <param name="folderId">The folder ID.</param>
- /// <returns>True if successful.</returns>
+ /// <returns>True if folder was found and deleted.</returns>
public async Task<bool> DeleteWithContentsAsync(Guid folderId)
{
var context = await dbService.GetDbContextAsync();
@@ -185,6 +191,9 @@ public sealed class FolderService(DbService dbService)
folder.IsDeleted = true;
folder.UpdatedAt = currentDateTime;
- return await dbService.SaveDatabaseAsync();
+ await context.SaveChangesAsync();
+ dbService.SaveDatabaseInBackground();
+
+ return true;
}
}
diff --git a/apps/server/AliasVault.Client/Services/SettingsService.cs b/apps/server/AliasVault.Client/Services/SettingsService.cs
index 34382f306..81976e274 100644
--- a/apps/server/AliasVault.Client/Services/SettingsService.cs
+++ b/apps/server/AliasVault.Client/Services/SettingsService.cs
@@ -8,7 +8,6 @@
namespace AliasVault.Client.Services;
using System;
-using System.Data;
using System.Globalization;
using System.Text.Json;
using System.Threading.Tasks;
@@ -359,7 +358,7 @@ public sealed class SettingsService
}
/// <summary>
- /// Set setting value in database.
+ /// Set setting value in database. Syncs to server in background without blocking UI.
/// </summary>
/// <param name="key">Key of setting to set.</param>
/// <param name="value">Value of setting to set.</param>
@@ -392,14 +391,12 @@ public sealed class SettingsService
db.Settings.Update(setting);
}
- // Also update the setting in the local dictionary so the new value
+ // Update the setting in the local dictionary so the new value
// is returned by subsequent local reads.
_settings[key] = value;
- var success = await _dbService.SaveDatabaseAsync();
- if (!success)
- {
- throw new DataException("Error saving database to server after setting update.");
- }
+ // Save to EF context and sync to server in background (non-blocking).
+ await db.SaveChangesAsync();
+ _dbService.SaveDatabaseInBackground();
}
}