@ziacik/upgrade-verify 0.2.0 → 1.0.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2023-10-21
+
+## Added
+
+- `removeHashes` option added to the `verify-build` executor, with a default of `true`, which removes hashes from file names, making the comparisons more deterministic.
+- `check-issues` executor added.
+
 ## [0.2.0] - 2023-10-15
 
 ### Changed
@@ -44,7 +51,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - READMEs updated and props added to package.json.
 - A _Package subpath './package.json' is not defined by "exports"_ error hopefully fixed.
 
-[unreleased]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.2.0...HEAD
+[unreleased]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-1.0.0...HEAD
+[1.0.0]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.2.0...upgrade-verify-1.0.0
 [0.2.0]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.1.1...upgrade-verify-0.2.0
 [0.1.1]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.1.0...upgrade-verify-0.1.1
 [0.1.0]: https://github.com/ziacik/nx-tools/compare/upgrade-verify-0.0.4...upgrade-verify-0.1.0

package/README.md

@@ -1,6 +1,22 @@
 # Nx Upgrade Verify Plugin
 
-This plugin provides functionality to verify the build of a project after NX upgrade by comparing distribution statistics and detecting any significant differences.
+This plugin provides functionality to verify various aspects of a workspace after NX upgrade.
+
+## Installation
+
+To install the plugin, run the following command:
+
+```bash
+npm install -D @ziacik/upgrade-verify
+```
+
+## Usage
+
+Once the plugin is installed, you can use its executors in your project's configuration.
+
+### verify-build executor
+
+This executor provides functionality to verify the build of a project after NX upgrade by comparing dist file statistics and detecting any significant differences.
 
 On each run, the executor builds the project for each configuration from the build target. At the first run, the executor generates stats in the `.stats` directory of the project from the built files.
 
@@ -10,27 +26,56 @@ The stats can be committed to the repository for future use.
 
 If the percentage differences cross a threshold of 10%, the executor will report a failure.
 
-Please note that the plugin is in the early development stage and configuration options will be added in future updates.
+#### Example configuration
 
-## Installation
+```json
+{
+	"name": "my-app",
+	...
+	"targets": {
+		"verify-build": {
+			"executor": "@ziacik/upgrade-verify:verify-build",
+			"options": {
+				"removeHashes": true
+			}
+		},
+		...
+	},
+	...
+}
+```
 
-To install the plugin, run the following command:
+Then to use the executor, run
 
 ```bash
-npm install -D @ziacik/upgrade-verify
+nx verify-build my-app
 ```
 
-## Usage
+### check-issues executor
+
+This executor serves as a watchdog for external issues tracked on github that are listed in workspace root's **ISSUES.md** file. This is useful when for example when a workaround has been introduced becaues of a bug, and we would like to remove that workaround when the issue is resolved.
+
+When this executor is run, it takes all issues listed in the **ISSUES.md** file, check if they are still active and lists all that have already been closed. That allows us to take action and remove that issue from the list.
 
-Once the plugin is installed, you can use it as a custom executor in your project's configuration. Here's an example configuration:
+#### Example contents of `ISSUES.md`
+
+```markdown
+# Issues to be watched
+
+https://github.com/ziacik/nx-tools/issues/1
+[https://github.com/ziacik/nx-tools/issues/2](https://github.com/ziacik/nx-tools/issues/2)
+[Some issue](https://github.com/ziacik/nx-tools/issues/3)
+```
+
+#### Example configuration
 
 ```json
 {
 	"name": "my-app",
 	...
 	"targets": {
-		"verify-build": {
-			"executor": "@ziacik/upgrade-verify:verify-build"
+		"check-issues": {
+			"executor": "@ziacik/upgrade-verify:check-issues"
 		},
 		...
 	},
@@ -38,10 +83,10 @@ Once the plugin is installed, you can use it as a custom executor in your projec
 }
 ```
 
-Then to use the plugin, run
+Then to use the executor, run
 
 ```bash
-nx verify-build my-app
+nx check-issues my-app
 ```
 
 ## License

package/executors.json

@@ -4,6 +4,11 @@
 			"implementation": "./src/executors/verify-build/executor",
 			"schema": "./src/executors/verify-build/schema.json",
 			"description": "Verifies that the build does not differ too much from the previous one after NX upgrade. Or, if this is the first run, creates stats for future verifications."
+		},
+		"check-issues": {
+			"implementation": "./src/executors/check-issues/executor",
+			"schema": "./src/executors/check-issues/schema.json",
+			"description": "Checks a list of issue links to see if they have been closed already."
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ziacik/upgrade-verify",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "type": "commonjs",
   "executors": "./executors.json",
   "keywords": [

package/src/executors/check-issues/executor.d.ts

@@ -0,0 +1,5 @@
+import { ExecutorContext } from '@nx/devkit';
+import { CheckIssuesExecutorSchema } from './schema';
+export default function runExecutor(options: CheckIssuesExecutorSchema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;

package/src/executors/check-issues/executor.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return runExecutor;
+    }
+});
+const _devkit = require("@nx/devkit");
+const _promises = require("fs/promises");
+const _path = require("path");
+const GITHUB_ISSUE_REGEX = RegExp("https:\\/\\/github.com\\/(?<owner>[^/]+)\\/(?<repo>[^/]+)\\/issues\\/(?<issueNumber>\\d+)");
+async function runExecutor(options, context) {
+    const issuesMd = await tryLoadIssuesMd(context.root);
+    if (issuesMd != null) {
+        const issueMdLines = issuesMd.split('\n');
+        await printClosedIssueLines(issueMdLines);
+    } else {
+        _devkit.logger.info("There is no 'ISSUES.md' file in the workspace root.");
+    }
+    return {
+        success: true
+    };
+}
+async function printClosedIssueLines(issueMdLines) {
+    const resolvedLines = await Promise.all(issueMdLines.map(resolveIssueMdLine));
+    const closedLines = resolvedLines.filter((resolvedLine)=>resolvedLine.result === 'closed');
+    if (closedLines.length > 0) {
+        _devkit.logger.info('Issues which are closed now:');
+        for (const closedLine of closedLines){
+            _devkit.logger.info(`- ${closedLine.issueMdLine}`);
+        }
+    } else {
+        _devkit.logger.info('No issues have been closed.');
+    }
+}
+async function resolveIssueMdLine(issueMdLine) {
+    const githubLink = issueMdLine.match(GITHUB_ISSUE_REGEX);
+    if (!githubLink) {
+        return {
+            issueMdLine,
+            result: 'noissue'
+        };
+    }
+    const [, owner, repo, issueNumber] = githubLink;
+    const response = await fetch(`https://api.github.com/repos/${owner}/${repo}/issues/${issueNumber}`);
+    const { state } = await response.json();
+    return {
+        issueMdLine,
+        result: state === 'closed' ? 'closed' : 'active'
+    };
+}
+async function tryLoadIssuesMd(root) {
+    try {
+        return await (0, _promises.readFile)((0, _path.join)(root, 'ISSUES.md'), 'utf8');
+    } catch (e) {
+        if (isNodeError(e) && e.code === 'ENOENT') {
+            return undefined;
+        } else {
+            throw e;
+        }
+    }
+}
+function isNodeError(error) {
+    return error instanceof Error && 'code' in error;
+}
+
+//# sourceMappingURL=executor.js.map

package/src/executors/check-issues/executor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/check-issues/executor.ts"],"sourcesContent":["import { ExecutorContext, logger } from '@nx/devkit';\nimport { readFile } from 'fs/promises';\nimport { join } from 'path';\nimport { CheckIssuesExecutorSchema } from './schema';\n\nconst GITHUB_ISSUE_REGEX = /https:\\/\\/github.com\\/(?<owner>[^/]+)\\/(?<repo>[^/]+)\\/issues\\/(?<issueNumber>\\d+)/;\n\nexport default async function runExecutor(options: CheckIssuesExecutorSchema, context: ExecutorContext) {\n\tconst issuesMd = await tryLoadIssuesMd(context.root);\n\n\tif (issuesMd != null) {\n\t\tconst issueMdLines = issuesMd.split('\\n');\n\t\tawait printClosedIssueLines(issueMdLines);\n\t} else {\n\t\tlogger.info(\"There is no 'ISSUES.md' file in the workspace root.\");\n\t}\n\n\treturn {\n\t\tsuccess: true,\n\t};\n}\n\nasync function printClosedIssueLines(issueMdLines: string[]) {\n\tconst resolvedLines = await Promise.all(issueMdLines.map(resolveIssueMdLine));\n\tconst closedLines = resolvedLines.filter((resolvedLine) => resolvedLine.result === 'closed');\n\n\tif (closedLines.length > 0) {\n\t\tlogger.info('Issues which are closed now:');\n\n\t\tfor (const closedLine of closedLines) {\n\t\t\tlogger.info(`- ${closedLine.issueMdLine}`);\n\t\t}\n\t} else {\n\t\tlogger.info('No issues have been closed.');\n\t}\n}\n\nasync function resolveIssueMdLine(issueMdLine: string): Promise<{ issueMdLine: string; result: 'noissue' | 'active' | 'closed' }> {\n\tconst githubLink = issueMdLine.match(GITHUB_ISSUE_REGEX);\n\n\tif (!githubLink) {\n\t\treturn { issueMdLine, result: 'noissue' };\n\t}\n\n\tconst [, owner, repo, issueNumber] = githubLink;\n\n\tconst response = await fetch(`https://api.github.com/repos/${owner}/${repo}/issues/${issueNumber}`);\n\tconst { state } = await response.json();\n\n\treturn {\n\t\tissueMdLine,\n\t\tresult: state === 'closed' ? 'closed' : 'active',\n\t};\n}\n\nasync function tryLoadIssuesMd(root: string): Promise<string | undefined> {\n\ttry {\n\t\treturn await readFile(join(root, 'ISSUES.md'), 'utf8');\n\t} catch (e) {\n\t\tif (isNodeError(e) && e.code === 'ENOENT') {\n\t\t\treturn undefined;\n\t\t} else {\n\t\t\tthrow e;\n\t\t}\n\t}\n}\n\nfunction isNodeError(error: unknown): error is NodeJS.ErrnoException {\n\treturn error instanceof Error && 'code' in error;\n}\n"],"names":["runExecutor","GITHUB_ISSUE_REGEX","options","context","issuesMd","tryLoadIssuesMd","root","issueMdLines","split","printClosedIssueLines","logger","info","success","resolvedLines","Promise","all","map","resolveIssueMdLine","closedLines","filter","resolvedLine","result","length","closedLine","issueMdLine","githubLink","match","owner","repo","issueNumber","response","fetch","state","json","readFile","join","e","isNodeError","code","undefined","error","Error"],"mappings":";+BAOA;;;eAA8BA;;;wBAPU;0BACf;sBACJ;AAGrB,MAAMC,qBAAqB;AAEZ,eAAeD,YAAYE,OAAkC,EAAEC,OAAwB;IACrG,MAAMC,WAAW,MAAMC,gBAAgBF,QAAQG,IAAI;IAEnD,IAAIF,YAAY,MAAM;QACrB,MAAMG,eAAeH,SAASI,KAAK,CAAC;QACpC,MAAMC,sBAAsBF;IAC7B,OAAO;QACNG,cAAM,CAACC,IAAI,CAAC;IACb;IAEA,OAAO;QACNC,SAAS;IACV;AACD;AAEA,eAAeH,sBAAsBF,YAAsB;IAC1D,MAAMM,gBAAgB,MAAMC,QAAQC,GAAG,CAACR,aAAaS,GAAG,CAACC;IACzD,MAAMC,cAAcL,cAAcM,MAAM,CAAC,CAACC,eAAiBA,aAAaC,MAAM,KAAK;IAEnF,IAAIH,YAAYI,MAAM,GAAG,GAAG;QAC3BZ,cAAM,CAACC,IAAI,CAAC;QAEZ,KAAK,MAAMY,cAAcL,YAAa;YACrCR,cAAM,CAACC,IAAI,CAAC,CAAC,EAAE,EAAEY,WAAWC,WAAW,CAAC,CAAC;QAC1C;IACD,OAAO;QACNd,cAAM,CAACC,IAAI,CAAC;IACb;AACD;AAEA,eAAeM,mBAAmBO,WAAmB;IACpD,MAAMC,aAAaD,YAAYE,KAAK,CAACzB;IAErC,IAAI,CAACwB,YAAY;QAChB,OAAO;YAAED;YAAaH,QAAQ;QAAU;IACzC;IAEA,MAAM,GAAGM,OAAOC,MAAMC,YAAY,GAAGJ;IAErC,MAAMK,WAAW,MAAMC,MAAM,CAAC,6BAA6B,EAAEJ,MAAM,CAAC,EAAEC,KAAK,QAAQ,EAAEC,YAAY,CAAC;IAClG,MAAM,EAAEG,KAAK,EAAE,GAAG,MAAMF,SAASG,IAAI;IAErC,OAAO;QACNT;QACAH,QAAQW,UAAU,WAAW,WAAW;IACzC;AACD;AAEA,eAAe3B,gBAAgBC,IAAY;IAC1C,IAAI;QACH,OAAO,MAAM4B,IAAAA,kBAAQ,EAACC,IAAAA,UAAI,EAAC7B,MAAM,cAAc;IAChD,EAAE,OAAO8B,GAAG;QACX,IAAIC,YAAYD,MAAMA,EAAEE,IAAI,KAAK,UAAU;YAC1C,OAAOC;QACR,OAAO;YACN,MAAMH;QACP;IACD;AACD;AAEA,SAASC,YAAYG,KAAc;IAClC,OAAOA,iBAAiBC,SAAS,UAAUD;AAC5C"}

package/src/executors/check-issues/schema.d.js

@@ -0,0 +1,4 @@
+"use strict";
+ // eslint-disable-line
+
+//# sourceMappingURL=schema.d.js.map

package/src/executors/check-issues/schema.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/check-issues/schema.d.ts"],"sourcesContent":["export interface CheckIssuesExecutorSchema {} // eslint-disable-line\n"],"names":[],"mappings":";CAA8C,sBAAsB"}

package/src/executors/check-issues/schema.d.ts

@@ -0,0 +1 @@
+export interface CheckIssuesExecutorSchema {} // eslint-disable-line

package/src/executors/check-issues/schema.json

@@ -0,0 +1,9 @@
+{
+	"$schema": "http://json-schema.org/schema",
+	"version": 2,
+	"title": "CheckIssues executor",
+	"description": "",
+	"type": "object",
+	"properties": {},
+	"required": []
+}

package/src/executors/verify-build/__fixtures__/expected-stats-nohash.json

@@ -0,0 +1,15 @@
+{
+	"name": "",
+	"size": 42926,
+	"items": [
+		{ "name": "3rdpartylicenses.txt", "size": 19, "items": [] },
+		{ "name": "assets", "size": 0, "items": [{ "name": ".gitkeep", "size": 0, "items": [] }] },
+		{ "name": "favicon.ico", "size": 15086, "items": [] },
+		{ "name": "index.html", "size": 608, "items": [] },
+		{ "name": "main.css", "size": 6168, "items": [] },
+		{ "name": "main.js", "size": 18760, "items": [] },
+		{ "name": "runtime.js", "size": 2109, "items": [] },
+		{ "name": "styles.js", "size": 176, "items": [] },
+		{ "name": "styles.css", "size": 0, "items": [] }
+	]
+}

package/src/executors/verify-build/dist-stats.d.ts

@@ -4,4 +4,4 @@ export type Stat = {
     readonly items: Stat[];
 };
 export declare function loadExistingDistStats(statsPath: string): Promise<Stat | undefined>;
-export declare function calculateDistStats(distDir: string): Promise<Stat>;
+export declare function calculateDistStats(distDir: string, removeHashes: boolean): Promise<Stat>;

package/src/executors/verify-build/dist-stats.js

@@ -23,24 +23,24 @@ async function loadExistingDistStats(statsPath) {
         return undefined;
     }
 }
-async function calculateDistStats(distDir) {
-    return getFolderStats(distDir, '');
+async function calculateDistStats(distDir, removeHashes) {
+    return getFolderStats(distDir, '', removeHashes);
 }
-async function getFolderStats(root, relative) {
-    return calculateStats(root, relative);
+async function getFolderStats(root, relative, removeHashes) {
+    return calculateStats(root, relative, removeHashes);
 }
-async function calculateStats(root, relative) {
+async function calculateStats(root, relative, removeHashes) {
     const path = (0, _path.join)(root, relative);
     const stats = await (0, _promises.stat)(path);
     if (stats.isFile()) {
         return {
-            name: relative,
+            name: removeHashes ? withHashRemoved(relative) : relative,
             size: stats.size,
             items: []
         };
     } else if (stats.isDirectory()) {
         const nestedFiles = await (0, _promises.readdir)(path);
-        const nestedStats = await Promise.all(nestedFiles.map((nestedFile)=>calculateStats((0, _path.join)(root, relative), nestedFile)));
+        const nestedStats = await Promise.all(nestedFiles.map((nestedFile)=>calculateStats((0, _path.join)(root, relative), nestedFile, removeHashes)));
         return {
             name: relative,
             size: nestedStats.reduce((result, stat)=>result + stat.size, 0),
@@ -50,5 +50,9 @@ async function calculateStats(root, relative) {
         throw new Error('What: ' + path);
     }
 }
+const HASH_REGEX = /\.[a-f0-9]{16}\./g;
+function withHashRemoved(fileName) {
+    return fileName.replace(HASH_REGEX, '.');
+}
 
 //# sourceMappingURL=dist-stats.js.map

package/src/executors/verify-build/dist-stats.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/dist-stats.ts"],"sourcesContent":["import { readFile, readdir, stat } from 'fs/promises';\nimport { join } from 'path';\n\nexport type Stat = {\n\treadonly name: string;\n\treadonly size: number;\n\treadonly items: Stat[];\n};\n\nexport async function loadExistingDistStats(statsPath: string): Promise<Stat | undefined> {\n\ttry {\n\t\tconst statsStr = await readFile(statsPath, 'utf-8');\n\t\treturn JSON.parse(statsStr);\n\t} catch {\n\t\treturn undefined;\n\t}\n}\n\nexport async function calculateDistStats(distDir: string): Promise<Stat> {\n\treturn getFolderStats(distDir, '');\n}\n\nasync function getFolderStats(root: string, relative: string): Promise<Stat> {\n\treturn calculateStats(root, relative);\n}\n\nasync function calculateStats(root: string, relative: string): Promise<Stat> {\n\tconst path = join(root, relative);\n\tconst stats = await stat(path);\n\n\tif (stats.isFile()) {\n\t\treturn {\n\t\t\tname: relative,\n\t\t\tsize: stats.size,\n\t\t\titems: [],\n\t\t};\n\t} else if (stats.isDirectory()) {\n\t\tconst nestedFiles = await readdir(path);\n\t\tconst nestedStats = await Promise.all(nestedFiles.map((nestedFile) => calculateStats(join(root, relative), nestedFile)));\n\t\treturn {\n\t\t\tname: relative,\n\t\t\tsize: nestedStats.reduce((result, stat) => result + stat.size, 0),\n\t\t\titems: nestedStats,\n\t\t};\n\t} else {\n\t\tthrow new Error('What: ' + path);\n\t}\n}\n"],"names":["loadExistingDistStats","calculateDistStats","statsPath","statsStr","readFile","JSON","parse","undefined","distDir","getFolderStats","root","relative","calculateStats","path","join","stats","stat","isFile","name","size","items","isDirectory","nestedFiles","readdir","nestedStats","Promise","all","map","nestedFile","reduce","result","Error"],"mappings":";;;;;;;;IASsBA,qBAAqB;eAArBA;;IASAC,kBAAkB;eAAlBA;;;0BAlBkB;sBACnB;AAQd,eAAeD,sBAAsBE,SAAiB;IAC5D,IAAI;QACH,MAAMC,WAAW,MAAMC,IAAAA,kBAAQ,EAACF,WAAW;QAC3C,OAAOG,KAAKC,KAAK,CAACH;IACnB,EAAE,UAAM;QACP,OAAOI;IACR;AACD;AAEO,eAAeN,mBAAmBO,OAAe;IACvD,OAAOC,eAAeD,SAAS;AAChC;AAEA,eAAeC,eAAeC,IAAY,EAAEC,QAAgB;IAC3D,OAAOC,eAAeF,MAAMC;AAC7B;AAEA,eAAeC,eAAeF,IAAY,EAAEC,QAAgB;IAC3D,MAAME,OAAOC,IAAAA,UAAI,EAACJ,MAAMC;IACxB,MAAMI,QAAQ,MAAMC,IAAAA,cAAI,EAACH;IAEzB,IAAIE,MAAME,MAAM,IAAI;QACnB,OAAO;YACNC,MAAMP;YACNQ,MAAMJ,MAAMI,IAAI;YAChBC,OAAO,EAAE;QACV;IACD,OAAO,IAAIL,MAAMM,WAAW,IAAI;QAC/B,MAAMC,cAAc,MAAMC,IAAAA,iBAAO,EAACV;QAClC,MAAMW,cAAc,MAAMC,QAAQC,GAAG,CAACJ,YAAYK,GAAG,CAAC,CAACC,aAAehB,eAAeE,IAAAA,UAAI,EAACJ,MAAMC,WAAWiB;QAC3G,OAAO;YACNV,MAAMP;YACNQ,MAAMK,YAAYK,MAAM,CAAC,CAACC,QAAQd,OAASc,SAASd,KAAKG,IAAI,EAAE;YAC/DC,OAAOI;QACR;IACD,OAAO;QACN,MAAM,IAAIO,MAAM,WAAWlB;IAC5B;AACD"}
+{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/dist-stats.ts"],"sourcesContent":["import { readFile, readdir, stat } from 'fs/promises';\nimport { join } from 'path';\n\nexport type Stat = {\n\treadonly name: string;\n\treadonly size: number;\n\treadonly items: Stat[];\n};\n\nexport async function loadExistingDistStats(statsPath: string): Promise<Stat | undefined> {\n\ttry {\n\t\tconst statsStr = await readFile(statsPath, 'utf-8');\n\t\treturn JSON.parse(statsStr);\n\t} catch {\n\t\treturn undefined;\n\t}\n}\n\nexport async function calculateDistStats(distDir: string, removeHashes: boolean): Promise<Stat> {\n\treturn getFolderStats(distDir, '', removeHashes);\n}\n\nasync function getFolderStats(root: string, relative: string, removeHashes: boolean): Promise<Stat> {\n\treturn calculateStats(root, relative, removeHashes);\n}\n\nasync function calculateStats(root: string, relative: string, removeHashes: boolean): Promise<Stat> {\n\tconst path = join(root, relative);\n\tconst stats = await stat(path);\n\n\tif (stats.isFile()) {\n\t\treturn {\n\t\t\tname: removeHashes ? withHashRemoved(relative) : relative,\n\t\t\tsize: stats.size,\n\t\t\titems: [],\n\t\t};\n\t} else if (stats.isDirectory()) {\n\t\tconst nestedFiles = await readdir(path);\n\t\tconst nestedStats = await Promise.all(nestedFiles.map((nestedFile) => calculateStats(join(root, relative), nestedFile, removeHashes)));\n\t\treturn {\n\t\t\tname: relative,\n\t\t\tsize: nestedStats.reduce((result, stat) => result + stat.size, 0),\n\t\t\titems: nestedStats,\n\t\t};\n\t} else {\n\t\tthrow new Error('What: ' + path);\n\t}\n}\n\nconst HASH_REGEX = /\\.[a-f0-9]{16}\\./g;\n\nfunction withHashRemoved(fileName: string): string {\n\treturn fileName.replace(HASH_REGEX, '.');\n}\n"],"names":["loadExistingDistStats","calculateDistStats","statsPath","statsStr","readFile","JSON","parse","undefined","distDir","removeHashes","getFolderStats","root","relative","calculateStats","path","join","stats","stat","isFile","name","withHashRemoved","size","items","isDirectory","nestedFiles","readdir","nestedStats","Promise","all","map","nestedFile","reduce","result","Error","HASH_REGEX","fileName","replace"],"mappings":";;;;;;;;IASsBA,qBAAqB;eAArBA;;IASAC,kBAAkB;eAAlBA;;;0BAlBkB;sBACnB;AAQd,eAAeD,sBAAsBE,SAAiB;IAC5D,IAAI;QACH,MAAMC,WAAW,MAAMC,IAAAA,kBAAQ,EAACF,WAAW;QAC3C,OAAOG,KAAKC,KAAK,CAACH;IACnB,EAAE,UAAM;QACP,OAAOI;IACR;AACD;AAEO,eAAeN,mBAAmBO,OAAe,EAAEC,YAAqB;IAC9E,OAAOC,eAAeF,SAAS,IAAIC;AACpC;AAEA,eAAeC,eAAeC,IAAY,EAAEC,QAAgB,EAAEH,YAAqB;IAClF,OAAOI,eAAeF,MAAMC,UAAUH;AACvC;AAEA,eAAeI,eAAeF,IAAY,EAAEC,QAAgB,EAAEH,YAAqB;IAClF,MAAMK,OAAOC,IAAAA,UAAI,EAACJ,MAAMC;IACxB,MAAMI,QAAQ,MAAMC,IAAAA,cAAI,EAACH;IAEzB,IAAIE,MAAME,MAAM,IAAI;QACnB,OAAO;YACNC,MAAMV,eAAeW,gBAAgBR,YAAYA;YACjDS,MAAML,MAAMK,IAAI;YAChBC,OAAO,EAAE;QACV;IACD,OAAO,IAAIN,MAAMO,WAAW,IAAI;QAC/B,MAAMC,cAAc,MAAMC,IAAAA,iBAAO,EAACX;QAClC,MAAMY,cAAc,MAAMC,QAAQC,GAAG,CAACJ,YAAYK,GAAG,CAAC,CAACC,aAAejB,eAAeE,IAAAA,UAAI,EAACJ,MAAMC,WAAWkB,YAAYrB;QACvH,OAAO;YACNU,MAAMP;YACNS,MAAMK,YAAYK,MAAM,CAAC,CAACC,QAAQf,OAASe,SAASf,KAAKI,IAAI,EAAE;YAC/DC,OAAOI;QACR;IACD,OAAO;QACN,MAAM,IAAIO,MAAM,WAAWnB;IAC5B;AACD;AAEA,MAAMoB,aAAa;AAEnB,SAASd,gBAAgBe,QAAgB;IACxC,OAAOA,SAASC,OAAO,CAACF,YAAY;AACrC"}

package/src/executors/verify-build/executor.js

@@ -35,13 +35,13 @@ async function verifyBuild(options, context) {
         retainEnv(envBackup);
         const runContext = JSON.parse(JSON.stringify(context));
         var _runContext_projectName;
-        const result = await (0, _devkit.runExecutor)({
+        const results = await (0, _devkit.runExecutor)({
             project: (_runContext_projectName = runContext.projectName) != null ? _runContext_projectName : '',
             target: 'build',
             configuration: configurationName
         }, {}, runContext);
-        for await (const x of result){
-            if (!x.success) {
+        for await (const result of results){
+            if (!result.success) {
                 return {
                     success: false
                 };
@@ -49,7 +49,8 @@ async function verifyBuild(options, context) {
         }
         const statsPath = (0, _path.join)(statsDir, configurationName + '.json');
         const existingStats = await (0, _diststats.loadExistingDistStats)(statsPath);
-        const newStats = await (0, _diststats.calculateDistStats)(distDir);
+        var _options_removeHashes;
+        const newStats = await (0, _diststats.calculateDistStats)(distDir, (_options_removeHashes = options.removeHashes) != null ? _options_removeHashes : true);
         await (0, _promises.writeFile)(statsPath, JSON.stringify(newStats, null, '\t'));
         if (existingStats != null) {
             const comparison = (0, _diststatcomparer.compareStats)(existingStats, newStats);

package/src/executors/verify-build/executor.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/executor.ts"],"sourcesContent":["import { ExecutorContext, logger, runExecutor } from '@nx/devkit';\nimport { mkdir, writeFile } from 'fs/promises';\nimport { join } from 'path';\nimport { env } from 'process';\nimport { compareStats } from './dist-stat-comparer';\nimport { calculateDistStats, loadExistingDistStats } from './dist-stats';\nimport { VerifyBuildExecutorSchema } from './schema';\n\nexport default async function verifyBuild(options: VerifyBuildExecutorSchema, context: ExecutorContext) {\n\tif (context.workspace == null) {\n\t\tthrow new Error('Workspace context info not available.');\n\t}\n\n\tif (context.projectName == null) {\n\t\tthrow new Error('Project name not specified in context info.');\n\t}\n\n\tconst projectConfig = context.workspace.projects[context.projectName];\n\n\tif (projectConfig.targets == null) {\n\t\tthrow new Error('Target info not available for the project in context info.');\n\t}\n\n\tconst distDir = join(context.root, projectConfig.targets['build'].options.outputPath);\n\tconst statsDir = join(context.root, projectConfig.root, '.stats');\n\tawait tryMkdir(statsDir);\n\n\tif (projectConfig.targets['build'].configurations == null) {\n\t\tthrow new Error('Configurations info not available for the project, target \"build\", in context info.');\n\t}\n\n\tlet success = true;\n\tconst envBackup = { ...env };\n\n\tfor (const configurationName of Object.keys(projectConfig.targets['build'].configurations)) {\n\t\tretainEnv(envBackup);\n\t\tconst runContext: ExecutorContext = JSON.parse(JSON.stringify(context));\n\n\t\tconst result = await runExecutor(\n\t\t\t{\n\t\t\t\tproject: runContext.projectName ?? '',\n\t\t\t\ttarget: 'build',\n\t\t\t\tconfiguration: configurationName,\n\t\t\t},\n\t\t\t{},\n\t\t\trunContext\n\t\t);\n\n\t\tfor await (const x of result) {\n\t\t\tif (!x.success) {\n\t\t\t\treturn { success: false };\n\t\t\t}\n\t\t}\n\n\t\tconst statsPath = join(statsDir, configurationName + '.json');\n\t\tconst existingStats = await loadExistingDistStats(statsPath);\n\t\tconst newStats = await calculateDistStats(distDir);\n\n\t\tawait writeFile(statsPath, JSON.stringify(newStats, null, '\\t'));\n\n\t\tif (existingStats != null) {\n\t\t\tconst comparison = compareStats(existingStats, newStats);\n\t\t\tlogger.info(\n\t\t\t\t`Stats for ${runContext.projectName}/${configurationName}: ${comparison.totalSizeDifferencePercentage}% total size difference, ${comparison.fileCountDifferencePercentage}% file count difference, ${comparison.newFilesPercentage}% new files, ${comparison.deletedFilesPercentage}% deleted files`\n\t\t\t);\n\n\t\t\tif (\n\t\t\t\tMath.abs(comparison.deletedFilesPercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.fileCountDifferencePercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.newFilesPercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.totalSizeDifferencePercentage) > 10\n\t\t\t) {\n\t\t\t\tsuccess = false;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn { success };\n}\n\nasync function tryMkdir(statsDir: string) {\n\ttry {\n\t\tawait mkdir(statsDir);\n\t} catch {\n\t\t// ignore\n\t}\n}\n\nfunction retainEnv(envBackup: Record<string, unknown>): void {\n\tfor (const key of Object.keys(env)) {\n\t\tdelete env[key];\n\t}\n\tObject.assign(env, envBackup);\n}\n"],"names":["verifyBuild","options","context","workspace","Error","projectName","projectConfig","projects","targets","distDir","join","root","outputPath","statsDir","tryMkdir","configurations","success","envBackup","env","configurationName","Object","keys","retainEnv","runContext","JSON","parse","stringify","result","runExecutor","project","target","configuration","x","statsPath","existingStats","loadExistingDistStats","newStats","calculateDistStats","writeFile","comparison","compareStats","logger","info","totalSizeDifferencePercentage","fileCountDifferencePercentage","newFilesPercentage","deletedFilesPercentage","Math","abs","mkdir","key","assign"],"mappings":";+BAQA;;;eAA8BA;;;;wBARuB;0BACpB;sBACZ;yBACD;kCACS;2BAC6B;AAG3C,eAAeA,YAAYC,OAAkC,EAAEC,OAAwB;IACrG,IAAIA,QAAQC,SAAS,IAAI,MAAM;QAC9B,MAAM,IAAIC,MAAM;IACjB;IAEA,IAAIF,QAAQG,WAAW,IAAI,MAAM;QAChC,MAAM,IAAID,MAAM;IACjB;IAEA,MAAME,gBAAgBJ,QAAQC,SAAS,CAACI,QAAQ,CAACL,QAAQG,WAAW,CAAC;IAErE,IAAIC,cAAcE,OAAO,IAAI,MAAM;QAClC,MAAM,IAAIJ,MAAM;IACjB;IAEA,MAAMK,UAAUC,IAAAA,UAAI,EAACR,QAAQS,IAAI,EAAEL,cAAcE,OAAO,CAAC,QAAQ,CAACP,OAAO,CAACW,UAAU;IACpF,MAAMC,WAAWH,IAAAA,UAAI,EAACR,QAAQS,IAAI,EAAEL,cAAcK,IAAI,EAAE;IACxD,MAAMG,SAASD;IAEf,IAAIP,cAAcE,OAAO,CAAC,QAAQ,CAACO,cAAc,IAAI,MAAM;QAC1D,MAAM,IAAIX,MAAM;IACjB;IAEA,IAAIY,UAAU;IACd,MAAMC,YAAY,eAAKC,YAAG;IAE1B,KAAK,MAAMC,qBAAqBC,OAAOC,IAAI,CAACf,cAAcE,OAAO,CAAC,QAAQ,CAACO,cAAc,EAAG;QAC3FO,UAAUL;QACV,MAAMM,aAA8BC,KAAKC,KAAK,CAACD,KAAKE,SAAS,CAACxB;YAInDqB;QAFX,MAAMI,SAAS,MAAMC,IAAAA,mBAAW,EAC/B;YACCC,SAASN,CAAAA,0BAAAA,WAAWlB,WAAW,YAAtBkB,0BAA0B;YACnCO,QAAQ;YACRC,eAAeZ;QAChB,GACA,CAAC,GACDI;QAGD,WAAW,MAAMS,KAAKL,OAAQ;YAC7B,IAAI,CAACK,EAAEhB,OAAO,EAAE;gBACf,OAAO;oBAAEA,SAAS;gBAAM;YACzB;QACD;QAEA,MAAMiB,YAAYvB,IAAAA,UAAI,EAACG,UAAUM,oBAAoB;QACrD,MAAMe,gBAAgB,MAAMC,IAAAA,gCAAqB,EAACF;QAClD,MAAMG,WAAW,MAAMC,IAAAA,6BAAkB,EAAC5B;QAE1C,MAAM6B,IAAAA,mBAAS,EAACL,WAAWT,KAAKE,SAAS,CAACU,UAAU,MAAM;QAE1D,IAAIF,iBAAiB,MAAM;YAC1B,MAAMK,aAAaC,IAAAA,8BAAY,EAACN,eAAeE;YAC/CK,cAAM,CAACC,IAAI,CACV,CAAC,UAAU,EAAEnB,WAAWlB,WAAW,CAAC,CAAC,EAAEc,kBAAkB,EAAE,EAAEoB,WAAWI,6BAA6B,CAAC,yBAAyB,EAAEJ,WAAWK,6BAA6B,CAAC,yBAAyB,EAAEL,WAAWM,kBAAkB,CAAC,aAAa,EAAEN,WAAWO,sBAAsB,CAAC,eAAe,CAAC;YAGrS,IACCC,KAAKC,GAAG,CAACT,WAAWO,sBAAsB,IAAI,MAC9CC,KAAKC,GAAG,CAACT,WAAWK,6BAA6B,IAAI,MACrDG,KAAKC,GAAG,CAACT,WAAWM,kBAAkB,IAAI,MAC1CE,KAAKC,GAAG,CAACT,WAAWI,6BAA6B,IAAI,IACpD;gBACD3B,UAAU;YACX;QACD;IACD;IAEA,OAAO;QAAEA;IAAQ;AAClB;AAEA,eAAeF,SAASD,QAAgB;IACvC,IAAI;QACH,MAAMoC,IAAAA,eAAK,EAACpC;IACb,EAAE,UAAM;IACP,SAAS;IACV;AACD;AAEA,SAASS,UAAUL,SAAkC;IACpD,KAAK,MAAMiC,OAAO9B,OAAOC,IAAI,CAACH,YAAG,EAAG;QACnC,OAAOA,YAAG,CAACgC,IAAI;IAChB;IACA9B,OAAO+B,MAAM,CAACjC,YAAG,EAAED;AACpB"}
+{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/executor.ts"],"sourcesContent":["import { ExecutorContext, logger, runExecutor } from '@nx/devkit';\nimport { mkdir, writeFile } from 'fs/promises';\nimport { join } from 'path';\nimport { env } from 'process';\nimport { compareStats } from './dist-stat-comparer';\nimport { calculateDistStats, loadExistingDistStats } from './dist-stats';\nimport { VerifyBuildExecutorSchema } from './schema';\n\nexport default async function verifyBuild(options: VerifyBuildExecutorSchema, context: ExecutorContext) {\n\tif (context.workspace == null) {\n\t\tthrow new Error('Workspace context info not available.');\n\t}\n\n\tif (context.projectName == null) {\n\t\tthrow new Error('Project name not specified in context info.');\n\t}\n\n\tconst projectConfig = context.workspace.projects[context.projectName];\n\n\tif (projectConfig.targets == null) {\n\t\tthrow new Error('Target info not available for the project in context info.');\n\t}\n\n\tconst distDir = join(context.root, projectConfig.targets['build'].options.outputPath);\n\tconst statsDir = join(context.root, projectConfig.root, '.stats');\n\tawait tryMkdir(statsDir);\n\n\tif (projectConfig.targets['build'].configurations == null) {\n\t\tthrow new Error('Configurations info not available for the project, target \"build\", in context info.');\n\t}\n\n\tlet success = true;\n\tconst envBackup = { ...env };\n\n\tfor (const configurationName of Object.keys(projectConfig.targets['build'].configurations)) {\n\t\tretainEnv(envBackup);\n\t\tconst runContext: ExecutorContext = JSON.parse(JSON.stringify(context));\n\n\t\tconst results = await runExecutor(\n\t\t\t{\n\t\t\t\tproject: runContext.projectName ?? '',\n\t\t\t\ttarget: 'build',\n\t\t\t\tconfiguration: configurationName,\n\t\t\t},\n\t\t\t{},\n\t\t\trunContext\n\t\t);\n\n\t\tfor await (const result of results) {\n\t\t\tif (!result.success) {\n\t\t\t\treturn { success: false };\n\t\t\t}\n\t\t}\n\n\t\tconst statsPath = join(statsDir, configurationName + '.json');\n\t\tconst existingStats = await loadExistingDistStats(statsPath);\n\t\tconst newStats = await calculateDistStats(distDir, options.removeHashes ?? true);\n\n\t\tawait writeFile(statsPath, JSON.stringify(newStats, null, '\\t'));\n\n\t\tif (existingStats != null) {\n\t\t\tconst comparison = compareStats(existingStats, newStats);\n\t\t\tlogger.info(\n\t\t\t\t`Stats for ${runContext.projectName}/${configurationName}: ${comparison.totalSizeDifferencePercentage}% total size difference, ${comparison.fileCountDifferencePercentage}% file count difference, ${comparison.newFilesPercentage}% new files, ${comparison.deletedFilesPercentage}% deleted files`\n\t\t\t);\n\n\t\t\tif (\n\t\t\t\tMath.abs(comparison.deletedFilesPercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.fileCountDifferencePercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.newFilesPercentage) > 10 ||\n\t\t\t\tMath.abs(comparison.totalSizeDifferencePercentage) > 10\n\t\t\t) {\n\t\t\t\tsuccess = false;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn { success };\n}\n\nasync function tryMkdir(statsDir: string) {\n\ttry {\n\t\tawait mkdir(statsDir);\n\t} catch {\n\t\t// ignore\n\t}\n}\n\nfunction retainEnv(envBackup: Record<string, unknown>): void {\n\tfor (const key of Object.keys(env)) {\n\t\tdelete env[key];\n\t}\n\tObject.assign(env, envBackup);\n}\n"],"names":["verifyBuild","options","context","workspace","Error","projectName","projectConfig","projects","targets","distDir","join","root","outputPath","statsDir","tryMkdir","configurations","success","envBackup","env","configurationName","Object","keys","retainEnv","runContext","JSON","parse","stringify","results","runExecutor","project","target","configuration","result","statsPath","existingStats","loadExistingDistStats","newStats","calculateDistStats","removeHashes","writeFile","comparison","compareStats","logger","info","totalSizeDifferencePercentage","fileCountDifferencePercentage","newFilesPercentage","deletedFilesPercentage","Math","abs","mkdir","key","assign"],"mappings":";+BAQA;;;eAA8BA;;;;wBARuB;0BACpB;sBACZ;yBACD;kCACS;2BAC6B;AAG3C,eAAeA,YAAYC,OAAkC,EAAEC,OAAwB;IACrG,IAAIA,QAAQC,SAAS,IAAI,MAAM;QAC9B,MAAM,IAAIC,MAAM;IACjB;IAEA,IAAIF,QAAQG,WAAW,IAAI,MAAM;QAChC,MAAM,IAAID,MAAM;IACjB;IAEA,MAAME,gBAAgBJ,QAAQC,SAAS,CAACI,QAAQ,CAACL,QAAQG,WAAW,CAAC;IAErE,IAAIC,cAAcE,OAAO,IAAI,MAAM;QAClC,MAAM,IAAIJ,MAAM;IACjB;IAEA,MAAMK,UAAUC,IAAAA,UAAI,EAACR,QAAQS,IAAI,EAAEL,cAAcE,OAAO,CAAC,QAAQ,CAACP,OAAO,CAACW,UAAU;IACpF,MAAMC,WAAWH,IAAAA,UAAI,EAACR,QAAQS,IAAI,EAAEL,cAAcK,IAAI,EAAE;IACxD,MAAMG,SAASD;IAEf,IAAIP,cAAcE,OAAO,CAAC,QAAQ,CAACO,cAAc,IAAI,MAAM;QAC1D,MAAM,IAAIX,MAAM;IACjB;IAEA,IAAIY,UAAU;IACd,MAAMC,YAAY,eAAKC,YAAG;IAE1B,KAAK,MAAMC,qBAAqBC,OAAOC,IAAI,CAACf,cAAcE,OAAO,CAAC,QAAQ,CAACO,cAAc,EAAG;QAC3FO,UAAUL;QACV,MAAMM,aAA8BC,KAAKC,KAAK,CAACD,KAAKE,SAAS,CAACxB;YAInDqB;QAFX,MAAMI,UAAU,MAAMC,IAAAA,mBAAW,EAChC;YACCC,SAASN,CAAAA,0BAAAA,WAAWlB,WAAW,YAAtBkB,0BAA0B;YACnCO,QAAQ;YACRC,eAAeZ;QAChB,GACA,CAAC,GACDI;QAGD,WAAW,MAAMS,UAAUL,QAAS;YACnC,IAAI,CAACK,OAAOhB,OAAO,EAAE;gBACpB,OAAO;oBAAEA,SAAS;gBAAM;YACzB;QACD;QAEA,MAAMiB,YAAYvB,IAAAA,UAAI,EAACG,UAAUM,oBAAoB;QACrD,MAAMe,gBAAgB,MAAMC,IAAAA,gCAAqB,EAACF;YACChC;QAAnD,MAAMmC,WAAW,MAAMC,IAAAA,6BAAkB,EAAC5B,SAASR,CAAAA,wBAAAA,QAAQqC,YAAY,YAApBrC,wBAAwB;QAE3E,MAAMsC,IAAAA,mBAAS,EAACN,WAAWT,KAAKE,SAAS,CAACU,UAAU,MAAM;QAE1D,IAAIF,iBAAiB,MAAM;YAC1B,MAAMM,aAAaC,IAAAA,8BAAY,EAACP,eAAeE;YAC/CM,cAAM,CAACC,IAAI,CACV,CAAC,UAAU,EAAEpB,WAAWlB,WAAW,CAAC,CAAC,EAAEc,kBAAkB,EAAE,EAAEqB,WAAWI,6BAA6B,CAAC,yBAAyB,EAAEJ,WAAWK,6BAA6B,CAAC,yBAAyB,EAAEL,WAAWM,kBAAkB,CAAC,aAAa,EAAEN,WAAWO,sBAAsB,CAAC,eAAe,CAAC;YAGrS,IACCC,KAAKC,GAAG,CAACT,WAAWO,sBAAsB,IAAI,MAC9CC,KAAKC,GAAG,CAACT,WAAWK,6BAA6B,IAAI,MACrDG,KAAKC,GAAG,CAACT,WAAWM,kBAAkB,IAAI,MAC1CE,KAAKC,GAAG,CAACT,WAAWI,6BAA6B,IAAI,IACpD;gBACD5B,UAAU;YACX;QACD;IACD;IAEA,OAAO;QAAEA;IAAQ;AAClB;AAEA,eAAeF,SAASD,QAAgB;IACvC,IAAI;QACH,MAAMqC,IAAAA,eAAK,EAACrC;IACb,EAAE,UAAM;IACP,SAAS;IACV;AACD;AAEA,SAASS,UAAUL,SAAkC;IACpD,KAAK,MAAMkC,OAAO/B,OAAOC,IAAI,CAACH,YAAG,EAAG;QACnC,OAAOA,YAAG,CAACiC,IAAI;IAChB;IACA/B,OAAOgC,MAAM,CAAClC,YAAG,EAAED;AACpB"}

package/src/executors/verify-build/schema.d.js

@@ -1,4 +1,3 @@
 "use strict";
- // eslint-disable-line
 
 //# sourceMappingURL=schema.d.js.map

package/src/executors/verify-build/schema.d.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/schema.d.ts"],"sourcesContent":["export interface VerifyBuildExecutorSchema {} // eslint-disable-line\n"],"names":[],"mappings":";CAA8C,sBAAsB"}
+{"version":3,"sources":["../../../../../../packages/upgrade-verify/src/executors/verify-build/schema.d.ts"],"names":[],"mappings":""}

package/src/executors/verify-build/schema.d.ts

@@ -1 +1,3 @@
-export interface VerifyBuildExecutorSchema {} // eslint-disable-line
+export interface VerifyBuildExecutorSchema {
+	removeHashes?: boolean;
+}

package/src/executors/verify-build/schema.json

@@ -4,6 +4,12 @@
 	"title": "VerifyBuild executor",
 	"description": "",
 	"type": "object",
-	"properties": {},
+	"properties": {
+		"removeHashes": {
+			"type": "boolean",
+			"description": "If true, remove hashes from file names. The hash part is detected by heuristics.",
+			"default": true
+		}
+	},
 	"required": []
 }