audits

package
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2020 License: MIT Imports: 4 Imported by: 6

Documentation

Overview

Package audits implements the Audits domain. Audits domain allows investigation of page violations and possible improvements.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the Audits domain with the connection set to conn.

Types

type AffectedCookie added in v0.26.0

type AffectedCookie struct {
	Name           string  `json:"name"`                     // The following three properties uniquely identify a cookie
	Path           string  `json:"path"`                     // No description.
	Domain         string  `json:"domain"`                   // No description.
	SiteForCookies *string `json:"siteForCookies,omitempty"` // Optionally identifies the site-for-cookies, which may be used by the front-end as additional context.
}

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

type AffectedResources added in v0.26.0

type AffectedResources struct {
	Cookies []AffectedCookie `json:"cookies,omitempty"` // No description.
}

AffectedResources

type GetEncodedResponseArgs

type GetEncodedResponseArgs struct {
	RequestID network.RequestID `json:"requestId"` // Identifier of the network request to get content for.
	// Encoding The encoding to use.
	//
	// Values: "webp", "jpeg", "png".
	Encoding string   `json:"encoding"`
	Quality  *float64 `json:"quality,omitempty"`  // The quality of the encoding (0-1). (defaults to 1)
	SizeOnly *bool    `json:"sizeOnly,omitempty"` // Whether to only return the size information (defaults to false).
}

GetEncodedResponseArgs represents the arguments for GetEncodedResponse in the Audits domain.

func NewGetEncodedResponseArgs

func NewGetEncodedResponseArgs(requestID network.RequestID, encoding string) *GetEncodedResponseArgs

NewGetEncodedResponseArgs initializes GetEncodedResponseArgs with the required arguments.

func (*GetEncodedResponseArgs) SetQuality

func (a *GetEncodedResponseArgs) SetQuality(quality float64) *GetEncodedResponseArgs

SetQuality sets the Quality optional argument. The quality of the encoding (0-1). (defaults to 1)

func (*GetEncodedResponseArgs) SetSizeOnly

func (a *GetEncodedResponseArgs) SetSizeOnly(sizeOnly bool) *GetEncodedResponseArgs

SetSizeOnly sets the SizeOnly optional argument. Whether to only return the size information (defaults to false).

type GetEncodedResponseReply

type GetEncodedResponseReply struct {
	Body         *string `json:"body,omitempty"` // The encoded body as a base64 string. Omitted if sizeOnly is true.
	OriginalSize int     `json:"originalSize"`   // Size before re-encoding.
	EncodedSize  int     `json:"encodedSize"`    // Size after re-encoding.
}

GetEncodedResponseReply represents the return values for GetEncodedResponse in the Audits domain.

type InspectorIssue added in v0.26.0

type InspectorIssue struct {
	Code      InspectorIssueCode    `json:"code"`      // No description.
	Details   InspectorIssueDetails `json:"details"`   // No description.
	Resources AffectedResources     `json:"resources"` // No description.
}

InspectorIssue An inspector issue reported from the back-end.

type InspectorIssueCode added in v0.26.0

type InspectorIssueCode string

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, and AffectedResources to identify resources that are affected by this issue.

const (
	InspectorIssueCodeNotSet              InspectorIssueCode = ""
	InspectorIssueCodeSameSiteCookieIssue InspectorIssueCode = "SameSiteCookieIssue"
)

InspectorIssueCode as enums.

func (InspectorIssueCode) String added in v0.26.0

func (e InspectorIssueCode) String() string

func (InspectorIssueCode) Valid added in v0.26.0

func (e InspectorIssueCode) Valid() bool

type InspectorIssueDetails added in v0.26.0

type InspectorIssueDetails struct {
	SameSiteCookieIssueDetails *SameSiteCookieIssueDetails `json:"sameSiteCookieIssueDetails,omitempty"` // No description.
}

InspectorIssueDetails This struct holds a list of optional fields with additional information pertaining to the kind of issue. This is useful if there is a number of very similar issues that only differ in details.

type IssueAddedClient added in v0.26.0

type IssueAddedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*IssueAddedReply, error)
	rpcc.Stream
}

IssueAddedClient is a client for IssueAdded events.

type IssueAddedReply added in v0.26.0

type IssueAddedReply struct {
	Issue InspectorIssue `json:"issue"` // No description.
}

IssueAddedReply is the reply for IssueAdded events.

type SameSiteCookieExclusionReason added in v0.26.0

type SameSiteCookieExclusionReason string

SameSiteCookieExclusionReason

const (
	SameSiteCookieExclusionReasonNotSet                                 SameSiteCookieExclusionReason = ""
	SameSiteCookieExclusionReasonExcludeSameSiteUnspecifiedTreatedAsLax SameSiteCookieExclusionReason = "ExcludeSameSiteUnspecifiedTreatedAsLax"
	SameSiteCookieExclusionReasonExcludeSameSiteNoneInsecure            SameSiteCookieExclusionReason = "ExcludeSameSiteNoneInsecure"
)

SameSiteCookieExclusionReason as enums.

func (SameSiteCookieExclusionReason) String added in v0.26.0

func (SameSiteCookieExclusionReason) Valid added in v0.26.0

type SameSiteCookieIssueDetails added in v0.26.0

type SameSiteCookieIssueDetails struct {
	CookieWarningReasons   []SameSiteCookieWarningReason   `json:"cookieWarningReasons"`   // No description.
	CookieExclusionReasons []SameSiteCookieExclusionReason `json:"cookieExclusionReasons"` // No description.
}

SameSiteCookieIssueDetails 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.

type SameSiteCookieWarningReason added in v0.26.0

type SameSiteCookieWarningReason string

SameSiteCookieWarningReason

const (
	SameSiteCookieWarningReasonNotSet                                         SameSiteCookieWarningReason = ""
	SameSiteCookieWarningReasonWarnSameSiteUnspecifiedCrossSiteContext        SameSiteCookieWarningReason = "WarnSameSiteUnspecifiedCrossSiteContext"
	SameSiteCookieWarningReasonWarnSameSiteNoneInsecure                       SameSiteCookieWarningReason = "WarnSameSiteNoneInsecure"
	SameSiteCookieWarningReasonWarnSameSiteUnspecifiedLaxAllowUnsafe          SameSiteCookieWarningReason = "WarnSameSiteUnspecifiedLaxAllowUnsafe"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeSecureURLMethodUnsafe   SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeSecureUrlMethodUnsafe"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeSecureURLLax            SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeSecureUrlLax"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeSecureURLStrict         SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeSecureUrlStrict"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeInsecureURLMethodUnsafe SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeInsecureUrlMethodUnsafe"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeInsecureURLLax          SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeInsecureUrlLax"
	SameSiteCookieWarningReasonWarnSameSiteCrossSchemeInsecureURLStrict       SameSiteCookieWarningReason = "WarnSameSiteCrossSchemeInsecureUrlStrict"
)

SameSiteCookieWarningReason as enums.

func (SameSiteCookieWarningReason) String added in v0.26.0

func (SameSiteCookieWarningReason) Valid added in v0.26.0

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL