build: add function to validate and update 3rd party license files

- Implemented functionality to compare and update third-party license files
- Added handling for '--accept' argument to update the golden license file
- Included tests to ensure the Critters license file matches the golden reference

This update ensures license file consistency and provides an easy way to update the reference file when necessary.

Author: alan-agius4

.prettierignore

@@ -12,6 +12,6 @@
 /CONTRIBUTING.md
 .yarn/
 dist/
-third_party/
+third_party/github.com/
 /tests/legacy-cli/e2e/assets/
-/tools/test/*.json
+/tools/test/*.json

package.json

@@ -83,6 +83,7 @@
     "@bazel/buildifier": "7.1.2",
     "@bazel/concatjs": "patch:@bazel/concatjs@npm%3A5.8.1#~/.yarn/patches/@bazel-concatjs-npm-5.8.1-1bf81df846.patch",
     "@bazel/jasmine": "patch:@bazel/jasmine@npm%3A5.8.1#~/.yarn/patches/@bazel-jasmine-npm-5.8.1-3370fee155.patch",
+    "@bazel/runfiles": "^5.8.1",
     "@discoveryjs/json-ext": "0.6.1",
     "@inquirer/confirm": "3.1.22",
     "@inquirer/prompts": "5.3.8",
@@ -91,6 +92,7 @@
     "@rollup/plugin-node-resolve": "^13.0.5",
     "@types/babel__core": "7.20.5",
     "@types/browser-sync": "^2.27.0",
+    "@types/diff": "^5.2.1",
     "@types/express": "^4.16.0",
     "@types/http-proxy": "^1.17.4",
     "@types/ini": "^4.0.0",
@@ -130,6 +132,7 @@
     "critters": "0.0.24",
     "css-loader": "7.1.2",
     "debug": "^4.1.1",
+    "diff": "^5.2.0",
     "esbuild": "0.23.1",
     "esbuild-wasm": "0.23.1",
     "eslint": "8.57.0",

packages/angular/ssr/package.json

@@ -28,6 +28,8 @@
     "@angular/platform-browser": "19.0.0-next.1",
     "@angular/platform-server": "19.0.0-next.1",
     "@angular/router": "19.0.0-next.1",
+    "@bazel/runfiles": "^5.8.1",
+    "diff": "^5.2.0",
     "zone.js": "^0.15.0"
   },
   "schematics": "./schematics/collection.json",

packages/angular/ssr/test/BUILD.bazel

@@ -13,7 +13,7 @@ ts_library(
     testonly = True,
     srcs = glob(
         include = ["**/*_spec.ts"],
-        exclude = ESM_TESTS,
+        exclude = ESM_TESTS + ["npm_package/**"],
     ),
     deps = [
         "//packages/angular/ssr",

packages/angular/ssr/test/npm_package/BUILD.bazel

@@ -0,0 +1,35 @@
+load("@build_bazel_rules_nodejs//:index.bzl", "nodejs_binary")
+load("@npm//@bazel/jasmine:index.bzl", "jasmine_node_test")
+load("//tools:defaults.bzl", "ts_library")
+
+ts_library(
+    name = "unit_test_lib",
+    testonly = True,
+    srcs = glob(["**/*.ts"]),
+    deps = [
+        "@npm//@bazel/runfiles",
+        "@npm//@types/diff",
+    ],
+)
+
+jasmine_node_test(
+    name = "test",
+    srcs = [":unit_test_lib"],
+    data = [
+        "THIRD_PARTY_LICENSES.txt.golden",
+        "//packages/angular/ssr:npm_package",
+        "@npm//diff",
+    ],
+)
+
+nodejs_binary(
+    name = "test.accept",
+    testonly = True,
+    data = [
+        "THIRD_PARTY_LICENSES.txt.golden",
+        ":unit_test_lib",
+        "//packages/angular/ssr:npm_package",
+        "@npm//diff",
+    ],
+    entry_point = ":update-package-golden.ts",
+)

packages/angular/ssr/test/npm_package/THIRD_PARTY_LICENSES.txt.golden

@@ -0,0 +1,62 @@
+/**
+ * @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.dev/license
+ */
+
+import { createPatch } from 'diff';
+import { existsSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import {
+  ANGULAR_SSR_PACKAGE_PATH,
+  CRITTERS_ACTUAL_LICENSE_FILE_PATH,
+  CRITTERS_GOLDEN_LICENSE_FILE_PATH,
+} from './utils';
+
+describe('NPM Package Tests', () => {
+  it('should not include the contents of third_party/critters/index.js in the FESM bundle', async () => {
+    const fesmFilePath = join(ANGULAR_SSR_PACKAGE_PATH, 'fesm2022/ssr.mjs');
+    const fesmContent = await readFile(fesmFilePath, 'utf-8');
+    expect(fesmContent).toContain(`import Critters from '../third_party/critters/index.js'`);
+  });
+
+  describe('third_party/critters/THIRD_PARTY_LICENSES.txt', () => {
+    it('should exist', () => {
+      expect(existsSync(CRITTERS_ACTUAL_LICENSE_FILE_PATH)).toBe(true);
+    });
+
+    it('should match the expected golden file', async () => {
+      const [expectedContent, actualContent] = await Promise.all([
+        readFile(CRITTERS_GOLDEN_LICENSE_FILE_PATH, 'utf-8'),
+        readFile(CRITTERS_ACTUAL_LICENSE_FILE_PATH, 'utf-8'),
+      ]);
+
+      if (expectedContent.trim() === actualContent.trim()) {
+        return;
+      }
+
+      const patch = createPatch(
+        CRITTERS_GOLDEN_LICENSE_FILE_PATH,
+        expectedContent,
+        actualContent,
+        'Golden License File',
+        'Current License File',
+        { context: 5 },
+      );
+
+      const errorMessage = `The content of the actual license file differs from the expected golden reference.
+      Diff:
+      ${patch}
+      To accept the new golden file, execute:
+        yarn bazel run ${process.env['BAZEL_TARGET']}.accept
+    `;
+
+      const error = new Error(errorMessage);
+      error.stack = error.stack?.replace(`      Diff:\n      ${patch}`, '');
+      throw error;
+    });
+  });
+});

packages/angular/ssr/test/npm_package/package_spec.ts

@@ -0,0 +1,15 @@
+/**
+ * @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.dev/license
+ */
+
+import { readFileSync, writeFileSync } from 'node:fs';
+import { CRITTERS_ACTUAL_LICENSE_FILE_PATH, CRITTERS_GOLDEN_LICENSE_FILE_PATH } from './utils';
+
+/**
+ * Updates the golden reference license file.
+ */
+writeFileSync(CRITTERS_GOLDEN_LICENSE_FILE_PATH, readFileSync(CRITTERS_ACTUAL_LICENSE_FILE_PATH));

packages/angular/ssr/test/npm_package/update-package-golden.ts

@@ -0,0 +1,32 @@
+/**
+ * @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.dev/license
+ */
+
+import { runfiles } from '@bazel/runfiles';
+import { dirname, join } from 'node:path';
+
+/**
+ * Resolve paths for the Critters license file and the golden reference file.
+ */
+export const ANGULAR_SSR_PACKAGE_PATH = dirname(
+  runfiles.resolve('angular_cli/packages/angular/ssr/npm_package/package.json'),
+);
+
+/**
+ * Path to the actual license file for the Critters library.
+ * This file is located in the `third_party/critters` directory of the Angular CLI npm package.
+ */
+export const CRITTERS_ACTUAL_LICENSE_FILE_PATH = join(
+  ANGULAR_SSR_PACKAGE_PATH,
+  'third_party/critters/THIRD_PARTY_LICENSES.txt',
+);
+
+/**
+ * Path to the golden reference license file for the Critters library.
+ * This file is used as a reference for comparison and is located in the same directory as this script.
+ */
+export const CRITTERS_GOLDEN_LICENSE_FILE_PATH = join(__dirname, 'THIRD_PARTY_LICENSES.txt.golden');

packages/angular/ssr/test/npm_package/utils.ts

@@ -87,10 +87,9 @@ const EXTRACTION_FILE_SEPARATOR = '-'.repeat(80) + '\n';
  * @returns A string containing the content of the output licenses file.
  */
 async function extractLicenses(metafile) {
-  let extractedLicenseContent = `${EXTRACTION_FILE_HEADER}\n${EXTRACTION_FILE_SEPARATOR}`;
-
   const seenPaths = new Set();
   const seenPackages = new Set();
+  const extractedLicenses = {};
 
   for (const entry of Object.values(metafile.outputs)) {
     for (const [inputPath, { bytesInOutput }] of Object.entries(entry.inputs)) {
@@ -186,12 +185,20 @@ async function extractLicenses(metafile) {
       }
 
       // Generate the package's license entry in the output content
-      extractedLicenseContent += `Package: ${packageJson.name}\n`;
-      extractedLicenseContent += `License: ${JSON.stringify(packageJson.license, null, 2)}\n`;
-      extractedLicenseContent += `\n${licenseText}\n`;
+      let extractedLicenseContent = `Package: ${packageJson.name}\n`;
+      extractedLicenseContent += `License: ${JSON.stringify(packageJson.license, undefined, 2)}\n`;
+      extractedLicenseContent += `\n${licenseText.trim().replace(/\r?\n/g, '\n')}\n`;
       extractedLicenseContent += EXTRACTION_FILE_SEPARATOR;
+
+      extractedLicenses[packageJson.name] = extractedLicenseContent;
     }
   }
 
-  return extractedLicenseContent;
+  // Get the keys of the object and sort them and etract and join the values corresponding to the sorted keys
+  const joinedLicenseContent = Object.keys(extractedLicenses)
+    .sort()
+    .map((pkgName) => extractedLicenses[pkgName])
+    .join('');
+
+  return `${EXTRACTION_FILE_HEADER}\n${EXTRACTION_FILE_SEPARATOR}${joinedLicenseContent}`;
 }