Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harden window closing code upon session reset #27

Merged
merged 6 commits into from
Jun 28, 2024
Merged

Harden window closing code upon session reset #27

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7d71e14
Harden window closing code upon session reset
aik099 Apr 7, 2024
3270459
Rewritten implementation to window handles directly (avoids name-to-h…
aik099 Apr 8, 2024
da234b2
Use initial window handle instead of name
aik099 Apr 9, 2024
e58c490
Simplify window closing code upon session reset
aik099 Apr 9, 2024
43666a6
Moving window closing upon session reset test into the `driver-testsu…
aik099 Apr 9, 2024
d04dfda
Renamed variables in the "switchToWindow" method to better explain co…
aik099 Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/WebdriverClassicDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,16 +136,22 @@ public function stop(): void
*/
public function reset(): void
{
$webDriver = $this->getWebDriver();

// switch to default window..
$this->switchToWindow();
$initialWindow = substr((string)$this->initialWindowName, strlen(self::W3C_WINDOW_HANDLE_PREFIX));
uuf6429 marked this conversation as resolved.
Show resolved Hide resolved
$webDriver->switchTo()->window($initialWindow);

// ..and close all other windows
foreach ($this->getWindowNames() as $name) {
if ($name !== $this->initialWindowName) {
$this->withWindow($name, fn() => $this->getWebDriver()->close());
foreach ($webDriver->getWindowHandles() as $tempWindow) {
if ($tempWindow !== $initialWindow) {
$webDriver->switchTo()->window($tempWindow);
$webDriver->close();
$webDriver->switchTo()->window($initialWindow);
}
}

$this->getWebDriver()->manage()->deleteAllCookies();
$webDriver->manage()->deleteAllCookies();
}

public function visit(string $url): void
Expand Down
62 changes: 62 additions & 0 deletions tests/Custom/SessionResetTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?php

namespace Mink\WebdriverClassDriver\Tests\Custom;

use Behat\Mink\Tests\Driver\TestCase;

class SessionResetTest extends TestCase
{
/**
* @dataProvider initialWindowNameDataProvider
*/
public function testSessionResetClosesWindows(?string $initialWindowName): void
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stof Would it make sense to put this test in driver-testsuite?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this test into the driver's test suite instead of the Mink driver test suite because the window closing behavior upon session reset is non-standard or advertised anywhere.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest adding that in the driver testsuite as I think it makes sense for any driver supporting to open new windows to close them on reset.

We can update the phpdoc of the DriverInterface to suggest drivers to close extra windows.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest adding that in the driver testsuite as I think it makes sense for any driver supporting to open new windows to close them on reset.

Done in the minkphp/driver-testsuite#96 .

We can update the phpdoc of the DriverInterface to suggest drivers to close extra windows.

@stof , please review my other PRs (7 by today). It's been over a month now, and I don't know if you've looked at them and they're OK to merge or I need to change something.

Also what can I do to speed up the review process?

Once that is arranged I can try creating a DriverInterface-related PR.

{
$session = $this->getSession();
$session->visit($this->pathTo('/window.html'));

if (null !== $initialWindowName) {
$session->executeScript('window.name = "'.$initialWindowName.'";');
}

$page = $session->getPage();

$page->clickLink('Popup #1');
$page->clickLink('Popup #2');

$expectedInitialWindowName = $session->evaluateScript('window.name');

$windowNames = $session->getWindowNames();
$this->assertCount(3, $windowNames);

$session->reset();

$windowNames = $session->getWindowNames();
$this->assertCount(1, $windowNames);
uuf6429 marked this conversation as resolved.
Show resolved Hide resolved

$actualInitialWindowName = $session->evaluateScript('window.name');
$this->assertEquals($expectedInitialWindowName, $actualInitialWindowName);
}

public static function initialWindowNameDataProvider(): array
{
return array(
'no name' => array(null),
'non-empty name' => array('initial-window'),
);
}

/**
* @after
*/
protected function resetSessions()
{
$session = $this->getSession();

// Stop the session instead of resetting, because resetting behavior is being tested.
if ($session->isStarted()) {
$session->stop();
}

parent::resetSessions();
}
}
Loading