fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix: [Session] Redis session race condition#8323

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

Merged
kenjis merged 7 commits into from
Feb 23, 2024
Merged

fix: [Session] Redis session race condition #8323

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e37810
style: break long lines
kenjis Dec 11, 2023
ce34999
refactor: use $this->logger instead of log_message()
kenjis Dec 11, 2023
849b93a
fix: Redis Session race condition
kenjis Dec 11, 2023
63beda2
fix: close() should return false if releaseLock() failed
kenjis Feb 22, 2024
7707ddf
fix: read() should return false if lockSession() failed
kenjis Feb 22, 2024
0617a7b
refactor: by rector
kenjis Feb 22, 2024
2fa55d4
docs: add @throws
kenjis Feb 23, 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
67 changes: 44 additions & 23 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,8 @@ protected function setSavePath(): void
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws RedisException
*/
public function open($path, $name): bool
{
Expand All@@ -124,12 +126,20 @@ public function open($path, $name): bool

$redis = new Redis();

if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
if (
! $redis->connect(
$this->savePath['protocol'] . '://' . $this->savePath['host'],
($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']),
$this->savePath['timeout']
)
) {
$this->logger->error('Session: Unable to connect to Redis with the configured settings.');
} elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
$this->logger->error('Session: Unable to authenticate to Redis instance.');
} elseif (isset($this->savePath['database']) && ! $redis->select($this->savePath['database'])) {
$this->logger->error('Session: Unable to select Redis database with index ' . $this->savePath['database']);
$this->logger->error(
'Session: Unable to select Redis database with index ' . $this->savePath['database']
);
} else {
$this->redis = $redis;

Expand All@@ -146,6 +156,8 @@ public function open($path, $name): bool
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*
* @throws RedisException
*/
#[ReturnTypeWillChange]
public function read($id)
Expand All@@ -168,14 +180,16 @@ public function read($id)
return $data;
}

return '';
return false;
}

/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*
* @throws RedisException
*/
public function write($id, $data): bool
{
Expand DownExpand Up@@ -222,8 +236,8 @@ public function close(): bool
$pingReply = $this->redis->ping();

if (($pingReply === true) || ($pingReply === '+PONG')) {
if (isset($this->lockKey)) {
$this->releaseLock();
if (isset($this->lockKey) && ! $this->releaseLock()) {
return false;
}

if (! $this->redis->close()) {
Expand All@@ -246,12 +260,16 @@ public function close(): bool
* Destroys a session
*
* @param string $id The session ID being destroyed
*
* @throws RedisException
*/
public function destroy($id): bool
{
if (isset($this->redis, $this->lockKey)) {
if (($result = $this->redis->del($this->keyPrefix . $id)) !== 1) {
$this->logger->debug('Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.');
$this->logger->debug(
'Session: Redis::del() expected to return 1, got ' . var_export($result, true) . ' instead.'
);
}

return $this->destroyCookie();
Expand All@@ -278,6 +296,8 @@ public function gc($max_lifetime)
* Acquires an emulated lock.
*
* @param string $sessionID Session ID
*
* @throws RedisException
*/
protected function lockSession(string $sessionID): bool
{
Expand All@@ -287,48 +307,49 @@ protected function lockSession(string $sessionID): bool
// so we need to check here if the lock key is for the
// correct session ID.
if ($this->lockKey === $lockKey) {
// If there is the lock, make the ttl longer.
return $this->redis->expire($this->lockKey, 300);
}

$attempt = 0;

do {
$ttl = $this->redis->ttl($lockKey);
assert(is_int($ttl));
$result = $this->redis->set(
$lockKey,
(string) Time::now()->getTimestamp(),
// NX -- Only set the key if it does not already exist.
// EX seconds -- Set the specified expire time, in seconds.
['nx', 'ex' => 300]
);

if ($ttl > 0) {
sleep(1);
if (! $result) {
usleep(100000);

continue;
}

if (! $this->redis->setex($lockKey, 300, (string) Time::now()->getTimestamp())) {
$this->logger->error('Session: Error while trying to obtain lock for ' . $this->keyPrefix . $sessionID);

return false;
}

$this->lockKey = $lockKey;
break;
} while (++$attempt < 30);
} while (++$attempt < 300);

if ($attempt === 30) {
log_message('error', 'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID . ' after 30 attempts, aborting.');
if ($attempt === 300) {
$this->logger->error(
'Session: Unable to obtain lock for ' . $this->keyPrefix . $sessionID
. ' after 300 attempts, aborting.'
);

return false;
}

if ($ttl === -1) {
log_message('debug', 'Session: Lock for ' . $this->keyPrefix . $sessionID . ' had no TTL, overriding.');
}

$this->lock = true;

return true;
}

/**
* Releases a previously acquired lock
*
* @throws RedisException
*/
protected function releaseLock(): bool
{
Expand Down