PHPC-741: Consistent exceptions for Javascript init methods

Author: jmikola

src/BSON/Javascript.c

@@ -46,10 +46,12 @@ PHONGO_API zend_class_entry *php_phongo_javascript_ce;
 
 zend_object_handlers php_phongo_handler_javascript;
 
-/* Initialize the object from a string and return whether it was successful. */
+/* Initialize the object and return whether it was successful. An exception will
+ * be thrown on error. */
 static bool php_phongo_javascript_init(php_phongo_javascript_t *intern, const char *code, phongo_zpp_char_len code_len, zval *scope TSRMLS_DC)
 {
 	if (scope && Z_TYPE_P(scope) != IS_OBJECT && Z_TYPE_P(scope) != IS_ARRAY && Z_TYPE_P(scope) != IS_NULL) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected scope to be array or object, %s given", zend_get_type_by_const(Z_TYPE_P(scope)));
 		return false;
 	}
 
@@ -66,7 +68,8 @@ static bool php_phongo_javascript_init(php_phongo_javascript_t *intern, const ch
 	return true;
 }
 
-/* Initialize the object from a HashTable and return whether it was successful. */
+/* Initialize the object from a HashTable and return whether it was successful.
+ * An exception will be thrown on error. */
 static bool php_phongo_javascript_init_from_hash(php_phongo_javascript_t *intern, HashTable *props TSRMLS_DC)
 {
 #if PHP_VERSION_ID >= 70000
@@ -86,6 +89,8 @@ static bool php_phongo_javascript_init_from_hash(php_phongo_javascript_t *intern
 		return php_phongo_javascript_init(intern, Z_STRVAL_PP(code), Z_STRLEN_PP(code), tmp TSRMLS_CC);
 	}
 #endif
+
+	phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "%s initialization requires \"code\" string field", ZSTR_VAL(php_phongo_javascript_ce->name));
 	return false;
 }
 
@@ -131,9 +136,7 @@ PHP_METHOD(Javascript, __set_state)
 	intern = Z_JAVASCRIPT_OBJ_P(return_value);
 	props = Z_ARRVAL_P(array);
 
-	if (!php_phongo_javascript_init_from_hash(intern, props TSRMLS_CC)) {
-		php_error(E_ERROR, "Invalid serialization data for Javascript object");
-	}
+	php_phongo_javascript_init_from_hash(intern, props TSRMLS_CC);
 }
 /* }}} */
 
@@ -151,10 +154,7 @@ PHP_METHOD(Javascript, __wakeup)
 	intern = Z_JAVASCRIPT_OBJ_P(getThis());
 	props = zend_std_get_properties(getThis() TSRMLS_CC);
 
-	if (!php_phongo_javascript_init_from_hash(intern, props TSRMLS_CC)) {
-		php_error(E_ERROR, "Invalid serialization data for Javascript object");
-	} else {
-	}
+	php_phongo_javascript_init_from_hash(intern, props TSRMLS_CC);
 }
 /* }}} */
 

tests/bson/bson-javascript-003.phpt …n/bson-javascript-serialization-001.phpttests/bson/bson-javascript-003.phpt renamed to tests/bson/bson-javascript-serialization-001.phpt tests/bson/bson-javascript-003.phpt renamed to tests/bson/bson-javascript-serialization-001.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\Javascript unserialization requires "code" string field
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+echo throws(function() {
+    unserialize('O:23:"MongoDB\BSON\Javascript":1:{s:4:"code";i:0;}');
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+MongoDB\BSON\Javascript initialization requires "code" string field
+===DONE===

tests/bson/bson-javascript-serialization_error-001.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\Javascript unserialization expects optional scope to be array or object
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+echo throws(function() {
+    unserialize('O:23:"MongoDB\BSON\Javascript":2:{s:4:"code";s:17:"function foo() {}";s:5:"scope";s:7:"INVALID";}');
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected scope to be array or object, string given
+===DONE===

tests/bson/bson-javascript-serialization_error-002.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\Javascript::__set_state() requires "code" string field
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+echo throws(function() {
+    MongoDB\BSON\Javascript::__set_state(['code' => 0]);
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+MongoDB\BSON\Javascript initialization requires "code" string field
+===DONE===

tests/bson/bson-javascript-set_state_error-001.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\BSON\Javascript::__set_state() expects optional scope to be array or object
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+echo throws(function() {
+    MongoDB\BSON\Javascript::__set_state(['code' => 'function foo() {}',  'scope' => 'INVALID']);
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected scope to be array or object, string given
+===DONE===