From d3bf013ceb1f31d81842b5abc9e49181f33f753a Mon Sep 17 00:00:00 2001
From: Daniel Imms <daimms@microsoft.com>
Date: Sat, 9 Nov 2019 13:57:42 -0800
Subject: [PATCH] Fix timing issues in web links addon tests

---
 .../xterm-addon-attach/src/AttachAddon.api.ts |  2 -
 .../src/WebLinksAddon.api.ts                  | 38 +++++++++++++------
 2 files changed, 26 insertions(+), 14 deletions(-)

diff --git a/addons/xterm-addon-attach/src/AttachAddon.api.ts b/addons/xterm-addon-attach/src/AttachAddon.api.ts
index 627647cd..264b32ee 100644
--- a/addons/xterm-addon-attach/src/AttachAddon.api.ts
+++ b/addons/xterm-addon-attach/src/AttachAddon.api.ts
@@ -43,7 +43,6 @@ describe('AttachAddon', () => {
     server.on('connection', socket => socket.send('foo'));
     await page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
     await pollFor(page, `window.term.buffer.getLine(0).translateToString(true)`, 'foo');
-    assert.equal(await page.evaluate(`window.term.buffer.getLine(0).translateToString(true)`), 'foo');
     server.close();
   });
 
@@ -56,7 +55,6 @@ describe('AttachAddon', () => {
     server.on('connection', socket => socket.send(data));
     await page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
     await pollFor(page, `window.term.buffer.getLine(0).translateToString(true)`, 'foo');
-    assert.equal(await page.evaluate(`window.term.buffer.getLine(0).translateToString(true)`), 'foo');
     server.close();
   });
 });
diff --git a/addons/xterm-addon-web-links/src/WebLinksAddon.api.ts b/addons/xterm-addon-web-links/src/WebLinksAddon.api.ts
index 2a3fd199..49ec4fee 100644
--- a/addons/xterm-addon-web-links/src/WebLinksAddon.api.ts
+++ b/addons/xterm-addon-web-links/src/WebLinksAddon.api.ts
@@ -19,7 +19,6 @@ describe('WebLinksAddon', () => {
     this.timeout(10000);
     browser = await puppeteer.launch({
       headless: process.argv.indexOf('--headless') !== -1,
-      slowMo: 0,
       args: [`--window-size=${width},${height}`, `--no-sandbox`]
     });
     page = (await browser.pages())[0];
@@ -54,22 +53,25 @@ describe('WebLinksAddon', () => {
 async function testHostName(hostname: string): Promise<void> {
   await openTerminal({ rendererType: 'dom' });
   await page.evaluate(`window.term.loadAddon(new window.WebLinksAddon())`);
+  await new Promise<void>(r => setTimeout(r, 100));
   await page.evaluate(`
+    window.ready = false;
     window.term.writeln('  http://${hostname}  ');
     window.term.writeln('  http://${hostname}/a~b#c~d?e~f  ');
     window.term.writeln('  http://${hostname}/colon:test  ');
     window.term.writeln('  http://${hostname}/colon:test:  ');
     window.term.writeln('"http://${hostname}/"');
     window.term.writeln('\\'http://${hostname}/\\'');
-    window.term.writeln('http://${hostname}/subpath/+/id');
+    window.term.writeln('http://${hostname}/subpath/+/id', () => window.ready = true);
   `);
-  assert.equal(await getLinkAtCell(3, 1), `http://${hostname}`);
-  assert.equal(await getLinkAtCell(3, 2), `http://${hostname}/a~b#c~d?e~f`);
-  assert.equal(await getLinkAtCell(3, 3), `http://${hostname}/colon:test`);
-  assert.equal(await getLinkAtCell(3, 4), `http://${hostname}/colon:test`);
-  assert.equal(await getLinkAtCell(2, 5), `http://${hostname}/`);
-  assert.equal(await getLinkAtCell(2, 6), `http://${hostname}/`);
-  assert.equal(await getLinkAtCell(1, 7), `http://${hostname}/subpath/+/id`);
+  await pollFor(page, 'window.ready', true);
+  await pollForLinkAtCell(3, 1, `http://${hostname}`);
+  await pollForLinkAtCell(3, 2, `http://${hostname}/a~b#c~d?e~f`);
+  await pollForLinkAtCell(3, 3, `http://${hostname}/colon:test`);
+  await pollForLinkAtCell(3, 4, `http://${hostname}/colon:test`);
+  await pollForLinkAtCell(2, 5, `http://${hostname}/`);
+  await pollForLinkAtCell(2, 6, `http://${hostname}/`);
+  await pollForLinkAtCell(1, 7, `http://${hostname}/subpath/+/id`);
 }
 
 async function openTerminal(options: ITerminalOptions = {}): Promise<void> {
@@ -82,8 +84,20 @@ async function openTerminal(options: ITerminalOptions = {}): Promise<void> {
   }
 }
 
-async function getLinkAtCell(col: number, row: number): Promise<string> {
+async function pollForLinkAtCell(col: number, row: number, value: string): Promise<void> {
   const rowSelector = `.xterm-rows > :nth-child(${row})`;
-  await page.hover(`${rowSelector} > :nth-child(${col})`);
-  return await page.evaluate(`Array.prototype.reduce.call(document.querySelectorAll('${rowSelector} > span[style]'), (a, b) => a + b.textContent, '');`);
+  await pollFor(page, `document.querySelectorAll('${rowSelector} > span[style]').length > 0`, true, async () => page.hover(`${rowSelector} > :nth-child(${col})`));
+  assert.equal(await page.evaluate(`Array.prototype.reduce.call(document.querySelectorAll('${rowSelector} > span[style]'), (a, b) => a + b.textContent, '');`), value);
+}
+
+async function pollFor(page: puppeteer.Page, fn: string, val: any, preFn?: () => Promise<void>): Promise<void> {
+  if (preFn) {
+    await preFn();
+  }
+  const result = await page.evaluate(fn);
+  if (result !== val) {
+    return new Promise<void>(r => {
+      setTimeout(() => r(pollFor(page, fn, val, preFn)), 10);
+    });
+  }
 }