Better comments in ShopifyAuthorizationService.IsValidMyShopifyUrl

Problem

The ShopifySharp.ShopifyAuthorizationService.IsValidMyShopifyUrl should have some changes in the comments.

A developer calling this method can guess wrongly these points:

• There is no remote calls in the method so there is no performance or delay penalty
• The method can ensure 100% that the shop url is valid. (But a fake website can also return a X-ShopId in the header parameters, so the method IsValidMyShopifyUrl will return true).

The original comment is:

 /// <summary>
/// A convenience function that tries to ensure that a given URL is a valid Shopify store by checking the response headers for X-ShopId.
/// </summary>

Solution

I propose to explain that the method actually make a request to the shop url. This is important because the caller of this method can know that will be a small time penalty becauseof the http request. And also explain about faking the headers.

This is just an example.

/// <summary>
/// A convenience function that tries to ensure that a given URL is a valid Shopify store by making a request to the shop url and checking the response headers for X-ShopId.
/// Take into account that a fake website could return the X-ShopId header.
/// </summary>

I would like to hear from you what do you think.

Thanks.

[nozzlegear]

Renamed to IsValidShopDomainAsync in c982781.

[nozzlegear]

I’m working on pushing through the final changes for v4 right now, and after reviewing this again I think I’m going to go with your original suggestion to improve the documentation and rename the function to IsValidMyShopifyUrlAsync @ernestogutierrez.

I liked your idea for pulling in the Shop’s Shop object to check its domain or myshopify domain property, but it didn’t occur to me at the time that we would need an access token to do so, at which point we already know that the URL must have been correct.

I’ll make sure I add documentation to the current function that the domain could fake the shop id header.