Merge pull request #2876 from github/henrymercer/fix-diff-informed-multiple-analyze

 Do not fail diff informed analyses when analyze is run twice in the same job

Author: henrymercer

.github/workflows/codescanning-config-cli.yml

@@ -3,6 +3,9 @@
 name: Code-Scanning config CLI tests
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  # Diff informed queries add an additional query filter which is not yet
+  # taken into account by these tests.
+  CODEQL_ACTION_DIFF_INFORMED_QUERIES: false
 
 on:
   push:

lib/analyze.js

@@ -507,7 +507,13 @@ function writeDiffRangeDataExtensionPack(
     actionsUtil.getTemporaryDirectory(),
     "pr-diff-range",
   );
-  fs.mkdirSync(diffRangeDir);
+
+  // We expect the Actions temporary directory to already exist, so are mainly
+  // using `recursive: true` to avoid errors if the directory already exists,
+  // for example if the analyze Action is run multiple times in the same job.
+  // This is not really something that is supported, but we make use of it in
+  // tests.
+  fs.mkdirSync(diffRangeDir, { recursive: true });
   fs.writeFileSync(
     path.join(diffRangeDir, "qlpack.yml"),
     `

lib/analyze.js.map

@@ -41,42 +41,44 @@ export function getJavaTempDependencyDir(): string {
 /**
  * Default caching configurations per language.
  */
-const CODEQL_DEFAULT_CACHE_CONFIG: { [language: string]: CacheConfig } = {
-  java: {
-    paths: [
-      // Maven
-      join(os.homedir(), ".m2", "repository"),
-      // Gradle
-      join(os.homedir(), ".gradle", "caches"),
-      // CodeQL Java build-mode: none
-      getJavaTempDependencyDir(),
-    ],
-    hash: [
-      // Maven
-      "**/pom.xml",
-      // Gradle
-      "**/*.gradle*",
-      "**/gradle-wrapper.properties",
-      "buildSrc/**/Versions.kt",
-      "buildSrc/**/Dependencies.kt",
-      "gradle/*.versions.toml",
-      "**/versions.properties",
-    ],
-  },
-  csharp: {
-    paths: [join(os.homedir(), ".nuget", "packages")],
-    hash: [
-      // NuGet
-      "**/packages.lock.json",
-      // Paket
-      "**/paket.lock",
-    ],
-  },
-  go: {
-    paths: [join(os.homedir(), "go", "pkg", "mod")],
-    hash: ["**/go.sum"],
-  },
-};
+function getDefaultCacheConfig(): { [language: string]: CacheConfig } {
+  return {
+    java: {
+      paths: [
+        // Maven
+        join(os.homedir(), ".m2", "repository"),
+        // Gradle
+        join(os.homedir(), ".gradle", "caches"),
+        // CodeQL Java build-mode: none
+        getJavaTempDependencyDir(),
+      ],
+      hash: [
+        // Maven
+        "**/pom.xml",
+        // Gradle
+        "**/*.gradle*",
+        "**/gradle-wrapper.properties",
+        "buildSrc/**/Versions.kt",
+        "buildSrc/**/Dependencies.kt",
+        "gradle/*.versions.toml",
+        "**/versions.properties",
+      ],
+    },
+    csharp: {
+      paths: [join(os.homedir(), ".nuget", "packages")],
+      hash: [
+        // NuGet
+        "**/packages.lock.json",
+        // Paket
+        "**/paket.lock",
+      ],
+    },
+    go: {
+      paths: [join(os.homedir(), "go", "pkg", "mod")],
+      hash: ["**/go.sum"],
+    },
+  };
+}
 
 async function makeGlobber(patterns: string[]): Promise<glob.Globber> {
   return glob.create(patterns.join("\n"));
@@ -96,7 +98,7 @@ export async function downloadDependencyCaches(
   const restoredCaches: Language[] = [];
 
   for (const language of languages) {
-    const cacheConfig = CODEQL_DEFAULT_CACHE_CONFIG[language];
+    const cacheConfig = getDefaultCacheConfig()[language];
 
     if (cacheConfig === undefined) {
       logger.info(
@@ -150,7 +152,7 @@ export async function downloadDependencyCaches(
  */
 export async function uploadDependencyCaches(config: Config, logger: Logger) {
   for (const language of config.languages) {
-    const cacheConfig = CODEQL_DEFAULT_CACHE_CONFIG[language];
+    const cacheConfig = getDefaultCacheConfig()[language];
 
     if (cacheConfig === undefined) {
       logger.info(