Merge pull request #94 from github/thyeggman/internet-connectivity

Do validation and add internet connectivity indictator to the extension

Author: thyeggman

src/extension.ts

@@ -1,7 +1,5 @@
 import * as vscode from "vscode";
 
-import {init as initLogger, log, revealLog} from "./log";
-
 import {registerCancelWorkflowRun} from "./commands/cancelWorkflowRun";
 import {registerOpenWorkflowFile} from "./commands/openWorkflowFile";
 import {registerOpenWorkflowJobLogs} from "./commands/openWorkflowJobLogs";
@@ -20,6 +18,7 @@ import {registerDeleteVariable} from "./commands/variables/deleteVariable";
 import {registerUpdateVariable} from "./commands/variables/updateVariable";
 import {initConfiguration} from "./configuration/configuration";
 import {getGitHubContext} from "./git/repository";
+import {init as initLogger, log, revealLog} from "./log";
 import {LogScheme} from "./logs/constants";
 import {WorkflowStepLogProvider} from "./logs/fileProvider";
 import {WorkflowStepLogFoldingProvider} from "./logs/foldingProvider";

src/git/repository.ts

@@ -6,6 +6,7 @@ import {getRemoteName} from "../configuration/configuration";
 import {Protocol} from "../external/protocol";
 import {logDebug, logError} from "../log";
 import {API, GitExtension, RefType, RepositoryState} from "../typings/git";
+import {canReachGitHubAPI} from "../util";
 
 interface GitHubUrls {
   workspaceUri: vscode.Uri;
@@ -142,6 +143,11 @@ export async function getGitHubContext(): Promise<GitHubContext | undefined> {
     return gitHubContext;
   }
 
+  if (!(await canReachGitHubAPI())) {
+    logError(new Error("Cannot fetch github context"));
+    return undefined;
+  }
+
   try {
     const git = await getGitExtension();
 

src/treeViews/currentBranch.ts

@@ -3,16 +3,18 @@ import * as vscode from "vscode";
 import {getCurrentBranch, getGitHubContext, GitHubRepoContext} from "../git/repository";
 import {CurrentBranchRepoNode} from "./current-branch/currentBranchRepoNode";
 
+import {NoRunForBranchNode} from "./current-branch/noRunForBranchNode";
 import {log, logDebug} from "../log";
 import {RunStore} from "../store/store";
-import {NoRunForBranchNode} from "./current-branch/noRunForBranchNode";
 import {AttemptNode} from "./shared/attemptNode";
+import {GitHubAPIUnreachableNode} from "./shared/gitHubApiUnreachableNode";
 import {NoWorkflowJobsNode} from "./shared/noWorkflowJobsNode";
 import {PreviousAttemptsNode} from "./shared/previousAttemptsNode";
 import {WorkflowJobNode} from "./shared/workflowJobNode";
 import {WorkflowRunNode} from "./shared/workflowRunNode";
 import {WorkflowRunTreeDataProvider} from "./workflowRunTreeDataProvider";
 import {WorkflowStepNode} from "./workflows/workflowStepNode";
+import {canReachGitHubAPI} from "../util";
 
 type CurrentBranchTreeNode =
   | CurrentBranchRepoNode
@@ -22,7 +24,8 @@ type CurrentBranchTreeNode =
   | WorkflowJobNode
   | NoWorkflowJobsNode
   | WorkflowStepNode
-  | NoRunForBranchNode;
+  | NoRunForBranchNode
+  | GitHubAPIUnreachableNode;
 
 export class CurrentBranchTreeProvider
   extends WorkflowRunTreeDataProvider
@@ -39,8 +42,13 @@ export class CurrentBranchTreeProvider
     this._onDidChangeTreeData.fire(node);
   }
 
-  refresh(): void {
-    this._onDidChangeTreeData.fire(null);
+  async refresh(): Promise<void> {
+    // Don't delete all the nodes if we can't reach GitHub API
+    if (await canReachGitHubAPI()) {
+      this._onDidChangeTreeData.fire(null);
+    } else {
+      await vscode.window.showWarningMessage("Unable to refresh, could not reach GitHub API");
+    }
   }
 
   getTreeItem(element: CurrentBranchTreeNode): vscode.TreeItem | Thenable<vscode.TreeItem> {
@@ -51,7 +59,7 @@ export class CurrentBranchTreeProvider
     if (!element) {
       const gitHubContext = await getGitHubContext();
       if (!gitHubContext) {
-        return [];
+        return [new GitHubAPIUnreachableNode()];
       }
 
       if (gitHubContext.repos.length === 1) {

src/treeViews/settings.ts

@@ -14,13 +14,20 @@ import {EnvironmentSecretsNode} from "./settings/environmentSecretsNode";
 import {EnvironmentVariablesNode} from "./settings/environmentVariablesNode";
 import {OrgVariablesNode} from "./settings/orgVariablesNode";
 import {OrgSecretsNode} from "./settings/orgSecretsNode";
+import {GitHubAPIUnreachableNode} from "./shared/gitHubApiUnreachableNode";
+import {canReachGitHubAPI} from "../util";
 
 export class SettingsTreeProvider implements vscode.TreeDataProvider<SettingsExplorerNode> {
   private _onDidChangeTreeData = new vscode.EventEmitter<SettingsExplorerNode | null>();
   readonly onDidChangeTreeData = this._onDidChangeTreeData.event;
 
-  refresh(): void {
-    this._onDidChangeTreeData.fire(null);
+  async refresh(): Promise<void> {
+    // Don't delete all the nodes if we can't reach GitHub API
+    if (await canReachGitHubAPI()) {
+      this._onDidChangeTreeData.fire(null);
+    } else {
+      await vscode.window.showWarningMessage("Unable to refresh, could not reach GitHub API");
+    }
   }
 
   getTreeItem(element: SettingsExplorerNode): vscode.TreeItem | Thenable<vscode.TreeItem> {
@@ -30,7 +37,7 @@ export class SettingsTreeProvider implements vscode.TreeDataProvider<SettingsExp
   async getChildren(element?: SettingsExplorerNode | undefined): Promise<SettingsExplorerNode[]> {
     const gitHubContext = await getGitHubContext();
     if (!gitHubContext) {
-      return [];
+      return [new GitHubAPIUnreachableNode()];
     }
 
     if (!element) {

src/treeViews/settings/types.ts

@@ -11,6 +11,7 @@ import {RepoVariablesNode} from "./repoVariablesNode";
 import {OrgVariablesNode} from "./orgVariablesNode";
 import {OrgSecretsNode} from "./orgSecretsNode";
 import {RepoSecretsNode} from "./repoSecretsNode";
+import {GitHubAPIUnreachableNode} from "../shared/gitHubApiUnreachableNode";
 
 export type SettingsExplorerNode =
   | SecretsNode
@@ -25,4 +26,5 @@ export type SettingsExplorerNode =
   | RepoVariablesNode
   | VariableNode
   | VariablesNode
-  | EmptyNode;
+  | EmptyNode
+  | GitHubAPIUnreachableNode;

src/treeViews/shared/gitHubApiUnreachableNode.ts

@@ -0,0 +1,11 @@
+import * as vscode from "vscode";
+
+/**
+ * Shown when no calls to the github API can be made.
+ */
+export class GitHubAPIUnreachableNode extends vscode.TreeItem {
+  constructor() {
+    super("Cannot reach GitHub API");
+    this.iconPath = new vscode.ThemeIcon("notebook-state-error");
+  }
+}

src/treeViews/treeViews.ts

@@ -21,15 +21,15 @@ export async function initTreeViews(context: vscode.ExtensionContext, store: Run
 
   context.subscriptions.push(
     vscode.commands.registerCommand("github-actions.explorer.refresh", async () => {
-      workflowTreeProvider.refresh();
-      settingsTreeProvider.refresh();
+      await workflowTreeProvider.refresh();
+      await settingsTreeProvider.refresh();
       await executeCacheClearCommand();
     })
   );
 
   context.subscriptions.push(
-    vscode.commands.registerCommand("github-actions.explorer.current-branch.refresh", () => {
-      currentBranchTreeProvider.refresh();
+    vscode.commands.registerCommand("github-actions.explorer.current-branch.refresh", async () => {
+      await currentBranchTreeProvider.refresh();
     })
   );
 
@@ -46,7 +46,7 @@ export async function initTreeViews(context: vscode.ExtensionContext, store: Run
 
     let currentAhead = repo.repositoryState.HEAD?.ahead;
     let currentHeadName = repo.repositoryState.HEAD?.name;
-    repo.repositoryState.onDidChange(() => {
+    repo.repositoryState.onDidChange(async () => {
       // When the current head/branch changes, or the number of commits ahead changes (which indicates
       // a push), refresh the current-branch view
       if (
@@ -55,7 +55,7 @@ export async function initTreeViews(context: vscode.ExtensionContext, store: Run
       ) {
         currentHeadName = repo.repositoryState?.HEAD?.name;
         currentAhead = repo.repositoryState?.HEAD?.ahead;
-        currentBranchTreeProvider.refresh();
+        await currentBranchTreeProvider.refresh();
       }
     });
   }

src/treeViews/workflows.ts

@@ -1,21 +1,22 @@
 import * as vscode from "vscode";
 
-import {log, logDebug, logError} from "../log";
-import {getWorkflowNodes, WorkflowsRepoNode} from "./workflows/workflowsRepoNode";
-
 import {getGitHubContext} from "../git/repository";
+import {log, logDebug, logError} from "../log";
 import {RunStore} from "../store/store";
 import {AttemptNode} from "./shared/attemptNode";
 import {AuthenticationNode} from "./shared/authenticationNode";
 import {ErrorNode} from "./shared/errorNode";
+import {GitHubAPIUnreachableNode} from "./shared/gitHubApiUnreachableNode";
 import {NoGitHubRepositoryNode} from "./shared/noGitHubRepositoryNode";
 import {NoWorkflowJobsNode} from "./shared/noWorkflowJobsNode";
 import {PreviousAttemptsNode} from "./shared/previousAttemptsNode";
 import {WorkflowJobNode} from "./shared/workflowJobNode";
 import {WorkflowRunNode} from "./shared/workflowRunNode";
 import {WorkflowRunTreeDataProvider} from "./workflowRunTreeDataProvider";
 import {WorkflowNode} from "./workflows/workflowNode";
+import {getWorkflowNodes, WorkflowsRepoNode} from "./workflows/workflowsRepoNode";
 import {WorkflowStepNode} from "./workflows/workflowStepNode";
+import {canReachGitHubAPI} from "../util";
 
 type WorkflowsTreeNode =
   | AuthenticationNode
@@ -26,7 +27,8 @@ type WorkflowsTreeNode =
   | AttemptNode
   | WorkflowJobNode
   | NoWorkflowJobsNode
-  | WorkflowStepNode;
+  | WorkflowStepNode
+  | GitHubAPIUnreachableNode;
 
 export class WorkflowsTreeProvider
   extends WorkflowRunTreeDataProvider
@@ -43,9 +45,13 @@ export class WorkflowsTreeProvider
     this._onDidChangeTreeData.fire(node);
   }
 
-  refresh(): void {
-    logDebug("Refreshing workflow tree");
-    this._onDidChangeTreeData.fire(null);
+  async refresh(): Promise<void> {
+    // Don't delete all the nodes if we can't reach GitHub API
+    if (await canReachGitHubAPI()) {
+      this._onDidChangeTreeData.fire(null);
+    } else {
+      await vscode.window.showWarningMessage("Unable to refresh, could not reach GitHub API");
+    }
   }
 
   getTreeItem(element: WorkflowsTreeNode): vscode.TreeItem | Thenable<vscode.TreeItem> {
@@ -59,8 +65,8 @@ export class WorkflowsTreeProvider
       try {
         const gitHubContext = await getGitHubContext();
         if (!gitHubContext) {
-          logDebug("could not get github context");
-          return [];
+          logDebug("could not get github context for workflows");
+          return [new GitHubAPIUnreachableNode()];
         }
 
         if (gitHubContext.repos.length > 0) {

src/util.ts

@@ -0,0 +1,18 @@
+import {Octokit} from "@octokit/rest";
+
+import {logError} from "./log";
+
+export async function canReachGitHubAPI() {
+  try {
+    const octokit = new Octokit();
+    await octokit.request("GET /", {
+      headers: {
+        "X-GitHub-Api-Version": "2022-11-28"
+      }
+    });
+  } catch {
+    logError(new Error("Unable to connect to GitHub API"));
+    return false;
+  }
+  return true;
+}