Add GraphQL endpoint

[weirdian2k3]

This is a re-introduction of an old PR by another person, trimmed down to just the GraphQL Client and a typo-fix
#118

I'm not sure why the original one got closed, but I've succeessfully used it for making mutations with queries

	req := `mutation webPixelCreate($webPixel: WebPixelInput!) {
		webPixelCreate(webPixel: $webPixel) {
			userErrors {
				code
				field
				message
			}
			webPixel {
				settings
				id
			}
		}
	}`

	settings, err := json.Marshal(map[string]interface{}{
		"accountID": fmt.Sprintf("%d", websiteID),
	})

	if err != nil {
		return err
	}

	variables := map[string]interface{}{
		"webPixel": map[string]interface{}{
			"settings": string(settings),
		},
	}

	var foo struct {
	}

	client.GraphQL.Query(req, &variables, &foo)

[oliver006]

Thanks for the PR! I'm a bit busy this week but I'll try to review it in the next couple of days.

[codecov]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (33479a2) 100.00% compared to head (24e796a) 100.00%.

❗ Current head 24e796a differs from pull request most recent head 94d3d6b. Consider uploading reports for the commit 94d3d6b to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #228   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        45    +1     
  Lines         1930      1994   +64     
=========================================
+ Hits          1930      1994   +64     

Files Changed	Coverage Δ
carrier.go	100.00% <ø> (ø)
options.go	100.00% <ø> (ø)
goshopify.go	100.00% <100.00%> (ø)
graphql.go	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[oliver006]

Thanks for the PR, look god overall, just a couple of questions/nits.

[oliver006]

I get why we want line 84 but why do you need copy the total attempts back to the client?

attempts isn't even used for anything, it's just incremented and the tests use it to see if it matches retries. I have no context but the original PR and that already had it like this which is odd (unless it was only ever meant to be a helper for the tests)

[weirdian2k3]

From what I can tell, it was only for the tests.

So it is less confusing, I moved attempts to a return value of the method. I'm not sure anyone will have a use for the value, but it allows the tests to run without some hijacking of other variables

[oliver006]

I'm not sure anyone will have a use for the value - I agree so let's not inconvenience everyone just for the sake of the tests. Can you remove attempts as the return value?
If we really care about testing the retries then we could pass out own httpClient and count the number of times a UR is requested. Or even simpler, use httpmock.GetCallCountInfo() to get the number of calls for each URL.

[weirdian2k3]

Good call, GetCallCountInfo worked a treat

[oliver006]

I'm not sure anyone will have a use for the value - I agree so let's not inconvenience everyone just for the sake of the tests. Can you remove attempts as the return value?
If we really care about testing the retries then we could pass out own httpClient and count the number of times a UR is requested. Or even simpler, use httpmock.GetCallCountInfo() to get the number of calls for each URL.

[oliver006]

I think it's worth mentioning that Query() will retry throttled requests but not e..g any other type of 500 error.

[weirdian2k3]

To keep the concept of retry more defined, I added this comment to the WithRetry method

// WithRetry sets the number of times a request will be retried if a rate limit or service unavailable error is returned.
// Rate limiting can be either REST API limits or GraphQL Cost limits

[oliver006]

I looked at the code again and I think this is a problem.
This is not threadsafe when multiple goroutines use the same client and make requests at the same time.
The state attempts part of the client is shared across requests and can't be relied on for truthfully telling the number of attempts made.
This should be something simple to show in a test (have the mock responder wait a sec for each request and respond with "throttled", then kick off 10 requests, all with the same client, then check attempts, should be the combined number of requests or so).

I think I'd want to remove attempts altogether and for instance have an alternate/secondary version of Post that returns the number of attempts.

This might be getting a bit much for this PR, to simplify you could, as first step, replace the attempts+=... with attempts += 1 andthen we can figure out later if this needs improving.

An alternate option would be to make the retry in doGetHeaders() smarter and possibly make it aware of GraphQL. But again, that's a bigger effort and I'd be fine with the simplified +=1

[weirdian2k3]

I went with the += 1 because I'm trying to ship something that depends on this, but I'll try to loop back and do a more proper management in another PR

[oliver006]

🚀

[nickfthedev]

@weirdian2k3 Hello Ian, Thank you for creating this endpoint. However, the example above is not working in my case. I get the error "unacceptable". Maybe you stumbled across a similar error?

func GraphQLTest(c echo.Context) error {
	// Get Access Token
	t, err := utils.GetAccessToken(c)
	if err != nil {
		fmt.Printf("Error: %s\n", err.Error())
		return c.String(500, "Token Error")
	}
	fmt.Printf("Token: %s\n", t.Token)
	// Endpoint Test
	client := goshopify.NewClient(utils.ShopifyApp, t.Shopname, t.Token)

	req := `mutation webPixelCreate($webPixel: WebPixelInput!) {
		webPixelCreate(webPixel: $webPixel) {
			userErrors {
				code
				field
				message
			}
			webPixel {
				settings
				id
			}
		}
	}`

	settings, err := json.Marshal(map[string]interface{}{
		"accountID": fmt.Sprintf("%d", 12121324),
	})

	if err != nil {
		fmt.Printf("Error: %v\n", err.Error())
		return c.String(500, " Error")
	}

	variables := map[string]interface{}{
		"webPixel": map[string]interface{}{
			"settings": string(settings),
		},
	}

	var foo struct {
	}

	err = client.GraphQL.Query(req, &variables, &foo)
	if err != nil {
		fmt.Printf("Error: %v\n", err.Error())
		return c.String(500, " Error")

	}
	return c.Render(http.StatusOK, "hello.html", map[string]interface{}{})
}

[johannessteu]

Same for me, even for simple examples like { shop { name } }} i do get a Not Acceptable response

[johannessteu]

@nickfthedev i think i found it. You should set an explicit version with goshopify.WithVersion("2024-04"). The graphql api does not allow a path myshopify.com/admin/api/graphql.json but myshopify.com/admin/api/2024-04/graphql.json