test: fix flaky doctool and test

Trott · targos · commit b93c8a77a3ca · 2019-11-10T14:50:10.000+01:00
Doctool tests have been failing a lot in CI on Win2008 R2. It appears async functions and callback-based functions are being used in combination such that the callback-based function cannot guarantee that it will invoke its callback. Convert the callback-based functions to async functions so we have one paradigm and reliable results. PR-URL: #29979 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
diff --git a/test/doctool/test-doctool-html.js b/test/doctool/test-doctool-html.js
@@ -22,7 +22,7 @@ const remark2rehype = require('remark-rehype');
 const raw = require('rehype-raw');
 const htmlStringify = require('rehype-stringify');
 
-function toHTML({ input, filename, nodeVersion }, cb) {
+async function toHTML({ input, filename, nodeVersion }) {
   const content = unified()
     .use(markdown)
     .use(html.firstHeader)
@@ -34,10 +34,7 @@ function toHTML({ input, filename, nodeVersion }, cb) {
     .use(htmlStringify)
     .processSync(input);
 
-  html.toHTML(
-    { input, content, filename, nodeVersion },
-    cb
-  );
+  return html.toHTML({ input, content, filename, nodeVersion });
 }
 
 // Test data is a list of objects with two properties.
@@ -107,23 +104,16 @@ testData.forEach(({ file, html }) => {
   // Normalize expected data by stripping whitespace.
   const expected = html.replace(spaces, '');
 
-  readFile(file, 'utf8', common.mustCall((err, input) => {
+  readFile(file, 'utf8', common.mustCall(async (err, input) => {
     assert.ifError(err);
-    toHTML(
-      {
-        input: input,
-        filename: 'foo',
-        nodeVersion: process.version,
-      },
-      common.mustCall((err, output) => {
-        assert.ifError(err);
+    const output = await toHTML({ input: input,
+                                  filename: 'foo',
+                                  nodeVersion: process.version });
 
-        const actual = output.replace(spaces, '');
-        // Assert that the input stripped of all whitespace contains the
-        // expected markup.
-        assert(actual.includes(expected),
-               `ACTUAL: ${actual}\nEXPECTED: ${expected}`);
-      })
-    );
+    const actual = output.replace(spaces, '');
+    // Assert that the input stripped of all whitespace contains the
+    // expected markup.
+    assert(actual.includes(expected),
+           `ACTUAL: ${actual}\nEXPECTED: ${expected}`);
   }));
 });
diff --git a/tools/doc/generate.js b/tools/doc/generate.js
@@ -67,7 +67,7 @@ if (!filename) {
 }
 
 
-fs.readFile(filename, 'utf8', (er, input) => {
+fs.readFile(filename, 'utf8', async (er, input) => {
   if (er) throw er;
 
   const content = unified()
@@ -84,15 +84,10 @@ fs.readFile(filename, 'utf8', (er, input) => {
 
   const basename = path.basename(filename, '.md');
 
-  html.toHTML(
-    { input, content, filename, nodeVersion },
-    (err, html) => {
-      const target = path.join(outputDir, `${basename}.html`);
-      if (err) throw err;
-      fs.writeFileSync(target, html);
-    }
-  );
+  const myHtml = await html.toHTML({ input, content, filename, nodeVersion });
+  const htmlTarget = path.join(outputDir, `${basename}.html`);
+  fs.writeFileSync(htmlTarget, myHtml);
 
-  const target = path.join(outputDir, `${basename}.json`);
-  fs.writeFileSync(target, JSON.stringify(content.json, null, 2));
+  const jsonTarget = path.join(outputDir, `${basename}.json`);
+  fs.writeFileSync(jsonTarget, JSON.stringify(content.json, null, 2));
 });
diff --git a/tools/doc/html.js b/tools/doc/html.js
@@ -63,7 +63,7 @@ const gtocHTML = unified()
 const templatePath = path.join(docPath, 'template.html');
 const template = fs.readFileSync(templatePath, 'utf8');
 
-async function toHTML({ input, content, filename, nodeVersion }, cb) {
+async function toHTML({ input, content, filename, nodeVersion }) {
   filename = path.basename(filename, '.md');
 
   const id = filename.replace(/\W+/g, '-');
@@ -87,7 +87,7 @@ async function toHTML({ input, content, filename, nodeVersion }, cb) {
     HTML = HTML.replace('__ALTDOCS__', '');
   }
 
-  cb(null, HTML);
+  return HTML;
 }
 
 // Set the section name based on the first header.  Default to 'Index'.

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ const gtocHTML = unified()`
`63`	`63`	`const templatePath = path.join(docPath, 'template.html');`
`64`	`64`	`const template = fs.readFileSync(templatePath, 'utf8');`
`65`	`65`
`66`		`-async function toHTML({ input, content, filename, nodeVersion }, cb) {`
	`66`	`+async function toHTML({ input, content, filename, nodeVersion }) {`
`67`	`67`	`filename = path.basename(filename, '.md');`
`68`	`68`
`69`	`69`	`const id = filename.replace(/\W+/g, '-');`
`@@ -87,7 +87,7 @@ async function toHTML({ input, content, filename, nodeVersion }, cb) {`
`87`	`87`	`HTML = HTML.replace('__ALTDOCS__', '');`
`88`	`88`	`}`
`89`	`89`
`90`		`- cb(null, HTML);`
	`90`	`+ return HTML;`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`// Set the section name based on the first header. Default to 'Index'.`