Fix json protocol

Updates gcdapi and json protocol to use PUT

Author: =

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Changelog (2023)
+- 2.3.0 (Mar 28) Updated JSON endpoint calls to use PUT instead of GET as GET returns an error since 111.
+  - Updates to chrome 111.0.5563.147 protocol
+
 # Changelog (2022)
 - 2.2.6 (Sept 5th) Fixes a bug where new types that were just arrays to another ref type were not being output correctly
   - Updates to chrome 105.0.5195.102

gcd.go

@@ -291,6 +291,7 @@ func (c *Gcd) getConnectableTargets() ([]*TargetInfo, error) {
 		targets := make([]*TargetInfo, 0)
 		err = json.Unmarshal(body, &targets)
 		if err != nil {
+			fmt.Printf("%s\n", string(body))
 			return nil, &GcdDecodingErr{Message: err.Error()}
 		}
 

gcd_test.go

@@ -27,7 +27,7 @@ var (
 func init() {
 	switch runtime.GOOS {
 	case "windows":
-		flag.StringVar(&testPath, "chrome", "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe", "path to chrome")
+		flag.StringVar(&testPath, "chrome", "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe", "path to chrome")
 		flag.StringVar(&testDir, "dir", "C:\\temp\\gcd\\", "user directory")
 	case "darwin":
 		flag.StringVar(&testPath, "chrome", "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome", "path to chrome")

v2/gcd.go

@@ -45,7 +45,7 @@ import (
 
 var json = jsoniter.ConfigCompatibleWithStandardLibrary
 
-var GCDVERSION = "v2.2.6"
+var GCDVERSION = "v2.3.0"
 
 var (
 	ErrNoTabAvailable = errors.New("no available tab found")
@@ -374,7 +374,12 @@ func (c *Gcd) GetNewTargets(knownIds map[string]struct{}) ([]*ChromeTarget, erro
 func (c *Gcd) getConnectableTargets() ([]*TargetInfo, error) {
 	// some times it takes a while to get results, so retry 4x
 	for i := 0; i < 4; i++ {
-		resp, err := http.Get(c.apiEndpoint)
+		req, err := http.NewRequest("PUT", c.apiEndpoint, nil)
+		if err != nil {
+			return nil, err
+		}
+
+		resp, err := http.DefaultClient.Do(req)
 		if err != nil {
 			return nil, err
 		}
@@ -408,7 +413,12 @@ func (c *Gcd) getConnectableTargets() ([]*TargetInfo, error) {
 
 // NewTab a new empty tab, returns the chrome target.
 func (c *Gcd) NewTab() (*ChromeTarget, error) {
-	resp, err := http.Get(c.apiEndpoint + "/new")
+	req, err := http.NewRequest("PUT", c.apiEndpoint+"/new", nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
 		return nil, err
 	}
@@ -427,30 +437,19 @@ func (c *Gcd) NewTab() (*ChromeTarget, error) {
 	return openChromeTarget(c, tabTarget, c.messageObserver)
 }
 
-// GetFirstTab returns the first tab created, to be called when
-// first started, otherwise you will get a random tab returned.
-func (c *Gcd) GetFirstTab() (*ChromeTarget, error) {
-	connectableTargets, err := c.getConnectableTargets()
-	if err != nil {
-		return nil, err
-	}
-
-	for _, tabTarget := range connectableTargets {
-		if tabTarget.Type == "page" {
-			return openChromeTarget(c, tabTarget, c.messageObserver)
-		}
-	}
-	return nil, ErrNoTabAvailable
-}
-
 // GetRevision of chrome
 func (c *Gcd) GetRevision() string {
 	return gcdapi.CHROME_VERSION
 }
 
 // CloseTab closes the target tab.
 func (c *Gcd) CloseTab(target *ChromeTarget) error {
-	resp, err := http.Get(fmt.Sprintf("%s/close/%s", c.apiEndpoint, target.Target.Id))
+	req, err := http.NewRequest("PUT", fmt.Sprintf("%s/close/%s", c.apiEndpoint, target.Target.Id), nil)
+	if err != nil {
+		return err
+	}
+
+	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
 		return err
 	}
@@ -461,7 +460,12 @@ func (c *Gcd) CloseTab(target *ChromeTarget) error {
 
 // ActivateTab (focus) the tab.
 func (c *Gcd) ActivateTab(target *ChromeTarget) error {
-	resp, err := http.Get(fmt.Sprintf("%s/activate/%s", c.apiEndpoint, target.Target.Id))
+	req, err := http.NewRequest("PUT", fmt.Sprintf("%s/activate/%s", c.apiEndpoint, target.Target.Id), nil)
+	if err != nil {
+		return err
+	}
+
+	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
 		return err
 	}

v2/gcd_test.go

@@ -83,13 +83,25 @@ func TestGetPages(t *testing.T) {
 	testDefaultStartup(t)
 	defer debugger.ExitProcess()
 
+	newTab, err := debugger.NewTab()
+	if err != nil {
+		t.Fatalf("error creating tab: %s\n", err)
+	}
+
 	targets, err := debugger.GetTargets()
 	if err != nil {
 		t.Fatalf("error getting targets: %s\n", err)
 	}
+
 	if len(targets) <= 0 {
 		t.Fatalf("invalid number of targets, got: %d\n", len(targets))
 	}
+
+	err = debugger.CloseTab(newTab)
+	if err != nil {
+		t.Fatalf("error CloseTab: %s\n", err)
+	}
+
 	t.Logf("page: %s\n", targets[0].Target.Url)
 }
 
@@ -529,7 +541,7 @@ func TestContextCancel(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*1)
 	defer cancel()
 
-	target, err := debugger.GetFirstTab()
+	target, err := debugger.NewTab()
 	if err != nil {
 		t.Fatalf("error getting first tab")
 	}
@@ -605,19 +617,10 @@ func TestNetworkIntercept(t *testing.T) {
 	<-doneCh
 }
 
-func TestGetFirstTab(t *testing.T) {
-	testDefaultStartup(t)
-	defer debugger.ExitProcess()
-	_, err := debugger.GetFirstTab()
-	if err != nil {
-		t.Fatalf("error getting first tab: %v\n", err)
-	}
-}
-
 func TestCloseTab(t *testing.T) {
 	testDefaultStartup(t)
 	defer debugger.ExitProcess()
-	target, err := debugger.GetFirstTab()
+	target, err := debugger.NewTab()
 	if err != nil {
 		t.Fatalf("error getting first tab: %v\n", err)
 	}
@@ -638,9 +641,9 @@ func TestCustomLogger(t *testing.T) {
 	customLogger := &testLogger{}
 	testDefaultStartup(t, WithLogger(customLogger), WithEventDebugging())
 	defer debugger.ExitProcess()
-	tab, err := debugger.GetFirstTab()
+	tab, err := debugger.NewTab()
 	if err != nil {
-		t.Fatalf("error getting first tab: %v\n", err)
+		t.Fatalf("error getting new tab: %v\n", err)
 	}
 
 	if _, err = tab.Page.Enable(context.TODO()); err != nil {

v2/gcdapi/accessibility.go

@@ -102,7 +102,7 @@ type AccessibilityGetPartialAXTreeParams struct {
 	BackendNodeId int `json:"backendNodeId,omitempty"`
 	// JavaScript object id of the node wrapper to get the partial accessibility tree for.
 	ObjectId string `json:"objectId,omitempty"`
-	// Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
+	// Whether to fetch this node's ancestors, siblings and children. Defaults to true.
 	FetchRelatives bool `json:"fetchRelatives,omitempty"`
 }
 
@@ -142,7 +142,7 @@ func (c *Accessibility) GetPartialAXTreeWithParams(ctx context.Context, v *Acces
 // nodeId - Identifier of the node to get the partial accessibility tree for.
 // backendNodeId - Identifier of the backend node to get the partial accessibility tree for.
 // objectId - JavaScript object id of the node wrapper to get the partial accessibility tree for.
-// fetchRelatives - Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
+// fetchRelatives - Whether to fetch this node's ancestors, siblings and children. Defaults to true.
 // Returns -  nodes - The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.
 func (c *Accessibility) GetPartialAXTree(ctx context.Context, nodeId int, backendNodeId int, objectId string, fetchRelatives bool) ([]*AccessibilityAXNode, error) {
 	var v AccessibilityGetPartialAXTreeParams

v2/gcdapi/audits.go

@@ -32,7 +32,7 @@ type AuditsCookieIssueDetails struct {
 	Cookie                 *AuditsAffectedCookie  `json:"cookie,omitempty"`         // If AffectedCookie is not set then rawCookieLine contains the raw Set-Cookie header string. This hints at a problem where the cookie line is syntactically or semantically malformed in a way that no valid cookie could be created.
 	RawCookieLine          string                 `json:"rawCookieLine,omitempty"`  //
 	CookieWarningReasons   []string               `json:"cookieWarningReasons"`     //  enum values: WarnSameSiteUnspecifiedCrossSiteContext, WarnSameSiteNoneInsecure, WarnSameSiteUnspecifiedLaxAllowUnsafe, WarnSameSiteStrictLaxDowngradeStrict, WarnSameSiteStrictCrossDowngradeStrict, WarnSameSiteStrictCrossDowngradeLax, WarnSameSiteLaxCrossDowngradeStrict, WarnSameSiteLaxCrossDowngradeLax, WarnAttributeValueExceedsMaxSize, WarnDomainNonASCII
-	CookieExclusionReasons []string               `json:"cookieExclusionReasons"`   //  enum values: ExcludeSameSiteUnspecifiedTreatedAsLax, ExcludeSameSiteNoneInsecure, ExcludeSameSiteLax, ExcludeSameSiteStrict, ExcludeInvalidSameParty, ExcludeSamePartyCrossPartyContext, ExcludeDomainNonASCII
+	CookieExclusionReasons []string               `json:"cookieExclusionReasons"`   //  enum values: ExcludeSameSiteUnspecifiedTreatedAsLax, ExcludeSameSiteNoneInsecure, ExcludeSameSiteLax, ExcludeSameSiteStrict, ExcludeInvalidSameParty, ExcludeSamePartyCrossPartyContext, ExcludeDomainNonASCII, ExcludeThirdPartyCookieBlockedInFirstPartySet
 	Operation              string                 `json:"operation"`                // Optionally identifies the site-for-cookies and the cookie url, which may be used by the front-end as additional context. enum values: SetCookie, ReadCookie
 	SiteForCookies         string                 `json:"siteForCookies,omitempty"` //
 	CookieUrl              string                 `json:"cookieUrl,omitempty"`      //
@@ -123,7 +123,7 @@ type AuditsCorsIssueDetails struct {
 
 // Details for issues around "Attribution Reporting API" usage. Explainer: https://github.com/WICG/attribution-reporting-api
 type AuditsAttributionReportingIssueDetails struct {
-	ViolationType    string                 `json:"violationType"`              //  enum values: PermissionPolicyDisabled, UntrustworthyReportingOrigin, InsecureContext, InvalidHeader, InvalidRegisterTriggerHeader, InvalidEligibleHeader, TooManyConcurrentRequests, SourceAndTriggerHeaders, SourceIgnored, TriggerIgnored
+	ViolationType    string                 `json:"violationType"`              //  enum values: PermissionPolicyDisabled, UntrustworthyReportingOrigin, InsecureContext, InvalidHeader, InvalidRegisterTriggerHeader, InvalidEligibleHeader, TooManyConcurrentRequests, SourceAndTriggerHeaders, SourceIgnored, TriggerIgnored, OsSourceIgnored, OsTriggerIgnored, InvalidRegisterOsSourceHeader, InvalidRegisterOsTriggerHeader, WebAndOsHeaders
 	Request          *AuditsAffectedRequest `json:"request,omitempty"`          //
 	ViolatingNodeId  int                    `json:"violatingNodeId,omitempty"`  //
 	InvalidParameter string                 `json:"invalidParameter,omitempty"` //
@@ -146,20 +146,21 @@ type AuditsNavigatorUserAgentIssueDetails struct {
 
 // Depending on the concrete errorType, different properties are set.
 type AuditsGenericIssueDetails struct {
-	ErrorType string `json:"errorType"`         // Issues with the same errorType are aggregated in the frontend. enum values: CrossOriginPortalPostMessageError
-	FrameId   string `json:"frameId,omitempty"` //
+	ErrorType       string `json:"errorType"`                 // Issues with the same errorType are aggregated in the frontend. enum values: CrossOriginPortalPostMessageError, FormLabelForNameError, FormDuplicateIdForInputError, FormInputWithNoLabelError, FormAutocompleteAttributeEmptyError, FormEmptyIdAndNameAttributesForInputError, FormAriaLabelledByToNonExistingId, FormInputAssignedAutocompleteValueToIdOrNameAttributeError, FormLabelHasNeitherForNorNestedInput, FormLabelForMatchesNonExistingIdError
+	FrameId         string `json:"frameId,omitempty"`         //
+	ViolatingNodeId int    `json:"violatingNodeId,omitempty"` //
 }
 
 // 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
 type AuditsDeprecationIssueDetails struct {
 	AffectedFrame      *AuditsAffectedFrame      `json:"affectedFrame,omitempty"` //
 	SourceCodeLocation *AuditsSourceCodeLocation `json:"sourceCodeLocation"`      //
-	Type               string                    `json:"type"`                    //  enum values: AuthorizationCoveredByWildcard, CanRequestURLHTTPContainingNewline, ChromeLoadTimesConnectionInfo, ChromeLoadTimesFirstPaintAfterLoadTime, ChromeLoadTimesWasAlternateProtocolAvailable, CookieWithTruncatingChar, CrossOriginAccessBasedOnDocumentDomain, CrossOriginWindowAlert, CrossOriginWindowConfirm, CSSSelectorInternalMediaControlsOverlayCastButton, DeprecationExample, DocumentDomainSettingWithoutOriginAgentClusterHeader, EventPath, ExpectCTHeader, GeolocationInsecureOrigin, GeolocationInsecureOriginDeprecatedNotRemoved, GetUserMediaInsecureOrigin, HostCandidateAttributeGetter, IdentityInCanMakePaymentEvent, InsecurePrivateNetworkSubresourceRequest, LegacyConstraintGoogIPv6, LocalCSSFileExtensionRejected, MediaSourceAbortRemove, MediaSourceDurationTruncatingBuffered, NavigateEventRestoreScroll, NavigateEventTransitionWhile, NoSysexWebMIDIWithoutPermission, NotificationInsecureOrigin, NotificationPermissionRequestedIframe, ObsoleteWebRtcCipherSuite, OpenWebDatabaseInsecureContext, OverflowVisibleOnReplacedElement, PersistentQuotaType, PictureSourceSrc, PrefixedCancelAnimationFrame, PrefixedRequestAnimationFrame, PrefixedStorageInfo, PrefixedVideoDisplayingFullscreen, PrefixedVideoEnterFullscreen, PrefixedVideoEnterFullScreen, PrefixedVideoExitFullscreen, PrefixedVideoExitFullScreen, PrefixedVideoSupportsFullscreen, RangeExpand, RequestedSubresourceWithEmbeddedCredentials, RTCConstraintEnableDtlsSrtpFalse, RTCConstraintEnableDtlsSrtpTrue, RTCPeerConnectionComplexPlanBSdpUsingDefaultSdpSemantics, RTCPeerConnectionSdpSemanticsPlanB, RtcpMuxPolicyNegotiate, SharedArrayBufferConstructedWithoutIsolation, TextToSpeech_DisallowedByAutoplay, V8SharedArrayBufferConstructedInExtensionWithoutIsolation, XHRJSONEncodingDetection, XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload, XRSupportsSession
+	Type               string                    `json:"type"`                    // One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5
 }
 
 // No Description.
 type AuditsFederatedAuthRequestIssueDetails struct {
-	FederatedAuthRequestIssueReason string `json:"federatedAuthRequestIssueReason"` //  enum values: ShouldEmbargo, TooManyRequests, ManifestListHttpNotFound, ManifestListNoResponse, ManifestListInvalidResponse, ManifestNotInManifestList, ManifestListTooBig, ManifestHttpNotFound, ManifestNoResponse, ManifestInvalidResponse, ClientMetadataHttpNotFound, ClientMetadataNoResponse, ClientMetadataInvalidResponse, DisabledInSettings, ErrorFetchingSignin, InvalidSigninResponse, AccountsHttpNotFound, AccountsNoResponse, AccountsInvalidResponse, IdTokenHttpNotFound, IdTokenNoResponse, IdTokenInvalidResponse, IdTokenInvalidRequest, ErrorIdToken, Canceled, RpPageNotVisible
+	FederatedAuthRequestIssueReason string `json:"federatedAuthRequestIssueReason"` //  enum values: ShouldEmbargo, TooManyRequests, WellKnownHttpNotFound, WellKnownNoResponse, WellKnownInvalidResponse, WellKnownListEmpty, ConfigNotInWellKnown, WellKnownTooBig, ConfigHttpNotFound, ConfigNoResponse, ConfigInvalidResponse, ClientMetadataHttpNotFound, ClientMetadataNoResponse, ClientMetadataInvalidResponse, DisabledInSettings, ErrorFetchingSignin, InvalidSigninResponse, AccountsHttpNotFound, AccountsNoResponse, AccountsInvalidResponse, AccountsListEmpty, IdTokenHttpNotFound, IdTokenNoResponse, IdTokenInvalidResponse, IdTokenInvalidRequest, ErrorIdToken, Canceled, RpPageNotVisible
 }
 
 // This issue tracks client hints related issues. It's used to deprecate old features, encourage the use of new ones, and provide general guidance.

v2/gcdapi/backgroundservice.go

@@ -24,6 +24,7 @@ type BackgroundServiceBackgroundServiceEvent struct {
 	EventName                   string                            `json:"eventName"`                   // A description of the event.
 	InstanceId                  string                            `json:"instanceId"`                  // An identifier that groups related events together.
 	EventMetadata               []*BackgroundServiceEventMetadata `json:"eventMetadata"`               // A list of event-specific information.
+	StorageKey                  string                            `json:"storageKey"`                  // Storage key this event belongs to.
 }
 
 // Called when the recording state for the service has been updated.