Rename master request to main request

Author: derrabus

CHANGELOG.md

@@ -8,7 +8,8 @@ CHANGELOG
  * Calling `Request::getSession()` when there is no available session throws a `SessionNotFoundException`
  * Add the `RequestStack::getSession` method
  * Deprecate the `NamespacedAttributeBag` class
- * added `ResponseFormatSame` PHPUnit constraint
+ * Add `ResponseFormatSame` PHPUnit constraint
+ * Deprecate the `RequestStack::getMasterRequest()` method and add `getMainRequest()` as replacement
 
 5.2.0
 -----

RequestStack.php

@@ -65,15 +65,13 @@ public function getCurrentRequest()
     }
 
     /**
-     * Gets the master Request.
+     * Gets the main request.
      *
-     * Be warned that making your code aware of the master request
+     * Be warned that making your code aware of the main request
      * might make it un-compatible with other features of your framework
      * like ESI support.
-     *
-     * @return Request|null
      */
-    public function getMasterRequest()
+    public function getMainRequest(): ?Request
     {
         if (!$this->requests) {
             return null;
@@ -82,14 +80,28 @@ public function getMasterRequest()
         return $this->requests[0];
     }
 
+    /**
+     * Gets the master request.
+     *
+     * @return Request|null
+     *
+     * @deprecated since symfony/http-foundation 5.3, use getMainRequest() instead
+     */
+    public function getMasterRequest()
+    {
+        trigger_deprecation('symfony/http-foundation', '5.3', '"%s()" is deprecated, use "getMainRequest()" instead.', __METHOD__);
+
+        return $this->getMainRequest();
+    }
+
     /**
      * Returns the parent request of the current.
      *
      * Be warned that making your code aware of the parent request
      * might make it un-compatible with other features of your framework
      * like ESI support.
      *
-     * If current Request is the master request, it returns null.
+     * If current Request is the main request, it returns null.
      *
      * @return Request|null
      */

Session/SessionFactory.php

@@ -35,6 +35,6 @@ public function __construct(RequestStack $requestStack, SessionStorageFactoryInt
 
     public function createSession(): SessionInterface
     {
-        return new Session($this->storageFactory->createStorage($this->requestStack->getMasterRequest()), null, null, $this->usageReporter);
+        return new Session($this->storageFactory->createStorage($this->requestStack->getMainRequest()), null, null, $this->usageReporter);
     }
 }

Tests/RequestStackTest.php

@@ -12,11 +12,14 @@
 namespace Symfony\Component\HttpFoundation\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 
 class RequestStackTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     public function testGetCurrentRequest()
     {
         $requestStack = new RequestStack();
@@ -33,6 +36,23 @@ public function testGetCurrentRequest()
         $this->assertNull($requestStack->pop());
     }
 
+    public function testGetMainRequest()
+    {
+        $requestStack = new RequestStack();
+        $this->assertNull($requestStack->getMainRequest());
+
+        $mainRequest = Request::create('/foo');
+        $subRequest = Request::create('/bar');
+
+        $requestStack->push($mainRequest);
+        $requestStack->push($subRequest);
+
+        $this->assertSame($mainRequest, $requestStack->getMainRequest());
+    }
+
+    /**
+     * @group legacy
+     */
     public function testGetMasterRequest()
     {
         $requestStack = new RequestStack();
@@ -44,6 +64,7 @@ public function testGetMasterRequest()
         $requestStack->push($masterRequest);
         $requestStack->push($subRequest);
 
+        $this->expectDeprecation('Since symfony/http-foundation 5.3: "Symfony\Component\HttpFoundation\RequestStack::getMasterRequest()" is deprecated, use "getMainRequest()" instead.');
         $this->assertSame($masterRequest, $requestStack->getMasterRequest());
     }
 
@@ -52,15 +73,15 @@ public function testGetParentRequest()
         $requestStack = new RequestStack();
         $this->assertNull($requestStack->getParentRequest());
 
-        $masterRequest = Request::create('/foo');
+        $mainRequest = Request::create('/foo');
 
-        $requestStack->push($masterRequest);
+        $requestStack->push($mainRequest);
         $this->assertNull($requestStack->getParentRequest());
 
         $firstSubRequest = Request::create('/bar');
 
         $requestStack->push($firstSubRequest);
-        $this->assertSame($masterRequest, $requestStack->getParentRequest());
+        $this->assertSame($mainRequest, $requestStack->getParentRequest());
 
         $secondSubRequest = Request::create('/baz');
 

UrlHelper.php

@@ -35,7 +35,7 @@ public function getAbsoluteUrl(string $path): string
             return $path;
         }
 
-        if (null === $request = $this->requestStack->getMasterRequest()) {
+        if (null === $request = $this->requestStack->getMainRequest()) {
             return $this->getAbsoluteUrlFromContext($path);
         }
 
@@ -64,7 +64,7 @@ public function getRelativePath(string $path): string
             return $path;
         }
 
-        if (null === $request = $this->requestStack->getMasterRequest()) {
+        if (null === $request = $this->requestStack->getMainRequest()) {
             return $path;
         }