archive
/
tailscale
mirror of https://github.com/tailscale/tailscale/
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

health: prefix Warnables received from the control plane

Browse Source 
Updates tailscale/corp#27759

Signed-off-by: James Sanderson <jsanderson@tailscale.com>
pull/16289/head
James Sanderson 6 months ago committed by James 'zofrex' Sanderson
parent 7b06532ea1
commit 5716d0977d
5 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File

2
control/controlclient/map.go
Unescape Escape View File

@ -853,7 +853,7 @@ func (ms *mapSession) netmap() *netmap.NetworkMap {
} else if len(ms.lastHealth) > 0 {
// Convert all ms.lastHealth to the new [netmap.NetworkMap.DisplayMessages]
for _, h := range ms.lastHealth {
id := "control-health-" + strhash(h) // Unique ID in case there is more than one health message
id := "health-" + strhash(h) // Unique ID in case there is more than one health message
mak.Set(&msgs, tailcfg.DisplayMessageID(id), tailcfg.DisplayMessage{
Title: "Coordination server reports an issue",
Severity: tailcfg.SeverityMedium,

12
control/controlclient/map_test.go
Unescape Escape View File

@ -1340,14 +1340,14 @@ func TestNetmapHealthIntegration(t *testing.T) {
ht.SetControlHealth(nm.DisplayMessages)
want := map[health.WarnableCode]health.UnhealthyState{
"control-health-c0719e9a8d5d838d861dc6f675c899d2b309a3a65bb9fe6b11e5afcbf9a2c0b1": {
WarnableCode: "control-health-c0719e9a8d5d838d861dc6f675c899d2b309a3a65bb9fe6b11e5afcbf9a2c0b1",
"control-health.health-c0719e9a8d5d838d861dc6f675c899d2b309a3a65bb9fe6b11e5afcbf9a2c0b1": {
WarnableCode: "control-health.health-c0719e9a8d5d838d861dc6f675c899d2b309a3a65bb9fe6b11e5afcbf9a2c0b1",
Title: "Coordination server reports an issue",
Severity: health.SeverityMedium,
Text: "The coordination server is reporting a health issue: Test message",
},
"control-health-1dc7017a73a3c55c0d6a8423e3813c7ab6562d9d3064c2ec6ac7822f61b1db9c": {
WarnableCode: "control-health-1dc7017a73a3c55c0d6a8423e3813c7ab6562d9d3064c2ec6ac7822f61b1db9c",
"control-health.health-1dc7017a73a3c55c0d6a8423e3813c7ab6562d9d3064c2ec6ac7822f61b1db9c": {
WarnableCode: "control-health.health-1dc7017a73a3c55c0d6a8423e3813c7ab6562d9d3064c2ec6ac7822f61b1db9c",
Title: "Coordination server reports an issue",
Severity: health.SeverityMedium,
Text: "The coordination server is reporting a health issue: Another message",
@ -1401,8 +1401,8 @@ func TestNetmapDisplayMessageIntegration(t *testing.T) {
}
want := map[health.WarnableCode]health.UnhealthyState{
"test-message": {
WarnableCode: "test-message",
"control-health.test-message": {
WarnableCode: "control-health.test-message",
Title: "Testing",
Text: "This is a test message",
Severity: health.SeverityHigh,

18
health/health_test.go
Unescape Escape View File

@ -468,14 +468,14 @@ func TestControlHealth(t *testing.T) {
baseStrs := ht.Strings()
msgs := map[tailcfg.DisplayMessageID]tailcfg.DisplayMessage{
"control-health-test": {
"test": {
Title: "Control health message",
Text: "Extra help.",
},
"control-health-title": {
"title": {
Title: "Control health title only",
},
"control-health-with-action": {
"with-action": {
Title: "Control health message",
Text: "Extra help.",
PrimaryAction: &tailcfg.DisplayMessageAction{
@ -488,19 +488,19 @@ func TestControlHealth(t *testing.T) {
t.Run("Warnings", func(t *testing.T) {
wantWarns := map[WarnableCode]UnhealthyState{
"control-health-test": {
WarnableCode: "control-health-test",
"control-health.test": {
WarnableCode: "control-health.test",
Severity: SeverityMedium,
Title: "Control health message",
Text: "Extra help.",
},
"control-health-title": {
WarnableCode: "control-health-title",
"control-health.title": {
WarnableCode: "control-health.title",
Severity: SeverityMedium,
Title: "Control health title only",
},
"control-health-with-action": {
WarnableCode: "control-health-with-action",
"control-health.with-action": {
WarnableCode: "control-health.with-action",
Severity: SeverityMedium,
Title: "Control health message",
Text: "Extra help.",

2
health/state.go
Unescape Escape View File

@ -112,7 +112,7 @@ func (t *Tracker) CurrentState() *State {
for id, msg := range t.lastNotifiedControlMessages {
state := UnhealthyState{
WarnableCode: WarnableCode(id),
WarnableCode: WarnableCode("control-health." + id),
Severity: severityFromTailcfg(msg.Severity),
Title: msg.Title,
Text: msg.Text,

26
ipn/ipnlocal/local_test.go
Unescape Escape View File

@ -8,6 +8,7 @@ import (
"encoding/json"
"errors"
"fmt"
"maps"
"math"
"net"
"net/http"
@ -5422,10 +5423,11 @@ func TestDisplayMessages(t *testing.T) {
})
state := ht.CurrentState()
_, ok := state.Warnings["test-message"]
wantID := health.WarnableCode("control-health.test-message")
_, ok := state.Warnings[wantID]
if !ok {
t.Error("no warning found with id 'test-message'")
t.Errorf("no warning found with id %q", wantID)
}
}
@ -5455,14 +5457,15 @@ func TestDisplayMessagesURLFilter(t *testing.T) {
})
state := ht.CurrentState()
got, ok := state.Warnings["test-message"]
wantID := health.WarnableCode("control-health.test-message")
got, ok := state.Warnings[wantID]
if !ok {
t.Fatal("no warning found with id 'test-message'")
t.Fatalf("no warning found with id %q", wantID)
}
want := health.UnhealthyState{
WarnableCode: "test-message",
WarnableCode: wantID,
Title: "Testing",
Severity: health.SeverityHigh,
}
@ -5494,12 +5497,14 @@ func TestDisplayMessageIPNBus(t *testing.T) {
},
}
wantID := health.WarnableCode("control-health.test-message")
for _, tt := range []test{
{
name: "older-client-no-actions",
mask: 0,
wantWarning: health.UnhealthyState{
WarnableCode: "test-message",
WarnableCode: wantID,
Severity: health.SeverityMedium,
Title: "Message title",
Text: "Message text. Learn more: https://example.com", // PrimaryAction appended to text
@ -5510,7 +5515,7 @@ func TestDisplayMessageIPNBus(t *testing.T) {
name: "new-client-with-actions",
mask: ipn.NotifyHealthActions,
wantWarning: health.UnhealthyState{
WarnableCode: "test-message",
WarnableCode: wantID,
Severity: health.SeverityMedium,
Title: "Message title",
Text: "Message text.",
@ -5530,17 +5535,20 @@ func TestDisplayMessageIPNBus(t *testing.T) {
ipnWatcher := newNotificationWatcher(t, lb, nil)
ipnWatcher.watch(tt.mask, []wantedNotification{{
name: "test",
name: fmt.Sprintf("warning with ID %q", wantID),
cond: func(_ testing.TB, _ ipnauth.Actor, n *ipn.Notify) bool {
if n.Health == nil {
return false
}
got, ok := n.Health.Warnings["test-message"]
got, ok := n.Health.Warnings[wantID]
if ok {
if diff := cmp.Diff(tt.wantWarning, got); diff != "" {
t.Errorf("unexpected warning details (-want/+got):\n%s", diff)
return true // we failed the test so tell the watcher we've seen what we need to to stop it waiting
}
} else {
got := slices.Collect(maps.Keys(n.Health.Warnings))
t.Logf("saw warnings: %v", got)
}
return ok
},

Write Preview
Loading…
Cancel
Save