Merge remote-tracking branch 'origin/main' into koesie10/add-database-source

Author: koesie10

extensions/ql-vscode/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [UNRELEASED]
 
+- When adding a CodeQL database, we no longer add the database source folder to the workspace by default (since this caused bugs in single-folder workspaces). [#3047](https://github.com/github/vscode-codeql/pull/3047)
+  - You can manually add individual database source folders to the workspace with the "Add Database Source to Workspace" right-click command in the databases view.
+  - To restore the old behavior of adding all database source folders by default, set the `codeQL.addingDatabases.addDatabaseSourceToWorkspace` setting to `true`.
+- Rename the `codeQL.databaseDownload.allowHttp` setting to `codeQL.addingDatabases.allowHttp`, so that database-related settings are grouped together in the Settings UI. [#3047](https://github.com/github/vscode-codeql/pull/3047)
 - The "Sort by Language" action in the databases view now sorts by name within each language. [#3055](https://github.com/github/vscode-codeql/pull/3055)
 
 ## 1.9.4 - 6 November 2023

extensions/ql-vscode/package.json

@@ -372,13 +372,23 @@
       },
       {
         "type": "object",
-        "title": "Downloading databases",
+        "title": "Adding databases",
         "order": 6,
         "properties": {
+          "codeQL.addingDatabases.allowHttp": {
+            "type": "boolean",
+            "default": false,
+            "description": "Allow databases to be downloaded via HTTP. Warning: enabling this option will allow downloading from insecure servers."
+          },
           "codeQL.databaseDownload.allowHttp": {
+            "type": "boolean",
+            "markdownDeprecationMessage": "**Deprecated**: Please use `#codeQL.addingDatabases.allowHttp#` instead.",
+            "deprecationMessage": "Deprecated: Please use codeQL.addingDatabases.allowHttp instead."
+          },
+          "codeQL.addingDatabases.addDatabaseSourceToWorkspace": {
             "type": "boolean",
             "default": false,
-            "description": "Allow database to be downloaded via HTTP. Warning: enabling this option will allow downloading from insecure servers."
+            "markdownDescription": "When adding a CodeQL database, automatically add the database's source folder as a workspace folder. Warning: enabling this option in a single-folder workspace will cause the workspace to reload as a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces). This may cause query history and database lists to be reset."
           }
         }
       },

extensions/ql-vscode/src/common/vscode/workspace-folders.ts

@@ -43,7 +43,9 @@ export function getFirstWorkspaceFolder() {
   const workspaceFolders = getOnDiskWorkspaceFolders();
 
   if (!workspaceFolders || workspaceFolders.length === 0) {
-    throw new Error("No workspace folders found");
+    throw new Error(
+      "No workspace folders found. Please open a folder or workspace in VS Code.",
+    );
   }
 
   const firstFolderFsPath = workspaceFolders[0];

extensions/ql-vscode/src/config.ts

@@ -641,14 +641,23 @@ export function isCodespacesTemplate() {
   return !!CODESPACES_TEMPLATE.getValue<boolean>();
 }
 
-const DATABASE_DOWNLOAD_SETTING = new Setting("databaseDownload", ROOT_SETTING);
+const ADDING_DATABASES_SETTING = new Setting("addingDatabases", ROOT_SETTING);
 
-const ALLOW_HTTP_SETTING = new Setting("allowHttp", DATABASE_DOWNLOAD_SETTING);
+const ALLOW_HTTP_SETTING = new Setting("allowHttp", ADDING_DATABASES_SETTING);
 
 export function allowHttp(): boolean {
   return ALLOW_HTTP_SETTING.getValue<boolean>() || false;
 }
 
+const ADD_DATABASE_SOURCE_TO_WORKSPACE_SETTING = new Setting(
+  "addDatabaseSourceToWorkspace",
+  ADDING_DATABASES_SETTING,
+);
+
+export function addDatabaseSourceToWorkspace(): boolean {
+  return ADD_DATABASE_SOURCE_TO_WORKSPACE_SETTING.getValue<boolean>() || false;
+}
+
 /**
  * Parent setting for all settings related to the "Create Query" command.
  */

extensions/ql-vscode/src/databases/database-fetcher.ts

@@ -29,7 +29,7 @@ import {
 } from "../common/github-url-identifier-helper";
 import { Credentials } from "../common/authentication";
 import { AppCommandManager } from "../common/commands";
-import { allowHttp } from "../config";
+import { addDatabaseSourceToWorkspace, allowHttp } from "../config";
 import { showAndLogInformationMessage } from "../common/logging";
 import { AppOctokit } from "../common/octokit";
 import { getLanguageDisplayName } from "../common/query-language";
@@ -104,7 +104,7 @@ export async function promptImportGithubDatabase(
   cli?: CodeQLCliServer,
   language?: string,
   makeSelected = true,
-  addSourceArchiveFolder = true,
+  addSourceArchiveFolder = addDatabaseSourceToWorkspace(),
 ): Promise<DatabaseItem | undefined> {
   const githubRepo = await askForGitHubRepo(progress);
   if (!githubRepo) {
@@ -183,7 +183,7 @@ export async function downloadGitHubDatabase(
   cli?: CodeQLCliServer,
   language?: string,
   makeSelected = true,
-  addSourceArchiveFolder = true,
+  addSourceArchiveFolder = addDatabaseSourceToWorkspace(),
 ): Promise<DatabaseItem | undefined> {
   const nwo = getNwoFromGitHubUrl(githubRepo) || githubRepo;
   if (!isValidGitHubNwo(nwo)) {
@@ -311,7 +311,7 @@ async function databaseArchiveFetcher(
   progress: ProgressCallback,
   cli?: CodeQLCliServer,
   makeSelected = true,
-  addSourceArchiveFolder = true,
+  addSourceArchiveFolder = addDatabaseSourceToWorkspace(),
 ): Promise<DatabaseItem> {
   progress({
     message: "Getting database",
@@ -493,7 +493,7 @@ async function checkForFailingResponse(
     return response;
   }
 
-  // An error downloading the database. Attempt to extract the resaon behind it.
+  // An error downloading the database. Attempt to extract the reason behind it.
   const text = await response.text();
   let msg: string;
   try {

extensions/ql-vscode/src/databases/local-databases/database-manager.ts

@@ -7,6 +7,7 @@ import { QueryRunner } from "../../query-server";
 import * as cli from "../../codeql-cli/cli";
 import { ProgressCallback, withProgress } from "../../common/vscode/progress";
 import {
+  addDatabaseSourceToWorkspace,
   getAutogenerateQlPacks,
   isCodespacesTemplate,
   setAutogenerateQlPacks,
@@ -137,7 +138,7 @@ export class DatabaseManager extends DisposableObject {
     displayName?: string,
     {
       isTutorialDatabase = false,
-      addSourceArchiveFolder = true,
+      addSourceArchiveFolder = addDatabaseSourceToWorkspace(),
     }: OpenDatabaseOptions = {},
   ): Promise<DatabaseItem> {
     const databaseItem = await this.createDatabaseItem(
@@ -164,7 +165,7 @@ export class DatabaseManager extends DisposableObject {
     databaseItem: DatabaseItemImpl,
     makeSelected: boolean,
     isTutorialDatabase?: boolean,
-    addSourceArchiveFolder = true,
+    addSourceArchiveFolder = addDatabaseSourceToWorkspace(),
   ): Promise<DatabaseItem> {
     const existingItem = this.findDatabaseItem(databaseItem.databaseUri);
     if (existingItem !== undefined) {
@@ -274,7 +275,7 @@ export class DatabaseManager extends DisposableObject {
       `We've noticed you don't have a CodeQL pack available to analyze this database. Can we set up a query pack for you?`,
     );
 
-    if (answer === "No") {
+    if (answer === "No" || answer === undefined) {
       return;
     }
 

extensions/ql-vscode/src/model-editor/modeled-method.ts

@@ -126,3 +126,38 @@ export function isModelAccepted(
     modeledMethod.provenance !== "ai-generated"
   );
 }
+
+/**
+ * Calculates the new provenance for a modeled method based on the current provenance.
+ * @param modeledMethod The modeled method if there is one.
+ * @returns The new provenance.
+ */
+export function calculateNewProvenance(
+  modeledMethod: ModeledMethod | undefined,
+) {
+  if (!modeledMethod || !modeledMethodSupportsProvenance(modeledMethod)) {
+    // If nothing has been modeled or the modeled method does not support
+    // provenance, we assume that the user has entered it manually.
+    return "manual";
+  }
+
+  switch (modeledMethod.provenance) {
+    case "df-generated":
+      // If the method has been generated and there has been a change, we assume
+      // that the user has manually edited it.
+      return "df-manual";
+    case "df-manual":
+      // If the method has had manual edits, we want the provenance to stay the same.
+      return "df-manual";
+    case "ai-generated":
+      // If the method has been generated and there has been a change, we assume
+      // that the user has manually edited it.
+      return "ai-manual";
+    case "ai-manual":
+      // If the method has had manual edits, we want the provenance to stay the same.
+      return "ai-manual";
+    default:
+      // The method has been modeled manually.
+      return "manual";
+  }
+}

extensions/ql-vscode/src/view/common/DeterminateProgressRing.tsx

@@ -3,7 +3,6 @@ import { styled } from "styled-components";
 
 type Props = {
   percent: number;
-  label?: string;
 };
 
 const Circle = styled.div`
@@ -33,10 +32,7 @@ const progressSegments = 44;
 // See https://github.com/microsoft/fast/blob/21c210f2164c5cf285cade1a328460c67e4b97e6/packages/web-components/fast-foundation/src/progress-ring/progress-ring.template.ts
 // Once the determinate progress ring is available in the VSCode webview UI toolkit, we should use that instead
 
-export const DeterminateProgressRing = ({
-  percent,
-  label = "Loading...",
-}: Props) => (
+export const DeterminateProgressRing = ({ percent }: Props) => (
   <Circle
     role="progressbar"
     aria-valuemin={0}

extensions/ql-vscode/src/view/model-editor/LibraryRow.tsx

@@ -226,7 +226,6 @@ export const LibraryRow = ({
         <>
           <SectionDivider />
           <ModeledMethodDataGrid
-            packageName={title}
             methods={methods}
             modeledMethodsMap={modeledMethodsMap}
             modifiedSignatures={modifiedSignatures}

extensions/ql-vscode/src/view/model-editor/ModelInputDropdown.tsx

@@ -2,6 +2,7 @@ import * as React from "react";
 import { ChangeEvent, useCallback, useMemo } from "react";
 import {
   ModeledMethod,
+  calculateNewProvenance,
   isModelAccepted,
   modeledMethodSupportsInput,
 } from "../../model-editor/modeled-method";
@@ -53,6 +54,7 @@ export const ModelInputDropdown = ({
 
       onChange({
         ...modeledMethod,
+        provenance: calculateNewProvenance(modeledMethod),
         input: target.value,
       });
     },