feat: fetch hostname suffix from API (#103)

Fixes #49

Adds support to query the hostname suffix from Coder server, and then
propagates any changes to the agent view models.

Author: spikecurtis

App/App.xaml.cs

@@ -72,6 +72,7 @@ public App()
             new WindowsCredentialBackend(WindowsCredentialBackend.CoderCredentialsTargetName));
         services.AddSingleton<ICredentialManager, CredentialManager>();
         services.AddSingleton<IRpcController, RpcController>();
+        services.AddSingleton<IHostnameSuffixGetter, HostnameSuffixGetter>();
 
         services.AddOptions<MutagenControllerConfig>()
             .Bind(builder.Configuration.GetSection(MutagenControllerConfigSection));

App/Models/CredentialModel.cs

@@ -1,4 +1,5 @@
 using System;
+using Coder.Desktop.CoderSdk.Coder;
 
 namespace Coder.Desktop.App.Models;
 
@@ -14,7 +15,7 @@ public enum CredentialState
     Valid,
 }
 
-public class CredentialModel
+public class CredentialModel : ICoderApiClientCredentialProvider
 {
     public CredentialState State { get; init; } = CredentialState.Unknown;
 
@@ -33,4 +34,14 @@ public CredentialModel Clone()
             Username = Username,
         };
     }
+
+    public CoderApiClientCredential? GetCoderApiClientCredential()
+    {
+        if (State != CredentialState.Valid) return null;
+        return new CoderApiClientCredential
+        {
+            ApiToken = ApiToken!,
+            CoderUrl = CoderUrl!,
+        };
+    }
 }

App/Services/HostnameSuffixGetter.cs

@@ -0,0 +1,144 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Coder.Desktop.App.Models;
+using Coder.Desktop.CoderSdk.Coder;
+using Coder.Desktop.Vpn.Utilities;
+using Microsoft.Extensions.Logging;
+
+namespace Coder.Desktop.App.Services;
+
+public interface IHostnameSuffixGetter
+{
+    public event EventHandler<string> SuffixChanged;
+
+    public string GetCachedSuffix();
+}
+
+public class HostnameSuffixGetter : IHostnameSuffixGetter
+{
+    private const string DefaultSuffix = ".coder";
+
+    private readonly ICredentialManager _credentialManager;
+    private readonly ICoderApiClientFactory _clientFactory;
+    private readonly ILogger<HostnameSuffixGetter> _logger;
+
+    // _lock protects all private (non-readonly) values
+    private readonly RaiiSemaphoreSlim _lock = new(1, 1);
+    private string _domainSuffix = DefaultSuffix;
+    private bool _dirty = false;
+    private bool _getInProgress = false;
+    private CredentialModel _credentialModel = new() { State = CredentialState.Invalid };
+
+    public event EventHandler<string>? SuffixChanged;
+
+    public HostnameSuffixGetter(ICredentialManager credentialManager, ICoderApiClientFactory apiClientFactory,
+        ILogger<HostnameSuffixGetter> logger)
+    {
+        _credentialManager = credentialManager;
+        _clientFactory = apiClientFactory;
+        _logger = logger;
+        credentialManager.CredentialsChanged += HandleCredentialsChanged;
+        HandleCredentialsChanged(this, _credentialManager.GetCachedCredentials());
+    }
+
+    ~HostnameSuffixGetter()
+    {
+        _credentialManager.CredentialsChanged -= HandleCredentialsChanged;
+    }
+
+    private void HandleCredentialsChanged(object? sender, CredentialModel credentials)
+    {
+        using var _ = _lock.Lock();
+        _logger.LogDebug("credentials updated with state {state}", credentials.State);
+        _credentialModel = credentials;
+        if (credentials.State != CredentialState.Valid) return;
+
+        _dirty = true;
+        if (!_getInProgress)
+        {
+            _getInProgress = true;
+            Task.Run(Refresh).ContinueWith(MaybeRefreshAgain);
+        }
+    }
+
+    private async Task Refresh()
+    {
+        _logger.LogDebug("refreshing domain suffix");
+        CredentialModel credentials;
+        using (_ = await _lock.LockAsync())
+        {
+            credentials = _credentialModel;
+            if (credentials.State != CredentialState.Valid)
+            {
+                _logger.LogDebug("abandoning refresh because credentials are now invalid");
+                return;
+            }
+
+            _dirty = false;
+        }
+
+        var client = _clientFactory.Create(credentials);
+        using var timeoutSrc = new CancellationTokenSource(TimeSpan.FromSeconds(10));
+        var connInfo = await client.GetAgentConnectionInfoGeneric(timeoutSrc.Token);
+
+        // older versions of Coder might not set this
+        var suffix = string.IsNullOrEmpty(connInfo.HostnameSuffix)
+            ? DefaultSuffix
+            // and, it doesn't include the leading dot.
+            : "." + connInfo.HostnameSuffix;
+
+        var changed = false;
+        using (_ = await _lock.LockAsync(CancellationToken.None))
+        {
+            if (_domainSuffix != suffix) changed = true;
+            _domainSuffix = suffix;
+        }
+
+        if (changed)
+        {
+            _logger.LogInformation("got new domain suffix '{suffix}'", suffix);
+            // grab a local copy of the EventHandler to avoid TOCTOU race on the `?.` null-check
+            var del = SuffixChanged;
+            del?.Invoke(this, suffix);
+        }
+        else
+        {
+            _logger.LogDebug("domain suffix unchanged '{suffix}'", suffix);
+        }
+    }
+
+    private async Task MaybeRefreshAgain(Task prev)
+    {
+        if (prev.IsFaulted)
+        {
+            _logger.LogError(prev.Exception, "failed to query domain suffix");
+            // back off here before retrying. We're just going to use a fixed, long
+            // delay since this just affects UI stuff; we're not in a huge rush as
+            // long as we eventually get the right value.
+            await Task.Delay(TimeSpan.FromSeconds(10));
+        }
+
+        using var l = await _lock.LockAsync(CancellationToken.None);
+        if ((_dirty || prev.IsFaulted) && _credentialModel.State == CredentialState.Valid)
+        {
+            // we still have valid credentials and we're either dirty or the last Get failed.
+            _logger.LogDebug("retrying domain suffix query");
+            _ = Task.Run(Refresh).ContinueWith(MaybeRefreshAgain);
+            return;
+        }
+
+        // Getting here means either the credentials are not valid or we don't need to
+        // refresh anyway.
+        // The next time we get new, valid credentials, HandleCredentialsChanged will kick off
+        // a new Refresh
+        _getInProgress = false;
+        return;
+    }
+
+    public string GetCachedSuffix()
+    {
+        using var _ = _lock.Lock();
+        return _domainSuffix;
+    }
+}

App/ViewModels/TrayWindowViewModel.cs

@@ -35,6 +35,7 @@ public partial class TrayWindowViewModel : ObservableObject, IAgentExpanderHost
     private readonly IRpcController _rpcController;
     private readonly ICredentialManager _credentialManager;
     private readonly IAgentViewModelFactory _agentViewModelFactory;
+    private readonly IHostnameSuffixGetter _hostnameSuffixGetter;
 
     private FileSyncListWindow? _fileSyncListWindow;
 
@@ -91,15 +92,14 @@ public partial class TrayWindowViewModel : ObservableObject, IAgentExpanderHost
 
     [ObservableProperty] public partial string DashboardUrl { get; set; } = DefaultDashboardUrl;
 
-    private string _hostnameSuffix = DefaultHostnameSuffix;
-
     public TrayWindowViewModel(IServiceProvider services, IRpcController rpcController,
-        ICredentialManager credentialManager, IAgentViewModelFactory agentViewModelFactory)
+        ICredentialManager credentialManager, IAgentViewModelFactory agentViewModelFactory, IHostnameSuffixGetter hostnameSuffixGetter)
     {
         _services = services;
         _rpcController = rpcController;
         _credentialManager = credentialManager;
         _agentViewModelFactory = agentViewModelFactory;
+        _hostnameSuffixGetter = hostnameSuffixGetter;
 
         // Since the property value itself never changes, we add event
         // listeners for the underlying collection changing instead.
@@ -139,6 +139,9 @@ public void Initialize(DispatcherQueue dispatcherQueue)
 
         _credentialManager.CredentialsChanged += (_, credentialModel) => UpdateFromCredentialModel(credentialModel);
         UpdateFromCredentialModel(_credentialManager.GetCachedCredentials());
+
+        _hostnameSuffixGetter.SuffixChanged += (_, suffix) => HandleHostnameSuffixChanged(suffix);
+        HandleHostnameSuffixChanged(_hostnameSuffixGetter.GetCachedSuffix());
     }
 
     private void UpdateFromRpcModel(RpcModel rpcModel)
@@ -195,7 +198,7 @@ private void UpdateFromRpcModel(RpcModel rpcModel)
                 this,
                 uuid,
                 fqdn,
-                _hostnameSuffix,
+                _hostnameSuffixGetter.GetCachedSuffix(),
                 connectionStatus,
                 credentialModel.CoderUrl,
                 workspace?.Name));
@@ -214,7 +217,7 @@ private void UpdateFromRpcModel(RpcModel rpcModel)
                 // Workspace ID is fine as a stand-in here, it shouldn't
                 // conflict with any agent IDs.
                 uuid,
-                _hostnameSuffix,
+                _hostnameSuffixGetter.GetCachedSuffix(),
                 AgentConnectionStatus.Gray,
                 credentialModel.CoderUrl,
                 workspace.Name));
@@ -273,6 +276,22 @@ private void UpdateFromCredentialModel(CredentialModel credentialModel)
         DashboardUrl = credentialModel.CoderUrl?.ToString() ?? DefaultDashboardUrl;
     }
 
+    private void HandleHostnameSuffixChanged(string suffix)
+    {
+        // Ensure we're on the UI thread.
+        if (_dispatcherQueue == null) return;
+        if (!_dispatcherQueue.HasThreadAccess)
+        {
+            _dispatcherQueue.TryEnqueue(() => HandleHostnameSuffixChanged(suffix));
+            return;
+        }
+
+        foreach (var agent in Agents)
+        {
+            agent.ConfiguredHostnameSuffix = suffix;
+        }
+    }
+
     public void VpnSwitch_Toggled(object sender, RoutedEventArgs e)
     {
         if (sender is not ToggleSwitch toggleSwitch) return;

CoderSdk/Coder/CoderApiClient.cs

@@ -49,6 +49,7 @@ public partial interface ICoderApiClient
     public void SetSessionToken(string token);
 }
 
+[JsonSerializable(typeof(AgentConnectionInfo))]
 [JsonSerializable(typeof(BuildInfo))]
 [JsonSerializable(typeof(Response))]
 [JsonSerializable(typeof(User))]

CoderSdk/Coder/WorkspaceAgents.cs

@@ -3,6 +3,14 @@ namespace Coder.Desktop.CoderSdk.Coder;
 public partial interface ICoderApiClient
 {
     public Task<WorkspaceAgent> GetWorkspaceAgent(string id, CancellationToken ct = default);
+    public Task<AgentConnectionInfo> GetAgentConnectionInfoGeneric(CancellationToken ct = default);
+}
+
+public class AgentConnectionInfo
+{
+    public string HostnameSuffix { get; set; } = string.Empty;
+    // note that we're leaving out several fields including the DERP Map because
+    // we don't use that information, and it's a complex object to define.
 }
 
 public class WorkspaceAgent
@@ -35,4 +43,9 @@ public Task<WorkspaceAgent> GetWorkspaceAgent(string id, CancellationToken ct =
     {
         return SendRequestNoBodyAsync<WorkspaceAgent>(HttpMethod.Get, "/api/v2/workspaceagents/" + id, ct);
     }
+
+    public Task<AgentConnectionInfo> GetAgentConnectionInfoGeneric(CancellationToken ct = default)
+    {
+        return SendRequestNoBodyAsync<AgentConnectionInfo>(HttpMethod.Get, "/api/v2/workspaceagents/connection", ct);
+    }
 }