Merge pull request #196 from umbraco/feature/shopify-oauth

acoumb · web-flow · commit 21ad4f021659 · 2024-06-20T10:05:21.000+03:00
Shopify OAuth fixes
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/App_Plugins/UmbracoCms.Integrations/Commerce/Shopify/js/productPickerSettings.controller.js b/src/Umbraco.Cms.Integrations.Commerce.Shopify/App_Plugins/UmbracoCms.Integrations/Commerce/Shopify/js/productPickerSettings.controller.js
@@ -62,11 +62,11 @@
 
     function validateOAuthSetup() {
         umbracoCmsIntegrationsCommerceShopifyResource.validateAccessToken().then(function (response) {
-
             vm.oauthSetup = {
-                isConnected: response.isValid,
+                isValid: response.isValid,
+                isConnected: response.isConnected,
                 isAccessTokenExpired: response.isExpired,
-                isAccessTokenValid: response.isValid
+                isAccessTokenValid: response.isConnected
             }
 
             if (vm.oauthSetup.isConnected === true && vm.oauthSetup.isAccessTokenValid === true) {
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Controllers/ProductsController.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Controllers/ProductsController.cs
@@ -50,7 +50,7 @@ public ProductsController(IShopifyService apiService, AuthorizationImplementatio
         }
 
         [HttpGet]
-        public EditorSettings CheckConfiguration() => _apiService.GetApiConfiguration();
+        public async Task<EditorSettings> CheckConfiguration() => await _apiService.GetApiConfiguration();
 
         [HttpGet]
         public string GetAuthorizationUrl() => _authorizationService.GetAuthorizationUrl();
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Models/EditorSettings.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Models/EditorSettings.cs
@@ -12,6 +12,9 @@ public EditorSettings()
         [JsonProperty("isValid")]
         public bool IsValid { get; set; }
 
+        [JsonProperty("isConnected")]
+        public bool IsConnected { get; set; }
+
         [JsonProperty("type")]
         public ConfigurationType Type { get; set; }
     }
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/BaseAuthorizationService.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/BaseAuthorizationService.cs
@@ -16,8 +16,7 @@ public class BaseAuthorizationService
         protected const string ShopifyAuthorizationUrl = "https://{0}.myshopify.com/admin/oauth/authorize" +
             "?client_id={1}" +
             "&redirect_uri={2}" +
-            "&scope=read_products" +
-            "&grant_options[]=value";
+            "&scope=read_products";
 
         public BaseAuthorizationService(ITokenService tokenService)
         {
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/IShopifyService.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/IShopifyService.cs
@@ -7,7 +7,7 @@ namespace Umbraco.Cms.Integrations.Commerce.Shopify.Services
 {
     public interface IShopifyService
     {
-        EditorSettings GetApiConfiguration();
+        Task<EditorSettings> GetApiConfiguration();
 
         Task<ResponseDto<ProductsListDto>> ValidateAccessToken();
 
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/ShopifyService.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Services/ShopifyService.cs
@@ -93,7 +93,7 @@ public ShopifyService(ILogger logger, ITokenService tokenService)
         }
 #endif
 
-        public EditorSettings GetApiConfiguration()
+        public async Task<EditorSettings> GetApiConfiguration()
         {
             if (string.IsNullOrEmpty(_settings.Shop)
                 || string.IsNullOrEmpty(_settings.ApiVersion))
@@ -105,14 +105,27 @@ public EditorSettings GetApiConfiguration()
 
             // validate OAuth configuration if AuthorizationService is used.
             // if authorization is managed through UmbracoAuthorizationService, the properties client ID and proxy URL are set correctly.
+            var accessTokenValidationResponse = await ValidateAccessToken();
             if (_settings.UseUmbracoAuthorization)
-                return new EditorSettings { IsValid = true, Type = ConfigurationType.OAuth };
+            {
+                var editorSettings = new EditorSettings { IsValid = true, Type = ConfigurationType.OAuth };
+
+                editorSettings.IsConnected = accessTokenValidationResponse.IsValid;
+
+                return editorSettings;
+            }
             else
+            {
                 return !string.IsNullOrEmpty(_oauthSettings.ClientId)
                         && !string.IsNullOrEmpty(_oauthSettings.ClientSecret)
                         && !string.IsNullOrEmpty(_oauthSettings.RedirectUri)
-                        ? new EditorSettings { IsValid = true, Type = ConfigurationType.OAuth }
+                        ? new EditorSettings { 
+                            IsValid = true,
+                            IsConnected = accessTokenValidationResponse.IsValid, 
+                            Type = ConfigurationType.OAuth 
+                        }
                         : new EditorSettings();
+            }
         }
 
         public async Task<ResponseDto<ProductsListDto>> ValidateAccessToken()
@@ -146,13 +159,15 @@ public async Task<ResponseDto<ProductsListDto>> ValidateAccessToken()
 
         public void RevokeAccessToken()
         {
-            _tokenService.RemoveParameters(Constants.Configuration.UmbracoCmsIntegrationsCommerceShopifyAccessToken);
+            _tokenService.RemoveParameters(Constants.AccessTokenDbKey);
         }
 
         public async Task<ResponseDto<ProductsListDto>> GetResults(string pageInfo)
         {
             string accessToken;
-            if (GetApiConfiguration().Type.Value == ConfigurationType.OAuth.Value)
+
+            var apiConfiguration = await GetApiConfiguration();
+            if (apiConfiguration.Type.Value == ConfigurationType.OAuth.Value)
                 _tokenService.TryGetParameters(Constants.AccessTokenDbKey, out accessToken);
             else
             {
@@ -210,7 +225,8 @@ public async Task<ResponseDto<ProductsListDto>> GetResults(string pageInfo)
         public async Task<ResponseDto<ProductsListDto>> GetProductsByIds(long[] ids)
         {
             string accessToken;
-            if (GetApiConfiguration().Type.Value == ConfigurationType.OAuth.Value)
+            var apiConfiguration = await GetApiConfiguration();
+            if (apiConfiguration.Type.Value == ConfigurationType.OAuth.Value)
                 _tokenService.TryGetParameters(Constants.AccessTokenDbKey, out accessToken);
             else
             {
@@ -260,7 +276,8 @@ public async Task<ResponseDto<ProductsListDto>> GetProductsByIds(long[] ids)
         public async Task<int> GetCount()
         {
             string accessToken;
-            if (GetApiConfiguration().Type.Value == ConfigurationType.OAuth.Value)
+            var apiConfiguration = await GetApiConfiguration();
+            if (apiConfiguration.Type.Value == ConfigurationType.OAuth.Value)
                 _tokenService.TryGetParameters(Constants.AccessTokenDbKey, out accessToken);
             else
             {
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Umbraco.Cms.Integrations.Commerce.Shopify.csproj b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Umbraco.Cms.Integrations.Commerce.Shopify.csproj
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFrameworks>net472;net50;net60;net70;net80</TargetFrameworks>
+		<TargetFrameworks>net472;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
 	</PropertyGroup>
 
 	<PropertyGroup>
@@ -10,7 +10,7 @@
 		<PackageIconUrl></PackageIconUrl>
 		<PackageProjectUrl>https://github.com/umbraco/Umbraco.Cms.Integrations/blob/main/src/Umbraco.Cms.Integrations.Commerce.Shopify</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/umbraco/Umbraco.Cms.Integrations</RepositoryUrl>
-		<Version>1.2.0</Version>
+		<Version>1.2.1</Version>
 		<Authors>Umbraco HQ</Authors>
 		<Company>Umbraco</Company>
 		<PackageTags>Umbraco;Umbraco-Marketplace</PackageTags>
@@ -22,22 +22,22 @@
 		<PackageReference Include="UmbracoCms.Web" version="8.5.4" />
 	</ItemGroup>
 
-	<ItemGroup Condition="'$(TargetFramework)' == 'net50'">
+	<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
 		<PackageReference Include="Umbraco.Cms.Web.Website" version="[9.0.1,10)" />
 		<PackageReference Include="Umbraco.Cms.Web.BackOffice" version="[9.0.1,10)" />
 	</ItemGroup>
 
-	<ItemGroup Condition="'$(TargetFramework)' == 'net60'">
+	<ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
 		<PackageReference Include="Umbraco.Cms.Web.Website" version="[10.0.0,11)" />
 		<PackageReference Include="Umbraco.Cms.Web.BackOffice" version="[10.0.0,11)" />
 	</ItemGroup>
 
-	<ItemGroup Condition="'$(TargetFramework)' == 'net70'">
+	<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
 		<PackageReference Include="Umbraco.Cms.Web.Website" version="[11.0.0,13)" />
 		<PackageReference Include="Umbraco.Cms.Web.BackOffice" version="[11.0.0,13)" />
 	</ItemGroup>
 	
-	<ItemGroup Condition="'$(TargetFramework)' == 'net80'">
+	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
 		<PackageReference Include="Umbraco.Cms.Web.Website" version="[13.0.0,14)" />
 		<PackageReference Include="Umbraco.Cms.Web.BackOffice" version="[13.0.0,14)" />
 	</ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public ProductsController(IShopifyService apiService, AuthorizationImplementatio`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`[HttpGet]`
`53`		`- public EditorSettings CheckConfiguration() => _apiService.GetApiConfiguration();`
	`53`	`+ public async Task<EditorSettings> CheckConfiguration() => await _apiService.GetApiConfiguration();`
`54`	`54`
`55`	`55`	`[HttpGet]`
`56`	`56`	`public string GetAuthorizationUrl() => _authorizationService.GetAuthorizationUrl();`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@ public EditorSettings()`
`12`	`12`	`[JsonProperty("isValid")]`
`13`	`13`	`public bool IsValid { get; set; }`
`14`	`14`
	`15`	`+ [JsonProperty("isConnected")]`
	`16`	`+ public bool IsConnected { get; set; }`
	`17`	`+`
`15`	`18`	`[JsonProperty("type")]`
`16`	`19`	`public ConfigurationType Type { get; set; }`
`17`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,7 @@ public class BaseAuthorizationService`
`16`	`16`	`protected const string ShopifyAuthorizationUrl = "https://{0}.myshopify.com/admin/oauth/authorize" +`
`17`	`17`	`"?client_id={1}" +`
`18`	`18`	`"&redirect_uri={2}" +`
`19`		`- "&scope=read_products" +`
`20`		`- "&grant_options[]=value";`
	`19`	`+ "&scope=read_products";`
`21`	`20`
`22`	`21`	`public BaseAuthorizationService(ITokenService tokenService)`
`23`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace Umbraco.Cms.Integrations.Commerce.Shopify.Services`
`7`	`7`	`{`
`8`	`8`	`public interface IShopifyService`
`9`	`9`	`{`
`10`		`- EditorSettings GetApiConfiguration();`
	`10`	`+ Task<EditorSettings> GetApiConfiguration();`
`11`	`11`
`12`	`12`	`Task<ResponseDto<ProductsListDto>> ValidateAccessToken();`
`13`	`13`