@eui/tools 6.4.2 → 6.4.3

package/.version.properties

@@ -1 +1 @@
-6.4.2
+6.4.3

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 6.4.3 (2023-02-23)
+
+##### Chores
+
+* **other:**
+  * limit the number of commit output for MS Teams message - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([616070b3](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/616070b3daaaae67fc5753c490290c14f9790738))
+  * adapted teams notification message for exception and commits outpuy - EUI-7146 [EUI-7146](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7146)  ([58f0f958](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/58f0f9587af636311c43d9a979ea3d4acb5c5511))
+
+* * *
+* * *
 ## 6.4.2 (2023-02-22)
 
 ##### Chores

package/package.json

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

package/sandbox.js

@@ -1181,9 +1181,22 @@ const versionUtils = require('./scripts/csdr/version/version-utils');
 //   })
 
 
-const teamsUtils = require('./scripts/utils/notification/teams-utils');
+// const teamsUtils = require('./scripts/utils/notification/teams-utils');
+
+// Promise.resolve()
+//   .then(() => {
+//     console.log(teamsUtils.getChannelHook('pipeline-ui-edui'));
+//   })
 
 Promise.resolve()
   .then(() => {
-    console.log(teamsUtils.getChannelHook('pipeline-ui-edui'));
+
+    var startTime = moment('03-01-2021 01:01:01', 'DD-MM-YYYY hh:mm:ss');
+    var endTime = moment('03-01-2021 01:04:53', 'DD-MM-YYYY hh:mm:ss');
+
+    var secondsDiff = endTime.diff(startTime, 's');
+
+    const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+    const minSec = getMinSec(secondsDiff);
+    console.log(minSec);
   })

package/scripts/utils/notification/common.js

@@ -12,6 +12,7 @@ module.exports.getMessage = (options) => {
     mainText: null,
     detailTitle: null,
     detailText: null,
+    detailTextArray: [],
     text: options.text || null,
     status: null,
     statusColor: null
@@ -41,55 +42,57 @@ module.exports.getMessage = (options) => {
     switch (options.exception) {
       case 'NO_VALID_COMMIT_FOUND':
         message.detailTitle = 'NO VALID COMMIT FOUND!';
-        message.detailText = 'No valid commit found since last release tag\n' + '...Check trace file for details';
+        message.detailTextArray.push('No valid commit found since last release tag');
         break;
 
       case 'NO_ISSUE_FOUND':
         message.detailTitle = 'NO ISSUE FOUND!';
-        message.detailText = 'No issue found on commits since last release tag\n' + '...Check trace file for details\n';
+        message.detailTextArray.push('No issue found on commits since last release tag');
+        message.detailTextArray.push('Commit details:');
         if (options.metadata.commits && options.metadata.commits.length !== 0) {
-          message.detailText += options.metadata.commits.map((commit) => {
+          const commits = options.metadata.commits.map((commit) => {
             return metadataUtils.commit.formatCommit(commit);
-          }).join('\n');
+          });
+          message.detailTextArray = [...message.detailTextArray, ...commits];
         }
         break;
 
       case 'GLOBAL_PIPELINE_DISABLED':
         message.detailTitle = 'PIPELINE GLOBALLY DISABLED!';
-        message.detailText = 'Due to maintenance, all pipeline jobs have been temporary disabled - retry later';
+        message.detailTextArray.push('Due to maintenance, all pipeline jobs have been temporary disabled - retry later');
         break;
 
       case 'PACKAGE_LOCKED':
         message.detailTitle = 'CONCURRENT BUILD DETECTED FOR PACKAGE - ABORTING!';
-        message.detailText = 'Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared';
+        message.detailTextArray.push('Another build has been detected for the current package being build\n Retry again this build after 15m, lock will be auto-cleared');
         break;
 
       case 'MULTIPLE_LOCAL_EUI_VERSIONS_FOUND':
         message.detailTitle = 'MULTIPLE eUI VERSIONS FOUND IN LOCAL PROJECT - ABORTING!';
-        message.detailText = 'Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects';
+        message.detailTextArray.push('Uncompatible version of eUI found installed in the local CSDR project, please adjust and keep same compatible versions of eUI packages and projects');
         break;
 
       case 'BRANCH_NOT_PROVIDED':
         message.detailTitle = 'RELEASE BRANCH missing - ABORTING!';
-        message.detailText = 'Package release needs to have a branch to build from as parameter from Bamboo';
+        message.detailTextArray.push('Package release needs to have a branch to build from as parameter from Bamboo');
         break;
 
       case 'REMOTE_ENVTARGET_NOT_MASTER_BRANCH':
         message.detailTitle = 'REMOTE envTarget type branchis different from master - ABORTING!';
-        message.detailText = 'For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question';
+        message.detailTextArray.push('For envTarget remote delivery or "à la carte", only the master branch is allowed for build, contact support if any question');
         break;
 
       case 'AUDIT_DEPENDENCIES_GATES_FAILED':
-        message.detailTitle = 'Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!';
-        message.detailText = 'Check logs for more info or contact eUI support for detailed checks';
+        message.detailTitle = 'AUDIT DEPENDENCIES GATES FAILED';
+        message.detailTextArray.push('Audit dependencies gates for current eUI version contains blocking vulnerabilities - ABORTING!');
         break;
 
       default:
         message.detailTitle = 'GENERAL ERROR!';
-        message.detailText = options.exception;
+        message.detailTextArray.push(options.exception);
     };
 
-
+    message.detailText = message.detailTextArray.join('\n');
 
   } else {
 
@@ -106,12 +109,16 @@ module.exports.getMessage = (options) => {
 
       if (options.metadata && options.metadata.commits && options.metadata.commits.length !== 0) {
         message.detailTitle = 'Commit history since last release tag';
-        message.detailText = options.metadata.commits.map((commit) => {
+        const formattedCommits = options.metadata.commits.map((commit) => {
           return metadataUtils.commit.formatCommit(commit);
-        }).join('\n ');
+        });
+        message.detailText = formattedCommits.join('\n ');
+        message.detailTextArray = formattedCommits;
 
         if (options.metadata.issues && options.metadata.issues.length !== 0) {
-          message.detailText += '\nExtracted issues : ' + options.metadata.issues;
+          const extractedIssuesText = 'Extracted issues : ' + options.metadata.issues;
+          message.detailText += '\n' + extractedIssuesText;
+          message.detailTextArray.push(extractedIssuesText);
         }
       }
     }

package/scripts/utils/notification/message-stack.js

@@ -22,6 +22,7 @@ const messageContent = {
   startTimestamp: null,
   endTimestamp: null,
   duration: null,
+  durationSeconds: null,
   durationMinSec: null
 };
 
@@ -33,7 +34,9 @@ module.exports.endStack = () => {
   messageContent.endTimestamp = moment();
   messageContent.duration = messageContent.endTimestamp - messageContent.startTimestamp;
   const start = messageContent.startTimestamp, end = messageContent.endTimestamp;
-  messageContent.durationMinSec = `${end.diff(start, 'm')}m:${end.diff(start, 's')}s`;
+  messageContent.durationSeconds = end.diff(start, 's');
+  const getMinSec = (s) => { return(s-(s%=60))/60+'m'+(9<s?':':':0')+s+'s'; }
+  messageContent.durationMinSec = getMinSec(messageContent.durationSeconds);
 }
 
 module.exports.pushMessage = (message) => {

package/scripts/utils/notification/teams-utils.js

@@ -54,11 +54,19 @@ const createPayload = (messageContent) => {
   const version = finalMessage.version;
 
   // set commit history
-  const commitHistory = "```" + finalMessage.detailText;
+  let commitHistory = [], exceptionDetails = [];
+  if (status === statuses.success) {
+    commitHistory = finalMessage.detailTextArray;
+  } else {
+    exceptionDetails = finalMessage.detailTextArray;
+  }
 
   // set summary
   const itemName = messageContent.buffer[0].scope;
-  const summary = `${status.emoji} :: ${status.text} - ${itemName} - ${version}`;
+  let summary = `${status.emoji} :: ${status.text} - ${itemName}`;
+  if (version) {
+    summary +=  ` - ${version}`;
+  }
 
   // set release sections
   const publications = messageContent.buffer.filter(m => m.text !== null && m.text.indexOf(':rocket:') > -1);
@@ -71,11 +79,29 @@ const createPayload = (messageContent) => {
     }
   });
 
-  sections.push({
-    "startGroup": true,
-    "activityTitle": "Commit history since last release tag",
-    "activityText": commitHistory
-  });
+  if (commitHistory.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": "Commit history since last release tag"
+    });
+    commitHistory.slice(0, 5).forEach((commit) => {
+      sections.push({
+        "activityText": commit
+      });
+    });
+  }
+
+  if (exceptionDetails.length > 0) {
+    sections.push({
+      "startGroup": true,
+      "activityTitle": finalMessage.detailTitle
+    });
+    exceptionDetails.forEach((exd) => {
+      sections.push({
+        "activityText": exd
+      });
+    });
+  }
 
   sections.push({
     "startGroup": true,

package/scripts/utils/tools.js

@@ -78,8 +78,8 @@ function getArgs() {
           const newItem = {};
           newItem[subItemSplit[0].trim()] = subItemSplit[1].trim();
           array.push(newItem);
-          args[item.split(':')[0]] = array;
         })
+        args[item.split(':')[0]] = array;
 
       // otherwise normal key/value pairs - example format : test1:test1,test2:test2
       } else {