67f65a9d25
Currently the `GitClient` accepts a generic parameter for determining
whether the `githubToken` should be set or not. This worked fine so far
in terms of distinguishing between an authenticated and
non-authenticated git client instance, but if we intend to conditionally
show methods only for authenticated instances, the generic parameter
is not suitable.
This commit splits up the `GitClient` into two classes. One for
the base logic without any authorization, and a second class that
extends the base logic with authentication logic. i.e. the
`AuthenticatedGitClient`. This allows us to have specific methods only
for the authenticated instance. e.g.
* `hasOauthScopes` has been moved to only exist for authenticated
instances.
* the GraphQL functionality within `gitClient.github` is not
accessible for non-authenticated instances. GraphQL API requires
authentication as per Github.
The initial motiviation for this was that we want to throw if
`hasOAuthScopes` is called without the Octokit instance having
a token configured. This should help avoiding issues as within
3b434ed94d
that prevented the caretaker process momentarily.
Additionally, the Git client has moved from `index.ts` to
`git-client.ts` for better discoverability in the codebase.
PR Close #42468
44 lines
1.6 KiB
TypeScript
44 lines
1.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
|
|
import {URL} from 'url';
|
|
|
|
import {GithubConfig} from '../config';
|
|
import {GitClient} from './git-client';
|
|
|
|
/** URL to the Github page where personal access tokens can be managed. */
|
|
export const GITHUB_TOKEN_SETTINGS_URL = 'https://github.com/settings/tokens';
|
|
|
|
/** URL to the Github page where personal access tokens can be generated. */
|
|
export const GITHUB_TOKEN_GENERATE_URL = 'https://github.com/settings/tokens/new';
|
|
|
|
/** Adds the provided token to the given Github HTTPs remote url. */
|
|
export function addTokenToGitHttpsUrl(githubHttpsUrl: string, token: string) {
|
|
const url = new URL(githubHttpsUrl);
|
|
url.username = token;
|
|
return url.href;
|
|
}
|
|
|
|
/** Gets the repository Git URL for the given github config. */
|
|
export function getRepositoryGitUrl(config: GithubConfig, githubToken?: string): string {
|
|
if (config.useSsh) {
|
|
return `git@github.com:${config.owner}/${config.name}.git`;
|
|
}
|
|
const baseHttpUrl = `https://github.com/${config.owner}/${config.name}.git`;
|
|
if (githubToken !== undefined) {
|
|
return addTokenToGitHttpsUrl(baseHttpUrl, githubToken);
|
|
}
|
|
return baseHttpUrl;
|
|
}
|
|
|
|
/** Gets a Github URL that refers to a list of recent commits within a specified branch. */
|
|
export function getListCommitsInBranchUrl({remoteParams}: GitClient, branchName: string) {
|
|
return `https://github.com/${remoteParams.owner}/${remoteParams.repo}/commits/${branchName}`;
|
|
}
|