feat(ng-dev): create a configuration check subcommand

Create a subcommand which validates that the configuration provided is portable in its initial load and passes expected assertions for specific
configurations.

Author: josephperrott

ng-dev/BUILD.bazel

@@ -54,6 +54,7 @@ ts_project(
         "//ng-dev/auth",
         "//ng-dev/caretaker",
         "//ng-dev/commit-message",
+        "//ng-dev/config",
         "//ng-dev/format",
         "//ng-dev/misc",
         "//ng-dev/ngbot",

ng-dev/cli.ts

@@ -22,6 +22,7 @@ import {captureLogOutputForCommand} from './utils/logging.js';
 import {ngDevVersionMiddleware} from './utils/version-check.js';
 import {buildAuthParser} from './auth/cli.js';
 import {buildPerfParser} from './perf/cli.js';
+import {buildConfigParser} from './config/cli.js';
 import {buildAiParser} from './ai/cli.js';
 import {Argv} from 'yargs';
 
@@ -44,6 +45,7 @@ runParserWithCompletedFunctions((yargs: Argv) => {
     .command('ngbot <command>', false, buildNgbotParser)
     .command('perf <command>', '', buildPerfParser)
     .command('ai <command>', '', buildAiParser)
+    .command('config <command>', false, buildConfigParser)
     .wrap(120)
     .strict();
 });

ng-dev/config/BUILD.bazel

@@ -0,0 +1,13 @@
+load("//tools:defaults.bzl", "ts_project")
+
+ts_project(
+    name = "config",
+    srcs = [
+        "cli.ts",
+    ],
+    visibility = ["//ng-dev:__subpackages__"],
+    deps = [
+        "//ng-dev:node_modules/@types/yargs",
+        "//ng-dev/config/validate",
+    ],
+)

ng-dev/config/cli.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright Google LLC
+ *
+ * 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 {Argv} from 'yargs';
+import {ValidateModule} from './validate/cli.js';
+
+/** Build the parser for the release commands. */
+export function buildConfigParser(localYargs: Argv) {
+  return localYargs.help().strict().demandCommand().command(ValidateModule);
+}

ng-dev/config/validate/BUILD.bazel

@@ -0,0 +1,15 @@
+load("//tools:defaults.bzl", "ts_project")
+
+ts_project(
+    name = "validate",
+    srcs = glob(["*.ts"]),
+    visibility = ["//ng-dev/config:__subpackages__"],
+    deps = [
+        "//ng-dev:node_modules/@types/yargs",
+        "//ng-dev/commit-message",
+        "//ng-dev/format",
+        "//ng-dev/pr/config",
+        "//ng-dev/release/config",
+        "//ng-dev/utils",
+    ],
+)

ng-dev/config/validate/cli.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright Google LLC
+ *
+ * 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 {Argv, CommandModule} from 'yargs';
+import {green, Log, red} from '../../utils/logging';
+import {checkPortability} from './portability';
+import {checkValidity} from './validity';
+import {ConfigValidationError} from '../../utils/config';
+
+export interface Options {}
+
+/** Builds the command. */
+async function builder(yargs: Argv) {
+  return yargs;
+}
+
+/** Handles the command. */
+async function handler() {
+  try {
+    await checkPortability();
+    await checkValidity();
+    Log.info(`${green('✓')} ng-dev configuration validation passed`);
+  } catch (error) {
+    if (error instanceof ConfigValidationError) {
+      error.errors.forEach((e) => Log.info(e));
+    } else {
+      Log.info(error);
+    }
+    Log.info(`${red('✘')} ng-dev configuration validation failed, see above for more details`);
+  }
+}
+
+/** yargs command module for logging into the ng-dev service. */
+export const ValidateModule: CommandModule<{}, Options> = {
+  handler,
+  builder,
+  command: 'validate',
+  describe: 'Validate that the configuration provided in .ng-dev/ is valid and portable',
+};

ng-dev/config/validate/portability.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright Google LLC
+ *
+ * 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 {ChildProcess} from '../../utils/child-process';
+import {join} from 'path';
+import {tmpdir} from 'os';
+import {cp, mkdtemp, rm} from 'fs/promises';
+import {determineRepoBaseDirFromCwd} from '../../utils/repo-directory';
+import {Log} from '../../utils/logging';
+
+export async function checkPortability() {
+  Log.debug('Copying ng-dev configuration to isolated temp directory');
+  const tmpConfigDir = await mkdtemp(join(tmpdir(), 'ng-dev-config-check-'));
+  const repoBaseDir = determineRepoBaseDirFromCwd();
+  try {
+    await cp(join(repoBaseDir, '.ng-dev'), tmpConfigDir, {recursive: true});
+    Log.debug('Validating configuration loads in isolation');
+    const baseConfigFile = join(tmpConfigDir, 'config.mjs');
+    const {status, stderr} = await ChildProcess.exec(`node ${baseConfigFile}`, {
+      cwd: tmpConfigDir,
+      mode: 'silent',
+    });
+    if (status !== 0) {
+      throw Error(stderr);
+    }
+  } catch (err) {
+    throw err;
+  } finally {
+    await rm(tmpConfigDir, {recursive: true, maxRetries: 3});
+  }
+}

ng-dev/config/validate/validity.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright Google LLC
+ *
+ * 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 {assertValidCommitMessageConfig} from '../../commit-message/config';
+import {assertValidFormatConfig} from '../../format/config';
+import {assertValidPullRequestConfig} from '../../pr/config';
+import {assertValidReleaseConfig} from '../../release/config';
+import {
+  assertValidCaretakerConfig,
+  assertValidGithubConfig,
+  getConfig,
+  NgDevConfig,
+} from '../../utils/config';
+
+export async function checkValidity() {
+  const config = (await getConfig()) as NgDevConfig<{[key: string]: any}>;
+  if (config['github']) {
+    assertValidGithubConfig(config);
+  }
+  if (config['caretaker']) {
+    assertValidCaretakerConfig(config);
+  }
+  if (config['commitMessage']) {
+    assertValidCommitMessageConfig(config);
+  }
+  if (config['pullRequest']) {
+    assertValidPullRequestConfig(config);
+  }
+  if (config['format']) {
+    assertValidFormatConfig(config);
+  }
+  if (config['release']) {
+    assertValidReleaseConfig(config);
+  }
+}