Skip to content

A local-first personal finance app

Surface clock drift errors with actionable messages (#6789)

Copilot19edbeb5c237
diff --git a/packages/desktop-client/src/sync-events.ts b/packages/desktop-client/src/sync-events.ts
index c600de48ef..4dc4880e91 100644
--- a/packages/desktop-client/src/sync-events.ts
+++ b/packages/desktop-client/src/sync-events.ts
@@ -344,6 +344,16 @@ export function listenForSyncEvent(store: AppStore) {
case 'network':
// Show nothing
break;
+ case 'clock-drift':
+ notif = {
+ title: t('Time sync issue'),
+ message: t(
+ 'Failed to sync because your device time differs too much from the server. Please check your device time settings and ensure they are correct.',
+ ),
+ type: 'warning',
+ sticky: true,
+ };
+ break;
case 'token-expired':
notif = {
title: 'Login expired',
diff --git a/packages/loot-core/src/server/sync/index.ts b/packages/loot-core/src/server/sync/index.ts
index 882870c9ad..3f9c7fb4d4 100644
--- a/packages/loot-core/src/server/sync/index.ts
+++ b/packages/loot-core/src/server/sync/index.ts
@@ -421,33 +421,51 @@ export const applyMessages = sequential(async (messages: Message[]) => {
});
export function receiveMessages(messages: Message[]): Promise<Message[]> {
- messages.forEach(msg => {
- Timestamp.recv(msg.timestamp);
- });
+ try {
+ messages.forEach(msg => {
+ Timestamp.recv(msg.timestamp);
+ });
+ } catch (e) {
+ if (e instanceof Timestamp.ClockDriftError) {
+ throw new SyncError('clock-drift');
+ }
+ throw e;
+ }
return runMutator(() => applyMessages(messages));
}
+async function errorHandler(e: Error) {
+ captureException(e);
+
+ if (e instanceof SyncError) {
+ if (e.reason === 'invalid-schema') {
+ // We know this message came from a local modification, and it
+ // couldn't apply, which doesn't make any sense. Must be a bug
+ // in the code. Send a specific error type for it for a custom
+ // message.
+ app.events.emit('sync', {
+ type: 'error',
+ subtype: 'apply-failure',
+ meta: e.meta,
+ });
+ } else {
+ app.events.emit('sync', { type: 'error', meta: e.meta });
+ }
+ } else if (e instanceof Timestamp.ClockDriftError) {
+ app.events.emit('sync', {
+ type: 'error',
+ subtype: 'clock-drift',
+ meta: { message: e.message },
+ });
+ }
+}
+
async function _sendMessages(messages: Message[]): Promise<void> {
try {
await applyMessages(messages);
} catch (e) {
- if (e instanceof SyncError) {
- if (e.reason === 'invalid-schema') {
- // We know this message came from a local modification, and it
- // couldn't apply, which doesn't make any sense. Must be a bug
- // in the code. Send a specific error type for it for a custom
- // message.
- app.events.emit('sync', {
- type: 'error',
- subtype: 'apply-failure',
- meta: e.meta,
- });
- } else {
- app.events.emit('sync', { type: 'error', meta: e.meta });
- }
- }
-
+ errorHandler(e);
throw e;
}
@@ -467,6 +485,8 @@ export async function batchMessages(func: () => Promise<void>): Promise<void> {
try {
await func();
+ } catch (e) {
+ errorHandler(e);
// TODO: if it fails, it shouldn't apply them?
} finally {
IS_BATCHING = false;
@@ -586,6 +606,12 @@ export const fullSync = once(async function (): Promise<
subtype: e.reason,
meta: e.meta,
});
+ } else if (e.reason === 'clock-drift') {
+ app.events.emit('sync', {
+ type: 'error',
+ subtype: 'clock-drift',
+ meta: e.meta,
+ });
} else {
app.events.emit('sync', { type: 'error', meta: e.meta });
}
diff --git a/packages/loot-core/src/shared/errors.ts b/packages/loot-core/src/shared/errors.ts
index 79b585ce84..c927343411 100644
--- a/packages/loot-core/src/shared/errors.ts
+++ b/packages/loot-core/src/shared/errors.ts
@@ -72,6 +72,11 @@ export function getDownloadError({
'This budget cannot be loaded with this version of the app. Make sure the app is up-to-date.',
);
+ case 'clock-drift':
+ return t(
+ 'Failed to download the budget because your device time differs too much from the server. Please check your device time settings and ensure they are correct.',
+ );
+
default:
const info =
meta && typeof meta === 'object' && 'fileId' in meta && meta.fileId
@@ -115,6 +120,10 @@ export function getSyncError(error, id) {
'Budget "{{id}}" not found. Check the ID of your budget in the Advanced section of the settings page.',
{ id },
);
+ } else if (error === 'clock-drift') {
+ return t(
+ 'Failed to sync because your device time differs too much from the server. Please check your device time settings and ensure they are correct.',
+ );
} else {
return t('We had an unknown problem opening "{{id}}".', { id });
}
diff --git a/upcoming-release-notes/6789.md b/upcoming-release-notes/6789.md
new file mode 100644
index 0000000000..6bc4ddb6ad
--- /dev/null
+++ b/upcoming-release-notes/6789.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [MatissJanis]
+---
+
+Add user-friendly error message for clock-drift issues