|
| 1 | +/** |
| 2 | + * @license |
| 3 | + * Copyright 2025 Google LLC |
| 4 | + * SPDX-License-Identifier: Apache-2.0 |
| 5 | + */ |
| 6 | + |
| 7 | +import {logger} from '../logger.js'; |
| 8 | +import {DevTools} from '../third_party/index.js'; |
| 9 | + |
| 10 | +// This key is expected to be visible. b/349721878 |
| 11 | +const CRUX_API_KEY = 'AIzaSyBn5gimNjhiEyA_euicSKko6IlD3HdgUfk'; |
| 12 | +const CRUX_ENDPOINT = `https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=${CRUX_API_KEY}`; |
| 13 | + |
| 14 | +export type PageScope = 'url' | 'origin'; |
| 15 | +export type DeviceScope = 'ALL' | 'DESKTOP' | 'PHONE' | 'TABLET'; |
| 16 | + |
| 17 | +export interface CrUXResponse { |
| 18 | + record: { |
| 19 | + key: { |
| 20 | + url?: string; |
| 21 | + origin?: string; |
| 22 | + formFactor?: string; |
| 23 | + }; |
| 24 | + metrics: Record<string, unknown>; |
| 25 | + collectionPeriod: unknown; |
| 26 | + }; |
| 27 | +} |
| 28 | + |
| 29 | +const DEVICE_SCOPE_LIST: DeviceScope[] = ['ALL', 'DESKTOP', 'PHONE']; |
| 30 | +const PAGE_SCOPE_LIST: PageScope[] = ['origin', 'url']; |
| 31 | + |
| 32 | +function mockCrUXManager(): void { |
| 33 | + const originalInstance = DevTools.CrUXManager.CrUXManager.instance; |
| 34 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 35 | + (DevTools.CrUXManager.CrUXManager as any).instance = (opts: any) => { |
| 36 | + try { |
| 37 | + return originalInstance.call(DevTools.CrUXManager.CrUXManager, opts); |
| 38 | + } catch { |
| 39 | + return { |
| 40 | + getSelectedScope: () => ({pageScope: 'url', deviceScope: 'ALL'}), |
| 41 | + }; |
| 42 | + } |
| 43 | + }; |
| 44 | +} |
| 45 | + |
| 46 | +export function ensureCrUXManager(): void { |
| 47 | + try { |
| 48 | + // Ensure Settings instance |
| 49 | + try { |
| 50 | + DevTools.Common.Settings.Settings.instance(); |
| 51 | + } catch { |
| 52 | + const storage = new DevTools.Common.Settings.SettingsStorage({}); |
| 53 | + DevTools.Common.Settings.Settings.instance({ |
| 54 | + forceNew: true, |
| 55 | + syncedStorage: storage, |
| 56 | + globalStorage: storage, |
| 57 | + localStorage: storage, |
| 58 | + settingRegistrations: |
| 59 | + DevTools.Common.SettingRegistration.getRegisteredSettings(), |
| 60 | + }); |
| 61 | + } |
| 62 | + |
| 63 | + // Ensure TargetManager instance |
| 64 | + DevTools.TargetManager.instance(); |
| 65 | + |
| 66 | + // Ensure CrUXManager instance |
| 67 | + DevTools.CrUXManager.CrUXManager.instance(); |
| 68 | + } catch { |
| 69 | + mockCrUXManager(); |
| 70 | + } |
| 71 | +} |
| 72 | + |
| 73 | +async function makeRequest(params: { |
| 74 | + url?: string; |
| 75 | + origin?: string; |
| 76 | + formFactor?: string; |
| 77 | +}): Promise<CrUXResponse | null> { |
| 78 | + try { |
| 79 | + const response = await fetch(CRUX_ENDPOINT, { |
| 80 | + method: 'POST', |
| 81 | + headers: { |
| 82 | + 'Content-Type': 'application/json', |
| 83 | + referer: 'devtools://mcp', |
| 84 | + }, |
| 85 | + body: JSON.stringify(params), |
| 86 | + }); |
| 87 | + |
| 88 | + if (response.status === 404) { |
| 89 | + return null; |
| 90 | + } |
| 91 | + |
| 92 | + if (!response.ok) { |
| 93 | + logger(`CrUX API error: ${response.status} ${response.statusText}`); |
| 94 | + return null; |
| 95 | + } |
| 96 | + |
| 97 | + return (await response.json()) as CrUXResponse; |
| 98 | + } catch (e) { |
| 99 | + logger(`CrUX API fetch failed: ${e}`); |
| 100 | + return null; |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +export async function getFieldDataForPage( |
| 105 | + pageUrl: string, |
| 106 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 107 | +): Promise<any /* CrUXManager.PageResult */> { |
| 108 | + const url = new URL(pageUrl); |
| 109 | + url.hash = ''; |
| 110 | + url.search = ''; |
| 111 | + const normalizedUrl = url.href; |
| 112 | + const origin = url.origin; |
| 113 | + const hostname = url.hostname; |
| 114 | + |
| 115 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 116 | + const pageResult: any = { |
| 117 | + 'origin-ALL': null, |
| 118 | + 'origin-DESKTOP': null, |
| 119 | + 'origin-PHONE': null, |
| 120 | + 'origin-TABLET': null, |
| 121 | + 'url-ALL': null, |
| 122 | + 'url-DESKTOP': null, |
| 123 | + 'url-PHONE': null, |
| 124 | + 'url-TABLET': null, |
| 125 | + warnings: [], |
| 126 | + normalizedUrl, |
| 127 | + }; |
| 128 | + |
| 129 | + if ( |
| 130 | + hostname === 'localhost' || |
| 131 | + hostname === '127.0.0.1' || |
| 132 | + !origin.startsWith('http') |
| 133 | + ) { |
| 134 | + return pageResult; |
| 135 | + } |
| 136 | + |
| 137 | + const promises: Array<Promise<void>> = []; |
| 138 | + |
| 139 | + for (const pageScope of PAGE_SCOPE_LIST) { |
| 140 | + for (const deviceScope of DEVICE_SCOPE_LIST) { |
| 141 | + // eslint-disable-next-line @typescript-eslint/no-explicit-any |
| 142 | + const params: any = { |
| 143 | + metrics: [ |
| 144 | + 'first_contentful_paint', |
| 145 | + 'largest_contentful_paint', |
| 146 | + 'cumulative_layout_shift', |
| 147 | + 'interaction_to_next_paint', |
| 148 | + 'round_trip_time', |
| 149 | + 'form_factors', |
| 150 | + 'largest_contentful_paint_image_time_to_first_byte', |
| 151 | + 'largest_contentful_paint_image_resource_load_delay', |
| 152 | + 'largest_contentful_paint_image_resource_load_duration', |
| 153 | + 'largest_contentful_paint_image_element_render_delay', |
| 154 | + ], |
| 155 | + }; |
| 156 | + if (pageScope === 'url') { |
| 157 | + params.url = normalizedUrl; |
| 158 | + } else { |
| 159 | + params.origin = origin; |
| 160 | + } |
| 161 | + |
| 162 | + if (deviceScope !== 'ALL') { |
| 163 | + params.formFactor = deviceScope; |
| 164 | + } |
| 165 | + |
| 166 | + const promise = makeRequest(params).then(response => { |
| 167 | + pageResult[`${pageScope}-${deviceScope}`] = response; |
| 168 | + }); |
| 169 | + promises.push(promise); |
| 170 | + } |
| 171 | + } |
| 172 | + |
| 173 | + // Implement timeout |
| 174 | + const timeoutPromise = new Promise<void>(resolve => |
| 175 | + setTimeout(resolve, 1000), |
| 176 | + ); |
| 177 | + await Promise.race([Promise.all(promises), timeoutPromise]); |
| 178 | + |
| 179 | + return pageResult; |
| 180 | +} |
| 181 | + |
| 182 | +export async function populateCruxData( |
| 183 | + parsedTrace: DevTools.TraceEngine.TraceModel.ParsedTrace, |
| 184 | +): Promise<void> { |
| 185 | + ensureCrUXManager(); |
| 186 | + try { |
| 187 | + const settings = DevTools.Common.Settings.Settings.instance(); |
| 188 | + const cruxSetting = settings.createSetting('field-data-enabled', true); |
| 189 | + if (!cruxSetting.get()) { |
| 190 | + return; |
| 191 | + } |
| 192 | + } catch { |
| 193 | + // Fallback if settings are not available |
| 194 | + } |
| 195 | + |
| 196 | + const urls = new Set<string>(); |
| 197 | + if (parsedTrace.insights) { |
| 198 | + for (const insightSet of parsedTrace.insights.values()) { |
| 199 | + urls.add(insightSet.url.href); |
| 200 | + } |
| 201 | + } else { |
| 202 | + // Fallback to main frame URL if no insights |
| 203 | + const mainUrl = parsedTrace.data.Meta.mainFrameURL; |
| 204 | + if (mainUrl) { |
| 205 | + urls.add(mainUrl); |
| 206 | + } |
| 207 | + } |
| 208 | + |
| 209 | + if (urls.size === 0) { |
| 210 | + return; |
| 211 | + } |
| 212 | + |
| 213 | + const cruxData = await Promise.all( |
| 214 | + Array.from(urls).map(url => getFieldDataForPage(url)), |
| 215 | + ); |
| 216 | + |
| 217 | + parsedTrace.metadata.cruxFieldData = cruxData; |
| 218 | +} |
0 commit comments