feat: add HTML comment generation for profiling data and improve parameter validation in REST API

Author: selul

inc/manager.php

@@ -432,6 +432,7 @@ public function replace_content( $html, $partial = false ) {
 		}
 		if ( self::should_load_profiler( $partial ) ) {
 			$profile_id = Profile::generate_id( $html );
+			$should_show_comment = false;
 			// We disable the optimizer for logged in users.
 			if ( ! is_user_logged_in() || ! apply_filters( 'optml_force_page_profiler', false ) !== true ) {
 				$js_optimizer = Optml_Admin::get_optimizer_script( false );
@@ -449,11 +450,16 @@ public function replace_content( $html, $partial = false ) {
 					if ( ! headers_sent() ) {
 						header( 'Cache-Control: max-age=300' ); // Attempt to cache the page just for 5 mins until the optimizer is done. Once the optimizer is done, the page will load optimized.
 					}
+				} else {
+					$should_show_comment = isset( $_GET['optml_debug'] ) && $_GET['optml_debug'] === 'true';
 				}
 			}
 
 			Profile::set_current_profile_id( $profile_id );
 			$this->page_profiler->set_current_profile_data();
+			if ( $should_show_comment ) {
+				$html = str_replace( '</html>', '</html>' . $this->page_profiler->get_current_profile_html_comment(), $html );
+			}
 		}
 		if ( ! $partial ) {
 			$html = $this->add_html_class( $html );

inc/rest.php

@@ -950,7 +950,7 @@ public function optimizations( WP_REST_Request $request ) {
 		if ( empty( $origin ) || ! is_allowed_http_origin( $origin ) ) {
 			return $this->response( 'Invalid origin', 'error' );
 		}
-		if ( empty( $device_type ) || empty( $above_fold_images ) || empty( $url ) || ! is_array( $above_fold_images ) ) {
+		if ( empty( $device_type ) || empty( $url ) || ! is_array( $above_fold_images ) ) {
 			return $this->response( 'Missing required parameters', 'error' );
 		}
 		if ( count( $above_fold_images ) > 20 ) {

inc/v2/PageProfiler/Profile.php

@@ -455,4 +455,50 @@ public function check_data_availability(): bool {
 
 		return $has_data;
 	}
+
+	/**
+	 * Generate HTML comment with profile data and performance metrics.
+	 *
+	 * @return string HTML comment with profile data and metrics.
+	 */
+	public function get_current_profile_html_comment(): string {
+		$profile_data = self::get_current_profile_data();
+
+		if ( empty( $profile_data ) ) {
+			return '<!-- plugin=optimole-wp: No profile ID available -->';
+		}
+
+		// Format the HTML comment
+		$comment_parts = [
+			'plugin=optimole-wp',
+		];
+
+		// Add device-specific metrics
+		foreach ( $profile_data as $device_type => $device_data ) {
+			$device_name = $this->get_device_name( $device_type );
+			$comment_parts[] = 'measurement#device-' . $device_name . '#' . json_encode( $device_data );
+		}
+
+		return '<!-- ' . implode( ' ', $comment_parts ) . ' -->';
+	}
+
+
+	/**
+	 * Get device name from device type constant.
+	 *
+	 * @param int $device_type The device type constant.
+	 * @return string Device name.
+	 */
+	private function get_device_name( int $device_type ): string {
+		switch ( $device_type ) {
+			case self::DEVICE_TYPE_MOBILE:
+				return 'mobile';
+			case self::DEVICE_TYPE_DESKTOP:
+				return 'desktop';
+			case self::DEVICE_TYPE_GLOBAL:
+				return 'global';
+			default:
+				return 'unknown';
+		}
+	}
 }