TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-04-16 19:51:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

derp: document the RunWatchConnectionLoop callback gotchas

Browse Source 
Updates #13566

Change-Id: I497b5adc57f8b1b97dbc3f74c0dc67140caad436
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2024-09-24 15:11:31 -07:00 committed by Brad Fitzpatrick
parent 6f7e7a30e3
commit e1bbe1bf45
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
derp/derp_client.go
View File

@ -356,6 +356,10 @@ func (ReceivedPacket) msg() {}
// PeerGoneMessage is a ReceivedMessage that indicates that the client // PeerGoneMessage is a ReceivedMessage that indicates that the client
// identified by the underlying public key is not connected to this // identified by the underlying public key is not connected to this
// server. // server.
//
// It has only historically been sent by the server when the client
// connection count decremented from 1 to 0 and not from e.g. 2 to 1.
// See https://github.com/tailscale/tailscale/issues/13566 for details.
type PeerGoneMessage struct { type PeerGoneMessage struct {
Peer key.NodePublic Peer key.NodePublic
Reason PeerGoneReasonType Reason PeerGoneReasonType
@ -363,8 +367,13 @@ type PeerGoneMessage struct {
func (PeerGoneMessage) msg() {} func (PeerGoneMessage) msg() {}
// PeerPresentMessage is a ReceivedMessage that indicates that the client // PeerPresentMessage is a ReceivedMessage that indicates that the client is
// is connected to the server. (Only used by trusted mesh clients) // connected to the server. (Only used by trusted mesh clients)
//
// It will be sent to client watchers for every new connection from a client,
// even if the client's already connected with that public key.
// See https://github.com/tailscale/tailscale/issues/13566 for PeerPresentMessage
// and PeerGoneMessage not being 1:1.
type PeerPresentMessage struct { type PeerPresentMessage struct {
// Key is the public key of the client. // Key is the public key of the client.
Key key.NodePublic Key key.NodePublic

4
derp/derphttp/mesh_client.go
View File

@ -26,6 +26,10 @@ var testHookWatchLookConnectResult func(connectError error, wasSelfConnect bool)
// returns. // returns.
// //
// Otherwise, the add and remove funcs are called as clients come & go. // Otherwise, the add and remove funcs are called as clients come & go.
// Note that add is called for every new connection and remove is only
// called for the final disconnection. See https://github.com/tailscale/tailscale/issues/13566.
// This behavior will likely change. Callers should do their own accounting
// and dup suppression as needed.
// //
// infoLogf, if non-nil, is the logger to write periodic status updates about // infoLogf, if non-nil, is the logger to write periodic status updates about
// how many peers are on the server. Error log output is set to the c's logger, // how many peers are on the server. Error log output is set to the c's logger,