Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.31%
108 / 117
75.00%
12 / 16
 CRAP
0.00%
0 / 1
Analytics_Dashboard
92.31%
108 / 117
75.00%
12 / 16
 46.96
0.00%
0 / 1
 init
100.00%
9 / 9
100.00%
1 / 1
 1
 register_section
100.00%
15 / 15
100.00%
1 / 1
 2
 get_no_orders_notice
100.00%
13 / 13
100.00%
1 / 1
 3
 get_default_layout
100.00%
20 / 20
100.00%
1 / 1
 1
 enqueue_store_performance_bookings
85.71%
6 / 7
0.00%
0 / 1
 6.10
 remove_unavailable_widget_types
100.00%
11 / 11
100.00%
1 / 1
 3
 register_widget_types
92.31%
12 / 13
0.00%
0 / 1
 5.01
 is_section_available
100.00%
1 / 1
100.00%
1 / 1
 2
 is_woocommerce_available
100.00%
2 / 2
100.00%
1 / 1
 2
 current_user_can_view_store_reports
100.00%
1 / 1
100.00%
1 / 1
 2
 is_bookings_plugin_active
100.00%
2 / 2
100.00%
1 / 1
 3
 supports_widget_contract
100.00%
7 / 7
100.00%
1 / 1
 5
 load_build
40.00%
2 / 5
0.00%
0 / 1
 4.94
 build_dir
100.00%
1 / 1
100.00%
1 / 1
 1
 section_slug_is_taken
100.00%
4 / 4
100.00%
1 / 1
 3
 dashboard_has_section_slug
33.33%
2 / 6
0.00%
0 / 1
 8.74
1<?php
2/**
3 * The WooCommerce section of the Premium Analytics dashboard.
4 *
5 * @package automattic/jetpack-woocommerce-stats
6 */
7
8namespace Automattic\Jetpack\WooCommerceStats;
9
10use Automattic\Jetpack\PremiumAnalytics\Sync\Sync_Status_Tracker;
11use function Automattic\Jetpack\PremiumAnalytics\get_dashboard_default_widget_instance;
12use function Automattic\Jetpack\PremiumAnalytics\register_dashboard_section;
13use function Automattic\Jetpack\PremiumAnalytics\register_widget_types_from_manifest;
14use const Automattic\Jetpack\PremiumAnalytics\DASHBOARD_NAME;
15
16/**
17 * Registers the WooCommerce section and the package's widget types.
18 *
19 * The plugin that bundles it calls `init()`; both register when the dashboard's registries hydrate,
20 * gated here on WooCommerce and on the reader's store reports capability.
21 *
22 * @since 0.1.0-alpha
23 */
24class Analytics_Dashboard {
25
26    const PACKAGE_VERSION = '0.3.2';
27
28    /**
29     * Namespaced section identifier. Its slug, `woocommerce`, keys the section's URL and stored layouts.
30     */
31    const SECTION_ID = 'woocommerce-analytics/woocommerce';
32
33    /**
34     * Widget type names the package builds, from `widgets/*\/widget.json`.
35     */
36    const STORE_PERFORMANCE_TYPE         = 'woocommerce-analytics/store-performance';
37    const NET_SALES_OVER_TIME_TYPE       = 'woocommerce-analytics/net-sales-over-time';
38    const TOTAL_SALES_OVER_TIME_TYPE     = 'woocommerce-analytics/total-sales-over-time';
39    const GROSS_SALES_OVER_TIME_TYPE     = 'woocommerce-analytics/gross-sales-over-time';
40    const ORDERS_OVER_TIME_TYPE          = 'woocommerce-analytics/orders-over-time';
41    const AVERAGE_ORDER_VALUE_TYPE       = 'woocommerce-analytics/average-order-value';
42    const AVERAGE_ITEMS_PER_ORDER_TYPE   = 'woocommerce-analytics/average-items-per-order';
43    const BOOKINGS_OVER_TIME_TYPE        = 'woocommerce-analytics/bookings-over-time';
44    const VISITORS_OVER_TIME_TYPE        = 'woocommerce-analytics/visitors-over-time';
45    const NEW_VS_RETURNING_CUSTOMER_TYPE = 'woocommerce-analytics/new-vs-returning-customer';
46    const PAYMENT_STATUS_TYPE            = 'woocommerce-analytics/payment-status';
47    const ORDERS_FULFILLMENT_TYPE        = 'woocommerce-analytics/orders-fulfillment';
48    const COUPON_USAGE_OVER_TIME_TYPE    = 'woocommerce-analytics/coupon-usage-over-time';
49    const BOOKINGS_BY_STATUS_TYPE        = 'woocommerce-analytics/bookings-by-status';
50    const SESSIONS_BY_DEVICE_TYPE        = 'woocommerce-analytics/sessions-by-device';
51
52    /**
53     * The columns family, with the bookings variants of the first two.
54     */
55    const REVENUE_BY_CUSTOMER_TYPE_TYPE          = 'woocommerce-analytics/revenue-by-customer-type';
56    const BOOKINGS_REVENUE_BY_CUSTOMER_TYPE_TYPE = 'woocommerce-analytics/bookings-revenue-by-customer-type';
57    const SALES_BY_DEVICE_TYPE                   = 'woocommerce-analytics/sales-by-device';
58    const BOOKINGS_BY_DEVICE_TYPE                = 'woocommerce-analytics/bookings-by-device';
59    const TOTAL_RETURNS_TYPE                     = 'woocommerce-analytics/total-returns';
60    const SALES_BY_COUPON_TYPE                   = 'woocommerce-analytics/sales-by-coupon';
61    const TOP_PERFORMING_PRODUCTS_TYPE           = 'woocommerce-analytics/top-performing-products';
62    const TOP_PERFORMING_BOOKINGS_TYPE           = 'woocommerce-analytics/top-performing-bookings';
63    const SALES_BY_UTM_SOURCE_TYPE               = 'woocommerce-analytics/sales-by-utm-source';
64    const SALES_BY_UTM_CHANNEL_TYPE              = 'woocommerce-analytics/sales-by-utm-channel';
65    const SALES_BY_UTM_CAMPAIGN_TYPE             = 'woocommerce-analytics/sales-by-utm-campaign';
66    const VISITORS_BY_LOCATION_TYPE              = 'woocommerce-analytics/visitors-by-location';
67
68    /**
69     * The conversion funnel, for every product and for bookings.
70     */
71    const CONVERSION_RATE_TYPE                = 'woocommerce-analytics/conversion-rate';
72    const STORE_CONVERSION_RATE_BOOKINGS_TYPE = 'woocommerce-analytics/store-conversion-rate-bookings';
73
74    /**
75     * Registry actions of the dashboard package.
76     */
77    const REGISTER_SECTIONS_ACTION     = 'jetpack_premium_analytics_register_dashboard_sections';
78    const REGISTER_WIDGET_TYPES_ACTION = 'jetpack_premium_analytics_register_widget_types';
79
80    /**
81     * Text domain of the widget metadata and of the built widget bundles.
82     */
83    const TEXTDOMAIN = 'jetpack-woocommerce-stats-pkg';
84
85    /**
86     * Lowest widget contract the build works against: 2.0.0, the start of the major it is built for.
87     */
88    const MIN_WIDGET_API_VERSION = '2.0.0';
89
90    /**
91     * Widget categories the package builds but holds back from the tab for now: the bookings
92     * reports answer 500 on a store without a synced booking (WOOA7S-2287).
93     */
94    const HELD_BACK_WIDGET_CATEGORIES = array( 'bookings' );
95
96    /**
97     * Ahead of Traffic (10), so a store's dashboard opens on this tab.
98     */
99    const SECTION_ORDER = 5;
100
101    /**
102     * Widget types the tab offers in the inserter on top of its default layout: the over-time
103     * charts a store owner may prefer over Store performance.
104     */
105    const INSERTABLE_WIDGET_TYPES = array(
106        self::NET_SALES_OVER_TIME_TYPE,
107        self::TOTAL_SALES_OVER_TIME_TYPE,
108        self::GROSS_SALES_OVER_TIME_TYPE,
109        self::ORDERS_OVER_TIME_TYPE,
110        self::VISITORS_OVER_TIME_TYPE,
111    );
112
113    /**
114     * Filter through which WooCommerce detection is resolved, for hosts and tests without the plugin.
115     */
116    const WOOCOMMERCE_AVAILABLE_FILTER = 'jetpack_woocommerce_stats_woocommerce_available';
117
118    /**
119     * Widget categories that also need the WooCommerce Bookings extension.
120     */
121    const BOOKINGS_WIDGET_CATEGORIES = array( 'bookings' );
122
123    /**
124     * The module that offers the Bookings metric to Store performance.
125     */
126    const STORE_PERFORMANCE_BOOKINGS_MODULE = '@jetpack-woocommerce-stats/store-performance-bookings';
127
128    /**
129     * Action the dashboard page fires as it enqueues its scripts: its menu slug,
130     * `Analytics::MENU_PAGE_SLUG`, under wp-build's `_init` suffix.
131     */
132    const DASHBOARD_PAGE_INIT_ACTION = 'jetpack-premium-analytics-wp-admin_init';
133
134    /**
135     * Register the sync opt-in, then hook both registrants on the dashboard's registry actions, the Bookings metric on the dashboard
136     * page, the reports proxy on REST requests and its cache reset on the end of the initial sync,
137     * and the store currency on the script data.
138     *
139     * Priority 20, after the dashboard package's own registrants: an older package that still
140     * registers the section itself is found by slug and left alone.
141     *
142     * Call it before plugins_loaded completes, for the sync opt-in ({@see Sync_Configuration::register()}).
143     *
144     * @return void
145     */
146    public static function init() {
147        Sync_Configuration::register();
148
149        add_action( self::REGISTER_SECTIONS_ACTION, array( __CLASS__, 'register_section' ), 20 );
150        add_action( self::REGISTER_WIDGET_TYPES_ACTION, array( __CLASS__, 'register_widget_types' ), 20 );
151        add_action( self::DASHBOARD_PAGE_INIT_ACTION, array( __CLASS__, 'enqueue_store_performance_bookings' ) );
152
153        add_action( 'rest_api_init', array( Api_Proxy_Controller::class, 'init' ) );
154        add_action( Report_Execution\Report_Registry::REGISTER_ACTION, array( Report_Execution\Default_Reports::class, 'register' ) );
155        add_filter( 'jetpack_stats_transient_cleanup_prefixes', array( Api_Proxy_Controller::class, 'register_transient_cleanup_prefix' ) );
156        add_action( Sync_Status_Tracker::MILESTONE_ACTION, array( Api_Proxy_Controller::class, 'clear_cache' ) );
157
158        Store_Currency::init();
159    }
160
161    /**
162     * Register the WooCommerce section unless `woocommerce` or the older `store` slug is taken.
163     *
164     * @param object $registry The section registry being hydrated.
165     * @return void
166     */
167    public static function register_section( $registry ) {
168        if ( self::section_slug_is_taken( $registry ) ) {
169            return;
170        }
171
172        register_dashboard_section(
173            DASHBOARD_NAME,
174            self::SECTION_ID,
175            array(
176                'label'                   => __( 'WooCommerce', 'jetpack-woocommerce-stats-pkg' ),
177                'order'                   => self::SECTION_ORDER,
178                'is_available'            => array( __CLASS__, 'is_section_available' ),
179                // Nothing backfills historical orders to WordPress.com but the analytics full sync.
180                'requires_sync'           => true,
181                'notice'                  => array( __CLASS__, 'get_no_orders_notice' ),
182                'default_layout'          => array( __CLASS__, 'get_default_layout' ),
183                'insertable_widget_types' => self::INSERTABLE_WIDGET_TYPES,
184            )
185        );
186    }
187
188    /**
189     * The message above the tab while the store has never had an order.
190     *
191     * @return string|null The message, or null once the store has an order or without WooCommerce.
192     */
193    public static function get_no_orders_notice() {
194        if ( ! function_exists( 'wc_get_orders' ) ) {
195            return null;
196        }
197
198        // The registered statuses, so an abandoned checkout draft is not mistaken for a first order.
199        $orders = wc_get_orders(
200            array(
201                'type'   => 'shop_order',
202                'status' => array_keys( wc_get_order_statuses() ),
203                'limit'  => 1,
204                'return' => 'ids',
205            )
206        );
207
208        if ( ! empty( $orders ) ) {
209            return null;
210        }
211
212        return __( 'Your store has no orders yet. Your sales, orders and customers will show here after your first order.', 'jetpack-woocommerce-stats-pkg' );
213    }
214
215    /**
216     * The default layout of the WooCommerce tab; the inserter offers its types plus
217     * `INSERTABLE_WIDGET_TYPES`.
218     *
219     * Each group below fills one row of the dashboard grid.
220     *
221     * @return array[] Widget instances, as `get_dashboard_default_widget_instance()` builds them.
222     */
223    public static function get_default_layout() {
224        return array(
225            get_dashboard_default_widget_instance( 'default-store-performance-widget-instance', self::STORE_PERFORMANCE_TYPE, 0, 'full', 2 ),
226
227            get_dashboard_default_widget_instance( 'default-top-performing-products-widget-instance', self::TOP_PERFORMING_PRODUCTS_TYPE, 10, 1, 2 ),
228            get_dashboard_default_widget_instance( 'default-average-order-value-widget-instance', self::AVERAGE_ORDER_VALUE_TYPE, 20, 1, 2 ),
229            get_dashboard_default_widget_instance( 'default-average-items-per-order-widget-instance', self::AVERAGE_ITEMS_PER_ORDER_TYPE, 30, 1, 2 ),
230
231            get_dashboard_default_widget_instance( 'default-conversion-rate-widget-instance', self::CONVERSION_RATE_TYPE, 40, 1, 2 ),
232            get_dashboard_default_widget_instance( 'default-visitors-by-location-widget-instance', self::VISITORS_BY_LOCATION_TYPE, 50, 2, 2 ),
233
234            get_dashboard_default_widget_instance( 'default-new-vs-returning-customer-widget-instance', self::NEW_VS_RETURNING_CUSTOMER_TYPE, 60, 1, 2 ),
235            get_dashboard_default_widget_instance( 'default-revenue-by-customer-type-widget-instance', self::REVENUE_BY_CUSTOMER_TYPE_TYPE, 70, 1, 2 ),
236            get_dashboard_default_widget_instance( 'default-total-returns-widget-instance', self::TOTAL_RETURNS_TYPE, 80, 1, 2 ),
237
238            get_dashboard_default_widget_instance( 'default-sales-by-utm-channel-widget-instance', self::SALES_BY_UTM_CHANNEL_TYPE, 90, 1, 2 ),
239            get_dashboard_default_widget_instance( 'default-sales-by-utm-source-widget-instance', self::SALES_BY_UTM_SOURCE_TYPE, 100, 1, 2 ),
240            get_dashboard_default_widget_instance( 'default-sales-by-utm-campaign-widget-instance', self::SALES_BY_UTM_CAMPAIGN_TYPE, 110, 1, 2 ),
241
242            get_dashboard_default_widget_instance( 'default-orders-fulfillment-widget-instance', self::ORDERS_FULFILLMENT_TYPE, 120, 1, 2 ),
243            get_dashboard_default_widget_instance( 'default-sales-by-coupon-widget-instance', self::SALES_BY_COUPON_TYPE, 130, 1, 2 ),
244            get_dashboard_default_widget_instance( 'default-coupon-usage-over-time-widget-instance', self::COUPON_USAGE_OVER_TIME_TYPE, 140, 1, 2 ),
245
246            get_dashboard_default_widget_instance( 'default-payment-status-widget-instance', self::PAYMENT_STATUS_TYPE, 150, 1, 2 ),
247            get_dashboard_default_widget_instance( 'default-sessions-by-device-widget-instance', self::SESSIONS_BY_DEVICE_TYPE, 160, 1, 2 ),
248            get_dashboard_default_widget_instance( 'default-sales-by-device-widget-instance', self::SALES_BY_DEVICE_TYPE, 170, 1, 2 ),
249        );
250    }
251
252    /**
253     * Load the Bookings metric with the dashboard on a store running the Bookings extension.
254     *
255     * Enqueued as a module of its own: the page's boot runs only the init modules its build names,
256     * and a boot dependency is preloaded, not run. The build's own registrant hooks
257     * `wp_default_scripts`, already fired on this page hook, so it runs here.
258     *
259     * @return void
260     */
261    public static function enqueue_store_performance_bookings() {
262        if ( ! self::is_bookings_plugin_active() || ! self::supports_widget_contract() || ! self::is_woocommerce_available() || ! self::current_user_can_view_store_reports() ) {
263            return;
264        }
265
266        self::load_build();
267        if ( ! function_exists( 'jetpack_woocommerce_stats_register_script_modules' ) ) {
268            return;
269        }
270        jetpack_woocommerce_stats_register_script_modules();
271
272        wp_enqueue_script_module( self::STORE_PERFORMANCE_BOOKINGS_MODULE );
273    }
274
275    /**
276     * The manifest minus the categories held back from the tab and the bookings categories
277     * without their extension.
278     *
279     * @param array[] $widget_modules     Widget module records of the build manifest.
280     * @param bool    $bookings_available Whether the WooCommerce Bookings extension is active.
281     * @return array[] The records the package registers.
282     */
283    private static function remove_unavailable_widget_types( $widget_modules, $bookings_available ) {
284        return array_values(
285            array_filter(
286                $widget_modules,
287                static function ( $widget_module ) use ( $bookings_available ) {
288                    $category = $widget_module['category'] ?? '';
289
290                    if ( in_array( $category, self::HELD_BACK_WIDGET_CATEGORIES, true ) ) {
291                        return false;
292                    }
293
294                    return $bookings_available || ! in_array( $category, self::BOOKINGS_WIDGET_CATEGORIES, true );
295                }
296            )
297        );
298    }
299
300    /**
301     * Register the widget types from the package's build manifest.
302     *
303     * Loads the generated build first: after `init` it registers the widget script modules on the
304     * spot, so they reach the page import map the same request.
305     *
306     * Registers nothing without WooCommerce or for a reader who cannot see store reports: the types
307     * would only collect 403s from the proxy.
308     *
309     * @param object $registry The widget type registry being hydrated.
310     * @return void
311     */
312    public static function register_widget_types( $registry ) {
313        if ( ! self::supports_widget_contract() || ! self::is_woocommerce_available() || ! self::current_user_can_view_store_reports() ) {
314            return;
315        }
316
317        self::load_build();
318        if ( ! function_exists( 'jetpack_woocommerce_stats_get_registered_widget_modules' ) ) {
319            return;
320        }
321
322        register_widget_types_from_manifest(
323            self::remove_unavailable_widget_types( jetpack_woocommerce_stats_get_registered_widget_modules(), self::is_bookings_plugin_active() ),
324            array(
325                'textdomain'    => self::TEXTDOMAIN,
326                'i18n_manifest' => add_query_arg( 'ver', self::PACKAGE_VERSION, plugins_url( 'i18n-manifest.json', self::build_dir() . '/build.php' ) ),
327            ),
328            $registry
329        );
330    }
331
332    /**
333     * Whether the WooCommerce tab is available: WooCommerce is active and the reader may see store
334     * reports.
335     *
336     * @return bool
337     */
338    public static function is_section_available() {
339        return self::is_woocommerce_available() && self::current_user_can_view_store_reports();
340    }
341
342    /**
343     * Whether WooCommerce is active.
344     *
345     * @return bool
346     */
347    public static function is_woocommerce_available() {
348        $is_available = class_exists( 'WooCommerce' ) || function_exists( 'WC' );
349
350        /**
351         * Filters whether WooCommerce was detected.
352         *
353         * @since 0.2.0
354         *
355         * @param bool $is_available Whether WooCommerce was detected in the current request.
356         */
357        return (bool) apply_filters( self::WOOCOMMERCE_AVAILABLE_FILTER, $is_available );
358    }
359
360    /**
361     * Whether the current user may read the store reports, the rule the reports proxy enforces.
362     *
363     * @return bool
364     */
365    public static function current_user_can_view_store_reports() {
366        // phpcs:ignore WordPress.WP.Capabilities.Unknown -- WooCommerce registers this capability.
367        return current_user_can( 'manage_options' ) || current_user_can( 'view_woocommerce_reports' );
368    }
369
370    /**
371     * Whether the WooCommerce Bookings extension is active; `is_plugin_active()` only exists in
372     * admin contexts, hence the guard.
373     *
374     * @return bool
375     */
376    private static function is_bookings_plugin_active() {
377        return class_exists( 'WC_Bookings' )
378            || ( function_exists( 'is_plugin_active' ) && \is_plugin_active( 'woocommerce-bookings/woocommerce-bookings.php' ) );
379    }
380
381    /**
382     * Whether the dashboard's widget contract is one the widgets were built against.
383     *
384     * On an older contract the SDK module lacks a name the widgets import, and they fail to load.
385     *
386     * @return bool
387     */
388    private static function supports_widget_contract() {
389        // The dashboard loads the file naming its contract when its widget registry is first read,
390        // which has not happened yet when the dashboard page enqueues its scripts.
391        if (
392            ! defined( 'Automattic\\Jetpack\\PremiumAnalytics\\WIDGET_API_VERSION' )
393            && function_exists( 'Automattic\\Jetpack\\PremiumAnalytics\\ensure_widget_registry_ready' )
394        ) {
395            \Automattic\Jetpack\PremiumAnalytics\ensure_widget_registry_ready();
396        }
397
398        if ( ! defined( 'Automattic\\Jetpack\\PremiumAnalytics\\WIDGET_API_VERSION' ) ) {
399            return false;
400        }
401
402        $version = \Automattic\Jetpack\PremiumAnalytics\WIDGET_API_VERSION;
403
404        return version_compare( $version, self::MIN_WIDGET_API_VERSION, '>=' ) && version_compare( $version, '3', '<' );
405    }
406
407    /**
408     * Load the generated build once. Guarded by symbol, not by path: two copies of the package
409     * can share a request.
410     *
411     * @return void
412     */
413    private static function load_build() {
414        if ( function_exists( 'jetpack_woocommerce_stats_get_registered_widget_modules' ) ) {
415            return;
416        }
417        $loader = self::build_dir() . '/build.php';
418        if ( file_exists( $loader ) ) {
419            require_once $loader;
420        }
421    }
422
423    /**
424     * Directory of the wp-build output.
425     *
426     * @return string
427     */
428    private static function build_dir() {
429        return dirname( __DIR__ ) . '/build';
430    }
431
432    /**
433     * Whether this tab's slug, or the `store` slug an older package still registers, is taken.
434     *
435     * @param object $registry The section registry being hydrated.
436     * @return bool
437     */
438    private static function section_slug_is_taken( $registry ) {
439        foreach ( array( 'woocommerce', 'store' ) as $slug ) {
440            if ( self::dashboard_has_section_slug( $registry, DASHBOARD_NAME, $slug ) ) {
441                return true;
442            }
443        }
444
445        return false;
446    }
447
448    /**
449     * Whether a section with the slug is registered on the dashboard.
450     *
451     * Reads the registry through the slug lookup when the package offers it, and through the full
452     * list otherwise: the package and this one ship on different cadences.
453     *
454     * @param object $registry       The registry being hydrated.
455     * @param string $dashboard_name Dashboard identifier.
456     * @param string $slug           Section slug.
457     * @return bool
458     */
459    private static function dashboard_has_section_slug( $registry, $dashboard_name, $slug ) {
460        if ( method_exists( $registry, 'get_registered_by_slug' ) ) {
461            return null !== $registry->get_registered_by_slug( $dashboard_name, $slug );
462        }
463
464        foreach ( $registry->get_all_registered( $dashboard_name ) as $section ) {
465            if ( $section->slug === $slug ) {
466                return true;
467            }
468        }
469
470        return false;
471    }
472}