arblant
firefox-vpn-client / core / internal / proxy / pool_test.go
pool_test.go371 lines · 9.7 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
package proxy

import (
	"errors"
	"sync"
	"sync/atomic"
	"testing"
	"time"
)

func TestProxySessionPoolDistributesTunnels(t *testing.T) {
	t.Parallel()

	sessions := []*fakeProxySession{{}, {}, {}}
	var created atomic.Int32
	pool, err := newProxySessionPool(len(sessions), func() (proxySession, error) {
		idx := int(created.Add(1)) - 1
		return sessions[idx], nil
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer pool.Close()

	for i := 0; i < 6; i++ {
		conn, err := pool.OpenTunnel("example.com:443")
		if err != nil {
			t.Fatalf("OpenTunnel %d returned error: %v", i, err)
		}
		_ = conn.Close()
	}

	for i, session := range sessions {
		if got := session.openCount.Load(); got != 2 {
			t.Fatalf("expected session %d open count 2, got %d", i, got)
		}
	}
}

func TestProxySessionPoolSkipsAndReplacesDeadSession(t *testing.T) {
	t.Parallel()

	dead := newMortalProxySession()
	live := newMortalProxySession()
	var created atomic.Int32
	replacement := newMortalProxySession()
	pool, err := newProxySessionPool(2, func() (proxySession, error) {
		switch created.Add(1) {
		case 1:
			return dead, nil
		case 2:
			return live, nil
		default:
			return replacement, nil
		}
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer pool.Close()

	// The keepalive notices the first session died while idle.
	dead.alive.Store(false)

	for i := 0; i < 4; i++ {
		conn, err := pool.OpenTunnel("example.com:443")
		if err != nil {
			t.Fatalf("OpenTunnel %d returned error: %v", i, err)
		}
		_ = conn.Close()
	}

	if got := dead.openCount.Load(); got != 0 {
		t.Fatalf("expected no tunnels on the dead session, got %d", got)
	}
	waitForCondition(t, 2*time.Second, func() bool {
		return created.Load() >= 3
	})
	waitForCondition(t, 2*time.Second, func() bool {
		return dead.closeCount.Load() == 1
	})
}

func TestProxySessionPoolPinsClientToOneSession(t *testing.T) {
	t.Parallel()

	sessions := []*fakeProxySession{{}, {}, {}}
	var created atomic.Int32
	p, err := newProxySessionPool(len(sessions), func() (proxySession, error) {
		idx := int(created.Add(1)) - 1
		if idx >= len(sessions) {
			return nil, errors.New("replacement unavailable")
		}
		return sessions[idx], nil
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer p.Close()

	for i := 0; i < 6; i++ {
		conn, err := p.OpenTunnelForClient("example.com:443", "127.0.0.1")
		if err != nil {
			t.Fatalf("OpenTunnelForClient %d returned error: %v", i, err)
		}
		_ = conn.Close()
	}

	used := 0
	for i, session := range sessions {
		if got := session.openCount.Load(); got > 0 {
			used++
			if got != 6 {
				t.Fatalf("expected pinned session %d to receive all tunnels, got %d", i, got)
			}
		}
	}
	if used != 1 {
		t.Fatalf("expected one session to receive pinned client tunnels, used %d", used)
	}
}

func TestProxySessionPoolKeepsClientOnFailoverSession(t *testing.T) {
	t.Parallel()

	sessions := []*fakeProxySession{{}, {}, {}}
	var created atomic.Int32
	p, err := newProxySessionPool(len(sessions), func() (proxySession, error) {
		idx := int(created.Add(1)) - 1
		if idx >= len(sessions) {
			return nil, errors.New("replacement unavailable")
		}
		return sessions[idx], nil
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer p.Close()

	const clientKey = "127.0.0.1"
	failedSlot := p.nextSlot(clientKey)
	failoverSlot := (failedSlot + 1) % len(sessions)
	sessions[failedSlot].openErr = errors.New("transport closed")

	conn, err := p.OpenTunnelForClient("example.com:443", clientKey)
	if err != nil {
		t.Fatalf("OpenTunnelForClient failover returned error: %v", err)
	}
	_ = conn.Close()

	conn, err = p.OpenTunnelForClient("example.org:443", clientKey)
	if err != nil {
		t.Fatalf("OpenTunnelForClient after failover returned error: %v", err)
	}
	_ = conn.Close()

	if got := sessions[failedSlot].openCount.Load(); got != 1 {
		t.Fatalf("expected failed slot to be tried once, got %d", got)
	}
	if got := sessions[failoverSlot].openCount.Load(); got != 2 {
		t.Fatalf("expected failover slot to remain sticky, got %d opens", got)
	}
}

func TestProxySessionPoolUpdatesExistingAndReplacementTokens(t *testing.T) {
	t.Parallel()

	var factoryMu sync.Mutex
	createToken := "old-token"
	var sessions []*fakeProxySession
	p, err := newProxySessionPool(2, func() (proxySession, error) {
		factoryMu.Lock()
		defer factoryMu.Unlock()
		session := &fakeProxySession{token: createToken}
		sessions = append(sessions, session)
		return session, nil
	}, func(token string) {
		factoryMu.Lock()
		createToken = token
		factoryMu.Unlock()
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer p.Close()

	if err := p.UpdateToken("new-token"); err != nil {
		t.Fatalf("UpdateToken returned error: %v", err)
	}
	factoryMu.Lock()
	initial := append([]*fakeProxySession(nil), sessions...)
	factoryMu.Unlock()
	for i, session := range initial {
		if got := session.currentToken(); got != "new-token" {
			t.Fatalf("expected existing session %d token to update, got %q", i, got)
		}
	}

	failed := p.slot(0)
	p.retireSlot(0, failed)
	waitForCondition(t, time.Second, func() bool {
		factoryMu.Lock()
		defer factoryMu.Unlock()
		return len(sessions) >= 3
	})
	factoryMu.Lock()
	replacement := sessions[len(sessions)-1]
	factoryMu.Unlock()
	if got := replacement.currentToken(); got != "new-token" {
		t.Fatalf("expected replacement session to use renewed token, got %q", got)
	}
}

func TestProxySessionPoolUpdatesReplacementCreatedDuringRenewal(t *testing.T) {
	t.Parallel()

	var factoryMu sync.Mutex
	createToken := "old-token"
	createCalls := 0
	replacementStarted := make(chan struct{})
	releaseReplacement := make(chan struct{})
	var releaseOnce sync.Once
	defer releaseOnce.Do(func() { close(releaseReplacement) })
	var sessions []*fakeProxySession
	p, err := newProxySessionPool(2, func() (proxySession, error) {
		factoryMu.Lock()
		createCalls++
		call := createCalls
		token := createToken
		factoryMu.Unlock()
		if call == 3 {
			close(replacementStarted)
			<-releaseReplacement
		}
		session := &fakeProxySession{token: token}
		factoryMu.Lock()
		sessions = append(sessions, session)
		factoryMu.Unlock()
		return session, nil
	}, func(token string) {
		factoryMu.Lock()
		createToken = token
		factoryMu.Unlock()
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer p.Close()

	p.retireSlot(0, p.slot(0))
	select {
	case <-replacementStarted:
	case <-time.After(time.Second):
		t.Fatal("replacement session creation did not start")
	}
	if err := p.UpdateToken("new-token"); err != nil {
		t.Fatalf("UpdateToken returned error: %v", err)
	}
	releaseOnce.Do(func() { close(releaseReplacement) })
	waitForCondition(t, time.Second, func() bool { return p.slot(0) != nil })

	factoryMu.Lock()
	replacement := sessions[len(sessions)-1]
	factoryMu.Unlock()
	if got := replacement.currentToken(); got != "new-token" {
		t.Fatalf("expected in-flight replacement to receive renewed token, got %q", got)
	}
}

func TestProxySessionPoolSkipsBrokenSession(t *testing.T) {
	t.Parallel()

	broken := &fakeProxySession{openErr: errors.New("transport closed")}
	healthy := &fakeProxySession{}
	replacement := &fakeProxySession{}
	sessions := []*fakeProxySession{broken, healthy, replacement}
	var created atomic.Int32
	pool, err := newProxySessionPool(2, func() (proxySession, error) {
		idx := int(created.Add(1)) - 1
		return sessions[idx], nil
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer pool.Close()

	conn, err := pool.OpenTunnel("example.com:443")
	if err != nil {
		t.Fatalf("OpenTunnel returned error: %v", err)
	}
	_ = conn.Close()

	if got := healthy.openCount.Load(); got != 1 {
		t.Fatalf("expected healthy session open count 1, got %d", got)
	}
	if err := pool.Close(); err != nil {
		t.Fatalf("pool Close returned error: %v", err)
	}
	if got := broken.closeCount.Load(); got != 1 {
		t.Fatalf("expected broken session to be closed once, got %d", got)
	}
}

func TestProxySessionPoolStartsWithPartialSuccess(t *testing.T) {
	t.Parallel()

	session := &fakeProxySession{}
	var attempts atomic.Int32
	pool, err := newProxySessionPool(3, func() (proxySession, error) {
		n := attempts.Add(1)
		if n == 1 {
			return session, nil
		}
		return nil, errors.New("temporary dial failure")
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer pool.Close()

	conn, err := pool.OpenTunnel("example.com:443")
	if err != nil {
		t.Fatalf("OpenTunnel returned error: %v", err)
	}
	_ = conn.Close()
	if got := session.openCount.Load(); got != 1 {
		t.Fatalf("expected available session open count 1, got %d", got)
	}
}

func TestProxySessionPoolReplenishesBrokenSession(t *testing.T) {
	t.Parallel()

	broken := &fakeProxySession{openErr: errors.New("transport closed")}
	healthy := &fakeProxySession{}
	replacement := &fakeProxySession{}
	sessions := []*fakeProxySession{broken, healthy, replacement}
	var created atomic.Int32
	pool, err := newProxySessionPool(2, func() (proxySession, error) {
		idx := int(created.Add(1)) - 1
		if idx >= len(sessions) {
			return nil, errors.New("unexpected extra create")
		}
		return sessions[idx], nil
	})
	if err != nil {
		t.Fatalf("newProxySessionPool returned error: %v", err)
	}
	defer pool.Close()

	conn, err := pool.OpenTunnel("example.com:443")
	if err != nil {
		t.Fatalf("OpenTunnel returned error: %v", err)
	}
	_ = conn.Close()

	waitForCondition(t, time.Second, func() bool {
		return pool.slot(0) != nil
	})

	for i := 0; i < 2; i++ {
		conn, err := pool.OpenTunnel("example.org:443")
		if err != nil {
			t.Fatalf("OpenTunnel after replenish returned error: %v", err)
		}
		_ = conn.Close()
	}
	if got := replacement.openCount.Load(); got == 0 {
		t.Fatal("expected replenished session to receive a tunnel")
	}
}