Skip to content

Commit 4adb6a3

Browse files
author
Jonathon Hill
committed
fix: fix session regeneration when used with a CAS handler
1 parent 1021e85 commit 4adb6a3

File tree

7 files changed

+85
-56
lines changed

7 files changed

+85
-56
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/vendor/
22
/.php-cs-fixer.cache
3+
/.vscode

‎features/regeneration.feature‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,17 @@ Feature: Session ID Regeneration
33
Existing session data is copied to the new generated ID.
44
The old session ID may be deleted when the new ID is generated.
55

6-
Scenario: Session ID is regenerated
7-
Given session is started and modified
6+
Scenario Outline: Session ID is regenerated
7+
Given session <handler> stored at <location>
8+
And session is started and modified
89
When session ID is regenerated, delete old session
910
Then session ID should change
1011
And session data should be preserved
1112
And old session should not remain
13+
14+
Examples:
15+
| handler | location |
16+
| kodus | A |
17+
| scrapbook | B |
18+
| redis | 0 |
19+
| file | C |

‎src/Handlers/RedisHandler.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function __construct(Config $config)
3333
public function open($path, $name): bool
3434
{
3535
if (isset($this->redis)) {
36-
return false;
36+
return true;
3737
}
3838

3939
// Parse redis connection settings from save path

‎src/Manager.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,11 @@ public function regenerate_id(bool $delete_old_session = false): bool
242242

243243
$this->currentSession->open($newId);
244244

245+
if ($handler instanceof Handlers\SessionCasHandlerInterface) {
246+
list($contents, $token) = $handler->read_cas($newId);
247+
$this->currentSession->setCasToken($token);
248+
}
249+
245250
if ($delete_old_session) {
246251
return $handler->destroy($oldId);
247252
}

‎tests/behavior/GivenHandlerContextTrait.php‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?php
2+
3+
namespace Compwright\PhpSession\BehaviorTest;
4+
5+
use Compwright\PhpSession\Config;
6+
use Compwright\PhpSession\Handlers\Psr16Handler;
7+
use Compwright\PhpSession\Handlers\ScrapbookHandler;
8+
use Compwright\PhpSession\Handlers\FileHandler;
9+
use Compwright\PhpSession\Handlers\RedisHandler;
10+
use RuntimeException;
11+
12+
trait GivenHandlerContextTrait
13+
{
14+
/**
15+
* @Given session :handler stored at :location
16+
*/
17+
public function sessionHandlerStoredAtLocation(string $handler, string $location): void
18+
{
19+
if ($handler !== 'redis') {
20+
$location = sys_get_temp_dir() . DIRECTORY_SEPARATOR . trim($location);
21+
if (!is_dir($location)) {
22+
mkdir($location, 0777, true);
23+
}
24+
}
25+
26+
$this->config = new Config();
27+
28+
$this->config->setSavePath($location);
29+
30+
switch ($handler) {
31+
case 'kodus':
32+
$cache = new \Kodus\Cache\FileCache($location, $this->config->getGcMaxLifetime());
33+
$handler = new Psr16Handler($this->config, $cache);
34+
break;
35+
case 'scrapbook':
36+
$fs = new \League\Flysystem\Filesystem(
37+
new \League\Flysystem\Local\LocalFilesystemAdapter($location, null, LOCK_EX)
38+
);
39+
$cache = new \MatthiasMullie\Scrapbook\Adapters\Flysystem($fs);
40+
$handler = new ScrapbookHandler($this->config, $cache);
41+
break;
42+
case 'redis':
43+
$this->config->setSavePath('tcp://localhost:6379?database=0');
44+
$handler = new RedisHandler($this->config);
45+
break;
46+
case 'file':
47+
$handler = new FileHandler($this->config);
48+
break;
49+
default:
50+
throw new RuntimeException('Not implemented: ' . $handler);
51+
}
52+
53+
$this->config->setSaveHandler($handler);
54+
}
55+
}

‎tests/behavior/PersistenceContext.php‎

Lines changed: 2 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44

55
use Behat\Behat\Context\Context;
66
use Compwright\PhpSession\Config;
7-
use Compwright\PhpSession\Handlers\Psr16Handler;
8-
use Compwright\PhpSession\Handlers\ScrapbookHandler;
9-
use Compwright\PhpSession\Handlers\FileHandler;
10-
use Compwright\PhpSession\Handlers\RedisHandler;
117
use Compwright\PhpSession\Manager;
128
use Compwright\PhpSession\Session;
139
use PHPUnit\Framework\Assert;
@@ -19,6 +15,8 @@
1915
*/
2016
class PersistenceContext implements Context
2117
{
18+
use GivenHandlerContextTrait;
19+
2220
private Config $config;
2321

2422
private Manager $manager;
@@ -27,48 +25,6 @@ class PersistenceContext implements Context
2725

2826
private string $previousSessionId;
2927

30-
/**
31-
* @Given session :handler stored at :location
32-
*/
33-
public function sessionHandlerStoredAtLocation(string $handler, string $location): void
34-
{
35-
if ($handler !== 'redis') {
36-
$location = sys_get_temp_dir() . DIRECTORY_SEPARATOR . trim($location);
37-
if (!is_dir($location)) {
38-
mkdir($location, 0777, true);
39-
}
40-
}
41-
42-
$this->config = new Config();
43-
44-
$this->config->setSavePath($location);
45-
46-
switch ($handler) {
47-
case 'kodus':
48-
$cache = new \Kodus\Cache\FileCache($location, $this->config->getGcMaxLifetime());
49-
$handler = new Psr16Handler($this->config, $cache);
50-
break;
51-
case 'scrapbook':
52-
$fs = new \League\Flysystem\Filesystem(
53-
new \League\Flysystem\Local\LocalFilesystemAdapter($location, null, LOCK_EX)
54-
);
55-
$cache = new \MatthiasMullie\Scrapbook\Adapters\Flysystem($fs);
56-
$handler = new ScrapbookHandler($this->config, $cache);
57-
break;
58-
case 'redis':
59-
$this->config->setSavePath('tcp://localhost:6379?database=0');
60-
$handler = new RedisHandler($this->config);
61-
break;
62-
case 'file':
63-
$handler = new FileHandler($this->config);
64-
break;
65-
default:
66-
throw new RuntimeException('Not implemented: ' . $handler);
67-
}
68-
69-
$this->config->setSaveHandler($handler);
70-
}
71-
7228
/**
7329
* @Then new session is started
7430
*/

‎tests/behavior/RegenerationContext.php‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
use Behat\Behat\Context\Context;
66
use Compwright\PhpSession\Config;
7-
use Compwright\PhpSession\Handlers\ArrayHandler;
87
use Compwright\PhpSession\Manager;
98
use Compwright\PhpSession\Session;
109
use PHPUnit\Framework\Assert;
@@ -14,6 +13,8 @@
1413
*/
1514
class RegenerationContext implements Context
1615
{
16+
use GivenHandlerContextTrait;
17+
1718
private Config $config;
1819

1920
private Manager $manager;
@@ -24,18 +25,19 @@ public function __construct()
2425
{
2526
$this->config = new Config();
2627
$this->config->setGcProbability(0);
27-
$handler = new ArrayHandler($this->config);
28-
$this->config->setSaveHandler($handler);
29-
$this->manager = new Manager($this->config);
30-
$this->manager->start();
31-
$this->sid = $this->manager->id();
3228
}
3329

3430
/**
3531
* @Given session is started and modified
3632
*/
3733
public function sessionIsStartedAndModified(): void
3834
{
35+
$this->manager = new Manager($this->config);
36+
$isStarted = $this->manager->start();
37+
Assert::assertTrue($isStarted, 'Session failed to start');
38+
39+
$this->sid = $this->manager->id();
40+
3941
/** @var Session $session */
4042
$session = $this->manager->getCurrentSession();
4143
$session->foo = 'bar';
@@ -67,7 +69,9 @@ public function sessionDataShouldBePreserved(): void
6769
{
6870
$manager = new Manager($this->config);
6971
$manager->id($this->manager->id());
70-
$manager->start();
72+
$isStarted = $manager->start();
73+
Assert::assertTrue($isStarted, 'Session failed to start');
74+
7175
/** @var Session $session */
7276
$session = $manager->getCurrentSession();
7377
Assert::assertTrue(isset($session->foo));

0 commit comments

Comments
 (0)