Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

core: add extensive logging around sync

Abdullah Atta632d923c69aa
diff --git a/packages/core/src/api/sync/collector.ts b/packages/core/src/api/sync/collector.ts
index 31544780e..8cc2a7868 100644
--- a/packages/core/src/api/sync/collector.ts
+++ b/packages/core/src/api/sync/collector.ts
@@ -69,7 +69,10 @@ class Collector {
.storage()
.encryptMulti(key.key, syncableItems);
const items = toSyncItem(ids, ciphers, key.version);
- if (!items.length) continue;
+ this.logger.debug(
+ `Collected ${items.length} items for type ${itemType}`,
+ { ids }
+ );
yield { items, type: itemType, count: items.length };
await this.db
diff --git a/packages/core/src/api/sync/index.ts b/packages/core/src/api/sync/index.ts
index de28b612e..ae470cb07 100644
--- a/packages/core/src/api/sync/index.ts
+++ b/packages/core/src/api/sync/index.ts
@@ -274,20 +274,33 @@ export class Sync {
await this.uploadAttachments();
let done = 0;
+ let total = 0;
for await (const item of this.collector.collect(100, isForceSync)) {
+ total += item.items.length;
const result = await this.pushItem(deviceId, item);
+ this.logger.info(`Batch sent for type ${item.type}`, {
+ result,
+ length: item.items.length,
+ type: item.type
+ });
if (result) {
done += item.items.length;
sendSyncProgressEvent(this.db.eventManager, "upload", done);
-
- this.logger.info(`Batch sent (${done})`);
} else {
this.logger.error(
new Error(`Failed to send batch. Server returned falsy response.`)
);
}
}
- if (done > 0) await this.connection?.send("PushCompletedV2", deviceId);
+ this.logger.info(
+ `Sync send completed. Sent ${done} out of ${total} items.`,
+ { done, total }
+ );
+ if (done !== total)
+ throw new Error(
+ `Failed to send all items. Sent ${done} out of ${total}.`
+ );
+ await this.connection?.send("PushCompletedV2", deviceId);
return true;
}
@@ -451,6 +464,9 @@ export class Sync {
chunkSize: item.chunkSize
});
+ this.logger.debug(`Merged ${items.length} items for type ${itemType}`, {
+ ids: items.map((i) => i?.id)
+ });
await collection.put(items as any);
}
@@ -531,6 +547,12 @@ export class Sync {
this.db.eventManager.publish(EVENTS.userSessionExpired);
return false;
}
+ this.logger.info(
+ `Received chunk for type ${chunk.type} with ${chunk.items.length} items.`,
+ {
+ ids: chunk.items.map((i: any) => i.id)
+ }
+ );
await this.processChunk(chunk, keys, options);
sendSyncProgressEvent(this.db.eventManager, `download`, chunk.count);
diff --git a/packages/core/src/api/sync/merger.ts b/packages/core/src/api/sync/merger.ts
index bc5441d88..eff2ecadc 100644
--- a/packages/core/src/api/sync/merger.ts
+++ b/packages/core/src/api/sync/merger.ts
@@ -47,6 +47,11 @@ class Merger {
localItem: MaybeDeletedItem<Item> | undefined
) {
if (!localItem || remoteItem.dateModified > localItem.dateModified) {
+ this.logger.debug(`Remote item is newer. Using remote item.`, {
+ id: remoteItem.id,
+ remoteDateModified: remoteItem.dateModified,
+ localDateModified: localItem?.dateModified
+ });
return remoteItem;
}
@@ -67,6 +72,14 @@ class Merger {
(localItem as unknown as Note).dateDeleted = null;
(localItem as unknown as Note).itemType = null;
+ this.logger.debug(
+ `Remote note has newer expiry date. Restoring expired note.`,
+ {
+ id: remoteItem.id,
+ remoteExpiryDateModified: remoteItem.expiryDate.dateModified,
+ localExpiryDateModified: localItem.expiryDate.dateModified
+ }
+ );
return localItem;
}
}
@@ -76,7 +89,16 @@ class Merger {
remoteItem: MaybeDeletedItem<Item>,
localItem: MaybeDeletedItem<Item> | undefined
) {
- if (localItem && "localOnly" in localItem && localItem.localOnly) return;
+ if (localItem && "localOnly" in localItem && localItem.localOnly) {
+ this.logger.debug(
+ `Local item is marked as localOnly. Skipping merge and keeping local item.`,
+ {
+ id: localItem.id,
+ localOnly: localItem.localOnly
+ }
+ );
+ return;
+ }
if (
!localItem ||
@@ -95,6 +117,15 @@ class Merger {
? "conflict"
: isContentConflicted(localItem, remoteItem, THRESHOLD);
+ this.logger.debug(`Content conflict check result: ${conflicted}`, {
+ id: localItem.id,
+ localDateModified: localItem.dateModified,
+ remoteDateModified: remoteItem.dateModified,
+ localDateResolved: localItem.dateResolved,
+ timeDifference:
+ Math.max(remoteItem.dateEdited, localItem.dateEdited) -
+ Math.min(remoteItem.dateEdited, localItem.dateEdited)
+ });
if (conflicted === "merge") return remoteItem;
else if (!conflicted) return;