feat: converge sync events if overlap

Author: Momik Shrestha

main.ts

@@ -1,8 +1,7 @@
-import {Plugin, addIcon, TFile, debounce} from "obsidian";
+import { Plugin, addIcon, TFile, debounce } from "obsidian";
 import { OnlyEverFileManager as Manager } from "./src/FileCollection/OnlyEverFileManager";
 import { OnlyEverSettingsTab } from "./src/OnlyEverSettingsTab";
-import {OnlyEverSettings} from "./src/interfaces";
-
+import { OnlyEverSettings, WasEditedMap } from "./src/interfaces";
 
 const DEFAULT_SETTINGS: OnlyEverSettings = {
 	apiToken: "",
@@ -15,8 +14,11 @@ const DEFAULT_SETTINGS: OnlyEverSettings = {
 export default class OnlyEverPlugin extends Plugin {
 	settings: OnlyEverSettings;
 	oeFileManager: Manager;
-	previousTab: null | TFile = null;
-	wasEdited: any = {}
+
+	previousTab: TFile;
+	activeTab: TFile;
+	wasEdited: WasEditedMap = {}
+	timeout = 2500;
 
 	async onload() {
 		this.loadIcons();
@@ -27,11 +29,9 @@ export default class OnlyEverPlugin extends Plugin {
 		this.scanVault();
 		this.registerAllEvents();
 
-		await this.oeFileManager.fileProcessor.processMarkedFiles(this.settings);
-
 		this.scheduledSync();
 		this.addSettingTab(new OnlyEverSettingsTab(this.app, this));
-		this.previousTab = this.app.workspace.getActiveFile()
+		this.setPreviousAndActiveTab();
 	}
 
 	async loadSettings() {
@@ -47,10 +47,6 @@ export default class OnlyEverPlugin extends Plugin {
 		this.scanVault();
 	}
 
-	getSettingsValue() {
-		return this.settings.apiToken;
-	}
-
 	private loadHotKeys() {
 		this.addCommand({
 			id: "add-obsidian-sync-true-in-frontmatter",
@@ -104,69 +100,108 @@ export default class OnlyEverPlugin extends Plugin {
 		}, syncIntervalMs);
 	}
 
-	/*
-	 * Registers event and functionality on event
+	/**
+	 * Note by: @PG-Momik
+	 * Obsidian's default 'modify' event is 'throttled' not 'debounced' (I Think)
+	 * The event delay is 2 seconds.
+	 * So we set the debounce interval to time greater than the throttle interval.
 	 */
-	private registerAllEvents() {
+	debouncedSync = debounce(async (file: TFile) => {
+		console.log('debounce sync vitra');
+		if(this.oeFileManager.isSupportedFile(file)){
+			console.log('i will sync now');
+			await this.oeFileManager.fileProcessor.processSingleFile(this.settings, file);
+			this.timeout = 2500;
+		}
+	}, this.timeout, true)
 
-		const debouncedSync = debounce(() => {
-			this.oeFileManager.fileProcessor.processSingleFile(this.settings, this.previousTab)
-		}, 3200, true)
+	debouncedSave = debounce((file: TFile)=>{
+		this.timeout = 0
+		this.wasEdited[file.path] = false;
+		this.debouncedSync(file);
+	}, 500, true);
 
-		/*
+	/**
+	 * Register event and functionality on event
+	 */
+	private registerAllEvents(): void {
+
+		/**
 		 * Registers and handles initial Obsidian open event
 		 */
 		this.registerEvent(
 			// @ts-ignore
-			this.app.workspace.on("layout-ready", () => {
-				this.oeFileManager.fileProcessor.processMarkedFiles(this.settings).then();
-			})
+			// IDE SHOWING ERROR DESPITE THIS CODE WORKING.
+			this.app.workspace.on("layout-ready",
+				() => {
+					this.oeFileManager.fileProcessor.processMarkedFiles(this.settings).then();
+				}
+			)
 		);
 
 		/*
 		 * Registers and handles active note edit event
 		 */
 		this.registerEvent(
-			this.app.vault.on("modify", ()=>{
-				debouncedSync.cancel()
-				debouncedSync();
-			})
+			this.app.vault.on("modify",
+			async (file) => {
+					if (file instanceof TFile) {
+						this.debouncedSync(file as TFile);
+					}
+				}
+			)
 		);
 
-		/*
-		 * Registers and handles vault's note rename event
+		/**
+		 * Registers and handles vault's note rename event.
 		 */
 		this.registerEvent(
-			this.app.vault.on("rename", () => {
-				this.oeFileManager.onActiveFileSaveAction(this.settings).then();
-			})
+			this.app.vault.on("rename",
+			() => {
+					this.oeFileManager.onActiveFileSaveAction(this.settings).then();
+				}
+			)
 		);
 
-		/*
-		 * Registers and handles note save event
+		/**
+		 * Registers and handles note save event.
 		 */
 		const saveCommandDefinition = (this.app as any).commands?.commands?.["editor:save-file"];
 		const save = saveCommandDefinition?.callback;
 
 		if (typeof save === "function") {
 			saveCommandDefinition.callback = async () => {
-				this.oeFileManager.onActiveFileSaveAction(this.settings).then();
+				this.debouncedSave(this.activeTab);
 			};
 		}
 
+		/**
+		 * Registers and handles tab switch event.
+		 */
 		this.registerEvent(
-			this.app.workspace.on('active-leaf-change', () => {
-				if(this.previousTab){
-					const prev = this.previousTab;
-					if(this.wasEdited[prev.name]){
-						debouncedSync.cancel()
-						this.oeFileManager.fileProcessor.processSingleFile(this.settings, this.previousTab)
-
-						this.previousTab = this.app.workspace.getActiveFile()
-						this.wasEdited[prev.name] = false
+			this.app.workspace.on('active-leaf-change',
+				async () => {
+					if (this.oeFileManager.isActualTabChanged(this.previousTab)) {
+						if (this.oeFileManager.fileWasEdited(this.wasEdited, this.previousTab) && this.oeFileManager.isSupportedFile(this.previousTab)) {
+							this.debouncedSync(this.previousTab);
+						}
+
+						this.setPreviousAndActiveTab();
+						this.wasEdited[this.activeTab.path] = false;
 					}
 				}
-			})
+			)
 		);
 	}
+
+	/**
+	 * Set previousTab and activeTab to current open file.
+	 */
+	private setPreviousAndActiveTab(): void {
+		const openFileOnAppOpen  = this.app.workspace.getActiveFile()
+
+		if(openFileOnAppOpen){
+			this.previousTab = this.activeTab = openFileOnAppOpen
+		}
+	}
 }

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "the-only-ever-plugin",
 	"name": "Only Ever",
-	"version": "1.3.8",
+	"version": "1.3.8-converge",
 	"minAppVersion": "0.15.0",
 	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
 	"author": "Obsidian",

src/FileCollection/OnlyEverFileManager.ts

@@ -1,6 +1,6 @@
-import { App, TFile } from "obsidian";
+import {App, TAbstractFile, TFile} from "obsidian";
 import { OnlyEverFileProcessor } from "./OnlyEverFileProcessor";
-import {OnlyEverSettings} from "../interfaces";
+import {OnlyEverSettings, WasEditedMap} from "../interfaces";
 
 class OnlyEverFileManager {
 	app: App;
@@ -16,6 +16,32 @@ class OnlyEverFileManager {
 	async onActiveFileSaveAction(settings:OnlyEverSettings) {
 		this.fileProcessor.processSingleFile(settings);
 	}
+
+	fileWasEdited(wasEditedMap: WasEditedMap, file: TFile|null) {
+		return Boolean(file && file.path && wasEditedMap[file.path]);
+	}
+
+	isSupportedFile(file: TFile | null){
+		if( file ){
+			return file.extension === 'md'
+		}
+
+		return false
+	}
+
+	/*
+	 * Note by @PG-Momik
+	 * Single Clicking item OR drag dropping items from sidebar is considered active-leaf-change.
+	 * So need to check if it's an actual active leaf change event or a false positive.
+	 * So we compare the file path of the supposed new active file and the actual previous file.
+	 *
+	 * @return boolean
+	 */
+	isActualTabChanged(previousTab: TFile): boolean {
+		const newActiveFile = this.app.workspace.getActiveFile();
+
+		return previousTab?.path !== newActiveFile?.path;
+	}
 }
 
 export { OnlyEverFileManager };

src/interfaces.ts

@@ -94,3 +94,7 @@ export interface  SyncImagesResponse extends  OeResponse{
 export interface Siblings {
     [key: string]: Stat
 }
+
+export interface WasEditedMap{
+	[key: string]: boolean
+}