Relocate VectorType enum defs and revise test cases

jmikola · jmikola · commit 4e0a57fcc19c · 2025-09-30T17:34:07.000-04:00
diff --git a/src/BSON/Binary.c b/src/BSON/Binary.c
@@ -24,6 +24,7 @@
 #include "phongo_error.h"
 #include "Binary.h"
 #include "Binary_arginfo.h"
+#include "VectorType.h"
 
 zend_class_entry* php_phongo_binary_ce;
 
@@ -45,7 +46,7 @@ static bool php_phongo_binary_init(php_phongo_binary_t* intern, const char* data
 		return false;
 	}
 
-	if ((type == BSON_SUBTYPE_VECTOR) && phongo_binary_get_vector_type_from_data((const uint8_t*) data, data_len) == PHONGO_BSON_VECTOR_TYPE_INVALID) {
+	if ((type == BSON_SUBTYPE_VECTOR) && phongo_binary_get_vector_type_from_data((const uint8_t*) data, data_len) == PHONGO_BSON_VECTOR_TYPE_UNKNOWN) {
 		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Binary vector data is invalid");
 		return false;
 	}
@@ -459,11 +460,11 @@ static void phongo_binary_init_vector_from_packed_bit_array(php_phongo_binary_t*
 	ZEND_HASH_FOREACH_VAL_IND(vector, val)
 	{
 		if (Z_TYPE_P(val) != IS_LONG && Z_TYPE_P(val) != IS_TRUE && Z_TYPE_P(val) != IS_FALSE) {
-			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected vector[%zu] to be an integer or boolean, %s given", i, zend_zval_type_name(val));
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected vector[%zu] to be 0, 1, or a boolean, %s given", i, zend_zval_type_name(val));
 			return;
 		}
 
-		if (Z_TYPE_P(val) == IS_LONG && (Z_LVAL_P(val) < 0 || Z_LVAL_P(val) > 1)) {
+		if (Z_TYPE_P(val) == IS_LONG && Z_LVAL_P(val) != 0 && Z_LVAL_P(val) != 1) {
 			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected vector[%zu] to be 0 or 1, %" PHONGO_LONG_FORMAT " given", i, Z_LVAL_P(val));
 			return;
 		}
@@ -484,8 +485,8 @@ static void phongo_binary_init_vector_from_packed_bit_array(php_phongo_binary_t*
 
 static PHP_METHOD(MongoDB_BSON_Binary, fromVector)
 {
-	HashTable*           vector;
-	zend_object*         type;
+	HashTable*   vector;
+	zend_object* type;
 
 	object_init_ex(return_value, php_phongo_binary_ce);
 	php_phongo_binary_t* intern = Z_BINARY_OBJ_P(return_value);
@@ -495,25 +496,20 @@ static PHP_METHOD(MongoDB_BSON_Binary, fromVector)
 	Z_PARAM_OBJ_OF_CLASS(type, php_phongo_vectortype_ce)
 	PHONGO_PARSE_PARAMETERS_END();
 
-	zval *type_name = zend_enum_fetch_case_name(type);
-
-	if (zend_string_equals_literal(Z_STR_P(type_name), "Float32")) {
-		phongo_binary_init_vector_from_float32_array(intern, vector);
-		return;
-	}
-
-	if (zend_string_equals_literal(Z_STR_P(type_name), "Int8")) {
-		phongo_binary_init_vector_from_int8_array(intern, vector);
-		return;
-	}
-
-	if (zend_string_equals_literal(Z_STR_P(type_name), "PackedBit")) {
-		phongo_binary_init_vector_from_packed_bit_array(intern, vector);
-		return;
+	switch (phongo_bson_vector_type_from_name(Z_STRVAL_P(zend_enum_fetch_case_name(type)))) {
+		case PHONGO_BSON_VECTOR_TYPE_FLOAT32:
+			phongo_binary_init_vector_from_float32_array(intern, vector);
+			return;
+		case PHONGO_BSON_VECTOR_TYPE_INT8:
+			phongo_binary_init_vector_from_int8_array(intern, vector);
+			return;
+		case PHONGO_BSON_VECTOR_TYPE_PACKED_BIT:
+			phongo_binary_init_vector_from_packed_bit_array(intern, vector);
+			return;
+		default:
+			phongo_throw_exception(PHONGO_ERROR_LOGIC, "Unsupported binary vector type: %s", Z_STRVAL_P(zend_enum_fetch_case_name(type)));
+			RETURN_THROWS();
 	}
-
-	phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Unsupported binary vector type: %s", Z_STR_P(type_name));
-	RETURN_THROWS();
 }
 
 static phongo_bson_vector_type_t phongo_binary_get_vector_type_from_data(const uint8_t* data, uint32_t data_len)
@@ -530,7 +526,7 @@ static phongo_bson_vector_type_t phongo_binary_get_vector_type_from_data(const u
 		return PHONGO_BSON_VECTOR_TYPE_PACKED_BIT;
 	}
 
-	return PHONGO_BSON_VECTOR_TYPE_INVALID;
+	return PHONGO_BSON_VECTOR_TYPE_UNKNOWN;
 }
 
 static phongo_bson_vector_type_t phongo_binary_get_vector_type(const php_phongo_binary_t* intern)
@@ -549,23 +545,12 @@ static PHP_METHOD(MongoDB_BSON_Binary, getVectorType)
 		RETURN_THROWS();
 	}
 
-	phongo_bson_vector_type_t type = phongo_binary_get_vector_type(Z_BINARY_OBJ_P(getThis()));
-	const char *type_case;
+	const char* type_case = phongo_bson_vector_type_to_name(phongo_binary_get_vector_type(Z_BINARY_OBJ_P(getThis())));
 
-	switch (type) {
-		case PHONGO_BSON_VECTOR_TYPE_FLOAT32:
-			type_case = "Float32";
-			break;
-		case PHONGO_BSON_VECTOR_TYPE_INT8:
-			type_case = "Int8";
-			break;
-		case PHONGO_BSON_VECTOR_TYPE_PACKED_BIT:
-			type_case = "PackedBit";
-			break;
-		default:
-			// The vector should always be valid by this point, but check for an error
-			phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE, "Binary vector data is invalid");
-			RETURN_THROWS();
+	// The vector should always be valid by this point, but check for an error
+	if (!type_case) {
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE, "Binary vector data is invalid");
+		RETURN_THROWS();
 	}
 
 	RETVAL_OBJ_COPY(zend_enum_get_case_cstr(php_phongo_vectortype_ce, type_case));
@@ -576,7 +561,7 @@ static void phongo_binary_get_vector_as_array(const php_phongo_binary_t* intern,
 	phongo_bson_vector_type_t type = phongo_binary_get_vector_type(intern);
 
 	// The vector should always be valid by this point, but check for an error
-	if (type == PHONGO_BSON_VECTOR_TYPE_INVALID) {
+	if (type == PHONGO_BSON_VECTOR_TYPE_UNKNOWN) {
 		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE, "Binary vector data is invalid");
 		RETURN_THROWS();
 	}
diff --git a/src/BSON/Binary.h b/src/BSON/Binary.h
@@ -19,13 +19,6 @@
 
 #define PHONGO_BINARY_UUID_SIZE 16
 
-typedef enum {
-	PHONGO_BSON_VECTOR_TYPE_INVALID    = 0,
-	PHONGO_BSON_VECTOR_TYPE_INT8       = 0x03,
-	PHONGO_BSON_VECTOR_TYPE_FLOAT32    = 0x27,
-	PHONGO_BSON_VECTOR_TYPE_PACKED_BIT = 0x10,
-} phongo_bson_vector_type_t;
-
 bool phongo_binary_new(zval* object, const char* data, size_t data_len, bson_subtype_t type);
 
 #endif /* PHONGO_BSON_BINARY_H */
diff --git a/src/BSON/VectorType.c b/src/BSON/VectorType.c
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-present MongoDB, Inc.
+ * Copyright 2025-present MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,10 +18,42 @@
 #include <Zend/zend_enum.h>
 
 #include "php_phongo.h"
+#include "VectorType.h"
 #include "VectorType_arginfo.h"
 
 zend_class_entry* php_phongo_vectortype_ce;
 
+phongo_bson_vector_type_t phongo_bson_vector_type_from_name(const char* name)
+{
+	if (!strcmp(name, PHONGO_BSON_VECTOR_TYPE_FLOAT32_NAME)) {
+		return PHONGO_BSON_VECTOR_TYPE_FLOAT32;
+	}
+
+	if (!strcmp(name, PHONGO_BSON_VECTOR_TYPE_INT8_NAME)) {
+		return PHONGO_BSON_VECTOR_TYPE_INT8;
+	}
+
+	if (!strcmp(name, PHONGO_BSON_VECTOR_TYPE_PACKED_BIT_NAME)) {
+		return PHONGO_BSON_VECTOR_TYPE_PACKED_BIT;
+	}
+
+	return PHONGO_BSON_VECTOR_TYPE_UNKNOWN;
+}
+
+const char* phongo_bson_vector_type_to_name(phongo_bson_vector_type_t type)
+{
+	switch (type) {
+		case PHONGO_BSON_VECTOR_TYPE_FLOAT32:
+			return PHONGO_BSON_VECTOR_TYPE_FLOAT32_NAME;
+		case PHONGO_BSON_VECTOR_TYPE_INT8:
+			return PHONGO_BSON_VECTOR_TYPE_INT8_NAME;
+		case PHONGO_BSON_VECTOR_TYPE_PACKED_BIT:
+			return PHONGO_BSON_VECTOR_TYPE_PACKED_BIT_NAME;
+		default:
+			return NULL;
+	}
+}
+
 void php_phongo_vectortype_init_ce(INIT_FUNC_ARGS)
 {
 	php_phongo_vectortype_ce = register_class_MongoDB_BSON_VectorType();
diff --git a/src/BSON/VectorType.h b/src/BSON/VectorType.h
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef PHONGO_BSON_VECTORTYPE_H
+#define PHONGO_BSON_VECTORTYPE_H
+
+#define PHONGO_BSON_VECTOR_TYPE_FLOAT32_NAME "Float32"
+#define PHONGO_BSON_VECTOR_TYPE_INT8_NAME "Int8"
+#define PHONGO_BSON_VECTOR_TYPE_PACKED_BIT_NAME "PackedBit"
+
+typedef enum {
+	PHONGO_BSON_VECTOR_TYPE_FLOAT32    = 0x27,
+	PHONGO_BSON_VECTOR_TYPE_INT8       = 0x03,
+	PHONGO_BSON_VECTOR_TYPE_PACKED_BIT = 0x10,
+	PHONGO_BSON_VECTOR_TYPE_UNKNOWN    = 0,
+} phongo_bson_vector_type_t;
+
+phongo_bson_vector_type_t phongo_bson_vector_type_from_name(const char* name);
+const char*               phongo_bson_vector_type_to_name(phongo_bson_vector_type_t type);
+
+#endif /* PHONGO_BSON_VECTORTYPE_H */
diff --git a/tests/bson/bson-binary-fromVector-001.phpt b/tests/bson/bson-binary-fromVector-001.phpt
@@ -4,7 +4,7 @@ MongoDB\BSON\Binary::fromVector() construction of various vector types
 <?php
 
 var_dump(MongoDB\BSON\Binary::fromVector([1.0, -1.0, 0.5, -0.5], MongoDB\BSON\VectorType::Float32));
-var_dump(MongoDB\BSON\Binary::fromVector([1, 2, 3, 4], MongoDB\BSON\VectorType::Int8));
+var_dump(MongoDB\BSON\Binary::fromVector([-128, 0, 1, 127], MongoDB\BSON\VectorType::Int8));
 var_dump(MongoDB\BSON\Binary::fromVector([1, 0, true, false], MongoDB\BSON\VectorType::PackedBit));
 
 ?>
@@ -38,13 +38,13 @@ object(MongoDB\BSON\Binary)#%d (%d) {
   ["vector"]=>
   array(4) {
     [0]=>
-    int(1)
+    int(-128)
     [1]=>
-    int(2)
+    int(0)
     [2]=>
-    int(3)
+    int(1)
     [3]=>
-    int(4)
+    int(127)
   }
   ["vectorType"]=>
   int(3)
diff --git a/tests/bson/bson-binary-fromVector_error-002.phpt b/tests/bson/bson-binary-fromVector_error-002.phpt
@@ -14,7 +14,11 @@ echo throws(function() {
 }, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n";
 
 echo throws(function() {
-    MongoDB\BSON\Binary::fromVector([1, 256], MongoDB\BSON\VectorType::Int8);
+    MongoDB\BSON\Binary::fromVector([1, -129], MongoDB\BSON\VectorType::Int8);
+}, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n";
+
+echo throws(function() {
+    MongoDB\BSON\Binary::fromVector([1, 128], MongoDB\BSON\VectorType::Int8);
 }, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n";
 
 ?>
@@ -26,5 +30,7 @@ Expected vector to be a list
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
 Expected vector[1] to be an integer, float given
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
-Expected vector[1] to be a signed 8-bit integer, 256 given
+Expected vector[1] to be a signed 8-bit integer, -129 given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected vector[1] to be a signed 8-bit integer, 128 given
 ===DONE===
diff --git a/tests/bson/bson-binary-fromVector_error-003.phpt b/tests/bson/bson-binary-fromVector_error-003.phpt
@@ -24,7 +24,7 @@ echo throws(function() {
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
 Expected vector to be a list
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
-Expected vector[1] to be an integer or boolean, float given
+Expected vector[1] to be 0, 1, or a boolean, float given
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
 Expected vector[1] to be 0 or 1, 2 given
 ===DONE===
