chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.audits

Package-level declarations

Types

AffectedCookie

@Serializable

data class AffectedCookie(val name: String, val path: String, val domain: String)

Information about a cookie that is affected by an inspector issue.

AffectedFrame

@Serializable

data class AffectedFrame(val frameId: FrameId)

Information about the frame affected by an inspector issue.

AffectedRequest

@Serializable

data class AffectedRequest(val requestId: RequestId, val url: String? = null)

Information about a request that is affected by an inspector issue.

AttributionReportingIssueDetails

@Serializable

data class AttributionReportingIssueDetails(val violationType: AttributionReportingIssueType, val request: AffectedRequest? = null, val violatingNodeId: BackendNodeId? = null, val invalidParameter: String? = null)

Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/attribution-reporting-api

AttributionReportingIssueType

@Serializable

enum AttributionReportingIssueType : Enum<AttributionReportingIssueType>

Official doc

AuditsDomain

class AuditsDomain

Audits domain allows investigation of page violations and possible improvements.

BlockedByResponseIssueDetails

@Serializable

data class BlockedByResponseIssueDetails(val request: AffectedRequest, val parentFrame: AffectedFrame? = null, val blockedFrame: AffectedFrame? = null, val reason: BlockedByResponseReason)

Details for a request that has been blocked with the BLOCKED_BY_RESPONSE code. Currently only used for COEP/COOP, but may be extended to include some CSP errors in the future.

BlockedByResponseReason

@Serializable

enum BlockedByResponseReason : Enum<BlockedByResponseReason>

Enum indicating the reason a response has been blocked. These reasons are refinements of the net error BLOCKED_BY_RESPONSE.

BounceTrackingIssueDetails

@Serializable

data class BounceTrackingIssueDetails(val trackingSites: List<String>)

This issue warns about sites in the redirect chain of a finished navigation that may be flagged as trackers and have their state cleared if they don't receive a user interaction. Note that in this context 'site' means eTLD+1. For example, if the URL https://example.test:80/bounce was in the redirect chain, the site reported would be example.test.

CheckContrastRequest

@Serializable

data class CheckContrastRequest(val reportAAA: Boolean? = null)

Request object containing input parameters for the AuditsDomain.checkContrast command.

CheckContrastResponse

@Serializable

object CheckContrastResponse

A dummy response object for the AuditsDomain.checkContrast command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

CheckFormsIssuesResponse

@Serializable

data class CheckFormsIssuesResponse(val formIssues: List<GenericIssueDetails>)

Response type for the AuditsDomain.checkFormsIssues command.

ClientHintIssueDetails

@Serializable

data class ClientHintIssueDetails(val sourceCodeLocation: SourceCodeLocation, val clientHintIssueReason: ClientHintIssueReason)

This issue tracks client hints related issues. It's used to deprecate old features, encourage the use of new ones, and provide general guidance.

ClientHintIssueReason

@Serializable

enum ClientHintIssueReason : Enum<ClientHintIssueReason>

Official doc

ContentSecurityPolicyIssueDetails

@Serializable

data class ContentSecurityPolicyIssueDetails(val blockedURL: String? = null, val violatedDirective: String, val isReportOnly: Boolean, val contentSecurityPolicyViolationType: ContentSecurityPolicyViolationType, val frameAncestor: AffectedFrame? = null, val sourceCodeLocation: SourceCodeLocation? = null, val violatingNodeId: BackendNodeId? = null)

Official doc

ContentSecurityPolicyViolationType

@Serializable

enum ContentSecurityPolicyViolationType : Enum<ContentSecurityPolicyViolationType>

Official doc

CookieExclusionReason

@Serializable

enum CookieExclusionReason : Enum<CookieExclusionReason>

Official doc

CookieIssueDetails

@Serializable

data class CookieIssueDetails(val cookie: AffectedCookie? = null, val rawCookieLine: String? = null, val cookieWarningReasons: List<CookieWarningReason>, val cookieExclusionReasons: List<CookieExclusionReason>, val operation: CookieOperation, val siteForCookies: String? = null, val cookieUrl: String? = null, val request: AffectedRequest? = null)

This information is currently necessary, as the front-end has a difficult time finding a specific cookie. With this, we can convey specific error information without the cookie.

CookieOperation

@Serializable

enum CookieOperation : Enum<CookieOperation>

Official doc

CookieWarningReason

@Serializable

enum CookieWarningReason : Enum<CookieWarningReason>

Official doc

CorsIssueDetails

@Serializable

data class CorsIssueDetails(val corsErrorStatus: CorsErrorStatus, val isWarning: Boolean, val request: AffectedRequest, val location: SourceCodeLocation? = null, val initiatorOrigin: String? = null, val resourceIPAddressSpace: IPAddressSpace? = null, val clientSecurityState: ClientSecurityState? = null)

Details for a CORS related issue, e.g. a warning or error related to CORS RFC1918 enforcement.

DeprecationIssueDetails

@Serializable

data class DeprecationIssueDetails(val affectedFrame: AffectedFrame? = null, val sourceCodeLocation: SourceCodeLocation, val type: String)

This issue tracks information needed to print a deprecation message. https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md

DisableResponse

@Serializable

object DisableResponse

A dummy response object for the AuditsDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

EnableResponse

@Serializable

object EnableResponse

A dummy response object for the AuditsDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

EncodedResponseEncoding

@Serializable

enum EncodedResponseEncoding : Enum<EncodedResponseEncoding>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

FailedRequestInfo

@Serializable

data class FailedRequestInfo(val url: String, val failureMessage: String, val requestId: RequestId? = null)

Official doc

FederatedAuthRequestIssueDetails

@Serializable

data class FederatedAuthRequestIssueDetails(val federatedAuthRequestIssueReason: FederatedAuthRequestIssueReason)

Official doc

FederatedAuthRequestIssueReason

@Serializable

enum FederatedAuthRequestIssueReason : Enum<FederatedAuthRequestIssueReason>

Represents the failure reason when a federated authentication reason fails. Should be updated alongside RequestIdTokenStatus in third_party/blink/public/mojom/devtools/inspector_issue.mojom to include all cases except for success.

FederatedAuthUserInfoRequestIssueDetails

@Serializable

data class FederatedAuthUserInfoRequestIssueDetails(val federatedAuthUserInfoRequestIssueReason: FederatedAuthUserInfoRequestIssueReason)

Official doc

FederatedAuthUserInfoRequestIssueReason

@Serializable

enum FederatedAuthUserInfoRequestIssueReason : Enum<FederatedAuthUserInfoRequestIssueReason>

Represents the failure reason when a getUserInfo() call fails. Should be updated alongside FederatedAuthUserInfoRequestResult in third_party/blink/public/mojom/devtools/inspector_issue.mojom.

GenericIssueDetails

@Serializable

data class GenericIssueDetails(val errorType: GenericIssueErrorType, val frameId: FrameId? = null, val violatingNodeId: BackendNodeId? = null, val violatingNodeAttribute: String? = null, val request: AffectedRequest? = null)

Depending on the concrete errorType, different properties are set.

GenericIssueErrorType

@Serializable

enum GenericIssueErrorType : Enum<GenericIssueErrorType>

Official doc

GetEncodedResponseRequest

@Serializable

data class GetEncodedResponseRequest(val requestId: RequestId, val encoding: EncodedResponseEncoding, val quality: Double? = null, val sizeOnly: Boolean? = null)

Request object containing input parameters for the AuditsDomain.getEncodedResponse command.

GetEncodedResponseResponse

@Serializable

data class GetEncodedResponseResponse(val body: String? = null, val originalSize: Int, val encodedSize: Int)

Response type for the AuditsDomain.getEncodedResponse command.

HeavyAdIssueDetails

@Serializable

data class HeavyAdIssueDetails(val resolution: HeavyAdResolutionStatus, val reason: HeavyAdReason, val frame: AffectedFrame)

Official doc

HeavyAdReason

@Serializable

enum HeavyAdReason : Enum<HeavyAdReason>

Official doc

HeavyAdResolutionStatus

@Serializable

enum HeavyAdResolutionStatus : Enum<HeavyAdResolutionStatus>

Official doc

InspectorIssue

@Serializable

data class InspectorIssue(val code: InspectorIssueCode, val details: InspectorIssueDetails, val issueId: IssueId? = null)

An inspector issue reported from the back-end.

InspectorIssueCode

@Serializable

enum InspectorIssueCode : Enum<InspectorIssueCode>

A unique identifier for the type of issue. Each type may use one of the optional fields in InspectorIssueDetails to convey more specific information about the kind of issue.

InspectorIssueDetails

@Serializable

data class InspectorIssueDetails(val cookieIssueDetails: CookieIssueDetails? = null, val mixedContentIssueDetails: MixedContentIssueDetails? = null, val blockedByResponseIssueDetails: BlockedByResponseIssueDetails? = null, val heavyAdIssueDetails: HeavyAdIssueDetails? = null, val contentSecurityPolicyIssueDetails: ContentSecurityPolicyIssueDetails? = null, val sharedArrayBufferIssueDetails: SharedArrayBufferIssueDetails? = null, val lowTextContrastIssueDetails: LowTextContrastIssueDetails? = null, val corsIssueDetails: CorsIssueDetails? = null, val attributionReportingIssueDetails: AttributionReportingIssueDetails? = null, val quirksModeIssueDetails: QuirksModeIssueDetails? = null, val navigatorUserAgentIssueDetails: NavigatorUserAgentIssueDetails? = null, val genericIssueDetails: GenericIssueDetails? = null, val deprecationIssueDetails: DeprecationIssueDetails? = null, val clientHintIssueDetails: ClientHintIssueDetails? = null, val federatedAuthRequestIssueDetails: FederatedAuthRequestIssueDetails? = null, val bounceTrackingIssueDetails: BounceTrackingIssueDetails? = null, val stylesheetLoadingIssueDetails: StylesheetLoadingIssueDetails? = null, val federatedAuthUserInfoRequestIssueDetails: FederatedAuthUserInfoRequestIssueDetails? = null)

This struct holds a list of optional fields with additional information specific to the kind of issue. When adding a new issue code, please also add a new optional field to this type.

IssueId

typealias IssueId = String

A unique id for a DevTools inspector issue. Allows other entities (e.g. exceptions, CDP message, console messages, etc.) to reference an issue.

Official doc

LowTextContrastIssueDetails

@Serializable

data class LowTextContrastIssueDetails(val violatingNodeId: BackendNodeId, val violatingNodeSelector: String, val contrastRatio: Double, val thresholdAA: Double, val thresholdAAA: Double, val fontSize: String, val fontWeight: String)

Official doc

MixedContentIssueDetails

@Serializable

data class MixedContentIssueDetails(val resourceType: MixedContentResourceType? = null, val resolutionStatus: MixedContentResolutionStatus, val insecureURL: String, val mainResourceURL: String, val request: AffectedRequest? = null, val frame: AffectedFrame? = null)

Official doc

MixedContentResolutionStatus

@Serializable

enum MixedContentResolutionStatus : Enum<MixedContentResolutionStatus>

Official doc

MixedContentResourceType

@Serializable

enum MixedContentResourceType : Enum<MixedContentResourceType>

Official doc

NavigatorUserAgentIssueDetails

@Serializable

data class ~~NavigatorUserAgentIssueDetails~~(val url: String, val location: SourceCodeLocation? = null)

Official doc

QuirksModeIssueDetails

@Serializable

data class QuirksModeIssueDetails(val isLimitedQuirksMode: Boolean, val documentNodeId: BackendNodeId, val url: String, val frameId: FrameId, val loaderId: LoaderId)

Details for issues about documents in Quirks Mode or Limited Quirks Mode that affects page layouting.

SharedArrayBufferIssueDetails

@Serializable

data class SharedArrayBufferIssueDetails(val sourceCodeLocation: SourceCodeLocation, val isWarning: Boolean, val type: SharedArrayBufferIssueType)

Details for a issue arising from an SAB being instantiated in, or transferred to a context that is not cross-origin isolated.

SharedArrayBufferIssueType

@Serializable

enum SharedArrayBufferIssueType : Enum<SharedArrayBufferIssueType>

Official doc

SourceCodeLocation

@Serializable

data class SourceCodeLocation(val scriptId: ScriptId? = null, val url: String, val lineNumber: Int, val columnNumber: Int)

Official doc

StylesheetLoadingIssueDetails

@Serializable

data class StylesheetLoadingIssueDetails(val sourceCodeLocation: SourceCodeLocation, val styleSheetLoadingIssueReason: StyleSheetLoadingIssueReason, val failedRequestInfo: FailedRequestInfo? = null)

This issue warns when a referenced stylesheet couldn't be loaded.

StyleSheetLoadingIssueReason

@Serializable

enum StyleSheetLoadingIssueReason : Enum<StyleSheetLoadingIssueReason>

Official doc