VST-2898: Update license activation logic and add logging (#2901)

Author: OlegoO

src/VirtoCommerce.Platform.Core/PlatformConstants.cs

@@ -9,6 +9,8 @@ namespace VirtoCommerce.Platform.Core
 {
     public static class PlatformConstants
     {
+        public const string UserAgent = "VirtoCommerce/3.0 (https://virtocommerce.com)";
+
         public static class Security
         {
             public static class GrantTypes

src/VirtoCommerce.Platform.Core/PlatformOptions.cs

@@ -13,7 +13,7 @@ public class PlatformOptions
 
         // The public URL for license activation
         [Url]
-        public string LicenseActivationUrl { get; set; } = "https://virtocommerce.com/admin/api/licenses/activate/";
+        public string LicenseActivationUrl { get; set; } = "https://license.virtocommerce.org/api/licenses/activate/";
 
         // Local path for license file
         public string LicenseFilePath { get; set; } = "app_data/VirtoCommerce.lic";

src/VirtoCommerce.Platform.Web/Controllers/Api/LicensingController.cs

@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using VirtoCommerce.Platform.Core;
 using VirtoCommerce.Platform.Core.Settings;
@@ -21,40 +22,67 @@ public class LicensingController : Controller
         private readonly PlatformOptions _platformOptions;
         private readonly ISettingsManager _settingsManager;
         private readonly LicenseProvider _licenseProvider;
-
-        public LicensingController(IOptions<PlatformOptions> platformOptions, ISettingsManager settingsManager, LicenseProvider licenseProvider)
+        private readonly ILogger<LicensingController> _logger;
+        private readonly IHttpClientFactory _httpClientFactory;
+
+        public LicensingController(
+            IOptions<PlatformOptions> platformOptions,
+            ISettingsManager settingsManager,
+            LicenseProvider licenseProvider,
+            ILogger<LicensingController> logger,
+            IHttpClientFactory httpClientFactory)
         {
             _platformOptions = platformOptions.Value;
             _settingsManager = settingsManager;
             _licenseProvider = licenseProvider;
+            _logger = logger;
+            _httpClientFactory = httpClientFactory;
         }
 
         [HttpPost]
         [Route("activateByCode")]
         public async Task<ActionResult<License>> ActivateByCode([FromBody] string activationCode)
         {
+            _logger.LogInformation("Activation by code started.");
+
             if (!Regex.IsMatch(activationCode, "^([a-zA-Z_0-9-])+$"))
             {
+                _logger.LogWarning("Invalid activation code");
                 return BadRequest(new { Message = $"Activation code \"{activationCode}\" is invalid" });
             }
 
             License license = null;
 
-            using (var httpClient = new HttpClient())
+            var activationUrl = new Uri(_platformOptions.LicenseActivationUrl + activationCode);
+            try
             {
-                var activationUrl = new Uri(_platformOptions.LicenseActivationUrl + activationCode);
+                var httpClient = _httpClientFactory.CreateClient();
+                httpClient.DefaultRequestHeaders.UserAgent.ParseAdd(PlatformConstants.UserAgent);
+                httpClient.DefaultRequestHeaders.Add("Accept", "*/*");
+
+                _logger.LogInformation("Sending request to activation URL: {ActivationUrl}", _platformOptions.LicenseActivationUrl);
                 var httpResponse = await httpClient.GetAsync(activationUrl);
 
                 if (httpResponse.IsSuccessStatusCode)
                 {
                     var rawLicense = await httpResponse.Content.ReadAsStringAsync();
+                    _logger.LogInformation("License content '{LicenseContent}' received successful.", rawLicense);
                     license = License.Parse(rawLicense, _platformOptions.LicensePublicKeyResourceName);
+                    _logger.LogInformation("License activation successful.");
+                }
+                else
+                {
+                    _logger.LogWarning("License activation failed using {ActivationUrl} by code with status code: {StatusCode}", _platformOptions.LicenseActivationUrl, httpResponse.StatusCode);
                 }
-            }
 
-            if (license != null)
+                if (license != null)
+                {
+                    await DisableTrial();
+                }
+            }
+            catch (Exception ex)
             {
-                await DisableTrial();
+                _logger.LogError(ex, "Error occurred during license activation using {ActivationUrl} by code.", _platformOptions.LicenseActivationUrl);
             }
 
             return Ok(license);

tests/VirtoCommerce.Platform.Web.Tests/Controllers/Api/LicensingControllerTests.cs

@@ -1,10 +1,12 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Net.Http;
 using System.Threading.Tasks;
 using AutoFixture;
 using FluentAssertions;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Moq;
 using VirtoCommerce.Platform.Core;
@@ -22,6 +24,8 @@ public class LicensingControllerTests : PlatformWebMockHelper
         private readonly Mock<IOptions<PlatformOptions>> _platformOptionsMock = new Mock<IOptions<PlatformOptions>>();
         private readonly Mock<ISettingsManager> _settingsManager = new Mock<ISettingsManager>();
         private readonly Mock<Func<IPlatformRepository>> _platformRepository = new Mock<Func<IPlatformRepository>>();
+        private readonly Mock<ILogger<LicensingController>> _logger = new Mock<ILogger<LicensingController>>();
+        private readonly Mock<IHttpClientFactory> _httpClientFactory = new Mock<IHttpClientFactory>();
         private readonly PlatformOptions platformOptions = new PlatformOptions();
         private readonly LicenseProvider _licenseProvider;
 
@@ -33,7 +37,7 @@ public LicensingControllerTests()
 
             _licenseProvider = new LicenseProvider(_platformOptionsMock.Object, _platformRepository.Object);
 
-            _controller = new LicensingController(_platformOptionsMock.Object, _settingsManager.Object, _licenseProvider);
+            _controller = new LicensingController(_platformOptionsMock.Object, _settingsManager.Object, _licenseProvider, _logger.Object, _httpClientFactory.Object);
         }
 
         [Theory]