Merge pull request #824 from newfold-labs/add/onboarding-time-tracking

track start and end time for onboarding

Author: wpalani

includes/Services/EventService.php

@@ -3,6 +3,7 @@
 namespace NewfoldLabs\WP\Module\Onboarding\Services;
 
 use NewfoldLabs\WP\Module\Onboarding\Data\Events;
+use NewfoldLabs\WP\Module\Onboarding\Data\Options;
 
 /**
  * Class for handling analytics events.
@@ -24,6 +25,9 @@ public static function send( $event ) {
 			);
 		}
 
+		// Add timestamp and ttl to specific events
+		$event = self::add_timestamp_and_ttl( $event );
+
 		$event_data_request = new \WP_REST_Request(
 			\WP_REST_Server::CREATABLE,
 			NFD_MODULE_DATA_EVENTS_API
@@ -86,4 +90,46 @@ public static function validate( $event ) {
 
 		return $event;
 	}
+
+	/**
+	 * Adds timestamp and ttl properties to specific events (onboarding_started and onboarding_complete).
+	 *
+	 * @param array $event The event to enhance.
+	 * @return array The enhanced event.
+	 */
+	private static function add_timestamp_and_ttl( $event ) {
+		$current_time = time();
+
+		switch ( $event['action'] ) {
+			case 'onboarding_started':
+				// Add timestamp to onboarding_started event
+				$event['data']['timestamp'] = $current_time;
+				break;
+
+			case 'onboarding_complete':
+				// Add timestamp and ttl to onboarding_complete event
+				$event['data']['timestamp'] = $current_time;
+
+				// Use the same completion time that was stored in handle_completed()
+				$completion_time = get_option( Options::get_option_name( 'completed_time' ) );
+				$start_time = get_option( Options::get_option_name( 'start_time' ) );
+
+				if ( $start_time ) {
+					if ( $completion_time ) {
+						// Use stored completion time
+						$ttl_seconds = $completion_time - $start_time;
+					} else {
+						// Fallback to current time if completion_time not found
+						$ttl_seconds = $current_time - $start_time;
+					}
+
+					if ( $ttl_seconds >= 0 ) {
+						$event['data']['ttl'] = $ttl_seconds;
+					}
+				}
+				break;
+		}
+
+		return $event;
+	}
 }

includes/Services/StatusService.php

@@ -22,6 +22,10 @@ public static function handle_started(): bool {
 		$status = get_option( Options::get_option_name( 'status' ) );
 		if ( 'started' !== $status && 'completed' !== $status ) {
 			update_option( Options::get_option_name( 'status' ), 'started' );
+
+			// Store start time when onboarding begins
+			update_option( Options::get_option_name( 'start_time' ), time() );
+
 			do_action( 'newfold/onboarding/started' );
 			return true;
 		}
@@ -36,6 +40,10 @@ public static function handle_started(): bool {
 	public static function handle_abandoned(): void {
 		if ( 'started' === get_option( Options::get_option_name( 'status' ) ) ) {
 			update_option( Options::get_option_name( 'status' ), 'abandoned' );
+
+			// Clean up time tracking when onboarding is abandoned
+			delete_option( Options::get_option_name( 'start_time' ) );
+			delete_option( Options::get_option_name( 'completed_time' ) );
 		}
 	}
 
@@ -47,6 +55,10 @@ public static function handle_abandoned(): void {
 	public static function handle_completed(): void {
 		if ( 'started' === get_option( Options::get_option_name( 'status' ) ) ) {
 			update_option( Options::get_option_name( 'status' ), 'completed' );
+
+			// Store completion time
+			update_option( Options::get_option_name( 'completed_time' ), time() );
+
 			/**
 			 * We're disabling the restart onboarding feature for now.
 			 */
@@ -181,7 +193,7 @@ public static function track(): void {
 		}
 
 		// Ignore if the request is not for the onboarding page.
-		if ( isset( $_GET['page'] ) && WP_Admin::$slug === \sanitize_text_field( $_GET['page'] ) ) {
+		if ( isset( $_GET['page'] ) && \sanitize_text_field( $_GET['page'] ) === WP_Admin::$slug ) {
 			return;
 		}