shorten unignore duration

Author: s-h-a-d-o-w

.gitignore

@@ -13,4 +13,6 @@ dist
 *.zip
 *.tar.gz
 *.log
-*.js
+*.js
+
+client/tests/test-client*

client/src/fileWatcher.ts

@@ -9,25 +9,24 @@ export enum FileOperationType {
   Sync,
 }
 
-let watcher: FSWatcher | undefined;
+export const UNIGNORE_DURATION = 200; // short because it only has to cover: end of operation -> file watcher trigger -> ignore that call
 export const WATCHER_DEBOUNCE_DURATION = 500;
 export const IGNORE_CLEANUP_DURATION = WATCHER_DEBOUNCE_DURATION * 2;
+
+let watcher: FSWatcher | undefined;
 const ignoreMaps = {
   [FileOperationType.Remove]: new Map<string, number>(),
   [FileOperationType.Sync]: new Map<string, number>(),
 };
 
-export function ignoreNext(fileOperationType: FileOperationType, path: string) {
+export function ignore(fileOperationType: FileOperationType, path: string) {
   ignoreMaps[fileOperationType].set(path, Date.now());
 }
 
-export function unignoreNext(
-  fileOperationType: FileOperationType,
-  path: string,
-) {
+export function unignore(fileOperationType: FileOperationType, path: string) {
   setTimeout(() => {
     ignoreMaps[fileOperationType].delete(path);
-  }, IGNORE_CLEANUP_DURATION);
+  }, UNIGNORE_DURATION);
 }
 
 function shouldIgnore(fileOperationType: FileOperationType, path: string) {

client/src/index.ts

@@ -16,9 +16,9 @@ import {
 import {
   cleanupFileWatcher,
   FileOperationType,
-  ignoreNext,
+  ignore,
   setUpFileWatcher,
-  unignoreNext,
+  unignore,
 } from "./fileWatcher.js";
 import { cleanupWebsocket, setUpWebsocket } from "./setUpWebsocket.js";
 import { trackFileOperation } from "./trackFileOperation.js";
@@ -55,14 +55,14 @@ async function main() {
     try {
       changeTrayIconState(TrayIconState.Busy);
 
-      ignoreNext(FileOperationType.Sync, localPath);
+      ignore(FileOperationType.Sync, localPath);
       await download(key, localPath);
       const { size } = await stat(localPath);
       trackFileOperation(key, size);
     } catch (error) {
       logger.error(`Error downloading file ${key}: ${getErrorMessage(error)}`);
     } finally {
-      unignoreNext(FileOperationType.Sync, localPath);
+      unignore(FileOperationType.Sync, localPath);
       changeTrayIconState(TrayIconState.Idle);
     }
   }
@@ -76,7 +76,7 @@ async function main() {
 
     try {
       changeTrayIconState(TrayIconState.Busy);
-      ignoreNext(FileOperationType.Remove, localPath);
+      ignore(FileOperationType.Remove, localPath);
 
       if ((await stat(localPath)).isDirectory()) {
         await rm(localPath, { recursive: true, force: true });
@@ -96,7 +96,7 @@ async function main() {
         );
       }
     } finally {
-      unignoreNext(FileOperationType.Remove, localPath);
+      unignore(FileOperationType.Remove, localPath);
       changeTrayIconState(TrayIconState.Idle);
     }
   }

client/src/s3Operations.ts

@@ -19,7 +19,7 @@ import {
   S3_BUCKET,
   SECRET_KEY,
 } from "./consts.js";
-import { FileOperationType, ignoreNext, unignoreNext } from "./fileWatcher.js";
+import { FileOperationType, ignore, unignore } from "./fileWatcher.js";
 
 export const s3Client = new S3Client({
   region: AWS_REGION,
@@ -32,9 +32,9 @@ export const s3Client = new S3Client({
 async function syncLastModified(localPath: string, lastModified?: Date) {
   if (lastModified) {
     logger.debug(`syncLastModified: added ${localPath} to ignore files.`);
-    ignoreNext(FileOperationType.Sync, localPath);
+    ignore(FileOperationType.Sync, localPath);
     await utimes(localPath, lastModified, lastModified);
-    unignoreNext(FileOperationType.Sync, localPath);
+    unignore(FileOperationType.Sync, localPath);
   }
 }
 
@@ -86,12 +86,12 @@ export async function download(key: string, localPath: string) {
       }),
     );
 
-    ignoreNext(FileOperationType.Sync, localPath);
+    ignore(FileOperationType.Sync, localPath);
     try {
       await mkdir(localPath, { recursive: true });
       await syncLastModified(localPath, LastModified);
     } finally {
-      unignoreNext(FileOperationType.Sync, localPath);
+      unignore(FileOperationType.Sync, localPath);
     }
 
     logger.info(`Downloaded: ${key}`);
@@ -109,13 +109,13 @@ export async function download(key: string, localPath: string) {
     // We don't manage ignoring potentially new created directories here because that would be a lot of overhead. Instead, if syncing is triggered, we let the upload of the directory handle breaking that chain. (via updating modification time and that timestamp then being the same)
     await mkdir(dirname(localPath), { recursive: true });
 
-    ignoreNext(FileOperationType.Sync, localPath);
+    ignore(FileOperationType.Sync, localPath);
     try {
       const writeStream = createWriteStream(localPath);
       await pipeline(Body.transformToWebStream(), writeStream);
       await syncLastModified(localPath, LastModified);
     } finally {
-      unignoreNext(FileOperationType.Sync, localPath);
+      unignore(FileOperationType.Sync, localPath);
     }
 
     logger.info(`Downloaded: ${key}`);