From 4622309dc247ef7fcefc8dcca6d73ab07c44b3b6 Mon Sep 17 00:00:00 2001
From: Ray Bellis <ray@isc.org>
Date: Thu, 31 Jan 2019 13:42:41 +0000
Subject: [PATCH] TidyHtml.js: convert to promises

test case uses "nodeify" to convert the calls to TidyHtml back
into nodeback because it integrates better with the test framework
---
 src/node/utils/TidyHtml.js      | 59 +++++++++++++++++----------------
 tests/backend/specs/api/tidy.js | 10 ++++--
 2 files changed, 38 insertions(+), 31 deletions(-)

diff --git a/src/node/utils/TidyHtml.js b/src/node/utils/TidyHtml.js
index 0f7119894..26d48a62f 100644
--- a/src/node/utils/TidyHtml.js
+++ b/src/node/utils/TidyHtml.js
@@ -5,38 +5,39 @@
 var log4js = require('log4js');
 var settings = require('./Settings');
 var spawn = require('child_process').spawn;
-const thenify = require("thenify").withCallback;
 
-exports.tidy = thenify(function(srcFile, callback) {
+exports.tidy = function(srcFile) {
   var logger = log4js.getLogger('TidyHtml');
 
-  // Don't do anything if Tidy hasn't been enabled
-  if (!settings.tidyHtml) {
-    logger.debug('tidyHtml has not been configured yet, ignoring tidy request');
-    return callback(null);
-  }
+  return new Promise((resolve, reject) => {
 
-  var errMessage = '';
-
-  // Spawn a new tidy instance that cleans up the file inline
-  logger.debug('Tidying ' + srcFile);
-  var tidy = spawn(settings.tidyHtml, ['-modify', srcFile]);
-
-  // Keep track of any error messages
-  tidy.stderr.on('data', function (data) {
-    errMessage += data.toString();
-  });
-
-  // Wait until Tidy is done
-  tidy.on('close', function(code) {
-    // Tidy returns a 0 when no errors occur and a 1 exit code when
-    // the file could be tidied but a few warnings were generated
-    if (code === 0 || code === 1) {
-      logger.debug('Tidied ' + srcFile + ' successfully');
-      return callback(null);
-    } else {
-      logger.error('Failed to tidy ' + srcFile + '\n' + errMessage);
-      return callback('Tidy died with exit code ' + code);
+    // Don't do anything if Tidy hasn't been enabled
+    if (!settings.tidyHtml) {
+      logger.debug('tidyHtml has not been configured yet, ignoring tidy request');
+      return resolve(null);
     }
+
+    var errMessage = '';
+
+    // Spawn a new tidy instance that cleans up the file inline
+    logger.debug('Tidying ' + srcFile);
+    var tidy = spawn(settings.tidyHtml, ['-modify', srcFile]);
+
+    // Keep track of any error messages
+    tidy.stderr.on('data', function (data) {
+      errMessage += data.toString();
+    });
+
+    tidy.on('close', function(code) {
+      // Tidy returns a 0 when no errors occur and a 1 exit code when
+      // the file could be tidied but a few warnings were generated
+      if (code === 0 || code === 1) {
+        logger.debug('Tidied ' + srcFile + ' successfully');
+        resolve(null);
+      } else {
+        logger.error('Failed to tidy ' + srcFile + '\n' + errMessage);
+        reject('Tidy died with exit code ' + code);
+      }
+    });
   });
-});
+}
diff --git a/tests/backend/specs/api/tidy.js b/tests/backend/specs/api/tidy.js
index 6f38ac7b0..3ef61931b 100644
--- a/tests/backend/specs/api/tidy.js
+++ b/tests/backend/specs/api/tidy.js
@@ -1,10 +1,12 @@
 var assert = require('assert')
+        os = require('os'),
         fs = require('fs'),
       path = require('path'),
   TidyHtml = null,
   Settings = null;
 
 var npm = require("../../../../src/node_modules/npm/lib/npm.js");
+var nodeify = require('../../../../src/node_modules/nodeify');
 
 describe('tidyHtml', function() {
   before(function(done) {
@@ -16,6 +18,10 @@ describe('tidyHtml', function() {
     });
   });
 
+  function tidy(file, callback) {
+    return nodeify(TidyHtml.tidy(file), callback);
+  }
+
   it('Tidies HTML', function(done) {
     // If the user hasn't configured Tidy, we skip this tests as it's required for this test
     if (!Settings.tidyHtml) {
@@ -27,7 +33,7 @@ describe('tidyHtml', function() {
 
     var tmpFile = path.join(tmpDir, 'tmp_' + (Math.floor(Math.random() * 1000000)) + '.html')
     fs.writeFileSync(tmpFile, '<html><body><p>a paragraph</p><li>List without outer UL</li>trailing closing p</p></body></html>');
-    TidyHtml.tidy(tmpFile, function(err){
+    tidy(tmpFile, function(err){
       assert.ok(!err);
 
       // Read the file again
@@ -56,7 +62,7 @@ describe('tidyHtml', function() {
       this.skip();
     }
 
-    TidyHtml.tidy('/some/none/existing/file.html', function(err) {
+    tidy('/some/none/existing/file.html', function(err) {
       assert.ok(err);
       return done();
     });