Add repository permissions to repo context

joshmgross · joshmgross · commit cfe9a31bffbd · 2023-03-08T12:01:44.000-05:00
diff --git a/src/git/repository-permissions.ts b/src/git/repository-permissions.ts
@@ -0,0 +1,27 @@
+export type RepositoryPermission = "admin" | "write" | "read";
+
+// https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository
+// This should always be set for authenticated requests
+type RepositoryPermissionResponse = {
+  admin: boolean;
+  maintain?: boolean;
+  push: boolean;
+  triage?: boolean;
+  pull: boolean;
+};
+
+export function getRepositoryPermission(permissions: RepositoryPermissionResponse | undefined): RepositoryPermission {
+  return permissions?.admin ? "admin" : permissions?.push ? "write" : "read";
+}
+
+export function hasAdminPermission(permission: RepositoryPermission): boolean {
+  return permission === "admin";
+}
+
+export function hasWritePermission(permission: RepositoryPermission): boolean {
+  return permission === "admin" || permission === "write";
+}
+
+export function hasReadPermission(permission: RepositoryPermission): boolean {
+  return permission === "admin" || permission === "write" || permission === "read";
+}
diff --git a/src/git/repository.ts b/src/git/repository.ts
@@ -7,6 +7,8 @@ import {Protocol} from "../external/protocol";
 import {logDebug, logError} from "../log";
 import {API, GitExtension, RefType, RepositoryState} from "../typings/git";
 import {canReachGitHubAPI} from "../util";
+import {getUsername} from "./username";
+import {RepositoryPermission, getRepositoryPermission} from "./repository-permissions";
 
 interface GitHubUrls {
   workspaceUri: vscode.Uri;
@@ -127,13 +129,14 @@ export interface GitHubRepoContext {
   name: string;
 
   organizationOwned: boolean;
-
   defaultBranch: string;
+  permissionLevel: RepositoryPermission;
 }
 
 export interface GitHubContext {
   repos: GitHubRepoContext[];
   reposByUri: Map<string, GitHubRepoContext>;
+  username: string;
 }
 
 let gitHubContext: Promise<GitHubContext | undefined> | undefined;
@@ -159,6 +162,10 @@ export async function getGitHubContext(): Promise<GitHubContext | undefined> {
 
     logDebug("Found protocol infos", protocolInfos.length.toString());
 
+    const username = await handleSamlError(async (client: Octokit) => {
+      return getUsername(client);
+    });
+
     const repos = await handleSamlError(async (client: Octokit) => {
       return await Promise.all(
         protocolInfos.map(async (protocolInfo): Promise<GitHubRepoContext> => {
@@ -179,15 +186,17 @@ export async function getGitHubContext(): Promise<GitHubContext | undefined> {
             owner: protocolInfo.protocol.owner,
             id: repoInfo.data.id,
             defaultBranch: `refs/heads/${repoInfo.data.default_branch}`,
-            organizationOwned: repoInfo.data.owner.type === "Organization"
+            organizationOwned: repoInfo.data.owner.type === "Organization",
+            permissionLevel: getRepositoryPermission(repoInfo.data.permissions)
           };
         })
       );
     });
 
     gitHubContext = Promise.resolve({
       repos,
-      reposByUri: new Map(repos.map(r => [r.workspaceUri.toString(), r]))
+      reposByUri: new Map(repos.map(r => [r.workspaceUri.toString(), r])),
+      username
     });
   } catch (e) {
     // Reset the context so the next attempt will try this flow again
diff --git a/src/git/username.ts b/src/git/username.ts
@@ -0,0 +1,11 @@
+import {Octokit} from "@octokit/rest";
+import {logError} from "../log";
+
+export async function getUsername(octokit: Octokit): Promise<string> {
+  try {
+    return (await octokit.users.getAuthenticated()).data.login;
+  } catch (e) {
+    logError(e as Error, "Failure to retrieve username");
+    throw e;
+  }
+}
