fix(@angular-devkit/build-angular): ensure karma sourcemap support on Windows

clydin · alan-agius4 · commit 1a160dac00f3 · 2022-04-16T07:42:20.000+02:00
The `glob`-based check when adding the sourcemap support packages to the karma setup was incorrectly
skipping the files due to Windows pathing issues. The `glob`-based check, however, is unneeded due
to the already present `require.resolve` checks for the sourcemap support packages which will
throw if the packages are not present.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -318,7 +318,7 @@ jobs:
           name: Execute E2E Tests
           command: |
             if (Test-Path env:CIRCLE_PULL_REQUEST) {
-              node tests\legacy-cli\run_e2e.js "--glob={tests/basic/**,tests/i18n/extract-ivy*.ts,tests/build/profile.ts}" --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX
+              node tests\legacy-cli\run_e2e.js "--glob={tests/basic/**,tests/i18n/extract-ivy*.ts,tests/build/profile.ts,tests/test/test-sourcemap.ts}" --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX
             } else {
               node tests\legacy-cli\run_e2e.js --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX
             }
diff --git a/packages/angular_devkit/build_angular/src/webpack/plugins/karma/karma.ts b/packages/angular_devkit/build_angular/src/webpack/plugins/karma/karma.ts
@@ -10,7 +10,6 @@
 // TODO: cleanup this file, it's copied as is from Angular CLI.
 import * as http from 'http';
 import * as path from 'path';
-import * as glob from 'glob';
 import webpack from 'webpack';
 import webpackDevMiddleware from 'webpack-dev-middleware';
 
@@ -28,29 +27,6 @@ let webpackMiddleware: any;
 let successCb: () => void;
 let failureCb: () => void;
 
-// Add files to the Karma files array.
-function addKarmaFiles(files: any[], newFiles: any[], prepend = false) {
-  const defaults = {
-    included: true,
-    served: true,
-    watched: true,
-  };
-
-  const processedFiles = newFiles
-    // Remove globs that do not match any files, otherwise Karma will show a warning for these.
-    .filter((file) => glob.sync(file.pattern, { nodir: true }).length != 0)
-    // Fill in pattern properties with defaults.
-    .map((file) => ({ ...defaults, ...file }));
-
-  // It's important to not replace the array, because
-  // karma already has a reference to the existing array.
-  if (prepend) {
-    files.unshift(...processedFiles);
-  } else {
-    files.push(...processedFiles);
-  }
-}
-
 const init: any = (config: any, emitter: any) => {
   if (!config.buildWebpack) {
     throw new Error(
@@ -73,13 +49,14 @@ const init: any = (config: any, emitter: any) => {
     const smsPath = path.dirname(require.resolve('source-map-support'));
     const ksmsPath = path.dirname(require.resolve('karma-source-map-support'));
 
-    addKarmaFiles(
-      config.files,
-      [
-        { pattern: path.join(smsPath, 'browser-source-map-support.js'), watched: false },
-        { pattern: path.join(ksmsPath, 'client.js'), watched: false },
-      ],
-      true,
+    config.files.unshift(
+      {
+        pattern: path.join(smsPath, 'browser-source-map-support.js'),
+        included: true,
+        served: true,
+        watched: false,
+      },
+      { pattern: path.join(ksmsPath, 'client.js'), included: true, served: true, watched: false },
     );
   }
 

Original file line number	Diff line number	Diff line change
`@@ -318,7 +318,7 @@ jobs:`
`318`	`318`	`name: Execute E2E Tests`
`319`	`319`	`command: \|`
`320`	`320`	`if (Test-Path env:CIRCLE_PULL_REQUEST) {`
`321`		`- node tests\legacy-cli\run_e2e.js "--glob={tests/basic/*,tests/i18n/extract-ivy.ts,tests/build/profile.ts}" --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX`
	`321`	`+ node tests\legacy-cli\run_e2e.js "--glob={tests/basic/*,tests/i18n/extract-ivy.ts,tests/build/profile.ts,tests/test/test-sourcemap.ts}" --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX`
`322`	`322`	`} else {`
`323`	`323`	`node tests\legacy-cli\run_e2e.js --nb-shards=$env:CIRCLE_NODE_TOTAL --shard=$env:CIRCLE_NODE_INDEX`
`324`	`324`	`}`