From f5c6bf01c4fc54c01d4c9f768ecfde7284063d88 Mon Sep 17 00:00:00 2001
From: catch <catch@35733.no-reply.drupal.org>
Date: Mon, 30 Nov 2020 12:18:49 +0000
Subject: [PATCH] Issue #3132887 by mondrake, longwave, anmolgoyal74,
kishor_kolekar: Deprecate BrowserTestBase::drupalGetHeader()
---
.../big_pipe/tests/src/Functional/BigPipeTest.php | 4 ++--
...uilderFieldBlockEntityReferenceCacheTagsTest.php | 2 +-
.../tests/src/Functional/PageCacheTest.php | 4 ++--
.../Cache/AssertPageCacheContextsAndTagsTrait.php | 13 ++++---------
.../Functional/Entity/EntityCacheTagsTestBase.php | 4 ++--
.../Drupal/FunctionalTests/BrowserTestBaseTest.php | 11 +++++++++++
core/tests/Drupal/Tests/BrowserTestBase.php | 6 ++++++
7 files changed, 28 insertions(+), 16 deletions(-)
diff --git a/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php b/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php
index 511cf79aa3db..fad6538fd91a 100644
--- a/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php
+++ b/core/modules/big_pipe/tests/src/Functional/BigPipeTest.php
@@ -341,7 +341,7 @@ protected function assertBigPipeResponseHeadersPresent() {
* markup.
*/
protected function assertBigPipeNoJsPlaceholders(array $expected_big_pipe_nojs_placeholders) {
- $this->assertSetsEqual(array_keys($expected_big_pipe_nojs_placeholders), array_map('rawurldecode', explode(' ', $this->drupalGetHeader('BigPipe-Test-No-Js-Placeholders'))));
+ $this->assertSetsEqual(array_keys($expected_big_pipe_nojs_placeholders), array_map('rawurldecode', explode(' ', $this->getSession()->getResponseHeader('BigPipe-Test-No-Js-Placeholders'))));
foreach ($expected_big_pipe_nojs_placeholders as $big_pipe_nojs_placeholder => $expected_replacement) {
// Checking whether the replacement for the BigPipe no-JS placeholder
// $big_pipe_nojs_placeholder is present.
@@ -362,7 +362,7 @@ protected function assertBigPipeNoJsPlaceholders(array $expected_big_pipe_nojs_p
* defined in the order that they are expected to be rendered & streamed.
*/
protected function assertBigPipePlaceholders(array $expected_big_pipe_placeholders, array $expected_big_pipe_placeholder_stream_order) {
- $this->assertSetsEqual(array_keys($expected_big_pipe_placeholders), explode(' ', $this->drupalGetHeader('BigPipe-Test-Placeholders')));
+ $this->assertSetsEqual(array_keys($expected_big_pipe_placeholders), explode(' ', $this->getSession()->getResponseHeader('BigPipe-Test-Placeholders')));
$placeholder_positions = [];
$placeholder_replacement_positions = [];
foreach ($expected_big_pipe_placeholders as $big_pipe_placeholder_id => $expected_ajax_response) {
diff --git a/core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php b/core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php
index c4f2f505c85e..f5d5e78e2b2f 100644
--- a/core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php
+++ b/core/modules/layout_builder/tests/src/Functional/LayoutBuilderFieldBlockEntityReferenceCacheTagsTest.php
@@ -130,7 +130,7 @@ protected function verifyPageCacheContainsTags(Url $url, $hit_or_miss, $tags = F
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', $hit_or_miss);
if ($hit_or_miss === 'HIT' && is_array($tags)) {
- $cache_tags = explode(' ', $this->drupalGetHeader('X-Drupal-Cache-Tags'));
+ $cache_tags = explode(' ', $this->getSession()->getResponseHeader('X-Drupal-Cache-Tags'));
$tags = array_unique($tags);
$this->assertEmpty(array_diff($tags, $cache_tags), 'Page cache tags contains all expected tags.');
}
diff --git a/core/modules/page_cache/tests/src/Functional/PageCacheTest.php b/core/modules/page_cache/tests/src/Functional/PageCacheTest.php
index 13e427e59f0e..dfb83c8af28c 100644
--- a/core/modules/page_cache/tests/src/Functional/PageCacheTest.php
+++ b/core/modules/page_cache/tests/src/Functional/PageCacheTest.php
@@ -204,8 +204,8 @@ public function testConditionalRequests() {
$this->drupalGet('');
$this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'HIT');
- $etag = $this->drupalGetHeader('ETag');
- $last_modified = $this->drupalGetHeader('Last-Modified');
+ $etag = $this->getSession()->getResponseHeader('ETag');
+ $last_modified = $this->getSession()->getResponseHeader('Last-Modified');
// Ensure a conditional request returns 304 Not Modified.
$this->drupalGet('', [], ['If-Modified-Since' => $last_modified, 'If-None-Match' => $etag]);
diff --git a/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php b/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php
index 236d42920ff0..6c70a38ae762 100644
--- a/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php
+++ b/core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php
@@ -31,13 +31,8 @@ protected function enablePageCaching() {
* The header value, potentially exploded by spaces.
*/
protected function getCacheHeaderValues($header_name) {
- $header_value = $this->drupalGetHeader($header_name);
- if (empty($header_value)) {
- return [];
- }
- else {
- return explode(' ', $header_value);
- }
+ $header_value = $this->getSession()->getResponseHeader($header_name);
+ return empty($header_value) ? [] : explode(' ', $header_value);
}
/**
@@ -47,7 +42,7 @@ protected function getCacheHeaderValues($header_name) {
* The expected cache context.
*/
protected function assertCacheContext($expected_cache_context) {
- $cache_contexts = explode(' ', $this->drupalGetHeader('X-Drupal-Cache-Contexts'));
+ $cache_contexts = explode(' ', $this->getSession()->getResponseHeader('X-Drupal-Cache-Contexts'));
$this->assertContains($expected_cache_context, $cache_contexts, "'" . $expected_cache_context . "' is present in the X-Drupal-Cache-Contexts header.");
}
@@ -58,7 +53,7 @@ protected function assertCacheContext($expected_cache_context) {
* The expected cache context.
*/
protected function assertNoCacheContext($not_expected_cache_context) {
- $cache_contexts = explode(' ', $this->drupalGetHeader('X-Drupal-Cache-Contexts'));
+ $cache_contexts = explode(' ', $this->getSession()->getResponseHeader('X-Drupal-Cache-Contexts'));
$this->assertNotContains($not_expected_cache_context, $cache_contexts, "'" . $not_expected_cache_context . "' is not present in the X-Drupal-Cache-Contexts header.");
}
diff --git a/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php b/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php
index 975134d27652..cdf4c4b440fc 100644
--- a/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php
+++ b/core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php
@@ -426,7 +426,7 @@ public function testReferencedEntity() {
// Verify a cache hit, but also the presence of the correct cache tags.
$this->verifyPageCache($empty_entity_listing_url, 'HIT', $empty_entity_listing_cache_tags);
// Verify the entity type's list cache contexts are present.
- $contexts_in_header = $this->drupalGetHeader('X-Drupal-Cache-Contexts');
+ $contexts_in_header = $this->getSession()->getResponseHeader('X-Drupal-Cache-Contexts');
$this->assertEqual(Cache::mergeContexts($page_cache_contexts, $this->getAdditionalCacheContextsForEntityListing()), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));
// Prime the page cache for the listing containing the referenced entity.
@@ -434,7 +434,7 @@ public function testReferencedEntity() {
// Verify a cache hit, but also the presence of the correct cache tags.
$this->verifyPageCache($nonempty_entity_listing_url, 'HIT', $nonempty_entity_listing_cache_tags);
// Verify the entity type's list cache contexts are present.
- $contexts_in_header = $this->drupalGetHeader('X-Drupal-Cache-Contexts');
+ $contexts_in_header = $this->getSession()->getResponseHeader('X-Drupal-Cache-Contexts');
$this->assertEqual(Cache::mergeContexts($page_cache_contexts, $this->getAdditionalCacheContextsForEntityListing()), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));
// Verify that after modifying the referenced entity, there is a cache miss
diff --git a/core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php b/core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php
index d393577678dd..15b2ee93508c 100644
--- a/core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php
+++ b/core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php
@@ -917,4 +917,15 @@ public function testLegacyFieldAssertsByName() {
$this->assertNoFieldByName('checkbox_enabled', FALSE);
}
+ /**
+ * Tests legacy drupalGetHeader().
+ *
+ * @group legacy
+ */
+ public function testDrupalGetHeader() {
+ $this->expectDeprecation('BrowserTestBase::drupalGetHeader() is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use $this->getSession()->getResponseHeader() instead. See https://www.drupal.org/node/3168383');
+ $this->drupalGet('test-page');
+ $this->drupalGetHeader('Content-Type');
+ }
+
}
diff --git a/core/tests/Drupal/Tests/BrowserTestBase.php b/core/tests/Drupal/Tests/BrowserTestBase.php
index 4d22affda49b..985a23a98a7c 100644
--- a/core/tests/Drupal/Tests/BrowserTestBase.php
+++ b/core/tests/Drupal/Tests/BrowserTestBase.php
@@ -674,8 +674,14 @@ protected function config($name) {
*
* @return string|null
* The HTTP header value or NULL if not found.
+ *
+ * @deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use
+ * $this->getSession()->getResponseHeader() instead.
+ *
+ * @see https://www.drupal.org/node/3168383
*/
protected function drupalGetHeader($name) {
+ @trigger_error('BrowserTestBase::drupalGetHeader() is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use $this->getSession()->getResponseHeader() instead. See https://www.drupal.org/node/3168383', E_USER_DEPRECATED);
return $this->getSession()->getResponseHeader($name);
}
--
GitLab