fix: schedule new automatic after it finishes

close #851

Author: Vinzent03

src/automaticsManager.ts

@@ -2,9 +2,9 @@ import { debounce } from "obsidian";
 import type ObsidianGit from "./main";
 
 export default class AutomaticsManager {
-    timeoutIDCommitAndSync?: number;
-    timeoutIDPush?: number;
-    timeoutIDPull?: number;
+    private timeoutIDCommitAndSync?: number;
+    private timeoutIDPush?: number;
+    private timeoutIDPull?: number;
 
     constructor(private readonly plugin: ObsidianGit) {}
 
@@ -147,41 +147,55 @@ export default class AutomaticsManager {
 
     // this.plugin is used for both auto commit-and-sync and commit only
     private doAutoCommitAndSync(): void {
-        this.plugin.promiseQueue.addTask(() => {
-            if (this.plugin.settings.differentIntervalCommitAndPush) {
-                return this.plugin.commit({ fromAuto: true });
-            } else {
-                return this.plugin.commitAndSync(true);
+        this.plugin.promiseQueue.addTask(
+            () => {
+                if (this.plugin.settings.differentIntervalCommitAndPush) {
+                    return this.plugin.commit({ fromAuto: true });
+                } else {
+                    return this.plugin.commitAndSync(true);
+                }
+            },
+            () => {
+                this.saveLastAuto(new Date(), "backup");
+                this.startAutoCommitAndSync();
             }
-        });
-        this.saveLastAuto(new Date(), "backup");
-        this.startAutoCommitAndSync();
+        );
     }
 
     private startAutoPull(minutes?: number) {
         let time = (minutes ?? this.plugin.settings.autoPullInterval) * 60000;
         // max timeout in js
         if (time > 2147483647) time = 2147483647;
 
-        this.timeoutIDPull = window.setTimeout(() => {
-            this.plugin.promiseQueue.addTask(() =>
-                this.plugin.pullChangesFromRemote()
-            );
-            this.saveLastAuto(new Date(), "pull");
-            this.startAutoPull();
-        }, time);
+        this.timeoutIDPull = window.setTimeout(() => this.doAutoPull(), time);
+    }
+
+    private doAutoPull(): void {
+        this.plugin.promiseQueue.addTask(
+            () => this.plugin.pullChangesFromRemote(),
+            () => {
+                this.saveLastAuto(new Date(), "pull");
+                this.startAutoPull();
+            }
+        );
     }
 
     private startAutoPush(minutes?: number) {
         let time = (minutes ?? this.plugin.settings.autoPushInterval) * 60000;
         // max timeout in js
         if (time > 2147483647) time = 2147483647;
 
-        this.timeoutIDPush = window.setTimeout(() => {
-            this.plugin.promiseQueue.addTask(() => this.plugin.push());
-            this.saveLastAuto(new Date(), "push");
-            this.startAutoPush();
-        }, time);
+        this.timeoutIDPush = window.setTimeout(() => this.doAutoPush(), time);
+    }
+
+    private doAutoPush(): void {
+        this.plugin.promiseQueue.addTask(
+            () => this.plugin.push(),
+            () => {
+                this.saveLastAuto(new Date(), "push");
+                this.startAutoPush();
+            }
+        );
     }
 
     private clearAutoCommitAndSync(): boolean {

src/promiseQueue.ts

@@ -1,29 +1,40 @@
 import type ObsidianGit from "./main";
 
 export class PromiseQueue {
-    tasks: (() => Promise<unknown>)[] = [];
+    private tasks: {
+        task: () => Promise<unknown>;
+        onFinished: () => void;
+    }[] = [];
 
     constructor(private readonly plugin: ObsidianGit) {}
 
-    addTask(task: () => Promise<unknown>) {
-        this.tasks.push(task);
+    /**
+     * Add a task to the queue.
+     *
+     * @param task The task to add.
+     * @param onFinished A callback that is called when the task is finished. Both on success and on error.
+     */
+    addTask(task: () => Promise<unknown>, onFinished?: () => void): void {
+        this.tasks.push({ task, onFinished: onFinished ?? (() => {}) });
         if (this.tasks.length === 1) {
             this.handleTask();
         }
     }
 
-    handleTask() {
+    private handleTask(): void {
         if (this.tasks.length > 0) {
-            this.tasks[0]()
+            const item = this.tasks[0];
+            item.task()
                 .catch((e) => this.plugin.displayError(e))
                 .finally(() => {
+                    item.onFinished();
                     this.tasks.shift();
                     this.handleTask();
                 });
         }
     }
 
-    clear() {
+    clear(): void {
         this.tasks = [];
     }
 }