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

Author: josephperrott

ng-dev/commit-message/config.ts

@@ -17,7 +17,9 @@ export interface CommitMessageConfig {
 }
 
 /** Assert the provided config contains a `CommitMessageConfig`. */
-export function assertValidCommitMessageConfig<T>(config: T & Partial<{commitMessage: CommitMessageConfig}>): asserts config is T & {commitMessage: CommitMessageConfig} {
+export function assertValidCommitMessageConfig<T>(
+  config: T & Partial<{commitMessage: CommitMessageConfig}>,
+): asserts config is T & {commitMessage: CommitMessageConfig} {
   if (config.commitMessage === undefined) {
     throw new ConfigValidationError(`No configuration defined for "commitMessage"`);
   }

ng-dev/commit-message/validate.spec.ts

@@ -36,7 +36,7 @@ function expectValidationResult(
 // TODO(josephperrott): Clean up tests to test script rather than for
 // specific commit messages we want to use.
 describe('validate-commit-message.js', () => {
-  let getConfigSpy: jasmine.Spy
+  let getConfigSpy: jasmine.Spy;
   beforeEach(() => {
     getConfigSpy = spyOn(configUtils, 'getConfig').and.returnValue(config);
   });

ng-dev/commit-message/validate.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { getConfig } from '../utils/config';
+import {getConfig} from '../utils/config';
 import {error} from '../utils/console';
 
 import {assertValidCommitMessageConfig, COMMIT_TYPES, ScopeRequirement} from './config';

ng-dev/release/build/BUILD.bazel

@@ -30,6 +30,7 @@ ts_library(
     deps = [
         ":build",
         "//ng-dev/release/config",
+        "//ng-dev/utils",
     ],
 )
 

ng-dev/release/build/build-worker.ts

@@ -13,7 +13,8 @@
  * supports stdout JSON output that should be parsable and not polluted from other stdout messages.
  */
 
-import {getReleaseConfig} from '../config/index';
+import {getConfig} from '../../utils/config';
+import {assertValidReleaseConfig} from '../config/index';
 
 // Start the release package building.
 main(process.argv[2] === 'true');
@@ -24,8 +25,9 @@ async function main(stampForRelease: boolean) {
     throw Error('This script needs to be invoked as a NodeJS worker.');
   }
 
-  const config = getReleaseConfig();
-  const builtPackages = await config.buildPackages(stampForRelease);
+  const config = getConfig();
+  assertValidReleaseConfig(config);
+  const builtPackages = await config.release.buildPackages(stampForRelease);
 
   // Transfer the built packages back to the parent process.
   process.send(builtPackages);

ng-dev/release/build/build.spec.ts

@@ -6,7 +6,8 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as releaseConfig from '../config/index';
+import * as configUtils from '../../utils/config';
+import {BuiltPackage} from '../config';
 import {ReleaseBuildCommandModule} from './cli';
 import * as index from './index';
 
@@ -31,9 +32,12 @@ describe('ng-dev release build', () => {
 
   /** Invokes the build command handler. */
   async function invokeBuild({json}: {json?: boolean} = {}) {
-    spyOn(releaseConfig, 'getReleaseConfig').and.returnValue({
-      npmPackages,
-      buildPackages,
+    spyOn(configUtils, 'getConfig').and.returnValue({
+      release: {
+        npmPackages,
+        buildPackages,
+        releaseNotes: {},
+      },
     });
     await ReleaseBuildCommandModule.handler({json: !!json, stampForRelease: true, $0: '', _: []});
   }
@@ -52,7 +56,7 @@ describe('ng-dev release build', () => {
     expect(writeSpy).toHaveBeenCalledTimes(1);
 
     const jsonText = writeSpy.calls.mostRecent().args[0] as string;
-    const parsed = JSON.parse(jsonText) as releaseConfig.BuiltPackage[];
+    const parsed = JSON.parse(jsonText) as BuiltPackage[];
 
     expect(parsed).toEqual([
       {name: '@angular/pkg1', outputPath: 'dist/pkg1'},

ng-dev/release/build/cli.ts

@@ -9,8 +9,8 @@
 import {Arguments, Argv, CommandModule} from 'yargs';
 
 import {getConfig} from '../../utils/config';
-import {error, green, info, red, warn, yellow} from '../../utils/console';
-import {BuiltPackage, getReleaseConfig} from '../config/index';
+import {error, green, info, red} from '../../utils/console';
+import {assertValidReleaseConfig} from '../config/index';
 
 import {buildReleaseOutput} from './index';
 
@@ -30,7 +30,9 @@ function builder(argv: Argv): Argv<ReleaseBuildOptions> {
 
 /** Yargs command handler for building a release. */
 async function handler(args: Arguments<ReleaseBuildOptions>) {
-  const {npmPackages} = getReleaseConfig();
+  const config = getConfig();
+  assertValidReleaseConfig(config);
+  const {npmPackages} = config.release;
   let builtPackages = await buildReleaseOutput(true);
 
   // If package building failed, print an error and exit with an error code.

ng-dev/release/config/index.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {assertNoErrors, getConfig} from '../../utils/config';
+import {assertNoErrors, ConfigValidationError, getConfig} from '../../utils/config';
 
 /** Interface describing a built package. */
 export interface BuiltPackage {
@@ -49,25 +49,26 @@ export interface ReleaseNotesConfig {
 export type DevInfraReleaseConfig = {release: ReleaseConfig};
 
 /** Retrieve and validate the config as `ReleaseConfig`. */
-export function getReleaseConfig(
-  config: Partial<DevInfraReleaseConfig> = getConfig(),
-): ReleaseConfig {
+export function assertValidReleaseConfig<T>(
+  config: T & Partial<DevInfraReleaseConfig>,
+): asserts config is T & DevInfraReleaseConfig {
   // List of errors encountered validating the config.
   const errors: string[] = [];
 
   if (config.release === undefined) {
-    errors.push(`No configuration defined for "release"`);
+    throw new ConfigValidationError('No configuration provided for `release`');
   }
-  if (config.release?.npmPackages === undefined) {
+
+  if (config.release.npmPackages === undefined) {
     errors.push(`No "npmPackages" configured for releasing.`);
   }
-  if (config.release?.buildPackages === undefined) {
+  if (config.release.buildPackages === undefined) {
     errors.push(`No "buildPackages" function configured for releasing.`);
   }
-  if (config.release?.releaseNotes === undefined) {
+  if (config.release.releaseNotes === undefined) {
     errors.push(`No "releaseNotes" configured for releasing.`);
   }
-
-  assertNoErrors(errors);
-  return config.release!;
+  if (errors.length) {
+    throw new ConfigValidationError('Invalid `release` configuration', errors);
+  }
 }

ng-dev/release/info/cli.ts

@@ -8,22 +8,24 @@
 
 import {CommandModule} from 'yargs';
 
-import {info} from '../../utils/console';
 import {GitClient} from '../../utils/git/git-client';
-import {getReleaseConfig} from '../config/index';
+import {assertValidReleaseConfig} from '../config/index';
 import {fetchActiveReleaseTrains} from '../versioning/active-release-trains';
 import {printActiveReleaseTrains} from '../versioning/print-active-trains';
 import {getNextBranchName, ReleaseRepoWithApi} from '../versioning';
+import {getConfig} from '../../utils/config';
 
 /** Yargs command handler for printing release information. */
 async function handler() {
   const git = GitClient.get();
   const nextBranchName = getNextBranchName(git.config.github);
   const repo: ReleaseRepoWithApi = {api: git.github, ...git.remoteConfig, nextBranchName};
   const releaseTrains = await fetchActiveReleaseTrains(repo);
+  const config = getConfig();
+  assertValidReleaseConfig(config);
 
   // Print the active release trains.
-  await printActiveReleaseTrains(releaseTrains, getReleaseConfig());
+  await printActiveReleaseTrains(releaseTrains, config.release);
 }
 
 /** CLI command module for retrieving release information. */

ng-dev/release/notes/release-notes.ts

@@ -11,12 +11,13 @@ import {CommitFromGitLog} from '../../commit-message/parse';
 
 import {promptInput} from '../../utils/console';
 import {GitClient} from '../../utils/git/git-client';
-import {DevInfraReleaseConfig, getReleaseConfig, ReleaseNotesConfig} from '../config/index';
+import {assertValidReleaseConfig, ReleaseNotesConfig} from '../config/index';
 import {RenderContext} from './context';
 
 import changelogTemplate from './templates/changelog';
 import githubReleaseTemplate from './templates/github-release';
 import {getCommitsForRangeWithDeduping} from './commits/get-commits-in-range';
+import {getConfig} from '../../utils/config';
 
 /** Release note generation. */
 export class ReleaseNotes {
@@ -87,9 +88,11 @@ export class ReleaseNotes {
     return this.renderContext;
   }
 
-  // These methods are used for access to the utility functions while allowing them
+  // This method is used for access to the utility functions while allowing them
   // to be overwritten in subclasses during testing.
-  protected getReleaseConfig(config?: Partial<DevInfraReleaseConfig>) {
-    return getReleaseConfig(config);
+  protected getReleaseConfig() {
+    const config = getConfig();
+    assertValidReleaseConfig(config);
+    return config.release;
   }
 }