@eui/tools 6.12.0 → 6.12.2

package/.version.properties

@@ -1 +1 @@
-6.12.0
+6.12.2

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 6.12.2 (2023-06-13)
+
+##### Chores
+
+* **other:**
+  * adjusted styles report - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([29457541](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/2945754155ec262c76c8443cee0885b205301fe4))
+
+* * *
+* * *
+## 6.12.1 (2023-06-13)
+
+##### Chores
+
+* **other:**
+  * adapted styles audit report - metadata storage - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([6e03d9e6](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/6e03d9e68757f5d79be048332c3dc4bbc81577e3))
+
+* * *
+* * *
 ## 6.12.0 (2023-06-13)
 
 ##### New Features

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eui/tools",
-    "version": "6.12.0",
+    "version": "6.12.2",
     "tag": "latest",
     "license": "EUPL-1.1",
     "description": "eUI common tools and scripts",

package/sandbox.js

@@ -1251,15 +1251,22 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 
 Promise.resolve()
   .then(() => {
+    // old package without gates forced
     const pkg = configUtils.packages.getPackage('folio-fo-ui', true);
     console.log(metadataUtils.package.isNewPackageBuild(pkg));
-    const pkg2 = configUtils.packages.getPackage('cc-summa-shared-ui', true);
+
+    // existing pkg but forced to all gates
+    const pkg2 = configUtils.packages.getPackage('mapar-administration-ui', true);
     console.log(metadataUtils.package.isNewPackageBuild(pkg2));
 
-    return auditUtils.styles.audit(pkg);
+    // newly created pkg
+    const pkg3 = configUtils.packages.getPackage('coli-management-ui', true);
+    console.log(metadataUtils.package.isNewPackageBuild(pkg3));
+
+    return auditUtils.styles.audit(pkg2);
   })
-  .then(() => {
-    console.log('ok');
+  .then((report) => {
+    console.log(report);
   })
 
   .catch((e) => {

package/scripts/csdr/audit/styles.js

@@ -104,6 +104,10 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
       count: 0,
       indices: []
     },
+    zIndex: {
+      count: 0,
+      indices: []
+    },
     inlineStyles: {
       count: 0,
       indices: []
@@ -116,6 +120,10 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
       count: 0,
       indices: []
     },
+    allModules: {
+      count: 0,
+      indices: []
+    },
     uxCmp: {
       count: 0,
       // indices: []
@@ -205,6 +213,14 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
    }
    report.ngDeep.count += ngDeepIndices.length;
    report.ngDeep.indices = [...report.ngDeep.indices, ...generateIndicesContent(ngDeepIndices, file, fileContent)];
+
+   let zIndexIndices = [];
+   regex = /z-index/gi;
+   while ( (result = regex.exec(fileContent)) ) {
+    zIndexIndices.push(result.index);
+   }
+   report.zIndex.count += zIndexIndices.length;
+   report.zIndex.indices = [...report.zIndex.indices, ...generateIndicesContent(zIndexIndices, file, fileContent)];
  });
 
 
@@ -267,7 +283,20 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
    }
    report.material.count += materialIndices.length;
    report.material.indices = [...report.material.indices, ...generateIndicesContent(materialIndices, file, fileContent)];
- })
+
+   let allModulesIndices = [];
+   regex = /EuiAllModule/gi;
+   while ( (result = regex.exec(fileContent)) ) {
+    allModulesIndices.push(result.index);
+   }
+   regex = /UxAllModule/gi;
+   while ( (result = regex.exec(fileContent)) ) {
+    allModulesIndices.push(result.index);
+   }
+   report.allModules.count += allModulesIndices.length;
+   report.allModules.indices = [...report.allModules.indices, ...generateIndicesContent(allModulesIndices, file, fileContent)];
+
+})
 
 
 
@@ -358,6 +387,12 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
     status: getStatus(report.ngDeep.count),
     comment: (report.ngDeep.count !== 0) ? 'Avoid ::ng-deep usage' : null
   }
+  report.finalReport['zIndex'] = {
+    description: 'z-index usage found',
+    value: report.zIndex.count,
+    status: getStatus(report.zIndex.count),
+    comment: (report.zIndex.count !== 0) ? 'Avoid z-index setting, usage of eUI CSS vars should be applied' : null
+  }
  }
 
  // CRITICAL ONLY
@@ -381,6 +416,12 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
      status: (report.primeng.count !== 0) ? 'CRITICAL' : 'OK',
      comment: (report.primeng.count !== 0) ? 'Remove any PrimeNG usage, deprecated in eUI - this will be blocking as of eUI 16' : null
    }
+   report.finalReport['allModules'] = {
+     description: 'Usage of EuiAllModule or UxAllModule',
+     value: report.allModules.count,
+     status: (report.allModules.count !== 0) ? 'CRITICAL' : 'OK',
+     comment: (report.allModules.count !== 0) ? 'Use only tree-shakable eUI module imports (as of 15+)' : null
+   }
 
   // IMPROVE ONLY
 
@@ -445,6 +486,8 @@ module.exports.audit = (pkg) => {
     return;
   }
 
+  let outputReport;
+
   tools.logTitle('Audit package styles');
 
   const report = runStylesAudit(pkg);
@@ -453,6 +496,8 @@ module.exports.audit = (pkg) => {
     return;
   }
 
+  outputReport = report;
+
   return Promise.resolve()
    .then(() => {
     // FINAL REPORT
@@ -496,27 +541,40 @@ module.exports.audit = (pkg) => {
         return;
       }
 
-      // getting gates for euiVersion found
-      let gates = configOptions.AUDIT_STYLES_GATES[euiVersion];
+      tools.logTitle(`Checking audit styles gates`);
 
-      tools.logTitle(`Checking audit styles gates for local euiVersion : ${euiVersion}`);
+      // getting gates
+      let gates;
+      const euiVersionGates = configOptions.AUDIT_STYLES_GATES[euiVersion];
+      const allNewGates = configOptions.AUDIT_STYLES_GATES['ALL_NEW'];
 
-      // if no gates found for corresponding version, checking if new package for new builds
-      if (!gates) {
-        tools.logInfo('No gates found for local eUI version...');
+      tools.logInfo('Checking if the package as gates forced');
+      if (pkg.build && pkg.build.stylesAuditCheck) {
+        tools.logInfo('All gates checks applied');
+        gates = allNewGates;
 
+      } else {
+        tools.logInfo('===> no forced gates flag detected ...');
         tools.logInfo('Checking if package is newly created -- all versions gates are checked in that case');
 
         if (metadataUtils.package.isNewPackageBuild(pkg)) {
-          gates = configOptions.AUDIT_STYLES_GATES['ALL_NEW'];
+          gates = allNewGates;
+
         } else {
-          tools.logInfo('Package is not a newly created package...skipping gates checks...');
-          return;
+          if (euiVersionGates) {
+            tools.logInfo('eUI version gates found, applied to older packages where limited gates are set');
+            gates = euiVersionGates;
+
+          } else {
+            tools.logInfo('No gates found for local eUI version...');
+            return;
+          }
         }
       }
 
       tools.logInfo(`Gates found : ${JSON.stringify(gates)}`);
 
+
       // checking gates level if any
       let gatesPassed = true;
 
@@ -542,6 +600,28 @@ module.exports.audit = (pkg) => {
       }
   })
 
+  .then(() => {
+    // formatting report for metadata storage
+
+    const metadataReport = {
+      score: outputReport.score,
+      total: outputReport.total,
+      pcScore: outputReport.pcScore,
+    };
+
+    const summarizedFinalReport = {};
+    Object.keys(outputReport.finalReport).forEach((item) => {
+      summarizedFinalReport[item] = {
+        value: outputReport.finalReport[item].value,
+        status: outputReport.finalReport[item].status,
+      };
+    });
+
+    metadataReport.finalReport = summarizedFinalReport;
+
+    return metadataReport;
+  })
+
   .catch((e) => {
      throw e;
    })

package/scripts/csdr/config/global.js

@@ -391,8 +391,10 @@ module.exports.getConfigOptions = () => {
             "plainColors": gatesForVersion.plainColors,
             "important": gatesForVersion.important,
             "ngDeep": gatesForVersion.ngDeep,
+            "zIndex": gatesForVersion.zIndex,
             "inlineStyles": gatesForVersion.inlineStyles,
-            "uxCmp": gatesForVersion.uxCmp
+            "uxCmp": gatesForVersion.uxCmp,
+            "allModules": gatesForVersion.allModules,
           };
         })
       }

package/scripts/csdr/metadata/package-versions.js

@@ -37,7 +37,7 @@ module.exports.getMetadataSync = (pkg) => {
   return tools.getJsonFileContent(path.join(DEVOPS_METADATA_PATH, pkg.devopsVersionsMetadataFile));
 }
 
-module.exports.storeMetadata = (pkg, pkgVersion, pkgCompositeDeps, duration, envTarget, branches) => {
+module.exports.storeMetadata = (pkg, pkgVersion, pkgCompositeDeps, duration, envTarget, branches, auditStylesReport) => {
   return Promise.resolve()
     .then(() => {
       tools.logInfo('Storing package version history metadata...');
@@ -75,6 +75,12 @@ module.exports.storeMetadata = (pkg, pkgVersion, pkgCompositeDeps, duration, env
         hotfix: isHotfixVersion,
       };
 
+      if (auditStylesReport) {
+        if (!pkg.backend && !pkg.remote) {
+          newVersionMetadata.auditStylesReport = auditStylesReport;
+        }
+      }
+
       if (pkg.remote) {
         tools.logInfo('Writing remote composite dependencies');
         newVersionMetadata.dependencies = pkgCompositeDeps;

package/scripts/csdr/metadata/package.js

@@ -17,13 +17,13 @@ const innerPackageVersions = require('./package-versions');
 const { dryRun } = tools.getArgs();
 
 
-module.exports.storeMetadata = (pkg, pkgVersion, pkgMetadata, branches, pkgCompositeDeps, duration, envTarget) => {
+module.exports.storeMetadata = (pkg, pkgVersion, pkgMetadata, branches, pkgCompositeDeps, duration, envTarget, auditStylesReport) => {
 
   tools.logTitle('Storing central and package metadata...');
 
   return Promise.resolve()
     .then(() => {
-      return innerPackageVersions.storeMetadata(pkg, pkgVersion, pkgCompositeDeps, duration, envTarget, branches);
+      return innerPackageVersions.storeMetadata(pkg, pkgVersion, pkgCompositeDeps, duration, envTarget, branches, auditStylesReport);
     })
 
     .then(() => {
@@ -253,18 +253,26 @@ module.exports.getPackageVersionFirst = (pkg) => {
 }
 
 module.exports.isNewPackageBuild = (pkg) => {
-  tools.logInfo('Checking if package is a newly created one : first build date after 2023/06/01');
+  tools.logInfo('Checking if package is a newly created one : first build date after 2023/06/01 or never built for MASTER');
 
   const firstPackageVersion = this.getPackageVersionFirst(pkg);
+  const versionsLatest = this.getPackageVersionsLatest(pkg);
 
   if (firstPackageVersion) {
-    const pkgDate = firstPackageVersion.date;
 
-    const pivotDate = moment('20230601');
-    const pkgDateM = moment(pkgDate, 'YYYYMMDD-HH:mm');
-    tools.logInfo(`First package build version date : ${pkgDate}`);
-    tools.logInfo(`==> NEW package : ${pkgDateM > pivotDate}`);
-    return pkgDateM > pivotDate;
+    if (versionsLatest.length === 0) {
+      tools.logInfo(`==> package has never been built for MASTER / latest version, package is considered new`);
+      return true;
+
+    } else {
+      const pkgDate = firstPackageVersion.date;
+
+      const pivotDate = moment('20230601');
+      const pkgDateM = moment(pkgDate, 'YYYYMMDD-HH:mm');
+      tools.logInfo(`First package build version date : ${pkgDate}`);
+      tools.logInfo(`==> NEW package : ${pkgDateM > pivotDate}`);
+      return pkgDateM > pivotDate;
+    }
 
   } else {
     tools.logInfo(`==> no versions metadata found : first build, package is new`);

package/scripts/csdr/release/package/common.js

@@ -483,7 +483,7 @@ module.exports.runGitOperations = (pkg, version) => {
 
 
 
-module.exports.storeMetadata = (pkg, version, pkgMetadata, pkgCompositeDeps, duration, envTarget) => {
+module.exports.storeMetadata = (pkg, version, pkgMetadata, pkgCompositeDeps, duration, envTarget, auditStylesReport) => {
   utils.tools.logBanner('STORE METADATA');
 
   const branches = this.getBranches();
@@ -495,7 +495,8 @@ module.exports.storeMetadata = (pkg, version, pkgMetadata, pkgCompositeDeps, dur
       branches,
       pkgCompositeDeps,
       duration,
-      envTarget
+      envTarget,
+      auditStylesReport,
     );
   })
 

package/scripts/csdr/release/package/release-ui.js

@@ -40,7 +40,7 @@ module.exports.run = () => {
 
 
     // local saved vars
-    var newVersion, pkgMetadata, pkgCompositeDeps;
+    var newVersion, pkgMetadata, pkgCompositeDeps, auditStylesReport;
 
 
     return Promise.resolve()
@@ -119,6 +119,10 @@ module.exports.run = () => {
       .then(() => {
         return utils.buildPackage.build(pkg, branches.isMaster);
       })
+      .then((report) => {
+        // storing audit styles metadata for storage
+        auditStylesReport = report;
+      })
 
 
       // EXECUTING SONAR ANALYSIS
@@ -179,7 +183,7 @@ module.exports.run = () => {
       .then(() => {
         // get run duration
         const duration = utils.pipeline.getTimerDuration();
-        return innerCommon.storeMetadata(pkg, newVersion, pkgMetadata, pkgCompositeDeps, duration, envTarget);
+        return innerCommon.storeMetadata(pkg, newVersion, pkgMetadata, pkgCompositeDeps, duration, envTarget, auditStylesReport);
       })
 
       // STORING PACKAGE HISTORY

package/scripts/utils/build/package/angular.js

@@ -19,6 +19,8 @@ module.exports.build = (pkg, isMaster) => {
   // FETCH ARGS
   let { deps, skipClean, skipLint, skipTest, skipCompile, skipDoc, build, skipAudit } = pkg.build? {...pkg.build, ...tools.getArgs()} : tools.getArgs();
 
+  let auditStylesReport;
+
   return Promise.resolve()
     .then(() => {
       if (deps === true) {
@@ -92,7 +94,11 @@ module.exports.build = (pkg, isMaster) => {
         return auditUtils.styles.audit(pkg);
       }
     })
-    .then(() => {
+    .then((report) => {
+      if (report) {
+        auditStylesReport = report;
+      }
+
       if (!skipCompile) {
         tools.logInfo('Bundling package...');
         let args = ['--max_old_space_size=8096', ng, 'build', pkg.name];
@@ -218,6 +224,10 @@ module.exports.build = (pkg, isMaster) => {
       })
     })
 
+    .then(() => {
+      return auditStylesReport;
+    })
+
     .catch((e) => {
       throw e;
     });