bump

- Fixed lack of error handling.

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-livesync",
     "name": "Self-hosted LiveSync",
-    "version": "0.17.16",
+    "version": "0.17.19",
     "minAppVersion": "0.9.12",
     "description": "Community implementation of self-hosted livesync. Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "author": "vorotamoroz",

package-lock.json

@@ -1,12 +1,12 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.17.16",
+    "version": "0.17.19",
     "lockfileVersion": 2,
     "requires": true,
     "packages": {
         "": {
             "name": "obsidian-livesync",
-            "version": "0.17.16",
+            "version": "0.17.19",
             "license": "MIT",
             "dependencies": {
                 "diff-match-patch": "^1.0.5",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.17.16",
+    "version": "0.17.19",
     "description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "main": "main.js",
     "type": "module",

src/DocumentHistoryModal.ts

@@ -6,6 +6,7 @@ import ObsidianLiveSyncPlugin from "./main";
 import { DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, diff_match_patch } from "diff-match-patch";
 import { LoadedEntry, LOG_LEVEL } from "./lib/src/types";
 import { Logger } from "./lib/src/logger";
+import { isErrorOfMissingDoc } from "./lib/src/utils_couchdb";
 import { getDocData } from "./lib/src/utils";
 
 export class DocumentHistoryModal extends Modal {
@@ -35,13 +36,13 @@ export class DocumentHistoryModal extends Modal {
         const db = this.plugin.localDatabase;
         try {
             const w = await db.localDatabase.get(path2id(this.file), { revs_info: true });
-            this.revs_info = w._revs_info.filter((e) => e.status == "available");
+            this.revs_info = w._revs_info.filter((e) => e?.status == "available");
             this.range.max = `${this.revs_info.length - 1}`;
             this.range.value = this.range.max;
             this.fileInfo.setText(`${this.file} / ${this.revs_info.length} revisions`);
             await this.loadRevs();
         } catch (ex) {
-            if (ex.status && ex.status == 404) {
+            if (isErrorOfMissingDoc(ex)) {
                 this.range.max = "0";
                 this.range.value = "";
                 this.range.disabled = true;

src/main.ts

@@ -15,7 +15,7 @@ import { decrypt, encrypt, tryDecrypt } from "./lib/src/e2ee_v2";
 const isDebug = false;
 
 import { InputStringDialog, PluginDialogModal, PopoverSelectString } from "./dialogs";
-import { isCloudantURI } from "./lib/src/utils_couchdb";
+import { isCloudantURI, isErrorOfMissingDoc } from "./lib/src/utils_couchdb";
 import { getGlobalStore, observeStores } from "./lib/src/store";
 import { lockStore, logMessageStore, logStore } from "./lib/src/stores";
 import { NewNotice, setNoticeClass, WrappedNotice } from "./lib/src/wrapper";
@@ -1920,10 +1920,25 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
                 await this.syncAllFiles(showingNotice);
             }
             if (this.settings.syncInternalFiles) {
-                await this.syncInternalFilesAndDatabase("push", showingNotice);
+                try {
+                    Logger("Synchronizing hidden files...");
+                    await this.syncInternalFilesAndDatabase("push", showingNotice);
+                    Logger("Synchronizing hidden files done");
+                } catch (ex) {
+                    Logger("Synchronizing hidden files failed");
+                    Logger(ex, LOG_LEVEL.VERBOSE)
+                }
             }
             if (this.settings.usePluginSync) {
-                await this.sweepPlugin(showingNotice);
+                try {
+                    Logger("Scanning plugins...");
+                    await this.sweepPlugin(showingNotice);
+                    Logger("Scanning plugins done");
+                } catch (ex) {
+                    Logger("Scanning plugins  failed");
+                    Logger(ex, LOG_LEVEL.VERBOSE)
+                }
+
             }
             this.isReady = true;
             // run queued event once.
@@ -2132,7 +2147,7 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
                 data: data
             };
         } catch (ex) {
-            if (ex.status && ex.status == 404) {
+            if (isErrorOfMissingDoc(ex)) {
                 return false;
             }
         }
@@ -2297,24 +2312,24 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
     }
 
     async mergeObject(path: string, baseRev: string, currentRev: string, conflictedRev: string): Promise<string | false> {
-        const baseLeaf = await this.getConflictedDoc(path, baseRev);
-        const leftLeaf = await this.getConflictedDoc(path, currentRev);
-        const rightLeaf = await this.getConflictedDoc(path, conflictedRev);
-        if (baseLeaf == false || leftLeaf == false || rightLeaf == false) {
-            return false;
-        }
-        const baseObj = { data: tryParseJSON(baseLeaf.data, {}) } as Record<string | number | symbol, any>;
-        const leftObj = { data: tryParseJSON(leftLeaf.data, {}) } as Record<string | number | symbol, any>;
-        const rightObj = { data: tryParseJSON(rightLeaf.data, {}) } as Record<string | number | symbol, any>;
-
-        const diffLeft = generatePatchObj(baseObj, leftObj);
-        const diffRight = generatePatchObj(baseObj, rightObj);
-        const patches = [
-            { mtime: leftLeaf.mtime, patch: diffLeft },
-            { mtime: rightLeaf.mtime, patch: diffRight }
-        ].sort((a, b) => a.mtime - b.mtime);
-        let newObj = { ...baseObj };
         try {
+            const baseLeaf = await this.getConflictedDoc(path, baseRev);
+            const leftLeaf = await this.getConflictedDoc(path, currentRev);
+            const rightLeaf = await this.getConflictedDoc(path, conflictedRev);
+            if (baseLeaf == false || leftLeaf == false || rightLeaf == false) {
+                return false;
+            }
+            const baseObj = { data: tryParseJSON(baseLeaf.data, {}) } as Record<string | number | symbol, any>;
+            const leftObj = { data: tryParseJSON(leftLeaf.data, {}) } as Record<string | number | symbol, any>;
+            const rightObj = { data: tryParseJSON(rightLeaf.data, {}) } as Record<string | number | symbol, any>;
+
+            const diffLeft = generatePatchObj(baseObj, leftObj);
+            const diffRight = generatePatchObj(baseObj, rightObj);
+            const patches = [
+                { mtime: leftLeaf.mtime, patch: diffLeft },
+                { mtime: rightLeaf.mtime, patch: diffRight }
+            ].sort((a, b) => a.mtime - b.mtime);
+            let newObj = { ...baseObj };
             for (const patch of patches) {
                 newObj = applyPatch(newObj, patch.patch);
             }
@@ -2990,41 +3005,47 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         const content = await arrayBufferToBase64(contentBin);
         const mtime = file.mtime;
         return await runWithLock("file-" + id, false, async () => {
-            const old = await this.localDatabase.getDBEntry(id, null, false, false);
-            let saveData: LoadedEntry;
-            if (old === false) {
-                saveData = {
-                    _id: id,
-                    data: content,
-                    mtime,
-                    ctime: mtime,
-                    datatype: "newnote",
-                    size: file.size,
-                    children: [],
-                    deleted: false,
-                    type: "newnote",
+            try {
+                const old = await this.localDatabase.getDBEntry(id, null, false, false);
+                let saveData: LoadedEntry;
+                if (old === false) {
+                    saveData = {
+                        _id: id,
+                        data: content,
+                        mtime,
+                        ctime: mtime,
+                        datatype: "newnote",
+                        size: file.size,
+                        children: [],
+                        deleted: false,
+                        type: "newnote",
+                    }
+                } else {
+                    if (isDocContentSame(old.data, content) && !forceWrite) {
+                        // Logger(`internal files STORAGE --> DB:${file.path}: Not changed`);
+                        return;
+                    }
+                    saveData =
+                    {
+                        ...old,
+                        data: content,
+                        mtime,
+                        size: file.size,
+                        datatype: "newnote",
+                        children: [],
+                        deleted: false,
+                        type: "newnote",
+                    }
                 }
-            } else {
-                if (isDocContentSame(old.data, content) && !forceWrite) {
-                    // Logger(`internal files STORAGE --> DB:${file.path}: Not changed`);
-                    return;
-                }
-                saveData =
-                {
-                    ...old,
-                    data: content,
-                    mtime,
-                    size: file.size,
-                    datatype: "newnote",
-                    children: [],
-                    deleted: false,
-                    type: "newnote",
-                }
-            }
 
-            const ret = await this.localDatabase.putDBEntry(saveData, true);
-            Logger(`STORAGE --> DB:${file.path}: (hidden) Done`);
-            return ret;
+                const ret = await this.localDatabase.putDBEntry(saveData, true);
+                Logger(`STORAGE --> DB:${file.path}: (hidden) Done`);
+                return ret;
+            } catch (ex) {
+                Logger(`STORAGE --> DB:${file.path}: (hidden) Failed`);
+                Logger(ex, LOG_LEVEL.VERBOSE);
+                return false;
+            }
         });
     }
 
@@ -3032,36 +3053,41 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         const id = filename2idInternalMetadata(path2id(filename));
         const mtime = new Date().getTime();
         await runWithLock("file-" + id, false, async () => {
-            const old = await this.localDatabase.getDBEntry(id, null, false, false) as InternalFileEntry | false;
-            let saveData: InternalFileEntry;
-            if (old === false) {
-                saveData = {
-                    _id: id,
-                    mtime,
-                    ctime: mtime,
-                    size: 0,
-                    children: [],
-                    deleted: true,
-                    type: "newnote",
-                }
-            } else {
-                if (old.deleted) {
-                    Logger(`STORAGE -x> DB:${filename}: (hidden) already deleted`);
-                    return;
-                }
-                saveData =
-                {
-                    ...old,
-                    mtime,
-                    size: 0,
-                    children: [],
-                    deleted: true,
-                    type: "newnote",
+            try {
+                const old = await this.localDatabase.getDBEntry(id, null, false, false) as InternalFileEntry | false;
+                let saveData: InternalFileEntry;
+                if (old === false) {
+                    saveData = {
+                        _id: id,
+                        mtime,
+                        ctime: mtime,
+                        size: 0,
+                        children: [],
+                        deleted: true,
+                        type: "newnote",
+                    }
+                } else {
+                    if (old.deleted) {
+                        Logger(`STORAGE -x> DB:${filename}: (hidden) already deleted`);
+                        return;
+                    }
+                    saveData =
+                    {
+                        ...old,
+                        mtime,
+                        size: 0,
+                        children: [],
+                        deleted: true,
+                        type: "newnote",
+                    }
                 }
+                await this.localDatabase.localDatabase.put(saveData);
+                Logger(`STORAGE -x> DB:${filename}: (hidden) Done`);
+            } catch (ex) {
+                Logger(`STORAGE -x> DB:${filename}: (hidden) Failed`);
+                Logger(ex, LOG_LEVEL.VERBOSE);
+                return false;
             }
-            await this.localDatabase.localDatabase.put(saveData);
-            Logger(`STORAGE -x> DB:${filename}: (hidden) Done`);
-
         });
     }
     async ensureDirectoryEx(fullPath: string) {
@@ -3089,28 +3115,25 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         const id = filename2idInternalMetadata(path2id(filename));
 
         return await runWithLock("file-" + id, false, async () => {
-            const fileOnDB = await this.localDatabase.getDBEntry(id, null, false, false) as false | LoadedEntry;
-            if (fileOnDB === false) throw new Error(`File not found on database.:${id}`);
-            const deleted = "deleted" in fileOnDB ? fileOnDB.deleted : false;
-            if (deleted) {
-                if (!isExists) {
-                    Logger(`STORAGE <x- DB:${filename}: deleted (hidden) Deleted on DB, but the file is  already not found on storage.`);
-                } else {
-                    Logger(`STORAGE <x- DB:${filename}: deleted (hidden).`);
-                    await this.app.vault.adapter.remove(filename);
+            try {
+                const fileOnDB = await this.localDatabase.getDBEntry(id, null, false, false) as false | LoadedEntry;
+                if (fileOnDB === false) throw new Error(`File not found on database.:${id}`);
+                const deleted = "deleted" in fileOnDB ? fileOnDB.deleted : false;
+                if (deleted) {
+                    if (!isExists) {
+                        Logger(`STORAGE <x- DB:${filename}: deleted (hidden) Deleted on DB, but the file is  already not found on storage.`);
+                    } else {
+                        Logger(`STORAGE <x- DB:${filename}: deleted (hidden).`);
+                        await this.app.vault.adapter.remove(filename);
+                    }
+                    return true;
                 }
-                return true;
-            }
-            if (!isExists) {
-                await this.ensureDirectoryEx(filename);
-                await this.app.vault.adapter.writeBinary(filename, base64ToArrayBuffer(fileOnDB.data), { mtime: fileOnDB.mtime, ctime: fileOnDB.ctime });
-                Logger(`STORAGE <-- DB:${filename}: written (hidden,new${force ? ", force" : ""})`);
-                return true;
-            } else {
-                try {
-                    // const stat = await this.app.vault.adapter.stat(filename);
-                    // const fileMTime = ~~(stat.mtime/1000);
-                    // const docMtime = ~~(old.mtime/1000);
+                if (!isExists) {
+                    await this.ensureDirectoryEx(filename);
+                    await this.app.vault.adapter.writeBinary(filename, base64ToArrayBuffer(fileOnDB.data), { mtime: fileOnDB.mtime, ctime: fileOnDB.ctime });
+                    Logger(`STORAGE <-- DB:${filename}: written (hidden,new${force ? ", force" : ""})`);
+                    return true;
+                } else {
                     const contentBin = await this.app.vault.adapter.readBinary(filename);
                     const content = await arrayBufferToBase64(contentBin);
                     if (content == fileOnDB.data && !force) {
@@ -3120,10 +3143,12 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
                     await this.app.vault.adapter.writeBinary(filename, base64ToArrayBuffer(fileOnDB.data), { mtime: fileOnDB.mtime, ctime: fileOnDB.ctime });
                     Logger(`STORAGE <-- DB:${filename}: written (hidden, overwrite${force ? ", force" : ""})`);
                     return true;
-                } catch (ex) {
-                    Logger(ex);
-                    return false;
+
                 }
+            } catch (ex) {
+                Logger(`STORAGE <-- DB:${filename}: written (hidden, overwrite${force ? ", force" : ""}) Failed`);
+                Logger(ex, LOG_LEVEL.VERBOSE);
+                return false;
             }
         });
     }
@@ -3154,54 +3179,58 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
     }
 
     async resolveConflictOnInternalFile(id: string): Promise<boolean> {
-        // Retrieve data
-        const doc = await this.localDatabase.localDatabase.get(id, { conflicts: true });
-        // If there is no conflict, return with false.
-        if (!("_conflicts" in doc)) return false;
-        if (doc._conflicts.length == 0) return false;
-        Logger(`Hidden file conflicted:${id2filenameInternalMetadata(id)}`);
-        const conflicts = doc._conflicts.sort((a, b) => Number(a.split("-")[0]) - Number(b.split("-")[0]));
-        const revA = doc._rev;
-        const revB = conflicts[0];
+        try {// Retrieve data
+            const doc = await this.localDatabase.localDatabase.get(id, { conflicts: true });
+            // If there is no conflict, return with false.
+            if (!("_conflicts" in doc)) return false;
+            if (doc._conflicts.length == 0) return false;
+            Logger(`Hidden file conflicted:${id2filenameInternalMetadata(id)}`);
+            const conflicts = doc._conflicts.sort((a, b) => Number(a.split("-")[0]) - Number(b.split("-")[0]));
+            const revA = doc._rev;
+            const revB = conflicts[0];
 
-        if (doc._id.endsWith(".json")) {
-            const conflictedRev = conflicts[0];
-            const conflictedRevNo = Number(conflictedRev.split("-")[0]);
-            //Search 
-            const revFrom = (await this.localDatabase.localDatabase.get(id, { revs_info: true })) as unknown as LoadedEntry & PouchDB.Core.GetMeta;
-            const commonBase = revFrom._revs_info.filter(e => e.status == "available" && Number(e.rev.split("-")[0]) < conflictedRevNo).first()?.rev ?? "";
-            const result = await this.mergeObject(id, commonBase, doc._rev, conflictedRev);
-            if (result) {
-                Logger(`Object merge:${id}`, LOG_LEVEL.INFO);
-                const filename = id2filenameInternalMetadata(id);
-                const isExists = await this.app.vault.adapter.exists(filename);
-                if (!isExists) {
-                    await this.ensureDirectoryEx(filename);
+            if (doc._id.endsWith(".json")) {
+                const conflictedRev = conflicts[0];
+                const conflictedRevNo = Number(conflictedRev.split("-")[0]);
+                //Search 
+                const revFrom = (await this.localDatabase.localDatabase.get(id, { revs_info: true })) as unknown as LoadedEntry & PouchDB.Core.GetMeta;
+                const commonBase = revFrom._revs_info.filter(e => e.status == "available" && Number(e.rev.split("-")[0]) < conflictedRevNo).first()?.rev ?? "";
+                const result = await this.mergeObject(id, commonBase, doc._rev, conflictedRev);
+                if (result) {
+                    Logger(`Object merge:${id}`, LOG_LEVEL.INFO);
+                    const filename = id2filenameInternalMetadata(id);
+                    const isExists = await this.app.vault.adapter.exists(filename);
+                    if (!isExists) {
+                        await this.ensureDirectoryEx(filename);
+                    }
+                    await this.app.vault.adapter.write(filename, result);
+                    const stat = await this.app.vault.adapter.stat(filename);
+                    await this.storeInternalFileToDatabase({ path: filename, ...stat });
+                    await this.extractInternalFileFromDatabase(filename);
+                    await this.localDatabase.localDatabase.remove(id, revB);
+                    return this.resolveConflictOnInternalFile(id);
+                } else {
+                    Logger(`Object merge is not applicable.`, LOG_LEVEL.VERBOSE);
                 }
-                await this.app.vault.adapter.write(filename, result);
-                const stat = await this.app.vault.adapter.stat(filename);
-                await this.storeInternalFileToDatabase({ path: filename, ...stat });
-                await this.extractInternalFileFromDatabase(filename);
-                await this.localDatabase.localDatabase.remove(id, revB);
-                return this.resolveConflictOnInternalFile(id);
-            } else {
-                Logger(`Object merge is not applicable.`, LOG_LEVEL.VERBOSE);
             }
+            const revBDoc = await this.localDatabase.localDatabase.get(id, { rev: revB });
+            // determine which revision should been deleted.
+            // simply check modified time
+            const mtimeA = ("mtime" in doc && doc.mtime) || 0;
+            const mtimeB = ("mtime" in revBDoc && revBDoc.mtime) || 0;
+            // Logger(`Revisions:${new Date(mtimeA).toLocaleString} and ${new Date(mtimeB).toLocaleString}`);
+            // console.log(`mtime:${mtimeA} - ${mtimeB}`);
+            const delRev = mtimeA < mtimeB ? revA : revB;
+            // delete older one.
+            await this.localDatabase.localDatabase.remove(id, delRev);
+            Logger(`Older one has been deleted:${id2filenameInternalMetadata(id)}`);
+            // check the file again 
+            return this.resolveConflictOnInternalFile(id);
+        } catch (ex) {
+            Logger("Failed to resolve conflict (Hidden)")
+            Logger(ex, LOG_LEVEL.VERBOSE);
+            return false;
         }
-        const revBDoc = await this.localDatabase.localDatabase.get(id, { rev: revB });
-        // determine which revision should been deleted.
-        // simply check modified time
-        const mtimeA = ("mtime" in doc && doc.mtime) || 0;
-        const mtimeB = ("mtime" in revBDoc && revBDoc.mtime) || 0;
-        // Logger(`Revisions:${new Date(mtimeA).toLocaleString} and ${new Date(mtimeB).toLocaleString}`);
-        // console.log(`mtime:${mtimeA} - ${mtimeB}`);
-        const delRev = mtimeA < mtimeB ? revA : revB;
-        // delete older one.
-        await this.localDatabase.localDatabase.remove(id, delRev);
-        Logger(`Older one has been deleted:${id2filenameInternalMetadata(id)}`);
-        // check the file again 
-        return this.resolveConflictOnInternalFile(id);
-
     }
     //TODO: Tidy up. Even though it is experimental feature, So dirty...
     async syncInternalFilesAndDatabase(direction: "push" | "pull" | "safe", showMessage: boolean, files: InternalFileInfo[] | false = false, targetFiles: string[] | false = false) {

updates.md

@@ -66,6 +66,8 @@
   - Fixed:
     - Hidden files have been synchronised again.
     - Rename of files has been fixed again.
+  And, minor changes have been included.
+
 - 0.17.16:
   - Improved:
     - Plugins and their settings no longer need scanning if changes are monitored.
@@ -79,7 +81,11 @@
     - Plugins and their setting can be synchronised again.
     - Hidden files and plugins are correctly scanned while rebuilding.
     - Files with the name started `_` are also being performed conflict-checking.
-    
-  And, minor changes have been included.
+- 0.17.17
+  - Fixed: Now we can merge JSON files even if we failed to compare items like null.
+- 0.17.18
+  - Fixed: Fixed lack of error handling.
+- 0.17.19 
+  - Fixed: Error reporting has been ensured.
 
 ... To continue on to `updates_old.md`.