@eui/tools 6.12.34 → 6.12.36

package/.version.properties

@@ -1 +1 @@
-6.12.34
+6.12.36

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 6.12.36 (2023-08-03)
+
+##### Bug Fixes
+
+* **other:**
+  * route replacement of custom installation - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([06f98a47](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/06f98a470edee4e2225e018f26cdcc5cf613c8e5))
+
+* * *
+* * *
+## 6.12.35 (2023-08-03)
+
+##### Chores
+
+* **other:**
+  * sandbox update  ([4bdda3b2](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/4bdda3b2fa84cc888a6f89a822b98b56b235078b))
+  * adapted init scripts for custom host installation - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([ae114c1a](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/ae114c1ad762ee0bcc9a91ef7bcd5784b93d96c9))
+  * adapted init vue app including branch seletion and retrieval from config - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([e9be35c6](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/e9be35c6331748021f812edf06c9a9d31533cd1a))
+  * custom routes for custom installation impl. - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([21738675](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/21738675a3e4f0a05b5f6a39f73d312070108597))
+
+* * *
+* * *
 ## 6.12.34 (2023-08-02)
 
 ##### Chores

package/package.json

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

package/sandbox.js

@@ -1273,31 +1273,48 @@ const publishUtils = require('./scripts/utils/publish/publish-utils');
 //     console.log(e);
 //   })
 
+// route replacement test
+
+
+// // BUILD PACKAGE FIRST !!
+
+// const pkg = configUtils.packages.getPackage('eui');
+// const pkgChild = configUtils.packages.getPackage('eui-base');
+// const version = '15.4.1';
+
+// Promise.resolve()
+//   .then(() => {
+//     return versionUtils.package.updateVersion(pkg,version);
+//   })
+//   .then(() => {
+//     return buildPackageUtils.postBuild(pkg);
+//   })
+//   .then(() => {
+//     // IF individual child packages have to be published individually
+
+//     // console.log(pkgChild);
+//     // const publishNpmCore = require('./scripts/utils/publish/npm');
+//     // return publishNpmCore.publishCore(pkgChild, 'https://registry.npmjs.org', true)
+//     return publishUtils.publish(pkg);
+//   })
+//   .then((report) => {
+//     console.log(report);
+//   })
+
+//   .catch((e) => {
+//     console.log(e);
+//   })
 
 
-// BUILD PACKAGE FIRST !!
 
-const pkg = configUtils.packages.getPackage('eui');
-const pkgChild = configUtils.packages.getPackage('eui-base');
-const version = '15.4.1';
 
 Promise.resolve()
   .then(() => {
-    return versionUtils.package.updateVersion(pkg,version);
-  })
-  .then(() => {
-    return buildPackageUtils.postBuild(pkg);
-  })
-  .then(() => {
-    // IF individual child packages have to be published individually
+    const prjName = 'my-workplace-host-playground-custom';
+    const project = configUtils.projects.getCsdrProject(prjName);
+    const envTarget = 'cdn-dev-local';
 
-    // console.log(pkgChild);
-    // const publishNpmCore = require('./scripts/utils/publish/npm');
-    // return publishNpmCore.publishCore(pkgChild, 'https://registry.npmjs.org', true)
-    return publishUtils.publish(pkg);
-  })
-  .then((report) => {
-    console.log(report);
+    return preBuildUtils.routesReplacement.buildRoutes(project, envTarget);
   })
 
   .catch((e) => {

package/scripts/app/public/index.html

@@ -130,7 +130,27 @@
                         Derived UI packages to be locally cloned :
                         <span class="text-primary fw-bold">{{ packages.length }}</span>
                     </h5>
-                    {{ packages }}
+                    <!-- {{ packages }} -->
+                    <table class="table table-striped" v-show="packages.length !== 0">
+                        <thead>
+                            <tr>
+                                <th scope="col">Pkg name</th>
+                                <th scope="col">Branch</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            <tr v-for="pkg in packages">
+                                <td>{{pkg.name}}</td>
+                                <td><input type="text" class="form-control" :id="pkg.name" v-model="pkg.branch"></td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    <!-- <div class="form-group row" v-for="pkg in packages">
+                        <label class="col-sm-2 col-form-label">{{ pkg.name }}</label>
+                        <div class="col-sm-10">
+                          <input type="email" class="form-control" id="{{pkg.name}}" :value="pkg.branch">
+                        </div>
+                    </div> -->
 
                     <hr />
 

package/scripts/app/public/index.js

@@ -21,6 +21,7 @@ new Vue({
             packages: [],
             saveConfigSubmitted: false,
             saveConfigOK: false,
+            configPackages: null
         };
     },
     created() {
@@ -44,15 +45,26 @@ new Vue({
                 this.selectedInstalledRemotes = finalRes.installedRemotes;
                 this.deps = finalRes.deps;
                 this.packages = finalRes.packages;
+                this.configPackages = finalRes.packages;
             }
         },
         async getPackages() {
             const res = await fetch("http://localhost:3000/api/remotes/packages", getRequestBody(this.selectedRemotes));
             const finalRes = await res.json();
+            this.deps = finalRes.deps;
+
             this.packages = finalRes.packages.filter(
-                (p) => p.indexOf("csdr-") < 0 && p.indexOf("cc-shared-ui") < 0 && p.indexOf("mywp-shared-ui") < 0
+                (p) => p.name.indexOf("csdr-") < 0 && p.name.indexOf("cc-shared-ui") < 0 && p.name.indexOf("mywp-shared-ui") < 0
             );
-            this.deps = finalRes.deps;
+            if (this.configPackages) {
+              this.packages = this.packages.map((p) => {
+                const configPkg = this.configPackages.find(cp => cp.name === p.name);
+                return {
+                  name: p.name,
+                  branch: configPkg.branch,
+                }
+              })
+            }
         },
         reset() {
             this.selectedRemotes = [];

package/scripts/csdr/config/global.js

@@ -85,6 +85,7 @@ const getGeneratedConfig = (euircBaseFile) => {
   // initializing projects and packages objects
   genConfig.projects = {};
   genConfig.packages = {};
+  genConfig.packagesBranches = [];
   genConfig.remotes = {};
 
   // remapping projects against csdr projects config
@@ -133,6 +134,9 @@ const getGeneratedConfig = (euircBaseFile) => {
     })
   }
 
+  // packages branches for custom initialization
+  genConfig.packagesBranches = configContent.packagesBranches;
+
   return genConfig;
 }
 
@@ -164,7 +168,7 @@ module.exports.getConfig = () => {
 
 
 
-module.exports.updateConfig = (args = { project, packages, remotes, reset}) => {
+module.exports.updateConfig = (args = { project, packages, packagesBranches, remotes, reset}) => {
   tools.logInfo('Updating euirc config');
   console.log(args);
 
@@ -181,6 +185,10 @@ module.exports.updateConfig = (args = { project, packages, remotes, reset}) => {
     if (args.packages) {
       newConfig.packages = args.packages;
     }
+    newConfig.packagesBranches = [];
+    if (args.packagesBranches) {
+      newConfig.packagesBranches = args.packagesBranches;
+    }
     newConfig.remotes = [];
     if (args.remotes) {
       newConfig.remotes = args.remotes;
@@ -198,6 +206,9 @@ module.exports.updateConfig = (args = { project, packages, remotes, reset}) => {
     if (args.packages) {
       newConfig.packages = tools.removeArrayDuplicates([...newConfig.packages || [], ...args.packages]);
     }
+    if (args.packagesBranches) {
+      newConfig.packagesBranches = tools.removeArrayDuplicates([...newConfig.packagesBranches || [], ...args.packagesBranches]);
+    }
 
     if (args.remotes) {
       newConfig.remotes = tools.removeArrayDuplicates([...newConfig.remotes || [], ...args.remotes]);
@@ -442,5 +453,11 @@ module.exports.generateCustomConfig = (customConfig) => {
 module.exports.getCustomConfig = () => {
   const configFile = path.join(process.cwd(), '.csdr', '.euirc-csdr-custom.json');
 
-  return tools.getJsonFileContent(configFile) || null;
+  delete require.cache[configFile];
+
+  if (tools.isFileExists(configFile)) {
+    return tools.getJsonFileContent(configFile) || null;
+  } else {
+    return null;
+  }
 }

package/scripts/csdr/config/init.js

@@ -18,7 +18,7 @@ module.exports.run = (args) => {
   return Promise.resolve()
     .then(() => {
       if (args.custom) {
-        return initConfigCustom();
+        return initConfigCustom(args);
 
       } else {
         return initConfigCore(args);
@@ -31,7 +31,7 @@ module.exports.run = (args) => {
 }
 
 
-const initConfigCustom = () => {
+const initConfigCustom = (args) => {
   return Promise.resolve()
     .then(() => {
       tools.logInfo('Updating local configuration - custom init');
@@ -42,9 +42,13 @@ const initConfigCustom = () => {
         throw new Error('Custom config not found... run the command "npm run init:custom" to generate your customized config');
       }
 
+      let defaultPackages = [];
+      defaultPackages = getInputPackages(args.project, args.pkg, args.team, args.prjOnly, args.containerOnly);
+
       return innerGlobal.updateConfig({
         project: customConfig.project,
-        packages: customConfig.packages,
+        packages: [...defaultPackages, ...customConfig.packages.map(p => p.name)],
+        packagesBranches: customConfig.packages,
         remotes: customConfig.remotes,
         reset: true
       });

package/scripts/csdr/config/packages.js

@@ -71,6 +71,30 @@ module.exports.getPackageByNpmPkg = (npmPkg, fromCsdrConfig) => {
   return;
 }
 
+module.exports.getPackageByRepository = (repository, fromCsdrConfig) => {
+  let packages;
+
+  // getting all config packages
+  if (fromCsdrConfig) {
+    packages = innerGlobal.getCsdrConfig().packages;
+
+  // get only packages installed config based on super .euirc.json file generated
+  } else {
+    packages = innerGlobal.getConfig().packages;
+  }
+
+  const pkg = Object.keys(packages).filter((p) => {
+    const pkg = packages[p];
+    return pkg.repository === repository;
+  })[0];
+
+  if (pkg) {
+    return this.getPackage(pkg, fromCsdrConfig);
+  }
+
+  return;
+}
+
 module.exports.isLocalPackage = (npmPkg) => {
   tools.logInfo(`Checking if ${npmPkg} is localled installed`);
 

package/scripts/csdr/config/projects.js

@@ -223,9 +223,14 @@ module.exports.getBaseHref = (prj, version, providedBaseHref) => {
 const getEuiVersionCore = (project) => {
   let version;
 
+  tools.logInfo(`Checking project dependencies in : ${project.folder}`);
   const depsCompositeFile = path.join(project.folder, 'dependencies-composite.json');
 
-  if (tools.isFileExists(depsCompositeFile)) {
+  if (!tools.isFileExists(depsCompositeFile)) {
+    tools.logWarning('Unable to find project version / dependencies-composite.json does not exist in project');
+
+  } else {
+    tools.logInfo(`parsing ${depsCompositeFile}`);
     const jsonFileContnet = JSON.parse(tools.getFileContent(depsCompositeFile));
     const deps = jsonFileContnet.dependencies;
 

package/scripts/csdr/config/remotes.js

@@ -197,6 +197,13 @@ module.exports.getRemotesPackages = (remotes) => {
     // adding the package root as source
     const pkg = innerPackages.getPackageByNpmPkg(rootNpmPkgName, true);
     packages.push(pkg.name);
+
+    packages = packages.map((p) => {
+      return {
+        name: p,
+        branch: 'develop'
+      }
+    });
   });
 
   return {

package/scripts/csdr/init/init-custom.js

@@ -14,21 +14,17 @@ const { skipInstall, build } = tools.getArgs();
 let customConfig;
 
 module.exports.init = (finalResponse) => {
+  tools.logTitle('Starting init custom');
+
   return Promise.resolve()
     .then(() => {
       customConfig = configUtils.global.getCustomConfig();
+
       if (!customConfig) {
         throw new Error('Custom config not found... run the command "npm run init:custom" to generate your customized config');
       }
     })
 
-    .then(() => {
-      finalResponse.project = customConfig.project;
-      finalResponse.euiVersion = customConfig.euiVersion;
-
-      return innerInitProject.init(finalResponse);
-    })
-
     .then(() => {
       return customConfig.remotes.reduce((promise, remote) => {
         return promise.then(() => (
@@ -38,15 +34,22 @@ module.exports.init = (finalResponse) => {
     })
 
     .then(() => {
-      return innerPackages.importPackages(finalResponse);
-    })
+      finalResponse.project = customConfig.project;
+      finalResponse.euiVersion = customConfig.euiVersion;
 
-    .then(() => {
-      if (!build && !skipInstall) {
-        return installUtils.localDev.install(customConfig.deps);
-      }
+      return innerInitProject.init(finalResponse);
     })
 
+    // .then(() => {
+    //   return innerPackages.importPackages(finalResponse);
+    // })
+
+    // .then(() => {
+    //   if (!build && !skipInstall) {
+    //     return installUtils.localDev.install(customConfig.deps);
+    //   }
+    // })
+
     .catch((e) => {
       throw e;
     });

package/scripts/csdr/init/meta.js

@@ -64,3 +64,18 @@ module.exports.getMetaProjects = () => {
 }
 
 
+module.exports.getBranchFromRepo = (repo) => {
+  tools.logInfo(`Getting branch from meta repo : ${repo.folder}`);
+  const config = configUtils.global.getConfig();
+
+  if (config.packagesBranches && config.packagesBranches.length !== 0) {
+    const pkg = configUtils.packages.getPackageByRepository(repo.uri);
+    const pkgBranch = config.packagesBranches.find(p => p.name === pkg.name);
+    if (pkgBranch) {
+      return pkgBranch.branch;
+    }
+
+  } else {
+    return null;
+  }
+}

package/scripts/csdr/init/repos.js

@@ -71,7 +71,15 @@ const cloneAndCheckout = (repo, args) => {
 
   return Promise.resolve()
     .then(() => {
-      return gitUtils.cloneAndCheckout(repo.uri, repo.folder, args.branch, false, shallowClone);
+      const branch = innerMeta.getBranchFromRepo(repo);
+      let cloneBranch;
+
+      if (branch) {
+        cloneBranch = branch;
+      } else {
+        cloneBranch = args.branch;
+      }
+      return gitUtils.cloneAndCheckout(repo.uri, repo.folder, cloneBranch, false, shallowClone);
     })
 
     .catch((e) => {

package/scripts/utils/git-utils.js

@@ -337,9 +337,9 @@ const checkout = (branch, folder, shallow = false) => {
         });
     })
     .catch((e) => {
-      if (!build) {
-        console.log(e);
-      }
+      // if (!build) {
+      //   console.log(e);
+      // }
       throw new Error(`Error trying to checkout ${branch} on ${folder}`);
     })
 }

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

@@ -3,3 +3,4 @@
 // INNER MODULES RE-EXPORTS
 module.exports.projects = require('./projects');
 module.exports.elements = require('./elements');
+module.exports.routesReplacement = require('./routes-replacement/routes-replacement');

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

@@ -31,18 +31,23 @@ const { debug } = tools.getArgs();
  * @param {boolean} build if the script is launched from a release pipeline OR from local CSDR playground environment (false in that case)
  * @returns {Promise} returns a Promise as it involves async I/O processes
  */
-module.exports.buildRoutes = (project, envTarget, build) => {
+module.exports.buildRoutes = (project, envTarget, build = false) => {
   tools.logTitle('Starting routes replacement');
 
+  // fetch custom config flag from project definition (used by host-playground-custom CSDR app config)
+  const custom = project.externalRoutesSources.custom;
+
+  // fetch generated envTarget
   const envTargetFinal = subs.getEnvTarget(envTarget, build);
 
+  // proceed to routes individual fetching and replacements
   return Promise.resolve()
     .then(() => {
       // injecting routes json definitions into project assets
       injectRoutesConfig(project);
 
       // getting all routes defs to be processed
-      const rawRoutesDefs = getRawRoutesDefs(project, envTargetFinal);
+      const rawRoutesDefs = getRawRoutesDefs(project, envTargetFinal, custom);
 
       // getting project routes remapped
       const routes = getProjectRoutes(project, rawRoutesDefs);
@@ -114,12 +119,61 @@ const injectRoutesConfig = (project) => {
 };
 
 
+const getCustomRoutesDefs = (project) => {
+  let routes = [];
+
+  tools.logInfo('Generating playground routes from custom config :');
+
+  const customConfig = configUtils.global.getCustomConfig();
+
+  if (Object.keys(customConfig).length === 0) {
+    tools.logError('No custom config found in your local csdr setup, run "npm run init:custom" for generating your own');
+    throw 'NO_CUSTOM_CONFIG_FOUND';
+  }
+
+  tools.logInfo('Custom config found :');
+  console.log(customConfig);
+
+  const routeDefsBaseFilename = 'route-defs-base.json';
+  const routeDefsBaseJSON = require(path.join(project.paths.assetsPath, routeDefsBaseFilename));
+
+  const getRouteFromNpmPkg = (npmPkg) => {
+    let route = null;
+
+    routeDefsBaseJSON.forEach((r) => {
+      if (r.lazyLoadDef) {
+        if (r.lazyLoadDef.npmPkg === npmPkg) {
+          route = r;
+        }
+      }
+    })
+
+    return route;
+  }
+
+  // get routes from local packages to be installed
+  customConfig.packages.forEach((p) => {
+    const pkg = configUtils.packages.getPackage(p.name);
 
+    tools.logInfo(`getting route def for : ${pkg.name} - ${pkg.npmPkg}`);
+    const route = getRouteFromNpmPkg(pkg.npmPkg);
+
+    if (route) {
+      routes.push({ path: route.path, lazy: true });
+    }
+  });
+  return routes;
+}
 
 
-const getRawRoutesDefs = (project, envTargetFinal) => {
+const getRoutesDefs = (project, envTargetFinal) => {
   // getting generated from input params
   const euiVersion = configUtils.projects.getProjectEuiVersion(project);
+
+  if (!euiVersion) {
+    throw 'PROJECT_EUI_VERSION_NOT_FOUND';
+  }
+
   const euiVersionNumber = euiVersion.split('.')[0];
 
   tools.logInfo(`Processing for envTarget : ${envTargetFinal}`);
@@ -152,6 +206,29 @@ const getRawRoutesDefs = (project, envTargetFinal) => {
 
   const routeDefsInputJSON = require(path.join(routeDefsInputPath));
 
+  return routeDefsInputJSON;
+}
+
+
+
+
+const getRawRoutesDefs = (project, envTargetFinal, custom) => {
+
+  let routesDefsBase = [];
+
+  if (custom) {
+    routesDefsBase = getCustomRoutesDefs(project);
+
+  } else {
+    routesDefsBase = getRoutesDefs(project, envTargetFinal);
+  }
+
+  if (routesDefsBase.length === 0) {
+    tools.logError('No routes base defs can be found, check your mywp-host-ui branch status or contact support');
+    throw 'NO_ROUTES_DEFS'
+  }
+
+
   // Merging content with "local" route file defs if existing
 
   let routes = [];
@@ -164,7 +241,7 @@ const getRawRoutesDefs = (project, envTargetFinal) => {
       tools.logInfo(`Merging local configuration found : ${localRouteDefsInputFilename}`);
       const localRouteDefsInputJSON = require(path.join(localRouteDefsInputPath));
 
-      routeDefsInputJSON.forEach((route) => {
+      routesDefsBase.forEach((route) => {
         const matchedRoute = localRouteDefsInputJSON.filter(newRoute => newRoute.path === route.path)[0];
         if (matchedRoute) {
           tools.logInfo(`-- replacing ${route.path} route entry with overriden local config`);
@@ -176,7 +253,7 @@ const getRawRoutesDefs = (project, envTargetFinal) => {
       });
     }
   } else {
-    routes = routeDefsInputJSON;
+    routes = routesDefsBase;
   }
 
   return routes;
@@ -499,8 +576,7 @@ const generateLinks = (project, routes, envTargetFinal) => {
     }
   });
 
-  tools.logInfo('Workspaces links generated :');
-  console.log(workspaceLinks);
+  tools.logInfo(`Workspaces links generated : ${workspaceLinks.length}`);
 
   const globalLinks = [
     ...routeDefsBaseLinksJSON,
@@ -525,7 +601,7 @@ const generateLinks = (project, routes, envTargetFinal) => {
             const defRoute = getRouteMenuDef(subLink);
 
             if (defRoute) {
-              if (project.externalRoutesSources.routesFilenameTemplate.indexOf('playground') > 0) {
+              if (project.name.indexOf('playground') > 0) {
                 const routePathInInputRoutes = routes.filter(r => r.angularRouteDef.path === defRoute.path)[0];
 
                 if (!routePathInInputRoutes) {
@@ -545,7 +621,7 @@ const generateLinks = (project, routes, envTargetFinal) => {
         const defRoute = getRouteMenuDef(link);
 
         if (defRoute) {
-          if (project.externalRoutesSources.routesFilenameTemplate.indexOf('playground') > 0) {
+          if (project.name.indexOf('playground') > 0) {
             const routePathInInputRoutes = routes.filter(r => r.angularRouteDef.path === defRoute.path)[0];
 
             if (!routePathInInputRoutes) {