Dusk waitForLocation error message should include the current location

[darynmitchell]

Currently, Dusk waitForLocation error message tells me that the test case run was not on the expected location, e.g.

Facebook\WebDriver\Exception\TimeoutException: Waited 10 seconds for location [/foo/1].

I would find the message much more helpful if it also told me what the actual location was, e.g.

Facebook\WebDriver\Exception\TimeoutException: Waited 10 seconds for location [/foo/1]. Actual 
location is [/bar/2].

Q: Would the team be open to changes in WaitsForElement to support this?

Example

I tried out a change locally and it seems "relatively simple" to support, by allowing the caller to optionally pass a message callback function (either instead of $message, or as an additional param), e.g. something like this:

public function waitUntil($script, $seconds = null, $message = null, $messageFn = null)
{
    ...
    return $this->waitUsing($seconds, 100, function () use ($script) {
        return $this->driver->executeScript($script);
    }, $messageFn ? $messageFn() : $message);
}

public function waitForLocation($path, $seconds = null)
{
    $messageFn = function () use ($path): string {
        $actual = $this->getCurrentRelativeURL();
        return $this->formatTimeOutMessage('Waited %s seconds for location', $path) . " Actual location is [$actual].";
    };

    return Str::startsWith($path, ['http://', 'https://'])
        ? $this->waitUntil('`${location.protocol}//${location.host}${location.pathname}` == \''.$path.'\'', $seconds, $message)
        : $this->waitUntil("window.location.pathname == '{$path}'", $seconds, null, $messageFn);
}

private function getCurrentRelativeURL(): string {
    $parts = parse_url($this->driver->getCurrentURL());
    $query = Arr::get($parts, 'query', '');
    $fragment = Arr::get($parts, 'fragment', '');
    return $parts ? Arr::get($parts, 'path', '') . ($query ? "?$query" : '') . ($fragment ? "#$fragment" : '') : 'ERROR';
}