Fixed timeout error message that contain percent characters when calling waitForTextIn (#1029)

* Added test that shows problem with waitForTextIn timeout error message

* Added fix for waitForTextIn timeout error messages containing a percent character

* Removed code duplication

* Added tests for other methods

* Update WaitsForElements.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: voidgraphics

src/Concerns/WaitsForElements.php

@@ -123,7 +123,7 @@ public function waitForText($text, $seconds = null)
      */
     public function waitForTextIn($selector, $text, $seconds = null)
     {
-        $message = 'Waited %s seconds for text "'.$text.'" in selector '.$selector;
+        $message = 'Waited %s seconds for text "'.$this->escapePercentCharacters($text).'" in selector '.$selector;
 
         return $this->waitUsing($seconds, 100, function () use ($selector, $text) {
             return $this->assertSeeIn($selector, $text);
@@ -427,6 +427,17 @@ public function waitUsing($seconds, $interval, Closure $callback, $message = nul
      */
     protected function formatTimeOutMessage($message, $expected)
     {
-        return $message.' ['.str_replace('%', '%%', $expected).'].';
+        return $message.' ['.$this->escapePercentCharacters($expected).'].';
+    }
+
+    /**
+     * Escape percent characters in preparation for sending the given message to "sprintf".
+     *
+     * @param  string  $message
+     * @return string
+     */
+    protected function escapePercentCharacters($message)
+    {
+        return str_replace('%', '%%', $message);
     }
 }

tests/WaitsForElementsTest.php

@@ -195,6 +195,24 @@ public function test_wait_until_missing()
         $browser->waitUntilMissing('foo');
     }
 
+    public function test_wait_until_missing_text_failure_message_containing_a_percent_character()
+    {
+        $element = m::mock(stdClass::class);
+        $element->shouldReceive('getText')->andReturn('Discount: 20%');
+
+        $resolver = m::mock(stdClass::class);
+        $resolver->shouldReceive('findOrFail')->with('')->andReturn($element);
+
+        $browser = new Browser(new stdClass, $resolver);
+
+        try {
+            $browser->waitUntilMissingText('Discount: 20%', 1);
+            $this->fail('waitUntilMissingText() did not timeout.');
+        } catch (TimeOutException $e) {
+            $this->assertSame('Waited 1 seconds for removal of text [Discount: 20%].', $e->getMessage());
+        }
+    }
+
     public function test_wait_for_text_failure_message_containing_a_percent_character()
     {
         $element = m::mock(stdClass::class);
@@ -213,6 +231,57 @@ public function test_wait_for_text_failure_message_containing_a_percent_characte
         }
     }
 
+    public function test_wait_for_text_in_failure_message_containing_a_percent_character()
+    {
+        $element = m::mock(stdClass::class);
+        $element->shouldReceive('getText')->andReturn('Discount: None');
+
+        $resolver = m::mock(stdClass::class);
+        $resolver->shouldReceive('format')->with('foo')->andReturn('body foo');
+        $resolver->shouldReceive('findOrFail')->with('foo')->andReturn($element);
+
+        $browser = new Browser(new stdClass, $resolver);
+
+        try {
+            $browser->waitForTextIn('foo', 'Discount: 20%', 1);
+            $this->fail('waitForTextIn() did not timeout.');
+        } catch (TimeOutException $e) {
+            $this->assertSame('Waited 1 seconds for text "Discount: 20%" in selector foo', $e->getMessage());
+        }
+    }
+
+    public function test_wait_for_link_failure_message_containing_a_percent_character()
+    {
+        $driver = m::mock(stdClass::class);
+        $driver->shouldReceive('executeScript')
+            ->andReturnFalse();
+
+        $browser = new Browser($driver);
+
+        try {
+            $browser->waitForLink('https://laravel.com?q=foo%20bar', 1);
+            $this->fail('waitForLink() did not timeout.');
+        } catch (TimeOutException $e) {
+            $this->assertSame('Waited 1 seconds for link [https://laravel.com?q=foo%20bar].', $e->getMessage());
+        }
+    }
+
+    public function test_wait_for_location_failure_message_containing_a_percent_character()
+    {
+        $driver = m::mock(stdClass::class);
+        $driver->shouldReceive('executeScript')
+            ->andReturnFalse();
+
+        $browser = new Browser($driver);
+
+        try {
+            $browser->waitForLocation('https://laravel.com?q=foo%20bar', 1);
+            $this->fail('waitForLocation() did not timeout.');
+        } catch (TimeOutException $e) {
+            $this->assertSame('Waited 1 seconds for location [https://laravel.com?q=foo%20bar].', $e->getMessage());
+        }
+    }
+
     public function test_wait_for_an_element_to_be_enabled()
     {
         $element = m::mock(stdClass::class);