Do not send null values in cookie array (fixes #626)

Author: JorisVanEijden

lib/Cookie.php

@@ -27,15 +27,7 @@
 class Cookie implements \ArrayAccess
 {
     /** @var array */
-    protected $cookie = [
-        'name' => null,
-        'value' => null,
-        'path' => null,
-        'domain' => null,
-        'expiry' => null,
-        'secure' => null,
-        'httpOnly' => null,
-    ];
+    protected $cookie = [];
 
     /**
      * @param string $name The name of the cookie; may not be null or an empty string.
@@ -51,11 +43,17 @@ public function __construct($name, $value)
     }
 
     /**
-     * @param array $cookieArray
+     * @param array $cookieArray The cookie fields; must contain name and value.
      * @return Cookie
      */
     public static function createFromArray(array $cookieArray)
     {
+        if (!isset($cookieArray['name'])) {
+            throw new InvalidArgumentException('Cookie name should be set');
+        }
+        if (!isset($cookieArray['value'])) {
+            throw new InvalidArgumentException('Cookie value should be set');
+        }
         $cookie = new self($cookieArray['name'], $cookieArray['value']);
 
         if (isset($cookieArray['path'])) {
@@ -82,15 +80,15 @@ public static function createFromArray(array $cookieArray)
      */
     public function getName()
     {
-        return $this->cookie['name'];
+        return $this->offsetGet('name');
     }
 
     /**
      * @return string
      */
     public function getValue()
     {
-        return $this->cookie['value'];
+        return $this->offsetGet('value');
     }
 
     /**
@@ -100,15 +98,15 @@ public function getValue()
      */
     public function setPath($path)
     {
-        $this->cookie['path'] = $path;
+        $this->offsetSet('path', $path);
     }
 
     /**
      * @return string|null
      */
     public function getPath()
     {
-        return $this->cookie['path'];
+        return $this->offsetGet('path');
     }
 
     /**
@@ -122,15 +120,15 @@ public function setDomain($domain)
             throw new InvalidArgumentException(sprintf('Cookie domain "%s" should not contain a port', $domain));
         }
 
-        $this->cookie['domain'] = $domain;
+        $this->offsetSet('domain', $domain);
     }
 
     /**
      * @return string|null
      */
     public function getDomain()
     {
-        return $this->cookie['domain'];
+        return $this->offsetGet('domain');
     }
 
     /**
@@ -140,15 +138,15 @@ public function getDomain()
      */
     public function setExpiry($expiry)
     {
-        $this->cookie['expiry'] = (int) $expiry;
+        $this->offsetSet('expiry', (int) $expiry);
     }
 
     /**
      * @return int|null
      */
     public function getExpiry()
     {
-        return $this->cookie['expiry'];
+        return $this->offsetGet('expiry');
     }
 
     /**
@@ -158,15 +156,15 @@ public function getExpiry()
      */
     public function setSecure($secure)
     {
-        $this->cookie['secure'] = $secure;
+        $this->offsetSet('secure', $secure);
     }
 
     /**
      * @return bool|null
      */
     public function isSecure()
     {
-        return $this->cookie['secure'];
+        return $this->offsetGet('secure');
     }
 
     /**
@@ -176,15 +174,15 @@ public function isSecure()
      */
     public function setHttpOnly($httpOnly)
     {
-        $this->cookie['httpOnly'] = $httpOnly;
+        $this->offsetSet('httpOnly', $httpOnly);
     }
 
     /**
      * @return bool|null
      */
     public function isHttpOnly()
     {
-        return $this->cookie['httpOnly'];
+        return $this->offsetGet('httpOnly');
     }
 
     /**
@@ -202,12 +200,16 @@ public function offsetExists($offset)
 
     public function offsetGet($offset)
     {
-        return $this->cookie[$offset];
+        return $this->offsetExists($offset) ? $this->cookie[$offset] : null;
     }
 
     public function offsetSet($offset, $value)
     {
-        $this->cookie[$offset] = $value;
+        if ($value === null) {
+            unset($this->cookie[$offset]);
+        } else {
+            $this->cookie[$offset] = $value;
+        }
     }
 
     public function offsetUnset($offset)

tests/unit/CookieTest.php

@@ -62,6 +62,28 @@ public function testShouldBeConvertibleToArray(Cookie $cookie)
         );
     }
 
+    /**
+     * Test that there are no null values in the cookie array.
+     *
+     * Both JsonWireProtocol and w3c protocol say to leave an entry off
+     * rather than having a null value.
+     *
+     * https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol
+     * https://w3c.github.io/webdriver/#add-cookie
+     */
+    public function testShouldNotContainNullValues()
+    {
+        $cookie = new Cookie('cookieName', 'someValue');
+
+        $cookie->setHttpOnly(null);
+        $cookie->setPath(null);
+        $cookieArray = $cookie->toArray();
+
+        foreach ($cookieArray as $key => $value) {
+            $this->assertNotNull($value, $key . ' should not be null');
+        }
+    }
+
     /**
      * @depends testShouldSetAllProperties
      * @param Cookie $cookie