@eui/tools 6.9.7 → 6.10.1

package/.version.properties

@@ -1 +1 @@
-6.9.7
+6.10.1

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.10.1 (2023-03-24)
+
+##### Bug Fixes
+
+* **other:**
+  * test failing and replace by my-workplace-host project  ([7aa2cee9](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/7aa2cee9d32c21e632cd423c6bbf29deac992f6f))
+  * throw exception if route not found or remote route not found - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([18f5d41e](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/18f5d41e321f2e91c874a9ec8e7b2d08d6a9b4c2))
+
+* * *
+* * *
+## 6.10.0 (2023-03-24)
+
+##### New Features
+
+* **other:**
+  * route replacement for route config v2 activated - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([bf43901b](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/bf43901b7fceac0dd0610677d32f4eeab88e95df))
+
+* * *
+* * *
 ## 6.9.7 (2023-03-22)
 
 ##### Chores

package/package.json

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

package/scripts/csdr/config/projects.test.js

@@ -13,12 +13,12 @@ describe('[csdr/config/config-utils] - getCsdrProject()', () => {
 
 
   it('should return valid project details if project exists', () => {
-    const prj = projects.getCsdrProject('my-workplace');
+    const prj = projects.getCsdrProject('my-workplace-host');
     expect(prj).not.to.be.null;
-    expect(prj.name).to.equal('my-workplace');
-    expect(prj.devopsMetadataFile).to.equal('app-my-workplace-build-metadata.json');
-    expect(prj.devopsEnvsMetadataFile).to.equal('app-my-workplace-envs-metadata.json');
-    expect(prj.devopsVersionsMetadataFile).to.equal('app-my-workplace-versions-metadata.json');
-    expect(prj.devopsHistoryMetadataFile).to.equal('app-my-workplace-history-metadata.json');
+    expect(prj.name).to.equal('my-workplace-host');
+    expect(prj.devopsMetadataFile).to.equal('app-my-workplace-host-build-metadata.json');
+    expect(prj.devopsEnvsMetadataFile).to.equal('app-my-workplace-host-envs-metadata.json');
+    expect(prj.devopsVersionsMetadataFile).to.equal('app-my-workplace-host-versions-metadata.json');
+    expect(prj.devopsHistoryMetadataFile).to.equal('app-my-workplace-host-history-metadata.json');
   })
 });

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

@@ -56,62 +56,41 @@ const getRoutesFile = (project, euiVersion) => {
       let routesFilePath;
       let srcRoutesFilePath;
 
-      if (!project.externalRoutesSources.routesFileNpmPkg || !project.externalRoutesSources.routesFileSource || !project.externalRoutesSources.routesFilePath) {
-        tools.logError('project requires externalRoutesSources.routesFileNpmPkg, routesFileSources and routesFilePath definitions');
+      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.routesFileNpmPkg
+        return p.npmPkg === project.externalRoutesSources.routesConfigNpmPkg
       })[0];
 
       // if local package is found
       if (localPackage) {
         tools.logInfo('local package found, copying from local');
 
-        if (tools.isFalse(project.externalRoutesSources.includeEuiVersion)) {
-          tools.logInfo('include eUI version in routes path...skipped');
-
-          srcRoutesFilePath = path.join(
-            process.cwd(), 'packages', localPackage.name,
-            project.externalRoutesSources.routesFileSource,
-          );
-
-        } else {
-          tools.logInfo(`constructing route path with eUI version provided: ${euiVersion}`);
-
-          srcRoutesFilePath = path.join(
-            process.cwd(), 'packages', localPackage.name,
-            'assets', euiVersion,
-            project.externalRoutesSources.routesFileSource,
-          );
-        }
+        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.routesFileNpmPkg.substr(0, project.externalRoutesSources.routesFileNpmPkg.indexOf('/'));
-        const npmPkgName = project.externalRoutesSources.routesFileNpmPkg.substr(project.externalRoutesSources.routesFileNpmPkg.indexOf('/') + 1);
+        const npmPkgScope = project.externalRoutesSources.routesConfigNpmPkg.substr(0, project.externalRoutesSources.routesConfigNpmPkg.indexOf('/'));
+        const npmPkgName = project.externalRoutesSources.routesConfigNpmPkg.substr(project.externalRoutesSources.routesConfigNpmPkg.indexOf('/') + 1);
 
-        if (tools.isFalse(project.externalRoutesSources.includeEuiVersion)) {
-          tools.logInfo('include eUI version in routes path...skipped');
+        tools.logInfo(`constructing route path with eUI version provided: ${euiVersion}`);
 
-          srcRoutesFilePath = path.join(
-            process.cwd(), 'node_modules', npmPkgScope, npmPkgName,
-            project.externalRoutesSources.routesFileSource,
-          );
-
-        } else {
-          tools.logInfo(`constructing route path with eUI version provided: ${euiVersion}`);
-
-          srcRoutesFilePath = path.join(
-            process.cwd(), 'node_modules', npmPkgScope, npmPkgName,
-            'assets', euiVersion,
-            project.externalRoutesSources.routesFileSource,
-          );
-        }
+        srcRoutesFilePath = path.join(
+          process.cwd(), 'node_modules', npmPkgScope, npmPkgName,
+          'assets', euiVersion,
+          project.externalRoutesSources.routesFileSource,
+        );
       }
 
       routesFilePath = path.join(project.paths.rootPath, project.externalRoutesSources.routesFilePath);
@@ -133,93 +112,9 @@ const getRoutesFile = (project, euiVersion) => {
     })
 }
 
-/* @deprecated - TO REMOVE */
-const replaceRouteLegacy = (route) => {
-  let routeContent = '{\n';
-
-  routeContent += `  path: '${route.path}',\n`;
-  if (route.data) {
-    routeContent += '  data: {\n';
-
-    if (route.data.id) {
-      routeContent += `    id: '${route.data.id}',\n`;
-    }
-    if (route.data.ids) {
-      routeContent += `    ids: ${route.data.ids},\n`;
-    }
-    if (route.data.featureName) {
-      routeContent += `    featureName: '${route.data.featureName}',\n`;
-    }
-    if (route.data.moduleId) {
-      routeContent += `    moduleId: '${route.data.moduleId}',\n`;
-    }
-    if (route.data.elementTag) {
-      routeContent += `    elementTag: '${route.data.elementTag}',\n`;
-    }
-    if (route.data.iframe) {
-      routeContent += `    iframe: ${route.data.iframe},\n`;
-    }
-    routeContent += '  },\n';
-  }
-  if (route.canActivate) {
-    routeContent += `  canActivate: ${route.canActivate},\n`;
-  }
-  if (route.loadChildren) {
-    routeContent += `  loadChildren: '${route.loadChildren}',\n`
-  }
-  routeContent += '},\n\n';
-
-  return routeContent;
-}
-
-
-/* @deprecated - TO REMOVE */
 const replaceRoute = (route) => {
   let routeContent = '{\n';
 
-  routeContent += `  path: '${route.path}',\n`;
-  if (route.data) {
-    routeContent += '  data: {\n';
-
-    if (route.data.id) {
-      routeContent += `    id: '${route.data.id}',\n`;
-    }
-    if (route.data.ids) {
-      routeContent += `    ids: ${route.data.ids},\n`;
-    }
-    if (route.data.featureName) {
-      routeContent += `    featureName: '${route.data.featureName}',\n`;
-    }
-    if (route.data.moduleId) {
-      routeContent += `    moduleId: '${route.data.moduleId}',\n`;
-    }
-    if (route.data.elementTag) {
-      routeContent += `    elementTag: '${route.data.elementTag}',\n`;
-    }
-    if (route.data.iframe) {
-      routeContent += `    iframe: ${route.data.iframe},\n`;
-    }
-    routeContent += '  },\n';
-  }
-  if (route.canActivate) {
-    routeContent += `  canActivate: ${route.canActivate},\n`;
-  }
-  if (route.loadChildren) {
-    const lcArray = route.loadChildren.split('#');
-    const lcImport = lcArray[0];
-    const lcModule = lcArray[1];
-    routeContent += `  loadChildren: () => import('${lcImport}').then(m => m.${lcModule}),\n`
-  }
-  routeContent += '},\n\n';
-
-  return routeContent;
-}
-
-
-
-const replaceRouteV2 = (route) => {
-  let routeContent = '{\n';
-
   routeContent += `  path: '${route.path}',\n`;
   if (Object.keys(route.data).length > 0) {
     routeContent += '  data: {\n';
@@ -256,129 +151,7 @@ const replaceRouteV2 = (route) => {
 }
 
 
-/* @deprecated - TO REMOVE */
-const replaceRoutes = (project, envTarget, build, routesFileContent, euiVersion) => {
-  return Promise.resolve()
-    .then(() => {
-
-      tools.logInfo('Replace routes legacy started...');
-
-      // getting base route defs content
-      // default route
-      let routeDefsBaseFilename = 'route-defs-base.json';
-
-      // if full route base name is setup
-      if (project.externalRoutesSources.routesBaseFilename) {
-        routeDefsBaseFilename = project.externalRoutesSources.routesBaseFilename;
-
-      // if prefix and type, we construct the route base name (dynamic following eUI version of host installed)
-      // format is : route-defs-base-vVERSION_NUMBER[-TYPE].json
-      } else if (project.externalRoutesSources.routesBaseFilenamePrefix) {
-        let routesBaseType = '';
-        if (project.externalRoutesSources.routesBaseFilenameType) {
-          routesBaseType = `-${project.externalRoutesSources.routesBaseFilenameType}`;
-        }
-        const euiVersionNumber = euiVersion.split('.')[0];
-        routeDefsBaseFilename = `${project.externalRoutesSources.routesBaseFilenamePrefix}-v${euiVersionNumber}${routesBaseType}.json`;
-      }
-
-      const projectAssetsPath = path.join(process.cwd(), project.folder, 'src', 'assets');
-      const baseRouteDefsPath = path.join(projectAssetsPath, routeDefsBaseFilename);
-
-      if (!tools.isFileExists(baseRouteDefsPath)) {
-        tools.logError(`${baseRouteDefsPath} File NOT FOUND`);
-        throw 'BASE_ROUTE_DEFS_FILE_NOT_FOUND';
-      }
-
-      // fetching base route defs file content
-      const baseRouteDefsJSON = require(baseRouteDefsPath);
-
-      // getting env route defs content if build mode (not serve)
-      let envRouteDefsPath, envRouteDefsJSON = [];
-      const envTargetFinal = getEnvTarget(envTarget, build);
-
-      envRouteDefsPath = path.join(projectAssetsPath, 'route-defs.' + envTargetFinal + '.json');
-
-      if (!tools.isFileExists(envRouteDefsPath)) {
-        tools.logError(`${envRouteDefsPath} File NOT FOUND`);
-        throw 'ENV_ROUTE_DEFS_FILE_NOT_FOUND';
-      }
-
-      // fetching file content
-      envRouteDefsJSON = require(envRouteDefsPath);
-
-      // merging content of base + env
-      tools.logInfo(`Merging ${baseRouteDefsPath} with ${envRouteDefsPath}`);
-
-      let mergedRouteDefs = _.merge(_.keyBy(baseRouteDefsJSON, 'path'), _.keyBy(envRouteDefsJSON, 'path'));
-      let finalRouteDefs = _.values(mergedRouteDefs);
-
-      // checking if overrides needs to be applied specific to env + version
-      let euiVersionNumber;
-      if (euiVersion === 'DEFAULT') {
-        euiVersionNumber = '7'
-      } else {
-        euiVersionNumber = euiVersion.split('.')[0];
-      };
-
-      const envRouteVersionOverridesPath = path.join(projectAssetsPath, 'route-defs.' + envTargetFinal + '-overrides-v' + euiVersionNumber + '.json');
-
-      if (!tools.isFileExists(envRouteVersionOverridesPath)) {
-        tools.logInfo('Routes file overrides not found for ' + envTargetFinal + ' ' + euiVersionNumber + '...skipping');
-
-      } else {
-        const euiRoutesOVerridesJSON = require(envRouteVersionOverridesPath);
-        tools.logInfo(`Merging ${envRouteVersionOverridesPath}`);
-        mergedRouteDefs = _.merge(_.keyBy(mergedRouteDefs, 'path'), _.keyBy(euiRoutesOVerridesJSON, 'path'));
-        finalRouteDefs = _.values(mergedRouteDefs);
-      }
-
-      // processing routes
-      let placeHolderContent = '';
-
-      tools.logInfo('Processing routes replacement');
-
-      finalRouteDefs.forEach((route) => {
-        if (debug) tools.logInfo(`====> route : ${route.path}`);
-
-        if (!route.loadChildren) {
-          tools.logInfo('Loadchildren does not exist for route...skipping');
-          tools.logInfo('Route excluded:');
-          console.log(route);
-
-        } else {
-          if (euiVersion === 'DEFAULT' || euiVersion === '10.x') {
-            tools.logInfo(`Legacy routes replacement for v7 and v10 => replacing ${route.path}`);
-            placeHolderContent += replaceRouteLegacy(route);
-
-          } else {
-            tools.logInfo(`New route replacement for v14+ => replacing ${route.path}`);
-            placeHolderContent += replaceRoute(route);
-          }
-
-          if (debug) tools.logSuccess('======> OK replaced');
-        }
-      })
-
-      const placeHolderToken = '// routes-placeholder';
-      routesFileContent = tools.replaceAll(routesFileContent, placeHolderToken, placeHolderContent);
-
-      if (debug) {
-        tools.logInfo('Routes file content replaced : ');
-        console.log(routesFileContent);
-      }
-
-      return routesFileContent;
-    })
-
-    .catch((e) => {
-      throw e;
-    })
-}
-
-
-
-const processRoutesConfigV2 = (project, envTarget, build, routesFileContent, euiVersion) => {
+const processRoutesConfig = (project, envTarget, build, routesFileContent, euiVersion) => {
   return Promise.resolve()
     .then(() => {
       tools.logInfo('Replace routes v2...');
@@ -431,7 +204,9 @@ const processRoutesConfigV2 = (project, envTarget, build, routesFileContent, eui
 
         const defRoute = routeDefsBaseJSON.filter(r => r.path === route.path)[0];
         if (!defRoute) {
-          tools.logError('==>route not found');
+          tools.logError('route not found for: ');
+          console.log(route);
+          throw 'ROUTE_NOT_FOUND';
 
         } else {
           let loadChildrenGenerated;
@@ -474,9 +249,17 @@ const processRoutesConfigV2 = (project, envTarget, build, routesFileContent, eui
           }
 
           if (route.remote) {
-            const remoteDef = defRoute.remoteDefs.filter((r) => {
-              return r.euiVersion === route.euiVersion
-            })[0];
+            let remoteDef;
+            try {
+              remoteDef = defRoute.remoteDefs.filter((r) => {
+                return r.euiVersion === route.euiVersion
+              })[0];
+            } catch {
+              tools.logError('Remote route not found for: ');
+              console.log(route);
+              throw 'REMOTE_ROUTE_DEF_NOT_FOUND';
+            }
+
             if (remoteDef) {
               newAppRoute.data.moduleId = remoteDef.moduleId;
               newAppRoute.data.elementTag = remoteDef.elementTag;
@@ -618,7 +401,7 @@ const processRoutesConfigV2 = (project, envTarget, build, routesFileContent, eui
       let placeHolderContent = '';
 
       appRoutes.forEach((route) => {
-        placeHolderContent += replaceRouteV2(route);
+        placeHolderContent += replaceRoute(route);
       });
 
       const placeHolderToken = '// routes-placeholder';
@@ -683,9 +466,7 @@ module.exports.buildRoutes = (project, envTarget, build) => {
 
   return Promise.resolve()
     .then(() => {
-      if (project.externalRoutesSources.routesConfigVersion === '2') {
-        return injectRoutesConfig(project, project.externalRoutesSources.routesConfigNpmPkg);
-      }
+      return injectRoutesConfig(project, project.externalRoutesSources.routesConfigNpmPkg);
     })
 
     .then(() => {
@@ -700,11 +481,7 @@ module.exports.buildRoutes = (project, envTarget, build) => {
     })
 
     .then(() => {
-      if (project.externalRoutesSources.routesConfigVersion === '2') {
-        return processRoutesConfigV2(project, envTarget, build, routesFileContent, euiVersion);
-      } else {
-        return replaceRoutes(project, envTarget, build, routesFileContent, euiVersion);
-      }
+      return processRoutesConfig(project, envTarget, build, routesFileContent, euiVersion);
     })
 
     .then((finalRouteFileContent) => {