PluginProbe
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO / 2.2.0
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO v2.2.0
2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.1.0 2.0.2 2.0.1 2.0.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 trunk 1.0.0 1.0.1 1.0.2 1.1.0 1.10.0 All 48 releases
thinkrank / includes / integrations / class-google-pagespeed-client.php

class-google-pagespeed-client.php in ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO 2.2.0, at includes/integrations/class-google-pagespeed-client.php

533 lines 21.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Google PageSpeed Insights Client Class
4 *
5 * Handles communication with Google PageSpeed Insights API for Core Web Vitals
6 * and performance data retrieval. Extends the base Google API client with
7 * PageSpeed-specific functionality and rate limiting.
8 *
9 * @package ThinkRank\Integrations
10 * @since 1.0.0
11 */
12
13 declare(strict_types=1);
14
15 namespace ThinkRank\Integrations;
16
17 // Prevent direct access
18 if (!defined('ABSPATH')) {
19 exit;
20 }
21
22 /**
23 * Google PageSpeed Insights Client Class
24 *
25 * Single Responsibility: Handle PageSpeed Insights API communication
26 * Following ThinkRank HTTP client patterns from Claude_Client and OpenAI_Client
27 *
28 * @since 1.0.0
29 */
30 class Google_PageSpeed_Client extends Google_API_Base_Client {
31
32 /**
33 * PageSpeed Insights API base URL
34 */
35 private const API_BASE_URL = 'https://www.googleapis.com/pagespeedonline/v5';
36
37 /**
38 * Rate limit transient key prefix
39 * Following ThinkRank option naming patterns
40 */
41 private const RATE_LIMIT_KEY = 'thinkrank_pagespeed_rate_limit';
42
43 /**
44 * Maximum requests per day (Google free tier limit)
45 */
46 private const MAX_REQUESTS_PER_DAY = 25000;
47
48 /**
49 * How long a parsed PageSpeed snapshot is reused before a new live run (seconds)
50 */
51 private const SNAPSHOT_TTL = 600;
52
53 /**
54 * How long a failed PageSpeed run is remembered before retrying (seconds)
55 *
56 * Lighthouse runs are slow (10-60s); without this, a failing URL (e.g. a
57 * non-public localhost) would block every admin request for the full HTTP
58 * timeout.
59 */
60 private const FAILURE_TTL = 300;
61
62 /**
63 * Exception code marking a rethrown remembered failure rather than a live
64 * API error, so callers can report "try again shortly" instead of implying
65 * the request was actually attempted.
66 */
67 public const CODE_REMEMBERED_FAILURE = 9001;
68
69 /**
70 * Per-request memo of parsed snapshots, keyed by url|strategy
71 *
72 * @var array<string,array>
73 */
74 private static array $snapshot_memo = [];
75
76 /**
77 * Default HTTP timeout for PageSpeed runs (seconds).
78 *
79 * Real Lighthouse runs routinely take 15-45s; the previous 20s timeout
80 * aborted a large share of otherwise-successful runs.
81 */
82 public const DEFAULT_TIMEOUT = 45;
83
84 /**
85 * Build a client authenticated the way the PageSpeed API expects.
86 *
87 * Auth order (RankMath uses the same model, minus the key):
88 * 1. Site-owned API key — dedicated per-project quota, always reliable.
89 * 2. The user's Google OAuth token — works at low volume; quota is
90 * shared across the OAuth project, so ThinkRank must stay frugal
91 * (see the 7-day refresh gate in Performance_Data_Collector).
92 * 3. Keyless — Google's shared anonymous pool; last resort.
93 *
94 * @param int|null $timeout HTTP timeout in seconds (default self::DEFAULT_TIMEOUT)
95 * @return self
96 */
97 public static function for_site(?int $timeout = null): self {
98 $api_key = '';
99 $access_token = '';
100 if (class_exists('\\ThinkRank\\Core\\Settings')) {
101 $settings = new \ThinkRank\Core\Settings();
102 $api_key = (string) $settings->get('google_pagespeed_api_key', '');
103 $access_token = (string) $settings->get('google_access_token', '');
104 }
105
106 if ($api_key !== '') {
107 // A dedicated key wins: pass no token so quota bills the key's project.
108 return new self($api_key, $timeout ?? self::DEFAULT_TIMEOUT, null);
109 }
110
111 return new self('', $timeout ?? self::DEFAULT_TIMEOUT, $access_token !== '' ? $access_token : null);
112 }
113
114 /**
115 * Whether the site holds a credential the PageSpeed API will accept.
116 *
117 * The counterpart to for_site(): either of the first two rungs of its auth
118 * order is enough, and a caller that wants to refuse the keyless third rung
119 * asks this rather than testing one credential itself. Callers that did the
120 * latter locked out every site configured with only an API key — the
121 * credential for_site() actually *prefers*, since a dedicated key bills its
122 * own project quota (#519).
123 *
124 * @since 2.1.1
125 *
126 * @return bool True when an API key or an OAuth token is configured.
127 */
128 public static function site_has_credentials(): bool {
129 if (!class_exists('\\ThinkRank\\Core\\Settings')) {
130 return false;
131 }
132
133 $settings = new \ThinkRank\Core\Settings();
134
135 // OAuth tokens are encrypted at rest; Settings::get() decrypts them.
136 return '' !== trim((string) $settings->get('google_pagespeed_api_key', ''))
137 || '' !== trim((string) $settings->get('google_access_token', ''));
138 }
139
140 /**
141 * Run PageSpeed test for a URL
142 *
143 * @param string $url URL to test
144 * @param string $strategy Device strategy ('mobile' or 'desktop')
145 * @param array $categories Categories to test (default: ['performance'])
146 * @return array PageSpeed test results
147 * @throws \Exception If API request fails
148 */
149 public function run_pagespeed_test(string $url, string $strategy = 'mobile', array $categories = ['performance']): array {
150 $endpoint = '/runPagespeed';
151 $params = [
152 'url' => $url,
153 'strategy' => $strategy,
154 // http_build_query would serialize an array as category[0]=…,
155 // which the PSI API ignores; a single category must be a scalar.
156 'category' => count($categories) === 1 ? $categories[0] : $categories,
157 ];
158
159 $full_url = self::API_BASE_URL . $endpoint;
160 return $this->make_request($full_url, $params, 'GET');
161 }
162
163 /**
164 * Get a parsed PageSpeed snapshot for a URL, from cache when possible.
165 *
166 * One live Lighthouse run produces Core Web Vitals, opportunities,
167 * diagnostics and the performance score together; callers that previously
168 * triggered separate runs for each now share a single cached result.
169 * Failures are remembered briefly (FAILURE_TTL) so a broken URL doesn't
170 * re-block every request for the full HTTP timeout.
171 *
172 * @param string $url URL to analyze
173 * @param string $strategy Device strategy ('mobile' or 'desktop')
174 * @return array{core_web_vitals:array,opportunities:array,diagnostics:array,performance_score:float,fetched_at:int}
175 * @throws \Exception If the API request fails (including remembered recent failures)
176 */
177 public function get_pagespeed_snapshot(string $url, string $strategy = 'mobile', bool $fresh = false): array {
178 $memo_key = $url . '|' . $strategy;
179 $hash = md5($memo_key);
180
181 // A user-initiated refresh must actually re-measure. The 7-day gate in
182 // Performance_Data_Collector was the only thing $force skipped, so a
183 // manual retry within FAILURE_TTL of any failure re-threw the remembered
184 // message in milliseconds without contacting Google — which made
185 // "refresh" useless for exactly the case people press it in, right after
186 // seeing an error.
187 if ($fresh) {
188 unset(self::$snapshot_memo[$memo_key]);
189 delete_transient('thinkrank_psi_snapshot_' . $hash);
190 delete_transient('thinkrank_psi_failure_' . $hash);
191 }
192
193 if (isset(self::$snapshot_memo[$memo_key])) {
194 return self::$snapshot_memo[$memo_key];
195 }
196
197 $cached = get_transient('thinkrank_psi_snapshot_' . $hash);
198 if (is_array($cached)) {
199 self::$snapshot_memo[$memo_key] = $cached;
200 return $cached;
201 }
202
203 $recent_failure = get_transient('thinkrank_psi_failure_' . $hash);
204 if (is_string($recent_failure) && $recent_failure !== '') {
205 throw new \Exception($recent_failure, self::CODE_REMEMBERED_FAILURE); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
206 }
207
208 try {
209 $result = $this->run_pagespeed_test($url, $strategy, ['performance']);
210 } catch (\Exception $e) {
211 set_transient('thinkrank_psi_failure_' . $hash, $e->getMessage(), self::FAILURE_TTL);
212 throw $e;
213 }
214
215 $snapshot = [
216 'core_web_vitals' => $this->parse_core_web_vitals($result),
217 'opportunities' => $this->parse_opportunities($result),
218 'diagnostics' => $this->parse_diagnostics($result),
219 'performance_score' => (float) (($result['lighthouseResult']['categories']['performance']['score'] ?? 0) * 100),
220 'loading_experience' => $result['loadingExperience'] ?? [],
221 'fetched_at' => time(),
222 ];
223
224 set_transient('thinkrank_psi_snapshot_' . $hash, $snapshot, self::SNAPSHOT_TTL);
225 self::$snapshot_memo[$memo_key] = $snapshot;
226
227 return $snapshot;
228 }
229
230 /**
231 * Test API connection
232 * Following ThinkRank test_connection patterns from AI clients
233 *
234 * @return array Connection test results
235 */
236 public function test_connection(): array {
237 try {
238 $test_url = home_url();
239 $result = $this->run_pagespeed_test($test_url, 'mobile', ['performance']);
240
241 $performance_score = 0;
242 if (isset($result['lighthouseResult']['categories']['performance']['score'])) {
243 $performance_score = $result['lighthouseResult']['categories']['performance']['score'] * 100;
244 }
245
246 return [
247 'success' => true,
248 'message' => 'PageSpeed Insights API connection successful',
249 'test_url' => $test_url,
250 'performance_score' => $performance_score
251 ];
252 } catch (\Exception $e) {
253 return [
254 'success' => false,
255 'error' => $e->getMessage()
256 ];
257 }
258 }
259
260 /**
261 * Get Core Web Vitals data for a URL
262 *
263 * @param string $url URL to analyze
264 * @param string $strategy Device strategy ('mobile' or 'desktop')
265 * @return array Core Web Vitals data
266 * @throws \Exception If API request fails
267 */
268 public function get_core_web_vitals(string $url, string $strategy = 'mobile'): array {
269 return $this->get_pagespeed_snapshot($url, $strategy)['core_web_vitals'];
270 }
271
272 /**
273 * Get performance opportunities for a URL
274 *
275 * @param string $url URL to test
276 * @param string $strategy Testing strategy (mobile/desktop)
277 * @return array Performance opportunities
278 * @throws \Exception If API request fails
279 */
280 public function get_opportunities(string $url, string $strategy = 'mobile'): array {
281 return $this->get_pagespeed_snapshot($url, $strategy)['opportunities'];
282 }
283
284 /**
285 * Get diagnostic information for a URL
286 *
287 * @param string $url URL to test
288 * @param string $strategy Testing strategy (mobile/desktop)
289 * @return array Diagnostic information
290 * @throws \Exception If API request fails
291 */
292 public function get_diagnostics(string $url, string $strategy = 'mobile'): array {
293 return $this->get_pagespeed_snapshot($url, $strategy)['diagnostics'];
294 }
295
296 /**
297 * Parse Core Web Vitals from PageSpeed response
298 *
299 * @param array $pagespeed_data Raw PageSpeed API response
300 * @return array Parsed Core Web Vitals data
301 */
302 private function parse_core_web_vitals(array $pagespeed_data): array {
303 $audits = $pagespeed_data['lighthouseResult']['audits'] ?? [];
304
305 return [
306 'lcp' => [
307 'name' => 'Largest Contentful Paint',
308 'value' => round((($audits['largest-contentful-paint']['numericValue'] ?? 0) / 1000), 4),
309 'score' => ($audits['largest-contentful-paint']['score'] ?? 0) * 100,
310 'unit' => 's',
311 'good_threshold' => 2.5,
312 'needs_improvement_threshold' => 4.0,
313 'description' => 'Time until the largest content element is rendered'
314 ],
315 // INP replaced FID as a Core Web Vital in March 2024. INP is a field
316 // metric — a standard PSI navigation run has no interaction to
317 // measure — so Lighthouse only reports it in timespan mode. Read that
318 // audit when it is present and otherwise fall back to Total Blocking
319 // Time, which is Google's documented lab proxy for INP. Real INP
320 // comes from the CrUX field data in Performance_Monitoring_Manager.
321 'inp' => [
322 'name' => 'Interaction to Next Paint',
323 'value' => round(
324 $audits['interaction-to-next-paint']['numericValue']
325 ?? $audits['total-blocking-time']['numericValue']
326 ?? 0,
327 4
328 ),
329 'score' => (
330 $audits['interaction-to-next-paint']['score']
331 ?? $audits['total-blocking-time']['score']
332 ?? 0
333 ) * 100,
334 'unit' => 'ms',
335 'good_threshold' => 200,
336 'needs_improvement_threshold' => 500,
337 'description' => 'Responsiveness across all interactions on the page',
338 'is_lab_proxy' => !isset($audits['interaction-to-next-paint'])
339 ],
340 'cls' => [
341 'name' => 'Cumulative Layout Shift',
342 'value' => round(($audits['cumulative-layout-shift']['numericValue'] ?? 0), 4),
343 'score' => ($audits['cumulative-layout-shift']['score'] ?? 0) * 100,
344 'unit' => '',
345 'good_threshold' => 0.1,
346 'needs_improvement_threshold' => 0.25,
347 'description' => 'Measure of visual stability during page load'
348 ],
349 'fcp' => [
350 'name' => 'First Contentful Paint',
351 'value' => round((($audits['first-contentful-paint']['numericValue'] ?? 0) / 1000), 4),
352 'score' => ($audits['first-contentful-paint']['score'] ?? 0) * 100,
353 'unit' => 's',
354 'good_threshold' => 1.8,
355 'needs_improvement_threshold' => 3.0,
356 'description' => 'Time until the first content is painted on screen'
357 ]
358 ];
359 }
360
361 /**
362 * Parse performance opportunities from PageSpeed data
363 *
364 * @param array $pagespeed_data Raw PageSpeed API response
365 * @return array Parsed opportunities data
366 */
367 private function parse_opportunities(array $pagespeed_data): array {
368 $audits = $pagespeed_data['lighthouseResult']['audits'] ?? [];
369 $opportunities = [];
370
371 // Define opportunity audits that provide savings estimates
372 $opportunity_audits = [
373 'render-blocking-resources' => 'Eliminate render-blocking resources',
374 'unused-css-rules' => 'Remove unused CSS',
375 'unused-javascript' => 'Remove unused JavaScript',
376 'modern-image-formats' => 'Serve images in next-gen formats',
377 'offscreen-images' => 'Defer offscreen images',
378 'unminified-css' => 'Minify CSS',
379 'unminified-javascript' => 'Minify JavaScript',
380 'efficient-animated-content' => 'Use video formats for animated content',
381 'duplicated-javascript' => 'Remove duplicate modules in JavaScript bundles',
382 'legacy-javascript' => 'Avoid serving legacy JavaScript to modern browsers'
383 ];
384
385 foreach ($opportunity_audits as $audit_id => $title) {
386 if (isset($audits[$audit_id]) && isset($audits[$audit_id]['details'])) {
387 $audit = $audits[$audit_id];
388 $savings = $audit['details']['overallSavingsMs'] ?? 0;
389
390 if ($savings > 0) {
391 $opportunities[] = [
392 'id' => $audit_id,
393 'title' => $title,
394 'description' => $audit['description'] ?? '',
395 'estimated_savings' => $savings,
396 'score' => ($audit['score'] ?? 0) * 100,
397 'details' => $audit['details'] ?? [],
398 'difficulty' => $this->get_difficulty_level($audit_id)
399 ];
400 }
401 }
402 }
403
404 // Sort by estimated savings (highest first)
405 usort($opportunities, function($a, $b) {
406 return $b['estimated_savings'] - $a['estimated_savings'];
407 });
408
409 return $opportunities;
410 }
411
412 /**
413 * Parse diagnostic information from PageSpeed data
414 *
415 * @param array $pagespeed_data Raw PageSpeed API response
416 * @return array Parsed diagnostics data
417 */
418 private function parse_diagnostics(array $pagespeed_data): array {
419 $audits = $pagespeed_data['lighthouseResult']['audits'] ?? [];
420 $diagnostics = [];
421
422 // Define diagnostic audits
423 $diagnostic_audits = [
424 'first-contentful-paint' => ['title' => 'First Contentful Paint', 'impact' => 'Performance'],
425 'largest-contentful-paint' => ['title' => 'Largest Contentful Paint', 'impact' => 'LCP'],
426 'first-meaningful-paint' => ['title' => 'First Meaningful Paint', 'impact' => 'Performance'],
427 'speed-index' => ['title' => 'Speed Index', 'impact' => 'Performance'],
428 'total-blocking-time' => ['title' => 'Total Blocking Time', 'impact' => 'INP'],
429 'cumulative-layout-shift' => ['title' => 'Cumulative Layout Shift', 'impact' => 'CLS'],
430 'server-response-time' => ['title' => 'Initial server response time was short', 'impact' => 'Performance'],
431 'interactive' => ['title' => 'Time to Interactive', 'impact' => 'Performance'],
432 'user-timings' => ['title' => 'User Timing marks and measures', 'impact' => 'Performance'],
433 'critical-request-chains' => ['title' => 'Avoid chaining critical requests', 'impact' => 'Performance'],
434 'redirects' => ['title' => 'Avoid multiple page redirects', 'impact' => 'Performance'],
435 'installable-manifest' => ['title' => 'Web app manifest meets the installability requirements', 'impact' => 'PWA'],
436 'apple-touch-icon' => ['title' => 'Provides a valid apple-touch-icon', 'impact' => 'PWA'],
437 'splash-screen' => ['title' => 'Configured for a custom splash screen', 'impact' => 'PWA'],
438 'themed-omnibox' => ['title' => 'Sets a theme color for the address bar', 'impact' => 'PWA'],
439 'content-width' => ['title' => 'Content is sized correctly for the viewport', 'impact' => 'Mobile'],
440 'image-aspect-ratio' => ['title' => 'Displays images with correct aspect ratio', 'impact' => 'Layout'],
441 'image-size-responsive' => ['title' => 'Serves images with appropriate resolution', 'impact' => 'Performance'],
442 'preload-fonts' => ['title' => 'Fonts with font-display: optional are preloaded', 'impact' => 'Performance'],
443 'font-display' => ['title' => 'All text remains visible during webfont loads', 'impact' => 'Performance']
444 ];
445
446 foreach ($diagnostic_audits as $audit_id => $config) {
447 if (isset($audits[$audit_id])) {
448 $audit = $audits[$audit_id];
449 $score = $audit['score'] ?? null;
450
451 $status = 'info';
452 if ($score !== null) {
453 if ($score >= 0.9) {
454 $status = 'passed';
455 } elseif ($score >= 0.5) {
456 $status = 'warning';
457 } else {
458 $status = 'failed';
459 }
460 }
461
462 $diagnostics[] = [
463 'id' => $audit_id,
464 'title' => $config['title'],
465 'description' => $audit['description'] ?? '',
466 'status' => $status,
467 'score' => $score ? ($score * 100) : null,
468 'impact' => $config['impact'],
469 'details' => $audit['details'] ?? [],
470 'display_value' => $audit['displayValue'] ?? null
471 ];
472 }
473 }
474
475 return $diagnostics;
476 }
477
478 /**
479 * Get difficulty level for optimization opportunities
480 *
481 * @param string $audit_id Audit identifier
482 * @return string Difficulty level
483 */
484 private function get_difficulty_level(string $audit_id): string {
485 $difficulty_map = [
486 'unminified-css' => 'Easy',
487 'unminified-javascript' => 'Easy',
488 'modern-image-formats' => 'Easy',
489 'offscreen-images' => 'Medium',
490 'unused-css-rules' => 'Hard',
491 'unused-javascript' => 'Hard',
492 'render-blocking-resources' => 'Medium',
493 'efficient-animated-content' => 'Medium',
494 'duplicated-javascript' => 'Hard',
495 'legacy-javascript' => 'Medium'
496 ];
497
498 return $difficulty_map[$audit_id] ?? 'Medium';
499 }
500
501 /**
502 * Get rate limit configuration
503 * Following ThinkRank rate limiting patterns
504 *
505 * @return array Rate limit configuration
506 */
507 protected function get_rate_limits(): array {
508 return [
509 'max_requests_per_day' => self::MAX_REQUESTS_PER_DAY,
510 'reset_time' => get_transient(self::RATE_LIMIT_KEY . '_reset') ?: strtotime('tomorrow')
511 ];
512 }
513
514 /**
515 * Get rate limit transient key
516 * Following ThinkRank option naming patterns
517 *
518 * @return string Rate limit key
519 */
520 protected function get_rate_limit_key(): string {
521 return self::RATE_LIMIT_KEY;
522 }
523
524 /**
525 * Get rate limit error message
526 *
527 * @return string Error message
528 */
529 protected function get_rate_limit_error_message(): string {
530 return 'PageSpeed Insights API rate limit exceeded. Try again tomorrow.';
531 }
532 }
533