Admin
2 months ago
Assets
2 weeks ago
CLI
2 years ago
Cache
2 weeks ago
Pages
10 months ago
PostTypes
2 months ago
Posts
1 year ago
Shortcodes
1 month ago
Taxonomies
1 year ago
Templates
1 year ago
Users
2 months ago
ActionsService.php
3 years ago
CompatibilityService.php
4 months ago
CurrencyService.php
4 months ago
GoogleMapApiService.php
2 months ago
HealthService.php
2 months ago
LineItemStateService.php
2 years ago
PluginActionLinksService.php
1 year ago
PluginService.php
1 year ago
PluginServiceProvider.php
1 year ago
RecaptchaValidationService.php
2 years ago
StateService.php
7 months ago
ThemeService.php
4 months ago
ThemeServiceProvider.php
7 months ago
TranslationsServiceProvider.php
3 months ago
UpgradeNoticeService.php
1 year ago
HealthService.php
209 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\WordPress; |
| 4 | |
| 5 | use SureCart\Models\Account; |
| 6 | use SureCart\Models\ApiToken; |
| 7 | use SureCart\Models\IncomingWebhook; |
| 8 | use SureCart\Models\RegisteredWebhook; |
| 9 | use SureCart\Support\Server; |
| 10 | |
| 11 | class HealthService { |
| 12 | /** |
| 13 | * Bootstrap the service. |
| 14 | * |
| 15 | * @return void |
| 16 | */ |
| 17 | public function bootstrap() { |
| 18 | add_filter( 'debug_information', [ $this, 'debugInfo' ] ); |
| 19 | add_filter( 'site_status_tests', [ $this, 'tests' ] ); |
| 20 | } |
| 21 | |
| 22 | /** |
| 23 | * Add debug information. |
| 24 | * |
| 25 | * @param array $debug_info Debug List. |
| 26 | * |
| 27 | * @return array |
| 28 | */ |
| 29 | public function debugInfo( $debug_info ) { |
| 30 | $total_failed = IncomingWebhook::whereNull( 'processed_at' )->andWhere( 'created_at', '<', ( new \DateTime() )->modify( '-30 minutes' )->format( 'Y-m-d H:i:s' ) )->count(); |
| 31 | $debug_info['surecart'] = array( |
| 32 | 'label' => __( 'SureCart', 'surecart' ), |
| 33 | 'fields' => array( |
| 34 | 'api' => array( |
| 35 | 'label' => __( 'API Connectivity', 'surecart' ), |
| 36 | 'value' => (bool) ApiToken::get() ? __( 'Connected', 'surecart' ) : __( 'Not connected', 'surecart' ), |
| 37 | 'private' => false, |
| 38 | ), |
| 39 | 'store_id' => array( |
| 40 | 'label' => __( 'Store ID', 'surecart' ), |
| 41 | 'value' => \SureCart::account()->id, |
| 42 | 'private' => false, |
| 43 | ), |
| 44 | 'url' => array( |
| 45 | 'label' => __( 'Store URL', 'surecart' ), |
| 46 | 'value' => \SureCart::account()->url, |
| 47 | 'private' => false, |
| 48 | ), |
| 49 | 'webhook_url' => array( |
| 50 | 'label' => __( 'Registered Webhook URL', 'surecart' ), |
| 51 | 'value' => RegisteredWebhook::registration()->get()->url ?? __( 'Not registered', 'surecart' ), |
| 52 | 'private' => false, |
| 53 | ), |
| 54 | 'webhooks_processing' => array( |
| 55 | 'label' => __( 'Webhooks Processing', 'surecart' ), |
| 56 | // translators: %d is the number of unprocessed webhooks. |
| 57 | 'value' => ! empty( $total_failed ) ? sprintf( __( '%d Unprocessed webhooks', 'surecart' ), $total_failed ) : __( 'Working', 'surecart' ), |
| 58 | 'private' => false, |
| 59 | ), |
| 60 | 'encryption_key' => array( |
| 61 | 'label' => __( 'Encryption Key', 'surecart' ), |
| 62 | 'value' => defined( 'SURECART_ENCRYPTION_KEY' ) ? __( 'Defined', 'surecart' ) : __( 'Not defined', 'surecart' ), |
| 63 | 'private' => false, |
| 64 | ), |
| 65 | 'number_formatter' => array( |
| 66 | 'label' => __( 'Number Formatter', 'surecart' ), |
| 67 | 'value' => class_exists( 'NumberFormatter' ) ? __( 'Defined', 'surecart' ) : __( 'Not defined', 'surecart' ), |
| 68 | 'private' => false, |
| 69 | ), |
| 70 | ), |
| 71 | ); |
| 72 | return $debug_info; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Register tests for the Status Page |
| 77 | * |
| 78 | * @param array $tests List of tests. |
| 79 | * |
| 80 | * @return array |
| 81 | */ |
| 82 | public function tests( $tests ) { |
| 83 | $tests['async']['surecart_api_test'] = array( |
| 84 | 'label' => __( 'SureCart', 'surecart' ) . ' ' . __( 'API connectivity', 'surecart' ), |
| 85 | 'test' => rest_url( 'surecart/v1/site-health/api-connectivity' ), |
| 86 | 'has_rest' => true, |
| 87 | 'async_direct_test' => [ $this, 'apiTest' ], |
| 88 | ); |
| 89 | |
| 90 | $is_localhost = ( new Server( get_home_url() ) )->isLocalHost(); |
| 91 | if ( ! $is_localhost ) { |
| 92 | $tests['direct']['surecart_webhook_test'] = array( |
| 93 | 'label' => __( 'SureCart', 'surecart' ) . ' ' . __( 'Webhooks Processing', 'surecart' ), |
| 94 | 'test' => [ $this, 'webhooksProcessingTest' ], |
| 95 | ); |
| 96 | $tests['async']['surecart_webhooks_test'] = array( |
| 97 | 'label' => __( 'SureCart', 'surecart' ) . ' ' . __( 'Webhooks Connection', 'surecart' ), |
| 98 | 'test' => rest_url( 'surecart/v1/site-health/webhooks' ), |
| 99 | 'has_rest' => true, |
| 100 | 'async_direct_test' => [ $this, 'webhooksTest' ], |
| 101 | ); |
| 102 | } |
| 103 | |
| 104 | return $tests; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Neve API test pretty response |
| 109 | * |
| 110 | * @return array |
| 111 | */ |
| 112 | public function apiTest() { |
| 113 | $account = Account::find(); |
| 114 | |
| 115 | return array( |
| 116 | 'label' => __( 'SureCart', 'surecart' ) . ' ' . __( 'API connectivity', 'surecart' ), |
| 117 | 'status' => ! empty( $account->id ) ? 'good' : 'critical', |
| 118 | 'badge' => array( |
| 119 | 'label' => __( 'SureCart', 'surecart' ), |
| 120 | 'color' => ! empty( $account->id ) ? 'blue' : 'red', |
| 121 | ), |
| 122 | 'description' => sprintf( |
| 123 | '<p>%s</p>', |
| 124 | ! empty( $account->id ) ? __( 'The SureCart API is reachable.', 'surecart' ) : __( 'The SureCart API is not reachable.', 'surecart' ) |
| 125 | ), |
| 126 | 'actions' => '', |
| 127 | 'test' => 'surecart_api_test', |
| 128 | ); |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Check that webhooks are processing normally. |
| 133 | * |
| 134 | * @return array |
| 135 | */ |
| 136 | public function webhooksProcessingTest() { |
| 137 | $total_failed = IncomingWebhook::whereNull( 'processed_at' )->andWhere( 'created_at', '<', ( new \DateTime() )->modify( '-30 minutes' )->format( 'Y-m-d H:i:s' ) )->count(); |
| 138 | $has_errors = ! empty( $total_failed ); |
| 139 | |
| 140 | return array( |
| 141 | 'label' => $has_errors ? __( 'SureCart Webhooks Processing Error', 'surecart' ) : __( 'SureCart Webhooks Processing', 'surecart' ), |
| 142 | 'status' => $has_errors ? 'critical' : 'good', |
| 143 | 'badge' => array( |
| 144 | 'label' => __( 'SureCart', 'surecart' ), |
| 145 | 'color' => $has_errors ? 'red' : 'blue', |
| 146 | ), |
| 147 | 'description' => sprintf( |
| 148 | '<p>%s</p>', |
| 149 | // translators: %d is the number of failed webhooks. |
| 150 | $has_errors ? sprintf( __( '%d of your webhooks failed to process on your site. Please check your error logs to make sure errors did not occur in webhook processing.', 'surecart' ), (int) $total_failed ) : __( 'Webhook processing is working normally.', 'surecart' ) |
| 151 | ), |
| 152 | 'actions' => $has_errors ? sprintf( |
| 153 | '<a href="%s" class="button" target="_blank">%s</a>', |
| 154 | esc_url( admin_url( 'admin.php?page=sc-settings&tab=connection' ) ), |
| 155 | __( 'Troubleshoot Connection', 'surecart' ) |
| 156 | ) : '', |
| 157 | 'test' => 'surecart_webhooks_processing_test', |
| 158 | ); |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Neve API test pretty response |
| 163 | * |
| 164 | * @return array |
| 165 | */ |
| 166 | public function webhooksTest() { |
| 167 | // clear account cache. |
| 168 | \SureCart::account()->clearCache(); |
| 169 | |
| 170 | $webhook = RegisteredWebhook::get(); |
| 171 | |
| 172 | // Defaults. |
| 173 | $description = __( 'Webhooks are working normally.', 'surecart' ); |
| 174 | $label = __( 'SureCart', 'surecart' ) . ' ' . __( 'Webhooks', 'surecart' ); |
| 175 | $status = 'good'; |
| 176 | |
| 177 | if ( empty( $webhook->enabled ) ) { |
| 178 | $status = 'critical'; |
| 179 | $label = __( 'SureCart', 'surecart' ) . ' ' . __( 'webhook is disabled.', 'surecart' ); |
| 180 | $description = __( 'The SureCart webhook is currently disabled which can cause issues with integrations. This can happen automatically due to repeated errors, or could have been disabled manually. Please re-enable the webhook and troubleshoot the issue if integrations are important to your store.', 'surecart' ); |
| 181 | } elseif ( ! empty( $webhook->erroring_grace_period_ends_at ) ) { |
| 182 | $status = 'critical'; |
| 183 | $label = __( 'SureCart', 'surecart' ) . ' ' . __( 'webhook connection is being monitored for errors.', 'surecart' ); |
| 184 | $description = __( 'The SureCart webhook has received repeated errors.', 'surecart' ); |
| 185 | $description .= ' ' . $webhook->erroring_grace_period_ends_at > time() ? sprintf( wp_kses( 'These errors will automatically attempt to be retried, however, we will disable this in <strong>%s</strong> if it continues to fail.', 'surecart' ), human_time_diff( $webhook->erroring_grace_period_ends_at ) ) : sprintf( wp_kses( 'It was automatically disabled %s ago.', 'surecart' ), human_time_diff( $webhook->erroring_grace_period_ends_at ) ); |
| 186 | $description .= ' ' . __( 'Please troubleshoot the issue if integrations are important to your store.', 'surecart' ); |
| 187 | } |
| 188 | |
| 189 | return array( |
| 190 | 'label' => $label, |
| 191 | 'status' => $status, |
| 192 | 'badge' => array( |
| 193 | 'label' => __( 'SureCart', 'surecart' ), |
| 194 | 'color' => 'critical' === $status ? 'red' : 'blue', |
| 195 | ), |
| 196 | 'description' => sprintf( |
| 197 | '<p>%s</p>', |
| 198 | $description |
| 199 | ), |
| 200 | 'actions' => 'critical' === $status ? sprintf( |
| 201 | '<a href="%s" class="button" target="_blank">%s</a>', |
| 202 | esc_url( untrailingslashit( SURECART_APP_URL ) . '/developer?switch_account_id=' . \SureCart::account()->id ), |
| 203 | __( 'Troubleshoot Connection', 'surecart' ) |
| 204 | ) : '', |
| 205 | 'test' => 'surecart_webhooks_test', |
| 206 | ); |
| 207 | } |
| 208 | } |
| 209 |