Skip to content

chore: add setStatus support to nodeUpdater #11568

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 1 commit into from
Jan 17, 2024
Merged

chore: add setStatus support to nodeUpdater #11568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions tailnet/node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ import (
"context"
"net/netip"
"sync"
"time"

"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
"tailscale.com/tailcfg"
"tailscale.com/types/key"
"tailscale.com/wgengine"

"cdr.dev/slog"
"github.com/coder/coder/v2/coderd/database/dbtime"
Expand All @@ -32,6 +34,7 @@ type nodeUpdater struct {
derpForcedWebsockets map[int]string
endpoints []string
addresses []netip.Prefix
lastStatus time.Time
}

// updateLoop waits until the config is dirty and then calls the callback with the newest node.
Expand Down Expand Up @@ -146,3 +149,30 @@ func (u *nodeUpdater) setDERPForcedWebsocket(region int, reason string) {
u.Broadcast()
}
}

// setStatus handles the status callback from the wireguard engine to learn about new endpoints
// (e.g. discovered by STUN)
func (u *nodeUpdater) setStatus(s *wgengine.Status, err error) {
u.logger.Debug(context.Background(), "wireguard status", slog.F("status", s), slog.Error(err))
if err != nil {
return
}
u.L.Lock()
defer u.L.Unlock()
if s.AsOf.Before(u.lastStatus) {
// Don't process outdated status!
return
}
u.lastStatus = s.AsOf
endpoints := make([]string, len(s.LocalAddrs))
for i, ep := range s.LocalAddrs {
endpoints[i] = ep.Addr.String()
}
if slices.Equal(endpoints, u.endpoints) {
// No need to update the node if nothing changed!
return
}
u.endpoints = endpoints
u.dirty = true
u.Broadcast()
}
178 changes: 178 additions & 0 deletions tailnet/node_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
package tailnet

import (
"net/netip"
"testing"
"time"

"golang.org/x/xerrors"

"golang.org/x/exp/slices"

"tailscale.com/wgengine"

"github.com/stretchr/testify/require"
"golang.org/x/exp/maps"
Expand Down Expand Up @@ -183,3 +191,173 @@ func TestNodeUpdater_setDERPForcedWebsocket_same(t *testing.T) {
}()
_ = testutil.RequireRecvCtx(ctx, t, done)
}

func TestNodeUpdater_setStatus_different(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
id := tailcfg.NodeID(1)
nodeKey := key.NewNode().Public()
discoKey := key.NewDisco().Public()
nodeCh := make(chan *Node)
uut := newNodeUpdater(
logger,
func(n *Node) {
nodeCh <- n
},
id, nodeKey, discoKey,
)
defer uut.close()

// Given: preferred DERP is 1, so we'll send an update
uut.L.Lock()
uut.preferredDERP = 1
uut.L.Unlock()

// When: we set a new status
asof := time.Date(2024, 1, 10, 8, 0o0, 1, 1, time.UTC)
uut.setStatus(&wgengine.Status{
LocalAddrs: []tailcfg.Endpoint{
{Addr: netip.MustParseAddrPort("[fe80::1]:5678")},
},
AsOf: asof,
}, nil)

// Then: we receive an update with the endpoint
node := testutil.RequireRecvCtx(ctx, t, nodeCh)
require.Equal(t, nodeKey, node.Key)
require.Equal(t, discoKey, node.DiscoKey)
require.True(t, slices.Equal([]string{"[fe80::1]:5678"}, node.Endpoints))

// Then: we store the AsOf time as lastStatus
uut.L.Lock()
require.Equal(t, uut.lastStatus, asof)
uut.L.Unlock()

done := make(chan struct{})
go func() {
defer close(done)
uut.close()
}()
_ = testutil.RequireRecvCtx(ctx, t, done)
}

func TestNodeUpdater_setStatus_same(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
id := tailcfg.NodeID(1)
nodeKey := key.NewNode().Public()
discoKey := key.NewDisco().Public()
nodeCh := make(chan *Node)
uut := newNodeUpdater(
logger,
func(n *Node) {
nodeCh <- n
},
id, nodeKey, discoKey,
)
defer uut.close()

// Then: we don't configure
requireNeverConfigures(ctx, t, &uut.phased)

// Given: preferred DERP is 1, so we would send an update on change &&
// endpoints set to {"[fe80::1]:5678"}
uut.L.Lock()
uut.preferredDERP = 1
uut.endpoints = []string{"[fe80::1]:5678"}
uut.L.Unlock()

// When: we set a status with endpoints {[fe80::1]:5678}
uut.setStatus(&wgengine.Status{LocalAddrs: []tailcfg.Endpoint{
{Addr: netip.MustParseAddrPort("[fe80::1]:5678")},
}}, nil)

done := make(chan struct{})
go func() {
defer close(done)
uut.close()
}()
_ = testutil.RequireRecvCtx(ctx, t, done)
}

func TestNodeUpdater_setStatus_error(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
id := tailcfg.NodeID(1)
nodeKey := key.NewNode().Public()
discoKey := key.NewDisco().Public()
nodeCh := make(chan *Node)
uut := newNodeUpdater(
logger,
func(n *Node) {
nodeCh <- n
},
id, nodeKey, discoKey,
)
defer uut.close()

// Then: we don't configure
requireNeverConfigures(ctx, t, &uut.phased)

// Given: preferred DERP is 1, so we would send an update on change && empty endpoints
uut.L.Lock()
uut.preferredDERP = 1
uut.L.Unlock()

// When: we set a status with endpoints {[fe80::1]:5678}, with an error
uut.setStatus(&wgengine.Status{LocalAddrs: []tailcfg.Endpoint{
{Addr: netip.MustParseAddrPort("[fe80::1]:5678")},
}}, xerrors.New("test"))

done := make(chan struct{})
go func() {
defer close(done)
uut.close()
}()
_ = testutil.RequireRecvCtx(ctx, t, done)
}

func TestNodeUpdater_setStatus_outdated(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
id := tailcfg.NodeID(1)
nodeKey := key.NewNode().Public()
discoKey := key.NewDisco().Public()
nodeCh := make(chan *Node)
uut := newNodeUpdater(
logger,
func(n *Node) {
nodeCh <- n
},
id, nodeKey, discoKey,
)
defer uut.close()

// Then: we don't configure
requireNeverConfigures(ctx, t, &uut.phased)

// Given: preferred DERP is 1, so we would send an update on change && lastStatus set ahead
ahead := time.Date(2024, 1, 10, 8, 0o0, 1, 0, time.UTC)
behind := time.Date(2024, 1, 10, 8, 0o0, 0, 0, time.UTC)
uut.L.Lock()
uut.preferredDERP = 1
uut.lastStatus = ahead
uut.L.Unlock()

// When: we set a status with endpoints {[fe80::1]:5678}, with AsOf set behind
uut.setStatus(&wgengine.Status{
LocalAddrs: []tailcfg.Endpoint{{Addr: netip.MustParseAddrPort("[fe80::1]:5678")}},
AsOf: behind,
}, xerrors.New("test"))

done := make(chan struct{})
go func() {
defer close(done)
uut.close()
}()
_ = testutil.RequireRecvCtx(ctx, t, done)
}