Merge pull request #2298 from github/elena/yer-a-windows-query

Fix problem with detecting storage folder on windows

Author: elenatanasoiu

extensions/ql-vscode/src/local-queries.ts

@@ -381,13 +381,16 @@ export class LocalQueries extends DisposableObject {
     await withProgress(
       async (progress: ProgressCallback, token: CancellationToken) => {
         const credentials = isCanary() ? this.app.credentials : undefined;
+        const contextStoragePath =
+          this.app.workspaceStoragePath || this.app.globalStoragePath;
         const skeletonQueryWizard = new SkeletonQueryWizard(
           this.cliServer,
           progress,
           credentials,
           extLogger,
           this.databaseManager,
           token,
+          contextStoragePath,
         );
         await skeletonQueryWizard.execute();
       },

extensions/ql-vscode/src/skeleton-query-wizard.ts

@@ -1,4 +1,4 @@
-import { join } from "path";
+import { join, dirname } from "path";
 import { CancellationToken, Uri, workspace, window as Window } from "vscode";
 import { CodeQLCliServer } from "./cli";
 import { OutputChannelLogger } from "./common";
@@ -27,7 +27,7 @@ export const QUERY_LANGUAGE_TO_DATABASE_REPO: QueryLanguagesToDatabaseMap = {
 export class SkeletonQueryWizard {
   private language: string | undefined;
   private fileName = "example.ql";
-  private storagePath: string | undefined;
+  private qlPackStoragePath: string | undefined;
 
   constructor(
     private readonly cliServer: CodeQLCliServer,
@@ -36,6 +36,7 @@ export class SkeletonQueryWizard {
     private readonly extLogger: OutputChannelLogger,
     private readonly databaseManager: DatabaseManager,
     private readonly token: CancellationToken,
+    private readonly databaseStoragePath: string | undefined,
   ) {}
 
   private get folderName() {
@@ -49,7 +50,7 @@ export class SkeletonQueryWizard {
       return;
     }
 
-    this.storagePath = this.getFirstStoragePath();
+    this.qlPackStoragePath = this.getFirstStoragePath();
 
     const skeletonPackAlreadyExists = isFolderAlreadyInWorkspace(
       this.folderName,
@@ -72,12 +73,12 @@ export class SkeletonQueryWizard {
   }
 
   private async openExampleFile() {
-    if (this.folderName === undefined || this.storagePath === undefined) {
+    if (this.folderName === undefined || this.qlPackStoragePath === undefined) {
       throw new Error("Path to folder is undefined");
     }
 
     const queryFileUri = Uri.file(
-      join(this.storagePath, this.folderName, this.fileName),
+      join(this.qlPackStoragePath, this.folderName, this.fileName),
     );
 
     try {
@@ -99,15 +100,16 @@ export class SkeletonQueryWizard {
     }
 
     const firstFolder = workspaceFolders[0];
+    const firstFolderFsPath = firstFolder.uri.fsPath;
 
     // For the vscode-codeql-starter repo, the first folder will be a ql pack
     // so we need to get the parent folder
-    if (firstFolder.uri.path.includes("codeql-custom-queries")) {
-      // slice off the last part of the path and return the parent folder
-      return firstFolder.uri.path.split("/").slice(0, -1).join("/");
+    if (firstFolderFsPath.includes("codeql-custom-queries")) {
+      // return the parent folder
+      return dirname(firstFolderFsPath);
     } else {
       // if the first folder is not a ql pack, then we are in a normal workspace
-      return firstFolder.uri.path;
+      return firstFolderFsPath;
     }
   }
 
@@ -137,7 +139,7 @@ export class SkeletonQueryWizard {
         this.folderName,
         this.language as QueryLanguage,
         this.cliServer,
-        this.storagePath,
+        this.qlPackStoragePath,
       );
 
       await qlPackGenerator.generate();
@@ -165,7 +167,7 @@ export class SkeletonQueryWizard {
         this.folderName,
         this.language as QueryLanguage,
         this.cliServer,
-        this.storagePath,
+        this.qlPackStoragePath,
       );
 
       this.fileName = await this.determineNextFileName(this.folderName);
@@ -178,11 +180,11 @@ export class SkeletonQueryWizard {
   }
 
   private async determineNextFileName(folderName: string): Promise<string> {
-    if (this.storagePath === undefined) {
+    if (this.qlPackStoragePath === undefined) {
       throw new Error("Workspace storage path is undefined");
     }
 
-    const folderUri = Uri.file(join(this.storagePath, folderName));
+    const folderUri = Uri.file(join(this.qlPackStoragePath, folderName));
     const files = await workspace.fs.readDirectory(folderUri);
     const qlFiles = files.filter(([filename, _fileType]) =>
       filename.match(/example[0-9]*.ql/),
@@ -192,10 +194,14 @@ export class SkeletonQueryWizard {
   }
 
   private async downloadDatabase() {
-    if (this.storagePath === undefined) {
+    if (this.qlPackStoragePath === undefined) {
       throw new Error("Workspace storage path is undefined");
     }
 
+    if (this.databaseStoragePath === undefined) {
+      throw new Error("Database storage path is undefined");
+    }
+
     if (this.language === undefined) {
       throw new Error("Language is undefined");
     }
@@ -219,7 +225,7 @@ export class SkeletonQueryWizard {
     await databaseFetcher.downloadGitHubDatabase(
       chosenRepo,
       this.databaseManager,
-      this.storagePath,
+      this.databaseStoragePath,
       this.credentials,
       this.progress,
       this.token,
@@ -233,7 +239,7 @@ export class SkeletonQueryWizard {
       throw new Error("Language is undefined");
     }
 
-    if (this.storagePath === undefined) {
+    if (this.qlPackStoragePath === undefined) {
       throw new Error("Workspace storage path is undefined");
     }
 

extensions/ql-vscode/test/vscode-tests/cli-integration/skeleton-query-wizard.test.ts

@@ -83,11 +83,11 @@ describe("SkeletonQueryWizard", () => {
     jest.spyOn(workspace, "workspaceFolders", "get").mockReturnValue([
       {
         name: `codespaces-codeql`,
-        uri: { path: storagePath },
+        uri: { fsPath: storagePath },
       },
       {
         name: "/second/folder/path",
-        uri: { path: storagePath },
+        uri: { fsPath: storagePath },
       },
     ] as WorkspaceFolder[]);
 
@@ -114,6 +114,7 @@ describe("SkeletonQueryWizard", () => {
       extLogger,
       mockDatabaseManager,
       token,
+      storagePath,
     );
 
     askForGitHubRepoSpy = jest
@@ -244,6 +245,7 @@ describe("SkeletonQueryWizard", () => {
           extLogger,
           mockDatabaseManagerWithItems,
           token,
+          storagePath,
         );
       });
 
@@ -305,8 +307,8 @@ describe("SkeletonQueryWizard", () => {
     it("should return the first workspace folder", async () => {
       jest.spyOn(workspace, "workspaceFolders", "get").mockReturnValue([
         {
-          name: "codeql-custom-queries-cpp",
-          uri: { path: "codespaces-codeql" },
+          name: "codespaces-codeql",
+          uri: { fsPath: "codespaces-codeql" },
         },
       ] as WorkspaceFolder[]);
 
@@ -317,6 +319,7 @@ describe("SkeletonQueryWizard", () => {
         extLogger,
         mockDatabaseManager,
         token,
+        storagePath,
       );
 
       expect(wizard.getFirstStoragePath()).toEqual("codespaces-codeql");
@@ -327,11 +330,21 @@ describe("SkeletonQueryWizard", () => {
         jest.spyOn(workspace, "workspaceFolders", "get").mockReturnValue([
           {
             name: "codeql-custom-queries-cpp",
-            uri: { path: "vscode-codeql-starter/codeql-custom-queries-cpp" },
+            uri: {
+              fsPath: join(
+                "vscode-codeql-starter",
+                "codeql-custom-queries-cpp",
+              ),
+            },
           },
           {
             name: "codeql-custom-queries-csharp",
-            uri: { path: "vscode-codeql-starter/codeql-custom-queries-csharp" },
+            uri: {
+              fsPath: join(
+                "vscode-codeql-starter",
+                "codeql-custom-queries-csharp",
+              ),
+            },
           },
         ] as WorkspaceFolder[]);
 
@@ -342,6 +355,7 @@ describe("SkeletonQueryWizard", () => {
           extLogger,
           mockDatabaseManager,
           token,
+          storagePath,
         );
 
         expect(wizard.getFirstStoragePath()).toEqual("vscode-codeql-starter");