libre-service.eu/pad.libre-service.eu-etherpad
libre-service.eu/pad.libre-service.eu-etherpad
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-01-31 19:02:59 +01:00
Code Issues Projects Releases Wiki Activity

TidyHtml.js: convert to promises

Browse source 
test case uses "nodeify" to convert the calls to TidyHtml back
into nodeback because it integrates better with the test framework
This commit is contained in:
Ray Bellis 2019-01-31 13:42:41 +00:00
parent 6d1b6b2796
commit 4622309dc2
2 changed files with 38 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
src/node/utils/TidyHtml.js
View file

@ -5,38 +5,39 @@
var log4js = require('log4js'); var log4js = require('log4js');
var settings = require('./Settings'); var settings = require('./Settings');
var spawn = require('child_process').spawn; 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'); var logger = log4js.getLogger('TidyHtml');
// Don't do anything if Tidy hasn't been enabled return new Promise((resolve, reject) => {
if (!settings.tidyHtml) {
logger.debug('tidyHtml has not been configured yet, ignoring tidy request');
return callback(null);
}
var errMessage = ''; // Don't do anything if Tidy hasn't been enabled
if (!settings.tidyHtml) {
// Spawn a new tidy instance that cleans up the file inline logger.debug('tidyHtml has not been configured yet, ignoring tidy request');
logger.debug('Tidying ' + srcFile); return resolve(null);
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);
} }
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);
}
});
}); });
}); }

10
tests/backend/specs/api/tidy.js
View file

@ -1,10 +1,12 @@
var assert = require('assert') var assert = require('assert')
os = require('os'),
fs = require('fs'), fs = require('fs'),
path = require('path'), path = require('path'),
TidyHtml = null, TidyHtml = null,
Settings = null; Settings = null;
var npm = require("../../../../src/node_modules/npm/lib/npm.js"); var npm = require("../../../../src/node_modules/npm/lib/npm.js");
var nodeify = require('../../../../src/node_modules/nodeify');
describe('tidyHtml', function() { describe('tidyHtml', function() {
before(function(done) { 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) { it('Tidies HTML', function(done) {
// If the user hasn't configured Tidy, we skip this tests as it's required for this test // If the user hasn't configured Tidy, we skip this tests as it's required for this test
if (!Settings.tidyHtml) { if (!Settings.tidyHtml) {
@ -27,7 +33,7 @@ describe('tidyHtml', function() {
var tmpFile = path.join(tmpDir, 'tmp_' + (Math.floor(Math.random() * 1000000)) + '.html') 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>'); 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); assert.ok(!err);
// Read the file again // Read the file again
@ -56,7 +62,7 @@ describe('tidyHtml', function() {
this.skip(); this.skip();
} }
TidyHtml.tidy('/some/none/existing/file.html', function(err) { tidy('/some/none/existing/file.html', function(err) {
assert.ok(err); assert.ok(err);
return done(); return done();
}); });