Skip to content

chore: added latency tooltips on workspaces #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 26, 2025
+187 −35
Merged

chore: added latency tooltips on workspaces #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c77369b
chore: added latency tooltips on workspaces
ibetitsmike Jun 23, 2025
b05f081
Merge branch 'main' of github.com:coder/coder-desktop-windows into mi…
ibetitsmike Jun 24, 2025
419dcb2
PR fixes
ibetitsmike Jun 24, 2025
d1b2c7d
added connecting state and improved the logic on tooltip generation
ibetitsmike Jun 24, 2025
8fbbff0
PR review
ibetitsmike Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 124 additions & 19 deletions App/ViewModels/AgentViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Windows.ApplicationModel.DataTransfer;
using Coder.Desktop.App.Services;
using Coder.Desktop.App.Utils;
using Coder.Desktop.CoderSdk;
Expand All @@ -18,15 +10,24 @@
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Controls.Primitives;
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Xml.Linq;
using Windows.ApplicationModel.DataTransfer;

namespace Coder.Desktop.App.ViewModels;

public interface IAgentViewModelFactory
{
public AgentViewModel Create(IAgentExpanderHost expanderHost, Uuid id, string fullyQualifiedDomainName,
string hostnameSuffix,
AgentConnectionStatus connectionStatus, Uri dashboardBaseUrl, string? workspaceName);

string hostnameSuffix, AgentConnectionStatus connectionStatus, Uri dashboardBaseUrl,
string? workspaceName, bool? didP2p, string? preferredDerp, TimeSpan? latency, TimeSpan? preferredDerpLatency, DateTime? lastHandshake);
public AgentViewModel CreateDummy(IAgentExpanderHost expanderHost, Uuid id,
string hostnameSuffix,
AgentConnectionStatus connectionStatus, Uri dashboardBaseUrl, string workspaceName);
Expand All @@ -40,7 +41,9 @@ public class AgentViewModelFactory(
{
public AgentViewModel Create(IAgentExpanderHost expanderHost, Uuid id, string fullyQualifiedDomainName,
string hostnameSuffix,
AgentConnectionStatus connectionStatus, Uri dashboardBaseUrl, string? workspaceName)
AgentConnectionStatus connectionStatus, Uri dashboardBaseUrl,
string? workspaceName, bool? didP2p, string? preferredDerp, TimeSpan? latency, TimeSpan? preferredDerpLatency,
DateTime? lastHandshake)
{
return new AgentViewModel(childLogger, coderApiClientFactory, credentialManager, agentAppViewModelFactory,
expanderHost, id)
Expand All @@ -51,6 +54,11 @@ public AgentViewModel Create(IAgentExpanderHost expanderHost, Uuid id, string fu
ConnectionStatus = connectionStatus,
DashboardBaseUrl = dashboardBaseUrl,
WorkspaceName = workspaceName,
DidP2p = didP2p,
PreferredDerp = preferredDerp,
Latency = latency,
PreferredDerpLatency = preferredDerpLatency,
LastHandshake = lastHandshake,
};
}

Expand All @@ -73,10 +81,25 @@ public AgentViewModel CreateDummy(IAgentExpanderHost expanderHost, Uuid id,

public enum AgentConnectionStatus
{
Green,
Yellow,
Red,
Gray,
Healthy,
Connecting,
Unhealthy,
NoRecentHandshake,
Offline
}

public static class AgentConnectionStatusExtensions
{
public static string ToDisplayString(this AgentConnectionStatus status) =>
status switch
{
AgentConnectionStatus.Healthy => "Healthy",
AgentConnectionStatus.Connecting => "Connecting",
AgentConnectionStatus.Unhealthy => "High latency",
AgentConnectionStatus.NoRecentHandshake => "No recent handshake",
AgentConnectionStatus.Offline => "Offline",
_ => status.ToString()
};
}

public partial class AgentViewModel : ObservableObject, IModelUpdateable<AgentViewModel>
Expand Down Expand Up @@ -160,6 +183,7 @@ public string FullyQualifiedDomainName
[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ShowExpandAppsMessage))]
[NotifyPropertyChangedFor(nameof(ExpandAppsMessage))]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public required partial AgentConnectionStatus ConnectionStatus { get; set; }

[ObservableProperty]
Expand All @@ -182,6 +206,77 @@ public string FullyQualifiedDomainName
[NotifyPropertyChangedFor(nameof(ExpandAppsMessage))]
public partial bool AppFetchErrored { get; set; } = false;

[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public partial bool? DidP2p { get; set; } = false;

[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public partial string? PreferredDerp { get; set; } = null;

[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public partial TimeSpan? Latency { get; set; } = null;

[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public partial TimeSpan? PreferredDerpLatency { get; set; } = null;

[ObservableProperty]
[NotifyPropertyChangedFor(nameof(ConnectionTooltip))]
public partial DateTime? LastHandshake { get; set; } = null;

public string ConnectionTooltip
{
get
{
var description = new StringBuilder();
var highLatencyWarning = ConnectionStatus == AgentConnectionStatus.Unhealthy ? $"({AgentConnectionStatus.Unhealthy.ToDisplayString()})" : "";

if (DidP2p != null && DidP2p.Value && Latency != null)
{
description.Append($"""
You're connected peer-to-peer. {highLatencyWarning}
You ↔ {Latency.Value.Milliseconds} ms ↔ {WorkspaceName}
"""
);
}
else if (Latency != null)
{
description.Append($"""
You're connected through a DERP relay. {highLatencyWarning}
We'll switch over to peer-to-peer when available.
Total latency: {Latency.Value.Milliseconds} ms
"""
);

if (PreferredDerpLatency != null)
{
description.Append($"\nYou ↔ {PreferredDerp}: {PreferredDerpLatency.Value.Milliseconds} ms");

var derpToWorkspaceEstimatedLatency = Latency - PreferredDerpLatency;

// Guard against negative values if the two readings were taken at different times
if (derpToWorkspaceEstimatedLatency > TimeSpan.Zero)
{
description.Append($"\n{PreferredDerp} ms ↔ {WorkspaceName}: {derpToWorkspaceEstimatedLatency.Value.Milliseconds} ms");
}
}
}
else
{
description.Append(ConnectionStatus.ToDisplayString());
}
if (LastHandshake != null)
description.Append($"\n\nLast handshake: {LastHandshake?.ToString()}");

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a relative timestamp (i.e. 5 seconds ago) here but I actually gotta get rid of it, so this is fine.
( Have to get rid of it cause it only gets rendered once, and doesn't update on tooltip re-hovers 😦 )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I check for Default and set to null in the viewmodel cause showing a made up handshake just felt wrong.

return description.ToString().TrimEnd('\n', ' '); ;
}
}


// We only show 6 apps max, which fills the entire width of the tray
// window.
public IEnumerable<AgentAppViewModel> VisibleApps => Apps.Count > MaxAppsPerRow ? Apps.Take(MaxAppsPerRow) : Apps;
Expand All @@ -192,7 +287,7 @@ public string? ExpandAppsMessage
{
get
{
if (ConnectionStatus == AgentConnectionStatus.Gray)
if (ConnectionStatus == AgentConnectionStatus.Offline)
return "Your workspace is offline.";
if (FetchingApps && Apps.Count == 0)
// Don't show this message if we have any apps already. When
Expand Down Expand Up @@ -285,6 +380,16 @@ public bool TryApplyChanges(AgentViewModel model)
DashboardBaseUrl = model.DashboardBaseUrl;
if (WorkspaceName != model.WorkspaceName)
WorkspaceName = model.WorkspaceName;
if (DidP2p != model.DidP2p)
DidP2p = model.DidP2p;
if (PreferredDerp != model.PreferredDerp)
PreferredDerp = model.PreferredDerp;
if (Latency != model.Latency)
Latency = model.Latency;
if (PreferredDerpLatency != model.PreferredDerpLatency)
PreferredDerpLatency = model.PreferredDerpLatency;
if (LastHandshake != model.LastHandshake)
LastHandshake = model.LastHandshake;

// Apps are not set externally.

Expand All @@ -307,7 +412,7 @@ public void SetExpanded(bool expanded)

partial void OnConnectionStatusChanged(AgentConnectionStatus oldValue, AgentConnectionStatus newValue)
{
if (IsExpanded && newValue is not AgentConnectionStatus.Gray) FetchApps();
if (IsExpanded && newValue is not AgentConnectionStatus.Offline) FetchApps();
}

private void FetchApps()
Expand All @@ -316,7 +421,7 @@ private void FetchApps()
FetchingApps = true;

// If the workspace is off, then there's no agent and there's no apps.
if (ConnectionStatus == AgentConnectionStatus.Gray)
if (ConnectionStatus == AgentConnectionStatus.Offline)
{
FetchingApps = false;
Apps.Clear();
Expand Down
41 changes: 33 additions & 8 deletions App/ViewModels/TrayWindowViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Linq;
using System.Security.Principal;
using System.Threading.Tasks;
using Coder.Desktop.App.Models;
using Coder.Desktop.App.Services;
Expand All @@ -29,6 +30,7 @@ public partial class TrayWindowViewModel : ObservableObject, IAgentExpanderHost
{
private const int MaxAgents = 5;
private const string DefaultDashboardUrl = "https://coder.com";
private readonly TimeSpan HealthyPingThreshold = TimeSpan.FromMilliseconds(150);

private readonly IServiceProvider _services;
private readonly IRpcController _rpcController;
Expand Down Expand Up @@ -222,10 +224,28 @@ private void UpdateFromRpcModel(RpcModel rpcModel)
if (string.IsNullOrWhiteSpace(fqdn))
continue;

var lastHandshakeAgo = DateTime.UtcNow.Subtract(agent.LastHandshake.ToDateTime());
var connectionStatus = lastHandshakeAgo < TimeSpan.FromMinutes(5)
? AgentConnectionStatus.Green
: AgentConnectionStatus.Yellow;
var connectionStatus = AgentConnectionStatus.Healthy;

if (agent.LastHandshake != null && agent.LastHandshake.ToDateTime() != default && agent.LastHandshake.ToDateTime() < DateTime.UtcNow)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

{
// For compatibility with older deployments, we assume that if the
// last ping is null, the agent is healthy.
var isLatencyAcceptable = agent.LastPing == null || agent.LastPing.Latency.ToTimeSpan() < HealthyPingThreshold;

var lastHandshakeAgo = DateTime.UtcNow.Subtract(agent.LastHandshake.ToDateTime());

if (lastHandshakeAgo > TimeSpan.FromMinutes(5))
connectionStatus = AgentConnectionStatus.NoRecentHandshake;
else if (!isLatencyAcceptable)
connectionStatus = AgentConnectionStatus.Unhealthy;
}
else
{
// If the last handshake is not correct (null, default or in the future),
// we assume the agent is connecting (yellow status icon).
connectionStatus = AgentConnectionStatus.Connecting;
}

workspacesWithAgents.Add(agent.WorkspaceId);
var workspace = rpcModel.Workspaces.FirstOrDefault(w => w.Id == agent.WorkspaceId);

Expand All @@ -236,7 +256,12 @@ private void UpdateFromRpcModel(RpcModel rpcModel)
_hostnameSuffixGetter.GetCachedSuffix(),
connectionStatus,
credentialModel.CoderUrl,
workspace?.Name));
workspace?.Name,
agent.LastPing?.DidP2P,
agent.LastPing?.PreferredDerp,
agent.LastPing?.Latency?.ToTimeSpan(),
agent.LastPing?.PreferredDerpLatency?.ToTimeSpan(),
agent.LastHandshake != null && agent.LastHandshake.ToDateTime() != default ? agent.LastHandshake?.ToDateTime() : null));
}

// For every stopped workspace that doesn't have any agents, add a
Expand All @@ -253,7 +278,7 @@ private void UpdateFromRpcModel(RpcModel rpcModel)
// conflict with any agent IDs.
uuid,
_hostnameSuffixGetter.GetCachedSuffix(),
AgentConnectionStatus.Gray,
AgentConnectionStatus.Offline,
credentialModel.CoderUrl,
workspace.Name));
}
Expand All @@ -268,7 +293,7 @@ private void UpdateFromRpcModel(RpcModel rpcModel)

if (Agents.Count < MaxAgents) ShowAllAgents = false;

var firstOnlineAgent = agents.FirstOrDefault(a => a.ConnectionStatus != AgentConnectionStatus.Gray);
var firstOnlineAgent = agents.FirstOrDefault(a => a.ConnectionStatus != AgentConnectionStatus.Offline);
if (firstOnlineAgent is null)
_hasExpandedAgent = false;
if (!_hasExpandedAgent && firstOnlineAgent is not null)
Expand Down Expand Up @@ -433,7 +458,7 @@ private static bool ShouldShowDummy(Workspace workspace)
case Workspace.Types.Status.Stopping:
case Workspace.Types.Status.Stopped:
return true;
// TODO: should we include and show a different color than Gray for workspaces that are
// TODO: should we include and show a different color than Offline for workspaces that are
// failed, canceled or deleting?
default:
return false;
Expand Down
14 changes: 10 additions & 4 deletions App/Views/Pages/TrayWindowMainPage.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,22 +137,27 @@
x:Key="StatusColor"
SelectedKey="{x:Bind Path=ConnectionStatus, Mode=OneWay}">

<converters:StringToBrushSelectorItem>
<converters:StringToBrushSelectorItem Key="Offline">
<converters:StringToBrushSelectorItem.Value>
<SolidColorBrush Color="#8e8e93" />
</converters:StringToBrushSelectorItem.Value>
</converters:StringToBrushSelectorItem>
<converters:StringToBrushSelectorItem Key="Red">
<converters:StringToBrushSelectorItem Key="NoRecentHandshake">
<converters:StringToBrushSelectorItem.Value>
<SolidColorBrush Color="#ff3b30" />
</converters:StringToBrushSelectorItem.Value>
</converters:StringToBrushSelectorItem>
<converters:StringToBrushSelectorItem Key="Yellow">
<converters:StringToBrushSelectorItem Key="Unhealthy">
<converters:StringToBrushSelectorItem.Value>
<SolidColorBrush Color="#ffcc01" />
</converters:StringToBrushSelectorItem.Value>
</converters:StringToBrushSelectorItem>
<converters:StringToBrushSelectorItem Key="Green">
<converters:StringToBrushSelectorItem Key="Connecting">
<converters:StringToBrushSelectorItem.Value>
<SolidColorBrush Color="#ffcc01" />
</converters:StringToBrushSelectorItem.Value>
</converters:StringToBrushSelectorItem>
<converters:StringToBrushSelectorItem Key="Healthy">
<converters:StringToBrushSelectorItem.Value>
<SolidColorBrush Color="#34c759" />
</converters:StringToBrushSelectorItem.Value>
Expand Down Expand Up @@ -189,6 +194,7 @@
HorizontalAlignment="Right"
VerticalAlignment="Center"
Height="14" Width="14"
ToolTipService.ToolTip="{x:Bind ConnectionTooltip, Mode=OneWay}"
Margin="0,1,0,0">

<Ellipse
Expand Down
24 changes: 20 additions & 4 deletions Vpn.Proto/vpn.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ option go_package = "github.com/coder/coder/v2/vpn";
option csharp_namespace = "Coder.Desktop.Vpn.Proto";

import "google/protobuf/timestamp.proto";
import "google/protobuf/duration.proto";

package vpn;

Expand Down Expand Up @@ -48,10 +49,10 @@ message TunnelMessage {
message ClientMessage {
RPC rpc = 1;
oneof msg {
StartRequest start = 2;
StopRequest stop = 3;
StatusRequest status = 4;
}
StartRequest start = 2;
StopRequest stop = 3;
StatusRequest status = 4;
}
}

// ServiceMessage is a message from the service (to the client). Windows only.
Expand Down Expand Up @@ -131,6 +132,21 @@ message Agent {
// last_handshake is the primary indicator of whether we are connected to a peer. Zero value or
// anything longer than 5 minutes ago means there is a problem.
google.protobuf.Timestamp last_handshake = 6;
// If unset, a successful ping has not yet been made.
optional LastPing last_ping = 7;
}

message LastPing {
// latency is the RTT of the ping to the agent.
google.protobuf.Duration latency = 1;
// did_p2p indicates whether the ping was sent P2P, or over DERP.
bool did_p2p = 2;
// preferred_derp is the human readable name of the preferred DERP region,
// or the region used for the last ping, if it was sent over DERP.
string preferred_derp = 3;
// preferred_derp_latency is the last known latency to the preferred DERP
// region. Unset if the region does not appear in the DERP map.
optional google.protobuf.Duration preferred_derp_latency = 4;
}

// NetworkSettingsRequest is based on
Expand Down
Loading