added support for shard count

jsteemann · jsteemann · commit a64211cbceb4 · 2021-04-23T17:22:32.000+02:00
diff --git a/lib/ArangoDBClient/CollectionHandler.php b/lib/ArangoDBClient/CollectionHandler.php
@@ -394,22 +394,21 @@ public function has($collection)
      * @throws Exception
      *
      * @param mixed $collection - collection id as a string or number
+     * @param bool  $details    - optional, will provide per-shard counts in a cluster
      *
-     * @return int - the number of documents in the collection
+     * @return mixed - int if details=false, the number of documents in the collection, array if details=true
      */
-    public function count($collection)
+    public function count($collection, $details = false)
     {
         $headers    = [];
         $this->addTransactionHeader($headers, $collection);
 
         $collection = $this->makeCollection($collection);
         $url        = UrlHelper::buildUrl(Urls::URL_COLLECTION, [$collection, self::OPTION_COUNT]);
+        $url        = UrlHelper::appendParamsUrl($url, ['details' => $details]);
         $response   = $this->getConnection()->get($url, $headers);
-
-        $data  = $response->getJson();
-        $count = $data[self::OPTION_COUNT];
-
-        return (int) $count;
+        $data       = $response->getJson();
+        return $data[self::OPTION_COUNT];
     }
 
 
diff --git a/lib/ArangoDBClient/Connection.php b/lib/ArangoDBClient/Connection.php
@@ -424,9 +424,17 @@ private function updateHttpHeader()
             $this->_httpHeader .= sprintf('Host: %s%s', Endpoint::getHost($endpoint), HttpHelper::EOL);
         }
 
-        if (isset($this->_options[ConnectionOptions::OPTION_AUTH_TYPE], $this->_options[ConnectionOptions::OPTION_AUTH_USER])) {
+        if (isset($this->_options[ConnectionOptions::OPTION_AUTH_JWT])) {
+            // JWT, used as is 
+            $this->_httpHeader .= sprintf(
+                'Authorization: Bearer %s%s',
+                $this->_options[ConnectionOptions::OPTION_AUTH_JWT],
+                HttpHelper::EOL
+            );
+        } else if (isset($this->_options[ConnectionOptions::OPTION_AUTH_TYPE], $this->_options[ConnectionOptions::OPTION_AUTH_USER])) {
+            // create a JWT for a given user and server's JWT secret 
             if ($this->_options[ConnectionOptions::OPTION_AUTH_TYPE] == 'Bearer') {
-                // JWT
+                // JWT secret
                 $base = json_encode(['typ' => 'JWT', 'alg' => 'HS256']);
                 $base64UrlHeader = str_replace(['+', '/', '='], ['-', '_', ''], base64_encode($base));
                 $payload = json_encode([
diff --git a/lib/ArangoDBClient/ConnectionOptions.php b/lib/ArangoDBClient/ConnectionOptions.php
@@ -169,6 +169,11 @@ class ConnectionOptions implements \ArrayAccess
      * Wait for sync index constant
      */
     const OPTION_IS_SYSTEM = 'isSystem';
+    
+    /**
+     * Authentication JWT
+     */
+    const OPTION_AUTH_JWT = 'Jwt';
 
     /**
      * Authentication user name
diff --git a/tests/CollectionBasicTest.php b/tests/CollectionBasicTest.php
@@ -1287,6 +1287,66 @@ public function testHasCollectionReturnsTrueIfCollectionExists()
     }
     
     
+    /**
+     * count
+     */
+    public function testCollectionCountDetailed()
+    {
+        if (!isCluster($this->connection)) {
+            // don't execute this test in a non-cluster
+            $this->markTestSkipped("test is only meaningful in cluster");
+            return;
+        }
+
+        $connection        = $this->connection;
+        $collectionHandler = new CollectionHandler($connection);
+
+        $name = 'ArangoDB_PHP_TestSuite_TestCollection_01' . '_' . static::$testsTimestamp;
+
+        try {
+            $collectionHandler->drop($name);
+        } catch (Exception $e) {
+            //Silence the exception
+        }
+
+        $collection        = Collection::createFromArray(['name' => $name, 'numberOfShards' => 5]);
+        $collectionHandler->create($collection);
+
+        $count = $collectionHandler->count($collection, false);
+        static::assertEquals(0, $count);
+        
+        $count = $collectionHandler->count($collection, true);
+        static::assertTrue(is_array($count));
+        static::assertEquals(5, count($count));
+
+        foreach ($count as $shard => $value) {
+            static::assertEquals('s', $shard[0]);
+            static::assertEquals(0, $value);
+        }
+        
+        // fill with data 
+        $statement = new Statement($connection, []);
+        $statement->setQuery('FOR i IN 1..1000 INSERT {} IN ' . $collection->getName());
+        $cursor = $statement->execute();
+        
+        $count = $collectionHandler->count($collection, false);
+        static::assertEquals(1000, $count);
+        
+        $count = $collectionHandler->count($collection, true);
+        static::assertTrue(is_array($count));
+        static::assertEquals(5, count($count));
+
+        $sum = 0;
+        foreach ($count as $shard => $value) {
+            static::assertEquals('s', $shard[0]);
+            static::assertTrue($value > 0);
+            $sum += $value;
+        }
+
+        static::assertEquals(1000, $sum);
+    }
+    
+    
     /**
      * get shards
      */
