issue arangodb#235: add Statement::setFailOnWarning()

jsteemann · jsteemann · commit 80b43b093dbc · 2018-02-02T15:39:30.000+01:00
diff --git a/lib/ArangoDBClient/Statement.php b/lib/ArangoDBClient/Statement.php
@@ -116,6 +116,21 @@ class Statement
      * @var bool
      */
     private $_cache;
+    
+    /**
+     * Whether or not the cache should abort when it encounters a warning
+     *
+     * @var bool
+     */
+    private $_failOnWarning = false;
+
+    /**
+     * Approximate memory limit value (in bytes) that a query can use on the server-side
+     * (a value of 0 or less will mean the memory is not limited)
+     *
+     * @var int
+     */
+    private $_memoryLimit = 0;
 
     /**
      * resultType
@@ -149,6 +164,16 @@ class Statement
      * Bind variables index
      */
     const ENTRY_BINDVARS = 'bindVars';
+    
+    /**
+     * Fail on warning flag
+     */
+    const ENTRY_FAIL_ON_WARNING = 'failOnWarning';
+    
+    /**
+     * Memory limit threshold for query
+     */
+    const ENTRY_MEMORY_LIMIT = 'memoryLimit';
 
     /**
      * Full count option index
@@ -215,6 +240,14 @@ public function __construct(Connection $connection, array $data)
         if (isset($data[Cursor::ENTRY_CACHE])) {
             $this->_cache = (bool) $data[Cursor::ENTRY_CACHE];
         }
+        
+        if (isset($data[self::ENTRY_FAIL_ON_WARNING])) {
+            $this->_failOnWarning = (bool) $data[self::ENTRY_FAIL_ON_WARNING];
+        }
+        
+        if (isset($data[self::ENTRY_MEMORY_LIMIT])) {
+            $this->_memoryLimit = (int) $data[self::ENTRY_MEMORY_LIMIT];
+        }
     }
 
     /**
@@ -430,7 +463,7 @@ public function setFullCount($value)
     {
         $this->_fullCount = (bool) $value;
     }
-
+    
     /**
      * Get the full count option value of the statement
      *
@@ -462,6 +495,51 @@ public function getCache()
     {
         return $this->_cache;
     }
+     
+    /**
+     * Set whether or not the cache should abort when it encounters a warning
+     *
+     * @param bool $value - value for fail-on-warning
+     *
+     * @return void
+     */
+    public function setFailOnWarning($value = true)
+    {
+        $this->_failOnWarning = (bool) $value;
+    }
+    
+    /**
+     * Get the configured value for fail-on-warning
+     *
+     * @return bool - current value of fail-on-warning option
+     */
+    public function getFailOnWarning()
+    {
+        return $this->_failOnWarning;
+    }
+    
+    /**
+     * Set the approximate memory limit threshold to be used by the query on the server-side
+     * (a value of 0 or less will mean the memory is not limited)
+     *
+     * @param int $value - value for memory limit
+     *
+     * @return void
+     */
+    public function setMemoryLimit($value)
+    {
+        $this->_memoryLimit = (int) $value;
+    }
+    
+    /**
+     * Get the configured memory limit for the statement
+     *
+     * @return int - current value of memory limit option
+     */
+    public function getMemoryLimit()
+    {
+        return $this->_memoryLimit;
+    }
 
     /**
      * Set the batch size for the statement
@@ -510,14 +588,19 @@ private function buildData()
             self::ENTRY_QUERY => $this->_query,
             self::ENTRY_COUNT => $this->_doCount,
             'options'         => [
-                self::FULL_COUNT => $this->_fullCount
+                self::FULL_COUNT => $this->_fullCount,
+                self::ENTRY_FAIL_ON_WARNING => $this->_failOnWarning
             ]
         ];
 
         if ($this->_cache !== null) {
             $data[Cursor::ENTRY_CACHE] = $this->_cache;
         }
 
+        if ($this->_memoryLimit > 0) {
+            $data[self::ENTRY_MEMORY_LIMIT] = $this->_memoryLimit;
+        }
+        
         if ($this->_bindVars->getCount() > 0) {
             $data[self::ENTRY_BINDVARS] = $this->_bindVars->getAll();
         }
diff --git a/tests/StatementTest.php b/tests/StatementTest.php
@@ -139,6 +139,42 @@ public function testStatementReturnWarnings()
         $warnings = $cursor->getWarnings();
         static::assertEquals(1562, $warnings[0]['code']);
     }
+    
+    /**
+     * Test fail if a warning occurs during querying
+     */
+    public function testStatementFailOnWarning()
+    {
+        $connection = $this->connection;
+
+        $statement = new Statement($connection, ['query' => 'RETURN 1/0']);
+        $statement->setFailOnWarning();
+
+        try {
+            $cursor = $statement->execute();
+            static::assertTrue(false);
+        } catch (ServerException $e) {
+            static::assertEquals(1562, $e->getServerCode());
+        }
+    }
+    
+    /**
+     * Test fail with memory limit hit
+     */
+    public function testStatementFailWithMemoryLimit()
+    {
+        $connection = $this->connection;
+
+        $statement = new Statement($connection, ['query' => 'FOR i IN 1..100000 RETURN CONCAT("test", TO_NUMBER(i))']);
+        $statement->setMemoryLimit(10000);
+
+        try {
+            $cursor = $statement->execute();
+            static::assertTrue(false);
+        } catch (ServerException $e) {
+            static::assertEquals(32, $e->getServerCode());
+        }
+    }
 
 
     /**
