feat(index.js): Using AdaptiveCard instead of MessageCard (deprecated), enhanced user experience, bug fixes related to pull req info

Author: AsifNawaz-cnic

assets/rtldev-middleware-blesta-ispapi-registrar.png

@@ -1,6 +1,6 @@
-const { getArguments } = require('./lib/notes');
+const { getArguments, getNotes, getReleaseDate } = require('./lib/notes');
 const { updateValues, readPackageJson, publishNotification, fetchPullRequestInfo } = require('./lib/payloadUtils');
-const messagePayload = require('./lib/teams_payload.json');
+const { execSync } = require('child_process');
 
 // Main function that returns a promise
 async function postNotification() {
@@ -9,24 +9,38 @@ async function postNotification() {
     // Fetch Jira issue link based on the repository URL
     const jiraIssueLink = fetchPullRequestInfo(repoUrl);
     // Get version information and release details
-    const { versionNumber, releaseType, releaseUrl } = getArguments(repoUrl);
+    const { versionNumber, releaseType, releaseUrl, headerColor, repoImg } = getArguments(repoUrl);
+
+    const notificationType = execSync("echo $TEAMS_NOTIFICATION_TYPE").toString().trim();
+    const messagePayload = require(notificationType ? './lib/messagecard_payload.json' : './lib/default_payload.json');
+
     // Function to create a custom value object with 'find' and 'replace' keys
     const createCustomValue = (find, replace) => ({ find, replace });
 
-    // Array to store custom values based on project and release information
-    const customValues = [
-        // Create custom value for the project name
-        createCustomValue({ name: "Project:" }, { value: projectName }),
-        // Create custom value for the release type and version number also replace the name
-        createCustomValue({ name: "Release Type:" }, { name: releaseType, value: versionNumber }),
-        // Add Release Notes custom value if releaseUrl is provided
-        releaseUrl && createCustomValue({ name: "Release Notes" }, { uri: releaseUrl }),
-        // Add Github Repository custom value if repoUrl is provided
-        repoUrl && createCustomValue({ name: "Github Repository" }, { uri: repoUrl }),
-        // Add Jira Issue custom value if jiraIssueLink is provided
-        jiraIssueLink && createCustomValue({ name: "Jira Issue" }, { uri: jiraIssueLink }),
-    ].filter(Boolean);  // Remove any falsy values from the array (e.g., if releaseUrl, repoUrl, or jiraIssueLink is not provided)
+    const customValues = [];
+    const pushCustomValue = (nameKey, titleKey) => (label, value) => {
+        const key = notificationType ? nameKey : titleKey;
+        customValues.push(createCustomValue({ [key]: label }, value));
+    };
 
+    const pushValue = pushCustomValue("name", "id");
+
+    if (!notificationType) {
+        pushValue("projectName", { text: projectName });
+        pushValue("releaseInfo", { text: `${releaseType} v${versionNumber} (${getReleaseDate()})` });
+        pushValue("changeLog", { text: getNotes() });
+        pushValue("header", { style: headerColor });
+        pushValue("releaseNotes", { url: releaseUrl ?? "" });
+        pushValue("githubRepository", { url: repoUrl ?? "" });
+        pushValue("jiraIssue", { url: jiraIssueLink ?? "" });
+        pushValue("productImage", { url: repoImg ?? "" });
+    } else {
+        pushValue("Project:", { value: projectName });
+        pushValue("Release Type:", { "title": releaseType, value: versionNumber });
+        pushValue("Release Notes", { uri: releaseUrl ?? "" });
+        pushValue("Github Repository", { uri: repoUrl ?? "" });
+        pushValue("Jira Issue", { uri: jiraIssueLink ?? "" });
+    }
 
     // Override values of the messagePayload directly based on customValues
     if (Object.keys(customValues).length !== 0) {

assets/rtldev-middleware-whmcs-src.png

@@ -0,0 +1,97 @@
+{
+    "type": "message",
+    "width": "stretch",
+    "attachments": [
+        {
+            "contentType": "application/vnd.microsoft.card.adaptive",
+            "contentUrl": null,
+            "content": {
+                "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+                "type": "AdaptiveCard",
+                "version": "1.5",
+                "verticalContentAlignment": "Center",
+                "body": [
+                    {
+                        "type": "ColumnSet",
+                        "columns": [
+                            {
+                                "type": "Column",
+                                "width": "50px",
+                                "items": [
+                                    {
+                                        "type": "Image",
+                                        "style": "person",
+                                        "url": "",
+                                        "size": "small",
+                                        "height": "50px"
+                                    }
+                                ],
+                                "id": "productImage"
+                            },
+                            {
+                                "type": "Column",
+                                "items": [
+                                    {
+                                        "type": "TextBlock",
+                                        "weight": "bolder",
+                                        "text": "",
+                                        "wrap": true,
+                                        "style": "columnHeader",
+                                        "id": "projectName"
+                                    },
+                                    {
+                                        "type": "TextBlock",
+                                        "spacing": "none",
+                                        "text": "",
+                                        "isSubtle": true,
+                                        "wrap": true,
+                                        "size": "small",
+                                        "id": "releaseInfo"
+                                    }
+                                ],
+                                "width": "stretch"
+                            }
+                        ],
+                        "id": "header",
+                        "bleed": true,
+                        "style": ""
+                    },
+                    {
+                        "type": "TextBlock",
+                        "text": "",
+                        "wrap": true,
+                        "fontType": "Monospace",
+                        "id": "changeLog",
+                        "isSubtle": true
+                    }
+                ],
+                "actions": [
+                    {
+                        "type": "Action.OpenUrl",
+                        "title": "Github Repository",
+                        "url": "",
+                        "id": "githubRepository"
+                    },
+                    {
+                        "type": "Action.OpenUrl",
+                        "title": "Release Notes",
+                        "url": "",
+                        "id": "releaseNotes"
+                    },
+                    {
+                        "type": "Action.OpenUrl",
+                        "title": "Jira Issue",
+                        "url": "",
+                        "id": "jiraIssue"
+                    },
+                    {
+                        "type": "Action.OpenUrl",
+                        "title": "Email Us",
+                        "url": "mailto:middleware@hexonet.net",
+                        "id": "emailUs"
+                    }
+                ]
+            }
+        }
+    ]
+}

index.js

@@ -0,0 +1,63 @@
+{
+    "@type": "MessageCard",
+    "@context": "http://schema.org/extensions",
+    "themeColor": "39ff14",
+    "summary": "A new change has just been reported by 3rd-party Software Integrations",
+    "sections": [
+      {
+        "facts": [
+          {
+            "name": "Project:",
+            "value": ""
+          },
+          {
+            "name": "Release Type:",
+            "value": ""
+          }
+        ],
+        "markdown": true
+      }
+    ],
+    "potentialAction": [
+      {
+        "@type": "OpenUri",
+        "name": "Github Repository",
+        "targets": [
+          {
+            "os": "default",
+            "uri": ""
+          }
+        ]
+      },
+      {
+        "@type": "OpenUri",
+        "name": "Release Notes",
+        "targets": [
+          {
+            "os": "default",
+            "uri": ""
+          }
+        ]
+      },
+      {
+        "@type": "OpenUri",
+        "name": "Jira Issue",
+        "targets": [
+          {
+            "os": "default",
+            "uri": ""
+          }
+        ]
+      },
+      {
+        "@type": "OpenUri",
+        "name": "Email Us",
+        "targets": [
+          {
+            "os": "default",
+            "uri": "https://outlook.office.com/mail/deeplink/compose?to=middleware@hexonet.net"
+          }
+        ]
+      }
+    ]
+  }

lib/default_payload.json

@@ -1,35 +1,56 @@
 const arg = require('./arguments');
-async function generateNotes() {
+function getNotes() {
     // Decode the notes to handle any special characters.
     let cleanedNotes = decodeURIComponent(arg.notes);
 
     // Define the regex to match links and commit ids in the notes.
-    const regex = /\(\[([^[\]]*)\]\([^()]*\)\)|\[([^[\]]*)\]\([^()]*\)/gi;
-
-    // Replace the links and commit ids with the text in the square brackets.
-    cleanedNotes = cleanedNotes.replace(regex, '$2');
+    const regex = /\*\*([^:]+):\*\* (.*) \(\[([a-f0-9]{7})\]\(.*?\)\)/g; // match the commit data with category and message
+    const result = cleanedNotes.match(regex); // extract the commit data as an array
+    cleanedNotes = '';
+    result.forEach(item => {
+      item = item.replace(/\(\[([a-f0-9]{7})\]\(.*?\)\)/, ''); // remove the parentheses and the commit hash
+      item = item.trim(); // remove any extra spaces
+      cleanedNotes += item + '\n\n'; // add the formatted item to the output string with a line break
+    });
 
     // Return the cleaned release notes.
-    return cleanedNotes;
+    return `Changelog:\n\n${cleanedNotes}`;
+}
+
+function getReleaseDate() {
+    let cleanedNotes = decodeURIComponent(arg.notes);
+    const regex = /\(\d{4}-\d{2}-\d{2}\)/; // match the date in parentheses
+    const result = cleanedNotes.match(regex); // extract the date as a string
+    cleanedNotes = result[0].replace(/\(|\)/g, ''); // remove the parentheses
+    return cleanedNotes; // return the date
 }
+
 function getArguments(repoUrl) {
     let releaseType;
+    let headerColor;
     switch (arg?.type) {
         case "minor":
             releaseType = "Feature Release:";
+            headerColor = "accent";
             break;
         case "major":
             releaseType = "Major Release:"
+            headerColor = "good";
             break;
         default:
             releaseType = "Patch Release:";
-
+            headerColor = "attention";
     }
     let releaseUrl = false;
     let versionNumber = arg?.update ?? "Development Changes";
     if (/\d+\.\d+\.\d+/.test(versionNumber)) {
         releaseUrl = `${repoUrl}/releases/tag/v${versionNumber}`;
     }
-    return { versionNumber: versionNumber, releaseType, releaseUrl }
+    let repoImg = "";
+    if (/whmcs|blesta/i.test(repoUrl)) {
+        repoImg = `https://github.com/centralnicgroup-opensource/rtldev-middleware-gulp-release-notification-plugin/blob/main/assets/${repoUrl.split('/').slice(-1)}.png`;
+    }
+    return { versionNumber: versionNumber, releaseType, releaseUrl, headerColor, repoImg }
 }
-module.exports = { generateNotes, getArguments };
+
+module.exports = { getNotes, getArguments, getReleaseDate };

lib/messagecard_payload.json

@@ -13,14 +13,17 @@ const updateValues = (payload, customValues) => {
                 const { replace } = matchingFind;
 
                 for (const replaceKey in replace) {
-                    if (payload[prop][replaceKey] !== undefined) {
+                    if (replace[replaceKey] === "") {
+                        delete payload[prop];
+                    } else if (payload[prop][replaceKey] !== undefined) {
                         payload[prop][replaceKey] = replace[replaceKey];
                     } else {
                         findAndReplaceNestedKey(payload[prop], replaceKey, replace[replaceKey]);
                     }
                 }
             }
         }
+        payload = removeNulls(payload);
     }
 };
 
@@ -37,7 +40,7 @@ const findAndReplaceNestedKey = (obj, targetKey, replacement) => {
 
 // Helper function to check if two objects match
 const isObjectMatch = (obj, criteria) =>
-    Object.entries(criteria).every(([key, value]) => obj[key] === value);
+    Object.entries(criteria).every(([key, value]) => obj && obj.hasOwnProperty(key) && obj[key] === value);
 
 const readPackageJson = async () => {
     try {
@@ -68,14 +71,14 @@ retryFn.counter = 1;
 const fetchPullRequestInfo = (repoUrl) => {
     const usernameAndRepo = repoUrl.split('/').slice(-2).join('/');
     const commitSHA = execSync("echo $COMMIT_SHA").toString().trim();
-    // need to check if it works without token or not
-    const githubToken = execSync("echo $RTLDEV_MW_CI_TOKEN || echo $GH_TOKEN || echo $GITHUB_TOKEN").toString().trim();
-    if (!commitSHA || !usernameAndRepo) {
+    const githubToken = execSync("echo ${RTLDEV_MW_CI_TOKEN:-${GH_TOKEN:-$GITHUB_TOKEN}}").toString().trim();
+
+    if (!githubToken || !commitSHA || !usernameAndRepo) {
         return;
     }
 
     try {
-        const result = JSON.parse(execSync(`curl -s -H "Authorization: token ${githubToken}" https://api.github.com/repos/${usernameAndRepo}/commits/${commitSHA}/pulls`, { encoding: 'utf-8' }))[0];
+        const result = JSON.parse(execSync(`curl -s -L -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${githubToken}" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/${usernameAndRepo}/commits/${commitSHA}/pulls`, { encoding: 'utf-8' }))[0];
 
         if (result?.title || result?.head?.ref) {
             const jiraID = result?.title.match(/(RSRMID|GI)-\d+/g) || result?.head?.ref.match(/(RSRMID|GI)-\d+/g);
@@ -106,4 +109,24 @@ const publishNotification = async (payload) => {
         return;
     }
 }
+
+const removeNulls = (obj) => {
+    if (obj && typeof obj === "object") {
+        if (Array.isArray(obj)) {
+            // Remove null entries from arrays
+            obj = obj.filter(item => item !== null);
+        } else {
+            // Remove null entries from objects
+            for (const key in obj) {
+                if (obj[key] === null) {
+                    delete obj[key];
+                } else {
+                    obj[key] = removeNulls(obj[key]);
+                }
+            }
+        }
+    }
+    return obj;
+}
+
 module.exports = { updateValues, isObjectMatch, findAndReplaceNestedKey, readPackageJson, retryFn, fetchPullRequestInfo, publishNotification };