Add support for syncing files with spaces (#450)

Author: fjakobs

packages/databricks-vscode/src/cli/BricksSyncParser.test.ts

@@ -35,6 +35,19 @@ describe("tests for BricksSycnParser", () => {
         assert.equal(syncState, "IN_PROGRESS");
     });
 
+    it("should handle files with spaces in their names", () => {
+        assert.equal(syncState, "STOPPED");
+        bricksSycnParser.process(
+            "Action: PUT: hello world.txt, hello.py, world hello.py"
+        );
+        assert.equal(syncState, "IN_PROGRESS");
+        bricksSycnParser.process("Uploaded hello world.txt");
+        bricksSycnParser.process("Uploaded hello.py");
+        bricksSycnParser.process("Uploaded world hello.py");
+        bricksSycnParser.process("[INFO] Initial Sync Complete");
+        assert.equal(syncState, "WATCHING_FOR_CHANGES");
+    });
+
     it("test bricksSycnParser.process correctly keeps track of state of inflight requests", () => {
         // recieving some random logs from bricks sync
         assert.equal(syncState, "STOPPED");

packages/databricks-vscode/src/cli/BricksSyncParser.ts

@@ -25,56 +25,26 @@ export class BricksSyncParser {
     // const s1 = "Action: PUT: g, .gitignore, DELETE: f"
     // A hacky way to solve this, lets move to structed logs from bricks later
     private parseForActionsInitiated(line: string) {
-        const indexOfAction = line.indexOf("Action:");
-        // The log line is not relevant for actions
-        if (indexOfAction === -1) {
+        const match = line.match(/Action:( PUT: (.*?))?( DELETE: (.*?))?$/);
+        if (!match) {
             return;
         }
 
-        const tokenizedLine = line.substring(indexOfAction).split(" ");
-        let isPut = false;
-        let isDelete = false;
-        for (let i = 1; i < tokenizedLine.length; i++) {
-            switch (tokenizedLine[i]) {
-                case "PUT:": {
-                    isPut = true;
-                    isDelete = false;
-                    break;
-                }
-                case "DELETE:": {
-                    isDelete = true;
-                    isPut = false;
-                    break;
-                }
-                default: {
-                    // trim the trailing , if it exists
-                    const filePath = tokenizedLine[i].replace(/,$/, "");
-                    if (isPut) {
-                        this.filesBeingUploaded.add(filePath);
-                    } else if (isDelete) {
-                        this.filesBeingDeleted.add(filePath);
-                    } else {
-                        throw new Error(
-                            "[BricksSyncParser] unexpected logs recieved"
-                        );
-                    }
-                }
-            }
-        }
+        const toAdd = match[2]?.split(", ");
+        const toDelete = match[4]?.split(", ");
+
+        toAdd?.forEach((f) => this.filesBeingUploaded.add(f));
+        toDelete?.forEach((f) => this.filesBeingDeleted.add(f));
     }
 
     // We expect a single line of logs for all files being put/delete
     private parseForUploadCompleted(line: string) {
-        const indexOfUploaded = line.indexOf("Uploaded");
-        if (indexOfUploaded === -1) {
+        const match = line.match(/Uploaded (.*)/);
+        if (!match) {
             return;
         }
 
-        const tokenizedLine = line.substring(indexOfUploaded).split(" ");
-        if (tokenizedLine.length !== 2) {
-            throw new Error("[BricksSyncParser] unexpected logs recieved");
-        }
-        const filePath = tokenizedLine[1];
+        const filePath = match[1];
         if (!this.filesBeingUploaded.has(filePath)) {
             throw new Error(
                 "[BricksSyncParser] untracked file uploaded. All upload complete " +
@@ -89,16 +59,12 @@ export class BricksSyncParser {
     }
 
     private parseForDeleteCompleted(line: string) {
-        const indexOfDeleted = line.indexOf("Deleted");
-        if (indexOfDeleted === -1) {
+        const match = line.match(/Deleted (.*)/);
+        if (!match) {
             return;
         }
 
-        const tokenizedLine = line.substring(indexOfDeleted).split(" ");
-        if (tokenizedLine.length !== 2) {
-            throw new Error("[BricksSyncParser] unexpected logs recieved");
-        }
-        const filePath = tokenizedLine[1];
+        const filePath = match[1];
         if (!this.filesBeingDeleted.has(filePath)) {
             throw new Error(
                 "[BricksSyncParser] untracked file deleted. All delete complete " +

packages/databricks-vscode/src/cli/BricksTasks.ts

@@ -165,7 +165,7 @@ class CustomSyncTerminal implements Pseudoterminal {
 /**
  * Wrapper around the CustomSyncTerminal class that lazily evaluates the process
  * and args properties. This is necessary because the process and args properties
- * re not known up front can only be computed dynamically at runtime.
+ * are not known up front and can only be computed dynamically at runtime.
  *
  * A Custom implmentation of the terminal is needed to run bricks sync as a CustomExecution
  * vscode task, which allows us to parse the stdout/stderr bricks sync logs and compute