← All changes
|
core/common/modules/events-manager/module.php
+61
-28
4.1.0-dev3
→
4.3.0-beta3
View file →
| @@ -4,8 +4,9 @@ | ||
| 4 | 4 | |
| 5 | 5 | use Elementor\Core\Base\Module as BaseModule; |
| 6 | 6 | use Elementor\Core\Common\Modules\Connect\Apps\Base_App; |
| 7 | 7 | use Elementor\Core\Common\Modules\Connect\Apps\Common_App; |
| 8 | +use Elementor\Core\Common\Modules\EventsManager\RestApi\Events_Proxy_REST_API; | |
| 8 | 9 | use Elementor\Core\Experiments\Manager as Experiments_Manager; |
| 9 | 10 | use Elementor\Includes\EditorAssetsAPI; |
| 10 | 11 | use Elementor\Utils; |
| 11 | 12 | use Elementor\Plugin; |
| @@ -17,23 +18,30 @@ | ||
| 17 | 18 | |
| 18 | 19 | class Module extends BaseModule { |
| 19 | 20 | |
| 20 | 21 | const EXPERIMENT_NAME = 'editor_events'; |
| 22 | + const DEFAULT_SESSION_RECORDING_PERCENT = 0; | |
| 23 | + const REMOTE_MIXPANEL_CONFIG_URL = 'https://assets.elementor.com/mixpanel/v1/mixpanel.json'; | |
| 21 | 24 | |
| 22 | - const REMOTE_MIXPANEL_CONFIG_URL = 'https://assets.elementor.com/mixpanel/v1/mixpanel.json'; | |
| 25 | + const API_UPSTREAM_HOST = 'https://api-eu.mixpanel.com'; | |
| 26 | + const LIBS_UPSTREAM_HOST = 'https://cdn.mxpnl.com/libs'; | |
| 23 | 27 | |
| 28 | + public function __construct() { | |
| 29 | + parent::__construct(); | |
| 30 | + | |
| 31 | + ( new Events_Proxy_REST_API() )->register_hooks(); | |
| 32 | + } | |
| 33 | + | |
| 24 | 34 | public function get_name() { |
| 25 | 35 | return 'events-manager'; |
| 26 | 36 | } |
| 27 | 37 | |
| 28 | 38 | public static function get_editor_events_config() { |
| 29 | - $can_send_events = ! empty( ELEMENTOR_EDITOR_EVENTS_MIXPANEL_TOKEN ) && | |
| 30 | - Tracker::is_allow_track() && | |
| 31 | - ! Tracker::has_terms_changed( '2025-07-07' ) && | |
| 32 | - Plugin::$instance->experiments->is_feature_active( self::EXPERIMENT_NAME ); | |
| 39 | + $can_send_events = self::can_send_events(); | |
| 33 | 40 | |
| 34 | 41 | $is_flags_enabled = false; |
| 35 | - $session_recording_events = []; | |
| 42 | + $session_recording_percent = self::DEFAULT_SESSION_RECORDING_PERCENT; | |
| 43 | + $debug = ( defined( 'ELEMENTOR_EDITOR_EVENTS_DEBUG' ) && ELEMENTOR_EDITOR_EVENTS_DEBUG ) ?? false; | |
| 36 | 44 | |
| 37 | 45 | if ( $can_send_events ) { |
| 38 | 46 | $mixpanel_config = self::get_remote_mixpanel_config(); |
| 39 | 47 | $has_config = EditorAssetsAPI::has_valid_nested_array( $mixpanel_config, [ 0 ] ); |
| @@ -41,28 +49,15 @@ | ||
| 41 | 49 | if ( $has_config ) { |
| 42 | 50 | $is_flags_enabled = (bool) ( $mixpanel_config[0]['flags'] ?? false ); |
| 43 | 51 | |
| 44 | 52 | $session_replays = $mixpanel_config[0]['sessionReplays'] ?? []; |
| 45 | - $is_session_replays_enabled = (bool) ( $session_replays['enabled'] ?? false ); | |
| 46 | - $raw_events = $session_replays['events'] ?? null; | |
| 47 | - $events_map = is_array( $raw_events ) ? $raw_events : []; | |
| 48 | - | |
| 49 | - if ( $is_session_replays_enabled ) { | |
| 50 | - $session_recording_events = array_values( array_filter( | |
| 51 | - self::get_session_recording_events(), | |
| 52 | - function ( $pair ) use ( $events_map ) { | |
| 53 | - if ( ! isset( $pair['start'] ) ) { | |
| 54 | - return false; | |
| 55 | - } | |
| 56 | - return (bool) ( $events_map[ $pair['start'] ] ?? false ); | |
| 57 | - } | |
| 58 | - ) ); | |
| 59 | - } | |
| 53 | + $session_recording_percent = $session_replays['recordSessionsPercent'] ?? null; | |
| 60 | 54 | } |
| 61 | 55 | } |
| 62 | 56 | |
| 63 | 57 | $settings = [ |
| 64 | 58 | 'can_send_events' => $can_send_events, |
| 59 | + 'debug' => $debug, | |
| 65 | 60 | 'elementor_version' => ELEMENTOR_VERSION, |
| 66 | 61 | 'site_url' => hash( 'sha256', get_site_url() ), |
| 67 | 62 | 'wp_version' => get_bloginfo( 'version' ), |
| 68 | 63 | 'user_agent' => esc_html( Utils::get_super_global_value( $_SERVER, 'HTTP_USER_AGENT' ) ), |
| @@ -70,16 +65,43 @@ | ||
| 70 | 65 | 'site_key' => get_option( Base_App::OPTION_CONNECT_SITE_KEY ), |
| 71 | 66 | 'subscription_id' => self::get_subscription_id(), |
| 72 | 67 | 'subscription' => self::get_subscription(), |
| 73 | 68 | 'token' => ELEMENTOR_EDITOR_EVENTS_MIXPANEL_TOKEN, |
| 69 | + 'proxy_api_host' => rest_url( Events_Proxy_REST_API::API_NAMESPACE . '/' . Events_Proxy_REST_API::API_BASE . '/api' ), | |
| 70 | + 'proxy_lib_base_path' => rest_url( Events_Proxy_REST_API::API_NAMESPACE . '/' . Events_Proxy_REST_API::API_BASE . '/libs/' ), | |
| 74 | 71 | 'flags_enabled' => $is_flags_enabled, |
| 75 | 72 | 'user_id' => self::get_user_id(), |
| 76 | - 'session_recording_events' => $session_recording_events, | |
| 73 | + 'session_recording_percent' => $session_recording_percent, | |
| 77 | 74 | ]; |
| 78 | 75 | |
| 79 | 76 | return $settings; |
| 80 | 77 | } |
| 81 | 78 | |
| 79 | + public static function dispatch_event( string $event_name, array $properties = [] ): void { | |
| 80 | + if ( ! self::can_send_events() ) { | |
| 81 | + return; | |
| 82 | + } | |
| 83 | + | |
| 84 | + try { | |
| 85 | + $user_id = self::get_user_id(); | |
| 86 | + | |
| 87 | + $context = [ | |
| 88 | + 'user_id' => $user_id, | |
| 89 | + 'distinct_id' => $user_id, | |
| 90 | + 'subscription_id' => self::get_subscription_id(), | |
| 91 | + 'site_key' => get_option( Base_App::OPTION_CONNECT_SITE_KEY ), | |
| 92 | + 'app_version' => ELEMENTOR_VERSION, | |
| 93 | + 'wp_version' => get_bloginfo( 'version' ), | |
| 94 | + 'site_language' => get_locale(), | |
| 95 | + 'source' => 'server', | |
| 96 | + ]; | |
| 97 | + | |
| 98 | + Server_Events_Client::track( $event_name, array_merge( $properties, $context ) ); | |
| 99 | + } catch ( \Throwable $e ) { | |
| 100 | + return; | |
| 101 | + } | |
| 102 | + } | |
| 103 | + | |
| 82 | 104 | public static function get_experimental_data(): array { |
| 83 | 105 | return [ |
| 84 | 106 | 'name' => static::EXPERIMENT_NAME, |
| 85 | 107 | 'title' => esc_html__( 'Elementor Editor Events', 'elementor' ), |
| @@ -93,8 +115,15 @@ | ||
| 93 | 115 | ], |
| 94 | 116 | ]; |
| 95 | 117 | } |
| 96 | 118 | |
| 119 | + private static function can_send_events(): bool { | |
| 120 | + return ! empty( ELEMENTOR_EDITOR_EVENTS_MIXPANEL_TOKEN ) && | |
| 121 | + Tracker::is_allow_track() && | |
| 122 | + ! Tracker::has_terms_changed() && | |
| 123 | + Plugin::$instance->experiments->is_feature_active( self::EXPERIMENT_NAME ); | |
| 124 | + } | |
| 125 | + | |
| 97 | 126 | private static function get_subscription_id() { |
| 98 | 127 | $subscription = self::get_subscription(); |
| 99 | 128 | |
| 100 | 129 | return $subscription['subscription_id'] ?? null; |
| @@ -122,14 +151,18 @@ | ||
| 122 | 151 | |
| 123 | 152 | return $editor_assets_api->get_assets_data(); |
| 124 | 153 | } |
| 125 | 154 | |
| 126 | - private static function get_session_recording_events(): array { | |
| 127 | - return [ | |
| 128 | - // Each entry defines a recording window: recording starts when 'start' fires | |
| 129 | - // and stops when 'end' fires. 'end' is optional — omit or set to null to record indefinitely. | |
| 130 | - [ 'start' => 'editor_loaded' ], | |
| 131 | - ]; | |
| 155 | + public static function get_mixpanel_api_host() { | |
| 156 | + $mixpanel_config = self::get_remote_mixpanel_config(); | |
| 157 | + | |
| 158 | + return wp_http_validate_url( $mixpanel_config[0]['apiHost'] ?? static::API_UPSTREAM_HOST ); | |
| 159 | + } | |
| 160 | + | |
| 161 | + public static function get_mixpanel_lib_host() { | |
| 162 | + $mixpanel_config = self::get_remote_mixpanel_config(); | |
| 163 | + | |
| 164 | + return wp_http_validate_url( $mixpanel_config[0]['libHost'] ?? static::LIBS_UPSTREAM_HOST ); | |
| 132 | 165 | } |
| 133 | 166 | |
| 134 | 167 | private static function get_user_id() { |
| 135 | 168 | $user_common_data = get_user_option( Common_App::OPTION_CONNECT_COMMON_DATA_KEY ); |