Refs googleapis#369: Fix header handling during cache revalidation.

Author: whatthejeff

src/Google/IO/Abstract.php

@@ -30,6 +30,17 @@ abstract class Google_IO_Abstract
  "HTTP/1.1 200 Connection established\r\n\r\n",
  );
  private static $ENTITY_HTTP_METHODS = array("POST" => null, "PUT" => null);
+ private static $HOP_BY_HOP = array(
+ 'connection' => true,
+ 'keep-alive' => true,
+ 'proxy-authenticate' => true,
+ 'proxy-authorization' => true,
+ 'te' => true,
+ 'trailers' => true,
+ 'transfer-encoding' => true,
+ 'upgrade' => true
+ );
+
 
  /** @var Google_Client */
  protected $client;
@@ -55,13 +66,13 @@ abstract public function executeRequest(Google_Http_Request $request);
  * @param $options
  */
  abstract public function setOptions($options);
- 
+
  /**
  * Set the maximum request time in seconds.
  * @param $timeout in seconds
  */
  abstract public function setTimeout($timeout);
- 
+
  /**
  * Get the maximum request time in seconds.
  * @return timeout in seconds
@@ -96,7 +107,7 @@ public function setCachedRequest(Google_Http_Request $request)
 
  return false;
  }
- 
+
  /**
  * Execute an HTTP Request
  *
@@ -128,7 +139,7 @@ public function makeRequest(Google_Http_Request $request)
  }
 
  if (!isset($responseHeaders['Date']) && !isset($responseHeaders['date'])) {
- $responseHeaders['Date'] = date("r");
+ $responseHeaders['date'] = date("r");
  }
 
  $request->setResponseHttpCode($respHttpCode);
@@ -221,23 +232,24 @@ protected function checkMustRevalidateCachedRequest($cached, $request)
  */
  protected function updateCachedRequest($cached, $responseHeaders)
  {
- if (isset($responseHeaders['connection'])) {
-  $hopByHop = array_merge(
-  self::$HOP_BY_HOP,
- explode(
-  ',',
- $responseHeaders['connection']
+ $hopByHop = self::$HOP_BY_HOP;
+ if (!empty($responseHeaders['connection'])) {
+ $connectionHeaders = array_map(
+ 'strtolower',
+ array_filter(
+ array_map('trim', explode(',', $responseHeaders['connection']))
  )
  );
+ $hopByHop += array_fill_keys($connectionHeaders, true);
+ }
 
- $endToEnd = array();
- foreach ($hopByHop as $key) {
- if (isset($responseHeaders[$key])) {
- $endToEnd[$key] = $responseHeaders[$key];
- }
+ $endToEnd = array();
+ foreach ($responseHeaders as $key => $val) {
+ if (empty($hopByHop[$key])) {
+ $endToEnd[$key] = $val;
  }
- $cached->setResponseHeaders($endToEnd);
  }
+ $cached->setResponseHeaders($endToEnd);
  }
 
  /**
@@ -320,7 +332,7 @@ private function parseArrayHeaders($rawHeaders)
  // Times will have colons in - so we just want the first match.
  $header_parts = explode(': ', $header, 2);
  if (count($header_parts) == 2) {
- $headers[$header_parts[0]] = $header_parts[1];
+ $headers[strtolower($header_parts[0])] = $header_parts[1];
  }
  }
 

tests/general/IoTest.php

@@ -134,6 +134,80 @@ public function testCurlInvalidRequest()
  $this->invalidRequest($io);
  }
 
+ public function testCacheRevalidate()
+ {
+ $client = $this->getClient();
+
+ $req = new Google_Http_Request('/test', 'GET');
+ $req->setRequestHeaders(array('Accept' => '*/*'));
+ $req->setResponseBody('{"a": "foo"}');
+ $req->setResponseHttpCode(200);
+ $req->setResponseHeaders(
+ array(
+ 'cache-control' => 'private',
+ 'etag' => '"this-is-an-etag"',
+ 'expires' => '-1',
+ 'date' => 'Sun, 1 Jan 2012 09:00:56 GMT',
+ 'content-type' => 'application/json; charset=UTF-8',
+ )
+ );
+
+ $io = $this->getMockBuilder('Google_IO_Abstract')
+ ->setConstructorArgs(array($client))
+ ->setMethods(
+ array(
+ 'getCachedRequest',
+ 'checkMustRevalidateCachedRequest'
+ )
+ )
+ ->getMockForAbstractClass();
+
+ $io->expects($this->once())
+ ->method('getCachedRequest')
+ ->will($this->returnValue($req));
+
+ $io->expects($this->once())
+ ->method('checkMustRevalidateCachedRequest')
+ ->will($this->returnValue(true));
+
+ $io->expects($this->once())
+ ->method('executeRequest')
+ ->will(
+ $this->returnValue(
+ array(
+ '{"a": "foo"}',
+ array(
+ 'te' => 'gzip',
+ 'connection' => 'Keep-Alive, Foo, Bar',
+ 'foo' => '123',
+ 'keep-alive' => 'timeout=30',
+ 'cache-control' => 'private',
+ 'eTag' => '"this-is-a-new-etag"',
+ "expires" => 'Sun, 22 Jan 2022 09:00:56 GMT',
+ 'date' => 'Sun, 1 Jan 2012 09:00:56 GMT',
+ 'content-type' => 'application/json; charset=UTF-8',
+ ),
+ 304
+ )
+ )
+ );
+
+ $res = $io->makeRequest(new Google_Http_Request('/test', 'GET'));
+
+ $this->assertEquals('{"a": "foo"}', $res->getResponseBody());
+ $this->assertEquals(200, $res->getResponseHttpCode());
+ $this->assertEquals(
+ array(
+ 'cache-control' => 'private',
+ 'etag' => '"this-is-a-new-etag"',
+ "expires" => 'Sun, 22 Jan 2022 09:00:56 GMT',
+ 'date' => 'Sun, 1 Jan 2012 09:00:56 GMT',
+ 'content-type' => 'application/json; charset=UTF-8',
+ ),
+ $res->getResponseHeaders()
+ );
+ }
+
  // Asserting Functions
 
  public function timeoutChecker($io)