@eui/tools 6.12.28 → 6.12.30

package/.version.properties

@@ -1 +1 @@
-6.12.28
+6.12.30

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.12.30 (2023-07-21)
+
+##### Chores
+
+* **other:**
+  * fix test failing  ([e0208503](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/e0208503a4b939eced6903ecf1ce3a1892d91ed9))
+  * refactor route replacements and cleanup - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([ce7cad37](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/ce7cad37193099685fc0c5ba0def280d9ac353e4))
+
+* * *
+* * *
+## 6.12.29 (2023-07-19)
+
+##### Bug Fixes
+
+* **other:**
+  * stats and lock custom install for v16 remotes - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([a4736428](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/a4736428e3c4d843c67a58608a3c4818e37a980d))
+
+* * *
+* * *
 ## 6.12.28 (2023-07-19)
 
 ##### Chores

package/package.json

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

package/scripts/app/public/index.html

@@ -44,7 +44,7 @@
                                 <label class="col-sm-2 col-form-label">eUI Version</label>
                                 <div class="col-sm-10">
                                     <select dis abled class="form-select" v-model="selectedEuiVersion">
-                                        <option value="15.x">eUI 15</option>
+                                        <option value="16.x">eUI 16</option>
                                     </select>
                                 </div>
                             </div>

package/scripts/app/public/index.js

@@ -13,7 +13,7 @@ new Vue({
     data() {
         return {
             selectedProject: "my-workplace-host-playground-custom",
-            selectedEuiVersion: "15.x",
+            selectedEuiVersion: "16.x",
             remotes: [],
             selectedRemotes: [],
             selectedInstalledRemotes: [],
@@ -29,7 +29,7 @@ new Vue({
     },
     methods: {
         async getRemotes() {
-            const res = await fetch("http://localhost:3000/api/remotes");
+            const res = await fetch("http://localhost:3000/api/remotesForConfig");
             const finalRes = await res.json();
             this.remotes = finalRes;
         },

package/scripts/app/routes/index.js

@@ -17,7 +17,38 @@ const handlerError = (res, e) => {
 router.get('/remotes', function (req, res) {
   return Promise.resolve()
     .then(() => {
-      return configUtils.remotes.getCsdrRemotesArray('my-workplace', '15.x');
+      return [
+      ...configUtils.remotes.getCsdrRemotesArray('my-workplace', '15.x'),
+      ...configUtils.remotes.getCsdrRemotesArray('my-workplace', '16.x'),
+      ];
+    })
+    .then((fetchedRemotes) => {
+      let remotes = tools.sortArray(fetchedRemotes, 'name');
+      remotes = remotes.filter((r) => {
+        let participant = false;
+        if (r.fullSkeletonSources) {
+          if (r.skeletonConfig.options && r.skeletonConfig.options.participant) {
+            participant = true;
+          }
+        }
+
+        if (r.fullSkeletonSources && !participant) {
+          return true;
+        }
+      })
+      res.send(remotes);
+    })
+    .catch((e) => {
+      handlerError(res, e);
+    })
+});
+
+router.get('/remotesForConfig', function (req, res) {
+  return Promise.resolve()
+    .then(() => {
+      return [
+      ...configUtils.remotes.getCsdrRemotesArray('my-workplace', '16.x'),
+      ];
     })
     .then((fetchedRemotes) => {
       let remotes = tools.sortArray(fetchedRemotes, 'name');

package/scripts/csdr/config/projects.js

@@ -41,6 +41,7 @@ const getProjectPaths = (prj) => {
   if (prj.build && prj.build.maven) {
     angularPath = path.join(rootPath, 'src/main/angular');
   }
+  const assetsPath = path.join(angularPath, 'src', 'assets');
   const elementsPath = path.join(angularPath, 'src', 'assets', 'elements');
 
   let installPath = process.cwd();
@@ -56,6 +57,7 @@ const getProjectPaths = (prj) => {
     elementsPath: elementsPath,
     installPath: installPath,
     nodeModulesPath: nodeModulesPath,
+    assetsPath: assetsPath,
   };
 
   // locate and find the TSLint or ESLint configuration files

package/scripts/csdr/metadata/stats.js

@@ -466,33 +466,39 @@ module.exports.getRemoteAllStats = () => {
       }
     })
     .then(() => {
-      let remotesArray = configUtils.remotes.getCsdrRemotesArray('my-workplace', '15.x');
+      let remotesArray = [
+        ...configUtils.remotes.getCsdrRemotesArray('my-workplace', '16.x'),
+        ...configUtils.remotes.getCsdrRemotesArray('my-workplace', '15.x'),
+      ];
+
       remotesArray = tools.sortArray(remotesArray, 'name');
 
       remotesArray.forEach((r) => {
-        const remote = configUtils.remotes.getRemote(r.name);
-        const versionsMatadata = metadataUtils.packageVersions.getMetadataSync(remote);
-        let versionsCount = 0, versionsCountEnvs = { "DEV": 0, "TST": 0, "INT": 0, "ACC": 0, "TRN": 0, "PROD": 0}, lastVersion = {};
-        if (versionsMatadata.versions) {
-          versionsCount = versionsMatadata.versions.length;
-          versionsCountEnvs['DEV'] = versionsMatadata.versions.filter(v => v.envTarget === 'DEV').length;
-          versionsCountEnvs['TST'] = versionsMatadata.versions.filter(v => v.envTarget === 'TST').length;
-          versionsCountEnvs['INT'] = versionsMatadata.versions.filter(v => v.envTarget === 'INT').length;
-          versionsCountEnvs['ACC'] = versionsMatadata.versions.filter(v => v.envTarget === 'ACC').length;
-          versionsCountEnvs['TRN'] = versionsMatadata.versions.filter(v => v.envTarget === 'TRN').length;
-          versionsCountEnvs['PROD'] = versionsMatadata.versions.filter(v => v.envTarget === 'PROD').length;
-          lastVersion = versionsMatadata.versions.slice(-1).pop();
-        }
-        const remoteStats = {
-          name: r.name,
-          // versions: versionsMatadata.versions,
-          lastVersion,
-          summary: {
-            versionsCount,
-            versionsCountEnvs
+        try {
+          const remote = configUtils.remotes.getRemote(r.name);
+          const versionsMatadata = metadataUtils.packageVersions.getMetadataSync(remote);
+          let versionsCount = 0, versionsCountEnvs = { "DEV": 0, "TST": 0, "INT": 0, "ACC": 0, "TRN": 0, "PROD": 0}, lastVersion = {};
+          if (versionsMatadata.versions) {
+            versionsCount = versionsMatadata.versions.length;
+            versionsCountEnvs['DEV'] = versionsMatadata.versions.filter(v => v.envTarget === 'DEV').length;
+            versionsCountEnvs['TST'] = versionsMatadata.versions.filter(v => v.envTarget === 'TST').length;
+            versionsCountEnvs['INT'] = versionsMatadata.versions.filter(v => v.envTarget === 'INT').length;
+            versionsCountEnvs['ACC'] = versionsMatadata.versions.filter(v => v.envTarget === 'ACC').length;
+            versionsCountEnvs['TRN'] = versionsMatadata.versions.filter(v => v.envTarget === 'TRN').length;
+            versionsCountEnvs['PROD'] = versionsMatadata.versions.filter(v => v.envTarget === 'PROD').length;
+            lastVersion = versionsMatadata.versions.slice(-1).pop();
           }
-        }
-        stats.push(remoteStats);
+          const remoteStats = {
+            name: r.name,
+            // versions: versionsMatadata.versions,
+            lastVersion,
+            summary: {
+              versionsCount,
+              versionsCountEnvs
+            }
+          }
+          stats.push(remoteStats);
+        } catch(e) {}
       })
     })
     .then(() => {

package/scripts/index.js

@@ -48,7 +48,10 @@ module.exports.prebuildInjectionUtils = require('./utils/pre-build/injection/inj
 module.exports.prebuildInjectionConfig = require('./utils/pre-build/injection/config');
 module.exports.prebuildInjectionSkeletons = require('./utils/pre-build/injection/skeletons');
 module.exports.prebuildInjectionExternals = require('./utils/pre-build/injection/externals');
-module.exports.prebuildInjectionRoutesReplacement = require('./utils/pre-build/injection/routes-replacement');
+
+// utils -pre-build - routes replacement
+module.exports.prebuildRoutesReplacement = require('./utils/pre-build/routes-replacement/routes-replacement');
+module.exports.prebuildRoutesReplacementSubs = require('./utils/pre-build/routes-replacement/routes-replacement-subs');
 
 // utils -pre-build - translations
 module.exports.prebuildTranslationUtils = require('./utils/pre-build/translations/translation-utils');

package/scripts/utils/pre-build/injection/injection-utils.js

@@ -4,5 +4,4 @@
 module.exports.config = require('./config');
 module.exports.skeletons = require('./skeletons');
 module.exports.externals = require('./externals');
-module.exports.routesReplacement = require('./routes-replacement');
 module.exports.openid = require('./openid');

package/scripts/utils/pre-build/projects.js

@@ -6,6 +6,7 @@ const tools = require('../tools');
 
 const injectionUtils = require('./injection/injection-utils');
 const translationUtils = require('./translations/translation-utils');
+const routesReplacement = require('./routes-replacement/routes-replacement');
 
 const configUtils = require('../../csdr/config/config-utils');
 const svgUtils = require('../svg-utils');
@@ -89,12 +90,13 @@ module.exports.preBuild = (project, envTarget, build, configEnvTarget) => {
     // replace app routes
     .then(() => {
       if (project.config && project.externalRoutesSources) {
-        return injectionUtils.routesReplacement.buildRoutes(project, envTarget, build);
+        return routesReplacement.buildRoutes(project, envTarget, build);
       }
     })
+    // generate remotes metadata during CI build of the host only (feeding the about page)
     .then(() => {
-      if (project.config && project.externalRoutesSources) {
-        return injectionUtils.routesReplacement.extractRemotesMetadata(project, configEnvTarget);
+      if (project.config && project.externalRoutesSources && build) {
+        return routesReplacement.extractRemotesMetadata(project, configEnvTarget);
       }
     })
 

package/scripts/utils/pre-build/routes-replacement/routes-replacement-subs.js

@@ -0,0 +1,143 @@
+'use strict';
+
+const path = require('path');
+
+const tools = require('../../tools');
+const configUtils = require('../../../csdr/config/config-utils');
+
+/**
+ * Get the env target, transform input envTarget to known files suffix or handle local / playground file
+ *
+ * @param {string} envTargetIn The build-time environment target provided to target specific routes for specific environment deployments
+ * @param {boolean} build if the script is launched from a release pipeline OR from local CSDR playground environment (false in that case) * @return routeContent the text block transformed from the route object as input
+ * @returns {string} the envTarget transformed
+ */
+module.exports.getEnvTarget = (envTargetIn, build) => {
+  if (!envTargetIn) {
+    // check if envTarget has been provided as cli args for stand-alone local build of CSDR apps
+    const { envTarget } = tools.getArgs();
+
+    if (!envTarget) {
+      throw 'ENV_TARGET_NOT_FOUND';
+    } else {
+      envTargetIn = envTarget;
+    }
+  }
+
+  let envTargetFinal = envTargetIn.toLowerCase();
+
+  if (build) {
+    // dirty fix as openid files do not respect envTarget names
+    if (envTargetFinal === 'tst') {
+      envTargetFinal = 'test';
+    }
+
+    // serve configuration based
+  } else {
+    if (envTargetIn.indexOf('local') > -1) {
+      envTargetFinal = envTargetIn.replace('-openid', '');
+    } else {
+      envTargetFinal = 'local-' + envTargetFinal;
+    }
+  }
+
+  return envTargetFinal;
+};
+
+
+
+
+/**
+ * Replace route object and transform into an Angular / eUI route definition
+ *
+ * @param {route} route route object containing the result of the route translated into route props
+ * @returns {string} routeContent the text block transformed from the route object as input
+ */
+
+
+/**
+ * Get routes file of project
+ *
+ * PRIVATE
+ *
+ * @param {project} project The CSDR project object fetched from csdr global projects config
+ * @param {string} euiVersion the eUI version of the current project used mainly in local CSDR playground environment (format : v.x)
+ * @returns {string} routeContent the text block transformed from the route object as input
+ */
+module.exports.getRoutesFile = (project, euiVersion) => {
+  tools.logInfo('Getting routes file for replacement');
+
+  if (!project.externalRoutesSources) {
+    tools.logError('project requires externalRoutesSources definition');
+    return;
+  }
+
+  let routesFilePath;
+  let srcRoutesFilePath;
+
+  if (
+    !project.externalRoutesSources.routesConfigNpmPkg ||
+    !project.externalRoutesSources.routesFileSource ||
+    !project.externalRoutesSources.routesFilePath
+  ) {
+    tools.logError('project requires externalRoutesSources.routesConfigNpmPkg, routesFileSources and routesFilePath definitions');
+    return;
+  }
+
+  // check if package is locally cloned
+  const localPackage = configUtils.packages.getPackages().filter((p) => {
+    return p.npmPkg === project.externalRoutesSources.routesConfigNpmPkg;
+  })[0];
+
+  // if local package is found
+  if (localPackage) {
+    tools.logInfo('local package found, copying from local');
+
+    tools.logInfo(`constructing route path with eUI version provided: ${euiVersion}`);
+
+    srcRoutesFilePath = path.join(
+      process.cwd(),
+      'packages',
+      localPackage.name,
+      'assets',
+      euiVersion,
+      project.externalRoutesSources.routesFileSource
+    );
+
+    // if not sources are taken from the npm package def in node_modules
+  } else {
+    tools.logInfo('remote package found, copying from remote');
+    const npmPkgScope = project.externalRoutesSources.routesConfigNpmPkg.substr(
+      0,
+      project.externalRoutesSources.routesConfigNpmPkg.indexOf('/')
+    );
+    const npmPkgName = project.externalRoutesSources.routesConfigNpmPkg.substr(
+      project.externalRoutesSources.routesConfigNpmPkg.indexOf('/') + 1
+    );
+
+    tools.logInfo(`constructing route path with eUI version provided: ${euiVersion}`);
+
+    srcRoutesFilePath = path.join(
+      process.cwd(),
+      'node_modules',
+      npmPkgScope,
+      npmPkgName,
+      'assets',
+      euiVersion,
+      project.externalRoutesSources.routesFileSource
+    );
+  }
+
+  routesFilePath = path.join(project.paths.rootPath, project.externalRoutesSources.routesFilePath);
+
+  // copy source file to project destination
+  tools.copy(srcRoutesFilePath, routesFilePath);
+
+  // checking is routes path declared
+  if (!tools.isFileExists(routesFilePath)) {
+    tools.logError(`Unable to find ${routesFilePath}`);
+    return;
+  }
+
+  return routesFilePath;
+};