Compare commits

..

2 Commits

Author SHA1 Message Date
Quentin McGaw 4ff4ff4d90 DEBUG_EXTERNAL_PORT_MISMATCH_CYCLES 2026-08-02 14:44:29 +00:00
Quentin McGaw ab09534a84 feat(portforward): log subcommands outputs with "up/down command:" prefix 2026-07-31 00:27:40 +00:00
4 changed files with 67 additions and 2 deletions
+21
View File
@@ -49,3 +49,24 @@ func portPairToString(internal, external uint16) string {
}
return fmt.Sprintf("%d (internal port %d)", external, internal)
}
type loggerWithPrefix struct {
prefix string
logger Logger
}
func (l *loggerWithPrefix) Debug(msg string) {
l.logger.Debug(l.prefix + msg)
}
func (l *loggerWithPrefix) Info(msg string) {
l.logger.Info(l.prefix + msg)
}
func (l *loggerWithPrefix) Warn(msg string) {
l.logger.Warn(l.prefix + msg)
}
func (l *loggerWithPrefix) Error(msg string) {
l.logger.Error(l.prefix + msg)
}
+5 -1
View File
@@ -133,7 +133,11 @@ func (s *Service) onNewPorts(ctx context.Context, internalToExternalPorts map[ui
copy(s.ports, externalPorts)
if s.settings.UpCommand != "" {
err = runCommand(ctx, s.cmder, s.logger, s.settings.UpCommand, externalPorts, s.settings.Interface)
logger := &loggerWithPrefix{
prefix: "up command: ",
logger: s.logger,
}
err = runCommand(ctx, s.cmder, logger, s.settings.UpCommand, externalPorts, s.settings.Interface)
if err != nil {
err = fmt.Errorf("running up command: %w", err)
s.logger.Error(err.Error())
+5 -1
View File
@@ -32,7 +32,11 @@ func (s *Service) cleanup() (err error) {
const downTimeout = 60 * time.Second
ctx, cancel := context.WithTimeout(context.Background(), downTimeout)
defer cancel()
err = runCommand(ctx, s.cmder, s.logger, s.settings.DownCommand, s.ports, s.settings.Interface)
logger := &loggerWithPrefix{
prefix: "down command: ",
logger: s.logger,
}
err = runCommand(ctx, s.cmder, logger, s.settings.DownCommand, s.ports, s.settings.Interface)
if err != nil {
err = fmt.Errorf("running down command: %w", err)
s.logger.Error(err.Error())
@@ -6,6 +6,8 @@ import (
"fmt"
"maps"
"net/netip"
"os"
"strconv"
"strings"
"time"
@@ -13,6 +15,25 @@ import (
"github.com/qdm12/gluetun/internal/provider/utils"
)
// debugPortMismatchTriggerCycles is read from the environment variable
// DEBUG_EXTERNAL_PORT_MISMATCH_CYCLES. If set to a value > 0, the port
// forwarding maintain loop will trigger a synthetic external port mismatch
// error after the specified number of successful maintain cycles.
// This is only used for testing/debugging purposes.
//
//nolint:gochecknoglobals // env var read once at init for debug-only synthetic trigger
var debugPortMismatchTriggerCycles = func() uint {
value := os.Getenv("DEBUG_EXTERNAL_PORT_MISMATCH_CYCLES")
if value == "" {
return 0
}
parsed, err := strconv.ParseUint(value, 10, 16)
if err != nil || parsed == 0 {
return 0
}
return uint(parsed)
}()
// PortForward obtains a VPN server side port forwarded from ProtonVPN gateway.
func (p *Provider) PortForward(ctx context.Context, objects utils.PortForwardObjects) (
internalToExternalPorts map[uint16]uint16, err error,
@@ -126,6 +147,7 @@ func (p *Provider) KeepPortForward(ctx context.Context,
const refreshTimeout = 45 * time.Second
timer := time.NewTimer(refreshTimeout)
logger := objects.Logger
maintainCycles := uint(0)
for {
select {
case <-ctx.Done():
@@ -134,6 +156,20 @@ func (p *Provider) KeepPortForward(ctx context.Context,
}
objects.Logger.Debug("refreshing forwarded ports since 45 seconds have elapsed")
// DEBUG: trigger synthetic port mismatch after N maintain cycles.
if debugPortMismatchTriggerCycles > 0 {
maintainCycles++
if maintainCycles == debugPortMismatchTriggerCycles {
fakeExternalPort := uint16(65535) //nolint:mnd // arbitrary port to trigger mismatch error
objects.Logger.Error(fmt.Sprintf(
"DEBUG: triggering synthetic external port mismatch after %d maintain cycles",
maintainCycles))
return fmt.Errorf("refreshing port mapping: TCP external port requested as %d but received %d",
uint16(1), fakeExternalPort)
}
}
const lifetime = 60 * time.Second
for internalPort, externalPort := range p.internalToExternalPorts {
_, _, err := addPortMappingTCPUDP(ctx, client, logger, objects.Gateway, internalPort, externalPort, lifetime)