Merge pull request #112 from github/joshmgross/sign-in-sidebar

Add sign in experience to extension activity bar

Author: joshmgross

package.json

@@ -241,24 +241,42 @@
         "category": "GitHub Actions",
         "title": "Unpin workflow",
         "icon": "$(pinned)"
+      },
+      {
+        "command": "github-actions.sign-in",
+        "title": "Sign in to GitHub"
       }
     ],
     "views": {
       "github-actions": [
         {
           "id": "github-actions.current-branch",
-          "name": "Current Branch"
+          "name": "Current Branch",
+          "when": "github-actions.signed-in"
         },
         {
           "id": "github-actions.workflows",
-          "name": "Workflows"
+          "name": "Workflows",
+          "when": "github-actions.signed-in"
         },
         {
           "id": "github-actions.settings",
-          "name": "Settings"
+          "name": "Settings",
+          "when": "github-actions.signed-in"
+        },
+        {
+          "id": "github-actions.empty-view",
+          "name": "",
+          "when": "!github-actions.signed-in"
         }
       ]
     },
+    "viewsWelcome": [
+      {
+        "view": "github-actions.empty-view",
+        "contents": "Sign in to GitHub to display runs, workflows, and configure Actions settings\n[Sign in to GitHub](command:github-actions.sign-in)"
+      }
+    ],
     "viewsContainers": {
       "activitybar": [
         {
@@ -440,6 +458,10 @@
         {
           "command": "github-actions.workflow.unpin",
           "when": "false"
+        },
+        {
+          "command": "github-actions.sign-in",
+          "when": "false"
         }
       ]
     }

src/auth/auth.ts

@@ -24,22 +24,37 @@ export async function newSession(forceMessage: string): Promise<vscode.Authentic
  * Retrieves a session from the GitHub authentication provider or prompts the user to sign in
  * @returns A {@link vscode.AuthenticationSession} or undefined
  */
-export async function getSession(): Promise<vscode.AuthenticationSession | undefined> {
-  const session = await getSessionInternal(false);
-  if (session || signInPrompted) {
+export async function getSession(skipPrompt = false): Promise<vscode.AuthenticationSession | undefined> {
+  const session = await getSessionInternal(skipPrompt);
+  if (session) {
+    await vscode.commands.executeCommand("setContext", "github-actions.signed-in", true);
     return session;
   }
 
+  if (signInPrompted || skipPrompt) {
+    return undefined;
+  }
+
   signInPrompted = true;
   const signInAction = "Sign in to GitHub";
-  const result = await vscode.window.showInformationMessage(
-    "Sign in to GitHub to access your repositories and GitHub Actions workflows.",
-    signInAction
-  );
-  if (result === signInAction) {
-    return await getSessionInternal(true);
-  }
-  throw new Error(SESSION_ERROR);
+  vscode.window
+    .showInformationMessage("Sign in to GitHub to access your repositories and GitHub Actions workflows.", signInAction)
+    .then(
+      async result => {
+        if (result === signInAction) {
+          const session = await getSessionInternal(true);
+          if (session) {
+            await vscode.commands.executeCommand("setContext", "github-actions.signed-in", true);
+          }
+        }
+      },
+      () => {
+        // Ignore rejected promise
+      }
+    );
+
+  // User chose to not sign in or hasn't signed in yet
+  return undefined;
 }
 
 async function getSessionInternal(forceNewMessage: string): Promise<vscode.AuthenticationSession | undefined>;

src/commands/signIn.ts

@@ -0,0 +1,13 @@
+import * as vscode from "vscode";
+import {getSession} from "../auth/auth";
+
+export function registerSignIn(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand("github-actions.sign-in", async () => {
+      const session = await getSession(true);
+      if (session) {
+        await vscode.commands.executeCommand("setContext", "github-actions.signed-in", true);
+      }
+    })
+  );
+}

src/extension.ts

@@ -30,12 +30,16 @@ import {initWorkspaceChangeTracker} from "./tracker/workspaceTracker";
 import {initResources} from "./treeViews/icons";
 import {initTreeViews} from "./treeViews/treeViews";
 import {deactivateLanguageServer, initLanguageServer} from "./workflow/languageServer";
+import {registerSignIn} from "./commands/signIn";
 
 export async function activate(context: vscode.ExtensionContext) {
   initLogger();
 
   log("Activating GitHub Actions extension...");
 
+  // Set signed-in context before other initializations use the session
+  await vscode.commands.executeCommand("setContext", "github-actions.signed-in", false);
+
   // Prefetch git repository origin url
   await getGitHubContext();
 
@@ -75,6 +79,8 @@ export async function activate(context: vscode.ExtensionContext) {
   registerPinWorkflow(context);
   registerUnPinWorkflow(context);
 
+  registerSignIn(context);
+
   // Log providers
   context.subscriptions.push(
     vscode.workspace.registerTextDocumentContentProvider(LogScheme, new WorkflowStepLogProvider())