Apply suggestions from code review

init/action.yml

@@ -15,7 +15,7 @@ inputs:
     required: false
   registries:
     description: |
-      A YAML string that defines the list of GitHub container registries to use for downloading packs. The string is in the following forma (the | is required on the first line):
+      A YAML string that defines the list of GitHub container registries to use for downloading packs. The string is in the following form (the | is required on the first line):
 
       registries: |
           - url: https://containers.GHEHOSTNAME1/v2/
@@ -28,7 +28,7 @@ inputs:
             packages: */*
             token: ${{ secrets.GHCR_TOKEN }}
 
-      The url property contains the url to the container registry you want to connect to.
+      The url property contains the URL to the container registry you want to connect to.
 
       The packages property contains a single entry or a list of globs specifying packages that can be found in the container registry. Order is important. Earlier entries will match before later entries.
 

lib/config-utils.js

@@ -919,10 +919,12 @@ async function initConfig(languagesInput, queriesInput, packsInput, registriesIn
 exports.initConfig = initConfig;
 function parseRegistries(registriesInput) {
     try {
-        return registriesInput ? yaml.l(registriesInput) : undefined;
+        return registriesInput
+            ? yaml.load(registriesInput)
+            : undefined;
     }
     catch (e) {
-        throw new Error(`Invalid registries input. Must be a JSON string, but got: ${e instanceof Error ? e.message : String(e)}`);
+        throw new Error("Invalid registries input. Must be a YAML string.");
     }
 }
 function isLocal(configPath) {
@@ -1054,6 +1056,18 @@ function createRegistriesBlock(registries) {
     };
     return qlconfig;
 }
+/**
+ * Create a temporary environment based on the existing environment and overridden
+ * by the given environment variables that are passed in as arguments.
+ *
+ * Use this new environment in the context of the given operation. After completing
+ * the operation, restore the original environment.
+ *
+ * This function does not support un-setting environment variables.
+ *
+ * @param env
+ * @param operation
+ */
 async function wrapEnvironment(env, operation) {
     // Remember the original env
     const oldEnv = { ...process.env };

lib/config-utils.test.js

@@ -1105,7 +1105,9 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
             java: ["a", "b"],
             go: ["c", "d"],
             python: ["e", "f"],
-        }, undefined, sampleApiDetails, tmpDir, logger);
+        }, undefined, // registries
+        sampleApiDetails, tmpDir, logger);
+        // Expecting packs to be downloaded once for java and once for python
         t.deepEqual(packDownloadStub.callCount, 2);
         // no config file was created, so pass `undefined` as the config file path
         t.deepEqual(packDownloadStub.firstCall.args, [["a", "b"], undefined]);
@@ -1128,7 +1130,7 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
             {
                 url: "https://containers.GHEHOSTNAME1/v2/",
                 packages: "semmle/*",
-                token: "still-a-token",
+                token: "still-not-a-token",
             },
         ];
         const expectedConfigFile = path.join(tmpDir, "qlconfig.yml");
@@ -1136,7 +1138,7 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
         packDownloadStub.callsFake((packs, configFile) => {
             t.deepEqual(configFile, expectedConfigFile);
             // verify the env vars were set correctly
-            t.deepEqual(process.env.GITHUB_TOKEN, "token");
+            t.deepEqual(process.env.GITHUB_TOKEN, sampleApiDetails.auth);
             t.deepEqual(process.env.CODEQL_REGISTRIES_AUTH, "http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-a-token");
             // verify the config file contents were set correctly
             const config = yaml.load(fs.readFileSync(configFile, "utf8"));

src/config-utils.test.ts

@@ -2253,12 +2253,13 @@ test("downloadPacks-no-registries", async (t) => {
         go: ["c", "d"],
         python: ["e", "f"],
       },
-      undefined,
+      undefined, // registries
       sampleApiDetails,
       tmpDir,
       logger
     );
 
+    // Expecting packs to be downloaded once for java and once for python
     t.deepEqual(packDownloadStub.callCount, 2);
     // no config file was created, so pass `undefined` as the config file path
     t.deepEqual(packDownloadStub.firstCall.args, [["a", "b"], undefined]);
@@ -2283,7 +2284,7 @@ test("downloadPacks-with-registries", async (t) => {
       {
         url: "https://containers.GHEHOSTNAME1/v2/",
         packages: "semmle/*",
-        token: "still-a-token",
+        token: "still-not-a-token",
       },
     ];
 
@@ -2292,7 +2293,7 @@ test("downloadPacks-with-registries", async (t) => {
     packDownloadStub.callsFake((packs, configFile) => {
       t.deepEqual(configFile, expectedConfigFile);
       // verify the env vars were set correctly
-      t.deepEqual(process.env.GITHUB_TOKEN, "token");
+      t.deepEqual(process.env.GITHUB_TOKEN, sampleApiDetails.auth);
       t.deepEqual(
         process.env.CODEQL_REGISTRIES_AUTH,
         "http://ghcr.io=not-a-token,https://containers.GHEHOSTNAME1/v2/=still-a-token"
@@ -2300,7 +2301,7 @@ test("downloadPacks-with-registries", async (t) => {
 
       // verify the config file contents were set correctly
       const config = yaml.load(fs.readFileSync(configFile, "utf8")) as {
-        registries: configUtils.SafeRegistryConfig[];
+        registries: configUtils.RegistryConfigNoCredentials[];
       };
       t.deepEqual(
         config.registries,

src/config-utils.ts

@@ -61,7 +61,7 @@ export interface UserConfig {
 
 export type QueryFilter = ExcludeQueryFilter | IncludeQueryFilter;
 
-export type RegistryConfig = SafeRegistryConfig & {
+export type RegistryConfigWithCredentials = RegistryConfigNoCredentials & {
   // Token to use when downloading packs from this registry.
   token: string;
 };
@@ -70,7 +70,7 @@ export type RegistryConfig = SafeRegistryConfig & {
  * The list of registries and the associated pack globs that determine where each
  * pack can be downloaded from.
  */
-export interface SafeRegistryConfig {
+export interface RegistryConfigNoCredentials {
   // URL of a package registry, eg- https://ghcr.io/v2/
   url: string;
 
@@ -1721,15 +1721,15 @@ export async function initConfig(
   return config;
 }
 
-function parseRegistries(registriesInput: string | undefined) {
+function parseRegistries(
+  registriesInput: string | undefined
+): RegistryConfigWithCredentials[] | undefined {
   try {
-    return registriesInput ? yaml.l(registriesInput) : undefined;
+    return registriesInput
+      ? (yaml.load(registriesInput) as RegistryConfigWithCredentials[])
+      : undefined;
   } catch (e) {
-    throw new Error(
-      `Invalid registries input. Must be a JSON string, but got: ${
-        e instanceof Error ? e.message : String(e)
-      }`
-    );
+    throw new Error("Invalid registries input. Must be a YAML string.");
   }
 }
 
@@ -1834,7 +1834,7 @@ export async function downloadPacks(
   codeQL: CodeQL,
   languages: Language[],
   packs: Packs,
-  registries: RegistryConfig[] | undefined,
+  registries: RegistryConfigWithCredentials[] | undefined,
   apiDetails: api.GitHubApiDetails,
   tmpDir: string,
   logger: Logger
@@ -1888,7 +1888,9 @@ export async function downloadPacks(
   );
 }
 
-function createRegistriesBlock(registries: RegistryConfig[]) {
+function createRegistriesBlock(registries: RegistryConfigWithCredentials[]): {
+  registries: RegistryConfigNoCredentials[];
+} {
   // be sure to remove the `token` field from the registry before writing it to disk.
   const safeRegistries = registries.map((registry) => ({
     url: registry.url,
@@ -1900,6 +1902,18 @@ function createRegistriesBlock(registries: RegistryConfig[]) {
   return qlconfig;
 }
 
+/**
+ * Create a temporary environment based on the existing environment and overridden
+ * by the given environment variables that are passed in as arguments.
+ *
+ * Use this new environment in the context of the given operation. After completing
+ * the operation, restore the original environment.
+ *
+ * This function does not support un-setting environment variables.
+ *
+ * @param env
+ * @param operation
+ */
 async function wrapEnvironment(
   env: Record<string, string | undefined>,
   operation: Function