Merge pull request #3543 from github/koesie10/pack-name-config

Add `codeQL.model.packName` setting

Author: koesie10

extensions/ql-vscode/package.json

@@ -470,6 +470,11 @@
             "type": "string",
             "default": ".github/codeql/extensions/${name}-${language}",
             "markdownDescription": "Location for newly created CodeQL model packs. The location can be either absolute or relative. If relative, it is relative to the workspace root.\n\nThe following variables are supported:\n* **${database}** - the name of the database\n* **${language}** - the name of the language\n* **${name}** - the name of the GitHub repository, or the name of the database if the database was not downloaded from GitHub\n* **${owner}** - the owner of the GitHub repository, or an empty string if the database was not downloaded from GitHub"
+          },
+          "codeQL.model.packName": {
+            "type": "string",
+            "default": "${owner}/${name}-${language}",
+            "markdownDescription": "Name of newly created CodeQL model packs. If the result is not a valid pack name, it will be converted to a valid pack name.\n\nThe following variables are supported:\n* **${database}** - the name of the database\n* **${language}** - the name of the language\n* **${name}** - the name of the GitHub repository, or the name of the database if the database was not downloaded from GitHub\n* **${owner}** - the owner of the GitHub repository, or an empty string if the database was not downloaded from GitHub"
           }
         }
       },

extensions/ql-vscode/src/config.ts

@@ -736,6 +736,7 @@ const LLM_GENERATION_DEV_ENDPOINT = new Setting(
 );
 const MODEL_EVALUATION = new Setting("evaluation", MODEL_SETTING);
 const MODEL_PACK_LOCATION = new Setting("packLocation", MODEL_SETTING);
+const MODEL_PACK_NAME = new Setting("packName", MODEL_SETTING);
 const ENABLE_PYTHON = new Setting("enablePython", MODEL_SETTING);
 const ENABLE_ACCESS_PATH_SUGGESTIONS = new Setting(
   "enableAccessPathSuggestions",
@@ -757,6 +758,7 @@ export interface ModelConfig {
     languageId: string,
     variables: ModelConfigPackVariables,
   ): string;
+  getPackName(languageId: string, variables: ModelConfigPackVariables): string;
   enablePython: boolean;
   enableAccessPathSuggestions: boolean;
 }
@@ -810,6 +812,18 @@ export class ModelConfigListener extends ConfigListener implements ModelConfig {
     );
   }
 
+  public getPackName(
+    languageId: string,
+    variables: ModelConfigPackVariables,
+  ): string {
+    return substituteConfigVariables(
+      MODEL_PACK_NAME.getValue<string>({
+        languageId,
+      }),
+      variables,
+    );
+  }
+
   public get enablePython(): boolean {
     return !!ENABLE_PYTHON.getValue<boolean>();
   }

extensions/ql-vscode/src/model-editor/extension-pack-name.ts

@@ -15,11 +15,19 @@ export function formatPackName(packName: ExtensionPackName): string {
   return `${packName.scope}/${packName.name}`;
 }
 
-export function autoNameExtensionPack(
-  name: string,
-  language: string,
-): ExtensionPackName | undefined {
-  let packName = `${name}-${language}`;
+export function sanitizePackName(userPackName: string): ExtensionPackName {
+  let packName = userPackName;
+
+  packName = packName.trim();
+
+  while (packName.startsWith("/")) {
+    packName = packName.slice(1);
+  }
+
+  while (packName.endsWith("/")) {
+    packName = packName.slice(0, -1);
+  }
+
   if (!packName.includes("/")) {
     packName = `pack/${packName}`;
   }

extensions/ql-vscode/src/model-editor/extension-pack-picker.ts

@@ -15,7 +15,11 @@ import type { NotificationLogger } from "../common/logging";
 import { showAndLogErrorMessage } from "../common/logging";
 import type { ModelConfig, ModelConfigPackVariables } from "../config";
 import type { ExtensionPackName } from "./extension-pack-name";
-import { autoNameExtensionPack, formatPackName } from "./extension-pack-name";
+import {
+  validatePackName,
+  sanitizePackName,
+  formatPackName,
+} from "./extension-pack-name";
 import {
   ensurePackLocationIsInWorkspaceFolder,
   packLocationToAbsolute,
@@ -80,15 +84,20 @@ export async function pickExtensionPack(
 
   await ensurePackLocationIsInWorkspaceFolder(packPath, modelConfig, logger);
 
-  // Generate the name of the extension pack
-  const packName = autoNameExtensionPack(
-    databaseItem.name,
+  const userPackName = modelConfig.getPackName(
     databaseItem.language,
+    getModelConfigPackVariables(databaseItem),
   );
-  if (!packName) {
+
+  // Generate the name of the extension pack
+  const packName = sanitizePackName(userPackName);
+
+  // Validate that the name isn't too long etc.
+  const packNameError = validatePackName(formatPackName(packName));
+  if (packNameError) {
     void showAndLogErrorMessage(
       logger,
-      `Could not automatically name extension pack for database ${databaseItem.name}`,
+      `Invalid model pack name '${formatPackName(packName)}' for database ${databaseItem.name}: ${packNameError}`,
     );
 
     return undefined;

extensions/ql-vscode/test/unit-tests/model-editor/extension-pack-name.test.ts

@@ -1,82 +1,81 @@
 import {
-  autoNameExtensionPack,
+  sanitizePackName,
   formatPackName,
   parsePackName,
   validatePackName,
 } from "../../../src/model-editor/extension-pack-name";
 
-describe("autoNameExtensionPack", () => {
+describe("sanitizePackName", () => {
   const testCases: Array<{
     name: string;
-    language: string;
     expected: string;
   }> = [
     {
-      name: "github/vscode-codeql",
-      language: "javascript",
+      name: "github/vscode-codeql-javascript",
       expected: "github/vscode-codeql-javascript",
     },
     {
-      name: "vscode-codeql",
-      language: "a",
+      name: "vscode-codeql-a",
       expected: "pack/vscode-codeql-a",
     },
     {
-      name: "b",
-      language: "java",
+      name: "b-java",
       expected: "pack/b-java",
     },
     {
-      name: "a/b",
-      language: "csharp",
+      name: "a/b-csharp",
       expected: "a/b-csharp",
     },
     {
-      name: "-/b",
-      language: "csharp",
+      name: "-/b-csharp",
       expected: "pack/b-csharp",
     },
     {
-      name: "a/b/c/d",
-      language: "csharp",
+      name: "a/b/c/d-csharp",
       expected: "a/b-c-d-csharp",
     },
     {
-      name: "JAVA/CodeQL",
-      language: "csharp",
+      name: "JAVA/CodeQL-csharp",
       expected: "java/codeql-csharp",
     },
     {
-      name: "my new pack",
-      language: "swift",
+      name: "my new pack-swift",
       expected: "pack/my-new-pack-swift",
     },
     {
-      name: "gïthub/vscode-codeql",
-      language: "javascript",
+      name: "gïthub/vscode-codeql-javascript",
       expected: "gthub/vscode-codeql-javascript",
     },
     {
-      name: "a/b-",
-      language: "csharp",
+      name: "a/b-csharp",
       expected: "a/b-csharp",
     },
     {
-      name: "-a-/b",
-      language: "ruby",
+      name: "-a-/b-ruby",
       expected: "a/b-ruby",
     },
     {
-      name: "a/b--d--e-d-",
-      language: "csharp",
+      name: "a/b--d--e-d-csharp",
       expected: "a/b-d-e-d-csharp",
     },
+    {
+      name: "/github/vscode-codeql",
+      expected: "github/vscode-codeql",
+    },
+    {
+      name: "github/vscode-codeql/",
+      expected: "github/vscode-codeql",
+    },
+    {
+      name: "///github/vscode-codeql///",
+      expected: "github/vscode-codeql",
+    },
   ];
 
   test.each(testCases)(
     "$name with $language = $expected",
-    ({ name, language, expected }) => {
-      const result = autoNameExtensionPack(name, language);
+    ({ name, expected }) => {
+      const result = sanitizePackName(name);
       expect(result).not.toBeUndefined();
       if (!result) {
         return;