fix:(GitHub Auth): Deprecate getAuthUsername (#585)

* remove getAuthUsername and add getGitHubAuthHeader

* remove setAuth as it seems to be no longer needed

* use token in git auth headers

* remove vars no longer needed

* remove unneeded parameter for GitHubRemote

* clean up imports

* going back to usernaem:token@github

* clean up comments

* restore missing function

* replace the word dummyusername with placeholderusername

* another to replace

Author: Jeffreyhung

src/targets/awsLambdaLayer.ts

@@ -4,8 +4,6 @@ import * as path from 'path';
 import { Octokit } from '@octokit/rest';
 import simpleGit from 'simple-git';
 import {
-  getAuthUsername,
-  getGitHubApiToken,
   getGitHubClient,
   GitHubRemote,
 } from '../utils/githubApi';
@@ -139,8 +137,6 @@ export class AwsLambdaLayerTarget extends BaseTarget {
     this.logger.trace('AWS regions: ', awsRegions);
 
     const remote = this.awsLambdaConfig.registryRemote;
-    const username = await getAuthUsername(this.github);
-    remote.setAuth(username, getGitHubApiToken());
 
     await withTempDir(
       async directory => {

src/targets/ghPages.ts

@@ -8,8 +8,6 @@ import { GitHubGlobalConfig, TargetConfig } from '../schemas/project_config';
 import { ConfigurationError, reportError } from '../utils/errors';
 import { withTempDir } from '../utils/files';
 import {
-  getAuthUsername,
-  getGitHubApiToken,
   getGitHubClient,
   GitHubRemote,
 } from '../utils/githubApi';
@@ -219,13 +217,9 @@ export class GhPagesTarget extends BaseTarget {
       packageFiles[0]
     );
 
-    const username = await getAuthUsername(this.github);
-
     const remote = new GitHubRemote(
       githubOwner,
       githubRepo,
-      username,
-      getGitHubApiToken()
     );
 
     await withTempDir(

src/targets/registry.ts

@@ -6,8 +6,6 @@ import { GitHubGlobalConfig, TargetConfig } from '../schemas/project_config';
 import { ConfigurationError, reportError } from '../utils/errors';
 import { withTempDir } from '../utils/files';
 import {
-  getAuthUsername,
-  getGitHubApiToken,
   getGitHubClient,
   GitHubRemote,
 } from '../utils/githubApi';
@@ -427,8 +425,6 @@ export class RegistryTarget extends BaseTarget {
 
   private async cloneRegistry(directory: string): Promise<SimpleGit> {
     const remote = this.remote;
-    const username = await getAuthUsername(this.github);
-    remote.setAuth(username, getGitHubApiToken());
 
     const git = simpleGit(directory);
     this.logger.info(

src/targets/upm.ts

@@ -1,7 +1,6 @@
 import { Octokit } from '@octokit/rest';
 import simpleGit from 'simple-git';
 import {
-  getAuthUsername,
   getGitHubApiToken,
   getGitHubClient,
   GitHubRemote,
@@ -107,11 +106,9 @@ export class UpmTarget extends BaseTarget {
       packageFile
     );
 
-    const username = await getAuthUsername(this.github);
     const remote = new GitHubRemote(
       this.config.releaseRepoOwner,
       this.config.releaseRepoName,
-      username,
       getGitHubApiToken()
     );
     const remoteAddr = remote.getRemoteString();

src/utils/githubApi.ts

@@ -12,8 +12,6 @@ export class GitHubRemote {
   public readonly owner: string;
   /** GitHub repository name */
   public readonly repo: string;
-  /** GitHub username */
-  protected username?: string;
   /** GitHub personal authentication token */
   protected apiToken?: string;
   /** GitHub hostname */
@@ -26,27 +24,14 @@ export class GitHubRemote {
   public constructor(
     owner: string,
     repo: string,
-    username?: string,
     apiToken?: string
   ) {
     this.owner = owner;
     this.repo = repo;
-    if (username && apiToken) {
-      this.setAuth(username, apiToken);
-    }
+    this.apiToken = apiToken;
     this.url = `/${this.owner}/${this.repo}/`;
   }
 
-  /**
-   * Sets authentication arguments: username and personal API token
-   *
-   * @param username GitHub username
-   * @param apiToken GitHub API token
-   */
-  public setAuth(username: string, apiToken: string): void {
-    this.username = username;
-    this.apiToken = apiToken;
-  }
 
   /**
    * Returns an HTTP-based git remote
@@ -60,12 +45,14 @@ export class GitHubRemote {
   /**
    * Returns an HTTP-based git remote with embedded HTTP basic auth
    *
+   * Using placeholder username as it does not matter for cloning
+   *
    * It MAY contain sensitive information (e.g. API tokens)
    */
   public getRemoteStringWithAuth(): string {
     const authData =
-      this.username && this.apiToken
-        ? `${this.username}:${this.apiToken}@`
+      this.apiToken
+        ? `placeholderusername:${this.apiToken}@`
         : '';
     return this.PROTOCOL_PREFIX + authData + this.GITHUB_HOSTNAME + this.url;
   }
@@ -123,21 +110,6 @@ export function getGitHubClient(token = ''): Octokit {
   return _GitHubClientCache[githubApiToken];
 }
 
-/**
- * Gets the currently authenticated GitHub user from the client
- *
- * @param github GitHub client
- * @returns GitHub username
- */
-export async function getAuthUsername(github: Octokit): Promise<string> {
-  const userData = await github.users.getAuthenticated({});
-  const username = (userData.data || {}).login;
-  if (!username) {
-    throw new Error('Cannot reliably detect GitHub username, aborting');
-  }
-  return username;
-}
-
 /**
  * Loads a file from the context's repository
  *