Add checks and unit tests to Transformers (#44634)

* Add checks and unit tests to Transformers * Add changelog * Update docs * Fix test * Set the default value to an empty array * Set default value to array() for ArrayColumn
woocommerce · Feb 16, 2024 · 75118fb · 75118fb
1 parent 0ea64cf
commit 75118fb
Show file tree

Hide file tree

Showing 17 changed files with 182 additions and 11 deletions.
diff --git a/plugins/woocommerce/changelog/dev-audit-transformaters b/plugins/woocommerce/changelog/dev-audit-transformaters
@@ -0,0 +1,4 @@
+Significance: patch
+Type: dev
+
+Add checks and unit tests to Transformers
diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayColumn.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayColumn.php
@@ -23,7 +23,11 @@ class ArrayColumn implements TransformerInterface {
 	 *
 	 * @return mixed
 	 */
-	public function transform( $value, stdClass $arguments = null, $default = null ) {
+	public function transform( $value, stdClass $arguments = null, $default = array() ) {
+		if ( ! is_array( $value ) ) {
+			return $default;
+		}
+
 		return array_column( $value, $arguments->key );
 	}
 
@@ -39,6 +43,14 @@ public function validate( stdClass $arguments = null ) {
 			return false;
 		}
 
+		if (
+			null !== $arguments->key &&
+			! is_string( $arguments->key ) &&
+			! is_int( $arguments->key )
+		) {
+			return false;
+		}
+
 		return true;
 	}
 }
diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayFlatten.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayFlatten.php
@@ -20,7 +20,11 @@ class ArrayFlatten implements TransformerInterface {
 	 *
 	 * @return mixed|null
 	 */
-	public function transform( $value, stdClass $arguments = null, $default = null ) {
+	public function transform( $value, stdClass $arguments = null, $default = array() ) {
+		if ( ! is_array( $value ) ) {
+			return $default;
+		}
+
 		$return = array();
 		array_walk_recursive(
 			$value,

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayKeys.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayKeys.php
@@ -20,7 +20,11 @@ class ArrayKeys implements TransformerInterface {
 	 *
 	 * @return mixed
 	 */
-	public function transform( $value, stdClass $arguments = null, $default = null ) {
+	public function transform( $value, stdClass $arguments = null, $default = array() ) {
+		if ( ! is_array( $value ) ) {
+			return $default;
+		}
+
 		return array_keys( $value );
 	}
 

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArraySearch.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArraySearch.php
@@ -24,6 +24,10 @@ class ArraySearch implements TransformerInterface {
 	 * @return mixed|null
 	 */
 	public function transform( $value, stdClass $arguments = null, $default = null ) {
+		if ( ! is_array( $value ) ) {
+			return $default;
+		}
+
 		$key = array_search( $arguments->value, $value, true );
 		if ( false !== $key ) {
 			return $value[ $key ];

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayValues.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/ArrayValues.php
@@ -20,7 +20,11 @@ class ArrayValues implements TransformerInterface {
 	 *
 	 * @return mixed
 	 */
-	public function transform( $value, stdClass $arguments = null, $default = null ) {
+	public function transform( $value, stdClass $arguments = null, $default = array() ) {
+		if ( ! is_array( $value ) ) {
+			return $default;
+		}
+
 		return array_values( $value );
 	}
 

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/Count.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/Count.php
@@ -6,21 +6,25 @@
 use stdClass;
 
 /**
- * Count elements in Array.
+ * Count elements in Array or Countable object.
  *
  * @package Automattic\WooCommerce\Admin\RemoteInboxNotifications\Transformers
  */
 class Count implements TransformerInterface {
 	/**
-	 *  Count elements in Array.
+	 *  Count elements in Array or Countable object.
 	 *
-	 * @param array         $value an array to count.
-	 * @param stdClass|null $arguments arguments.
-	 * @param string|null   $default default value.
+	 * @param array|Countable $value an array to count.
+	 * @param stdClass|null   $arguments arguments.
+	 * @param string|null     $default default value.
 	 *
 	 * @return number
 	 */
 	public function transform( $value, stdClass $arguments = null, $default = null ) {
+		if ( ! is_array( $value ) && ! $value instanceof \Countable ) {
+			return $default;
+		}
+
 		return count( $value );
 	}
 

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/DotNotation.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/DotNotation.php
@@ -43,6 +43,10 @@ public function transform( $value, stdclass $arguments = null, $default = null )
 	 * @return mixed|null
 	 */
 	public function get( $array, $path, $default = null ) {
+		if ( ! is_array( $array ) ) {
+			return $default;
+		}
+
 		if ( isset( $array[ $path ] ) ) {
 			return $array[ $path ];
 		}

diff --git a/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/PrepareUrl.php b/plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/PrepareUrl.php
@@ -14,15 +14,32 @@ class PrepareUrl implements TransformerInterface {
 	/**
 	 * Prepares the site URL by removing the protocol and trailing slash.
 	 *
-	 * @param mixed         $value a value to transform.
+	 * @param string        $value a value to transform.
 	 * @param stdClass|null $arguments arguments.
 	 * @param string|null   $default default value.
 	 *
 	 * @return mixed|null
 	 */
 	public function transform( $value, stdClass $arguments = null, $default = null ) {
+		if ( ! is_string( $value ) ) {
+			return $default;
+		}
+
 		$url_parts = wp_parse_url( rtrim( $value, '/' ) );
-		return isset( $url_parts['path'] ) ? $url_parts['host'] . $url_parts['path'] : $url_parts['host'];
+
+		if ( ! $url_parts ) {
+			return $default;
+		}
+
+		if ( ! isset( $url_parts['host'] ) ) {
+			return $default;
+		}
+
+		if ( isset( $url_parts['path'] ) ) {
+			return $url_parts['host'] . $url_parts['path'];
+		}
+
+		return $url_parts['host'];
 	}
 
 	/**

diff --git a/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-column.php b/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-column.php
@@ -21,6 +21,37 @@ public function test_validate_returns_false_when_key_argument_is_missing() {
 		$this->assertFalse( false, $result );
 	}
 
+	/**
+	 * Test validate method returns false when argument->key is not valid type
+	 */
+	public function test_validate_returns_false_when_argument_key_is_not_valid_type() {
+		$array_column = new ArrayColumn();
+		$result       = $array_column->validate(
+			(object) array(
+				'key' => true,
+			)
+		);
+		$this->assertFalse( false, $result );
+
+		$result = $array_column->validate(
+			(object) array(
+				'key' => array(),
+			)
+		);
+		$this->assertFalse( false, $result );
+	}
+
+	/**
+	 * Test it returns default value when value is not an array
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$arguments    = (object) array( 'key' => 'name' );
+		$array_column = new ArrayColumn();
+		$default      = 'default value';
+		$result       = $array_column->transform( 'invalid value', $arguments, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns value by array column.
 	 */

diff --git a/...cy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-flatten.php b/...cy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-flatten.php
@@ -11,6 +11,16 @@
  * class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayKeys
  */
 class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayFlatten extends WC_Unit_Test_Case {
+	/**
+	 * Test it returns default value when value is not an array
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$default    = 'default value';
+		$array_keys = new ArrayFlatten();
+		$result     = $array_keys->transform( 'invalid value', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns flatten array
 	 */

diff --git a/...egacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-keys.php b/...egacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-keys.php
@@ -11,6 +11,16 @@
  * class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayKeys
  */
 class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayKeys extends WC_Unit_Test_Case {
+	/**
+	 * Test it returns default value when value is not an array
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$default    = 'default value';
+		$array_keys = new ArrayKeys();
+		$result     = $array_keys->transform( 'invalid value', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns array values.
 	 */

diff --git a/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-search.php b/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-search.php
@@ -31,6 +31,16 @@ public function test_it_returns_null_if_value_is_not_found() {
 		$this->assertEquals( null, $result );
 	}
 
+	/**
+	 * Test it returns default value when value is not an array
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$default    = 'default value';
+		$array_keys = new ArraySearch();
+		$result     = $array_keys->transform( 'invalid value', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns value by array value.
 	 */

diff --git a/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-values.php b/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/array-values.php
@@ -11,6 +11,16 @@
  * class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayValues
  */
 class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayValues extends WC_Unit_Test_Case {
+	/**
+	 * Test it returns default value when value is not an array
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$default    = 'default value';
+		$array_keys = new ArrayValues();
+		$result     = $array_keys->transform( 'invalid value', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns array values.
 	 */

diff --git a/...sts/legacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/count.php b/...sts/legacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/count.php
@@ -11,6 +11,16 @@
  * class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayValues
  */
 class WC_Admin_Tests_RemoteInboxNotifications_Transformers_ArrayCount extends WC_Unit_Test_Case {
+	/**
+	 * Test it returns default value when value is not an array.
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$default    = 'default value';
+		$array_keys = new Count();
+		$result     = $array_keys->transform( 'invalid value', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns array count.
 	 */

diff --git a/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/dot-notation.php b/...acy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/dot-notation.php
@@ -35,6 +35,18 @@ public function test_it_can_get_value_by_index() {
 		$this->assertEquals( $result, $item );
 	}
 
+	/**
+	 * Test it returns default value when value is not an array.
+	 */
+	public function test_it_returns_default_value_when_value_is_not_an_array() {
+		$arguments  = (object) array( 'path' => 'teams.ghidorah' );
+		$default    = 'default value';
+		$array_keys = new DotNotation();
+
+		$result = $array_keys->transform( 'invalid value', $arguments, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it get getvalue by dot notation.
 	 */

diff --git a/...gacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/prepare-url.php b/...gacy/unit-tests/woocommerce-admin/remote-inbox-notifications/Transformers/prepare-url.php
@@ -11,6 +11,27 @@
  * class WC_Admin_Tests_RemoteInboxNotifications_Transformers_PrepareUrl
  */
 class WC_Admin_Tests_RemoteInboxNotifications_Transformers_PrepareUrl extends WC_Unit_Test_Case {
+	/**
+	 * Test it returns default value when url is not string.
+	 */
+	public function test_it_returns_default_value_when_url_is_not_string() {
+
+		$prepare_url = new PrepareUrl();
+		$default     = 'default value';
+		$result      = $prepare_url->transform( 123, null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
+	/**
+	 * Test it returns default when url cannot be parsed.
+	 */
+	public function test_it_returns_default_when_url_cannot_be_parsed() {
+		$prepare_url = new PrepareUrl();
+		$default     = 'default value';
+		$result      = $prepare_url->transform( 'invalid url', null, $default );
+		$this->assertEquals( $default, $result );
+	}
+
 	/**
 	 * Test it returns url without protocol and trailing slash.
 	 */