Release Comparison Fixes and Xml parsing Fixes (#32)

* Ignore Release compare errors from AzureDevOps API

* Fix for line break issues

* Fix Line Breaks in Error messages and stack traces

* Fix the line breaks

* Upgrade versions

* Upgrade version

Co-authored-by: Krishna V <[email protected]>

Author: saikrishnav

Tasks/emailReportTask/htmlreport/HTMLReportCreator.ts

@@ -3,7 +3,7 @@ import { IHTMLReportCreator } from './IHTMLReportCreator';
 import { Report } from '../model/Report';
 import { ReportConfiguration } from '../config/ReportConfiguration';
 const fs = require("fs");
-const js2xmlparser = require("js2xmlparser");
+const o2x = require('object-to-xml');
 const xsltProcessor = require("xslt-processor");
 const { xmlParse, xsltProcess } = xsltProcessor;
 
@@ -17,17 +17,18 @@ export class HTMLReportCreator implements IHTMLReportCreator {
 
     // Create a view model object before serialize to xml
     const reportViewModel = new EmailReportViewModel(report, reportConfiguration);
-
     // Serialize gathered data into xml 
-    const xmlString: string = js2xmlparser.parse("EmailReportViewModel", reportViewModel);
+    const xmlString: string = "<EmailReportViewModel>" + o2x(reportViewModel) + "</EmailReportViewModel>";
     // Read XSLT email template 
     const buffer = fs.readFileSync(xsltTemplatePath);
     // Parse the xml string as XmlDocument/Node
     const xmlDoc = xmlParse(xmlString, "text/xml");
     // Parse XSLT as XMLDocument
     const xsltDoc = xmlParse(buffer.toString(), "application/xml");
     // Fill the XSLT document template with the xml doc data
-    const outXmlString = xsltProcess(xmlDoc, xsltDoc);
+    let outXmlString = xsltProcess(xmlDoc, xsltDoc);
+    // XML parsing changes <br/> to special chars if they are part of xml nodevalues. Do string replace to fix the jankiness for HTML.
+    outXmlString = outXmlString.split("&lt;br/&gt;").join("<br/>");
     return outXmlString;
   }
 }

Tasks/emailReportTask/model/viewmodel/TestResultViewModel.ts

@@ -35,10 +35,10 @@ export class TestResultViewModel {
     const result = testResultModel.testResult;
     this.Id = result.id;
     this.TestCaseTitle = result.testCaseTitle;
-    this.ErrorMessage = StringUtils.ReplaceNewlineWithBrTag(result.errorMessage);
+    this.ErrorMessage = "<![CDATA[" + StringUtils.ReplaceNewlineWithBrTag(result.errorMessage) + "]]>";
     this.TestOutcome = result.outcome;
-    this.StackTrace = StringUtils.ReplaceNewlineWithBrTag(
-      StringUtils.getFirstNLines(result.stackTrace, this.StackTraceLineCount));
+    this.StackTrace = "<![CDATA[" + StringUtils.ReplaceNewlineWithBrTag(
+      StringUtils.getFirstNLines(result.stackTrace, this.StackTraceLineCount)) + "]]>";
 
     if (result.priority != 255) {
       this.Priority = DisplayNameHelper.getPriorityDisplayName(result.priority == null ? "" : result.priority.toString());

Tasks/emailReportTask/package.json

@@ -9,8 +9,8 @@
   "dependencies": {
     "azure-devops-node-api": "^10.0.0",
     "azure-pipelines-task-lib": "^2.8.0",
-    "js2xmlparser": "^4.0.0",
     "nodemailer": "^6.3.0",
+    "object-to-xml": "^2.0.0",
     "performance-now": "^2.1.0",
     "reflect-metadata": "^0.1.13",
     "xslt-processor": "^0.11.5"

Tasks/emailReportTask/providers/pipeline/ReleaseDataProvider.ts

@@ -40,7 +40,12 @@ export class ReleaseDataProvider implements IDataProvider {
     // check if last completed one isn't latter one, then changes don't make sense
     if (lastCompletedRelease != null && lastCompletedRelease.id < release.id) {
       console.log(`Getting changes between releases ${release.id} & ${lastCompletedRelease.id}`);
-      changes = await RetryablePromise.RetryAsync(async () => this.pipelineRestClient.getPipelineChangesAsync(lastCompletedRelease.id), "GetPipelineChanges");
+      try {
+        changes = await RetryablePromise.RetryAsync(async () => this.pipelineRestClient.getPipelineChangesAsync(lastCompletedRelease.id), "GetPipelineChanges");
+      } catch(err) {
+        // Changes happened in current release w.r.t previous one isn't strictly required to send mail - ignoring any errors
+        console.warn(`Error while comparing current release - '${release.id}' with previous one - '${lastCompletedRelease.id}': ${err}`);
+      }
     }
     else {
       console.log("Unable to find any last completed release");

Tasks/emailReportTask/task.dev.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 1,
     "Minor": 2,
-    "Patch": 202
+    "Patch": 204
   },
   "groups": [
     {

Tasks/emailReportTask/task.prod.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 1,
     "Minor": 1,
-    "Patch": 5
+    "Patch": 6
   },
   "groups": [
     {

Tasks/emailReportTask/tests/__e_to_e_tests__/InvokeTest.ts

@@ -13,16 +13,11 @@ import { PipelineType } from "../../config/pipeline/PipelineType";
 import { ReportProvider } from "../../providers/ReportProvider";
 import { DataProviderFactory } from "../../providers/DataProviderFactory";
 import { HTMLReportCreator } from "../../htmlreport/HTMLReportCreator";
-import { IHTMLReportCreator } from "../../htmlreport/IHTMLReportCreator";
-import { Report } from "../../model/Report";
-import { EmailReportViewModel } from "../../model/viewmodel/EmailReportViewModel";
 import { isNullOrUndefined } from "util";
 import { EmailSender } from "../../EmailSender";
 import { TelemetryLogger } from "../../telemetry/TelemetryLogger";
 
 const fs = require("fs");
-const js2xmlparser = require("js2xmlparser");
-
 const accessKey = process.env.AccessKey;
 const smtpUser = process.env.SMTPUSER;
 const smtpPassword = process.env.SMTPPASSWORD;
@@ -44,16 +39,6 @@ export class FileWriter {
   }
 }
 
-export class ReportCreatorWrapper implements IHTMLReportCreator {
-  createHtmlReport(report: Report, reportConfiguration: ReportConfiguration): string {
-    // Serialize gathered data into xml 
-    const xmlString: string = js2xmlparser.parse("EmailReportViewModel", new EmailReportViewModel(report, reportConfiguration));
-    FileWriter.writeToFile(xmlString, "reportViewModel.xml");
-    const actualCreator = new HTMLReportCreator();
-    return actualCreator.createHtmlReport(report, reportConfiguration);
-  }
-}
-
 export class MockConfigProvider implements IConfigurationProvider {
 
   getPipelineConfiguration(): PipelineConfiguration {
@@ -85,7 +70,7 @@ async function run(): Promise<void> {
   TelemetryLogger.LogTaskConfig(reportConfiguration);
   const reportManager = new ReportManager(
     new ReportProvider(new DataProviderFactory(configProvider.getPipelineConfiguration())),
-    new ReportCreatorWrapper(),
+    new HTMLReportCreator(),
     new EmailSender());
 
   reportManager.sendReportAsync(reportConfiguration);

Tasks/emailReportTask/utils/StringUtils.ts

@@ -26,7 +26,7 @@ export class StringUtils {
       return null;
     }
 
-    const lines = this.getNonEmptyLines(content);
+    const lines = this.getNonEmptyLines(content);    
     return lines.join("<br/>");
   }
 

Tasks/emailReportTask/vss-extension.json

@@ -2,7 +2,7 @@
   "manifestVersion": 1,
   "id": "EmailReportExtension",
   "name": "Email Report Extension",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "publisher": "epsteam",
   "targets": [
     {