Creating tests for Tribe__PUE__Notices class.

changelog/fix-PUE_Notices_duplication

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Improved data sanitization for tribe_pue_key_notices to prevent memory exhaustion errors caused by corrupted data. [ET-2277]

src/Tribe/PUE/Notices.php

@@ -11,8 +11,36 @@ class Tribe__PUE__Notices {
 	const EXPIRED_KEY = 'expired_key';
 	const STORE_KEY   = 'tribe_pue_key_notices';
 
+	/**
+	 * List of registered plugin names for use in notifications.
+	 *
+	 * Holds an array of plugin names that are registered during
+	 * a request. Only registered plugins will appear in notifications.
+	 *
+	 * @var string[]
+	 */
 	protected $registered = [];
+
+	/**
+	 * Notices previously saved in the database.
+	 *
+	 * Holds the saved notices retrieved from the database,
+	 * typically via the `get_option` function. It serves as a reference for
+	 * comparing or merging with current notices.
+	 *
+	 * @var array<string, array<string, bool>>
+	 */
 	protected $saved_notices = [];
+
+	/**
+	 * Notices to be displayed or processed during the current request.
+	 *
+	 * Contains the current set of notices, which may include
+	 * notices added during the current request. It is merged with
+	 * `$saved_notices` to ensure consistency.
+	 *
+	 * @var array<string, array<string, bool>>
+	 */
 	protected $notices = [];
 
 	protected $plugin_names = [
@@ -85,28 +113,72 @@ public function register_name( $plugin_name ) {
 	}
 
 	/**
-	 * Restores plugins added on previous requests to the relevant notification
-	 * groups.
+	 * Restores and sanitizes plugin notices to ensure data integrity and prevent memory issues.
+	 *
+	 * Retrieves saved notices from the database, validates and sanitizes them,
+	 * and merges them with the current request's notices. If discrepancies or corrupted data
+	 * are detected, it updates the database to reflect the corrected state.
+	 *
+	 * @since TBD Switched from `array_merge_recursive` to `wp_parse_args` to fix data duplication issues. Added additional sanitation and memory safeguards to handle large data sets effectively.
+	 *
+	 * @return void
 	 */
 	protected function populate() {
-		$this->saved_notices = (array) get_option( self::STORE_KEY, [] );
+		$saved_notices = get_option( self::STORE_KEY, [] );
 
-		if ( empty( $this->saved_notices ) ) {
-			return;
+		// If $saved_notices is not an array, reset it to an empty array.
+		$original_saved_notices = is_array( $saved_notices ) ? $saved_notices : [];
+
+		// Sanitize $saved_notices.
+		$sanitized_saved_notices = $this->sanitize_notices( $original_saved_notices );
+
+		// Update the option if sanitized data differs or the original data was not an array.
+		if ( $saved_notices !== $sanitized_saved_notices ) {
+			update_option( self::STORE_KEY, $sanitized_saved_notices );
 		}
 
-		$this->notices = array_merge_recursive( $this->notices, $this->saved_notices );
+		unset( $saved_notices );
+
+		// Set the sanitized saved notices to the class property.
+		$this->saved_notices = $sanitized_saved_notices;
 
-		// Cleanup
-		foreach ( $this->notices as $key => &$plugin_lists ) {
-			// Purge any elements that are not arrays
-			if ( ! is_array( $plugin_lists ) ) {
-				unset( $this->notices[ $key ] );
+		// Unset $sanitized_saved_notices to free memory.
+		unset( $sanitized_saved_notices, $original_saved_notices );
+
+		// Merge and sanitize notices with the saved notices.
+		$this->notices = $this->sanitize_notices(
+			wp_parse_args( $this->notices, $this->saved_notices )
+		);
+
+		// Save the final sanitized and merged notices back to the database if they differ.
+		if ( $this->saved_notices !== $this->notices ) {
+			update_option( self::STORE_KEY, $this->notices );
+		}
+	}
+
+	/**
+	 * Recursively sanitizes notices to prevent nesting and ensure data integrity.
+	 *
+	 * @param array $notices The array of notices to sanitize.
+	 *
+	 * @return array Sanitized notices.
+	 */
+	protected function sanitize_notices( array $notices ): array {
+		foreach ( $notices as $key => &$plugin_list ) {
+			// Ensure the value is an array; otherwise, reset it.
+			if ( ! is_array( $plugin_list ) ) {
+				$plugin_list = [];
 				continue;
 			}
+
+			foreach ( $plugin_list as $plugin => $data ) {
+				// Flatten deeply nested arrays and set the value to `true`.
+				$plugin_list[ $plugin ] = true;
+			}
 		}
-	}
 
+		return $notices;
+	}
 	/**
 	 * Saves any license key notices already added.
 	 */
@@ -566,4 +638,20 @@ protected function get_formatted_plugin_names( $group ) {
 
 		return '<span class="plugin-list">' . $html . '</span>';
 	}
+
+	/**
+	 * Clears all stored and saved notices.
+	 *
+	 * This method resets both the `notices` and `saved_notices` properties to empty arrays,
+	 * effectively removing all license key notifications from memory.
+	 *
+	 * Note: This does not persist changes to the database. To save changes,
+	 * ensure `save_notices()` is called after invoking this method.
+	 *
+	 * @return void
+	 */
+	public function clear_all_notices() {
+		$this->notices       = [];
+		$this->saved_notices = [];
+	}
 }