Skip to content

Analytics: reliable activation event, stable install identity, consistent categories #1262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
udil-cloudinary wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Analytics: reliable activation event, stable install identity, consistent categories #1262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions php/class-admin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,9 +538,10 @@ protected function maybe_track_global_transformation( $analytics, $submission, $

$analytics->track(
'transformation_applied',
'media',
'feature_usage',
null,
array(
'feature' => 'transformation',
'scope' => 'global',
'transformation_count' => count( $matched ),
)
Expand All @@ -565,9 +566,10 @@ protected function track_gallery_configured( $analytics, $data ) {

$analytics->track(
'gallery_configured',
'features',
'feature_usage',
null,
array(
'feature' => 'gallery',
'layout' => isset( $config['displayProps']['mode'] ) ? $config['displayProps']['mode'] : '',
'media_count' => isset( $config['mediaAssets'] ) && is_array( $config['mediaAssets'] ) ? count( $config['mediaAssets'] ) : 0,
)
Expand Down
37 changes: 34 additions & 3 deletions php/class-analytics.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public static function stash_activation() {
'new_version' => $current,
'days_since_last_active' => $days_since_last_active,
),
HOUR_IN_SECONDS
DAY_IN_SECONDS
);
} catch ( \Throwable $e ) {
// Fail silent: activation must never break.
Expand All @@ -147,6 +147,11 @@ public static function record_deactivation() {
* @return void
*/
public function maybe_send_pending_activation() {
// Leave the stash intact if emission is disabled, so the event is not
// consumed-and-dropped and can still be sent on a later admin load.
if ( ! $this->is_enabled() ) {
return;
}
$pending = get_transient( self::PENDING_ACTIVATION );
if ( empty( $pending ) || ! is_array( $pending ) ) {
return;
Expand Down Expand Up @@ -314,6 +319,7 @@ protected function base_params() {
'wp_version' => get_bloginfo( 'version' ),
'php_version' => PHP_VERSION,
'site_id' => hash( 'sha256', home_url() ),
'install_id' => $this->get_install_id(),
'session_id' => $this->get_session_id(),
'user_role' => $this->get_user_role(),
'is_multisite' => is_multisite(),
Expand All @@ -335,6 +341,25 @@ protected function base_params() {
return $params;
}

/**
* Stable, session-independent installation identifier.
*
* Generated once and persisted, so events emitted off-interactive
* (cron/queue/front-end), where `session_id` is empty, still carry a
* durable join key. Unlike `site_id` it survives a domain change.
*
* @return string
*/
protected function get_install_id() {
$id = get_option( '_cloudinary_install_id' );
if ( empty( $id ) ) {
$id = wp_generate_uuid4();
add_option( '_cloudinary_install_id', $id, '', false );
}

return (string) $id;
}

/**
* Per-admin-session identifier, derived from the hashed WP login token.
*
Expand Down Expand Up @@ -369,7 +394,13 @@ protected function get_user_role() {
return (string) reset( $user->roles );
}

return '';
// No acting user (cron/queue/front-end): record the context instead of
// an empty string so off-interactive events remain distinguishable.
if ( wp_doing_cron() ) {
return 'cron';
}

return is_admin() ? 'system' : 'front';
}

/**
Expand Down Expand Up @@ -475,7 +506,7 @@ public function maybe_send_smoke_event() {
}
set_transient( $throttle_key, true, 5 * MINUTE_IN_SECONDS );

$this->track( 'poc_smoke_test', 'poc' );
$this->track( 'poc_smoke_test', 'system' );
}

/**
Expand Down
3 changes: 2 additions & 1 deletion php/class-assets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,10 @@ public function track_cache_uploaded( $attachment_id, $result ) {

$analytics->track(
'cache_uploaded',
'cache',
'feature_usage',
null,
array(
'feature' => 'asset_sync',
'item_count' => 1,
'status' => is_wp_error( $result ) ? 'error' : 'success',
)
Expand Down
2 changes: 1 addition & 1 deletion php/class-deactivation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ public function rest_callback( WP_REST_Request $request ) {
if ( $analytics && ! $is_contact_flow ) {
$analytics->track(
'deactivation_submitted',
'deactivation',
'activation_funnel',
null,
array(
'reason_id' => sanitize_text_field( $reason ),
Expand Down
Loading