VersionInfo: add overlayVersion field

Author: cklin

src/codeql.ts

@@ -218,6 +218,15 @@ export interface CodeQL {
 export interface VersionInfo {
   version: string;
   features?: { [name: string]: boolean };
+  /**
+   * The overlay version helps deal with backward incompatible changes for
+   * overlay analysis. When a precompiled query pack reports the same overlay
+   * version as the CodeQL CLI, we can use the CodeQL CLI to perform overlay
+   * analysis with that pack. Otherwise, if the overlay versions are different,
+   * or if either the pack or the CLI does not report an overlay version,
+   * we need to revert to non-overlay analysis.
+   */
+  overlayVersion?: number;
 }
 
 export interface ResolveLanguagesOutput {

src/testing-utils.ts

@@ -254,18 +254,21 @@ export function mockLanguagesInRepo(languages: string[]) {
 export const makeVersionInfo = (
   version: string,
   features?: { [name: string]: boolean },
+  overlayVersion?: number,
 ): codeql.VersionInfo => ({
   version,
   features,
+  overlayVersion,
 });
 
 export function mockCodeQLVersion(
   version: string,
   features?: { [name: string]: boolean },
+  overlayVersion?: number,
 ) {
   return codeql.setCodeQL({
     async getVersion() {
-      return makeVersionInfo(version, features);
+      return makeVersionInfo(version, features, overlayVersion);
     },
   });
 }