From 213906e2867ddf6187bb140a3002db2c1144ab92 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Thu, 22 Feb 2024 13:05:24 +0000
Subject: [PATCH] Issue #3414287 by catch, longwave: Avoid reading session from
the database multiple times during a big pipe request
---
.../Session/ResponseKeepSessionOpenInterface.php | 16 ++++++++++++++++
core/lib/Drupal/Core/StackMiddleware/Session.php | 3 ++-
core/modules/big_pipe/src/Render/BigPipe.php | 12 ------------
.../big_pipe/src/Render/BigPipeResponse.php | 3 ++-
...OpenTelemetryAuthenticatedPerformanceTest.php | 3 +--
.../StandardPerformanceTest.php | 4 ++--
6 files changed, 23 insertions(+), 18 deletions(-)
create mode 100644 core/lib/Drupal/Core/Session/ResponseKeepSessionOpenInterface.php
diff --git a/core/lib/Drupal/Core/Session/ResponseKeepSessionOpenInterface.php b/core/lib/Drupal/Core/Session/ResponseKeepSessionOpenInterface.php
new file mode 100644
index 000000000000..4f4cdcc30d0a
--- /dev/null
+++ b/core/lib/Drupal/Core/Session/ResponseKeepSessionOpenInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Drupal\Core\Session;
+
+/**
+ * Indicates that sessions for this response should be kept open after sending.
+ *
+ * By default, Drupal closes sessions as soon as the response is sent. If
+ * a response implements this interface, Drupal will skip this behavior and
+ * assume that the session will be closed manually later in the request.
+ *
+ * @see Drupal\Core\StackMiddleware\Session
+ * @see Drupal\big_pipe\src\Render\BigPipeResponse
+ * @internal
+ */
+interface ResponseKeepSessionOpenInterface {}
diff --git a/core/lib/Drupal/Core/StackMiddleware/Session.php b/core/lib/Drupal/Core/StackMiddleware/Session.php
index 94841e1508dd..6e8082b81e44 100644
--- a/core/lib/Drupal/Core/StackMiddleware/Session.php
+++ b/core/lib/Drupal/Core/StackMiddleware/Session.php
@@ -2,6 +2,7 @@
namespace Drupal\Core\StackMiddleware;
+use Drupal\Core\Session\ResponseKeepSessionOpenInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
@@ -58,7 +59,7 @@ public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = TR
$result = $this->httpKernel->handle($request, $type, $catch);
- if ($type === self::MAIN_REQUEST && PHP_SAPI !== 'cli' && $request->hasSession()) {
+ if ($type === self::MAIN_REQUEST && !$result instanceof ResponseKeepSessionOpenInterface && PHP_SAPI !== 'cli' && $request->hasSession()) {
$request->getSession()->save();
}
diff --git a/core/modules/big_pipe/src/Render/BigPipe.php b/core/modules/big_pipe/src/Render/BigPipe.php
index 1dab69c4e3c0..1eab778c0c21 100644
--- a/core/modules/big_pipe/src/Render/BigPipe.php
+++ b/core/modules/big_pipe/src/Render/BigPipe.php
@@ -220,16 +220,6 @@ public function __construct(RendererInterface $renderer, SessionInterface $sessi
}
}
- /**
- * Performs tasks before sending content (and rendering placeholders).
- */
- protected function performPreSendTasks() {
- // The content in the placeholders may depend on the session, and by the
- // time the response is sent (see index.php), the session is already
- // closed. Reopen it for the duration that we are rendering placeholders.
- $this->session->start();
- }
-
/**
* Performs tasks after sending content (and rendering placeholders).
*/
@@ -282,8 +272,6 @@ public function sendContent(BigPipeResponse $response) {
$cumulative_assets = AttachedAssets::createFromRenderArray(['#attached' => $attachments]);
$cumulative_assets->setAlreadyLoadedLibraries($attachments['library']);
- $this->performPreSendTasks();
-
// Find the closing </body> tag and get the strings before and after. But be
// careful to use the latest occurrence of the string "</body>", to ensure
// that strings in inline JavaScript or CDATA sections aren't used instead.
diff --git a/core/modules/big_pipe/src/Render/BigPipeResponse.php b/core/modules/big_pipe/src/Render/BigPipeResponse.php
index 573b7dcb5ef3..0af699617068 100644
--- a/core/modules/big_pipe/src/Render/BigPipeResponse.php
+++ b/core/modules/big_pipe/src/Render/BigPipeResponse.php
@@ -3,6 +3,7 @@
namespace Drupal\big_pipe\Render;
use Drupal\Core\Render\HtmlResponse;
+use Drupal\Core\Session\ResponseKeepSessionOpenInterface;
/**
* A response that is sent in chunks by the BigPipe service.
@@ -18,7 +19,7 @@
* created in https://www.drupal.org/node/2577631. Only code internal to
* BigPipe should instantiate or type hint to this class.
*/
-class BigPipeResponse extends HtmlResponse {
+class BigPipeResponse extends HtmlResponse implements ResponseKeepSessionOpenInterface {
/**
* The BigPipe service.
diff --git a/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php b/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
index 8e66e7df19ae..2612ecf5bac5 100644
--- a/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
+++ b/core/profiles/demo_umami/tests/src/FunctionalJavascript/OpenTelemetryAuthenticatedPerformanceTest.php
@@ -35,8 +35,7 @@ public function testFrontPageAuthenticatedWarmCache(): void {
$performance_data = $this->collectPerformanceData(function () {
$this->drupalGet('<front>');
}, 'authenticatedFrontPage');
- $this->assertGreaterThanOrEqual(10, $performance_data->getQueryCount());
- $this->assertLessThanOrEqual(12, $performance_data->getQueryCount());
+ $this->assertCountBetween(9, 11, $performance_data->getQueryCount());
$this->assertSame(45, $performance_data->getCacheGetCount());
$this->assertSame(0, $performance_data->getCacheSetCount());
$this->assertSame(0, $performance_data->getCacheDeleteCount());
diff --git a/core/profiles/standard/tests/src/FunctionalJavascript/StandardPerformanceTest.php b/core/profiles/standard/tests/src/FunctionalJavascript/StandardPerformanceTest.php
index c977aaf51d1c..5fece5679a74 100644
--- a/core/profiles/standard/tests/src/FunctionalJavascript/StandardPerformanceTest.php
+++ b/core/profiles/standard/tests/src/FunctionalJavascript/StandardPerformanceTest.php
@@ -113,7 +113,7 @@ public function testLogin(): void {
$this->submitLoginForm($account);
});
- $this->assertCountBetween(26, 31, $performance_data->getQueryCount());
+ $this->assertCountBetween(25, 30, $performance_data->getQueryCount());
$this->assertSame(64, $performance_data->getCacheGetCount());
$this->assertSame(1, $performance_data->getCacheSetCount());
$this->assertSame(1, $performance_data->getCacheDeleteCount());
@@ -146,7 +146,7 @@ public function testLoginBlock(): void {
$performance_data = $this->collectPerformanceData(function () use ($account) {
$this->submitLoginForm($account);
});
- $this->assertCountBetween(31, 34, $performance_data->getQueryCount());
+ $this->assertCountBetween(30, 33, $performance_data->getQueryCount());
$this->assertSame(85, $performance_data->getCacheGetCount());
$this->assertSame(1, $performance_data->getCacheSetCount());
$this->assertSame(1, $performance_data->getCacheDeleteCount());
--
GitLab