6d2087b8f fix(@angular-devkit/build-angular): automatically purge stale build cache entries

Angular Builds · Angular Builds · commit 8b9feff92b68 · 2022-01-12T18:29:00.000Z
diff --git a/package.json b/package.json
@@ -7,9 +7,9 @@
   "builders": "builders.json",
   "dependencies": {
     "@ampproject/remapping": "1.0.2",
-    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#cbe028e37",
-    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#cbe028e37",
-    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#cbe028e37",
+    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#6d2087b8f",
+    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#6d2087b8f",
+    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#6d2087b8f",
     "@babel/core": "7.16.7",
     "@babel/generator": "7.16.7",
     "@babel/helper-annotate-as-pure": "7.16.7",
@@ -20,7 +20,7 @@
     "@babel/runtime": "7.16.7",
     "@babel/template": "7.16.7",
     "@discoveryjs/json-ext": "0.5.6",
-    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#cbe028e37",
+    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#6d2087b8f",
     "ansi-colors": "4.1.1",
     "babel-loader": "8.2.3",
     "babel-plugin-istanbul": "6.1.1",
diff --git a/src/babel/webpack-loader.js b/src/babel/webpack-loader.js
@@ -14,6 +14,7 @@ const remapping_1 = __importDefault(require("@ampproject/remapping"));
 const babel_loader_1 = require("babel-loader");
 const typescript_1 = require("typescript");
 const load_esm_1 = require("../utils/load-esm");
+const package_version_1 = require("../utils/package-version");
 /**
  * Cached instance of the compiler-cli linker's needsLinking function.
  */
@@ -151,7 +152,7 @@ exports.default = (0, babel_loader_1.custom)(() => {
                 ...baseOptions,
                 ...rawOptions,
                 cacheIdentifier: JSON.stringify({
-                    buildAngular: require('../../package.json').version,
+                    buildAngular: package_version_1.VERSION,
                     customOptions,
                     baseOptions,
                     rawOptions,
diff --git a/src/builders/browser/index.js b/src/builders/browser/index.js
@@ -44,6 +44,7 @@ const index_html_generator_1 = require("../../utils/index-file/index-html-genera
 const normalize_cache_1 = require("../../utils/normalize-cache");
 const output_paths_1 = require("../../utils/output-paths");
 const package_chunk_sort_1 = require("../../utils/package-chunk-sort");
+const purge_cache_1 = require("../../utils/purge-cache");
 const service_worker_1 = require("../../utils/service-worker");
 const spinner_1 = require("../../utils/spinner");
 const supported_browsers_1 = require("../../utils/supported-browsers");
@@ -98,6 +99,8 @@ function buildWebpackBrowser(options, context, transforms = {}) {
     return (0, rxjs_1.from)(context.getProjectMetadata(projectName)).pipe((0, operators_1.switchMap)(async (projectMetadata) => {
         var _a;
         const sysProjectRoot = (0, core_1.getSystemPath)((0, core_1.resolve)((0, core_1.normalize)(context.workspaceRoot), (0, core_1.normalize)((_a = projectMetadata.root) !== null && _a !== void 0 ? _a : '')));
+        // Purge old build disk cache.
+        await (0, purge_cache_1.purgeStaleBuildCache)(context);
         checkInternetExplorerSupport(sysProjectRoot, context.logger);
         return {
             ...(await initialize(options, context, transforms.webpackConfiguration)),
diff --git a/src/builders/dev-server/index.js b/src/builders/dev-server/index.js
@@ -41,6 +41,7 @@ const i18n_options_1 = require("../../utils/i18n-options");
 const load_translations_1 = require("../../utils/load-translations");
 const normalize_cache_1 = require("../../utils/normalize-cache");
 const package_chunk_sort_1 = require("../../utils/package-chunk-sort");
+const purge_cache_1 = require("../../utils/purge-cache");
 const version_1 = require("../../utils/version");
 const webpack_browser_config_1 = require("../../utils/webpack-browser-config");
 const webpack_diagnostics_1 = require("../../utils/webpack-diagnostics");
@@ -69,6 +70,8 @@ function serveWebpackBrowser(options, context, transforms = {}) {
         if (!projectName) {
             throw new Error('The builder requires a target.');
         }
+        // Purge old build disk cache.
+        await (0, purge_cache_1.purgeStaleBuildCache)(context);
         options.port = await (0, check_port_1.checkPort)((_b = options.port) !== null && _b !== void 0 ? _b : 4200, options.host || 'localhost');
         if (options.hmr) {
             logger.warn(core_1.tags.stripIndents `NOTICE: Hot Module Replacement (HMR) is enabled for the dev server.
diff --git a/src/builders/extract-i18n/index.js b/src/builders/extract-i18n/index.js
@@ -37,6 +37,7 @@ const path = __importStar(require("path"));
 const webpack_1 = __importDefault(require("webpack"));
 const i18n_options_1 = require("../../utils/i18n-options");
 const load_esm_1 = require("../../utils/load-esm");
+const purge_cache_1 = require("../../utils/purge-cache");
 const version_1 = require("../../utils/version");
 const webpack_browser_config_1 = require("../../utils/webpack-browser-config");
 const configs_1 = require("../../webpack/configs");
@@ -119,6 +120,8 @@ async function execute(options, context, transforms) {
     var _a;
     // Check Angular version.
     (0, version_1.assertCompatibleAngularVersion)(context.workspaceRoot);
+    // Purge old build disk cache.
+    await (0, purge_cache_1.purgeStaleBuildCache)(context);
     const browserTarget = (0, architect_1.targetFromTargetString)(options.browserTarget);
     const browserOptions = await context.validateOptions(await context.getTargetOptions(browserTarget), await context.getBuilderNameForTarget(browserTarget));
     const format = normalizeFormatOption(options);
diff --git a/src/builders/karma/index.js b/src/builders/karma/index.js
@@ -32,13 +32,16 @@ const core_1 = require("@angular-devkit/core");
 const path_1 = require("path");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const purge_cache_1 = require("../../utils/purge-cache");
 const version_1 = require("../../utils/version");
 const webpack_browser_config_1 = require("../../utils/webpack-browser-config");
 const configs_1 = require("../../webpack/configs");
 const single_test_transform_1 = require("../../webpack/plugins/single-test-transform");
 const schema_1 = require("../browser/schema");
 const find_tests_1 = require("./find-tests");
 async function initialize(options, context, webpackConfigurationTransformer) {
+    // Purge old build disk cache.
+    await (0, purge_cache_1.purgeStaleBuildCache)(context);
     const { config } = await (0, webpack_browser_config_1.generateBrowserWebpackConfigFromContext)(
     // only two properties are missing:
     // * `outputPath` which is fixed for tests
diff --git a/src/builders/ng-packagr/index.js b/src/builders/ng-packagr/index.js
@@ -32,12 +32,15 @@ const path_1 = require("path");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const normalize_cache_1 = require("../../utils/normalize-cache");
+const purge_cache_1 = require("../../utils/purge-cache");
 /**
  * @experimental Direct usage of this function is considered experimental.
  */
 function execute(options, context) {
     return (0, rxjs_1.from)((async () => {
         var _a;
+        // Purge old build disk cache.
+        await (0, purge_cache_1.purgeStaleBuildCache)(context);
         const root = context.workspaceRoot;
         const packager = (await Promise.resolve().then(() => __importStar(require('ng-packagr')))).ngPackagr();
         packager.forProject((0, path_1.resolve)(root, options.project));
diff --git a/src/builders/server/index.js b/src/builders/server/index.js
@@ -37,6 +37,7 @@ const typescript_1 = require("typescript");
 const utils_1 = require("../../utils");
 const i18n_inlining_1 = require("../../utils/i18n-inlining");
 const output_paths_1 = require("../../utils/output-paths");
+const purge_cache_1 = require("../../utils/purge-cache");
 const version_1 = require("../../utils/version");
 const webpack_browser_config_1 = require("../../utils/webpack-browser-config");
 const configs_1 = require("../../webpack/configs");
@@ -103,6 +104,8 @@ function execute(options, context, transforms = {}) {
 exports.execute = execute;
 exports.default = (0, architect_1.createBuilder)(execute);
 async function initialize(options, context, webpackConfigurationTransform) {
+    // Purge old build disk cache.
+    await (0, purge_cache_1.purgeStaleBuildCache)(context);
     const originalOutputPath = options.outputPath;
     const { config, i18n, target } = await (0, webpack_browser_config_1.generateI18nBrowserWebpackConfigFromContext)({
         ...options,
diff --git a/src/utils/index-file/inline-fonts.js b/src/utils/index-file/inline-fonts.js
@@ -36,8 +36,8 @@ const https = __importStar(require("https"));
 const https_proxy_agent_1 = __importDefault(require("https-proxy-agent"));
 const path_1 = require("path");
 const url_1 = require("url");
+const package_version_1 = require("../package-version");
 const html_rewriting_stream_1 = require("./html-rewriting-stream");
-const packageVersion = require('../../../package.json').version;
 const SUPPORTED_PROVIDERS = {
     'fonts.googleapis.com': {
         preconnectUrl: 'https://fonts.gstatic.com',
@@ -146,7 +146,7 @@ class InlineFontsProcessor {
     }
     async getResponse(url) {
         var _a;
-        const key = `${packageVersion}|${url}`;
+        const key = `${package_version_1.VERSION}|${url}`;
         if (this.cachePath) {
             const entry = await cacache.get.info(this.cachePath, key);
             if (entry) {
diff --git a/src/utils/normalize-cache.d.ts b/src/utils/normalize-cache.d.ts
@@ -7,7 +7,11 @@
  */
 import { json } from '@angular-devkit/core';
 export interface NormalizedCachedOptions {
+    /** Whether disk cache is enabled. */
     enabled: boolean;
+    /** Disk cache path. Example: `/.angular/cache/v12.0.0`. */
     path: string;
+    /** Disk cache base path. Example: `/.angular/cache`. */
+    basePath: string;
 }
 export declare function normalizeCacheOptions(metadata: json.JsonObject, worspaceRoot: string): NormalizedCachedOptions;
diff --git a/src/utils/normalize-cache.js b/src/utils/normalize-cache.js
@@ -11,6 +11,7 @@ exports.normalizeCacheOptions = void 0;
 const core_1 = require("@angular-devkit/core");
 const path_1 = require("path");
 const environment_options_1 = require("./environment-options");
+const package_version_1 = require("./package-version");
 function normalizeCacheOptions(metadata, worspaceRoot) {
     var _a;
     const cacheMetadata = core_1.json.isJsonObject(metadata.cli) && core_1.json.isJsonObject(metadata.cli.cache)
@@ -32,9 +33,11 @@ function normalizeCacheOptions(metadata, worspaceRoot) {
                 break;
         }
     }
+    const cacheBasePath = (0, path_1.resolve)(worspaceRoot, path);
     return {
         enabled: cacheEnabled,
-        path: (0, path_1.resolve)(worspaceRoot, path),
+        basePath: cacheBasePath,
+        path: (0, path_1.join)(cacheBasePath, package_version_1.VERSION),
     };
 }
 exports.normalizeCacheOptions = normalizeCacheOptions;
diff --git a/src/utils/package-version.d.ts b/src/utils/package-version.d.ts
@@ -0,0 +1,8 @@
+/**
+ * @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.io/license
+ */
+export declare const VERSION: string;
diff --git a/src/utils/package-version.js b/src/utils/package-version.js
@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * @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.io/license
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = require('../../package.json').version;
diff --git a/src/utils/purge-cache.d.ts b/src/utils/purge-cache.d.ts
@@ -0,0 +1,10 @@
+/**
+ * @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.io/license
+ */
+import { BuilderContext } from '@angular-devkit/architect';
+/** Delete stale cache directories used by previous versions of build-angular. */
+export declare function purgeStaleBuildCache(context: BuilderContext): Promise<void>;
diff --git a/src/utils/purge-cache.js b/src/utils/purge-cache.js
@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * @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.io/license
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.purgeStaleBuildCache = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const normalize_cache_1 = require("./normalize-cache");
+/** Delete stale cache directories used by previous versions of build-angular. */
+async function purgeStaleBuildCache(context) {
+    var _a;
+    const projectName = (_a = context.target) === null || _a === void 0 ? void 0 : _a.project;
+    if (!projectName) {
+        return;
+    }
+    const metadata = await context.getProjectMetadata(projectName);
+    const { basePath, path, enabled } = (0, normalize_cache_1.normalizeCacheOptions)(metadata, context.workspaceRoot);
+    if (!enabled || !(0, fs_1.existsSync)(basePath)) {
+        return;
+    }
+    // The below should be removed and replaced with just `rm` when support for Node.Js 12 is removed.
+    const { rm, rmdir } = fs_1.promises;
+    const entriesToDelete = (await fs_1.promises.readdir(basePath, { withFileTypes: true }))
+        .filter((d) => (0, path_1.join)(basePath, d.name) !== path && d.isDirectory())
+        .map((d) => {
+        const subPath = (0, path_1.join)(basePath, d.name);
+        try {
+            return rm
+                ? rm(subPath, { force: true, recursive: true, maxRetries: 3 })
+                : rmdir(subPath, { recursive: true, maxRetries: 3 });
+        }
+        catch { }
+    });
+    await Promise.all(entriesToDelete);
+}
+exports.purgeStaleBuildCache = purgeStaleBuildCache;
diff --git a/src/webpack/utils/helpers.js b/src/webpack/utils/helpers.js
@@ -35,6 +35,7 @@ const fs_1 = require("fs");
 const glob_1 = __importDefault(require("glob"));
 const path = __importStar(require("path"));
 const typescript_1 = require("typescript");
+const package_version_1 = require("../../utils/package-version");
 function getOutputHashFormat(option, length = 20) {
     const hashFormats = {
         none: { chunk: '', extract: '', file: '', script: '' },
@@ -113,7 +114,6 @@ exports.getInstrumentationExcludedPaths = getInstrumentationExcludedPaths;
 function getCacheSettings(wco, angularVersion) {
     const { enabled, path: cacheDirectory } = wco.buildOptions.cache;
     if (enabled) {
-        const packageVersion = require('../../../package.json').version;
         return {
             type: 'filesystem',
             profile: wco.buildOptions.verbose,
@@ -124,7 +124,7 @@ function getCacheSettings(wco, angularVersion) {
             // None of which are "named".
             name: (0, crypto_1.createHash)('sha1')
                 .update(angularVersion)
-                .update(packageVersion)
+                .update(package_version_1.VERSION)
                 .update(wco.projectRoot)
                 .update(JSON.stringify(wco.tsConfig))
                 .update(JSON.stringify({
diff --git a/uniqueId b/uniqueId
@@ -1 +1 @@
-Tue Jan 11 2022 00:43:25 GMT+0000 (Coordinated Universal Time)
+Wed Jan 12 2022 18:29:00 GMT+0000 (Coordinated Universal Time)
