refactor: move to using assertions in place to determine the types of a configuration for the github config

josephperrott · devversion · commit 7c87273a0310 · 2021-08-20T11:56:34.000+02:00
diff --git a/ng-dev/caretaker/check/base.ts b/ng-dev/caretaker/check/base.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {NgDevConfig} from '../../utils/config';
+import {GitClientConfig} from '../../utils/config';
 import {AuthenticatedGitClient} from '../../utils/git/authenticated-git-client';
 import {CaretakerConfig} from '../config';
 
@@ -17,7 +17,7 @@ export abstract class BaseModule<Data> {
   /** The data for the module. */
   readonly data = this.retrieveData();
 
-  constructor(protected config: NgDevConfig<{caretaker: CaretakerConfig}>) {}
+  constructor(protected config: {caretaker: CaretakerConfig; github: GitClientConfig}) {}
 
   /** Asyncronously retrieve data for the module. */
   protected abstract retrieveData(): Promise<Data>;
diff --git a/ng-dev/caretaker/check/check.ts b/ng-dev/caretaker/check/check.ts
@@ -6,6 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {assertValidGithubConfig} from '../../utils/config';
 import {getCaretakerConfig} from '../config';
 
 import {CiModule} from './ci';
@@ -20,6 +21,7 @@ const moduleList = [GithubQueriesModule, ServicesModule, CiModule, G3Module];
 export async function checkServiceStatuses() {
   /** The configuration for the caretaker commands. */
   const config = getCaretakerConfig();
+  assertValidGithubConfig(config);
   /** List of instances of Caretaker Check modules */
   const caretakerCheckModules = moduleList.map((module) => new module(config));
 
diff --git a/ng-dev/caretaker/config.ts b/ng-dev/caretaker/config.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {assertNoErrors, getConfig, NgDevConfig} from '../utils/config';
+import {assertNoErrors, getConfig} from '../utils/config';
 
 export interface CaretakerConfig {
   /** Github queries showing a snapshot of pulls/issues caretakers need to monitor. */
@@ -23,7 +23,7 @@ export function getCaretakerConfig() {
   // List of errors encountered validating the config.
   const errors: string[] = [];
   // The non-validated config object.
-  const config: Partial<NgDevConfig<{caretaker: CaretakerConfig}>> = getConfig();
+  const config: Partial<{caretaker: CaretakerConfig}> = getConfig();
 
   assertNoErrors(errors);
   return config as Required<typeof config>;
diff --git a/ng-dev/commit-message/config.ts b/ng-dev/commit-message/config.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {assertNoErrors, getConfig, NgDevConfig} from '../utils/config';
+import {assertNoErrors, getConfig} from '../utils/config';
 
 /** Configuration for commit-message comands. */
 export interface CommitMessageConfig {
@@ -21,7 +21,7 @@ export function getCommitMessageConfig() {
   // List of errors encountered validating the config.
   const errors: string[] = [];
   // The non-validated config object.
-  const config: Partial<NgDevConfig<{commitMessage: CommitMessageConfig}>> = getConfig();
+  const config: Partial<{commitMessage: CommitMessageConfig}> = getConfig();
 
   if (config.commitMessage === undefined) {
     errors.push(`No configuration defined for "commitMessage"`);
diff --git a/ng-dev/format/config.ts b/ng-dev/format/config.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {assertNoErrors, getConfig, NgDevConfig} from '../utils/config';
+import {assertNoErrors, getConfig} from '../utils/config';
 
 interface Formatter {
   matchers: string[];
@@ -21,7 +21,7 @@ export function getFormatConfig() {
   // List of errors encountered validating the config.
   const errors: string[] = [];
   // The unvalidated config object.
-  const config: Partial<NgDevConfig<{format: FormatConfig}>> = getConfig();
+  const config: Partial<{format: FormatConfig}> = getConfig();
 
   if (config.format === undefined) {
     errors.push(`No configuration defined for "format"`);
diff --git a/ng-dev/pr/check-target-branches/check-target-branches.ts b/ng-dev/pr/check-target-branches/check-target-branches.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {getConfig} from '../../utils/config';
+import {assertValidGithubConfig, getConfig} from '../../utils/config';
 import {error, info, red} from '../../utils/console';
 import {GitClient} from '../../utils/git/git-client';
 import {loadAndValidateConfig, TargetLabel} from '../merge/config';
@@ -19,6 +19,7 @@ import {
 export async function getTargetBranchesForPr(prNumber: number) {
   /** The ng-dev configuration. */
   const config = getConfig();
+  assertValidGithubConfig(config);
   /** Repo owner and name for the github repository. */
   const {owner, name: repo} = config.github;
   /** The singleton instance of the GitClient. */
diff --git a/ng-dev/pr/merge/config.ts b/ng-dev/pr/merge/config.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {GitClientConfig, NgDevConfig} from '../../utils/config';
+import {GitClientConfig} from '../../utils/config';
 import {GithubClient} from '../../utils/git/github';
 
 import {GithubApiMergeStrategyConfig} from './strategies/api-merge';
@@ -84,9 +84,10 @@ export interface MergeConfig {
  * on branch name computations. We don't want to run these immediately whenever
  * the dev-infra configuration is loaded as that could slow-down other commands.
  */
-export type DevInfraMergeConfig = NgDevConfig<{
-  'merge': (api: GithubClient) => MergeConfig | Promise<MergeConfig>;
-}>;
+export type DevInfraMergeConfig = {
+  github: GitClientConfig;
+  merge: (api: GithubClient) => MergeConfig | Promise<MergeConfig>;
+};
 
 /** Loads and validates the merge configuration. */
 export async function loadAndValidateConfig(
diff --git a/ng-dev/pr/merge/defaults/integration.spec.ts b/ng-dev/pr/merge/defaults/integration.spec.ts
@@ -11,7 +11,7 @@ import {ParsedUrlQuery} from 'querystring';
 
 import {ReleaseConfig} from '../../../release/config/index';
 import {_npmPackageInfoCache, NpmPackageInfo} from '../../../release/versioning/npm-registry';
-import {GithubConfig} from '../../../utils/config';
+import {GitClientConfig} from '../../../utils/config';
 import * as console from '../../../utils/console';
 import {GithubClient} from '../../../utils/git/github';
 import {buildGithubPaginationResponseHeader} from '../../../utils/testing/github-pagination-header';
@@ -25,7 +25,7 @@ const API_ENDPOINT = `https://api.github.com`;
 
 describe('default target labels', () => {
   let api: GithubClient;
-  let githubConfig: GithubConfig;
+  let githubConfig: GitClientConfig;
   let releaseConfig: ReleaseConfig;
 
   beforeEach(() => {
diff --git a/ng-dev/pr/merge/defaults/labels.ts b/ng-dev/pr/merge/defaults/labels.ts
@@ -13,7 +13,7 @@ import {
   isVersionBranch,
   ReleaseRepoWithApi,
 } from '../../../release/versioning';
-import {GithubConfig} from '../../../utils/config';
+import {GitClientConfig} from '../../../utils/config';
 import {GithubClient} from '../../../utils/git/github';
 import {TargetLabel} from '../config';
 import {InvalidTargetBranchError, InvalidTargetLabelError} from '../target-label';
@@ -34,7 +34,7 @@ import {assertActiveLtsBranch} from './lts-branch';
  */
 export async function getDefaultTargetLabelConfiguration(
   api: GithubClient,
-  githubConfig: GithubConfig,
+  githubConfig: GitClientConfig,
   releaseConfig: ReleaseConfig,
 ): Promise<TargetLabel[]> {
   const nextBranchName = getNextBranchName(githubConfig);
diff --git a/ng-dev/pr/merge/index.ts b/ng-dev/pr/merge/index.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {getConfig} from '../../utils/config';
+import {assertValidGithubConfig, getConfig} from '../../utils/config';
 import {error, green, info, promptConfirm, red, yellow} from '../../utils/console';
 import {AuthenticatedGitClient} from '../../utils/git/authenticated-git-client';
 import {GithubApiRequestError} from '../../utils/git/github';
@@ -130,6 +130,7 @@ export async function mergePullRequest(prNumber: number, flags: PullRequestMerge
  */
 async function createPullRequestMergeTask(flags: PullRequestMergeTaskFlags) {
   const devInfraConfig = getConfig();
+  assertValidGithubConfig(devInfraConfig);
   /** The singleton instance of the authenticated git client. */
   const git = AuthenticatedGitClient.get();
   const {config, errors} = await loadAndValidateConfig(devInfraConfig, git.github);
diff --git a/ng-dev/release/config/index.ts b/ng-dev/release/config/index.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {assertNoErrors, getConfig, NgDevConfig} from '../../utils/config';
+import {assertNoErrors, getConfig} from '../../utils/config';
 
 /** Interface describing a built package. */
 export interface BuiltPackage {
@@ -46,7 +46,7 @@ export interface ReleaseNotesConfig {
 }
 
 /** Configuration for releases in the dev-infra configuration. */
-export type DevInfraReleaseConfig = NgDevConfig<{release: ReleaseConfig}>;
+export type DevInfraReleaseConfig = {release: ReleaseConfig};
 
 /** Retrieve and validate the config as `ReleaseConfig`. */
 export function getReleaseConfig(
diff --git a/ng-dev/release/notes/context.ts b/ng-dev/release/notes/context.ts
@@ -8,7 +8,7 @@
 
 import {COMMIT_TYPES, ReleaseNotesLevel} from '../../commit-message/config';
 import {CommitFromGitLog} from '../../commit-message/parse';
-import {GithubConfig} from '../../utils/config';
+import {GitClientConfig} from '../../utils/config';
 import {ReleaseNotesConfig} from '../config/index';
 
 /** List of types to be included in the release notes. */
@@ -27,7 +27,7 @@ export interface RenderContextData {
   date?: Date;
   commits: CommitFromGitLog[];
   version: string;
-  github: GithubConfig;
+  github: GitClientConfig;
 }
 
 /** Context class used for rendering release notes. */
diff --git a/ng-dev/release/publish/cli.ts b/ng-dev/release/publish/cli.ts
@@ -8,7 +8,7 @@
 
 import {Argv, CommandModule} from 'yargs';
 
-import {getConfig} from '../../utils/config';
+import {assertValidGithubConfig, getConfig} from '../../utils/config';
 import {error, green, info, red, yellow} from '../../utils/console';
 import {GitClient} from '../../utils/git/git-client';
 import {addGithubTokenOption} from '../../utils/git/github-yargs';
@@ -31,6 +31,7 @@ async function handler() {
   const git = GitClient.get();
   const config = getConfig();
   const releaseConfig = getReleaseConfig(config);
+  assertValidGithubConfig(config);
   const task = new ReleaseTool(releaseConfig, config.github, git.baseDir);
   const result = await task.run();
 
diff --git a/ng-dev/release/publish/index.ts b/ng-dev/release/publish/index.ts
@@ -7,7 +7,7 @@
  */
 
 import {ListChoiceOptions, prompt} from 'inquirer';
-import {GithubConfig} from '../../utils/config';
+import {GitClientConfig} from '../../utils/config';
 import {debug, error, info, log, promptConfirm, red, yellow} from '../../utils/console';
 import {AuthenticatedGitClient} from '../../utils/git/authenticated-git-client';
 import {ReleaseConfig} from '../config/index';
@@ -34,7 +34,7 @@ export class ReleaseTool {
 
   constructor(
     protected _config: ReleaseConfig,
-    protected _github: GithubConfig,
+    protected _github: GitClientConfig,
     protected _projectRoot: string,
   ) {}
 
diff --git a/ng-dev/release/publish/test/release-notes/generation.spec.ts b/ng-dev/release/publish/test/release-notes/generation.spec.ts
@@ -10,15 +10,15 @@ import {installSandboxGitClient, SandboxGitClient} from '../test-utils/sandbox-g
 import {mkdirSync, rmdirSync} from 'fs';
 import {testTmpDir} from '../test-utils/action-mocks';
 import {getMockGitClient} from '../test-utils/git-client-mock';
-import {GithubConfig} from '../../../../utils/config';
+import {GitClientConfig} from '../../../../utils/config';
 import {SandboxGitRepo} from '../test-utils/sandbox-testing';
 import {ReleaseNotes} from '../../../notes/release-notes';
 import {ReleaseConfig} from '../../../config';
 import {changelogPattern, parse} from '../test-utils/test-utils';
 
 describe('release notes generation', () => {
   let releaseConfig: ReleaseConfig;
-  let githubConfig: GithubConfig;
+  let GitClientConfig: GitClientConfig;
   let client: SandboxGitClient;
 
   beforeEach(() => {
@@ -28,8 +28,8 @@ describe('release notes generation', () => {
     mkdirSync(testTmpDir);
 
     releaseConfig = {npmPackages: [], buildPackages: async () => []};
-    githubConfig = {owner: 'angular', name: 'dev-infra-test', mainBranchName: 'main'};
-    client = getMockGitClient(githubConfig, /* useSandboxGitClient */ true);
+    GitClientConfig = {owner: 'angular', name: 'dev-infra-test', mainBranchName: 'main'};
+    client = getMockGitClient(GitClientConfig, /* useSandboxGitClient */ true);
 
     installSandboxGitClient(client);
 
@@ -39,7 +39,7 @@ describe('release notes generation', () => {
 
   describe('changelog', () => {
     it('should capture breaking changes', async () => {
-      SandboxGitRepo.withInitialCommit(githubConfig)
+      SandboxGitRepo.withInitialCommit(GitClientConfig)
         .commit('fix(cdk/a11y): already released #1')
         .createTagForHead('13.0.0-next.0')
         .commit('fix(cdk/a11y): not yet released #1')
@@ -65,7 +65,7 @@ describe('release notes generation', () => {
     });
 
     it('should capture deprecations', async () => {
-      SandboxGitRepo.withInitialCommit(githubConfig)
+      SandboxGitRepo.withInitialCommit(GitClientConfig)
         .commit('fix(cdk/a11y): already released #1')
         .createTagForHead('13.0.0-next.0')
         .commit('fix(cdk/a11y): not yet released #1')
@@ -92,7 +92,7 @@ describe('release notes generation', () => {
 
   describe('github release notes', () => {
     it('should capture breaking changes', async () => {
-      SandboxGitRepo.withInitialCommit(githubConfig)
+      SandboxGitRepo.withInitialCommit(GitClientConfig)
         .commit('fix(cdk/a11y): already released #1')
         .createTagForHead('13.0.0-next.0')
         .commit('fix(cdk/a11y): not yet released #1')
@@ -118,7 +118,7 @@ describe('release notes generation', () => {
     });
 
     it('should capture deprecations', async () => {
-      SandboxGitRepo.withInitialCommit(githubConfig)
+      SandboxGitRepo.withInitialCommit(GitClientConfig)
         .commit('fix(cdk/a11y): already released #1')
         .createTagForHead('13.0.0-next.0')
         .commit('fix(cdk/a11y): not yet released #1')
diff --git a/ng-dev/release/publish/test/test-utils/action-mocks.ts b/ng-dev/release/publish/test/test-utils/action-mocks.ts
@@ -15,7 +15,7 @@ import * as externalCommands from '../../external-commands';
 import * as console from '../../../../utils/console';
 
 import {ReleaseAction} from '../../actions';
-import {GithubConfig} from '../../../../utils/config';
+import {GitClientConfig} from '../../../../utils/config';
 import {ReleaseConfig} from '../../../config';
 import {installVirtualGitClientSpies, VirtualGitClient} from '../../../../utils/testing';
 import {installSandboxGitClient} from './sandbox-git-client';
@@ -34,7 +34,7 @@ export const testReleasePackages = ['@angular/pkg1', '@angular/pkg2'];
 
 /** Gets test configurations for running testing a publish action. */
 export function getTestConfigurationsForAction() {
-  const githubConfig: GithubConfig = {
+  const githubConfig: GitClientConfig = {
     owner: 'angular',
     name: 'dev-infra-test',
     mainBranchName: 'master',
@@ -50,7 +50,7 @@ export function getTestConfigurationsForAction() {
 
 /** Sets up all test mocks needed to run a release action. */
 export function setupMocksForReleaseAction<T extends boolean>(
-  githubConfig: GithubConfig,
+  githubConfig: GitClientConfig,
   releaseConfig: ReleaseConfig,
   useSandboxGitClient: T,
 ) {
diff --git a/ng-dev/release/publish/test/test-utils/git-client-mock.ts b/ng-dev/release/publish/test/test-utils/git-client-mock.ts
@@ -6,14 +6,14 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {GithubConfig} from '../../../../utils/config';
+import {GitClientConfig} from '../../../../utils/config';
 import {SandboxGitClient} from './sandbox-git-client';
 import {VirtualGitClient} from '../../../../utils/testing';
 import {testTmpDir} from './action-mocks';
 
 /** Gets a mock instance for the `GitClient` instance. */
 export function getMockGitClient<T extends boolean>(
-  github: GithubConfig,
+  github: GitClientConfig,
   useSandboxGitClient: T,
 ): T extends true ? SandboxGitClient : VirtualGitClient {
   if (useSandboxGitClient) {
diff --git a/ng-dev/release/publish/test/test-utils/sandbox-git-client.ts b/ng-dev/release/publish/test/test-utils/sandbox-git-client.ts
@@ -8,7 +8,7 @@
 
 import {SpawnSyncOptions, SpawnSyncReturns} from 'child_process';
 import {AuthenticatedGitClient} from '../../../../utils/git/authenticated-git-client';
-import {NgDevConfig} from '../../../../utils/config';
+import {GitClientConfig} from '../../../../utils/config';
 import {GitClient} from '../../../../utils/git/git-client';
 
 /** Fake spawn sync returns value that is successful without any process output. */
@@ -22,7 +22,7 @@ const noopSpawnSyncReturns = {status: 0, stderr: '', output: [], pid: -1, signal
 export class SandboxGitClient extends AuthenticatedGitClient {
   static createInstance(
     gitBinPath: string,
-    config: NgDevConfig,
+    config: {github: GitClientConfig},
     baseDir: string,
   ): SandboxGitClient {
     return new SandboxGitClient(gitBinPath, 'abc123', baseDir, config);
@@ -33,7 +33,7 @@ export class SandboxGitClient extends AuthenticatedGitClient {
     override gitBinPath: string,
     githubToken: string,
     baseDir?: string,
-    config?: NgDevConfig,
+    config?: {github: GitClientConfig},
   ) {
     super(githubToken, baseDir, config);
   }
diff --git a/ng-dev/release/publish/test/test-utils/sandbox-testing.ts b/ng-dev/release/publish/test/test-utils/sandbox-testing.ts
diff --git a/ng-dev/release/publish/test/test-utils/test-action.ts b/ng-dev/release/publish/test/test-utils/test-action.ts
diff --git a/ng-dev/release/versioning/test/active-release-trains.spec.ts b/ng-dev/release/versioning/test/active-release-trains.spec.ts
diff --git a/ng-dev/release/versioning/version-branches.ts b/ng-dev/release/versioning/version-branches.ts
diff --git a/ng-dev/utils/config.ts b/ng-dev/utils/config.ts
diff --git a/ng-dev/utils/git/authenticated-git-client.ts b/ng-dev/utils/git/authenticated-git-client.ts
diff --git a/ng-dev/utils/git/git-client.ts b/ng-dev/utils/git/git-client.ts
diff --git a/ng-dev/utils/git/github-urls.ts b/ng-dev/utils/git/github-urls.ts
diff --git a/ng-dev/utils/testing/virtual-git-client.ts b/ng-dev/utils/testing/virtual-git-client.ts
