Implement DnsZoneQueryResult to report success or failure as well as the zone list

webprofusion-chrisc · webprofusion-chrisc · commit 0e98726e65d1 · 2025-07-11T17:25:30.000+08:00
diff --git a/src/Certify.Client/CertifyApiClient.cs b/src/Certify.Client/CertifyApiClient.cs
@@ -10,6 +10,7 @@
 using Certify.Models;
 using Certify.Models.Config;
 using Certify.Models.Hub;
+using Certify.Models.Providers;
 using Certify.Models.Reporting;
 using Certify.Models.Utils;
 using Certify.Shared;
@@ -574,10 +575,10 @@ public async Task<List<StatusMessage>> PerformChallengeCleanup(ManagedCertificat
             var response = await PostAsync($"managedcertificates/challengecleanup", site, authContext);
             return JsonConvert.DeserializeObject<List<StatusMessage>>(await response.Content.ReadAsStringAsync());
         }
-        public async Task<List<Models.Providers.DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null)
+        public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null)
         {
             var json = await FetchAsync($"managedcertificates/dnszones/{providerTypeId}/{credentialId}", authContext);
-            return JsonConvert.DeserializeObject<List<Models.Providers.DnsZone>>(json);
+            return JsonConvert.DeserializeObject<DnsZoneQueryResult>(json);
         }
 
         public async Task<List<ActionStep>> PreviewActions(ManagedCertificate site, AuthContext authContext = null)
diff --git a/src/Certify.Client/ICertifyClient.cs b/src/Certify.Client/ICertifyClient.cs
@@ -4,6 +4,7 @@
 using Certify.Models;
 using Certify.Models.Config;
 using Certify.Models.Hub;
+using Certify.Models.Providers;
 using Certify.Models.Reporting;
 using Certify.Models.Utils;
 using Certify.Shared;
@@ -71,7 +72,7 @@ public partial interface ICertifyInternalApiClient
         Task<CertificateRequestResult> BeginCertificateRequest(string managedItemId, bool resumePaused, bool isInteractive, AuthContext authContext = null);
         Task<List<StatusMessage>> TestChallengeConfiguration(ManagedCertificate site, AuthContext authContext = null);
         Task<List<StatusMessage>> PerformChallengeCleanup(ManagedCertificate site, AuthContext authContext = null);
-        Task<List<Models.Providers.DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null);
+        Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null);
         Task<List<ActionStep>> PreviewActions(ManagedCertificate site, AuthContext authContext = null);
         Task<List<ChallengeProviderDefinition>> GetChallengeAPIList(AuthContext authContext = null);
         Task<List<DeploymentProviderDefinition>> GetDeploymentProviderList(AuthContext authContext = null);
diff --git a/src/Certify.Core/Management/CertifyManager/CertifyManager.ManagedCertificates.cs b/src/Certify.Core/Management/CertifyManager/CertifyManager.ManagedCertificates.cs
@@ -701,21 +701,39 @@ public async Task<ActionResult<byte[]>> ExportCertificate(string managedCertId,
             }
         }
 
-        public async Task<List<DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId)
+        public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId)
         {
             var dnsHelper = new Core.Management.Challenges.DnsChallengeHelper(_credentialsManager);
 
             var result = await dnsHelper.GetDnsProvider(providerTypeId, credentialId, null, _credentialsManager, _serviceLog);
 
             if (result.Provider != null)
             {
-                var list = await result.Provider.GetZones();
-
-                return list?.OrderBy(x => x.Name).ToList();
+                try
+                {
+                    var list = await result.Provider.GetZones();
+                    return new DnsZoneQueryResult
+                    {
+                        IsSuccess = true,
+                        Result = list?.OrderBy(x => x.Name).ToList() ?? []
+                    };
+                }
+                catch (Exception exp)
+                {
+                    return new DnsZoneQueryResult
+                    {
+                        IsSuccess = false,
+                        Message = $"Failed to Get DNS Zones using provider {result.Provider.ProviderTitle} : {exp.Message}"
+                    };
+                }
             }
             else
             {
-                return new List<DnsZone>();
+                return new DnsZoneQueryResult
+                {
+                    IsSuccess = false,
+                    Message = $"Failed to create provider while fetching DNS Zones using {result.Provider?.ProviderTitle ?? providerTypeId}"
+                };
             }
         }
 
diff --git a/src/Certify.Core/Management/Challenges/DNS/DnsChallengeHelper.cs b/src/Certify.Core/Management/Challenges/DNS/DnsChallengeHelper.cs
@@ -178,24 +178,14 @@ public async Task<DnsChallengeHelperResult> CompleteDNSChallenge(ILog log, Manag
             }
             catch (Exception exp)
             {
-                return new DnsChallengeHelperResult($"DNS Challenge API Provider could not be created. Check all required credentials are set. {exp.ToString()}");
+                return new DnsChallengeHelperResult($"DNS Challenge API Provider could not be created. Check all required credentials are set. {exp}");
             }
 
             if (dnsAPIProvider == null)
             {
                 return new DnsChallengeHelperResult("DNS Challenge API Provider not set or not recognised. Select an API to proceed.");
             }
 
-            if (isTestMode && !dnsAPIProvider.IsTestModeSupported)
-            {
-                return new DnsChallengeHelperResult
-                {
-                    Result = new ActionResult { IsSuccess = true, Message = dnsAPIProvider.ProviderTitle + " does not perform any tests." },
-                    PropagationSeconds = 0,
-                    IsAwaitingUser = false
-                };
-            }
-
             string zoneId = null;
             if (parameters != null && parameters.ContainsKey("zoneid"))
             {
diff --git a/src/Certify.Models/Providers/ICertifyManager.cs b/src/Certify.Models/Providers/ICertifyManager.cs
@@ -41,7 +41,7 @@ public interface ICertifyManager
         Task<List<StatusMessage>> TestChallenge(ILog log, ManagedCertificate managedCertificate, bool isPreviewMode, IProgress<RequestProgressState>? progress = null);
         Task<List<StatusMessage>> PerformChallengeCleanup(ILog log, ManagedCertificate managedCertificate, IProgress<RequestProgressState>? progress = null);
         Task<List<ActionResult>> PerformServiceDiagnostics();
-        Task<List<DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId);
+        Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId);
         Task<ActionResult> UpdateCertificateAuthority(CertificateAuthority certificateAuthority);
         Task<List<CertificateAuthority>> GetCertificateAuthorities();
         Task<StatusMessage> RevokeCertificate(ILog log, ManagedCertificate managedCertificate);
diff --git a/src/Certify.Models/Providers/IDnsProvider.cs b/src/Certify.Models/Providers/IDnsProvider.cs
@@ -6,6 +6,16 @@
 
 namespace Certify.Models.Providers
 {
+    public class DnsZoneQueryResult : ActionResult<ICollection<DnsZone>>
+    {
+        public DnsZoneQueryResult()
+        {
+        }
+        public DnsZoneQueryResult(string msg, bool isSuccess, ICollection<DnsZone> result = null)
+            : base(msg, isSuccess, result)
+        {
+        }
+    }
     public class DnsZone
     {
         public string ZoneId { get; set; }
diff --git a/src/Certify.Server/Certify.Server.Core/Certify.Server.Core/Controllers/ManagedCertificateController.cs b/src/Certify.Server/Certify.Server.Core/Certify.Server.Core/Controllers/ManagedCertificateController.cs
@@ -3,6 +3,7 @@
 using Certify.Models;
 using Certify.Models.Config;
 using Certify.Models.Hub;
+using Certify.Models.Providers;
 using Certify.Models.Reporting;
 using Certify.Models.Utils;
 using Microsoft.AspNetCore.Mvc;
@@ -301,7 +302,7 @@ public async Task<List<SimpleAuthorizationChallengeItem>> GetCurrentChallenges(s
         }
 
         [HttpGet, Route("dnszones/{providerTypeId}/{credentialId}")]
-        public async Task<List<Models.Providers.DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId) => await _certifyManager.GetDnsProviderZones(providerTypeId, credentialId);
+        public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId) => await _certifyManager.GetDnsProviderZones(providerTypeId, credentialId);
 
         [HttpGet, Route("maintenance/{id?}")]
         public async Task<List<Models.Config.ActionResult>> PerformCertMaintenanceTasks(string id = null)
diff --git a/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementAPI.cs b/src/Certify.Server/Certify.Server.Hub.Api/Services/ManagementAPI.cs
@@ -1,4 +1,4 @@
-using System.Text.Json;
+﻿using System.Text.Json;
 using Certify.Client;
 using Certify.Models;
 using Certify.Models.Config;
@@ -464,15 +464,15 @@ public async Task<StatusSummary> GetManagedCertificateSummary(AuthContext? curre
         /// <param name="credentialId">The credential identifier.</param>
         /// <param name="currentAuthContext">The current authentication context.</param>
         /// <returns>A collection of <see cref="Models.Providers.DnsZone"/> objects, or null if none found.</returns>
-        public async Task<ICollection<Models.Providers.DnsZone>?> GetDnsZones(string instanceId, string providerTypeId, string credentialId, AuthContext? currentAuthContext)
+        public async Task<DnsZoneQueryResult?> GetDnsZones(string instanceId, string providerTypeId, string credentialId, AuthContext? currentAuthContext)
         {
             var args = new KeyValuePair<string, string>[] {
                         new("instanceId", instanceId),
                         new("providerTypeId", providerTypeId),
                         new("credentialId", credentialId)
                     };
 
-            return await PerformInstanceCommandTaskWithResult<ICollection<DnsZone>>(instanceId, args, ManagementHubCommands.GetDnsZones);
+            return await PerformInstanceCommandTaskWithResult<DnsZoneQueryResult>(instanceId, args, ManagementHubCommands.GetDnsZones);
         }
 
         /// <summary>
diff --git a/src/Certify.Server/Certify.Server.HubService/Services/CertifyDirectHubService.cs b/src/Certify.Server/Certify.Server.HubService/Services/CertifyDirectHubService.cs
@@ -131,7 +131,7 @@ private ServiceControllers.TagController _tagController(AuthContext authContext)
         public Task<List<ProviderDefinition>> GetDataStoreProviders(AuthContext? authContext = null) => throw new NotImplementedException();
         public Task<DeploymentProviderDefinition> GetDeploymentProviderDefinition(string id, DeploymentTaskConfig config, AuthContext? authContext = null) => throw new NotImplementedException();
         public Task<List<DeploymentProviderDefinition>> GetDeploymentProviderList(AuthContext? authContext = null) => throw new NotImplementedException();
-        public Task<List<DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext? authContext = null) => throw new NotImplementedException();
+
         public Task<LogItem[]> GetItemLog(string id, int limit, AuthContext? authContext = null) => throw new NotImplementedException();
         public Task<ManagedCertificate> GetManagedCertificate(string managedItemId, AuthContext? authContext = null) => throw new NotImplementedException();
         public Task<List<ManagedCertificate>> GetManagedCertificates(ManagedCertificateFilter filter, AuthContext? authContext = null) => throw new NotImplementedException();
@@ -173,6 +173,7 @@ private ServiceControllers.TagController _tagController(AuthContext authContext)
 
         public Task<ActionResult> AddHubItemTag(ItemTag tag, AuthContext authContext) => _tagController(authContext).AddTag(tag);
         public Task<ICollection<ItemTag>> GetHubItemTags(AuthContext authContext) => _tagController(authContext).GetTags();
+        public Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext? authContext = null) => throw new NotImplementedException();
 
 #pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
     }
diff --git a/src/Certify.Service/Controllers/ManagedCertificateController.cs b/src/Certify.Service/Controllers/ManagedCertificateController.cs
@@ -9,6 +9,7 @@
 using Certify.Models;
 using Certify.Models.Config;
 using Certify.Models.Hub;
+using Certify.Models.Providers;
 using Certify.Models.Reporting;
 using Certify.Models.Utils;
 using Microsoft.Extensions.Logging;
@@ -306,7 +307,7 @@ public async Task<List<SimpleAuthorizationChallengeItem>> GetCurrentChallenges(s
         }
 
         [HttpGet, Route("dnszones/{providerTypeId}/{credentialId}")]
-        public async Task<List<Models.Providers.DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId) => await _certifyManager.GetDnsProviderZones(providerTypeId, credentialId);
+        public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId) => await _certifyManager.GetDnsProviderZones(providerTypeId, credentialId);
 
         [HttpGet, Route("maintenance/{id?}")]
         public async Task<List<Models.Config.ActionResult>> PerformCertMaintenanceTasks(string id = null)
diff --git a/src/Certify.SourceGenerators/ApiMethods.cs b/src/Certify.SourceGenerators/ApiMethods.cs
@@ -1,4 +1,4 @@
-using System;
+﻿using System;
 using System.Collections.Generic;
 using System.Linq;
 using Certify.Models;
@@ -608,7 +608,7 @@ public static List<GeneratedAPI> GetApiDefinitions()
                     UseManagementAPI = true,
                     PublicAPIController = "ChallengeProvider",
                     PublicAPIRoute = "{instanceId}/dnszones/{providerTypeId}/{credentialId}",
-                    ReturnType = "ICollection<Certify.Models.Providers.DnsZone>",
+                    ReturnType = "Certify.Models.Providers.DnsZoneQueryResult",
                     Params = new Dictionary<string, string>
                     {
                         { "instanceId", "string" },
diff --git a/src/Certify.UI.Shared/Controls/ManagedCertificate/ChallengeConfigItem.xaml.cs b/src/Certify.UI.Shared/Controls/ManagedCertificate/ChallengeConfigItem.xaml.cs
@@ -172,12 +172,22 @@ private async Task RefreshDnsZoneLookup()
                 });
 
                 // fetch dns zone list from api 
-                var zones = await AppViewModel.GetDnsProviderZones(EditModel.SelectedItem.ChallengeProvider, EditModel.SelectedItem.ChallengeCredentialKey);
+                var zonesResult = await AppViewModel.GetDnsProviderZones(EditModel.SelectedItem.ChallengeProvider, EditModel.SelectedItem.ChallengeCredentialKey);
 
-                // populate dropdown, default to no selection
-                zones.Insert(0, new Models.Providers.DnsZone { ZoneId = "", Name = "(Select Zone)" });
-                EditModel.DnsZones = new ObservableCollection<Models.Providers.DnsZone>(zones);
-                DnsZoneList.SelectedValue = "";
+                if (zonesResult.IsSuccess)
+                {
+                    var zones = zonesResult.Result.ToList();
+
+                    // populate dropdown, default to no selection
+                    zones.Insert(0, new Models.Providers.DnsZone { ZoneId = "", Name = "(Select Zone)" });
+                    EditModel.DnsZones = new ObservableCollection<Models.Providers.DnsZone>(zones);
+                    DnsZoneList.SelectedValue = "";
+                }
+                else
+                {
+                    // if we can't get zones, show error
+                    MessageBox.Show($"Unable to fetch DNS Zones for this provider. Check credentials are correctly set: {zonesResult.Message}");
+                }
             }
             catch (Exception)
             {
diff --git a/src/Certify.UI.Shared/ViewModel/AppViewModel/AppViewModel.Config.cs b/src/Certify.UI.Shared/ViewModel/AppViewModel/AppViewModel.Config.cs
@@ -17,7 +17,7 @@ public partial class AppViewModel : BindableBase
         /// <summary>
         /// Cached list of known certificate authorities
         /// </summary>
-        public ObservableCollection<CertificateAuthority> CertificateAuthorities = new ObservableCollection<CertificateAuthority>();
+        public ObservableCollection<CertificateAuthority> CertificateAuthorities = [];
 
         /// <summary>
         /// Refresh cached list of Certificate Authorities
@@ -235,7 +235,7 @@ public async Task RefreshStoredCredentialsList()
 
             if (StoredCredentials == null)
             {
-                StoredCredentials = new ObservableCollection<StoredCredential>();
+                StoredCredentials = [];
                 System.Windows.Data.BindingOperations.EnableCollectionSynchronization(StoredCredentials, _storedCredentialsLock);
             }
 
@@ -271,12 +271,12 @@ public async Task RefreshChallengeAPIList()
         /// <param name="challengeProvider"></param>
         /// <param name="challengeCredentialKey"></param>
         /// <returns></returns>
-        public async Task<List<DnsZone>> GetDnsProviderZones(string challengeProvider, string challengeCredentialKey) => await _certifyClient.GetDnsProviderZones(challengeProvider, challengeCredentialKey);
+        public async Task<DnsZoneQueryResult> GetDnsProviderZones(string challengeProvider, string challengeCredentialKey) => await _certifyClient.GetDnsProviderZones(challengeProvider, challengeCredentialKey);
 
         /// <summary>
         /// Cached list of Deployment Task types
         /// </summary>
-        public ObservableCollection<DeploymentProviderDefinition> DeploymentTaskProviders { get; set; } = new ObservableCollection<DeploymentProviderDefinition> { };
+        public ObservableCollection<DeploymentProviderDefinition> DeploymentTaskProviders { get; set; } = [];
 
         /// <summary>
         /// Refresh cached list of deployment task types via service
@@ -354,7 +354,7 @@ internal async Task<List<ProviderDefinition>> GetDataStoreProviders()
         }
 
         /// <summary>
-        /// Get the current configured data store conenctions to choose from
+        /// Get the current configured data store connections to choose from
         /// </summary>
         /// <returns></returns>
         internal async Task<List<DataStoreConnection>> GetDataStoreConnections()

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`using Certify.Models;`
`11`	`11`	`using Certify.Models.Config;`
`12`	`12`	`using Certify.Models.Hub;`
	`13`	`+using Certify.Models.Providers;`
`13`	`14`	`using Certify.Models.Reporting;`
`14`	`15`	`using Certify.Models.Utils;`
`15`	`16`	`using Certify.Shared;`
`@@ -574,10 +575,10 @@ public async Task<List<StatusMessage>> PerformChallengeCleanup(ManagedCertificat`
`574`	`575`	`var response = await PostAsync($"managedcertificates/challengecleanup", site, authContext);`
`575`	`576`	`return JsonConvert.DeserializeObject<List<StatusMessage>>(await response.Content.ReadAsStringAsync());`
`576`	`577`	`}`
`577`		`- public async Task<List<Models.Providers.DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null)`
	`578`	`+ public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId, AuthContext authContext = null)`
`578`	`579`	`{`
`579`	`580`	`var json = await FetchAsync($"managedcertificates/dnszones/{providerTypeId}/{credentialId}", authContext);`
`580`		`- return JsonConvert.DeserializeObject<List<Models.Providers.DnsZone>>(json);`
	`581`	`+ return JsonConvert.DeserializeObject<DnsZoneQueryResult>(json);`
`581`	`582`	`}`
`582`	`583`
`583`	`584`	`public async Task<List<ActionStep>> PreviewActions(ManagedCertificate site, AuthContext authContext = null)`
Original file line number	Diff line number	Diff line change
`@@ -701,21 +701,39 @@ public async Task<ActionResult<byte[]>> ExportCertificate(string managedCertId,`
`701`	`701`	`}`
`702`	`702`	`}`
`703`	`703`
`704`		`- public async Task<List<DnsZone>> GetDnsProviderZones(string providerTypeId, string credentialId)`
	`704`	`+ public async Task<DnsZoneQueryResult> GetDnsProviderZones(string providerTypeId, string credentialId)`
`705`	`705`	`{`
`706`	`706`	`var dnsHelper = new Core.Management.Challenges.DnsChallengeHelper(_credentialsManager);`
`707`	`707`
`708`	`708`	`var result = await dnsHelper.GetDnsProvider(providerTypeId, credentialId, null, _credentialsManager, _serviceLog);`
`709`	`709`
`710`	`710`	`if (result.Provider != null)`
`711`	`711`	`{`
`712`		`- var list = await result.Provider.GetZones();`
`713`		`-`
`714`		`- return list?.OrderBy(x => x.Name).ToList();`
	`712`	`+ try`
	`713`	`+ {`
	`714`	`+ var list = await result.Provider.GetZones();`
	`715`	`+ return new DnsZoneQueryResult`
	`716`	`+ {`
	`717`	`+ IsSuccess = true,`
	`718`	`+ Result = list?.OrderBy(x => x.Name).ToList() ?? []`
	`719`	`+ };`
	`720`	`+ }`
	`721`	`+ catch (Exception exp)`
	`722`	`+ {`
	`723`	`+ return new DnsZoneQueryResult`
	`724`	`+ {`
	`725`	`+ IsSuccess = false,`
	`726`	`+ Message = $"Failed to Get DNS Zones using provider {result.Provider.ProviderTitle} : {exp.Message}"`
	`727`	`+ };`
	`728`	`+ }`
`715`	`729`	`}`
`716`	`730`	`else`
`717`	`731`	`{`
`718`		`- return new List<DnsZone>();`
	`732`	`+ return new DnsZoneQueryResult`
	`733`	`+ {`
	`734`	`+ IsSuccess = false,`
	`735`	`+ Message = $"Failed to create provider while fetching DNS Zones using {result.Provider?.ProviderTitle ?? providerTypeId}"`
	`736`	`+ };`
`719`	`737`	`}`
`720`	`738`	`}`
`721`	`739`
Original file line number	Diff line number	Diff line change
`@@ -178,24 +178,14 @@ public async Task<DnsChallengeHelperResult> CompleteDNSChallenge(ILog log, Manag`
`178`	`178`	`}`
`179`	`179`	`catch (Exception exp)`
`180`	`180`	`{`
`181`		`- return new DnsChallengeHelperResult($"DNS Challenge API Provider could not be created. Check all required credentials are set. {exp.ToString()}");`
	`181`	`+ return new DnsChallengeHelperResult($"DNS Challenge API Provider could not be created. Check all required credentials are set. {exp}");`
`182`	`182`	`}`
`183`	`183`
`184`	`184`	`if (dnsAPIProvider == null)`
`185`	`185`	`{`
`186`	`186`	`return new DnsChallengeHelperResult("DNS Challenge API Provider not set or not recognised. Select an API to proceed.");`
`187`	`187`	`}`
`188`	`188`
`189`		`- if (isTestMode && !dnsAPIProvider.IsTestModeSupported)`
`190`		`- {`
`191`		`- return new DnsChallengeHelperResult`
`192`		`- {`
`193`		`- Result = new ActionResult { IsSuccess = true, Message = dnsAPIProvider.ProviderTitle + " does not perform any tests." },`
`194`		`- PropagationSeconds = 0,`
`195`		`- IsAwaitingUser = false`
`196`		`- };`
`197`		`- }`
`198`		`-`
`199`	`189`	`string zoneId = null;`
`200`	`190`	`if (parameters != null && parameters.ContainsKey("zoneid"))`
`201`	`191`	`{`