Support new authentication API

cschleiden · cschleiden · commit 9e9b3ec745aa · 2020-05-05T15:56:17.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 All notable changes to the "vscode-github-actions" extension will be documented in this file.
 
+## [v0.5.0]
+- Support the VS Code authentication API. This replaces the previous, manual PAT-based authentication flow.
+
 ## [v0.4.1]
 - Add inline run button to workflow list
 
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Simple, **unofficial** extension to interact with GitHub Actions from within VS
 
 1. Install extension
 2. Open a repository with a `github.com` origin
-3. When prompted, enter a PAT with `repo` scope to authenticate against the API
+3. When prompted, allow `GitHub Actions` to access your `github` account
 
 ## Features
 
diff --git a/package.json b/package.json
@@ -7,23 +7,24 @@
     "url": "https://github.com/cschleiden/vscode-github-actions"
   },
   "description": "See GitHub Actions workflows and runs for github.com hosted repositories in VS Code",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "engines": {
     "vscode": "^1.44.0"
   },
   "categories": [
     "Other"
   ],
   "activationEvents": [
-    "onCommand:auth.login",
     "onView:workflows",
     "onView:settings",
     "workspaceContains:**/.github/workflows/**"
   ],
   "main": "./dist/extension",
   "extensionDependencies": [
-    "vscode.git"
+    "vscode.git",
+    "vscode.github-authentication"
   ],
+  "enableProposedApi": true,
   "contributes": {
     "configuration": {
       "title": "GitHub Actions",
@@ -48,11 +49,6 @@
       }
     },
     "commands": [
-      {
-        "command": "auth.login",
-        "title": "Login",
-        "category": "GitHub Actions"
-      },
       {
         "command": "explorer.refresh",
         "title": "Refresh",
@@ -252,7 +248,7 @@
     "clean": "rimraf ./dist ./out",
     "compile": "tsc -p ./",
     "watch": "tsc -watch -p ./",
-    "package": "npm run clean && npm version patch --no-git-tag-version && vsce package",
+    "package": "npm run clean && vsce package",
     "vscode:prepublish": "webpack --mode production",
     "webpack": "webpack --mode development",
     "webpack-dev": "webpack --mode development --watch",
diff --git a/src/auth/pat.ts b/src/auth/pat.ts
@@ -1,41 +1,29 @@
-import * as keytarType from "keytar";
-import { env } from "vscode";
+import * as vscode from "vscode";
 
-declare const __webpack_require__: typeof require;
-declare const __non_webpack_require__: typeof require;
-function getNodeModule<T>(moduleName: string): T | undefined {
-  const r =
-    typeof __webpack_require__ === "function"
-      ? __non_webpack_require__
-      : require;
-  try {
-    return r(`${env.appRoot}/node_modules.asar/${moduleName}`);
-  } catch (err) {
-    // Not in ASAR.
-  }
-  try {
-    return r(`${env.appRoot}/node_modules/${moduleName}`);
-  } catch (err) {
-    // Not available.
-  }
-  return undefined;
-}
-
-function getKeytar(): typeof keytarType {
-  const keytar = getNodeModule<typeof keytarType>("keytar");
-  if (!keytar) {
-    throw new Error("Keytar module for secure token storage not found");
-  }
+const AUTH_PROVIDER_ID = "github";
+const SCOPES = ["repo", "workflows"];
 
-  return keytar;
-}
-
-const ServiceName = "VS Code GitHub Actions";
+let token: Promise<string> | undefined;
 
 export async function getPAT(): Promise<string | null> {
-  return getKeytar().getPassword(ServiceName, "pat");
-}
+  if (token) {
+    return token;
+  }
+
+  return (token = new Promise(async (resolve) => {
+    const existingSessions = await vscode.authentication.getSessions(
+      AUTH_PROVIDER_ID,
+      SCOPES
+    );
 
-export async function setPAT(token: string): Promise<void> {
-  return getKeytar().setPassword(ServiceName, "pat", token);
+    if (existingSessions.length) {
+      resolve(await existingSessions[0].getAccessToken());
+    } else {
+      const session = await vscode.authentication.login(
+        AUTH_PROVIDER_ID,
+        SCOPES
+      );
+      resolve(await session.getAccessToken());
+    }
+  }));
 }
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,6 +1,5 @@
 import { Octokit } from "@octokit/rest";
 import * as vscode from "vscode";
-import { setPAT } from "./auth/pat";
 import { getClient } from "./client/client";
 import { initConfiguration } from "./configuration/configuration";
 import { Protocol } from "./external/protocol";
@@ -146,29 +145,6 @@ export function activate(context: vscode.ExtensionContext) {
     })
   );
 
-  context.subscriptions.push(
-    vscode.commands.registerCommand("auth.login", async () => {
-      // Disable this until service setup
-      // const selection = await vscode.window.showQuickPick([
-      //   "Enter PAT",
-      //   "Use OAuth flow (coming soon)"
-      // ]);
-
-      const selection = "Enter PAT";
-      switch (selection) {
-        case "Enter PAT":
-          const token = await vscode.window.showInputBox({
-            prompt: "Enter a GitHub PAT with `workflow` and `repo` scope:",
-          });
-          if (token) {
-            await setPAT(token);
-            workflowTreeProvider.refresh();
-          }
-          break;
-      }
-    })
-  );
-
   context.subscriptions.push(
     vscode.commands.registerCommand("workflow.run.open", async (args) => {
       const run: WorkflowRun = args.run;
diff --git a/src/treeViews/settings.ts b/src/treeViews/settings.ts
@@ -64,13 +64,11 @@ type SettingsExplorerNode = SelfHostedRunnersNode | SecretsNode | SecretNode;
 
 export class SettingsTreeProvider
   implements vscode.TreeDataProvider<SettingsExplorerNode> {
-  private _onDidChangeTreeData = new vscode.EventEmitter<
-    SettingsExplorerNode
-  >();
+  private _onDidChangeTreeData = new vscode.EventEmitter<SettingsExplorerNode | null>();
   readonly onDidChangeTreeData = this._onDidChangeTreeData.event;
 
   refresh(): void {
-    this._onDidChangeTreeData.fire();
+    this._onDidChangeTreeData.fire(null);
   }
 
   getTreeItem(
diff --git a/src/treeViews/workflows.ts b/src/treeViews/workflows.ts
@@ -203,11 +203,11 @@ type ActionsExplorerNode =
 
 export class ActionsExplorerProvider
   implements vscode.TreeDataProvider<ActionsExplorerNode> {
-  private _onDidChangeTreeData = new vscode.EventEmitter<ActionsExplorerNode>();
+  private _onDidChangeTreeData = new vscode.EventEmitter<ActionsExplorerNode | null>();
   readonly onDidChangeTreeData = this._onDidChangeTreeData.event;
 
   refresh(): void {
-    this._onDidChangeTreeData.fire();
+    this._onDidChangeTreeData.fire(null);
   }
 
   getTreeItem(
diff --git a/vscode.d.ts b/vscode.d.ts
diff --git a/vscode.proposed.d.ts b/vscode.proposed.d.ts
