Log the version warning a second time if a request fails unexpectedly.

github · Nov 3, 2020 · b16110e · b16110e
1 parent 5e2fa08
commit b16110e
Showing 6 changed files with 62 additions and 55 deletions.
diff --git a/lib/api-client.js b/lib/api-client.js
diff --git a/lib/api-client.js.map b/lib/api-client.js.map
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/src/api-client.ts b/src/api-client.ts
@@ -27,49 +27,53 @@ export const getApiClient = function (
   githubUrl: string,
   mode: Mode,
   logger: Logger,
-  allowLocalRun = false
+  allowLocalRun = false,
+  possibleFailureExpected = false
 ) {
   if (isLocalRun() && !allowLocalRun) {
     throw new Error("Invalid API call in local run");
   }
   const customOctokit = githubUtils.GitHub.plugin(retry.retry, (octokit, _) => {
     octokit.hook.after("request", (response: OctokitResponse<any>, _) => {
+      if (response.status < 400 && !possibleFailureExpected) {
+        if (hasBeenWarnedAboutVersion) {
+          return;
+        }
+      }
       if (
-        !hasBeenWarnedAboutVersion &&
-        response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] !== undefined &&
-        process.env[CODEQL_ACTION_WARNED_ABOUT_VERSION_ENV_VAR] !== undefined
+        response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] === undefined ||
+        process.env[CODEQL_ACTION_WARNED_ABOUT_VERSION_ENV_VAR] === undefined
       ) {
-        const installedVersion = response.headers[
-          GITHUB_ENTERPRISE_VERSION_HEADER
-        ] as string;
-        const disallowedAPIVersionReason = apiVersionInRange(
-          installedVersion,
-          apiCompatibility.minimumVersion,
-          apiCompatibility.maximumVersion
-        );
+        return;
+      }
+      const installedVersion = response.headers[
+        GITHUB_ENTERPRISE_VERSION_HEADER
+      ] as string;
+      const disallowedAPIVersionReason = apiVersionInRange(
+        installedVersion,
+        apiCompatibility.minimumVersion,
+        apiCompatibility.maximumVersion
+      );
 
-        const toolName = mode === "actions" ? "Action" : "Runner";
+      const toolName = mode === "actions" ? "Action" : "Runner";
 
-        if (
-          disallowedAPIVersionReason ===
-          DisallowedAPIVersionReason.ACTION_TOO_OLD
-        ) {
-          logger.warning(
-            `The CodeQL ${toolName} version you are using is too old to be compatible with GitHub Enterprise ${installedVersion}. If you experience issues, please upgrade to a more recent version of the CodeQL ${toolName}.`
-          );
-        }
-        if (
-          disallowedAPIVersionReason ===
-          DisallowedAPIVersionReason.ACTION_TOO_NEW
-        ) {
-          logger.warning(
-            `GitHub Enterprise ${installedVersion} is too old to be compatible with this version of the CodeQL ${toolName}. If you experience issues, please upgrade to a more recent version of GitHub Enterprise or use an older version of the CodeQL ${toolName}.`
-          );
-        }
-        hasBeenWarnedAboutVersion = true;
-        if (mode === "actions") {
-          exportVariable(CODEQL_ACTION_WARNED_ABOUT_VERSION_ENV_VAR, true);
-        }
+      if (
+        disallowedAPIVersionReason === DisallowedAPIVersionReason.ACTION_TOO_OLD
+      ) {
+        logger.warning(
+          `The CodeQL ${toolName} version you are using is too old to be compatible with GitHub Enterprise ${installedVersion}. If you experience issues, please upgrade to a more recent version of the CodeQL ${toolName}.`
+        );
+      }
+      if (
+        disallowedAPIVersionReason === DisallowedAPIVersionReason.ACTION_TOO_NEW
+      ) {
+        logger.warning(
+          `GitHub Enterprise ${installedVersion} is too old to be compatible with this version of the CodeQL ${toolName}. If you experience issues, please upgrade to a more recent version of GitHub Enterprise or use an older version of the CodeQL ${toolName}.`
+        );
+      }
+      hasBeenWarnedAboutVersion = true;
+      if (mode === "actions") {
+        exportVariable(CODEQL_ACTION_WARNED_ABOUT_VERSION_ENV_VAR, true);
       }
     });
   });

diff --git a/src/codeql.ts b/src/codeql.ts
@@ -188,7 +188,7 @@ async function getCodeQLBundleDownloadURL(
     const [repositoryOwner, repositoryName] = repository.split("/");
     try {
       const release = await api
-        .getApiClient(githubAuth, githubUrl, mode, logger)
+        .getApiClient(githubAuth, githubUrl, mode, logger, false, true)
         .repos.getReleaseByTag({
           owner: repositoryOwner,
           repo: repositoryName,