4219337b405746bc85dcd98d59a4f0c481d96048

Committed 03 Apr 2025 02:57PM UTC coverage: 54.506% (+0.07%) from 54.437%

Build # 4219337b405746bc85dcd98d59a4f0c481d96048

Build Type

Pull #22125

github

Committed by

web-flow

Commit Message

Merge d4122c4ff into 96c815bb6

Pull Request Pull Request #22125: Add tracking of user progress in the Site Kit setup widged

Run Details

7801 of 13850 branches covered (56.32%)

Branch coverage included in aggregate %.

124 of 150 new or added lines in 10 files covered. (82.67%)

1 existing line in 1 file now uncovered.

29688 of 54930 relevant lines covered (54.05%)

43392.31 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.67

/src/dashboard/user-interface/tracking/setup-steps-tracking-route.php

<?php
// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
namespace Yoast\WP\SEO\Dashboard\User_Interface\Tracking;

use Exception;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
use Yoast\WP\SEO\Conditionals\No_Conditionals;
use Yoast\WP\SEO\Dashboard\Infrastructure\Tracking\Setup_Steps_Tracking_Repository_Interface;
use Yoast\WP\SEO\Helpers\Capability_Helper;
use Yoast\WP\SEO\Main;
use Yoast\WP\SEO\Routes\Route_Interface;

/**
 * Registers a route to keep track of the Site Kit usage.
 *
 * @makePublic
 *
 * @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded
 */
class Setup_Steps_Tracking_Route implements Route_Interface {

        use No_Conditionals;

        /**
         *  The namespace for this route.
         *
         * @var string
         */
        public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;

        /**
         *  The prefix for this route.
         *
         * @var string
         */
        public const ROUTE_PREFIX = '/setup_steps_tracking';

        /**
         * Holds the repository instance.
         *
         * @var Setup_Steps_Tracking_Repository_Interface
         */
        private $setup_steps_tracking_repository;

        /**
         * Holds the capability helper instance.
         *
         * @var Capability_Helper
         */
        private $capability_helper;

        /**
         * Constructs the class.
         *
         * @param Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository The repository.
         * @param Capability_Helper                         $capability_helper               The capability helper.
         */
        public function __construct(
                Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository,
                Capability_Helper $capability_helper
        ) {
                $this->setup_steps_tracking_repository = $setup_steps_tracking_repository;
                $this->capability_helper               = $capability_helper;
        }

        /**
         * Registers routes with WordPress.
         *
         * @return void
         */
        public function register_routes() {
                \register_rest_route(
                        self::ROUTE_NAMESPACE,
                        self::ROUTE_PREFIX,
                        [
                                [
                                        'methods'             => 'POST',
                                        'callback'            => [ $this, 'track_setup_steps' ],
                                        'permission_callback' => [ $this, 'check_capabilities' ],
                                        'args'                => [
                                                'setup_widget_loaded' => [
                                                        'required'          => false,
                                                        'type'              => 'string',
                                                        'enum'              => [ 'yes', 'no' ],
                                                ],
                                                'first_interaction_stage' => [
                                                        'required'          => false,
                                                        'type'              => 'string',
                                                        'enum'              => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
                                                ],
                                                'last_interaction_stage' => [
                                                        'required'          => false,
                                                        'type'              => 'string',
                                                        'enum'              => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],
                                                ],
                                                'setup_widget_temporarily_dismissed' => [
                                                        'required'          => false,
                                                        'type'              => 'string',
                                                        'enum'              => [ 'yes', 'no' ],
                                                ],
                                                'setup_widget_permanently_dismissed' => [
                                                        'required'          => false,
                                                        'type'              => 'string',
                                                        'enum'              => [ 'yes', 'no' ],
                                                ],
                                        ],
                                ],
                        ]
                );
        }

        /**
         * Stores tracking information.
         *
         * @param WP_REST_Request $request The request object.
         *
         * @return WP_REST_Response|WP_Error The success or failure response.
         */
        public function track_setup_steps( WP_REST_Request $request ) {
                $data = \array_filter(
                        [
                                'setup_widget_loaded'                => $request->get_param( 'setupWidgetLoaded' ),
                                'first_interaction_stage'            => $request->get_param( 'firstInteractionStage' ),
                                'last_interaction_stage'             => $request->get_param( 'lastInteractionStage' ),
                                'setup_widget_temporarily_dismissed' => $request->get_param( 'setupWidgetTemporarilyDismissed' ),
                                'setup_widget_permanently_dismissed' => $request->get_param( 'setupWidgetPermanentlyDismissed' ),
                        ],
                        static function ( $element_value ) {
                                        return ! \is_null( $element_value );
                        }
                );

                if ( empty( $data ) ) {
                        return new WP_Error(
                                'wpseo_set_site_kit_usage_tracking',
                                \__( 'No valid parameters were provided.', 'wordpress-seo' ),
                                (object) []
                        );
                }

                $result = true;
                foreach ( $data as $element_name => $element_value ) {
                        try {
                                $result = $this->setup_steps_tracking_repository->set_setup_steps_tracking_element( $element_name, $element_value );
                        } catch ( Exception $exception ) {
                                return new WP_Error(
                                        'wpseo_set_site_kit_usage_tracking',
                                        $exception->getMessage(),
                                        (object) []
                                );
                        }
                        if ( ! $result ) {
                                break;
                        }
                }

                return new WP_REST_Response(
                        [
                                'success' => $result,
                        ],
                        ( $result ) ? 200 : 400
                );
        }

        /**
         * Checks if the current user has the required capabilities.
         *
         * @return bool
         */
        public function check_capabilities() {
                return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
        }
}

1	<?php
2	// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure.
3	namespace Yoast\WP\SEO\Dashboard\User_Interface\Tracking;
4
5	use Exception;
6	use WP_Error;
7	use WP_REST_Request;
8	use WP_REST_Response;
9	use Yoast\WP\SEO\Conditionals\No_Conditionals;
10	use Yoast\WP\SEO\Dashboard\Infrastructure\Tracking\Setup_Steps_Tracking_Repository_Interface;
11	use Yoast\WP\SEO\Helpers\Capability_Helper;
12	use Yoast\WP\SEO\Main;
13	use Yoast\WP\SEO\Routes\Route_Interface;
14
15	/**
16	* Registers a route to keep track of the Site Kit usage.
17	*
18	* @makePublic
19	*
20	* @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded
21	*/
22	class Setup_Steps_Tracking_Route implements Route_Interface {
23
24	use No_Conditionals;
25
26	/**
27	* The namespace for this route.
28	*
29	* @var string
30	*/
31	public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;
32
33	/**
34	* The prefix for this route.
35	*
36	* @var string
37	*/
38	public const ROUTE_PREFIX = '/setup_steps_tracking';
39
40	/**
41	* Holds the repository instance.
42	*
43	* @var Setup_Steps_Tracking_Repository_Interface
44	*/
45	private $setup_steps_tracking_repository;
46
47	/**
48	* Holds the capability helper instance.
49	*
50	* @var Capability_Helper
51	*/
52	private $capability_helper;
53
54	/**
55	* Constructs the class.
56	*
57	* @param Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository The repository.
58	* @param Capability_Helper $capability_helper The capability helper.
59	*/
60	public function __construct(	6✔
61	Setup_Steps_Tracking_Repository_Interface $setup_steps_tracking_repository,
62	Capability_Helper $capability_helper
63	) {	1✔
64	$this->setup_steps_tracking_repository = $setup_steps_tracking_repository;	6✔
65	$this->capability_helper = $capability_helper;	6✔
66	}	1✔
67
68	/**
69	* Registers routes with WordPress.
70	*
71	* @return void
72	*/
73	public function register_routes() {	2✔
74	\register_rest_route(	2✔
75	self::ROUTE_NAMESPACE,	2✔
76	self::ROUTE_PREFIX,	2✔
77	[	1✔
78	[	1✔
79	'methods' => 'POST',	2✔
80	'callback' => [ $this, 'track_setup_steps' ],	2✔
81	'permission_callback' => [ $this, 'check_capabilities' ],	2✔
82	'args' => [	1✔
83	'setup_widget_loaded' => [	1✔
84	'required' => false,	1✔
85	'type' => 'string',	1✔
86	'enum' => [ 'yes', 'no' ],	1✔
87	],	1✔
88	'first_interaction_stage' => [	1✔
89	'required' => false,	1✔
90	'type' => 'string',	1✔
91	'enum' => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],	1✔
92	],	1✔
93	'last_interaction_stage' => [	1✔
94	'required' => false,	1✔
95	'type' => 'string',	1✔
96	'enum' => [ 'install', 'activate', 'setup', 'grantConsent', 'successfullyConnected' ],	1✔
97	],	1✔
98	'setup_widget_temporarily_dismissed' => [	1✔
99	'required' => false,	1✔
100	'type' => 'string',	1✔
101	'enum' => [ 'yes', 'no' ],	1✔
102	],	1✔
103	'setup_widget_permanently_dismissed' => [	1✔
104	'required' => false,	1✔
105	'type' => 'string',	1✔
106	'enum' => [ 'yes', 'no' ],	1✔
107	],	1✔
108	],	1✔
109	],	1✔
110	]	1✔
111	);	1✔
112	}	1✔
113
114	/**
115	* Stores tracking information.
116	*
117	* @param WP_REST_Request $request The request object.
118	*
119	* @return WP_REST_Response\|WP_Error The success or failure response.
120	*/
121	public function track_setup_steps( WP_REST_Request $request ) {	2✔
122	$data = \array_filter(	2✔
123	[	2✔
124	'setup_widget_loaded' => $request->get_param( 'setupWidgetLoaded' ),	2✔
125	'first_interaction_stage' => $request->get_param( 'firstInteractionStage' ),	2✔
126	'last_interaction_stage' => $request->get_param( 'lastInteractionStage' ),	2✔
127	'setup_widget_temporarily_dismissed' => $request->get_param( 'setupWidgetTemporarilyDismissed' ),	2✔
128	'setup_widget_permanently_dismissed' => $request->get_param( 'setupWidgetPermanentlyDismissed' ),	2✔
129	],	2✔
130	static function ( $element_value ) {	2✔
131	return ! \is_null( $element_value );	2✔
132	}	2✔
133	);	2✔
134
NEW 135	if ( empty( $data ) ) {	×
NEW 136	return new WP_Error(	×
NEW 137	'wpseo_set_site_kit_usage_tracking',	×
NEW 138	\__( 'No valid parameters were provided.', 'wordpress-seo' ),	×
139	(object) []
140	);
141	}
142
143	$result = true;	2✔
144	foreach ( $data as $element_name => $element_value ) {
145	try {
NEW 146	$result = $this->setup_steps_tracking_repository->set_setup_steps_tracking_element( $element_name, $element_value );	×
NEW 147	} catch ( Exception $exception ) {	×
NEW 148	return new WP_Error(	×
NEW 149	'wpseo_set_site_kit_usage_tracking',	×
NEW 150	$exception->getMessage(),	×
151	(object) []
152	);
153	}
NEW 154	if ( ! $result ) {	×
155	break;
156	}
157	}
158
159	return new WP_REST_Response(	2✔
160	[	2✔
161	'success' => $result,	2✔
162	],	2✔
163	( $result ) ? 200 : 400	2✔
164	);	2✔
165	}
166
167	/**
168	* Checks if the current user has the required capabilities.
169	*
170	* @return bool
171	*/
172	public function check_capabilities() {
173	return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
174	}
175	}

Yoast / wordpress-seo / 4219337b405746bc85dcd98d59a4f0c481d96048

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous