mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-22 18:26:41 +00:00
* [client] Suppress ICE signaling and periodic offers in force-relay mode When NB_FORCE_RELAY is enabled, skip WorkerICE creation entirely, suppress ICE credentials in offer/answer messages, disable the periodic ICE candidate monitor, and fix isConnectedOnAllWay to only check relay status so the guard stops sending unnecessary offers. * [client] Dynamically suppress ICE based on remote peer's offer credentials Track whether the remote peer includes ICE credentials in its offers/answers. When remote stops sending ICE credentials, skip ICE listener dispatch, suppress ICE credentials in responses, and exclude ICE from the guard connectivity check. When remote resumes sending ICE credentials, re-enable all ICE behavior. * [client] Fix nil SessionID panic and force ICE teardown on relay-only transition Fix nil pointer dereference in signalOfferAnswer when SessionID is nil (relay-only offers). Close stale ICE agent immediately when remote peer stops sending ICE credentials to avoid traffic black-hole during the ICE disconnect timeout. * [client] Add relay-only fallback check when ICE is unavailable Ensure the relay connection is supported with the peer when ICE is disabled to prevent connectivity issues. * [client] Add tri-state connection status to guard for smarter ICE retry (#5828) * [client] Add tri-state connection status to guard for smarter ICE retry Refactor isConnectedOnAllWay to return a ConnStatus enum (Connected, Disconnected, PartiallyConnected) instead of a boolean. When relay is up but ICE is not (PartiallyConnected), limit ICE offers to 3 retries with exponential backoff then fall back to hourly attempts, reducing unnecessary signaling traffic. Fully disconnected peers continue to retry aggressively. External events (relay/ICE disconnect, signal/relay reconnect) reset retry state to give ICE a fresh chance. * [client] Clarify guard ICE retry state and trace log trigger Split iceRetryState.attempt into shouldRetry (pure predicate) and enterHourlyMode (explicit state transition) so the caller in reconnectLoopWithRetry reads top-to-bottom. Restore the original trace-log behavior in isConnectedOnAllWay so it only logs on full disconnection, not on the new PartiallyConnected state. * [client] Extract pure evalConnStatus and add unit tests Split isConnectedOnAllWay into a thin method that snapshots state and a pure evalConnStatus helper that takes a connStatusInputs struct, so the tri-state decision logic can be exercised without constructing full Worker or Handshaker objects. Add table-driven tests covering force-relay, ICE-unavailable and fully-available code paths, plus unit tests for iceRetryState budget/hourly transitions and reset. * [client] Improve grammar in logs and refactor ICE credential checks
202 lines
4.9 KiB
Go
202 lines
4.9 KiB
Go
package peer
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/netbirdio/netbird/client/internal/peer/guard"
|
|
)
|
|
|
|
func TestEvalConnStatus_ForceRelay(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in connStatusInputs
|
|
want guard.ConnStatus
|
|
}{
|
|
{
|
|
name: "force relay, peer uses relay, relay up",
|
|
in: connStatusInputs{
|
|
forceRelay: true,
|
|
peerUsesRelay: true,
|
|
relayConnected: true,
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "force relay, peer uses relay, relay down",
|
|
in: connStatusInputs{
|
|
forceRelay: true,
|
|
peerUsesRelay: true,
|
|
relayConnected: false,
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
{
|
|
name: "force relay, peer does NOT use relay - disconnected forever",
|
|
in: connStatusInputs{
|
|
forceRelay: true,
|
|
peerUsesRelay: false,
|
|
relayConnected: true,
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
if got := evalConnStatus(tc.in); got != tc.want {
|
|
t.Fatalf("evalConnStatus = %v, want %v", got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestEvalConnStatus_ICEUnavailable(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in connStatusInputs
|
|
want guard.ConnStatus
|
|
}{
|
|
{
|
|
name: "remote does not support ICE, peer uses relay, relay up",
|
|
in: connStatusInputs{
|
|
peerUsesRelay: true,
|
|
relayConnected: true,
|
|
remoteSupportsICE: false,
|
|
iceWorkerCreated: true,
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "remote does not support ICE, peer uses relay, relay down",
|
|
in: connStatusInputs{
|
|
peerUsesRelay: true,
|
|
relayConnected: false,
|
|
remoteSupportsICE: false,
|
|
iceWorkerCreated: true,
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
{
|
|
name: "ICE worker not yet created, relay up",
|
|
in: connStatusInputs{
|
|
peerUsesRelay: true,
|
|
relayConnected: true,
|
|
remoteSupportsICE: true,
|
|
iceWorkerCreated: false,
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "remote does not support ICE, peer does not use relay",
|
|
in: connStatusInputs{
|
|
peerUsesRelay: false,
|
|
relayConnected: false,
|
|
remoteSupportsICE: false,
|
|
iceWorkerCreated: true,
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
if got := evalConnStatus(tc.in); got != tc.want {
|
|
t.Fatalf("evalConnStatus = %v, want %v", got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestEvalConnStatus_FullyAvailable(t *testing.T) {
|
|
base := connStatusInputs{
|
|
remoteSupportsICE: true,
|
|
iceWorkerCreated: true,
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
mutator func(*connStatusInputs)
|
|
want guard.ConnStatus
|
|
}{
|
|
{
|
|
name: "ICE connected, relay connected, peer uses relay",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = true
|
|
in.relayConnected = true
|
|
in.iceStatusConnecting = true
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "ICE connected, peer does NOT use relay",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = false
|
|
in.relayConnected = false
|
|
in.iceStatusConnecting = true
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "ICE InProgress only, peer does NOT use relay",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = false
|
|
in.iceStatusConnecting = false
|
|
in.iceInProgress = true
|
|
},
|
|
want: guard.ConnStatusConnected,
|
|
},
|
|
{
|
|
name: "ICE down, relay up, peer uses relay -> partial",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = true
|
|
in.relayConnected = true
|
|
in.iceStatusConnecting = false
|
|
in.iceInProgress = false
|
|
},
|
|
want: guard.ConnStatusPartiallyConnected,
|
|
},
|
|
{
|
|
name: "ICE down, peer does NOT use relay -> disconnected",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = false
|
|
in.relayConnected = false
|
|
in.iceStatusConnecting = false
|
|
in.iceInProgress = false
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
{
|
|
name: "ICE up, peer uses relay but relay down -> partial (relay required, ICE ignored)",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = true
|
|
in.relayConnected = false
|
|
in.iceStatusConnecting = true
|
|
},
|
|
// relayOK = false (peer uses relay but it's down), iceUp = true
|
|
// first switch arm fails (relayOK false), relayUsedAndUp = false (relay down),
|
|
// falls into default: Disconnected.
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
{
|
|
name: "ICE down, relay up but peer does not use relay -> disconnected",
|
|
mutator: func(in *connStatusInputs) {
|
|
in.peerUsesRelay = false
|
|
in.relayConnected = true // not actually used since peer doesn't rely on it
|
|
in.iceStatusConnecting = false
|
|
in.iceInProgress = false
|
|
},
|
|
want: guard.ConnStatusDisconnected,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
in := base
|
|
tc.mutator(&in)
|
|
if got := evalConnStatus(in); got != tc.want {
|
|
t.Fatalf("evalConnStatus = %v, want %v (inputs: %+v)", got, tc.want, in)
|
|
}
|
|
})
|
|
}
|
|
}
|