Fix tests by using API Key for CI (#2255)

* Fix tests by using API Key for CI

* new lines so codacy is happy

* better logging of errors

* tslint

* refactor to more concise code

Author: TylerLeonhardt

src/features/UpdatePowerShell.ts

@@ -2,7 +2,7 @@
  * Copyright (C) Microsoft Corporation. All rights reserved.
  *--------------------------------------------------------*/
 
-import fetch from "node-fetch";
+import fetch, { RequestInit } from "node-fetch";
 import * as semver from "semver";
 import { MessageItem, window } from "vscode";
 import { LanguageClient } from "vscode-languageclient";
@@ -16,18 +16,33 @@ const PowerShellGitHubPrereleasesUrl =
 
 export class GitHubReleaseInformation {
     public static async FetchLatestRelease(preview: boolean): Promise<GitHubReleaseInformation> {
+        const requestConfig: RequestInit = {};
+
+        // For CI. This prevents GitHub from rate limiting us.
+        if (process.env.PS_TEST_GITHUB_API_USERNAME && process.env.PS_TEST_GITHUB_API_PAT) {
+            const authHeaderValue = Buffer
+                .from(`${process.env.PS_TEST_GITHUB_API_USERNAME}:${process.env.PS_TEST_GITHUB_API_PAT}`)
+                .toString("base64");
+            requestConfig.headers = {
+                Authorization: `Basic ${authHeaderValue}`,
+            };
+        }
+
         // Fetch the latest PowerShell releases from GitHub.
-        let releaseJson: any;
-        if (preview) {
-            // This gets all releases and the first one is the latest prerelease if
-            // there is a prerelease version.
-            releaseJson = (await fetch(PowerShellGitHubPrereleasesUrl)
-                .then((res) => res.json())).find((release: any) => release.prerelease);
-        } else {
-            releaseJson = await fetch(PowerShellGitHubReleasesUrl)
-                .then((res) => res.json());
+        const response = await fetch(
+            preview ? PowerShellGitHubPrereleasesUrl : PowerShellGitHubReleasesUrl,
+            requestConfig);
+
+        if (!response.ok) {
+            const json = await response.json();
+            throw json.message || json || "response was not ok.";
         }
 
+        // For preview, we grab all the releases and then grab the first prerelease.
+        const releaseJson = preview
+            ? (await response.json()).find((release: any) => release.prerelease)
+            : await response.json();
+
         return new GitHubReleaseInformation(
             releaseJson.tag_name, releaseJson.assets);
     }

src/session.ts

@@ -591,8 +591,9 @@ export class SessionManager implements Middleware {
                                         localVersion,
                                         this.versionDetails.architecture,
                                         release);
-                                } catch {
+                                } catch (e) {
                                     // best effort. This probably failed to fetch the data from GitHub.
+                                    this.log.writeWarning(e.message);
                                 }
                             });