BasicContext.php

<?php

namespace SilverStripe\BehatExtension\Context;

use Exception;
use InvalidArgumentException;
use Behat\Behat\Context\Context;
use Behat\Behat\Context\Environment\InitializedContextEnvironment;
use Behat\Behat\Hook\Scope\AfterScenarioScope;
use Behat\Behat\Hook\Scope\AfterStepScope;
use Behat\Behat\Hook\Scope\BeforeScenarioScope;
use Behat\Behat\Hook\Scope\BeforeStepScope;
use Behat\Mink\Driver\Selenium2Driver;
use Behat\Mink\Element\ElementInterface;
use Behat\Mink\Element\NodeElement;
use Behat\Mink\Exception\ElementNotFoundException;
use Behat\Mink\Session;
use Behat\Testwork\Tester\Result\TestResult;
use Facebook\WebDriver\Exception\WebDriverException;
use Facebook\WebDriver\WebDriver;
use Facebook\WebDriver\WebDriverAlert;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverExpectedCondition;
use Facebook\WebDriver\WebDriverKeys;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\ExpectationFailedException;
use SilverStripe\Assets\File;
use SilverStripe\Assets\Filesystem;
use SilverStripe\BehatExtension\Utility\StepHelper;
use SilverStripe\BehatExtension\Utility\DebugTools;
use SilverStripe\MinkFacebookWebDriver\FacebookWebDriver;

/**
 * BasicContext
 *
 * Context used to define generic steps like following anchors or pressing buttons.
 * Handles timeouts.
 * Handles redirections.
 * Handles AJAX enabled links, buttons and forms - jQuery is assumed.
 */
class BasicContext implements Context
{
    use MainContextAwareTrait;
    use StepHelper;
    use DebugTools;

    /**
     * Date format in date() syntax
     *
     * @var string
     */
    protected $dateFormat = 'Y-m-d';

    /**
     * Time format in date() syntax
     * @var String
     */
    protected $timeFormat = 'H:i:s';

    /**
     * Date/time format in date() syntax
     * @var String
     */
    protected $datetimeFormat = 'Y-m-d H:i:s';

    /**
     * @var FixtureContext
     */
    protected $fixtureContext = null;

    /**
     * Get the fixture context of the current module
     *
     * @BeforeScenario
     */
    public function gatherContexts(BeforeScenarioScope $scope): void
    {
        /** @var InitializedContextEnvironment $environment */
        $environment = $scope->getEnvironment();

        // Find the FixtureContext defined in behat.yml
        $subClasses = $this->getSubclassesOf(FixtureContext::class);
        foreach ($subClasses as $class) {
            if (!$environment->hasContextClass($class)) {
                continue;
            }
            $this->fixtureContext = $environment->getContext($class);
            break;
        }
        // Fallback to base FixtureClass
        if (!$this->fixtureContext && $environment->hasContextClass(FixtureContext::class)) {
            $this->fixtureContext = $environment->getContext(FixtureContext::class);
        }
    }

    /**
     * Gets the subclasses of a class
     */
    private function getSubclassesOf($parent): array
    {
        $result = [];
        foreach (get_declared_classes() as $class) {
            if (is_subclass_of($class, $parent ?? '')) {
                $result[] = $class;
            }
        }
        return $result;
    }

    /**
     * Get Mink session from MinkContext
     *
     * @param string $name
     * @return Session
     */
    public function getSession($name = null)
    {
        /** @var SilverStripeContext $context */
        $context = $this->getMainContext();
        return $context->getSession($name);
    }

    /**
     * @AfterStep
     *
     * Excluding scenarios with @modal tag is required,
     * because modal dialogs stop any JS interaction
     *
     * @param AfterStepScope $event
     */
    public function appendErrorHandlerBeforeStep(AfterStepScope $event)
    {
        // Manually exclude @modal
        if ($this->stepHasTag($event, 'modal')) {
            return;
        }

        try {
            $javascript = <<<JS
window.onerror = function(message, file, line, column, error) {
    var body = document.getElementsByTagName('body')[0];
	var msg = message + " in " + file + ":" + line + ":" + column;
	if(error !== undefined && error.stack !== undefined) {
		msg += "\\nSTACKTRACE:\\n" + error.stack;
	}
    body.setAttribute('data-jserrors', '[captured JavaScript error] ' + msg);
};
if ('undefined' !== typeof window.jQuery) {
    window.jQuery('body').ajaxError(function(event, jqxhr, settings, exception) {
        if ('abort' === exception) {
            return;
        }
        window.onerror(event.type + ': ' + settings.type + ' ' + settings.url + ' ' + exception + ' ' + jqxhr.responseText);
    });
}
JS;

            $this->getSession()->executeScript($javascript);
        } catch (WebDriverException $e) {
            $this->logException($e);
        }
    }

    /**
     * @AfterStep
     *
     * Excluding scenarios with @modal tag is required,
     * because modal dialogs stop any JS interaction
     *
     * @param AfterStepScope $event
     */
    public function readErrorHandlerAfterStep(AfterStepScope $event)
    {
        // Manually exclude @modal
        if ($this->stepHasTag($event, 'modal')) {
            return;
        }
        try {
            $page = $this->getSession()->getPage();

            $jserrors = $page->find('xpath', '//body[@data-jserrors]');
            if (null !== $jserrors) {
                $this->takeScreenshot($event);
                $this->logMessage($jserrors->getAttribute('data-jserrors'));
            }

            $javascript = <<<JS
if ('undefined' !== typeof window.jQuery) {
	window.jQuery(document).ready(function() {
		window.jQuery('body').removeAttr('data-jserrors');
	});
}
JS;

            $this->getSession()->executeScript($javascript);
        } catch (WebDriverException $e) {
            $this->logException($e);
        }
    }

    /**
     * Hook into jQuery ajaxStart, ajaxSuccess and ajaxComplete events.
     * Prepare __ajaxStatus() functions and attach them to these handlers.
     * Event handlers are removed after one run.
     *
     * @BeforeStep
     * @param BeforeStepScope $event
     */
    public function handleAjaxBeforeStep(BeforeStepScope $event)
    {
        // Manually exclude @modal
        if ($this->stepHasTag($event, 'modal')) {
            return;
        }
        try {
            $ajaxEnabledSteps = $this->getMainContext()->getAjaxSteps();
            $ajaxEnabledSteps = implode('|', array_filter($ajaxEnabledSteps ?? []));

            if (empty($ajaxEnabledSteps) || !preg_match('/(' . $ajaxEnabledSteps . ')/i', $event->getStep()->getText() ?? '')) {
                return;
            }

            $javascript = <<<JS
if ('undefined' !== typeof window.jQuery && 'undefined' !== typeof window.jQuery.fn.on) {
    window.jQuery(document).on('ajaxStart.ss.test.behaviour', function(){
        window.__ajaxStatus = function() {
            return 'waiting';
        };
    });
    window.jQuery(document).on('ajaxComplete.ss.test.behaviour', function(e, jqXHR){
        if (null === jqXHR.getResponseHeader('X-ControllerURL')) {
            window.__ajaxStatus = function() {
                return 'no ajax';
            };
        }
    });
    window.jQuery(document).on('ajaxSuccess.ss.test.behaviour', function(e, jqXHR){
        if (null === jqXHR.getResponseHeader('X-ControllerURL')) {
            window.__ajaxStatus = function() {
                return 'success';
            };
        }
    });
}
JS;
            $this->getSession()->wait(500); // give browser a chance to process and render response
            $this->getSession()->executeScript($javascript);
        } catch (WebDriverException $e) {
            $this->logException($e);
        }
    }

    /**
     * Wait for the __ajaxStatus()to return anything but 'waiting'.
     * Don't wait longer than 5 seconds.
     *
     * Don't unregister handler if we're dealing with modal windows
     *
     * @AfterStep
     * @param AfterStepScope $event
     */
    public function handleAjaxAfterStep(AfterStepScope $event)
    {
        // Manually exclude @modal
        if ($this->stepHasTag($event, 'modal')) {
            return;
        }
        try {
            $ajaxEnabledSteps = $this->getMainContext()->getAjaxSteps();
            $ajaxEnabledSteps = implode('|', array_filter($ajaxEnabledSteps ?? []));

            if (empty($ajaxEnabledSteps) || !preg_match('/(' . $ajaxEnabledSteps . ')/i', $event->getStep()->getText() ?? '')) {
                return;
            }

            $this->handleAjaxTimeout();

            $javascript = <<<JS
if ('undefined' !== typeof window.jQuery && 'undefined' !== typeof window.jQuery.fn.off) {
window.jQuery(document).off('ajaxStart.ss.test.behaviour');
window.jQuery(document).off('ajaxComplete.ss.test.behaviour');
window.jQuery(document).off('ajaxSuccess.ss.test.behaviour');
}
JS;
            $this->getSession()->executeScript($javascript);
        } catch (WebDriverException $e) {
            $this->logException($e);
        }
    }

    public function handleAjaxTimeout()
    {
        $timeoutMs = $this->getMainContext()->getAjaxTimeout();

        // Wait for an ajax request to complete, but only for a maximum of 5 seconds to avoid deadlocks
        $this->getSession()->wait(
            $timeoutMs,
            "(typeof window.__ajaxStatus !== 'undefined' ? window.__ajaxStatus() : 'no ajax') !== 'waiting'"
        );

        // wait additional 100ms to allow DOM to update
        $this->getSession()->wait(100);
    }

    /**
     * Close modal dialog if test scenario fails on CMS page
     *
     * @AfterScenario
     * @param AfterScenarioScope $event
     */
    public function closeModalDialog(AfterScenarioScope $event)
    {
        $expectsUnsavedChangesModal = $this->stepHasTag($event, 'unsavedChanges');

        try {
            // Only for failed tests on CMS page
            if ($expectsUnsavedChangesModal || $event->getTestResult()->getResultCode() === TestResult::FAILED) {
                $cmsElement = $this->getSession()->getPage()->find('css', '.cms');
                if ($cmsElement) {
                    try {
                        // Navigate away triggered by reloading the page
                        $this->getSession()->reload();
                        $this->getExpectedAlert()->accept();
                    } catch (WebDriverException $e) {
                        // no-op, alert might not be present
                    }
                }
            }
        } catch (WebDriverException $e) {
            $this->logException($e);
        }
    }

    /**
     * Delete any created files and folders from assets directory
     *
     * @AfterScenario @assets
     * @param AfterScenarioScope $event
     */
    public function cleanAssetsAfterScenario(AfterScenarioScope $event)
    {
        foreach (File::get() as $file) {
            $file->delete();
        }
        Filesystem::removeFolder(ASSETS_PATH, true);
    }

    /**
     * @Given /^the page can't be found/
     */
    public function stepPageCantBeFound()
    {
        $page = $this->getSession()->getPage();
        Assert::assertTrue(
            // Content from ErrorPage default record
            $page->hasContent('Page not found')
                // Generic ModelAsController message
                || $page->hasContent('The requested page could not be found')
        );
    }

    /**
     * @Given /^I wait (?:for )?([\d\.]+) second(?:s?)$/
     *
     * @param float $secs
     */
    public function stepIWaitFor($secs)
    {
        $this->getSession()->wait((float)$secs * 1000);
    }

    /**
     * Find visible button with the given text.
     * Supports data-text-alternate property.
     *
     * @param string $title
     * @return NodeElement|null
     */
    public function findNamedButton($title, ?ElementInterface $parent = null)
    {
        if ($parent === null) {
            $parent = $this->getSession()->getPage();
        }
        // See https://mathiasbynens.be/notes/css-escapes
        $escapedTitle = addcslashes($title ?? '', '!"#$%&\'()*+,-./:;<=>?@[\]^`{|}~');
        $searches = [
            ['named', ['link_or_button', "'{$title}'"]],
            ['css', "button[data-text-alternate='{$escapedTitle}']"],
        ];
        foreach ($searches as list($type, $arg)) {
            $buttons = $parent->findAll($type, $arg);
            /** @var NodeElement $button */
            foreach ($buttons as $button) {
                if ($button->isVisible()) {
                    return $button;
                }
            }
        }
        return null;
    }

    /**
     * Example: I should see a "Submit" button
     * Example: I should not see a "Delete" button
     *
     * @Given /^I should( not? |\s*)see (?:a|an|the) "([^"]*)" button$/
     * @param string $negative
     * @param string $text
     */
    public function iShouldSeeAButton($negative, $text)
    {
        $button = $this->findNamedButton($text);
        if (trim($negative ?? '')) {
            Assert::assertNull($button, sprintf('%s button found', $text));
        } else {
            Assert::assertNotNull($button, sprintf('%s button not found', $text));
        }
    }

    /**
     * @Given /^I press the "([^"]*)" button$/
     * @param string $text
     */
    public function stepIPressTheButton($text)
    {
        $button = $this->findNamedButton($text);
        Assert::assertNotNull($button, "{$text} button not found");
        $button->click();
    }

    /**
     * @Given /^I press the "([^"]*)" buttons$/
     * @param string $text A list of button names can be provided by seperating the entries with the | character.
     */
    public function stepIPressTheButtons($text)
    {
        $buttonNames = explode('|', $text ?? '');
        foreach ($buttonNames as $name) {
            $button = $this->findNamedButton(trim($name ?? ''));
            if ($button) {
                break;
            }
        }

        Assert::assertNotNull($button, "{$text} button not found");
        $button->click();
    }

    /**
     * Needs to be in single command to avoid "unexpected alert open" errors in Selenium.
     * Example1: I press the "Remove current combo" button, confirming the dialog
     * Example2: I follow the "Remove current combo" link, confirming the dialog
     *
     * @Given /^I (?:press|follow) the "([^"]*)" (?:button|link), confirming the dialog$/
     * @param string $button
     */
    public function stepIPressTheButtonConfirmingTheDialog($button)
    {
        $this->stepIPressTheButton($button);
        $this->iConfirmTheDialog();
    }

    /**
     * Needs to be in single command to avoid "unexpected alert open" errors in Selenium.
     * Example: I follow the "Remove current combo" link, dismissing the dialog
     *
     * @Given /^I (?:press|follow) the "([^"]*)" (?:button|link), dismissing the dialog$/
     * @param string $button
     */
    public function stepIPressTheButtonDismissingTheDialog($button)
    {
        $this->stepIPressTheButton($button);
        $this->iDismissTheDialog();
    }

    /**
     * @Given /^I click on the "([^"]+)" element$/
     * @param string $selector
     */
    public function iClickOnTheElement($selector)
    {
        $page = $this->getMainContext()->getSession()->getPage();
        $element = $page->find('css', $selector);
        Assert::assertNotNull($element, sprintf('Element %s not found', $selector));
        $element->click();
    }

    /**
     * Needs to be in single command to avoid "unexpected alert open" errors in Selenium.
     *
     * @When /^I click on the "([^"]+)" element, confirming the dialog$/
     * @param $selector
     */
    public function iClickOnTheElementConfirmingTheDialog($selector)
    {
        $this->iClickOnTheElement($selector);
        $this->iConfirmTheDialog();
    }

    /**
     * @Given /^I (click|double click) "([^"]*)"(| directly) in the "([^"]*)" element$/
     * @param string $clickType
     * @param string $text
     * @param string $directly If used, the text must be directly in the element. Otherwise it can be in a child element.
     * @param string $selector
     */
    public function iClickInTheElement($clickType, $text, $directly, $selector)
    {
        $clickTypeMap = array(
            "double click" => "doubleclick",
            "click" => "click"
        );
        $page = $this->getSession()->getPage();
        $parentElement = $page->find('css', $selector);
        Assert::assertNotNull($parentElement, sprintf('"%s" element not found', $selector));
        if ($directly) {
            // Finds the specific text within the selector element (to validate it's there), and then grabs the element that holds the text
            $element = $parentElement->find('xpath', sprintf('/text()[contains(.,"%s")]/..', $text));
        } else {
            // Finds a child of the selector element which contains the text
            $element = $parentElement->find('xpath', sprintf('//*[count(*)=0 and contains(.,"%s")]', $text));
        }
        Assert::assertNotNull($element, sprintf('"%s" not found', $text));
        $clickTypeFn = $clickTypeMap[$clickType];
        $element->$clickTypeFn();
    }

    /**
     * Needs to be in single command to avoid "unexpected alert open" errors in Selenium.
     * Example: I click "Delete" in the ".actions" element, confirming the dialog
     *
     * @Given /^I (click|double click) "([^"]*)" in the "([^"]*)" element, confirming the dialog$/
     * @param string $clickType
     * @param string $text
     * @param string $selector
     */
    public function iClickInTheElementConfirmingTheDialog($clickType, $text, $selector)
    {
        $this->iClickInTheElement($clickType, $text, $selector);
        $this->iConfirmTheDialog();
    }

    /**
     * Needs to be in single command to avoid "unexpected alert open" errors in Selenium.
     * Example: I click "Delete" in the ".actions" element, dismissing the dialog
     *
     * @Given /^I (click|double click) "([^"]*)" in the "([^"]*)" element, dismissing the dialog$/
     * @param string $clickType
     * @param string $text
     * @param string $selector
     */
    public function iClickInTheElementDismissingTheDialog($clickType, $text, $selector)
    {
        $this->iClickInTheElement($clickType, $text, $selector);
        $this->iDismissTheDialog();
    }

    /**
     * @Then /^the "([^"]+)" element "([^"]+)" attribute should be "([^"]*)"$/
     */
    public function theElementAttributeShouldBe($selector, $attribute, $value)
    {
        $page = $this->getSession()->getPage();
        $element = $page->find('css', $selector);
        Assert::assertNotNull($element, sprintf('Element %s not found', $selector));
        Assert::assertEquals($value, $element->getAttribute($attribute));
    }

    /**
     * @Given /^I see the text "([^"]+)" in the alert$/
     * @param string $expected
     */
    public function iSeeTheDialogText($expected)
    {
        $driver = $this->getSession()->getDriver();
        if ($driver instanceof Selenium2Driver) {
            $text = $driver->getWebDriverSession()->getAlert_text();
        } else {
            $text = $this->getExpectedAlert()->getText();
        }
        Assert::assertStringContainsString($expected, $text);
    }

    /**
     * @Given /^I type "([^"]*)" into the dialog$/
     * @param string $data
     */
    public function iTypeIntoTheDialog($data)
    {
        $this->getExpectedAlert()
            ->sendKeys($data)
            ->accept();
    }

    /**
     * Wait for alert to appear, and return handle
     *
     * @return WebDriverAlert
     */
    protected function getExpectedAlert()
    {
        $session = $this->getWebDriverSession();
        $session->wait()->until(
            WebDriverExpectedCondition::alertIsPresent(),
            "Alert is expected"
        );
        return $session->switchTo()->alert();
    }

    /**
     * @Given /^I confirm the dialog$/
     */
    public function iConfirmTheDialog()
    {
        $driver = $this->getSession()->getDriver();
        if ($driver instanceof Selenium2Driver) {
            $driver->getWebDriverSession()->accept_alert();
        } else {
            $session = $this->getWebDriverSession();
            $session->wait()->until(
                WebDriverExpectedCondition::alertIsPresent(),
                "Alert is expected"
            );
            $session->switchTo()->alert()->accept();
        }
        $this->handleAjaxTimeout();
    }

    /**
     * @Given /^I dismiss the dialog$/
     */
    public function iDismissTheDialog()
    {
        $driver = $this->getSession()->getDriver();
        if ($driver instanceof Selenium2Driver) {
            $driver->getWebDriverSession()->dismiss_alert();
        } else {
            $this->getExpectedAlert()->dismiss();
        }
        $this->handleAjaxTimeout();
    }

    /**
     * Get Selenium webdriver session.
     * Note: Will fail if current driver isn't FacebookWebDriver
     *
     * @return WebDriver
     */
    protected function getWebDriverSession()
    {
        $driver = $this->getSession()->getDriver();
        if (!$driver instanceof FacebookWebDriver) {
            throw new InvalidArgumentException("Only supported for FacebookWebDriver");
        }
        return $driver->getWebDriver();
    }

    /**
     * Select a specific option in a select element
     *
     * @Given /^I select "([^"]*)" in the "([^"]*)" dropdown$/
     */
    public function iSelectOptionInDropdown(string $optionLocator, string $dropdownLocator): void
    {
        $dropdown = $this->getElement($dropdownLocator);
        $dropdown->selectOption($optionLocator);
    }

    /**
     * Validate that a specific option is selected in a select element
     *
     * @Then /^the "([^"]*)" option is selected in the "([^"]*)" dropdown$/
     */
    public function optionIsSelectedInDropdown(string $optionLocator, string $dropdownLocator): void
    {
        $dropdown = $this->getElement($dropdownLocator);
        $selectedOption = null;
        foreach ($dropdown->findAll('css', 'option') as $option) {
            if ($option->isSelected()) {
                $selectedOption = $option;
                break;
            }
        }
        if ($selectedOption === null) {
            throw new InvalidArgumentException("No option was selected in dropdown '$dropdownLocator'");
        }
        // Try value first - use == instead of === because the type may be e.g. int vs our expected string.
        if ($selectedOption->getValue() == $optionLocator) {
            return;
        }
        // Then try text - sometimes the value isn't the same as the text, and often behat tests are written based on what's visible
        if ($selectedOption->getText() === $optionLocator) {
            return;
        }
        throw new InvalidArgumentException("Option '$optionLocator' wasn't selected - selected option is '{$selectedOption->getValue()}'");
    }

    /**
     * Select an individual input from within a group, matched by the top-most label.
     *
     * @Given /^I select "([^"]*)" from "([^"]*)" input group$/
     * @param string $value
     * @param string $labelText
     */
    public function iSelectFromInputGroup($value, $labelText)
    {
        $page = $this->getSession()->getPage();
        $parent = null;

        /** @var NodeElement $label */
        foreach ($page->findAll('css', 'label') as $label) {
            if ($label->getText() == $labelText) {
                $parent = $label->getParent();
            }
        }

        if (!$parent) {
            throw new InvalidArgumentException(sprintf('Input group with label "%s" cannot be found', $labelText));
        }

        /** @var NodeElement $option */
        foreach ($parent->findAll('css', 'label') as $option) {
            if ($option->getText() == $value) {
                $input = null;

                // First, look for inputs referenced by the "for" element on this label
                $for = $option->getAttribute('for');
                if ($for) {
                    $input = $parent->findById($for);
                }

                // Otherwise look for inputs _inside_ the label
                if (!$input) {
                    $input = $option->find('css', 'input');
                }

                if (!$input) {
                    throw new InvalidArgumentException(sprintf('Input "%s" cannot be found', $value));
                }

                $this->getSession()->getDriver()->click($input->getXPath());
            }
        }
    }

    /**
     * Pauses the scenario until the user presses a key. Useful when debugging a scenario.
     *
     * @Then /^(?:|I )put a breakpoint$/
     */
    public function iPutABreakpoint()
    {
        fwrite(STDOUT, "\033[s    \033[93m[Breakpoint] Press \033[1;93m[RETURN]\033[0;93m to continue...\033[0m");
        while (fgets(STDIN, 1024) == '') {
            // noop
        }
        fwrite(STDOUT, "\033[u");

        return;
    }

    /**
     * Transforms relative time statements compatible with strtotime().
     * Example: "time of 1 hour ago" might return "22:00:00" if its currently "23:00:00".
     * Customize through {@link setTimeFormat()}.
     *
     * @Transform /^(?:(the|a)) time of (?<val>.*)$/
     * @param string $prefix
     * @param string $val
     * @return false|string
     */
    public function castRelativeToAbsoluteTime($prefix, $val)
    {
        $timestamp = strtotime($val ?? '');
        if (!$timestamp) {
            throw new InvalidArgumentException(sprintf(
                "Can't resolve '%s' into a valid datetime value",
                $val
            ));
        }
        return date($this->timeFormat ?? '', $timestamp);
    }

    /**
     * Transforms relative date and time statements compatible with strtotime().
     * Example: "datetime of 2 days ago" might return "2013-10-10 22:00:00" if its currently
     * the 12th of October 2013. Customize through {@link setDatetimeFormat()}.
     *
     * @Transform /^(?:(the|a)) datetime of (?<val>.*)$/
     * @param string $prefix
     * @param string $val
     * @return false|string
     */
    public function castRelativeToAbsoluteDatetime($prefix, $val)
    {
        $timestamp = strtotime($val ?? '');
        if (!$timestamp) {
            throw new InvalidArgumentException(sprintf(
                "Can't resolve '%s' into a valid datetime value",
                $val
            ));
        }
        return date($this->datetimeFormat ?? '', $timestamp);
    }

    /**
     * Transforms relative date statements compatible with strtotime().
     * Example: "date 2 days ago" might return "2013-10-10" if its currently
     * the 12th of October 2013. Customize through {@link setDateFormat()}.
     *
     * @Transform /^(?:(the|a)) date of (?<val>.*)$/
     * @param string $prefix
     * @param string $val
     * @return false|string
     */
    public function castRelativeToAbsoluteDate($prefix, $val)
    {
        $timestamp = strtotime($val ?? '');
        if (!$timestamp) {
            throw new InvalidArgumentException(sprintf(
                "Can't resolve '%s' into a valid datetime value",
                $val
            ));
        }
        return date($this->dateFormat ?? '', $timestamp);
    }

    public function getDateFormat()
    {
        return $this->dateFormat;
    }

    public function setDateFormat($format)
    {
        $this->dateFormat = $format;
    }

    public function getTimeFormat()
    {
        return $this->timeFormat;
    }

    public function setTimeFormat($format)
    {
        $this->timeFormat = $format;
    }

    public function getDatetimeFormat()
    {
        return $this->datetimeFormat;
    }

    public function setDatetimeFormat($format)
    {
        $this->datetimeFormat = $format;
    }

    /**
     * Checks that field with specified in|name|label|value is disabled.
     * Example: Then the field "Email" should be disabled
     * Example: Then the "Email" field should be disabled
     *
     * @Then /^the "(?P<name>(?:[^"]|\\")*)" (?P<type>(?:(field|button))) should (?P<negate>(?:(not |)))be disabled/
     * @Then /^the (?P<type>(?:(field|button))) "(?P<name>(?:[^"]|\\")*)" should (?P<negate>(?:(not |)))be disabled/
     * @param string $name
     * @param string $type
     * @param string $negate
     */
    public function stepFieldShouldBeDisabled($name, $type, $negate)
    {
        $page = $this->getSession()->getPage();
        if ($type == 'field') {
            $element = $page->findField($name);
        } else {
            $element = $page->find('named', array(
                'button',
                $this->getMainContext()->getXpathEscaper()->escapeLiteral($name)
            ));
        }

        Assert::assertNotNull($element, sprintf("Element '%s' not found", $name));

        $disabledAttribute = $element->getAttribute('disabled');
        if (trim($negate ?? '')) {
            Assert::assertNull($disabledAttribute, sprintf("Failed asserting element '%s' is not disabled", $name));
        } else {
            Assert::assertNotNull($disabledAttribute, sprintf("Failed asserting element '%s' is disabled", $name));
        }
    }

    /**
     * Checks that checkbox with specified in|name|label|value is enabled.
     * Example: Then the field "Email" should be enabled
     * Example: Then the "Email" field should be enabled
     *
     * @Then /^the "(?P<field>(?:[^"]|\\")*)" field should be enabled/
     * @Then /^the field "(?P<field>(?:[^"]|\\")*)" should be enabled/
     * @param string $field
     */
    public function stepFieldShouldBeEnabled($field)
    {
        $page = $this->getSession()->getPage();
        $fieldElement = $page->findField($field);
        Assert::assertNotNull($fieldElement, sprintf("Field '%s' not found", $field));

        $disabledAttribute = $fieldElement->getAttribute('disabled');

        Assert::assertNull($disabledAttribute, sprintf("Failed asserting field '%s' is enabled", $field));
    }

    /**
     * Clicks a link in a specific region (an element identified by a CSS selector, a "data-title" attribute,
     * or a named region mapped to a CSS selector via Behat configuration).
     *
     * Example: Given I follow "Select" in the "header .login-form" region
     * Example: Given I follow "Select" in the "My Login Form" region
     *
     * @Given /^I (?:follow|click) "(?P<link>[^"]*)" in the "(?P<region>[^"]*)" region$/
     * @param string $link
     * @param string $region
     * @throws \Exception
     */
    public function iFollowInTheRegion($link, $region)
    {
        $context = $this->getMainContext();
        $regionObj = $context->getRegionObj($region);
        Assert::assertNotNull($regionObj);

        $linkObj = $regionObj->findLink($link);
        if (empty($linkObj)) {
            throw new \Exception(sprintf('The link "%s" was not found in the region "%s"
				on the page %s', $link, $region, $this->getSession()->getCurrentUrl()));
        }

        $linkObj->click();
    }

    /**
     * Fills in a field in a specfic region similar to (@see iFollowInTheRegion or @see iSeeTextInRegion)
     *
     * Example: Given I fill in "Hello" with "World"
     *
     * @Given /^I fill in "(?P<field>[^"]*)" with "(?P<value>[^"]*)" in the "(?P<region>[^"]*)" region$/
     * @param string $field
     * @param string $value
     * @param string $region
     * @throws \Exception
     */
    public function iFillinTheRegion($field, $value, $region)
    {
        $context = $this->getMainContext();
        $regionObj = $context->getRegionObj($region);
        Assert::assertNotNull($regionObj, "Region Object is null");

        $fieldObj = $regionObj->findField($field);
        if (empty($fieldObj)) {
            throw new \Exception(sprintf('The field "%s" was not found in the region "%s"
				on the page %s', $field, $region, $this->getSession()->getCurrentUrl()));
        }

        $regionObj->fillField($field, $value);
    }

    /**
     * Asserts text in a specific region (an element identified by a CSS selector, a "data-title" attribute,
     * or a named region mapped to a CSS selector via Behat configuration).
     * Supports regular expressions in text value.
     *
     * Example: Given I should see "My Text" in the "header .login-form" region
     * Example: Given I should not see "My Text" in the "My Login Form" region
     *
     * @Given /^I should (?P<negate>(?:(not |)))see "(?P<text>[^"]*)" in the "(?P<region>[^"]*)" region$/
     * @param string $negate
     * @param string $text
     * @param string $region
     * @throws \Exception
     */
    public function iSeeTextInRegion($negate, $text, $region)
    {
        $context = $this->getMainContext();
        $regionObj = $context->getRegionObj($region);
        Assert::assertNotNull($regionObj);

        $actual = $regionObj->getText();
        $actual = preg_replace('/\s+/u', ' ', $actual ?? '');
        $regex  = '/' . preg_quote($text ?? '', '/') . '/ui';

        if (trim($negate ?? '')) {
            if (preg_match($regex ?? '', $actual ?? '')) {
                $message = sprintf(
                    'The text "%s" was found in the text of the "%s" region on the page %s.',
                    $text,
                    $region,
                    $this->getSession()->getCurrentUrl()
                );

                throw new \Exception($message);
            }
        } else {
            if (!preg_match($regex ?? '', $actual ?? '')) {
                $message = sprintf(
                    'The text "%s" was not found anywhere in the text of the "%s" region on the page %s.',
                    $text,
                    $region,
                    $this->getSession()->getCurrentUrl()
                );

                throw new \Exception($message);
            }
        }
    }

    /**
     * Selects the specified radio button
     *
     * @Given /^I select the "([^"]*)" radio button$/
     * @param string $radioLabel
     */
    public function iSelectTheRadioButton($radioLabel)
    {
        $session = $this->getSession();
        $radioButton = $session->getPage()->find('named', [
            'radio',
            $this->getMainContext()->getXpathEscaper()->escapeLiteral($radioLabel)
        ]);
        Assert::assertNotNull($radioButton);
        $session->getDriver()->click($radioButton->getXPath());
    }

    /**
     * @Then /^the "([^"]*)" table should contain "([^"]*)"$/
     * @param string $selector
     * @param string $text
     */
    public function theTableShouldContain($selector, $text)
    {
        $table = $this->getTable($selector);

        $element = $table->find('named', array('content', "'$text'"));
        Assert::assertNotNull($element, sprintf('Element containing `%s` not found in `%s` table', $text, $selector));
    }

    /**
     * @Then /^the "([^"]*)" table should not contain "([^"]*)"$/
     * @param string $selector
     * @param string $text
     */
    public function theTableShouldNotContain($selector, $text)
    {
        $table = $this->getTable($selector);

        $element = $table->find('named', array('content', "'$text'"));
        Assert::assertNull($element, sprintf('Element containing `%s` not found in `%s` table', $text, $selector));
    }

    /**
     * @Given /^I click on "([^"]*)" in the "([^"]*)" table$/
     * @param string $text
     * @param string $selector
     */
    public function iClickOnInTheTable($text, $selector)
    {
        $table = $this->getTable($selector);

        $element = $table->find('xpath', sprintf('//*[count(*)=0 and contains(.,"%s")]', $text));
        Assert::assertNotNull($element, sprintf('Element containing `%s` not found', $text));
        $element->click();
    }

    /**
     * Finds the first visible table by various factors:
     * - table[id]
     * - table[title]
     * - table *[class=title]
     * - fieldset[data-name] table
     * - table caption
     *
     * @param string $selector
     * @return NodeElement
     */
    protected function getTable($selector)
    {
        $selector = $this->getMainContext()->getXpathEscaper()->escapeLiteral($selector);
        $page = $this->getSession()->getPage();
        $candidates = $page->findAll(
            'xpath',
            $this->getSession()->getSelectorsHandler()->selectorToXpath(
                "xpath",
                ".//table[(./@id = $selector or  contains(./@title, $selector))]"
            )
        );

        // Find tables by a <caption> field
        $candidates += $page->findAll('xpath', "//table//caption[contains(normalize-space(string(.)),
			$selector)]/ancestor-or-self::table[1]");

        // Find tables by a .title node
        $candidates += $page->findAll('xpath', "//table//*[contains(concat(' ',normalize-space(@class),' '), ' title ') and contains(normalize-space(string(.)),
			$selector)]/ancestor-or-self::table[1]");

        // Some tables don't have a visible title, so look for a fieldset with data-name instead
        $candidates += $page->findAll('xpath', "//fieldset[@data-name=$selector]//table");

        Assert::assertTrue((bool)$candidates, 'Could not find any table elements');

        $table = null;
        /** @var NodeElement $candidate */
        foreach ($candidates as $candidate) {
            if (!$table && $candidate->isVisible()) {
                $table = $candidate;
            }
        }

        Assert::assertTrue((bool)$table, 'Found table elements, but none are visible');

        return $table;
    }

    /**
     * Checks the order of two texts.
     * Assumptions: the two texts appear in their conjunct parent element once
     * @Then /^I should see the text "(?P<textBefore>(?:[^"]|\\")*)" (?P<order>(before|after)) the text "(?P<textAfter>(?:[^"]|\\")*)" in the "(?P<element>[^"]*)" element$/
     * @param string $textBefore
     * @param string $order
     * @param string $textAfter
     * @param string $element
     */
    public function theTextBeforeAfter($textBefore, $order, $textAfter, $element)
    {
        $ele = $this->getSession()->getPage()->find('css', $element);
        Assert::assertNotNull($ele, sprintf('%s not found', $element));

        // Check both of the texts exist in the element
        $text = $ele->getText();
        Assert::assertTrue(strpos($text ?? '', $textBefore ?? '') !== 'FALSE', sprintf('%s not found in the element %s', $textBefore, $element));
        Assert::assertTrue(strpos($text ?? '', $textAfter ?? '') !== 'FALSE', sprintf('%s not found in the element %s', $textAfter, $element));

        /// Use strpos to get the position of the first occurrence of the two texts (case-sensitive)
        // and compare them with the given order (before or after)
        if ($order === 'before') {
            Assert::assertTrue(strpos($text ?? '', $textBefore ?? '') < strpos($text ?? '', $textAfter ?? ''));
        } else {
            Assert::assertTrue(strpos($text ?? '', $textBefore ?? '') > strpos($text ?? '', $textAfter ?? ''));
        }
    }

    /**
     * Wait until a certain amount of seconds till I see an element  identified by a CSS selector.
     *
     * Example: Given I wait for 10 seconds until I see the ".css_element" element
     *
     * @Given /^I wait for (\d+) seconds until I see the "([^"]*)" element$/
     * @param int $wait
     * @param string $selector
     */
    public function iWaitXUntilISee($wait, $selector)
    {
        $page = $this->getSession()->getPage();

        $this->spin(function () use ($page, $selector) {
            $element = $page->find('css', $selector);

            if (empty($element)) {
                return false;
            } else {
                return $element->isVisible();
            }
        });
    }

    /**
     * Wait until a particular element is visible, using a CSS selector. Useful for content loaded via AJAX, or only
     * populated after JS execution.
     *
     * Example: Given I wait until I see the "header .login-form" element
     *
     * @Given /^I wait until I see the "([^"]*)" element$/
     * @param string $selector
     */
    public function iWaitUntilISee($selector)
    {
        $page = $this->getSession()->getPage();
        $this->spin(function () use ($page, $selector) {
            $element = $page->find('css', $selector);
            if (empty($element)) {
                return false;
            } else {
                return ($element->isVisible());
            }
        });
    }

    /**
     * Wait until a particular string is found on the page. Useful for content loaded via AJAX, or only populated after
     * JS execution.
     *
     * Example: Given I wait until I see the text "Welcome back, John!"
     *
     * @Given /^I wait until I see the text "([^"]*)"$/
     * @param string $text
     */
    public function iWaitUntilISeeText($text)
    {
        $page = $this->getSession()->getPage();
        $session = $this->getSession();
        $this->spin(function () use ($page, $session, $text) {
            $elements = $page->findAll(
                'xpath',
                $session->getSelectorsHandler()->selectorToXpath("xpath", ".//*[contains(text(), '$text')]")
            );
            foreach ($elements as $element) {
                if (empty($element)) {
                    continue;
                }
                if (!$element->isVisible()) {
                    continue;
                }
                return true;
            }
            return false;
        });
    }

    /**
     * @Given /^I scroll to the bottom$/
     */
    public function iScrollToBottom()
    {
        $javascript = 'window.scrollTo(0, Math.max(document.documentElement.scrollHeight, document.body.scrollHeight, document.documentElement.clientHeight));';
        $this->getSession()->executeScript($javascript);
    }

    /**
     * @Given /^I scroll to the bottom of the edit form panel$/
     */
    public function iScrollToTheBottomOfTheEditFormPanel()
    {
        $javascript = implode('', [
            "var el = document.querySelector('.cms #Form_EditForm > .panel,.cms #Form_ItemEditForm > .panel');",
            "el.scrollTo(0, Math.max(el.scrollHeight, el.scrollHeight, el.clientHeight));",
        ]);
        $this->getSession()->executeScript($javascript);
    }

    /**
     * @Given /^I scroll to the top$/
     */
    public function iScrollToTop()
    {
        $this->getSession()->executeScript('window.scrollTo(0,0);');
    }

    /**
     * @Given /^I scroll to the top of the edit form panel$/
     */
    public function iScrollToTheTopOfTheEditFormPanel()
    {
        $javascript = implode('', [
            "var el = document.querySelector('.cms #Form_EditForm > .panel,.cms #Form_ItemEditForm > .panel');",
            "el.scrollTo(0, 0);",
        ]);
        $this->getSession()->executeScript($javascript);
    }

    /**
     * Scroll to a certain element by label.
     * Requires an "id" attribute to uniquely identify the element in the document.
     *
     * Example: Given I scroll to the "Submit" button
     * Example: Given I scroll to the "My Date" field
     *
     * @Given /^I scroll to the "([^"]*)" (field|link|button)$/
     * @param string $locator
     * @param string $type
     */
    public function iScrollToField($locator, $type)
    {
        $page = $this->getSession()->getPage();
        $el = $page->find('named', array($type, "'$locator'"));
        Assert::assertNotNull($el, sprintf('%s element not found', $locator));

        $id = $el->getAttribute('id');
        if (empty($id)) {
            throw new InvalidArgumentException('Element requires an "id" attribute');
        }

        $js = sprintf("document.getElementById('%s').scrollIntoView(true);", $id);
        $this->getSession()->executeScript($js);
    }

    /**
     * Scroll to a certain element by CSS selector.
     * Requires an "id" attribute to uniquely identify the element in the document.
     *
     * Example: Given I scroll to the ".css_element" element
     *
     * @Given /^I scroll to the "(?P<locator>(?:[^"]|\\")*)" element$/
     * @param string $locator
     */
    public function iScrollToElement($locator)
    {
        $el = $this->getSession()->getPage()->find('css', $locator);
        Assert::assertNotNull($el, sprintf('The element "%s" is not found', $locator));

        $id = $el->getAttribute('id');
        if (empty($id)) {
            throw new InvalidArgumentException('Element requires an "id" attribute');
        }

        $js = sprintf("document.getElementById('%s').scrollIntoView(true);", $id);
        $this->getSession()->executeScript($js);
    }

    /**
     * Continuously poll the dom until callback returns true, code copied from
     * (@link http://docs.behat.org/cookbook/using_spin_functions.html)
     * If not found within a given wait period, timeout and throw error
     *
     * @param callback $lambda The function to run continuously
     * @param integer $wait Timeout in seconds
     * @return bool Returns true if the lambda returns successfully
     * @throws \Exception Thrown if the wait threshold is exceeded without the lambda successfully returning
     */
    public function spin($lambda, $wait = 60)
    {
        for ($i = 0; $i < $wait; $i++) {
            try {
                if ($lambda($this)) {
                    return true;
                }
            } catch (\Exception $e) {
                // do nothing
            }

            sleep(1);
        }

        $backtrace = debug_backtrace();

        throw new \Exception(sprintf(
            "Timeout thrown by %s::%s()\n.",
            $backtrace[1]['class'],
            $backtrace[1]['function']
        ));
    }


    /**
     * Log a message
     */
    protected function logMessage(string $message)
    {
        file_put_contents('php://stderr', $message . PHP_EOL);
    }


    /**
     * We have to catch exceptions and log somehow else otherwise behat falls over
     *
     * @param Exception $exception
     */
    protected function logException(Exception $exception)
    {
        $this->logMessage('Exception caught: ' . $exception->getMessage());
    }

    /**
     * Detect element with javascript, rather than having the selector converted to xpath
     * There's already an xpath based function 'I see the "" element' iSeeTheElement() in silverstripe/cms
     * There's also an 'I should see "" element' in MinkContext which also converts the css selector to xpath
     *
     * @When /^I should(| not) see the "([^"]+)" element/
     * @param $selector
     */
    public function iShouldSeeTheElement($not, $cssSelector = '')
    {
        $sel = str_replace('"', '\\"', $cssSelector ?? '');
        $js = <<<JS
return document.querySelector("$sel");
JS;
        $element = $this->getSession()->evaluateScript($js);
        if ($not) {
            Assert::assertNull($element, sprintf('Element %s was found when it should not have been', $cssSelector));
        } else {
            Assert::assertNotNull($element, sprintf('Element %s not found', $cssSelector));
        }
    }

    /**
     * Selects the option in select field with specified id|name|label|value
     * Also accepts CSS selectors
     *
     * @When /^I select "([^"]+)" from the "([^"]+)" field(| with javascript)$/
     * @param string $value
     * @param string $locator - select id, name, label or element
     * @param string $withJavascript - use javascript if having trouble selecting an option e.g. visibility
     */
    public function iSelectFromTheField($value, $locator, $withJavascript)
    {
        $field = $this->getElement($locator);
        if (!$withJavascript) {
            $field->selectOption($value);
        } else {
            $xpath = $field->getXpath();
            $xpath = str_replace(['"', "\n"], ['\"', ''], $xpath ?? '');
            $value = str_replace('"', '\"', $value ?? '');
            $js = <<<JS
                return (function() {
                    let select = document.evaluate("{$xpath}", document).iterateNext();
                    let options = select.getElementsByTagName('option');
                    for (let i = 0; i < options.length; i++) {
                        let option = options[i];
                        if (option.value != "{$value}" && option.innerHTML.trim() != "{$value}") {
                            continue;
                        }
                        select.value = option.value;
                        return 1;
                    }
                    return 0;
                })();
JS;
            $result = $this->getSession()->evaluateScript($js);
            Assert::assertEquals(1, $result, "Unable to select value {$value} from {$locator} with javascript");
        }
    }

    /**
     * @Then /^the rendered HTML should(| not) contain "(.+)"$/
     * @param string $not
     * @param string $htmlFragment
     */
    public function theRenderedHtmlShouldContain($not, $htmlFragment)
    {
        $html = $this->getSession()->getPage()->getOuterHtml();
        $htmlFragment = str_replace('\"', '"', $htmlFragment ?? '');
        $contains = strpos($html ?? '', $htmlFragment ?? '') !== false;
        if ($not) {
            Assert::assertFalse($contains, "HTML fragment {$htmlFragment} was in rendered HTML when it should not have been");
        } else {
            Assert::assertTrue($contains, "HTML fragment {$htmlFragment} not found in rendered HTML");
        }
    }

    /**
     * Add tag values to the react TagField component which uses react-select
     *
     * @Then /^I add "([^"]+)" to the "([^"]+)" tag field$/
     * @param string $value
     * @param string $selector
     */
    public function iAddToTheTagField($value, $selector)
    {
        $page = $this->getSession()->getPage();
        /** @var NodeElement $parentElement */
        $parentElement = null;
        $dropdown = null;
        $this->retryThrowable(function () use (&$parentElement, &$page, $selector) {
            $parentElement = $page->find('css', $selector);
            Assert::assertNotNull($parentElement, sprintf('"%s" element not found', $selector));
            $page = $this->getSession()->getPage();
        });

        $this->retryThrowable(function () use (&$dropdown, $parentElement, $selector) {
            $dropdown = $parentElement->find('css', '.ss-tag-field__dropdown-indicator');
            Assert::assertNotNull($dropdown, sprintf('Unable to find the dropdown in "%s"', $selector));
            $dropdown->click();
        });

        $inputField = null;
        try {
            // Try setting to a value already in the dropdown
            $this->retryThrowable(function () use ($value, $parentElement, $selector) {
                $element = $parentElement->find('xpath', sprintf('//*[count(*)=0 and .="%s"]', $value));
                Assert::assertNotNull($element, sprintf('"%s" not found in "%s"', $value, $selector));
                $element->click();
            });
        } catch (ExpectationFailedException $e) {
            // Try creating a new value
            $this->retryThrowable(function () use (&$inputField, $value, $parentElement, $selector) {
                /** @var NodeElement $parentElement */
                $inputField = $parentElement->find('css', '.ss-tag-field__input');
                Assert::assertNotNull($inputField, sprintf('Could not create "%s" in "%s"', $value, $selector));
                // We need to type the value in - react won't accept us just setting the value via js
                $inputField->focus();
                /** @var FacebookWebDriver $driver */
                $driver = $this->getSession()->getDriver();
                $keyboard = $driver->getWebDriver()->getKeyboard();
                $keyboard->sendKeys($value);
            });

            // Try selecting the 'Create "$value"' option
            $this->retryThrowable(function () use ($value, $parentElement, $selector) {
                $createOption = 'Create "' . $value . '"';
                $element = $parentElement->find('xpath', sprintf('//*[count(*)=0 and .=\'%s\']', $createOption));
                Assert::assertNotNull($element, sprintf('"%s" not found in "%s"', $createOption, $selector));
                $element->click();
            });
        }
    }

    /**
     * @Then /^the "([^"]+)" field should have the value "([^"]+)"$/
     * @param string $locator
     * @param string $value
     */
    public function theFieldShouldHaveTheValue($locator, $value)
    {
        Assert::assertEquals($value, $this->getElement($locator)->getValue());
    }

    /**
     * Will first attempt to find a field based on $locator
     * Will fall back to finding an element based on css selector
     *
     * @param string $locator
     * @return null|NodeElement
     */
    private function getElement($locator): ?NodeElement
    {
        $page = $this->getSession()->getPage();
        try {
            $element = $page->findField($locator);
        } catch (ElementNotFoundException $e) {
            // noop
        }
        if (!$element) {
            $element = $page->find('css', $locator);
        }
        Assert::assertNotNull($element, "Field {$locator} was not found");
        return $element;
    }

    /**
     * @When /^I drag the "([^"]+)" element to the "([^"]+)" element$/
     * @param string $locatorA
     * @param string $locatorB
     */
    public function iDragTheElementToTheElement($locatorA, $locatorB)
    {
        $elementA = $this->getElement($locatorA);
        $elementB = $this->getElement($locatorB);
        $elementA->dragTo($elementB);
    }

    /**
     * This doesn't seem to work quite right in practice
     * iDragTheElementToTheElement is much more reliable
     *
     * @When /^I drag the "([^"]+)" element by "(\-?[0-9]+),(\-?[0-9]+)"$/
     * @param string $locatorA
     * @param string $xOffset
     * @param string $yOffset
     */
    public function iDragTheElementBy($locatorA, $xOffset, $yOffset)
    {
        /** @var FacebookWebDrvier $driver */
        $driver = $this->getSession()->getDriver();
        if (!($driver instanceof FacebookWebDriver)) {
            $this->logMessage('Drag and drop by offset is only supported for FacebookWebDriver: skipping');
            return;
        }
        $elementA = $this->getElement($locatorA);
        $driver->dragBy($elementA->getXpath(), (int) $xOffset, (int) $yOffset);
    }

    /**
     * Globally press the key i.e. not type into an input
     *
     * @When /^I press the "([^"]+)" key globally$/
     * @param string $keyCombo - e.g. tab / shift-tab / ctrl-c / alt-f4
     */
    public function iPressTheKeyGlobally($keyCombo)
    {
        /** @var FacebookWebDrvier $driver */
        $driver = $this->getSession()->getDriver();
        if (!($driver instanceof FacebookWebDriver)) {
            $this->logMessage('Pressing keys globally is only supported for FacebookWebDriver: skipping');
            return;
        }
        $modifier = null;
        $pos = strpos($keyCombo ?? '', '-');
        if ($pos !== false && $pos !== 0) {
            list($modifier, $char) = explode('-', $keyCombo ?? '');
        } else {
            $char = $keyCombo;
        }
        // handle special chars e.g. "space"
        if (defined(WebDriverKeys::class . '::' . strtoupper($char ?? ''))) {
            $char = constant(WebDriverKeys::class . '::' . strtoupper($char ?? ''));
        }
        if ($modifier) {
            $modifier = strtoupper($modifier ?? '');
            if (defined(WebDriverKeys::class . '::' . $modifier)) {
                $modifier = constant(WebDriverKeys::class . '::' . $modifier);
            } else {
                $modifier = null;
            }
        }
        $driver->globalKeyPress($char, $modifier);
    }

    /**
     * Use upload fields
     *
     * @Then /^I attach the file "([^"]+)" to the "([^"]+)" field$/
     * @param $filename
     * @param $locator
     */
    public function iAttachTheFileToTheField($filename, $locator)
    {
        Assert::assertNotNull($this->fixtureContext, 'FixtureContext was not found so cannot know location of fixture files');
        $path = $this->fixtureContext->getFilesPath() . '/' . $filename;
        $path = str_replace('//', '/', $path ?? '');
        Assert::assertNotEmpty($path, 'Fixture files path is empty');
        $field = $this->getElement($locator);
        $filesPath = $this->fixtureContext->getFilesPath();
        if ($filesPath) {
            $fullPath = rtrim(realpath($filesPath ?? '') ?? '', DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $path;
            if (is_file($fullPath ?? '')) {
                $path = $fullPath;
            }
        }
        Assert::assertFileExists($path, "{$path} does not exist");
        $field->attachFile($path);
    }

    /**
     * Use this to follow hyperlinks with target="_blank"
     * Behat won't switch to the new tab
     * Also allows use of css selectors
     *
     * @When /^I follow "([^"]+)" with javascript$/
     * @param string $locator
     */
    public function iFollowWithJavascript($locator)
    {
        $page = $this->getSession()->getPage();
        $link = $page->find('named', ['link', $locator]);
        if (!$link) {
            $link = $page->find('css', $locator);
        }
        Assert::assertNotNull($link, "Link {$locator} was not found");
        $html = $link->getOuterHtml();
        preg_match('#href=([\'"])#', $html ?? '', $m);
        $q = $m[1];
        preg_match("#href={$q}(.+?){$q}#", $html ?? '', $m);
        $href = str_replace("'", "\\'", $m[1] ?? '');
        if (strpos($href ?? '', 'http') !== 0) {
            $href = rtrim($href ?? '', '/');
            $href = "/{$href}";
        }
        $this->getSession()->executeScript("document.location.href = '{$href}';");
    }

    /**
     * @Given /^I focus on the "([^"]+)" element$/
     */
    public function iFocusOnTheElement(string $selector)
    {
        $page = $this->getSession()->getPage();
        $element = $page->find('css', $selector);
        Assert::assertNotNull($element, sprintf('Element %s not found', $selector));
        $element->focus();
    }

    /**
     * Checks if an element has focus.
     *
     * Example: Then the ".some-css-selector" element should have focus
     * @Then /^the "([^"]*)" element should have focus$/
     */
    public function theFieldShouldHaveFocus(string $selector)
    {
        $page = $this->getSession()->getPage();
        $element = $page->find('css', $selector);
        Assert::assertNotNull($element, sprintf('Element %s not found', $selector));
        $sel = str_replace('"', '\\"', $selector);
        $script = <<<JS
            return (function() {
                var el = document.querySelector("$sel");
                if (!el) {
                    return false;
                }
                return el == document.activeElement;
            })();
        JS;
        $res = $this->getSession()->evaluateScript($script);
        Assert::assertTrue($res);
    }

    /**
     * @Given /^I type "([^"]+)" in the field$/
     *
     * This method is used to type into the active element.
     * It's used to type into fields that are input fields and currently active (has focus).
     * Should be used together with the step "I focus on the "selector" element"
     *
     * Example:
     * When I focus on the "selector" element
     * And I type "text" in the field
     */
    public function iTypeInTheField(string $data)
    {
        $driver = $this->getSession()->getDriver()->getWebDriver();
        $driver->switchTo()->activeElement();
        $keyboard = $driver->getKeyboard();
        $keyboard->sendKeys([$data]);
    }

    /**
     * @Given /^the active element should be "([^"]+)"$/
     *
     * Example: And the active element should be "selector"
     */
    public function theActiveElementShouldBe(string $selector)
    {
        $driver = $this->getSession()->getDriver()->getWebDriver();
        $element = $driver->findElement(WebDriverBy::cssSelector($selector));
        Assert::assertNotNull($element, sprintf('Element %s not found', $selector));
        Assert::assertTrue($element->equals($driver->switchTo()->activeElement()));
    }

    /**
     * @Given /^I type "([^"]+)" in the active element "([^"]+)"$/
     *
     * This method is used to type into the active element.
     *
     * Example: And I type "text" in the active element "selector"
     */
    public function iTypeInTheActiveElement(string $data, string $selector)
    {
        $this->theActiveElementShouldBe($selector);
        $this->iTypeInTheField($data);
    }

    /**
     * Globally press the key i.e. not type into an input and confirm dialog
     *
     * @When /^I press the "([^"]+)" key and confirm the dialog$/
     */
    public function iPressTheKeyAndConfirmTheDialog(string $key)
    {
        $this->iPressTheKeyGlobally($key);
        $this->iConfirmTheDialog();
    }
}