bump to 0.3.17

.github/workflows/release.yml

@@ -12,8 +12,6 @@ on:
   push:
     tags:
       - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
-    branches:
-      - master
 
 jobs:
   build:

README.md

@@ -35,6 +35,9 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 - **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
 - **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
 - **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
+- **You should protect your `data.json` file.** The file contains sensitive information.
+  - It's strongly advised **NOT** to share your `data.json` file to anyone.
+  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
 
 ## Questions, Suggestions, Or Bugs
 

docs/how_to_debug/README.md

@@ -6,6 +6,14 @@ Ideally, users do not need to debug anything. But if something bad happened, we
 
 See [here](./export_sync_plans.md).
 
-## Advanced: Check Console Output
+## Advanced: Check Console Output Directly
+
+...of desktop and Android.
 
 See [here](./check_console_output.md).
+
+## Advanced: Save Console Output Then Read Them Later
+
+This method works for desktop and mobile devices (iOS, Android).
+
+See [here](./save_console_output_and_export.md).

docs/how_to_debug/check_console_output.md

@@ -1,6 +1,6 @@
 # Check Console Output
 
-If you are using Obsidian on desktop, you can check the Obsidian console.
+If you are using Obsidian on desktop or Android, you can check the Obsidian console.
 
 ## Disable Auto Sync Firstly
 
@@ -12,6 +12,12 @@ Go to the plugin settings, scroll down to the section "Debug" -> "alter console
 
 ## Check The Output
 
-Then, press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+- If you are on desktop
+
+  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+
+- If you are using Android
+
+  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
 
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.

docs/how_to_debug/save_console_output_and_export.md

@@ -0,0 +1,25 @@
+# Save Console Output And Read Them Later
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Enable Saving The Output To DB
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
+
+## Run The Sync
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
+
+## Export The Output And Read The Logs
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
+
+## Disable Saving The Output To DB
+
+After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.3.16",
+  "version": "0.3.17",
   "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.3.16",
+  "version": "0.3.17",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs",
@@ -62,6 +62,7 @@
     "@fyears/tsqueue": "^1.0.1",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "acorn": "^8.5.0",
+    "aggregate-error": "^4.0.0",
     "assert": "^2.0.0",
     "aws-crt": "^1.10.1",
     "buffer": "^6.0.3",

src/baseTypes.ts

@@ -84,6 +84,7 @@ export interface RemotelySavePluginSettings {
   syncConfigDir?: boolean;
   syncUnderscoreItems?: boolean;
   lang?: LangTypeAndAuto;
+  logToDB?: boolean;
 
   /**
    * @deprecated
@@ -145,9 +146,19 @@ export interface FileOrFolderMixedState {
   decisionBranch?: number;
   syncDone?: "done";
   remoteEncryptedKey?: string;
+
+  mtimeLocalFmt?: string;
+  mtimeRemoteFmt?: string;
+  deltimeLocalFmt?: string;
+  deltimeRemoteFmt?: string;
 }
 
 export const API_VER_STAT_FOLDER = "0.13.27";
 export const API_VER_REQURL = "0.13.26";
 export const VALID_REQURL =
   requireApiVersion(API_VER_REQURL) && !Platform.isAndroidApp;
+
+export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
+export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
+  "sync_plans_hist_exported_on_";
+export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";

src/configPersist.ts

@@ -3,8 +3,7 @@ import { reverseString } from "./misc";
 
 import type { RemotelySavePluginSettings } from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 const DEFAULT_README: string =
   "The file contains sensitive info, so DO NOT take screenshot of, copy, or share it to anyone! It's also generated automatically, so do not edit it manually.";
@@ -20,8 +19,8 @@ interface MessyConfigType {
 export const messyConfigToNormal = (
   x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
-  log.debug("loading, original config on disk:");
+  // log.debug("loading, original config on disk:");
-  log.debug(x);
+  // log.debug(x);
   if (x === null || x === undefined) {
     log.debug("the messy config is null or undefined, skip");
     return x as any;
@@ -36,12 +35,12 @@ export const messyConfigToNormal = (
         }) as Buffer
       ).toString("utf-8")
     );
-    log.debug("loading, parsed config is:");
+    // log.debug("loading, parsed config is:");
-    log.debug(y);
+    // log.debug(y);
     return y;
   } else {
     // return as is
-    log.debug("loading, parsed config is the same");
+    // log.debug("loading, parsed config is the same");
     return x;
   }
 };
@@ -64,7 +63,7 @@ export const normalConfigToMessy = (
       })
     ),
   };
-  log.debug("encoding, encoded config is:");
+  // log.debug("encoding, encoded config is:");
-  log.debug(y);
+  // log.debug(y);
   return y;
 };

src/debugMode.ts

@@ -1,15 +1,19 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
 import type { SyncPlanType } from "./sync";
-import { readAllSyncPlanRecordTextsByVault } from "./localdb";
+import {
+  readAllSyncPlanRecordTextsByVault,
+  readAllLogRecordTextsByVault,
+} from "./localdb";
 import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
+import {
+  DEFAULT_DEBUG_FOLDER,
+  DEFAULT_LOG_HISTORY_FILE_PREFIX,
+  DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
+} from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
-
-const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
 
 export const exportVaultSyncPlansToFiles = async (
   db: InternalDBs,
@@ -34,3 +38,27 @@ export const exportVaultSyncPlansToFiles = async (
   });
   log.info("finish exporting");
 };
+
+export const exportVaultLoggerOutputToFiles = async (
+  db: InternalDBs,
+  vault: Vault,
+  vaultRandomID: string
+) => {
+  await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
+  const records = await readAllLogRecordTextsByVault(db, vaultRandomID);
+  let md = "";
+  if (records.length === 0) {
+    md = "No logger history found.";
+  } else {
+    md =
+      "Logger history found:\n\n" +
+      "```text\n" +
+      records.join("\n") +
+      "\n```\n";
+  }
+  const ts = Date.now();
+  const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_LOG_HISTORY_FILE_PREFIX}${ts}.md`;
+  await vault.create(filePath, md, {
+    mtime: ts,
+  });
+};

src/encrypt.ts

@@ -1,8 +1,7 @@
 import { base32, base64url } from "rfc4648";
 import { bufferToArrayBuffer, hexStringToTypedArray } from "./misc";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 const DEFAULT_ITER = 20000;
 

src/importExport.ts

@@ -7,8 +7,7 @@ import {
   RemotelySavePluginSettings,
 } from "./baseTypes";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export const exportQrCodeUri = async (
   settings: RemotelySavePluginSettings,

src/localdb.ts

@@ -1,14 +1,13 @@
 import localforage from "localforage";
+export type LocalForage = typeof localforage;
+import { nanoid } from "nanoid";
 import { requireApiVersion, TAbstractFile, TFile, TFolder } from "obsidian";
 
 import { API_VER_STAT_FOLDER, SUPPORTED_SERVICES_TYPE } from "./baseTypes";
 import type { SyncPlanType } from "./sync";
+import { toText, unixTimeToStr } from "./misc";
 
-export type LocalForage = typeof localforage;
+import { log } from "./moreOnLog";
-
-import * as origLog from "loglevel";
-import { nanoid } from "nanoid";
-const log = origLog.getLogger("rs-default");
 
 const DB_VERSION_NUMBER_IN_HISTORY = [20211114, 20220108, 20220326];
 export const DEFAULT_DB_VERSION_NUMBER: number = 20220326;
@@ -18,6 +17,7 @@ export const DEFAULT_TBL_FILE_HISTORY = "filefolderoperationhistory";
 export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
 export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
 export const DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING = "vaultrandomidmapping";
+export const DEFAULT_TBL_LOGGER_OUTPUT = "loggeroutput";
 
 export interface FileFolderHistoryRecord {
   key: string;
@@ -57,6 +57,7 @@ export interface InternalDBs {
   syncMappingTbl: LocalForage;
   syncPlansTbl: LocalForage;
   vaultRandomIDMappingTbl: LocalForage;
+  loggerOutputTbl: LocalForage;
 }
 
 /**
@@ -211,6 +212,10 @@ export const prepareDBs = async (
       name: DEFAULT_DB_NAME,
       storeName: DEFAULT_TBL_VAULT_RANDOM_ID_MAPPING,
     }),
+    loggerOutputTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_LOGGER_OUTPUT,
+    }),
   } as InternalDBs;
 
   // try to get vaultRandomID firstly
@@ -516,6 +521,7 @@ export const insertSyncPlanRecordByVault = async (
 ) => {
   const record = {
     ts: syncPlan.ts,
+    tsFmt: syncPlan.tsFmt,
     vaultRandomID: vaultRandomID,
     remoteType: syncPlan.remoteType,
     syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
@@ -545,3 +551,133 @@ export const readAllSyncPlanRecordTextsByVault = async (
     return records.map((x) => x.syncPlan);
   }
 };
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredSyncPlanRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.syncPlansTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.syncPlansTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};
+
+export const readAllLogRecordTextsByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string
+) => {
+  const records = [] as { ts: number; r: string }[];
+  await db.loggerOutputTbl.iterate((value, key, iterationNumber) => {
+    if (key.startsWith(`${vaultRandomID}\t`)) {
+      const item = {
+        ts: parseInt(key.split("\t")[1]),
+        r: value as string,
+      };
+      records.push(item);
+    }
+  });
+
+  // while reading the logs, we want it to be ascending
+  records.sort((a, b) => a.ts - b.ts);
+
+  if (records === undefined) {
+    return [] as string[];
+  } else {
+    return records.map((x) => x.r);
+  }
+};
+
+export const insertLoggerOutputByVault = async (
+  db: InternalDBs,
+  vaultRandomID: string,
+  ...msg: any[]
+) => {
+  const ts = Date.now();
+  const tsFmt = unixTimeToStr(ts);
+  const key = `${vaultRandomID}\t${ts}`;
+
+  try {
+    const val = [`[${tsFmt}]`, ...msg.map((x) => toText(x))].join(" ");
+    db.loggerOutputTbl.setItem(key, val);
+  } catch (err) {
+    // give up, and let it pass
+  }
+};
+
+export const clearAllLoggerOutputRecords = async (db: InternalDBs) => {
+  await db.loggerOutputTbl.clear();
+};
+
+/**
+ * We remove records that are older than 7 days or 10000 records.
+ * It's a heavy operation, so we shall not place it in the start up.
+ * @param db
+ */
+export const clearExpiredLoggerOutputRecords = async (db: InternalDBs) => {
+  const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 7; // 7 days
+  const COUNT_TO_MANY = 10000;
+
+  const currTs = Date.now();
+  const expiredTs = currTs - MILLISECONDS_OLD;
+
+  let records = (await db.loggerOutputTbl.keys()).map((key) => {
+    const ts = parseInt(key.split("\t")[1]);
+    const expired = ts <= expiredTs;
+    return {
+      ts: ts,
+      key: key,
+      expired: expired,
+    };
+  });
+
+  const keysToRemove = new Set(
+    records.filter((x) => x.expired).map((x) => x.key)
+  );
+
+  if (records.length - keysToRemove.size > COUNT_TO_MANY) {
+    // we need to find out records beyond 10000 records
+    records = records.filter((x) => !x.expired); // shrink the array
+    records.sort((a, b) => -(a.ts - b.ts)); // descending
+    records.slice(COUNT_TO_MANY).forEach((element) => {
+      keysToRemove.add(element.key);
+    });
+  }
+
+  const ps = [] as Promise<void>[];
+  keysToRemove.forEach((element) => {
+    ps.push(db.loggerOutputTbl.removeItem(element));
+  });
+  await Promise.all(ps);
+};

src/main.ts

@@ -24,6 +24,9 @@ import {
   loadFileHistoryTableByVault,
   prepareDBs,
   InternalDBs,
+  insertLoggerOutputByVault,
+  clearExpiredLoggerOutputRecords,
+  clearExpiredSyncPlanRecords,
 } from "./localdb";
 import { RemoteClient } from "./remote";
 import {
@@ -48,10 +51,12 @@ import { ObsConfigDirFileType, listFilesInObsFolder } from "./obsFolderLister";
 import { I18n } from "./i18n";
 import type { LangType, LangTypeAndAuto, TransItemType } from "./i18n";
 
-import * as origLog from "loglevel";
 import { DeletionOnRemote, MetadataOnRemote } from "./metadataOnRemote";
 import { SyncAlgoV2Modal } from "./syncAlgoV2Notice";
-const log = origLog.getLogger("rs-default");
+import { applyPresetRulesInplace } from "./presetRules";
+
+import { applyLogWriterInplace, log } from "./moreOnLog";
+import AggregateError from "aggregate-error";
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   s3: DEFAULT_S3_CONFIG,
@@ -69,6 +74,7 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   syncConfigDir: false,
   syncUnderscoreItems: false,
   lang: "auto",
+  logToDB: false,
 };
 
 interface OAuth2Info {
@@ -342,10 +348,16 @@ export default class RemotelySavePlugin extends Plugin {
         triggerSource: triggerSource,
         syncStatus: this.syncStatus,
       });
-      log.info(msg);
+      log.error(msg);
-      log.info(error);
+      log.error(error);
       getNotice(msg, 10 * 1000);
+      if (error instanceof AggregateError) {
+        for (const e of error.errors) {
+          getNotice(e.message, 10 * 1000);
+        }
+      } else {
         getNotice(error.message, 10 * 1000);
+      }
       this.syncStatus = "idle";
       if (this.syncRibbon !== undefined) {
         setIcon(this.syncRibbon, iconNameSyncWait);
@@ -373,6 +385,7 @@ export default class RemotelySavePlugin extends Plugin {
     this.currSyncMsg = "";
 
     await this.loadSettings();
+    await this.checkIfPresetRulesFollowed();
 
     // lang should be load early, but after settings
     this.i18n = new I18n(this.settings.lang, async (lang: LangTypeAndAuto) => {
@@ -410,6 +423,13 @@ export default class RemotelySavePlugin extends Plugin {
       throw err;
     }
 
+    // must AFTER preparing DB
+    this.addOutputToDBIfSet();
+    this.enableAutoClearOutputToDBHistIfSet();
+
+    // must AFTER preparing DB
+    this.enableAutoClearSyncPlanHist();
+
     this.syncStatus = "idle";
 
     this.registerEvent(
@@ -706,6 +726,13 @@ export default class RemotelySavePlugin extends Plugin {
     }
   }
 
+  async checkIfPresetRulesFollowed() {
+    const res = applyPresetRulesInplace(this.settings);
+    if (res.changed) {
+      await this.saveSettings();
+    }
+  }
+
   async saveSettings() {
     await this.saveData(normalConfigToMessy(this.settings));
   }
@@ -869,6 +896,13 @@ export default class RemotelySavePlugin extends Plugin {
     this.currSyncMsg = msg;
   }
 
+  /**
+   * Because data.json contains sensitive information,
+   * We usually want to ignore it in the version control.
+   * However, if there's already a an ignore file (even empty),
+   * we respect the existing configure and not add any modifications.
+   * @returns
+   */
   async tryToAddIgnoreFile() {
     const pluginConfigDir =
       this.manifest.dir ||
@@ -886,15 +920,7 @@ export default class RemotelySavePlugin extends Plugin {
     const contentText = "data.json\n";
 
     try {
-      if (ignoreFileExists) {
+      if (!ignoreFileExists) {
-        // check empty, if empty, we can write it
-        // if not empty, we do nothing
-        const content = (await this.app.vault.adapter.read(ignoreFile)).trim();
-        if (content === "") {
-          // no need to await writing
-          this.app.vault.adapter.write(ignoreFile, contentText);
-        }
-      } else {
         // not exists, directly create
         // no need to await
         this.app.vault.adapter.write(ignoreFile, contentText);
@@ -903,4 +929,52 @@ export default class RemotelySavePlugin extends Plugin {
       // just skip
     }
   }
+
+  addOutputToDBIfSet() {
+    if (this.settings.logToDB) {
+      applyLogWriterInplace((...msg: any[]) => {
+        insertLoggerOutputByVault(this.db, this.vaultRandomID, ...msg);
+      });
+    }
+  }
+
+  enableAutoClearOutputToDBHistIfSet() {
+    const initClearOutputToDBHistAfterMilliseconds = 1000 * 45;
+    const autoClearOutputToDBHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, initClearOutputToDBHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        if (this.settings.logToDB) {
+          clearExpiredLoggerOutputRecords(this.db);
+        }
+      }, autoClearOutputToDBHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
+
+  enableAutoClearSyncPlanHist() {
+    const initClearSyncPlanHistAfterMilliseconds = 1000 * 45;
+    const autoClearSyncPlanHistAfterMilliseconds = 1000 * 60 * 5;
+
+    this.app.workspace.onLayoutReady(() => {
+      // init run
+      window.setTimeout(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, initClearSyncPlanHistAfterMilliseconds);
+
+      // scheduled run
+      const intervalID = window.setInterval(() => {
+        clearExpiredSyncPlanRecords(this.db);
+      }, autoClearSyncPlanHistAfterMilliseconds);
+      this.registerInterval(intervalID);
+    });
+  }
 }

src/misc.ts

@@ -4,8 +4,13 @@ import * as path from "path";
 import { base32, base64url } from "rfc4648";
 import XRegExp from "xregexp";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
+
+declare global {
+  interface Window {
+    moment: (...data: any) => any;
+  }
+}
 
 /**
  * If any part of the file starts with '.' or '_' then it's a hidden file.
@@ -303,3 +308,74 @@ export const atWhichLevel = (x: string) => {
 export const checkHasSpecialCharForDir = (x: string) => {
   return /[?/\\]/.test(x);
 };
+
+export const unixTimeToStr = (x: number | undefined | null) => {
+  if (x === undefined) {
+    return undefined;
+  }
+  if (x === null) {
+    return null;
+  }
+  return window.moment(x).format() as string;
+};
+
+/**
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value#examples
+ * @returns
+ */
+const getCircularReplacer = () => {
+  const seen = new WeakSet();
+  return (key: any, value: any) => {
+    if (typeof value === "object" && value !== null) {
+      if (seen.has(value)) {
+        return;
+      }
+      seen.add(value);
+    }
+    return value;
+  };
+};
+
+/**
+ * Convert "any" value to string.
+ * @param x
+ * @returns
+ */
+export const toText = (x: any) => {
+  if (x === undefined || x === null) {
+    return `${x}`;
+  }
+  if (typeof x === "string") {
+    return x;
+  }
+  if (
+    x instanceof String ||
+    x instanceof Date ||
+    typeof x === "number" ||
+    typeof x === "bigint" ||
+    typeof x === "boolean"
+  ) {
+    return `${x}`;
+  }
+
+  if (
+    x instanceof Error ||
+    (x &&
+      x.stack &&
+      x.message &&
+      typeof x.stack === "string" &&
+      typeof x.message === "string")
+  ) {
+    return `ERROR! MESSAGE: ${x.message}, STACK: ${x.stack}`;
+  }
+
+  try {
+    const y = JSON.stringify(x, getCircularReplacer(), 2);
+    if (y !== undefined) {
+      return y;
+    }
+    throw new Error("not jsonable");
+  } catch {
+    return `${x}`;
+  }
+};

src/moreOnLog.ts

@@ -0,0 +1,34 @@
+// It's very dangerous for this file to depend on other files in the same project.
+// We should avoid this situation as much as possible.
+
+import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
+
+import * as origLog from "loglevel";
+import type { LogLevelNumbers, Logger, LogLevel, LogLevelDesc } from "loglevel";
+const log2 = origLog.getLogger("rs-default");
+
+const originalFactory = log2.methodFactory;
+
+export const applyLogWriterInplace = function (writer: (...msg: any[]) => any) {
+  log2.methodFactory = function (
+    methodName: string,
+    logLevel: LogLevelNumbers,
+    loggerName: string | symbol
+  ) {
+    const rawMethod = originalFactory(methodName, logLevel, loggerName);
+
+    return function (...msg: any[]) {
+      rawMethod.apply(undefined, msg);
+      writer(...msg);
+    };
+  };
+
+  log2.setLevel(log2.getLevel());
+};
+
+export const restoreLogWritterInplace = () => {
+  log2.methodFactory = originalFactory;
+  log2.setLevel(log2.getLevel());
+};
+
+export const log = log2;

src/obsFolderLister.ts

@@ -3,9 +3,6 @@ import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
 import flatten from "lodash/flatten";
 
-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
-
 export interface ObsConfigDirFileType {
   key: string;
   ctime: number;

src/presetRules.ts

@@ -0,0 +1,69 @@
+import type {
+  RemotelySavePluginSettings,
+  WebdavConfig,
+  WebdavDepthType,
+} from "./baseTypes";
+
+const RULES = {
+  webdav: {
+    depth: [
+      {
+        url: "^https://(.+).teracloud.jp/.+",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+      {
+        url: "^https://dav.jianguoyun.com/dav/",
+        depth: "auto_1",
+        manualRecursive: true,
+      },
+    ],
+  },
+};
+
+export const applyWebdavPresetRulesInplace = (
+  webdav: Partial<WebdavConfig> | undefined
+) => {
+  if (webdav === undefined) {
+    return {
+      changed: false,
+      webdav: webdav,
+    };
+  }
+  for (const { url, depth, manualRecursive } of RULES.webdav.depth) {
+    if (
+      webdav.address !== undefined &&
+      new RegExp(url).test(webdav.address) &&
+      webdav.depth !== undefined &&
+      webdav.depth.startsWith("auto_") &&
+      webdav.depth !== depth
+    ) {
+      webdav.depth = depth as WebdavDepthType;
+      webdav.manualRecursive = manualRecursive;
+      return {
+        changed: true,
+        webdav: webdav,
+      };
+    }
+  }
+  return {
+    changed: false,
+    webdav: webdav,
+  };
+};
+
+export const applyPresetRulesInplace = (
+  settings: RemotelySavePluginSettings | undefined
+) => {
+  if (settings === undefined) {
+    return {
+      changed: false,
+      settings: settings,
+    };
+  }
+  const webdavRes = applyWebdavPresetRulesInplace(settings.webdav);
+  return {
+    changed: webdavRes.changed,
+    settings: settings,
+  };
+};

src/remote.ts

@@ -11,8 +11,7 @@ import * as onedrive from "./remoteForOnedrive";
 import * as s3 from "./remoteForS3";
 import * as webdav from "./remoteForWebdav";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export class RemoteClient {
   readonly serviceType: SUPPORTED_SERVICES_TYPE;

src/remoteForDropbox.ts

@@ -12,8 +12,7 @@ import { bufferToArrayBuffer, getFolderLevels, mkdirpInVault } from "./misc";
 
 export { Dropbox } from "dropbox";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export const DEFAULT_DROPBOX_CONFIG: DropboxConfig = {
   accessToken: "",

src/remoteForOnedrive.ts

@@ -6,7 +6,6 @@ import type {
   User,
 } from "@microsoft/microsoft-graph-types";
 import cloneDeep from "lodash/cloneDeep";
-import * as origLog from "loglevel";
 import { request, requestUrl, requireApiVersion, Vault } from "obsidian";
 import {
   API_VER_REQURL,
@@ -24,7 +23,7 @@ import {
   mkdirpInVault,
 } from "./misc";
 
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 const SCOPES = ["User.Read", "Files.ReadWrite.AppFolder", "offline_access"];
 const REDIRECT_URI = `obsidian://${COMMAND_CALLBACK_ONEDRIVE}`;

src/remoteForS3.ts

@@ -39,8 +39,7 @@ import {
 
 export { S3Client } from "@aws-sdk/client-s3";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 ////////////////////////////////////////////////////////////////////////////////
 // special handler using Obsidian requestUrl

src/remoteForWebdav.ts

@@ -9,8 +9,7 @@ import { RemoteItem, VALID_REQURL, WebdavConfig } from "./baseTypes";
 import { decryptArrayBuffer, encryptArrayBuffer } from "./encrypt";
 import { bufferToArrayBuffer, getPathFolder, mkdirpInVault } from "./misc";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 import type {
   FileStat,

src/settings.ts

@@ -9,18 +9,25 @@ import {
 } from "obsidian";
 import {
   API_VER_REQURL,
+  DEFAULT_DEBUG_FOLDER,
   SUPPORTED_SERVICES_TYPE,
   SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR,
   VALID_REQURL,
   WebdavAuthType,
   WebdavDepthType,
 } from "./baseTypes";
-import { exportVaultSyncPlansToFiles } from "./debugMode";
+import {
+  exportVaultSyncPlansToFiles,
+  exportVaultLoggerOutputToFiles,
+} from "./debugMode";
 import { exportQrCodeUri } from "./importExport";
 import {
   clearAllSyncMetaMapping,
   clearAllSyncPlanRecords,
   destroyDBs,
+  clearAllLoggerOutputRecords,
+  insertLoggerOutputByVault,
+  clearExpiredLoggerOutputRecords,
 } from "./localdb";
 import type RemotelySavePlugin from "./main"; // unavoidable
 import { RemoteClient } from "./remote";
@@ -36,10 +43,14 @@ import {
 } from "./remoteForOnedrive";
 import { messyConfigToNormal } from "./configPersist";
 import type { TransItemType } from "./i18n";
-
-import * as origLog from "loglevel";
 import { checkHasSpecialCharForDir } from "./misc";
-const log = origLog.getLogger("rs-default");
+import { applyWebdavPresetRulesInplace } from "./presetRules";
+
+import {
+  applyLogWriterInplace,
+  log,
+  restoreLogWritterInplace,
+} from "./moreOnLog";
 
 class PasswordModal extends Modal {
   plugin: RemotelySavePlugin;
@@ -1323,6 +1334,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             ) {
               this.plugin.settings.webdav.depth = "auto_unknown";
             }
+
+            // TODO: any more elegant way?
+            applyWebdavPresetRulesInplace(this.plugin.settings.webdav);
+
+            // normally saved
             await this.plugin.saveSettings();
           })
       );
@@ -1420,6 +1436,11 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             this.plugin.settings.webdav.depth = "manual_infinity";
             this.plugin.settings.webdav.manualRecursive = false;
           }
+
+          // TODO: any more elegant way?
+          applyWebdavPresetRulesInplace(this.plugin.settings.webdav);
+
+          // normally save
           await this.plugin.saveSettings();
         });
       });
@@ -1691,6 +1712,64 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         });
       });
 
+    const logToDBDiv = debugDiv.createEl("div");
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodb"))
+      .setDesc(t("settings_logtodb_desc"))
+      .addDropdown(async (dropdown) => {
+        dropdown.addOption("enable", t("enable"));
+        dropdown.addOption("disable", t("disable"));
+        dropdown
+          .setValue(this.plugin.settings.logToDB ? "enable" : "disable")
+          .onChange(async (val: string) => {
+            const logToDB = val === "enable";
+            if (logToDB) {
+              applyLogWriterInplace((...msg: any[]) => {
+                insertLoggerOutputByVault(
+                  this.plugin.db,
+                  this.plugin.vaultRandomID,
+                  ...msg
+                );
+              });
+            } else {
+              restoreLogWritterInplace();
+            }
+            clearExpiredLoggerOutputRecords(this.plugin.db);
+            this.plugin.settings.logToDB = logToDB;
+            await this.plugin.saveSettings();
+          });
+      });
+
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodbexport"))
+      .setDesc(
+        t("settings_logtodbexport_desc", {
+          debugFolder: DEFAULT_DEBUG_FOLDER,
+        })
+      )
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_logtodbexport_button"));
+        button.onClick(async () => {
+          await exportVaultLoggerOutputToFiles(
+            this.plugin.db,
+            this.app.vault,
+            this.plugin.vaultRandomID
+          );
+          new Notice(t("settings_logtodbexport_notice"));
+        });
+      });
+
+    new Setting(logToDBDiv)
+      .setName(t("settings_logtodbclear"))
+      .setDesc(t("settings_logtodbclear_desc"))
+      .addButton(async (button) => {
+        button.setButtonText(t("settings_logtodbclear_button"));
+        button.onClick(async () => {
+          await clearAllLoggerOutputRecords(this.plugin.db);
+          new Notice(t("settings_logtodbclear_notice"));
+        });
+      });
+
     const syncMappingDiv = debugDiv.createEl("div");
     new Setting(syncMappingDiv)
       .setName(t("settings_delsyncmap"))

src/sync.ts

@@ -5,6 +5,7 @@ import {
   Vault,
   requireApiVersion,
 } from "obsidian";
+import AggregateError from "aggregate-error";
 import PQueue from "p-queue";
 import {
   RemoteItem,
@@ -33,6 +34,7 @@ import {
   getFolderLevels,
   getParentFolder,
   atWhichLevel,
+  unixTimeToStr,
 } from "./misc";
 import { RemoteClient } from "./remote";
 import {
@@ -46,8 +48,7 @@ import {
 } from "./metadataOnRemote";
 import { isInsideObsFolder, ObsConfigDirFileType } from "./obsFolderLister";
 
-import * as origLog from "loglevel";
+import { log } from "./moreOnLog";
-const log = origLog.getLogger("rs-default");
 
 export type SyncStatusType =
   | "idle"
@@ -63,6 +64,7 @@ export type SyncStatusType =
 
 export interface SyncPlanType {
   ts: number;
+  tsFmt?: string;
   remoteType: SUPPORTED_SERVICES_TYPE;
   mixedStates: Record<string, FileOrFolderMixedState>;
 }
@@ -212,10 +214,12 @@ export const parseRemoteItems = async (
     let r = {} as FileOrFolderMixedState;
     if (backwardMapping !== undefined) {
       key = backwardMapping.localKey;
+      const mtimeRemote = backwardMapping.localMtime || entry.lastModified;
       r = {
         key: key,
         existRemote: true,
-        mtimeRemote: backwardMapping.localMtime || entry.lastModified,
+        mtimeRemote: mtimeRemote,
+        mtimeRemoteFmt: unixTimeToStr(mtimeRemote),
         sizeRemote: backwardMapping.localSize || entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
         changeRemoteMtimeUsingMapping: true,
@@ -225,6 +229,7 @@ export const parseRemoteItems = async (
         key: key,
         existRemote: true,
         mtimeRemote: entry.lastModified,
+        mtimeRemoteFmt: unixTimeToStr(entry.lastModified),
         sizeRemote: entry.size,
         remoteEncryptedKey: remoteEncryptedKey,
         changeRemoteMtimeUsingMapping: false,
@@ -320,10 +325,12 @@ const ensembleMixedStates = async (
       // ignore
       continue;
     } else if (entry instanceof TFile) {
+      const mtimeLocal = Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0);
       r = {
         key: entry.path,
         existLocal: true,
-        mtimeLocal: Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.stat.size,
       };
     } else if (entry instanceof TFolder) {
@@ -332,6 +339,7 @@ const ensembleMixedStates = async (
         key: key,
         existLocal: true,
         mtimeLocal: undefined,
+        mtimeLocalFmt: undefined,
         sizeLocal: 0,
       };
     } else {
@@ -346,6 +354,7 @@ const ensembleMixedStates = async (
       results[key].key = r.key;
       results[key].existLocal = r.existLocal;
       results[key].mtimeLocal = r.mtimeLocal;
+      results[key].mtimeLocalFmt = r.mtimeLocalFmt;
       results[key].sizeLocal = r.sizeLocal;
     } else {
       results[key] = r;
@@ -356,10 +365,12 @@ const ensembleMixedStates = async (
   if (syncConfigDir && localConfigDirContents !== undefined) {
     for (const entry of localConfigDirContents) {
       const key = entry.key;
+      const mtimeLocal = Math.max(entry.mtime, entry.ctime);
       const r: FileOrFolderMixedState = {
         key: key,
         existLocal: true,
-        mtimeLocal: Math.max(entry.mtime, entry.ctime),
+        mtimeLocal: mtimeLocal,
+        mtimeLocalFmt: unixTimeToStr(mtimeLocal),
         sizeLocal: entry.size,
       };
 
@@ -367,6 +378,7 @@ const ensembleMixedStates = async (
         results[key].key = r.key;
         results[key].existLocal = r.existLocal;
         results[key].mtimeLocal = r.mtimeLocal;
+        results[key].mtimeLocalFmt = r.mtimeLocalFmt;
         results[key].sizeLocal = r.sizeLocal;
       } else {
         results[key] = r;
@@ -380,6 +392,7 @@ const ensembleMixedStates = async (
     const r = {
       key: key,
       deltimeRemote: entry.actionWhen,
+      deltimeRemoteFmt: unixTimeToStr(entry.actionWhen),
     } as FileOrFolderMixedState;
 
     if (isSkipItem(key, syncConfigDir, syncUnderscoreItems, configDir)) {
@@ -389,6 +402,7 @@ const ensembleMixedStates = async (
     if (results.hasOwnProperty(key)) {
       results[key].key = r.key;
       results[key].deltimeRemote = r.deltimeRemote;
+      results[key].deltimeRemoteFmt = r.deltimeRemoteFmt;
     } else {
       results[key] = r;
 
@@ -417,10 +431,12 @@ const ensembleMixedStates = async (
       const r = {
         key: key,
         deltimeLocal: entry.actionWhen,
+        deltimeLocalFmt: unixTimeToStr(entry.actionWhen),
       } as FileOrFolderMixedState;
 
       if (results.hasOwnProperty(key)) {
         results[key].deltimeLocal = r.deltimeLocal;
+        results[key].deltimeLocalFmt = r.deltimeLocalFmt;
       } else {
         results[key] = r;
         results[key].existLocal = false; // we have already checked local
@@ -430,13 +446,16 @@ const ensembleMixedStates = async (
       const r = {
         key: key,
         mtimeLocal: entry.actionWhen,
+        mtimeLocalFmt: unixTimeToStr(entry.actionWhen),
         changeLocalMtimeUsingMapping: true,
       };
       if (results.hasOwnProperty(key)) {
-        results[key].mtimeLocal = Math.max(
+        const mtimeLocal = Math.max(
           r.mtimeLocal || 0,
           results[key].mtimeLocal || 0
         );
+        results[key].mtimeLocal = mtimeLocal;
+        results[key].mtimeLocalFmt = unixTimeToStr(mtimeLocal);
         results[key].changeLocalMtimeUsingMapping =
           r.changeLocalMtimeUsingMapping;
       } else {
@@ -793,8 +812,11 @@ export const getSyncPlan = async (
     }
   }
 
+  const currTs = Date.now();
+  const currTsFmt = unixTimeToStr(currTs);
   const plan = {
-    ts: Date.now(),
+    ts: currTs,
+    tsFmt: currTsFmt,
     remoteType: remoteType,
     mixedStates: mixedStates,
   } as SyncPlanType;
@@ -1135,6 +1157,8 @@ export const doActualSync = async (
       }
 
       const queue = new PQueue({ concurrency: concurrency, autoStart: true });
+      const potentialErrors: Error[] = [];
+      let tooManyErrors = false;
 
       for (let k = 0; k < singleLevelOps.length; ++k) {
         const val: FileOrFolderMixedState = singleLevelOps[k];
@@ -1167,10 +1191,28 @@ export const doActualSync = async (
 
           log.debug(`finished ${key}`);
         };
-        queue.add(fn);
+
+        queue.add(fn).catch((e) => {
+          const msg = `${key}: ${e.message}`;
+          potentialErrors.push(new Error(msg));
+          if (potentialErrors.length >= 3) {
+            tooManyErrors = true;
+            queue.pause();
+            queue.clear();
+          }
+        });
       }
 
       await queue.onIdle();
+
+      if (potentialErrors.length > 0) {
+        if (tooManyErrors) {
+          potentialErrors.push(
+            new Error("too many errors, stop the remaining tasks")
+          );
+        }
+        throw new AggregateError(potentialErrors);
+      }
     }
   }
 };

src/syncAlgoV2Notice.ts

@@ -1,8 +1,8 @@
 import { App, Modal, Notice, PluginSettingTab, Setting } from "obsidian";
 import type RemotelySavePlugin from "./main"; // unavoidable
 import type { TransItemType } from "./i18n";
-import * as origLog from "loglevel";
+
-const log = origLog.getLogger("rs-default");
+import { log } from "./moreOnLog";
 
 export class SyncAlgoV2Modal extends Modal {
   agree: boolean;

tests/presetRules.test.ts

@@ -0,0 +1,111 @@
+import { expect } from "chai";
+import type { WebdavConfig } from "../src/baseTypes";
+import { applyWebdavPresetRulesInplace } from "../src/presetRules";
+
+describe("Preset rules tests", () => {
+  it("should check undefined correctly", () => {
+    let x: Partial<WebdavConfig> | undefined = undefined;
+    const y = applyWebdavPresetRulesInplace(x);
+    expect(y.webdav === undefined);
+    expect(!y.changed);
+  });
+
+  it("should check empty object", () => {
+    let x: Partial<WebdavConfig> | undefined = {};
+    const y = applyWebdavPresetRulesInplace(x);
+    expect(y.webdav).deep.equals({});
+    expect(!y.changed);
+  });
+
+  it("should modify depths correctly", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://example.teracloud.jp/dav/",
+      depth: "auto_unknown",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://example.teracloud.jp/dav/example",
+      depth: "auto_unknown",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_unknown",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_infinity",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(y.changed);
+  });
+
+  it("should not modify depths if depths is set automatically correctly", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "auto_1",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_1");
+    expect(!y.changed);
+  });
+
+  it("should not modify depths if depths have been set manually", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://example.teracloud.jp/dav/",
+      depth: "manual_infinity",
+    };
+    let y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "manual_infinity");
+    expect(!y.changed);
+
+    x = {
+      address: "https://example.teracloud.jp/dav/example",
+      depth: "manual_1",
+    };
+    y = applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "manual_1");
+    expect(!y.changed);
+  });
+
+  it("should not modify depths when urls are not in preset rules", () => {
+    let x: Partial<WebdavConfig> = {
+      address: "https://teracloud.jp/dav/",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav_example",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "",
+      depth: "auto_unknown",
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === "auto_unknown");
+
+    x = {
+      address: "https://dav.jianguoyun.com/dav/",
+      depth: "what" as any,
+    };
+    applyWebdavPresetRulesInplace(x);
+    expect(x.depth === ("what" as any));
+  });
+});

versions.json

@@ -1,4 +1,4 @@
 {
   "0.3.2": "0.12.15",
-  "0.3.16": "0.13.21"
+  "0.3.17": "0.13.21"
 }