Merge pull request #15 from appwrite/shift-workdir

chore: shift workDir to be instance based

Author: ChiragAgg5k

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appwrite.io/synapse",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Operating system gateway for remote serverless environments",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/services/filesystem.ts

@@ -24,22 +24,31 @@ export type FileOperationResult = {
 
 export class Filesystem {
   private synapse: Synapse;
+  private workDir: string;
   private folderWatchers: Map<string, fsSync.FSWatcher> = new Map();
 
   /**
    * Creates a new Filesystem instance
    * @param synapse - The Synapse instance to use
    */
-  constructor(synapse: Synapse) {
+  constructor(synapse: Synapse, workDir?: string) {
     this.synapse = synapse;
     this.synapse.setFilesystem(this);
+    this.workDir = workDir ?? process.cwd();
   }
 
   private log(message: string): void {
     const timestamp = new Date().toISOString();
     console.log(`[Filesystem][${timestamp}] ${message}`);
   }
 
+  private resolvePath(inputPath: string): string {
+    if (path.isAbsolute(inputPath)) {
+      return inputPath;
+    }
+    return path.join(this.workDir, inputPath);
+  }
+
   /**
    * Creates a new file at the specified path with optional content.
    * Fails if the file already exists.
@@ -52,7 +61,7 @@ export class Filesystem {
     filePath: string,
     content: string = "",
   ): Promise<FileOperationResult> {
-    const fullPath = path.join(this.synapse.workDir, filePath);
+    const fullPath = this.resolvePath(filePath);
 
     try {
       await fs.access(fullPath, fsConstants.F_OK);
@@ -111,7 +120,7 @@ export class Filesystem {
    */
   async getFile(filePath: string): Promise<FileOperationResult> {
     try {
-      const fullPath = path.join(this.synapse.workDir, filePath);
+      const fullPath = this.resolvePath(filePath);
 
       const data = await fs.readFile(fullPath, "utf-8");
 
@@ -140,7 +149,7 @@ export class Filesystem {
   ): Promise<FileOperationResult> {
     try {
       this.log(`Updating file at path: ${filePath}`);
-      const fullPath = path.join(this.synapse.workDir, filePath);
+      const fullPath = this.resolvePath(filePath);
       const dirPath = path.dirname(filePath);
 
       await this.createFolder(dirPath);
@@ -170,7 +179,7 @@ export class Filesystem {
     content: string,
   ): Promise<FileOperationResult> {
     try {
-      const fullPath = path.join(this.synapse.workDir, filePath);
+      const fullPath = this.resolvePath(filePath);
       await fs.appendFile(fullPath, content);
       return { success: true };
     } catch (error) {
@@ -197,8 +206,8 @@ export class Filesystem {
   ): Promise<FileOperationResult> {
     try {
       this.log(`Moving file from ${oldPath} to ${newPath}`);
-      const fullOldPath = path.join(this.synapse.workDir, oldPath);
-      const fullNewPath = path.join(this.synapse.workDir, newPath);
+      const fullOldPath = this.resolvePath(oldPath);
+      const fullNewPath = this.resolvePath(newPath);
 
       await fs.rename(fullOldPath, fullNewPath);
 
@@ -223,7 +232,7 @@ export class Filesystem {
   async deleteFile(filePath: string): Promise<FileOperationResult> {
     try {
       this.log(`Deleting file at path: ${filePath}`);
-      const fullPath = path.join(this.synapse.workDir, filePath);
+      const fullPath = this.resolvePath(filePath);
 
       await fs.unlink(fullPath);
 
@@ -246,13 +255,13 @@ export class Filesystem {
    * @throws Error if directory creation fails
    */
   async createFolder(dirPath: string): Promise<FileOperationResult> {
+    const fullPath = this.resolvePath(dirPath);
+
     if (dirPath === "." || dirPath === "" || dirPath === "/") {
       // Skip creation for root or relative '.' path
       return { success: true };
     }
 
-    const fullPath = path.join(this.synapse.workDir, dirPath);
-
     try {
       await fs.mkdir(fullPath, { recursive: true });
 
@@ -279,7 +288,7 @@ export class Filesystem {
   async getFolder(dirPath: string): Promise<FileItemResult> {
     try {
       this.log(`Reading directory at path: ${dirPath}`);
-      const fullPath = path.join(this.synapse.workDir, dirPath);
+      const fullPath = this.resolvePath(dirPath);
 
       const items = await fs.readdir(fullPath, { withFileTypes: true });
       const data: FileItem[] = items.map((item) => ({
@@ -312,7 +321,7 @@ export class Filesystem {
   ): Promise<FileOperationResult> {
     try {
       this.log(`Renaming folder at ${dirPath} to ${name}`);
-      const fullPath = path.join(this.synapse.workDir, dirPath);
+      const fullPath = this.resolvePath(dirPath);
 
       const dir = path.dirname(fullPath);
       const newPath = path.join(dir, name);
@@ -344,8 +353,8 @@ export class Filesystem {
   ): Promise<FileOperationResult> {
     try {
       this.log(`Moving folder from ${oldPath} to ${newPath}`);
-      const fullOldPath = path.join(this.synapse.workDir, oldPath);
-      const fullNewPath = path.join(this.synapse.workDir, newPath);
+      const fullOldPath = this.resolvePath(oldPath);
+      const fullNewPath = this.resolvePath(newPath);
 
       await fs.rename(fullOldPath, fullNewPath);
 
@@ -370,7 +379,7 @@ export class Filesystem {
   async deleteFolder(dirPath: string): Promise<FileOperationResult> {
     try {
       this.log(`Deleting folder at path: ${dirPath}`);
-      const fullPath = path.join(this.synapse.workDir, dirPath);
+      const fullPath = this.resolvePath(dirPath);
 
       await fs.rm(fullPath, { recursive: true });
 
@@ -393,15 +402,15 @@ export class Filesystem {
   watchWorkDir(
     onChange: (result: { path: string; content: string | null }) => void,
   ): void {
-    const fullPath = path.join(this.synapse.workDir);
+    const fullPath = this.resolvePath(this.workDir);
     if (this.folderWatchers.has(fullPath)) {
       return;
     }
 
     // Read and parse .gitignore from the root of the workspace
     let ig: ReturnType<typeof ignore> | null = null;
     try {
-      const gitignorePath = path.join(this.synapse.workDir, ".gitignore");
+      const gitignorePath = this.resolvePath(".gitignore");
       const gitignoreContent = fsSync.existsSync(gitignorePath)
         ? fsSync.readFileSync(gitignorePath, "utf-8")
         : "";
@@ -422,7 +431,7 @@ export class Filesystem {
           return; // ignore this change
         }
         const changedPath = path.join("/", filename); // relative to workDir
-        const absPath = path.join(this.synapse.workDir, filename);
+        const absPath = path.join(this.workDir, filename);
 
         try {
           const stat = await fs.lstat(absPath);
@@ -447,7 +456,7 @@ export class Filesystem {
    * Stops watching a directory for changes.
    */
   unwatchWorkDir(): void {
-    const fullPath = path.join(this.synapse.workDir);
+    const fullPath = this.resolvePath(this.workDir);
     const watcher = this.folderWatchers.get(fullPath);
     if (watcher) {
       watcher.close();

src/services/git.ts

@@ -11,13 +11,15 @@ export type GitOperationResult = {
 
 export class Git {
   private synapse: Synapse;
+  private workDir: string;
 
   /**
    * Creates a new Git instance
    * @param synapse - The Synapse instance to use
    */
-  constructor(synapse: Synapse) {
+  constructor(synapse: Synapse, workDir?: string) {
     this.synapse = synapse;
+    this.workDir = workDir ?? process.cwd();
   }
 
   private isErrnoException(error: unknown): error is NodeJS.ErrnoException {
@@ -26,7 +28,7 @@ export class Git {
 
   private async execute(args: string[]): Promise<GitOperationResult> {
     return new Promise((resolve) => {
-      const git = spawn("git", args, { cwd: this.synapse.workDir });
+      const git = spawn("git", args, { cwd: this.workDir });
       let output = "";
       let errorOutput = "";
 
@@ -60,7 +62,7 @@ export class Git {
 
   private async isGitRepository(): Promise<boolean> {
     try {
-      const gitDir = path.join(this.synapse.workDir, ".git");
+      const gitDir = path.join(this.workDir, ".git");
       return fs.existsSync(gitDir) && fs.statSync(gitDir).isDirectory();
     } catch (error: unknown) {
       if (this.isErrnoException(error)) {
@@ -86,7 +88,7 @@ export class Git {
 
       // Check if we have write permissions in the current directory
       try {
-        await fs.promises.access(this.synapse.workDir, fs.constants.W_OK);
+        await fs.promises.access(this.workDir, fs.constants.W_OK);
       } catch (error: unknown) {
         if (this.isErrnoException(error)) {
           return {

src/services/terminal.ts

@@ -6,6 +6,7 @@ export type TerminalOptions = {
   shell: string;
   cols?: number;
   rows?: number;
+  workDir?: string;
 };
 
 export class Terminal {
@@ -27,6 +28,7 @@ export class Terminal {
       shell: os.platform() === "win32" ? "powershell.exe" : "bash",
       cols: 80,
       rows: 24,
+      workDir: process.cwd(),
     },
   ) {
     this.synapse = synapse;
@@ -37,7 +39,7 @@ export class Terminal {
         name: "xterm-color",
         cols: terminalOptions.cols,
         rows: terminalOptions.rows,
-        cwd: this.synapse.workDir,
+        cwd: terminalOptions.workDir,
         env: process.env,
       });
 

src/synapse.ts

@@ -1,4 +1,3 @@
-import fs from "fs";
 import { IncomingMessage } from "http";
 import { Socket } from "net";
 import WebSocket, { WebSocketServer } from "ws";
@@ -52,23 +51,12 @@ class Synapse {
   private host: string;
   private port: number;
 
-  public workDir: string;
-
   private serverConnectionListener: ServerConnectionCallback = () => {};
 
-  constructor(
-    host: string = "localhost",
-    port: number = 3000,
-    workDir: string = process.cwd(),
-  ) {
+  constructor(host: string = "localhost", port: number = 3000) {
     this.host = host;
     this.port = port;
 
-    if (!fs.existsSync(workDir)) {
-      fs.mkdirSync(workDir, { recursive: true });
-    }
-    this.workDir = workDir;
-
     this.wss = new WebSocketServer({ noServer: true });
     this.wss.on("connection", (ws: WebSocket, req: IncomingMessage) => {
       const connectionId = this.generateConnectionId();
@@ -202,40 +190,6 @@ class Synapse {
     this.filesystem = filesystem;
   }
 
-  /**
-   * Sets the working directory for the Synapse instance
-   * @param workDir - The path to the working directory
-   * @returns void
-   */
-  updateWorkDir(workDir: string): { success: boolean; data: string } {
-    if (!fs.existsSync(workDir)) {
-      try {
-        fs.mkdirSync(workDir, { recursive: true });
-      } catch (error) {
-        const errorMessage =
-          error instanceof Error
-            ? error.message
-            : "Unknown error creating directory";
-        this.log(`Failed to create work directory: ${errorMessage}`);
-        return {
-          success: false,
-          data: `Failed to create work directory: ${errorMessage}`,
-        };
-      }
-    }
-
-    this.workDir = workDir;
-    this.terminals.forEach((terminal) => {
-      if (terminal.isTerminalAlive()) {
-        terminal.updateWorkDir(workDir);
-      }
-    });
-    return {
-      success: true,
-      data: "Work directory updated successfully",
-    };
-  }
-
   /**
    * Establishes a WebSocket connection to the specified URL
    * @param path - The WebSocket endpoint path (e.g. '/' or '/terminal')

tests/services/filesystem.test.ts

@@ -27,7 +27,7 @@ describe("Filesystem", () => {
       setFilesystem: jest.fn(),
     } as unknown as Synapse);
 
-    filesystem = new Filesystem(mockSynapse);
+    filesystem = new Filesystem(mockSynapse, "/test");
     jest.clearAllMocks();
   });