feat(stat): Collect publishing progress data for all touched files. WIP

Author: walkthunder

src/baseTypes.ts

@@ -140,6 +140,13 @@ export type DecisionType =
   | DecisionTypeForFileSize
   | DecisionTypeForFolder;
 
+export type TSyncStatus =
+  | "pending"
+  | "syncing"
+  | "publishing"
+  | "done"
+  | "fail"
+
 export interface FileOrFolderMixedState {
   key: string;
   existLocal?: boolean;
@@ -160,6 +167,9 @@ export interface FileOrFolderMixedState {
   decisionBranch?: number;
   syncDone?: "done";
   remoteEncryptedKey?: string;
+  syncStatus?: TSyncStatus;
+  syncError?: string;
+  publishError?: string;
 
   mtimeLocalFmt?: string;
   mtimeRemoteFmt?: string;

src/exporter.ts

@@ -83,7 +83,8 @@ export const publishFiles = async (
     allFiles: TFile[],
     password: string = "",
     settings: any,
-    triggerSource: string
+    triggerSource: string,
+    cb?: (key: string, status: 'START' | 'DONE' | 'FAIL') => any,
 ) => {
     const htmlPath = AssetHandler.initHtmlPath();
 
@@ -146,6 +147,10 @@ export const publishFiles = async (
         const resPromise = toUploads.map((upload, i) => {
             const htmlFileRelPath = Path.getRelativePathFromVault(new Path(upload.path), true).asString;
             log.info('rel path: ', htmlFileRelPath);
+            if (cb) {
+                const skip = cb(upload.key, 'START');
+                if (skip) return;
+            }
             return client.uploadToRemote(
                 htmlFileRelPath,
                 '',
@@ -159,7 +164,14 @@ export const publishFiles = async (
                 upload.key
             ).then((resp) => {
                 RenderLog.progress(i++, toUploads.length, "Uploading Docs", "Upload success: " + upload.key, "var(--color-accent)");
+                if (cb) {
+                    cb(upload.key, 'DONE');
+                }
                 return resp;
+            }).catch(err => {
+                if (cb) {
+                    cb(upload.key, 'FAIL');
+                }
             })
         })
 
@@ -212,9 +224,25 @@ const getFileFromRemoteKey = (vault: any, filePath: string) => {
 export const unpublishFile = async (
     client: RemoteClient,
     vault: any,
-    path: string
+    path: string,
+    cb?: (key: string, status: 'START' | 'DONE' | 'FAIL') => any,
 ) => {
     const remoteKey = getFileFromRemoteKey(vault, path);
     log.info('deleting.... ', remoteKey);
-    return client.deleteFromRemote(remoteKey, '', '', '');
+    if (cb) {
+        const skip = cb(path, 'START');
+        if (skip) return;
+    }
+    return client.deleteFromRemote(remoteKey, '', '', '')
+        .then(resp => {
+            if (cb) {
+                cb(path, 'DONE');
+            }
+            return resp;
+        })
+        .catch(err => {
+            if (cb) {
+                cb(path, 'FAIL');
+            }
+        })
 }

src/main.ts

@@ -316,6 +316,7 @@ export default class InvioPlugin extends Plugin {
         this.syncStatus = "syncing";
         // TODO: Delete all remote html files if triggerSource === force
         const pubPathList: string[] = [];
+        const unPubList: string[] = [];
         await doActualSync(
           client,
           this.db,
@@ -341,14 +342,18 @@ export default class InvioPlugin extends Plugin {
           },
           async (i: number, totalCount: number, pathName: string, decision: string) => {
             self.setCurrSyncMsg(i, totalCount, pathName, decision);
-            log.info('publishing ', pathName, decision);
+
+            log.info('syncing ', pathName, decision);
+            if (touchedFileMap?.pathName) {
+              touchedFileMap.pathName.syncStatus = 'syncing';
+            }
             // TODO: Wrap in transation and do alert when publish failed
             if (decision === 'uploadLocalToRemote') {
               // upload
               pubPathList.push(pathName);
             } else if (decision === 'uploadLocalDelHistToRemote') {
               // delete
-              await unpublishFile(client, this.app.vault, pathName);
+              unPubList.push(pathName);
             } else {
               log.info('ignore decision ', decision, pathName);
             } 
@@ -357,12 +362,44 @@ export default class InvioPlugin extends Plugin {
             log.warn('Remote files conflicts when syncing ... ', key);
           }
         );
+
+        log.info('sync done with touched file map: ', JSON.stringify(touchedFileMap));
+
+        for (const pathName of unPubList) {
+          if (touchedFileMap?.pathName) {
+            touchedFileMap.pathName.syncStatus = 'publishing';
+          }
+          await unpublishFile(client, this.app.vault, pathName, (pathName: string, status: string) => {
+            log.info('publishing ', pathName, status);
+            if (touchedFileMap?.pathName) {
+              if (status === 'START') {
+                touchedFileMap.pathName.syncStatus = 'publishing';
+              } else if (status === 'DONE') {
+                touchedFileMap.pathName.syncStatus = 'done';
+              } else if (status === 'FAIL') {
+                touchedFileMap.pathName.syncStatus = 'fail';
+              }
+            }
+          });
+        }
+
         const basePath = new Path(this.settings.localWatchDir);
         // get files to export
         let allFiles = this.app.vault.getMarkdownFiles();
         // if we are at the root path export all files, otherwise only export files in the folder we are exporting
         allFiles = allFiles.filter((file: TFile) => new Path(file.path).directory.asString.startsWith(basePath.asString) && (file.extension === "md") && (!file.name.endsWith('.conflict.md')));
-        await publishFiles(client, this.app.vault, pubPathList, allFiles, '', this.settings, triggerSource);
+        await publishFiles(client, this.app.vault, pubPathList, allFiles, '', this.settings, triggerSource, (pathName: string, status: string) => {
+          log.info('publishing ', pathName, status);
+          if (touchedFileMap?.pathName) {
+            if (status === 'START') {
+              touchedFileMap.pathName.syncStatus = 'publishing';
+            } else if (status === 'DONE') {
+              touchedFileMap.pathName.syncStatus = 'done';
+            } else if (status === 'FAIL') {
+              touchedFileMap.pathName.syncStatus = 'fail';
+            }
+          }
+        });
 
         if (triggerSource === 'force') {
           const forceList: string[] = [];
@@ -405,6 +442,9 @@ export default class InvioPlugin extends Plugin {
           this.manifest.id
         }-${Date.now()}: finish sync, triggerSource=${triggerSource}`
       );
+
+      // TODO: Show stats model
+      return touchedFileMap;
     } catch (error) {
       const msg = t("syncrun_abort", {
         manifestID: this.manifest.id,

src/sync.ts

@@ -1084,16 +1084,16 @@ export const getSyncPlan = async (
     }
   }
 
-  const touchedFileMap: FileOrFolderMixedState[] = [];
+  const touchedFileMap: Record<string, FileOrFolderMixedState> = {};
   for (let i = 0; i < sortedKeys.length; ++i) {
     const key = sortedKeys[i];
     const val = mixedStates[key];
 
     if (RemoteFileTouchedDecisions.includes(val.decision)) {
-      touchedFileMap.push(val);
+      touchedFileMap[key] = val;
     }
     if (LocalFileTouchedDecisions.includes(val.decision)) {
-      touchedFileMap.push(val);
+      touchedFileMap[key] = val;
     }
   }
 

src/touchedPlanModel.ts

@@ -9,8 +9,8 @@ export class TouchedPlanModel extends Modal {
   agree: boolean;
   readonly plugin: InvioPlugin;
   hook: (agree: boolean) => void;
-  readonly files: FileOrFolderMixedState[];
-  constructor(app: App, plugin: InvioPlugin, fileMap: FileOrFolderMixedState[], cb: (agree: boolean) => void) {
+  readonly files: Record<string, FileOrFolderMixedState>;
+  constructor(app: App, plugin: InvioPlugin, fileMap: Record<string, FileOrFolderMixedState>, cb: (agree: boolean) => void) {
     super(app);
     this.plugin = plugin;
     this.agree = false;
@@ -31,7 +31,8 @@ export class TouchedPlanModel extends Modal {
     const toLocalFiles: FileOrFolderMixedState[] = [];
     const conflictFiles: FileOrFolderMixedState[] = [];
 
-    this.files.forEach(f => {
+    [ ...Object.keys(this.files) ].forEach(key => {
+      const f = this.files[key];
       if ((f.decision === 'uploadLocalDelHistToRemote') && f.existRemote) {
         toRemoteFiles.push(f);
       }