Switch from Gaze to Chokidar (#146)

* Switch from Gaze to Chokidar

* Remove linter

* upgrade packages

* Update with absolute path

* Add file path test for watcher

---------

Co-authored-by: Elliot Braem <[email protected]>

Author: bb-face

lib/dev.ts

@@ -1,4 +1,4 @@
-import { Gaze } from "gaze";
+import { FSWatcher } from "chokidar";
 import path from "path";
 import { Server as IoServer } from "socket.io";
 import { buildApp } from "@/lib/build";
@@ -15,7 +15,7 @@ var appDevJsons = [];
 var appDevJsonPath = "bos-loader.json";
 var appDevOptions: null | DevOptions = null;
 let io: null | IoServer = null;
-let fileWatcher: null | Gaze = null;
+let fileWatcher: null | FSWatcher = null;
 
 export type DevOptions = {
   port?: number; // port to run dev server

lib/watcher.ts

@@ -1,10 +1,19 @@
-import { Gaze } from "gaze";
+import path from "path"
+import chokidar, { FSWatcher } from "chokidar";
 
-export function startFileWatcher(watchPaths: string[], callback: Function): Gaze {
-  const gaze = new Gaze(watchPaths, { debounceDelay: 100 });
+export function startFileWatcher(watchPaths: string[], callback: Function): FSWatcher {
+  const watcher = chokidar.watch(watchPaths, {
+    ignoreInitial: true,
+    awaitWriteFinish: {
+      stabilityThreshold: 100,
+      pollInterval: 100
+    }
+  });
 
-  // @ts-ignore
-  gaze.on("all", callback);
+  watcher.on('all', (event, relativePath) => {
+		const absolutePath = path.resolve(relativePath)
+		callback(event, absolutePath);
+	});
 
-  return gaze;
+  return watcher;
 }

package.json

@@ -31,11 +31,11 @@
     "@near-js/types": "^0.2.0",
     "axios": "^1.7.2",
     "body-parser": "^1.20.2",
+    "chokidar": "^3.6.0",
     "commander": "^11.1.0",
     "crypto-js": "^4.2.0",
     "express": "^4.18.2",
     "fs-extra": "^11.2.0",
-    "gaze": "^1.1.3",
     "glob": "^10.3.10",
     "http-proxy": "^1.18.1",
     "https": "^1.0.0",
@@ -55,7 +55,6 @@
     "@types/crypto-js": "^4.2.2",
     "@types/express": "^4.17.21",
     "@types/fs-extra": "^11.0.4",
-    "@types/gaze": "^1.1.5",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.11.30",
     "@types/supertest": "^6.0.2",

tests/unit/dev.ts

@@ -8,7 +8,7 @@ import { startFileWatcher } from "@/lib/watcher";
 import http from "http";
 import path from "path";
 import { Server as IoServer } from "socket.io";
-import { Gaze } from "gaze";
+import chokidar from "chokidar";
 
 import { vol } from 'memfs';
 jest.mock('fs', () => require('memfs').fs);
@@ -43,7 +43,6 @@ describe("dev", () => {
     (loadConfig as jest.MockedFunction<typeof loadConfig>).mockResolvedValue(mockConfig);
     (startDevServer as jest.MockedFunction<typeof startDevServer>).mockReturnValue({} as http.Server);
     (startSocket as jest.MockedFunction<typeof startSocket>).mockReturnValue(new IoServer());
-    (startFileWatcher as jest.MockedFunction<typeof startFileWatcher>).mockReturnValue(new Gaze(mockSrc));
     (buildApp as jest.MockedFunction<typeof buildApp>).mockReturnValue({} as Promise<any>);
   });
 
@@ -89,8 +88,16 @@ describe("dev", () => {
   });
 
   it("should add correct watch paths after adding apps", async () => {
-    const mockedGazeAdd = jest.spyOn(Gaze.prototype, 'add');
-    
+		const mockAdd = jest.fn();
+		const mockWatch = jest.fn().mockReturnValue({
+			add: mockAdd,
+		});
+		(chokidar.watch as jest.Mock) = mockWatch;
+
+		(startFileWatcher as jest.MockedFunction<typeof startFileWatcher>).mockReturnValue(
+			mockWatch([], {}) as chokidar.FSWatcher
+		);
+
     const mockOpts: DevOptions = { hot: false };
     await dev(mockSrc, "build", mockOpts);
 
@@ -106,6 +113,6 @@ describe("dev", () => {
       path.join(mockSrc2, 'bos.config.json'),
       path.join(mockSrc2, 'aliases.json'),
     ];
-    expect(mockedGazeAdd).toHaveBeenCalledWith(expectedWatchPaths);
+    expect(mockAdd).toHaveBeenCalledWith(expectedWatchPaths);
   });
 });

tests/unit/devNoMock.ts

@@ -0,0 +1,40 @@
+import { startFileWatcher } from "@/lib/watcher";
+import path from "path";
+import fs from "fs";
+
+describe("File Watcher Tests", () => {
+	let watcher;
+	const tempDirPath = path.join(__dirname, "temp-test");
+
+  it("should call the file watcher callback with the correct attributes", async () => {
+    const mockCallback = jest.fn();
+
+    fs.mkdirSync(tempDirPath, { recursive: true });
+
+    const tempFilePath = path.join(tempDirPath, "temp-file.txt");
+
+		const relativeTempFilePath = path.relative("./", tempFilePath)
+
+    fs.writeFileSync(tempFilePath, "initial content");
+
+    watcher = startFileWatcher([relativeTempFilePath], mockCallback);
+
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    fs.appendFileSync(tempFilePath, "\nadded content");
+
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    expect(mockCallback).toHaveBeenCalled();
+    expect(mockCallback.mock.calls[0][0]).toBe("change");
+    expect(mockCallback.mock.calls[0][1]).toBe(path.resolve(tempFilePath));
+  });
+
+	afterAll(async () => {
+		if (watcher) await watcher.close();
+
+    if (fs.existsSync(tempDirPath)) {
+      fs.rmSync(tempDirPath, { recursive: true, force: true });
+    }
+  });
+});