From 583b365e723263d973f66a861057d88365a121cb Mon Sep 17 00:00:00 2001
From: fyears <1142836+fyears@users.noreply.github.com>
Date: Wed, 3 Apr 2024 00:21:43 +0800
Subject: [PATCH] optimize export sync plans, and clear too many sync plans
---
src/debugMode.ts | 18 ++++++++++++++----
src/langs/en.json | 9 +++++++--
src/langs/zh_cn.json | 7 ++++++-
src/langs/zh_tw.json | 8 ++++++--
src/localdb.ts | 6 +++---
src/main.ts | 37 ++++++++++++++++++++++++++++++++++---
src/settings.ts | 29 +++++++++++++++++++++++++++--
7 files changed, 97 insertions(+), 17 deletions(-)
diff --git a/src/debugMode.ts b/src/debugMode.ts
index d873ca5..5b2e8bd 100644
--- a/src/debugMode.ts
+++ b/src/debugMode.ts
@@ -73,7 +73,8 @@ const turnSyncPlanToTable = (record: string) => {
export const exportVaultSyncPlansToFiles = async (
db: InternalDBs,
vault: Vault,
- vaultRandomID: string
+ vaultRandomID: string,
+ howMany: number
) => {
console.info("exporting");
await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
@@ -82,9 +83,18 @@ export const exportVaultSyncPlansToFiles = async (
if (records.length === 0) {
md = "No sync plans history found";
} else {
- md =
- "Sync plans found:\n\n" +
- records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+ if (howMany <= 0) {
+ md =
+ "Sync plans found:\n\n" +
+ records.map((x) => "```json\n" + x + "\n```\n").join("\n");
+ } else {
+ md =
+ "Sync plans found:\n\n" +
+ records
+ .map((x) => "```json\n" + x + "\n```\n")
+ .slice(0, howMany)
+ .join("\n");
+ }
}
const ts = Date.now();
const filePath = `${DEFAULT_DEBUG_FOLDER}${DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX}${ts}.md`;
diff --git a/src/langs/en.json b/src/langs/en.json
index 936e015..b64b19f 100644
--- a/src/langs/en.json
+++ b/src/langs/en.json
@@ -38,7 +38,10 @@
"protocol_onedrive_connect_unknown": "Do not know how to deal with the callback: {{params}}",
"command_startsync": "start sync",
"command_drynrun": "start sync (dry run only)",
- "command_exportsyncplans_json": "export sync plans in json format",
+ "command_exportsyncplans_1": "export sync plans (latest 1)",
+ "command_exportsyncplans_5": "export sync plans (latest 5)",
+ "command_exportsyncplans_all": "export sync plans (all)",
+
"command_exportlogsindb": "export logs saved in db",
"statusbar_time_years": "Synced {{time}} years ago",
@@ -292,7 +295,9 @@
"settings_viewconsolelog_desc": "On desktop, please press \"ctrl+shift+i\" or \"cmd+shift+i\" to view the log. On mobile, please install the third-party plugin Logstravaganza to export the console log to a note.",
"settings_syncplans": "Export Sync Plans",
"settings_syncplans_desc": "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync. Click the button to export sync plans.",
- "settings_syncplans_button_json": "Export",
+ "settings_syncplans_button_1": "Export latest 1",
+ "settings_syncplans_button_5": "Export latest 5",
+ "settings_syncplans_button_all": "Export All",
"settings_syncplans_notice": "Sync plans history exported.",
"settings_delsyncplans": "Delete Sync Plans History In DB",
"settings_delsyncplans_desc": "Delete sync plans history in DB.",
diff --git a/src/langs/zh_cn.json b/src/langs/zh_cn.json
index dd83c7b..76b1d50 100644
--- a/src/langs/zh_cn.json
+++ b/src/langs/zh_cn.json
@@ -39,6 +39,9 @@
"command_startsync": "开始同步(start sync)",
"command_drynrun": "开始同步(空跑模式)(start sync (dry run only))",
"command_exportsyncplans_json": "导出同步计划为 json 格式(export sync plans in json format)",
+ "command_exportsyncplans_1": "导出同步计划(最近 1 次)(export sync plans (latest 1))",
+ "command_exportsyncplans_5": "导出同步计划(最近 5 次)(export sync plans (latest 5))",
+ "command_exportsyncplans_all": "导出同步计划(所有)(export sync plans (all))",
"command_exportlogsindb": "从数据库导出终端日志(export logs saved in db)",
"statusbar_time_years": "{{time}} 年前同步",
@@ -291,7 +294,9 @@
"settings_viewconsolelog_desc": "电脑上,输入“ctrl+shift+i”或“cmd+shift+i”来查看终端输出。手机上,安装第三方插件 Logstravaganza 来导出终端输出到一篇笔记上。",
"settings_syncplans": "导出同步计划",
"settings_syncplans_desc": "每次您启动同步,并在实际上传下载前,插件会生成同步计划。它可以使您知道每次同步发生了什么。点击按钮可以导出同步计划。",
- "settings_syncplans_button_json": "导出",
+ "settings_syncplans_button_1": "导出最近 1 次",
+ "settings_syncplans_button_5": "导出最近 5 次",
+ "settings_syncplans_button_all": "导出所有",
"settings_syncplans_notice": "同步计划已导出",
"settings_delsyncplans": "删除数据库里的同步计划历史",
"settings_delsyncplans_desc": "删除数据库里的同步计划历史。",
diff --git a/src/langs/zh_tw.json b/src/langs/zh_tw.json
index 7b87e9e..1bdb4cb 100644
--- a/src/langs/zh_tw.json
+++ b/src/langs/zh_tw.json
@@ -38,7 +38,9 @@
"protocol_onedrive_connect_unknown": "不知道如何處理此 callback:{{params}}",
"command_startsync": "開始同步(start sync)",
"command_drynrun": "開始同步(空跑模式)(start sync (dry run only))",
- "command_exportsyncplans_json": "匯出同步計劃為 json 格式(export sync plans in json format)",
+ "command_exportsyncplans_1": "匯出同步計劃(最近 1 次)(export sync plans (latest 1))",
+ "command_exportsyncplans_5": "匯出同步計劃(最近 5 次)(export sync plans (latest 5))",
+ "command_exportsyncplans_all": "匯出同步計劃(所有)(export sync plans (all))",
"command_exportlogsindb": "從資料庫匯出終端日誌(export logs saved in db)",
"statusbar_time_years": "{{time}} 年前同步",
@@ -291,7 +293,9 @@
"settings_viewconsolelog_desc": "電腦上,輸入“ctrl+shift+i”或“cmd+shift+i”來檢視終端輸出。手機上,安裝第三方外掛 Logstravaganza 來匯出終端輸出到一篇筆記上。",
"settings_syncplans": "匯出同步計劃",
"settings_syncplans_desc": "每次您啟動同步,並在實際上傳下載前,外掛會生成同步計劃。它可以使您知道每次同步發生了什麼。點選按鈕可以匯出同步計劃。",
- "settings_syncplans_button_json": "匯出",
+ "settings_syncplans_button_1": "匯出最近 1 次",
+ "settings_syncplans_button_5": "匯出最近 5 次",
+ "settings_syncplans_button_all": "匯出所有",
"settings_syncplans_notice": "同步計劃已匯出",
"settings_delsyncplans": "刪除資料庫裡的同步計劃歷史",
"settings_delsyncplans_desc": "刪除資料庫裡的同步計劃歷史。",
diff --git a/src/localdb.ts b/src/localdb.ts
index a874096..1e87a44 100644
--- a/src/localdb.ts
+++ b/src/localdb.ts
@@ -382,13 +382,13 @@ export const readAllSyncPlanRecordTextsByVault = async (
};
/**
- * We remove records that are older than 3 days or 100 records.
+ * We remove records that are older than 1 days or 20 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 * 3; // 3 days
- const COUNT_TO_MANY = 100;
+ const MILLISECONDS_OLD = 1000 * 60 * 60 * 24 * 1; // 1 days
+ const COUNT_TO_MANY = 20;
const currTs = Date.now();
const expiredTs = currTs - MILLISECONDS_OLD;
diff --git a/src/main.ts b/src/main.ts
index 4e2abd4..e5ceb78 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -782,14 +782,45 @@ export default class RemotelySavePlugin extends Plugin {
});
this.addCommand({
- id: "export-sync-plans-json",
- name: t("command_exportsyncplans_json"),
+ id: "export-sync-plans-1",
+ name: t("command_exportsyncplans_1"),
icon: iconNameLogs,
callback: async () => {
await exportVaultSyncPlansToFiles(
this.db,
this.app.vault,
- this.vaultRandomID
+ this.vaultRandomID,
+ 1
+ );
+ new Notice(t("settings_syncplans_notice"));
+ },
+ });
+
+ this.addCommand({
+ id: "export-sync-plans-5",
+ name: t("command_exportsyncplans_5"),
+ icon: iconNameLogs,
+ callback: async () => {
+ await exportVaultSyncPlansToFiles(
+ this.db,
+ this.app.vault,
+ this.vaultRandomID,
+ 5
+ );
+ new Notice(t("settings_syncplans_notice"));
+ },
+ });
+
+ this.addCommand({
+ id: "export-sync-plans-all",
+ name: t("command_exportsyncplans_all"),
+ icon: iconNameLogs,
+ callback: async () => {
+ await exportVaultSyncPlansToFiles(
+ this.db,
+ this.app.vault,
+ this.vaultRandomID,
+ -1
);
new Notice(t("settings_syncplans_notice"));
},
diff --git a/src/settings.ts b/src/settings.ts
index cef8edc..4c19202 100644
--- a/src/settings.ts
+++ b/src/settings.ts
@@ -2204,12 +2204,37 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
.setName(t("settings_syncplans"))
.setDesc(t("settings_syncplans_desc"))
.addButton(async (button) => {
- button.setButtonText(t("settings_syncplans_button_json"));
+ button.setButtonText(t("settings_syncplans_button_1"));
button.onClick(async () => {
await exportVaultSyncPlansToFiles(
this.plugin.db,
this.app.vault,
- this.plugin.vaultRandomID
+ this.plugin.vaultRandomID,
+ 1
+ );
+ new Notice(t("settings_syncplans_notice"));
+ });
+ })
+ .addButton(async (button) => {
+ button.setButtonText(t("settings_syncplans_button_5"));
+ button.onClick(async () => {
+ await exportVaultSyncPlansToFiles(
+ this.plugin.db,
+ this.app.vault,
+ this.plugin.vaultRandomID,
+ 5
+ );
+ new Notice(t("settings_syncplans_notice"));
+ });
+ })
+ .addButton(async (button) => {
+ button.setButtonText(t("settings_syncplans_button_all"));
+ button.onClick(async () => {
+ await exportVaultSyncPlansToFiles(
+ this.plugin.db,
+ this.app.vault,
+ this.plugin.vaultRandomID,
+ -1
);
new Notice(t("settings_syncplans_notice"));
});