From 253b42372f05f38c57da95fa174eed92d7ff863a Mon Sep 17 00:00:00 2001
From: Matt Friedman <maf675@gmail.com>
Date: Wed, 3 Oct 2018 18:50:30 -0700
Subject: [PATCH] [ticket/15824] Add UI test method to wait for AJAX requests

PHPBB3-15824
---
 tests/test_framework/phpbb_ui_test_case.php | 33 +++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/tests/test_framework/phpbb_ui_test_case.php b/tests/test_framework/phpbb_ui_test_case.php
index d16ac78c4b..15a1cd375e 100644
--- a/tests/test_framework/phpbb_ui_test_case.php
+++ b/tests/test_framework/phpbb_ui_test_case.php
@@ -606,4 +606,37 @@ class phpbb_ui_test_case extends phpbb_test_case
 
 		$this->getDriver()->takeScreenshot($screenshot);
 	}
+
+	/**
+	 * Wait for AJAX. Should be called after an AJAX action is made.
+	 *
+	 * @param string $framework javascript frameworks jquery|prototype|dojo
+	 * @throws \Facebook\WebDriver\Exception\NoSuchElementException
+	 * @throws \Facebook\WebDriver\Exception\TimeOutException
+	 */
+	public function waitForAjax($framework = 'jquery')
+	{
+		switch ($framework)
+		{
+			case 'jquery':
+				$code = 'return jQuery.active;';
+			break;
+			case 'prototype':
+				$code = 'return Ajax.activeRequestCount;';
+			break;
+			case 'dojo':
+				$code = 'return dojo.io.XMLHTTPTransport.inFlight.length;';
+			break;
+			default:
+				throw new \RuntimeException('Unsupported framework');
+			break;
+		}
+		// wait for at most 30s, retry every 2000ms (2s)
+		$driver = $this->getDriver();
+		$driver->wait(30, 2000)->until(
+			function () use ($driver, $code) {
+				return !$driver->executeScript($code);
+			}
+		);
+	}
 }