Fix test failures, remove redundant test

Author: TysonAndre

package.xml

@@ -20,17 +20,23 @@
  -->
  <date>2022-10-14</date>
  <version>
-  <release>2.2.0dev</release>
-  <api>2.2.0dev</api>
+  <release>3.0.0dev</release>
+  <api>3.0.0dev</api>
  </version>
  <stability>
   <release>stable</release>
   <api>stable</api>
  </stability>
  <license uri="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</license>
  <notes>
+* Add SimdJsonValueError. In php 8.0+, it extends ValueError, and it extends Error in older php versions.
+  This provides an API similar to the JSON module, which started throwing ValueError for invalid depths in php 8.0.
+* Throw SimdJsonValueError instead of emitting notices if $depth is too small or too large in all simdjson PHP functions.
+  simdjson_is_valid(), simdjson_key_count() and simdjson_key_exists() now have non-null return types.
+* Throw a SimdJsonException in simdjson_key_exists on error conditions such as invalid json, to be consistent with other simdjson PHP functions.
+* Add an optional boolean `$throw_if_uncountable = false` to simdjson_key_count.
+  When this is overridden to be true, simdjson_key_count will throw a SimdJsonException if the JSON pointer refers to a value that exists but is neither an array nor an object instead of returning 0.
 * Expose simdjson C APIs marked with PHP_SIMDJSON_API in php_simdjson.h to other C projects.
-* Ensure that that header file works when required by C projects and that publicly exposed functions are available.
  </notes>
  <contents>
   <dir name="/">
@@ -64,6 +70,7 @@
     <file name="decode_strict_types.phpt" role="test"/>
     <file name="decode_types.phpt" role="test"/>
     <file name="depth.phpt" role="test"/>
+    <file name="dump.inc" role="test"/>
     <file name="is_valid.phpt" role="test"/>
     <file name="is_valid_args.phpt" role="test"/>
     <file name="key_count.phpt" role="test"/>
@@ -94,7 +101,6 @@
      <file name="bug69187.phpt" role="test"/>
      <file name="fail001.phpt" role="test"/>
      <file name="json_decode_basic.phpt" role="test"/>
-     <file name="json_decode_error.phpt" role="test"/>
      <file name="json_decode_invalid_utf8.phpt" role="test"/>
      <file name="pass001.1_64bit.phpt" role="test"/>
      <file name="pass001.1.phpt" role="test"/>

php_simdjson.cpp

@@ -71,16 +71,17 @@ ZEND_BEGIN_ARG_INFO_EX(simdjson_key_value_arginfo, 0, 0, 2)
         ZEND_ARG_TYPE_INFO(0, depth, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-SIMDJSON_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(simdjson_key_exists_arginfo, 0, 2, _IS_BOOL, 1)
+SIMDJSON_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(simdjson_key_exists_arginfo, 0, 2, _IS_BOOL, 0)
         ZEND_ARG_TYPE_INFO(0, json, IS_STRING, 0)
         ZEND_ARG_TYPE_INFO(0, key, IS_STRING, 0)
         ZEND_ARG_TYPE_INFO(0, depth, IS_LONG, 0)
 ZEND_END_ARG_INFO()
 
-SIMDJSON_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(simdjson_key_count_arginfo, 0, 2, IS_LONG, 1)
+SIMDJSON_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(simdjson_key_count_arginfo, 0, 2, IS_LONG, 0)
         ZEND_ARG_TYPE_INFO(0, json, IS_STRING, 0)
         ZEND_ARG_TYPE_INFO(0, key, IS_STRING, 0)
         ZEND_ARG_TYPE_INFO(0, depth, IS_LONG, 0)
+        ZEND_ARG_TYPE_INFO(0, throw_if_uncountable, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
 #define SIMDJSON_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(simdjson, v)

tests/compat/json_decode_error.phpt

@@ -5,16 +5,9 @@ simdjson_decode reject max depth
 declare(strict_types=1);
 ini_set('error_reporting', (string)E_ALL);
 ini_set('display_errors', 'stderr');
+require_once __DIR__ . '/dump.inc';
 
-function dump(Closure $c) {
-    try {
-        var_dump($c());
-    } catch (SimdJsonValueError $e) {
-        printf("Caught %s: %s\n", get_class($e), $e->getMessage());
-    }
-}
-
-foreach ([0, 1024, PHP_INT_MAX >> 1] as $depth) {
+foreach ([0, PHP_INT_MIN, 1024, PHP_INT_MAX >> 1, PHP_INT_MAX] as $depth) {
     dump(function () use ($depth) { return simdjson_decode('[]', true, $depth); });
     dump(function () use ($depth) { return simdjson_key_count('{"a":"b"}', 'a', $depth); });
     dump(function () use ($depth) { return simdjson_key_value('{"a":{}}', 'a', true, $depth); });
@@ -28,6 +21,11 @@ Caught SimdJsonValueError: simdjson_key_count(): Argument #4 ($depth) must be gr
 Caught SimdJsonValueError: simdjson_key_value(): Argument #4 ($depth) must be greater than zero
 Caught SimdJsonValueError: simdjson_key_exists(): Argument #3 ($depth) must be greater than zero
 Caught SimdJsonValueError: simdjson_is_valid(): Argument #2 ($depth) must be greater than zero
+Caught SimdJsonValueError: simdjson_decode(): Argument #2 ($depth) must be greater than zero
+Caught SimdJsonValueError: simdjson_key_count(): Argument #4 ($depth) must be greater than zero
+Caught SimdJsonValueError: simdjson_key_value(): Argument #4 ($depth) must be greater than zero
+Caught SimdJsonValueError: simdjson_key_exists(): Argument #3 ($depth) must be greater than zero
+Caught SimdJsonValueError: simdjson_is_valid(): Argument #2 ($depth) must be greater than zero
 array(0) {
 }
 int(0)
@@ -40,3 +38,8 @@ Caught SimdJsonValueError: simdjson_key_count(): Argument #4 ($depth) exceeds ma
 Caught SimdJsonValueError: simdjson_key_value(): Argument #4 ($depth) exceeds maximum allowed value of %d
 Caught SimdJsonValueError: simdjson_key_exists(): Argument #3 ($depth) exceeds maximum allowed value of %d
 Caught SimdJsonValueError: simdjson_is_valid(): Argument #2 ($depth) exceeds maximum allowed value of %d
+Caught SimdJsonValueError: simdjson_decode(): Argument #2 ($depth) exceeds maximum allowed value of %d
+Caught SimdJsonValueError: simdjson_key_count(): Argument #4 ($depth) exceeds maximum allowed value of %d
+Caught SimdJsonValueError: simdjson_key_value(): Argument #4 ($depth) exceeds maximum allowed value of %d
+Caught SimdJsonValueError: simdjson_key_exists(): Argument #3 ($depth) exceeds maximum allowed value of %d
+Caught SimdJsonValueError: simdjson_is_valid(): Argument #2 ($depth) exceeds maximum allowed value of %d

tests/decode_max_depth.phpt

@@ -5,8 +5,9 @@ display_errors=stderr
 error_reporting=E_ALL
 --FILE--
 <?php
-var_dump(simdjson_decode('[]', true, 0));
-var_dump(simdjson_key_value('[]', '', true, 0));
+require_once __DIR__ . '/dump.inc';
+
+// too small/large depths tested in decode_max_depth
 var_dump(simdjson_key_count('[]', '', 1));
 var_dump(simdjson_decode('[]', true, 1));
 echo "Test '[1]'\n";
@@ -29,10 +30,6 @@ var_dump(simdjson_decode('[[]]', true, 2));
 var_dump(simdjson_decode('[[1]]', true, 3));
 ?>
 --EXPECTF--
-Warning: simdjson_decode(): Depth must be greater than zero in %s on line 2
-NULL
-Warning: simdjson_key_value(): Depth must be greater than zero in %s on line 3
-NULL
 int(0)
 array(0) {
 }

tests/depth.phpt

@@ -0,0 +1,8 @@
+<?php
+function dump(Closure $c) {
+    try {
+        var_dump($c());
+    } catch (Throwable $e) {
+        printf("Caught %s: %s\n", get_class($e), $e->getMessage());
+    }
+}

tests/dump.inc

@@ -13,5 +13,5 @@ Function [ <internal:simdjson> function simdjson_is_valid ] {
     Parameter #0 [ <required> string $json ]
     Parameter #1 [ <optional> int%S $depth%S ]
   }
-  - Return [ %Sbool%S ]
+  - Return [ bool%S ]
 }

tests/is_valid_args.phpt

@@ -5,20 +5,20 @@ error_reporting=E_ALL
 display_errors=stderr
 --FILE--
 <?php
-var_dump(\simdjson_is_valid('[]', -1));
-var_dump(\simdjson_is_valid('[[]]', 2));
-var_dump(\simdjson_is_valid('[[]]', 1024));
-var_dump(\simdjson_is_valid('[[]]', 1));
-var_dump(\simdjson_is_valid('[[]]'));
+require_once __DIR__ . '/dump.inc';
+dump(function () { return simdjson_is_valid('[]', -1); });
+dump(function () { return simdjson_is_valid('[[]]', 2); });
+dump(function () { return simdjson_is_valid('[[]]', 1024); });
+dump(function () { return simdjson_is_valid('[[]]', 1); });
+dump(function () { return simdjson_is_valid('[[]]'); });
 echo "test deeply nested\n";
 $long = str_repeat('[', 3000) . str_repeat(']', 3000);
-var_dump(\simdjson_is_valid($long));
-var_dump(\simdjson_is_valid($long, 2999));
-var_dump(\simdjson_is_valid($long, 3000));
+dump(function () use ($long) { return simdjson_is_valid($long); });
+dump(function () use ($long) { return simdjson_is_valid($long, 2999); });
+dump(function () use ($long) { return simdjson_is_valid($long, 3000); });
 ?>
 --EXPECTF--
-Warning: simdjson_is_valid(): Depth must be greater than zero in %sis_valid_edge_cases.php on line 2
-NULL
+Caught SimdJsonValueError: simdjson_is_valid(): Argument #2 ($depth) must be greater than zero
 bool(true)
 bool(true)
 bool(false)

tests/is_valid_edge_cases.phpt

@@ -9,10 +9,11 @@ echo $reflection;
 --EXPECTF--
 Function [ <internal:simdjson> function simdjson_key_count ] {
 
-  - Parameters [3] {
+  - Parameters [4] {
     Parameter #0 [ <required> string $json ]
     Parameter #1 [ <required> string $key ]
     Parameter #2 [ <optional> int%S $depth%S ]
+    Parameter #3 [ <optional> bool%S $throw_if_uncountable%S ]
   }
-  - Return [ %Sint%S ]
+  - Return [ int%S ]
 }

tests/key_count_args.phpt

@@ -14,5 +14,5 @@ Function [ <internal:simdjson> function simdjson_key_exists ] {
     Parameter #1 [ <required> string $key ]
     Parameter #2 [ <optional> int%S $depth%S ]
   }
-  - Return [ %Sbool%S ]
+  - Return [ bool%S ]
 }