// Copyright 2021 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import * as i18n from '../../core/i18n/i18n.js'; import type * as Platform from '../../core/platform/platform.js'; import * as SDK from '../../core/sdk/sdk.js'; import type * as Protocol from '../../generated/protocol.js'; import * as SourceFrame from '../../ui/legacy/components/source_frame/source_frame.js'; import * as UI from '../../ui/legacy/legacy.js'; import {html, render} from '../../ui/lit/lit.js'; import * as VisualLogging from '../../ui/visual_logging/visual_logging.js'; import * as ApplicationComponents from './components/components.js'; const {widgetConfig} = UI.Widget; const UIStrings = { /** * @description Placeholder text that shows if no report or endpoint was detected. * A report contains information on issues or events that were encountered by a web browser. * An endpoint is a URL where the report is sent to. * (https://developer.chrome.com/docs/capabilities/web-apis/reporting-api) */ noReportOrEndpoint: 'No report or endpoint', /** * @description Placeholder text that shows if no report or endpoint was detected. * A report contains information on issues or events that were encountered by a web browser. * An endpoint is a URL where the report is sent to. * (https://developer.chrome.com/docs/capabilities/web-apis/reporting-api) */ reportingApiDescription: 'On this page you will be able to inspect `Reporting API` reports and endpoints.', /** * @description Placeholder text that shows if no report was selected for viewing *report body (https://developers.google.com/web/updates/2018/09/reportingapi#sending). */ noReportSelected: 'No report selected', /** * @description Placeholder text instructing the user how to display a Reporting API *report body (https://developers.google.com/web/updates/2018/09/reportingapi#sending). */ clickToDisplayBody: 'Click on any report to display its body', } as const; const str_ = i18n.i18n.registerUIStrings('panels/application/ReportingApiView.ts', UIStrings); export const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_); const REPORTING_API_EXPLANATION_URL = 'https://developer.chrome.com/docs/capabilities/web-apis/reporting-api' as Platform.DevToolsPath.UrlString; interface ViewInput { hasReports: boolean; hasEndpoints: boolean; endpoints: Map; reports: Protocol.Network.ReportingApiReport[]; focusedReport?: Protocol.Network.ReportingApiReport; onReportSelected: (id: string) => void; } export const DEFAULT_VIEW = (input: ViewInput, output: undefined, target: HTMLElement): void => { if (input.hasReports || input.hasEndpoints) { // clang-format off render(html` ${input.hasReports ? html`
${input.focusedReport ? html` ` : html` `}
` : html`
`}
`, target); // clang-format on } else { // clang-format off render(html` `, target); // clang-format on } }; type View = typeof DEFAULT_VIEW; export class ReportingApiView extends UI.Widget.VBox implements SDK.TargetManager.SDKModelObserver { #endpoints: Map; #view: View; #networkManager?: SDK.NetworkManager.NetworkManager; #reports: Protocol.Network.ReportingApiReport[] = []; #focusedReport?: Protocol.Network.ReportingApiReport; constructor(view = DEFAULT_VIEW) { super(); this.#view = view; this.#endpoints = new Map(); SDK.TargetManager.TargetManager.instance().observeModels(SDK.NetworkManager.NetworkManager, this); this.requestUpdate(); } modelAdded(networkManager: SDK.NetworkManager.NetworkManager): void { if (networkManager.target() !== SDK.TargetManager.TargetManager.instance().primaryPageTarget()) { return; } this.#networkManager = networkManager; this.#networkManager.addEventListener( SDK.NetworkManager.Events.ReportingApiEndpointsChangedForOrigin, this.#onEndpointsChangedForOrigin, this); this.#networkManager.addEventListener(SDK.NetworkManager.Events.ReportingApiReportAdded, this.#onReportAdded, this); this.#networkManager.addEventListener( SDK.NetworkManager.Events.ReportingApiReportUpdated, this.#onReportUpdated, this); void this.#networkManager.enableReportingApi(); this.requestUpdate(); } modelRemoved(networkManager: SDK.NetworkManager.NetworkManager): void { if (!this.#networkManager || this.#networkManager !== networkManager) { return; } this.#networkManager.removeEventListener( SDK.NetworkManager.Events.ReportingApiEndpointsChangedForOrigin, this.#onEndpointsChangedForOrigin, this); this.#networkManager.removeEventListener( SDK.NetworkManager.Events.ReportingApiReportAdded, this.#onReportAdded, this); this.#networkManager.removeEventListener( SDK.NetworkManager.Events.ReportingApiReportUpdated, this.#onReportUpdated, this); this.#networkManager = undefined; } override performUpdate(): void { const viewInput = { hasReports: this.#reports.length > 0, hasEndpoints: this.#endpoints.size > 0, endpoints: this.#endpoints, reports: this.#reports, focusedReport: this.#focusedReport, onReportSelected: this.#onReportSelected.bind(this), }; this.#view(viewInput, undefined, this.element); } #onEndpointsChangedForOrigin({data}: {data: Protocol.Network.ReportingApiEndpointsChangedForOriginEvent}): void { this.#endpoints.set(data.origin, data.endpoints); this.requestUpdate(); } #onReportAdded({data: report}: {data: Protocol.Network.ReportingApiReport}): void { this.#reports.push(report); this.requestUpdate(); } #onReportUpdated({data: report}: {data: Protocol.Network.ReportingApiReport}): void { const index = this.#reports.findIndex(oldReport => oldReport.id === report.id); this.#reports[index] = report; this.requestUpdate(); } #onReportSelected(id: string): void { const report = this.#reports.find(report => report.id === id); if (report) { this.#focusedReport = report; this.requestUpdate(); } } }