build: check bazel rollup globals

We currently need to also maintain a list
of rollup globals for bazel. Since these globals
are impacting the release output we need to check
these somehow in order to be sure that we do not
accidentally bundle other entry-points into an
entry-point.

Author: devversion

.circleci/config.yml

@@ -265,8 +265,16 @@ jobs:
     steps:
       - *checkout_code
       - *restore_cache
+      - *setup_bazel_ci_config
       - *yarn_download
       - *yarn_install
+      - *setup_bazel_binary
+
+      - run:
+          name: Checking rollup globals
+          command: |
+            bazel build //:rollup_globals
+            yarn check-rollup-globals $(bazel info bazel-bin)/rollup_globals.json
 
       - run: ./scripts/circleci/lint-bazel-files.sh
       - run: yarn gulp ci:lint

BUILD.bazel

@@ -1,3 +1,11 @@
 package(default_visibility = ["//visibility:public"])
 
+load("//:packages.bzl", "ROLLUP_GLOBALS")
+
 exports_files(["LICENSE"])
+
+genrule(
+    name = "rollup_globals",
+    outs = ["rollup_globals.json"],
+    cmd = "echo '%s' > $@" % ROLLUP_GLOBALS,
+)

package.json

@@ -34,7 +34,8 @@
     "format:ts": "git-clang-format HEAD $(git diff HEAD --name-only | grep -v \"\\.d\\.ts\")",
     "format:bazel": "yarn -s bazel:buildifier --lint=fix --mode=fix",
     "format": "yarn -s format:ts && yarn -s format:bazel",
-    "cherry-pick-patch": "ts-node --project tools/cherry-pick-patch/ tools/cherry-pick-patch/cherry-pick-patch.ts"
+    "cherry-pick-patch": "ts-node --project tools/cherry-pick-patch/ tools/cherry-pick-patch/cherry-pick-patch.ts",
+    "check-rollup-globals": "ts-node --project scripts/ scripts/check-rollup-globals.ts"
   },
   "version": "8.2.0",
   "requiredAngularVersion": "^8.0.0 || ^9.0.0-0",

packages.bzl

@@ -1,3 +1,7 @@
+# Disable sorting of dict variables  as we sometimes want to group
+# specific dict entries manually.
+# buildifier: disable=unsorted-dict-items
+
 # List of all components / subpackages.
 
 CDK_PACKAGES = [
@@ -134,13 +138,35 @@ VERSION_PLACEHOLDER_REPLACEMENTS = {
 
 # Base rollup globals for everything in the repo.
 ROLLUP_GLOBALS = {
+    # Framework packages.
+    "@angular/animations": "ng.animations",
+    "@angular/common": "ng.common",
+    "@angular/common/http": "ng.common.http",
+    "@angular/common/http/testing": "ng.common.http.testing",
+    "@angular/common/testing": "ng.common.testing",
+    "@angular/core": "ng.core",
+    "@angular/core/testing": "ng.core.testing",
+    "@angular/forms": "ng.forms",
+    "@angular/platform-browser": "ng.platformBrowser",
+    "@angular/platform-browser-dynamic": "ng.platformBrowserDynamic",
+    "@angular/platform-browser-dynamic/testing": "ng.platformBrowserDynamic.testing",
+    "@angular/platform-browser/animations": "ng.platformBrowser.animations",
+    "@angular/platform-server": "ng.platformServer",
+    "@angular/router": "ng.router",
+
+    # Primary entry-points in the project.
     "@angular/cdk": "ng.cdk",
     "@angular/cdk-experimental": "ng.cdkExperimental",
     "@angular/google-maps": "ng.googleMaps",
     "@angular/material": "ng.material",
     "@angular/material-experimental": "ng.materialExperimental",
+    "@angular/material-moment-adapter": "ng.materialMomentAdapter",
     "@angular/youtube-player": "ng.youtubePlayer",
 
+    # Special tertiary entry-points for which globals are not generated
+    # automatically (e.g. since they are treated as their own npm package).
+    "@angular/cdk/testing": "ng.cdk.testing",
+
     # MDC Web
     "@material/animation": "mdc.animation",
     "@material/auto-init": "mdc.autoInit",
@@ -172,7 +198,12 @@ ROLLUP_GLOBALS = {
     "@material/tab-scroller": "mdc.tabScroller",
     "@material/text-field": "mdc.textField",
     "@material/top-app-bar": "mdc.topAppBar",
+
+    # Third-party libraries.
     "moment": "moment",
+    "protractor": "protractor",
+    "rxjs": "rxjs",
+    "rxjs/operators": "rxjs.operators",
     "tslib": "tslib",
 }
 
@@ -195,6 +226,15 @@ ROLLUP_GLOBALS.update({
     for p in MATERIAL_PACKAGES
 })
 
+# Rollup globals for material testing entry-points.
+# e.g., {"@angular/material/dialog/testing": "ng.material.dialog.testing"}
+# TODO(devversion): consider removing this if we wire up tertiary entry-points in the
+# release package. We should not hardcode these tertiary entry-points.
+ROLLUP_GLOBALS.update({
+    "@angular/material/%s/testing" % p: "ng.material.%s.testing" % p
+    for p in MATERIAL_PACKAGES
+})
+
 # Rollup globals for material experimental subpackages, e.g.,
 # {"@angular/material-experimental/list": "ng.materialExperimental.list"}
 ROLLUP_GLOBALS.update({

scripts/check-rollup-globals.ts

@@ -0,0 +1,73 @@
+/**
+ * Script that goes through each source file that will be included in the
+ * release output and checks if any module imports are not part of the
+ * specified rollup globals file.
+ *
+ * This script is used to validate Bazel rollup globals. We use a genrule to
+ * convert the Starlark rollup globals dict into a JSON file which then can
+ * be passed to this script to ensure that the rollup globals are up-to-date.
+ */
+
+import {green, red, yellow} from 'chalk';
+import {readFileSync} from 'fs';
+import * as minimatch from 'minimatch';
+import {join, relative} from 'path';
+import * as ts from 'typescript';
+
+const projectRoot = join(__dirname, '../');
+const args = process.argv.slice(2);
+
+if (args.length !== 1) {
+  console.error(red('No rollup globals file has been specified.'));
+  process.exit(1);
+}
+
+const rollupGlobals = JSON.parse(readFileSync(args[0], 'utf8'));
+const configFile = ts.readJsonConfigFile(join(projectRoot, 'tsconfig.json'), ts.sys.readFile);
+const parsedConfig = ts.parseJsonSourceFileConfigFileContent(configFile, ts.sys, projectRoot);
+const filesToCheckGlob = [
+  'src/**/!(*.spec).ts',
+  '!src/+(a11y-demo|e2e-app|universal-app|dev-app)/**/*.ts',
+  '!src/**/schematics/**/*.ts',
+];
+
+const failures = new Map<string, string[]>();
+
+parsedConfig.fileNames.forEach(fileName => {
+  const relativeFileName = relative(projectRoot, fileName);
+  if (!filesToCheckGlob.every(g => minimatch(relativeFileName, g))) {
+    return;
+  }
+
+  const sourceFile =
+      ts.createSourceFile(fileName, readFileSync(fileName, 'utf8'), ts.ScriptTarget.Latest, true);
+
+  const visitNode = (node: ts.Node) => {
+    if (ts.isImportDeclaration(node)) {
+      // Parse out the module name. The first and last characters are the quote marks.
+      const module = node.moduleSpecifier.getText().slice(1, -1);
+      const isExternal = !module.startsWith('.') && !module.startsWith('/');
+
+      // Check whether the module is external and whether it's in our rollup globals.
+      if (isExternal && !rollupGlobals[module]) {
+        failures.set(fileName, (failures.get(fileName) || []).concat(module));
+      }
+    }
+
+    ts.forEachChild(node, visitNode);
+  };
+
+  ts.forEachChild(sourceFile, visitNode);
+});
+
+if (failures.size) {
+  console.error(red('  ✘   Rollup globals are not up-to-date.'));
+  console.error();
+
+  failures.forEach((missingGlobals, fileName) => {
+    console.error(yellow(`  ⮑   ${fileName}:`));
+    missingGlobals.forEach(g => console.error(`      - ${g}`));
+  });
+} else {
+  console.info(green('  ✓   Rollup globals are up-to-date.'));
+}