bug #22036 Set Date header in Response constructor already (mpdude)

fabpot · fabpot · commit e3d90db74773 · 2017-03-22T14:18:49.000-07:00
This PR was squashed before being merged into the 2.8 branch (closes #22036). Discussion ---------- Set Date header in Response constructor already | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Setting the `Date` header in the `Response` constructor has been removed in #14912 and changed to a more lazy approach in `getDate()`. That way, methods like `getAge()`, `getTtl()` or `isFresh()` cause side effects as they eventually call `getDate()` and the Request "starts to age" once you call them. I don't know if this would be a nice test, but current behaviour is ```php $response = new Response(); $response->setSharedMaxAge(10); sleep(20); $this->assertTrue($response->isFresh()); sleep(5); $this->assertTrue($response->isFresh()); sleep(5); $this->assertFalse($response->isFresh()); ``` A particular weird case is the `isCacheable()` method, because it calls `isFresh()` only under certain conditions, like particular status codes, no `ETag` present etc. This symptom is also described under "Cause of the problem" in #19390, however the problem is worked around there in other ways. So, this PR suggests to effectively revert #14912. Additionally, I'd like to suggest to move this special handling of the `Date` header into the `ResponseHeaderBag`. If the `ResponseHeaderBag` guards that we always have the `Date`, we would not need special logic in `sendHeaders()` and could also take care of #14912 (comment). Commits ------- 3a7fa7e Set Date header in Response constructor already
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -201,6 +201,11 @@ public function __construct($content = '', $status = 200, $headers = array())
         $this->setContent($content);
         $this->setStatusCode($status);
         $this->setProtocolVersion('1.0');
+
+        /* RFC2616 - 14.18 says all Responses need to have a Date */
+        if (!$this->headers->has('Date')) {
+            $this->setDate(new \DateTime(null, new \DateTimeZone('UTC')));
+        }
     }
 
     /**
@@ -329,6 +334,7 @@ public function sendHeaders()
             return $this;
         }
 
+        /* RFC2616 - 14.18 says all Responses need to have a Date */
         if (!$this->headers->has('Date')) {
             $this->setDate(\DateTime::createFromFormat('U', time()));
         }
@@ -612,6 +618,11 @@ public function mustRevalidate()
      */
     public function getDate()
     {
+        /*
+            RFC2616 - 14.18 says all Responses need to have a Date.
+            Make sure we provide one even if it the header
+            has been removed in the meantime.
+         */
         if (!$this->headers->has('Date')) {
             $this->setDate(\DateTime::createFromFormat('U', time()));
         }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php
@@ -276,8 +276,10 @@ public function testGetDate()
         $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the date when the header has been modified');
 
         $response = new Response('', 200);
+        $now = $this->createDateTimeNow();
         $response->headers->remove('Date');
-        $this->assertInstanceOf('\DateTime', $response->getDate());
+        $date = $response->getDate();
+        $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the current Date when the header has previously been removed');
     }
 
     public function testGetMaxAge()

Original file line number	Diff line number	Diff line change
`@@ -201,6 +201,11 @@ public function __construct($content = '', $status = 200, $headers = array())`
`201`	`201`	`$this->setContent($content);`
`202`	`202`	`$this->setStatusCode($status);`
`203`	`203`	`$this->setProtocolVersion('1.0');`
	`204`	`+`
	`205`	`+ /* RFC2616 - 14.18 says all Responses need to have a Date */`
	`206`	`+ if (!$this->headers->has('Date')) {`
	`207`	`+ $this->setDate(new \DateTime(null, new \DateTimeZone('UTC')));`
	`208`	`+ }`
`204`	`209`	`}`
`205`	`210`
`206`	`211`	`/**`
`@@ -329,6 +334,7 @@ public function sendHeaders()`
`329`	`334`	`return $this;`
`330`	`335`	`}`
`331`	`336`
	`337`	`+ /* RFC2616 - 14.18 says all Responses need to have a Date */`
`332`	`338`	`if (!$this->headers->has('Date')) {`
`333`	`339`	`$this->setDate(\DateTime::createFromFormat('U', time()));`
`334`	`340`	`}`
`@@ -612,6 +618,11 @@ public function mustRevalidate()`
`612`	`618`	`*/`
`613`	`619`	`public function getDate()`
`614`	`620`	`{`
	`621`	`+ /*`
	`622`	`+ RFC2616 - 14.18 says all Responses need to have a Date.`
	`623`	`+ Make sure we provide one even if it the header`
	`624`	`+ has been removed in the meantime.`
	`625`	`+ */`
`615`	`626`	`if (!$this->headers->has('Date')) {`
`616`	`627`	`$this->setDate(\DateTime::createFromFormat('U', time()));`
`617`	`628`	`}`