Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.
Tweak useVaultSync and useVaultMutate and refactor network error flow (#1404)
Leendert de Borstc853e3214e21
diff --git a/apps/browser-extension/src/entrypoints/popup/hooks/useVaultMutate.ts b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultMutate.tsindex 637fab462..74c36fd1c 100644--- a/apps/browser-extension/src/entrypoints/popup/hooks/useVaultMutate.ts+++ b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultMutate.ts@@ -52,7 +52,7 @@ export function useVaultMutate(): {encryptionKey);- // Store the updated vault locally with pending sync flag (atomic operation)+ // Store the updated vault locally with pending sync flagawait sendMessage('STORE_ENCRYPTED_VAULT', {vaultBlob: encryptedVaultBlob,hasPendingSync: truediff --git a/apps/browser-extension/src/entrypoints/popup/hooks/useVaultSync.ts b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultSync.tsindex 6dafa4ebc..3088d86ed 100644--- a/apps/browser-extension/src/entrypoints/popup/hooks/useVaultSync.ts+++ b/apps/browser-extension/src/entrypoints/popup/hooks/useVaultSync.ts@@ -9,6 +9,7 @@ import { useWebApi } from '@/entrypoints/popup/context/WebApiContext';import type { EncryptionKeyDerivationParams } from '@/utils/dist/shared/models/metadata';import type { VaultResponse } from '@/utils/dist/shared/models/webapi';import { EncryptionUtility } from '@/utils/EncryptionUtility';+import { NetworkError } from '@/utils/types/errors/NetworkError';import { VaultVersionIncompatibleError } from '@/utils/types/errors/VaultVersionIncompatibleError';import type { VaultUploadResponse } from '@/utils/types/messaging/VaultUploadResponse';import { vaultMergeService } from '@/utils/VaultMergeService';@@ -50,14 +51,40 @@ type VaultSyncOptions = {* Hook to sync the vault with the server.* Supports offline mode: if server is unavailable, continues with local vault.*/-export const useVaultSync = () : {- syncVault: (options?: VaultSyncOptions) => Promise<boolean>;-} => {+export const useVaultSync = (): { syncVault: (options?: VaultSyncOptions) => Promise<boolean>; } => {const { t } = useTranslation();const app = useApp();const dbContext = useDb();const webApi = useWebApi();+ /**+ * Check for pending migrations and trigger upgrade if needed.+ * @returns True if upgrade is required (caller should return), false otherwise.+ */+ const checkAndHandleUpgrade = useCallback(async (onUpgradeRequired?: () => void): Promise<boolean> => {+ if (await dbContext.hasPendingMigrations()) {+ onUpgradeRequired?.();+ return true;+ }+ return false;+ }, [dbContext]);++ /**+ * Handle entering offline mode.+ * @returns True to indicate success (caller should return true).+ */+ const enterOfflineMode = useCallback(async (+ onStatus?: (message: string) => void,+ onOffline?: () => void,+ onSuccess?: (hasNewVault: boolean) => void+ ): Promise<boolean> => {+ await dbContext.setIsOffline(true);+ onStatus?.(t('common.offlineMode'));+ onOffline?.();+ onSuccess?.(false);+ return true;+ }, [dbContext, t]);+const syncVault = useCallback(async (options: VaultSyncOptions = {}) => {const { initialSync = false, onSuccess, onError, onStatus, onOffline, onUpgradeRequired } = options;@@ -80,12 +107,7 @@ export const useVaultSync = () : {if (statusResponse.serverVersion === '0.0.0') {// Server is unavailable - enter offline mode if we have a local vaultif (dbContext.dbAvailable) {- // We have a local vault, continue in offline mode- await dbContext.setIsOffline(true);- onStatus?.(t('common.offlineMode'));- onOffline?.();- onSuccess?.(false);- return true;+ return enterOfflineMode(onStatus, onOffline, onSuccess);} else {// No local vault available, can't operate offlineonError?.(t('common.errors.serverNotAvailable'));@@ -186,11 +208,10 @@ export const useVaultSync = () : {}}- const sqliteClient = await dbContext.initializeDatabase(vaultResponseJson, encryptionKey);+ await dbContext.initializeDatabase(vaultResponseJson, encryptionKey);- // Check if the current vault version is known and up to date, if not known trigger an exception, if not up to date redirect to the upgrade page.- if (await sqliteClient.hasPendingMigrations()) {- onUpgradeRequired?.();+ // Check if upgrade is required after initializing database+ if (await checkAndHandleUpgrade(onUpgradeRequired)) {return false;}@@ -243,9 +264,8 @@ export const useVaultSync = () : {}}- // Check if the vault is up to date, if not, redirect to the upgrade page.- if (await dbContext.hasPendingMigrations()) {- onUpgradeRequired?.();+ // Check if upgrade is required (for paths that didn't initialize a new database)+ if (await checkAndHandleUpgrade(onUpgradeRequired)) {return false;}@@ -262,21 +282,16 @@ export const useVaultSync = () : {}// Check if it's a network error - enter offline mode if we have a local vault- if (errorMessage.includes('network') || errorMessage.includes('timeout') || errorMessage.includes('fetch') || errorMessage.includes('Failed to fetch')) {+ if (err instanceof NetworkError) {if (dbContext.dbAvailable) {- // We have a local vault, continue in offline mode- await dbContext.setIsOffline(true);- onStatus?.(t('common.offlineMode'));- onOffline?.();- onSuccess?.(false);- return true;+ return enterOfflineMode(onStatus, onOffline, onSuccess);}}onError?.(errorMessage);return false;}- }, [app, dbContext, webApi, t]);+ }, [app, dbContext, webApi, t, checkAndHandleUpgrade, enterOfflineMode]);return { syncVault };};diff --git a/apps/browser-extension/src/utils/WebApiService.ts b/apps/browser-extension/src/utils/WebApiService.tsindex 79575c3ea..1e440734f 100644--- a/apps/browser-extension/src/utils/WebApiService.ts+++ b/apps/browser-extension/src/utils/WebApiService.ts@@ -3,6 +3,7 @@ import type { StatusResponse } from '@/utils/dist/shared/models/webapi';import { logoutEventEmitter } from '@/events/LogoutEventEmitter';import { AppInfo } from "./AppInfo";+import { NetworkError } from './types/errors/NetworkError';import { storage } from '#imports';@@ -94,6 +95,7 @@ export class WebApiService {/*** Fetch data from the API without authentication headers and without access token refresh retry.+ * Throws NetworkError for network-related failures (offline, timeout, DNS, etc.)*/public async rawFetch(endpoint: string,@@ -116,7 +118,11 @@ export class WebApiService {return response;} catch (error) {console.error('API request failed:', error);- throw error;+ // Convert fetch errors to NetworkError for proper error handling+ throw new NetworkError(+ error instanceof Error ? error.message : 'Network request failed',+ error instanceof Error ? error : undefined+ );}}diff --git a/apps/browser-extension/src/utils/types/errors/NetworkError.ts b/apps/browser-extension/src/utils/types/errors/NetworkError.tsnew file mode 100644index 000000000..1fa67d677--- /dev/null+++ b/apps/browser-extension/src/utils/types/errors/NetworkError.ts@@ -0,0 +1,21 @@+/**+ * Custom error class for network-related errors.+ * Used to detect offline scenarios and trigger offline mode.+ *+ * This error is thrown by WebApiService.rawFetch() when fetch() fails due to+ * network issues (offline, DNS, timeout, CORS, etc.). By throwing a proper+ * typed error at the source, we avoid fragile string-matching in error handlers.+ */+export class NetworkError extends Error {+ /**+ * Creates a new instance of NetworkError.+ * @param message - The error message.+ * @param cause - The original error that caused this network error.+ */+ public constructor(message: string = 'Network error', cause?: Error) {+ super(message);+ this.name = 'NetworkError';+ this.cause = cause;+ Object.setPrototypeOf(this, NetworkError.prototype);+ }+}