Added feature of metadata deploy result panel

xgeek-net · xgeek-net · commit 6a5aa9da342f · 2019-01-07T22:47:17.000+09:00
Fixed bug of custom fields metadata query
diff --git a/bower.json b/bower.json
@@ -17,6 +17,7 @@
     "font-awesome": "^5.0.13",
     "moment": "^2.22.2",
     "js-xlsx": "^0.14.0",
-    "xlsx-populate": "^1.17.0"
+    "xlsx-populate": "^1.17.0",
+    "progressbar.js": "^1.0.1"
   }
 }
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "pipeline",
   "description": "Be less busy, less mistake in Salesforce metadata deploy",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "private": false,
   "main": "src/main.js",
   "dependencies": {
diff --git a/src/class/Pipeline.js b/src/class/Pipeline.js
@@ -173,19 +173,58 @@ class Pipeline {
       ev.sender.send('data-pipeline-log-callback',utils.serialize(err), result);
     }
     try{
-      let index = 1;
-      
+      let pipeline = this.storage.get(arg.id);
+      if(pipeline.deployResult && pipeline.deployResult.done != true) {
+        // Uncompleted deploy, clean cache and reload
+        this.storage.getAll({ cache : false }); 
+        pipeline = this.storage.get(arg.id);
+      }
       const metadata = new Metadata();
       const pPath = metadata.getPipelineFolder();
-      const logPath = path.join(pPath, arg.id, 'pipeline.log');
+      const logPath = path.join(pPath, pipeline.id, 'pipeline.log');
       if(!fs.existsSync(logPath)) {
         return callback(null);
       }
       fs.readFile(logPath, 'utf-8', function(err, data) {
         //console.log('>>> getPipelineLog' + index, (new Date()));
-        index++;
         if(err) return callback(err);
-        const result = data;
+        // read deployResult
+        const drPath = path.join(pPath, pipeline.id, 'deployResult.json');
+        let deployResult = {};
+        if(fs.existsSync(drPath)) {
+          deployResult = JSON.parse(fs.readFileSync(drPath));
+        }
+        const result = { body : data, deployResult : deployResult };
+        return callback(null, result);
+      });
+    }catch(err) {
+      console.error('[ERROR]', err);
+      Raven.captureException(err);
+      return callback(err);
+    }
+  }
+
+  /**
+   * Export pipeline metadata zip file
+   * @param {Object} ev 
+   * @param {Object} arg 
+   */
+  exportMetadata(ev, arg) {
+    const callback = function(err, result) {
+      ev.sender.send('data-pipeline-export-metadata-callback',utils.serialize(err), result);
+    }
+    try{
+      const metadata = new Metadata();
+      const pPath = metadata.getPipelineFolder();
+      const packagePath = path.join(pPath, arg.id, 'package.zip');
+      if(!fs.existsSync(packagePath)) {
+        return callback(null);
+      }
+      fs.readFile(packagePath, 'base64', function(err, data) {
+        //new Buffer(data).toString('base64')
+        //console.log('>>> getPipelineLog' + index, (new Date()));
+        if(err) return callback(err);
+        const result = { data : data };
         return callback(null, result);
       });
     }catch(err) {
@@ -229,6 +268,7 @@ class Pipeline {
       const pPath = metadata.mkdirPipelineFolder(pipeline.id);
 
       const logPath = path.join(pPath, 'pipeline.log');
+      const deployResultPath = path.join(pPath, 'deployResult.json');
       const pipelineLog = function(line) {
         line = moment().format('HH:mm:ss') + ' ' + line + '\n';
         fs.appendFileSync(logPath, line);
@@ -288,20 +328,22 @@ class Pipeline {
           // Do Destruct
           opts['purgeOnDelete'] = true;
           return metadata.deploy(fromConn, zipPath, opts, function(deployResult) {
+            deployResult = self.saveDeployResult(deployResultPath, fromConn, deployResult);
             self.outputDeployProcessLog(pipelineLog, deployResult);
           });
         } else {
           // Do Deploy
           opts['runAllTests'] = (pipeline.runTests === true);
           return metadata.deploy(toConn, zipPath, opts, function(deployResult) {
+            deployResult = self.saveDeployResult(deployResultPath, toConn, deployResult);
             self.outputDeployProcessLog(pipelineLog, deployResult);
           });
         }
       })
       .then(function(deployResult) {
         // Save deploy result
         const targetConn = (pipeline.action == 'destruct') ? fromConn : toConn;
-        deployResult['url'] = targetConn.instanceUrl + '/changemgmt/monitorDeploymentsDetails.apexp?asyncId=' + deployResult.id
+        deployResult = self.saveDeployResult(deployResultPath, targetConn, deployResult);
         self.outputDeployLog(pipelineLog, deployResult);
         const now = new Date();
         const endTime = now.toISOString();
@@ -366,18 +408,53 @@ class Pipeline {
    * @param {Object} deployResult 
    */
   outputDeployLog(pipelineLog, deployResult) {
-    pipelineLog('[Metadata] Deploy Done : ');
-    //pipelineLog('           Id: ' + deployResult.id);
-    pipelineLog('           Success: ' + deployResult.success);
-    pipelineLog('           Components Total: ' + deployResult.numberComponentsTotal);
-    pipelineLog('           Components Error: ' + deployResult.numberComponentErrors);
-    pipelineLog('           Components Deployed: ' + deployResult.numberComponentsDeployed);
-    pipelineLog('           Tests Total: ' + deployResult.numberTestsTotal);
-    pipelineLog('           Tests Error: ' + deployResult.numberTestErrors);
-    pipelineLog('           Tests Completed: ' + deployResult.numberTestsCompleted);
+    pipelineLog('[Metadata] Deploy done');
     pipelineLog('[Metadata] Deploy result: @see ' + deployResult.url);
   }
 
+  /**
+   * Set component type label to deploy result and export to json file
+   */
+  saveDeployResult(filePath, targetConn, deployResult) {
+    // Set Entity Label to deployResult
+    const sfdcApi = new SfdcApi(targetConn);
+    const componentLables = sfdcApi.getComponentLabels(targetConn.language);
+    deployResult['instanceUrl'] = targetConn.instanceUrl;
+    deployResult['url'] = targetConn.instanceUrl + '/changemgmt/monitorDeploymentsDetails.apexp?asyncId=' + deployResult.id
+
+    const getStatus = function(cmp) {
+      let status = 'No Change';
+      if(cmp.changed == 'true') status = 'Updated';
+      if(cmp.created == 'true') status = 'Created';
+      if(cmp.deleted == 'true') status = 'Deleted';
+      if(cmp.problem && cmp.problemType) {
+        status = 'Error: ' + cmp.problem + ' (line ' + (cmp.lineNumber || 0) + ', column ' + (cmp.columnNumber || 0) + ')';
+      }
+      return status;
+    }
+
+    if(deployResult.details && deployResult.details.componentSuccesses) {
+      for(let i = 0; i < deployResult.details.componentSuccesses.length; i++) {
+        let componentType = deployResult.details.componentSuccesses[i].componentType;
+        if(utils.isBlank(componentType)) continue;
+        if(!componentLables.hasOwnProperty(componentType)) continue;
+        deployResult.details.componentSuccesses[i]['componentTypeLabel'] = componentLables[componentType];
+        deployResult.details.componentSuccesses[i]['status'] = getStatus(deployResult.details.componentSuccesses[i]);
+      }
+    }
+    if(deployResult.details && deployResult.details.componentFailures) {
+      for(let i = 0; i < deployResult.details.componentFailures.length; i++) {
+        let componentType = deployResult.details.componentFailures[i].componentType;
+        if(utils.isBlank(componentType)) continue;
+        if(!componentLables.hasOwnProperty(componentType)) continue;
+        deployResult.details.componentFailures[i]['componentTypeLabel'] = componentLables[componentType];
+        deployResult.details.componentSuccesses[i]['status'] = getStatus(deployResult.details.componentSuccesses[i]);
+      }
+    }
+    fs.writeFileSync(filePath, JSON.stringify(deployResult));
+    return deployResult;
+  }
+
 }
 
 module.exports = Pipeline;
diff --git a/src/class/SfdcApi.js b/src/class/SfdcApi.js
@@ -468,6 +468,9 @@ class SfdcApi {
       let metaType;
       if(!Array.isArray(metadata)) console.log('[ERROR]', metadata);
       for(let meta of metadata) {
+        // Filter object which has not fields, 
+        // to fix sf:UNKNOWN_EXCEPTION: UNKNOWN_EXCEPTION bug
+        if(!objLabelMap.hasOwnProperty(meta.fullName)) continue;
         metaType = meta.type;
         fullNames.push(meta.fullName);
       }
diff --git a/src/main.js b/src/main.js
@@ -119,6 +119,9 @@ ipc.on('data-pipelines', (event, arg) => {
 ipc.on('data-pipeline-log', (event, arg) => {
   pipeline.getPipelineLog(event, arg);
 });
+ipc.on('data-pipeline-export-metadata', (event, arg) => {
+  pipeline.exportMetadata(event, arg);
+});
 ipc.on('pipeline-run', (event, arg) => {
   pipeline.runPipeline(event, arg);
 });
diff --git a/src/view/css/style.css b/src/view/css/style.css
@@ -98,6 +98,14 @@
 #sidebar .sidebar-body .menu-button .slds-icon {
   fill: #16325c;
 }
+#sidebar .sidebar-body .menu.fix-bottom {
+  position: absolute;
+  bottom: 5px;
+}
+#sidebar .sidebar-body .menu.fix-bottom .github-button{
+  font-size: 1.4rem;
+}
+
 /**
  * #main
  */
@@ -443,23 +451,107 @@
 .pipeline-detail .detail-header .status .duration{
   margin-right: 0.5rem;
 }
-.pipeline-detail .detail-body{
+/** .detail-process-panel */
+.pipeline-detail .detail-process-panel{
+  margin: 0.5rem;
+  height: 200px;
+  background-color: #F4F6F9;
+  color: #514f4d;
+  font-size: 0.9rem;
+  line-height: 1.5rem;
+}
+.pipeline-detail .detail-process-panel .slds-card__body {
+  margin-bottom: 0px;
+}
+.pipeline-detail .detail-process-panel .process-detail,
+.pipeline-detail .detail-process-panel .component-progress,
+.pipeline-detail .detail-process-panel .testclass-progress {
+  padding: 18px 5px 18px 18px;
+}
+.pipeline-detail .detail-process-panel .progressbar__label {
+  line-height: 1.2;
+}
+.pipeline-detail .detail-process-panel .process-detail label {
+  color: #16325c;
+}
+.pipeline-detail .detail-process-panel .component-progress {
+  border-left: 1px solid #d8dde6;
+  height: 100%;
+}
+.pipeline-detail .detail-process-panel .circle {
+  width: 120px;
+  height: 120px;
+  text-align: center;
+  margin: 0 auto;
+}
+.pipeline-detail .detail-process-panel .circle > svg {
+  width: 100%;
+  display: block;
+}
+.pipeline-detail .detail-process-panel h3.title {
+  text-align: center;
+  margin-top: 1rem;
+  font-size: 1.1rem;
+}
+
+/** .detail-process-panel */
+.pipeline-detail .detail-component-panel {
+  margin: 0.5rem;
+  background-color: #F4F6F9;
+  color: #514f4d;
+  height: calc(100% - 224px);   /* 200px + 24px */
+  overflow-y: auto;
+}
+.pipeline-detail .detail-component-panel .slds-card__header {
+  padding-top: 0.5rem;
+  margin-bottom: 0.5rem;
+}
+
+.pipeline-detail .detail-component-panel .slds-truncate {
+  white-space: normal;
+  min-height: 1rem;
+}
+
+.pipeline-detail .pipeline-log{
+  position: relative;
   display: block;
   height: calc(100% - 50px);
-  padding: 0.5rem 1rem;
-  line-height: 1.25rem;
-  overflow-y: scroll;
+  overflow: hidden;
 }
-.pipeline-detail .detail-body p{
+.pipeline-detail .pipeline-log.collapsed {
+  height: 110px;
+}
+.pipeline-detail .pipeline-log > .btn-collapse {
+  position: absolute;
+  right: 3px;
+  top: 3px;
+  padding: 3px;
+}
+.pipeline-detail .pipeline-log p{
   word-wrap: break-word;
   word-break: break-all;
+  display: block;
+  height: 100%;
+  overflow-y: auto;
+  padding: 0.5rem 1rem;
+  line-height: 1.25rem;
 }
-.pipeline-detail .detail-body p > a,
-.pipeline-detail .detail-body p > a:hover,
-.pipeline-detail .detail-body p > a:focus{
+.pipeline-detail .pipeline-log p > a,
+.pipeline-detail .pipeline-log p > a:hover,
+.pipeline-detail .pipeline-log p > a:focus{
   color: #dce5f5;
   text-decoration: underline;
 }
+/* Detail body */
+.pipeline-detail .detail-body {
+  height: calc(100% - 160px);
+  overflow: hidden;
+  border-bottom: 1px solid #d8dde6;
+}
+.pipeline-detail .detail-body .btn-export-metadata {
+  margin-top: 0.5rem;
+}
+
 #main .pipeline-detail .pipeline-status.success{
   color: #4bc076;
 }
diff --git a/src/view/index.html b/src/view/index.html
@@ -46,6 +46,7 @@ <h1 class="">{{ page.title }}</h1>
   <script type="text/javascript" src="components/moment/min/moment-with-locales.min.js"></script>
   <script type="text/javascript" src="components/xlsx-populate/browser/xlsx-populate.min.js"></script>
   <script type="text/javascript" src="components/js-xlsx/dist/xlsx.full.min.js"></script>
+  <script type="text/javascript" src="components/progressbar.js/dist/progressbar.min.js"></script>
   <script type="text/javascript" src="js/include/ExcelHandler.js"></script>
   <script type="text/javascript" src="js/include/master.js"></script>
   <script type="text/javascript" src="js/include/ga.js"></script>
diff --git a/src/view/js/vue-components/app-pipeline-detail.js b/src/view/js/vue-components/app-pipeline-detail.js
diff --git a/src/view/js/vue-components/app-sidebar.js b/src/view/js/vue-components/app-sidebar.js

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`"font-awesome": "^5.0.13",`
`18`	`18`	`"moment": "^2.22.2",`
`19`	`19`	`"js-xlsx": "^0.14.0",`
`20`		`- "xlsx-populate": "^1.17.0"`
	`20`	`+ "xlsx-populate": "^1.17.0",`
	`21`	`+ "progressbar.js": "^1.0.1"`
`21`	`22`	`}`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "pipeline",`
`3`	`3`	`"description": "Be less busy, less mistake in Salesforce metadata deploy",`
`4`		`- "version": "1.2.0",`
	`4`	`+ "version": "1.3.0",`
`5`	`5`	`"private": false,`
`6`	`6`	`"main": "src/main.js",`
`7`	`7`	`"dependencies": {`