feat(vscode): improved path resolution algorithm from command palette (#831)

alestiago · web-flow · commit 05114e44ffc7 · 2023-08-01T10:36:27.000-03:00
diff --git a/extensions/vscode/src/commands/new-middleware.ts b/extensions/vscode/src/commands/new-middleware.ts
@@ -1,7 +1,11 @@
 const cp = require("child_process");
 
 import { Uri, window, OpenDialogOptions, ProgressOptions } from "vscode";
-import { nearestDartFrogProject, normalizeRoutePath } from "../utils";
+import {
+  nearestDartFrogProject,
+  normalizeRoutePath,
+  resolveDartFrogProjectPathFromWorkspace,
+} from "../utils";
 
 /**
  * Command to create a new middleware.
@@ -24,26 +28,30 @@ import { nearestDartFrogProject, normalizeRoutePath } from "../utils";
  * @param {Uri | undefined} uri
  */
 export const newMiddleware = async (uri: Uri | undefined): Promise<void> => {
-  let selectedUri;
+  let selectedPath;
   if (uri === undefined) {
-    selectedUri = await promptForTargetDirectory();
-    if (selectedUri === undefined) {
+    selectedPath = resolveDartFrogProjectPathFromWorkspace();
+
+    if (selectedPath === undefined) {
+      selectedPath = await promptForTargetDirectory();
+    }
+    if (selectedPath === undefined) {
       window.showErrorMessage("Please select a valid directory");
       return;
     }
   } else {
-    selectedUri = uri.fsPath;
+    selectedPath = uri.fsPath;
   }
 
-  const dartFrogProjectPath = nearestDartFrogProject(selectedUri);
+  const dartFrogProjectPath = nearestDartFrogProject(selectedPath);
   if (dartFrogProjectPath === undefined) {
     window.showErrorMessage(
       "No Dart Frog project found in the selected directory"
     );
     return;
   }
 
-  const routePath = normalizeRoutePath(selectedUri, dartFrogProjectPath);
+  const routePath = normalizeRoutePath(selectedPath, dartFrogProjectPath);
 
   const options: ProgressOptions = {
     location: 15,
diff --git a/extensions/vscode/src/commands/new-route.ts b/extensions/vscode/src/commands/new-route.ts
@@ -7,7 +7,11 @@ import {
   OpenDialogOptions,
   ProgressOptions,
 } from "vscode";
-import { nearestDartFrogProject, normalizeRoutePath } from "../utils";
+import {
+  nearestDartFrogProject,
+  normalizeRoutePath,
+  resolveDartFrogProjectPathFromWorkspace,
+} from "../utils";
 
 /**
  * Command to create a new route.
@@ -30,18 +34,22 @@ import { nearestDartFrogProject, normalizeRoutePath } from "../utils";
  * @param {Uri | undefined} uri
  */
 export const newRoute = async (uri: Uri | undefined): Promise<void> => {
-  let selectedUri;
+  let selectedPath;
   if (uri === undefined) {
-    selectedUri = await promptForTargetDirectory();
-    if (selectedUri === undefined) {
+    selectedPath = resolveDartFrogProjectPathFromWorkspace();
+
+    if (selectedPath === undefined) {
+      selectedPath = await promptForTargetDirectory();
+    }
+    if (selectedPath === undefined) {
       window.showErrorMessage("Please select a valid directory");
       return;
     }
   } else {
-    selectedUri = uri.fsPath;
+    selectedPath = uri.fsPath;
   }
 
-  const dartFrogProjectPath = nearestDartFrogProject(selectedUri);
+  const dartFrogProjectPath = nearestDartFrogProject(selectedPath);
   if (dartFrogProjectPath === undefined) {
     window.showErrorMessage(
       "No Dart Frog project found in the selected directory"
@@ -50,7 +58,7 @@ export const newRoute = async (uri: Uri | undefined): Promise<void> => {
   }
 
   const normalizedRoutePath = normalizeRoutePath(
-    selectedUri,
+    selectedPath,
     dartFrogProjectPath
   );
 
diff --git a/extensions/vscode/src/test/suite/commands/new-middleware.test.ts b/extensions/vscode/src/test/suite/commands/new-middleware.test.ts
@@ -27,6 +27,7 @@ suite("new-middleware command", () => {
     utilsStub = {
       nearestDartFrogProject: sinon.stub(),
       normalizeRoutePath: sinon.stub(),
+      resolveDartFrogProjectPathFromWorkspace: sinon.stub(),
     };
 
     utilsStub.nearestDartFrogProject
@@ -50,8 +51,9 @@ suite("new-middleware command", () => {
   });
 
   suite("file open dialog", () => {
-    test("is shown when Uri is undefined", async () => {
+    test("is shown when Uri is undefined and fails to resolve a path from workspace", async () => {
       vscodeStub.window.showOpenDialog.returns(Promise.resolve(undefined));
+      utilsStub.resolveDartFrogProjectPathFromWorkspace.returns(undefined);
 
       await command.newMiddleware();
 
@@ -63,6 +65,16 @@ suite("new-middleware command", () => {
       });
     });
 
+    test("is not shown when Uri is undefined but resolves a path from workspace", async () => {
+      utilsStub.resolveDartFrogProjectPathFromWorkspace.returns(
+        validUri.fsPath
+      );
+
+      await command.newMiddleware();
+
+      sinon.assert.notCalled(vscodeStub.window.showOpenDialog);
+    });
+
     test("is not shown when Uri is defined", async () => {
       await command.newMiddleware(invalidUri);
 
diff --git a/extensions/vscode/src/test/suite/commands/new-route.test.ts b/extensions/vscode/src/test/suite/commands/new-route.test.ts
@@ -30,6 +30,7 @@ suite("new-route command", () => {
     utilsStub = {
       nearestDartFrogProject: sinon.stub(),
       normalizeRoutePath: sinon.stub(),
+      resolveDartFrogProjectPathFromWorkspace: sinon.stub(),
     };
 
     utilsStub.nearestDartFrogProject
@@ -123,9 +124,10 @@ suite("new-route command", () => {
   });
 
   suite("file open dialog", () => {
-    test("is shown when Uri is undefined", async () => {
+    test("is shown when Uri is undefined and fails to resolve a path from workspace", async () => {
       vscodeStub.window.showInputBox.returns(validRouteName);
       vscodeStub.window.showOpenDialog.returns(Promise.resolve(undefined));
+      utilsStub.resolveDartFrogProjectPathFromWorkspace.returns(undefined);
 
       await command.newRoute();
 
@@ -137,6 +139,17 @@ suite("new-route command", () => {
       });
     });
 
+    test("is not shown when Uri is undefined but resolves a path from workspace", async () => {
+      utilsStub.resolveDartFrogProjectPathFromWorkspace.returns(
+        validUri.fsPath
+      );
+      utilsStub.normalizeRoutePath.returns("/");
+
+      await command.newRoute();
+
+      sinon.assert.notCalled(vscodeStub.window.showOpenDialog);
+    });
+
     test("is not shown when Uri is defined", async () => {
       vscodeStub.window.showInputBox.returns(validRouteName);
 
diff --git a/extensions/vscode/src/test/suite/utils/dart-frog-structure.test.ts b/extensions/vscode/src/test/suite/utils/dart-frog-structure.test.ts
@@ -144,7 +144,7 @@ suite("nearestDartFrogProject", () => {
     const routesPath1 = path.join(dartFrogPath1, "routes");
     const pubspecPath1 = path.join(dartFrogPath1, "pubspec.yaml");
 
-    const dartFrogPath2 = "/home/user/Developer/myserver";
+    const dartFrogPath2 = "home/user/Developer/myserver";
     const routesPath2 = path.join(dartFrogPath2, "routes");
     const pubspecPath2 = path.join(dartFrogPath2, "pubspec.yaml");
 
@@ -276,6 +276,179 @@ suite("isDartFrogProject", () => {
   });
 });
 
+suite("resolveDartFrogProjectPathFromWorkspace", () => {
+  let vscodeStub: any;
+  let resolveDartFrogProjectPathFromWorkspace: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      workspace: {
+        workspaceFolders: sinon.stub(),
+      },
+      window: {
+        activeTextEditor: sinon.stub(),
+      },
+    };
+
+    resolveDartFrogProjectPathFromWorkspace = proxyquire(
+      "../../../utils/dart-frog-structure",
+      {
+        vscode: vscodeStub,
+      }
+    ).resolveDartFrogProjectPathFromWorkspace;
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("returns the file path of the active route Dart file", () => {
+    vscodeStub.window.activeTextEditor = {
+      document: {
+        uri: {
+          fsPath: `home/user/routes/index.dart`,
+        },
+      },
+    };
+
+    const result = resolveDartFrogProjectPathFromWorkspace(
+      sinon.stub().returns("home/user/")
+    );
+
+    sinon.assert.match(result, "home/user/routes/index.dart");
+  });
+
+  suite("returns the directory path of the active workspace folder", () => {
+    test("when there is no active text editor", () => {
+      vscodeStub.window.activeTextEditor = undefined;
+      vscodeStub.workspace.workspaceFolders = [
+        {
+          uri: {
+            fsPath: `home/user/routes/animals`,
+          },
+        },
+      ];
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        sinon.stub().returns("home/user/")
+      );
+
+      sinon.assert.match(result, "home/user/routes/animals");
+    });
+
+    test("when the active text editor is not a route", () => {
+      vscodeStub.window.activeTextEditor = {
+        document: {
+          uri: {
+            fsPath: `home/user/pubspec.yaml`,
+          },
+        },
+      };
+      vscodeStub.workspace.workspaceFolders = [
+        {
+          uri: {
+            fsPath: `home/user/`,
+          },
+        },
+      ];
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        sinon.stub().returns("home/user/")
+      );
+
+      sinon.assert.match(result, "home/user/");
+    });
+
+    test("when the active text editor is not a Dart route", () => {
+      vscodeStub.window.activeTextEditor = {
+        document: {
+          uri: {
+            fsPath: `home/user/routes/hello.yaml`,
+          },
+        },
+      };
+      vscodeStub.workspace.workspaceFolders = [
+        {
+          uri: {
+            fsPath: `home/user/`,
+          },
+        },
+      ];
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        sinon.stub().returns("home/user/")
+      );
+
+      sinon.assert.match(result, "home/user/");
+    });
+
+    test("when the active text editor is not a Dart Frog project", () => {
+      vscodeStub.window.activeTextEditor = {
+        document: {
+          uri: {
+            fsPath: `/home/bin/routes/animals/frog.dart`,
+          },
+        },
+      };
+      vscodeStub.workspace.workspaceFolders = [
+        {
+          uri: {
+            fsPath: `home/user/`,
+          },
+        },
+      ];
+
+      const nearestDartFrogProject = sinon.stub();
+      nearestDartFrogProject
+        .withArgs("/home/bin/routes/animals")
+        .returns(undefined);
+      nearestDartFrogProject.withArgs("home/user/").returns("home/user/");
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        nearestDartFrogProject
+      );
+
+      sinon.assert.match(result, "home/user/");
+    });
+  });
+
+  suite("returns undefined", () => {
+    test("when there is no active workspace folder nor text editor", () => {
+      vscodeStub.window.activeTextEditor = undefined;
+      vscodeStub.workspace.workspaceFolders = undefined;
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        sinon.stub().returns(undefined)
+      );
+
+      sinon.assert.match(result, undefined);
+    });
+
+    test("when there is not an active workspace folder nor text editor that are Dart Frog projects", () => {
+      vscodeStub.window.activeTextEditor = {
+        document: {
+          uri: {
+            fsPath: `home/user/routes/animals/frog.dart`,
+          },
+        },
+      };
+      vscodeStub.workspace.workspaceFolders = [
+        {
+          uri: {
+            fsPath: `home/user/`,
+          },
+        },
+      ];
+
+      const result = resolveDartFrogProjectPathFromWorkspace(
+        sinon.stub().returns(undefined)
+      );
+
+      sinon.assert.match(result, undefined);
+    });
+  });
+});
+
 /**
  * Example of a pubspec.yaml file that depends on Dart Frog.
  *
diff --git a/extensions/vscode/src/utils/dart-frog-structure.ts b/extensions/vscode/src/utils/dart-frog-structure.ts
