Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add redirect to ThemeKit Access when password prefix matches pattern #933

Merged
merged 2 commits into from
May 5, 2021
Merged

Add redirect to ThemeKit Access when password prefix matches pattern #933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
518bae8
Add redirect to ThemeKit Access when password prefix matches pattern
d-koval May 4, 2021
6d8255a
Make themeKitAccessURL a variable and update it in unit tests
d-koval May 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/httpify/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import (
"github.com/Shopify/themekit/src/release"
)

const themeKitPasswordPrefix = "shptka_"

var (
// ErrConnectionIssue is an error that is thrown when a very specific error is
// returned from our http request that usually implies bad connections.
Expand All @@ -27,6 +29,7 @@ var (
httpClient = &http.Client{
Timeout: 30 * time.Second,
}
themeKitAccessURL = "https://theme-kit-access.shopifyapps.com/cli"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either make this a constant variable and use it in the Client struct changing the struct in your tests, OR make this a var and reference it in the do method, and alter the var in the tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the second approach, in that way we avoid modifying HTTPClient struct altogether

)

type proxyHandler func(*http.Request) (*url.URL, error)
Expand Down Expand Up @@ -103,7 +106,15 @@ func (client *HTTPClient) Delete(path string, headers map[string]string) (*http.

// do will issue an authenticated json request to shopify.
func (client *HTTPClient) do(method, path string, body interface{}, headers map[string]string) (*http.Response, error) {
req, err := http.NewRequest(method, client.baseURL.String()+path, nil)
appBaseURL := client.baseURL.String()

// redirect to Theme Kit Access
if strings.HasPrefix(client.password, themeKitPasswordPrefix) {
appBaseURL = themeKitAccessURL
}

req, err := http.NewRequest(method, appBaseURL+path, nil)

if err != nil {
return nil, err
}
Expand All @@ -112,6 +123,9 @@ func (client *HTTPClient) do(method, path string, body interface{}, headers map[
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("User-Agent", fmt.Sprintf("go/themekit (%s; %s; %s)", runtime.GOOS, runtime.GOARCH, release.ThemeKitVersion.String()))
if strings.HasPrefix(client.password, themeKitPasswordPrefix) {
req.Header.Add("X-Shopify-Shop", client.domain)
}
for label, value := range headers {
req.Header.Add(label, value)
}
Expand Down
44 changes: 44 additions & 0 deletions src/httpify/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,50 @@ func TestClient_do(t *testing.T) {
_, err = client.do("POST", "/assets.json", body, nil)
assert.Contains(t, err.Error(), "request failed after 1 retries", server.URL)
server.Close()

// Client should query Theme Kit Access server instead of Shopify when password starts with a prefix "shptka_"
shopifyServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))

themeKitAccessServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
assert.Equal(t, r.Header.Get("X-Shopify-Shop"), client.domain)
}))

client, err = NewClient(Params{
Domain: shopifyServer.URL,
Password: "shptka_00000000000000000000000000000000",
})
themeKitAccessURL = themeKitAccessServer.URL

assert.NotNil(t, client)
assert.Nil(t, err)

resp, err = client.Post("/assets.json", body, map[string]string{"X-Custom-Header": "Checksum"})
assert.Nil(t, err)
assert.NotNil(t, resp)

server.Close()

// Client should query Shopify instead of Theme Kit Access server when password has no specified prefix
shopifyServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
assert.Empty(t, r.Header.Get("X-Shopify-Shop"))
}))

themeKitAccessServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))

client, err = NewClient(Params{
Domain: shopifyServer.URL,
Password: "secret_password",
})
themeKitAccessURL = themeKitAccessServer.URL

assert.NotNil(t, client)
assert.Nil(t, err)

resp, err = client.Post("/assets.json", body, map[string]string{"X-Custom-Header": "Checksum"})
assert.Nil(t, err)
assert.NotNil(t, resp)

server.Close()
}

func TestGenerateHTTPAdapter(t *testing.T) {
Expand Down