New feature:

- Add database configuration check & fixing tool

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-livesync",
     "name": "Self-hosted LiveSync",
-    "version": "0.8.6",
+    "version": "0.9.0",
     "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.8.6",
+    "version": "0.9.0",
     "lockfileVersion": 2,
     "requires": true,
     "packages": {
         "": {
             "name": "obsidian-livesync",
-            "version": "0.8.6",
+            "version": "0.9.0",
             "license": "MIT",
             "dependencies": {
                 "diff-match-patch": "^1.0.5",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.8.6",
+    "version": "0.9.0",
     "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/LocalPouchDB.ts

@@ -707,7 +707,7 @@ export class LocalPouchDB {
             this.openOneshotReplication(
                 setting,
                 showingNotice,
-                async (e) => {},
+                async (e) => { },
                 false,
                 (e) => {
                     if (e === true) res(e);
@@ -719,7 +719,7 @@ export class LocalPouchDB {
         });
     }
 
-    async checkReplicationConnectivity(setting: RemoteDBSettings, keepAlive: boolean, skipCheck: boolean) {
+    async checkReplicationConnectivity(setting: RemoteDBSettings, keepAlive: boolean, skipCheck: boolean, showResult: boolean) {
         if (!this.isReady) {
             Logger("Database is not ready.");
             return false;
@@ -742,7 +742,7 @@ export class LocalPouchDB {
 
         const dbret = await connectRemoteCouchDB(uri, auth, setting.disableRequestURI || this.isMobile);
         if (typeof dbret === "string") {
-            Logger(`could not connect to ${uri}: ${dbret}`, LOG_LEVEL.NOTICE);
+            Logger(`could not connect to ${uri}: ${dbret}`, showResult ? LOG_LEVEL.NOTICE : LOG_LEVEL.INFO);
             return false;
         }
 
@@ -855,10 +855,10 @@ export class LocalPouchDB {
         }
         Logger("Oneshot Sync begin...");
         let thisCallback = callbackDone;
-        const ret = await this.checkReplicationConnectivity(setting, true, retrying);
+        const ret = await this.checkReplicationConnectivity(setting, true, retrying, showResult);
         let notice: WrappedNotice = null;
         if (ret === false) {
-            Logger("Could not connect to server.", LOG_LEVEL.NOTICE);
+            Logger("Could not connect to server.", showResult ? LOG_LEVEL.NOTICE : LOG_LEVEL.INFO);
             return;
         }
         if (showResult) {
@@ -974,7 +974,7 @@ export class LocalPouchDB {
             false,
             async () => {
                 Logger("LiveSync begin...");
-                const ret = await this.checkReplicationConnectivity(setting, true, true);
+                const ret = await this.checkReplicationConnectivity(setting, true, true, showResult);
                 let notice: WrappedNotice = null;
                 if (ret === false) {
                     Logger("Could not connect to server.", showResult ? LOG_LEVEL.NOTICE : LOG_LEVEL.INFO);

src/ObsidianLiveSyncSettingTab.ts

@@ -1,4 +1,4 @@
-import { App, PluginSettingTab, Setting, sanitizeHTMLToDom } from "obsidian";
+import { App, PluginSettingTab, Setting, sanitizeHTMLToDom, RequestUrlParam, requestUrl } from "obsidian";
 import { EntryDoc, LOG_LEVEL } from "./lib/src/types";
 import { path2id, id2path } from "./utils";
 import { NewNotice, runWithLock } from "./lib/src/utils";
@@ -197,6 +197,174 @@ export class ObsidianLiveSyncSettingTab extends PluginSettingTab {
                     })
             );
 
+        new Setting(containerRemoteDatabaseEl)
+            .setName("Check database configuration")
+            // .setDesc("Open database connection. If the remote database is not found and you have the privilege to create a database, the database will be created.")
+            .addButton((button) =>
+                button
+                    .setButtonText("Check")
+                    .setDisabled(false)
+                    .onClick(async () => {
+                        const checkConfig = async () => {
+                            try {
+                                const requestToCouchDB = async (baseUri: string, username: string, password: string, origin: string, key?: string, body?: string) => {
+                                    const utf8str = String.fromCharCode.apply(null, new TextEncoder().encode(`${username}:${password}`));
+                                    const encoded = window.btoa(utf8str);
+                                    const authHeader = "Basic " + encoded;
+                                    // const origin = "capacitor://localhost";
+                                    const transformedHeaders: Record<string, string> = { authorization: authHeader, origin: origin };
+                                    const uri = `${baseUri}/_node/_local/_config${key ? "/" + key : ""}`;
+
+                                    const requestParam: RequestUrlParam = {
+                                        url: uri,
+                                        method: body ? "PUT" : "GET",
+                                        headers: transformedHeaders,
+                                        contentType: "application/json",
+                                        body: body ? JSON.stringify(body) : undefined,
+                                    };
+                                    return await requestUrl(requestParam);
+                                };
+
+                                const r = await requestToCouchDB(this.plugin.settings.couchDB_URI, this.plugin.settings.couchDB_USER, this.plugin.settings.couchDB_PASSWORD, window.origin);
+
+                                Logger(JSON.stringify(r.json, null, 2));
+
+                                const responseConfig = r.json;
+
+                                const emptyDiv = createDiv();
+                                emptyDiv.innerHTML = "<span></span>";
+                                checkResultDiv.replaceChildren(...[emptyDiv]);
+                                const addResult = (msg: string, classes?: string[]) => {
+                                    const tmpDiv = createDiv();
+                                    tmpDiv.addClass("ob-btn-config-fix");
+                                    if (classes) {
+                                        tmpDiv.addClasses(classes);
+                                    }
+                                    tmpDiv.innerHTML = `${msg}`;
+                                    checkResultDiv.appendChild(tmpDiv);
+                                };
+                                const addConfigFixButton = (title: string, key: string, value: string) => {
+                                    const tmpDiv = createDiv();
+                                    tmpDiv.addClass("ob-btn-config-fix");
+                                    tmpDiv.innerHTML = `<label>${title}</label><button>Fix</button>`;
+                                    const x = checkResultDiv.appendChild(tmpDiv);
+                                    x.querySelector("button").addEventListener("click", async () => {
+                                        console.dir({ key, value });
+                                        const res = await requestToCouchDB(this.plugin.settings.couchDB_URI, this.plugin.settings.couchDB_USER, this.plugin.settings.couchDB_PASSWORD, undefined, key, value);
+                                        console.dir(res);
+                                        if (res.status == 200) {
+                                            Logger(`${title} successfly updated`, LOG_LEVEL.NOTICE);
+                                            checkResultDiv.removeChild(x);
+                                            checkConfig();
+                                        } else {
+                                            Logger(`${title} failed`, LOG_LEVEL.NOTICE);
+                                            Logger(res.text);
+                                        }
+                                    });
+                                };
+                                addResult("---Notice---", ["ob-btn-config-head"]);
+                                addResult(
+                                    "If the server configuration is not persistent (e.g., running on docker), the values set from here will also be volatile. Once you are able to connect, please reflect the settings in the server's local.ini.",
+                                    ["ob-btn-config-info"]
+                                );
+
+                                addResult("Your configuration is dumped to Log", ["ob-btn-config-info"]);
+                                addResult("--Config check--", ["ob-btn-config-head"]);
+
+                                // Admin check
+                                //  for database creation and deletion
+                                if (!(this.plugin.settings.couchDB_USER in responseConfig.admins)) {
+                                    addResult(`⚠ You do not have administrative privileges.`);
+                                } else {
+                                    addResult("✔ You have administrative privileges.");
+                                }
+                                // HTTP user-authorization check
+                                if (responseConfig?.chttpd?.require_valid_user != "true") {
+                                    addResult("❗ chttpd.require_valid_user looks like wrong.");
+                                    addConfigFixButton("Set chttpd.require_valid_user = true", "chttpd/require_valid_user", "true");
+                                } else {
+                                    addResult("✔ chttpd.require_valid_user is ok.");
+                                }
+                                if (responseConfig?.chttpd_auth?.require_valid_user != "true") {
+                                    addResult("❗ chttpd_auth.require_valid_user looks like wrong.");
+                                    addConfigFixButton("Set chttpd_auth.require_valid_user = true", "chttpd_auth/require_valid_user", "true");
+                                } else {
+                                    addResult("✔ chttpd_auth.require_valid_user is ok.");
+                                }
+                                // HTTPD check
+                                //  Check Authentication header
+                                if (!responseConfig?.httpd["WWW-Authenticate"]) {
+                                    addResult("❗ httpd.WWW-Authenticate is missing");
+                                    addConfigFixButton("Set httpd.WWW-Authenticate", "httpd/WWW-Authenticate", 'Basic realm="couchdb"');
+                                } else {
+                                    addResult("✔ httpd.WWW-Authenticate is ok.");
+                                }
+                                if (responseConfig?.httpd?.enable_cors != "true") {
+                                    addResult("❗ httpd.enable_cors is wrong");
+                                    addConfigFixButton("Set httpd.enable_cors", "httpd/enable_cors", "true");
+                                } else {
+                                    addResult("✔ httpd.enable_cors is ok.");
+                                }
+                                // CORS check
+                                //  checking connectivity for mobile
+                                if (responseConfig?.cors?.credentials != "true") {
+                                    addResult("❗ cors.credentials is wrong");
+                                    addConfigFixButton("Set cors.credentials", "cors/credentials", "true");
+                                } else {
+                                    addResult("✔ cors.credentials is ok.");
+                                }
+                                const ConfiguredOrigins = ((responseConfig?.cors?.origins ?? "") + "").split(",");
+                                if (
+                                    responseConfig?.cors?.origins == "*" ||
+                                    (ConfiguredOrigins.indexOf("app://obsidian.md") !== -1 && ConfiguredOrigins.indexOf("capacitor://localhost") !== -1 && ConfiguredOrigins.indexOf("http://localhost") !== -1)
+                                ) {
+                                    addResult("✔ cors.origins is ok.");
+                                } else {
+                                    addResult("❗ cors.origins is wrong");
+                                    addConfigFixButton("Set cors.origins", "cors/origins", "app://obsidian.md,capacitor://localhost,http://localhost");
+                                }
+                                addResult("--Connection check--", ["ob-btn-config-head"]);
+                                addResult(`Current origin:${window.location.origin}`);
+
+                                // Request header check
+                                const origins = ["app://obsidian.md", "capacitor://localhost", "http://localhost"];
+                                for (const org of origins) {
+                                    const rr = await requestToCouchDB(this.plugin.settings.couchDB_URI, this.plugin.settings.couchDB_USER, this.plugin.settings.couchDB_PASSWORD, org);
+                                    const responseHeaders = Object.entries(rr.headers)
+                                        .map((e) => {
+                                            e[0] = (e[0] + "").toLowerCase();
+                                            return e;
+                                        })
+                                        .reduce((obj, [key, val]) => {
+                                            obj[key] = val;
+                                            return obj;
+                                        }, {});
+                                    addResult(`Origin check:${org}`);
+                                    if (responseHeaders["access-control-allow-credentials"] != "true") {
+                                        addResult("❗ CORS is not allowing credential");
+                                    } else {
+                                        addResult("✔ CORS credential OK");
+                                    }
+                                    if (responseHeaders["access-control-allow-origin"] != org) {
+                                        addResult(`❗ CORS Origin is unmatched:${origin}->${responseHeaders["access-control-allow-origin"]}`);
+                                    } else {
+                                        addResult("✔ CORS origin OK");
+                                    }
+                                }
+                                addResult("--Done--", ["ob-btn-config-haed"]);
+                                addResult("If you have some trouble with Connection-check even though all Config-check has been passed, Please check your reverse proxy's configuration.", ["ob-btn-config-info"]);
+                            } catch (ex) {
+                                Logger(`Checking configration failed`);
+                                Logger(ex);
+                            }
+                        };
+                        await checkConfig();
+                    })
+            );
+        const checkResultDiv = containerRemoteDatabaseEl.createEl("div", {
+            text: "",
+        });
+
         addScreenElement("0", containerRemoteDatabaseEl);
         const containerLocalDatabaseEl = containerEl.createDiv();
         containerLocalDatabaseEl.createEl("h3", { text: "Local Database configuration" });

src/main.ts

@@ -373,7 +373,7 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         this.registerEvent(this.app.vault.on("modify", this.watchVaultChange));
         this.registerEvent(this.app.vault.on("delete", this.watchVaultDelete));
         this.registerEvent(this.app.vault.on("rename", this.watchVaultRename));
-        this.registerEvent(this.app.vault.on("create", this.watchVaultChange));
+        this.registerEvent(this.app.vault.on("create", this.watchVaultCreate));
         this.registerEvent(this.app.workspace.on("file-open", this.watchWorkspaceOpen));
         window.addEventListener("visibilitychange", this.watchWindowVisiblity);
     }

styles.css

@@ -172,3 +172,19 @@ div.sls-setting-menu-btn {
     background-color: var(--text-muted);
     text-decoration: line-through;
 }
+
+.ob-btn-config-fix label {
+    margin-right: 40px;
+}
+.ob-btn-config-info {
+    border: 1px solid salmon;
+    padding: 2px;
+    margin: 1px;
+    border-radius: 4px;
+}
+
+.ob-btn-config-head {
+    padding: 2px;
+    margin: 1px;
+    border-radius: 4px;
+}