feat: close conns

Author: Larvan2

adapter/outboundgroup/fallback.go

@@ -150,17 +150,22 @@ func (f *Fallback) ForceSet(name string) {
 	f.selected = name
 }
 
+func (f *Fallback) CloseRelatedConns() {
+	f.closeRelatedConns()
+}
+
 func NewFallback(option *GroupCommonOption, providers []provider.ProxyProvider) *Fallback {
 	return &Fallback{
 		GroupBase: NewGroupBase(GroupBaseOption{
-			Name:           option.Name,
-			Type:           C.Fallback,
-			Filter:         option.Filter,
-			ExcludeFilter:  option.ExcludeFilter,
-			ExcludeType:    option.ExcludeType,
-			TestTimeout:    option.TestTimeout,
-			MaxFailedTimes: option.MaxFailedTimes,
-			Providers:      providers,
+			Name:            option.Name,
+			Type:            C.Fallback,
+			Filter:          option.Filter,
+			ExcludeFilter:   option.ExcludeFilter,
+			ExcludeType:     option.ExcludeType,
+			TestTimeout:     option.TestTimeout,
+			MaxFailedTimes:  option.MaxFailedTimes,
+			CloseOnSelected: option.CloseOnSelected,
+			Providers:       providers,
 		}),
 		disableUDP:     option.DisableUDP,
 		testUrl:        option.URL,

adapter/outboundgroup/groupbase.go

@@ -16,6 +16,8 @@ import (
 	types "github.com/metacubex/mihomo/constant/provider"
 	"github.com/metacubex/mihomo/log"
 	"github.com/metacubex/mihomo/tunnel"
+	"github.com/metacubex/mihomo/tunnel/statistic"
+	"github.com/samber/lo"
 
 	"github.com/dlclark/regexp2"
 	"golang.org/x/exp/slices"
@@ -33,6 +35,7 @@ type GroupBase struct {
 	failedTesting     atomic.Bool
 	TestTimeout       int
 	maxFailedTimes    int
+	closeOnSelected   bool
 
 	// for GetProxies
 	getProxiesMutex  sync.Mutex
@@ -41,14 +44,15 @@ type GroupBase struct {
 }
 
 type GroupBaseOption struct {
-	Name           string
-	Type           C.AdapterType
-	Filter         string
-	ExcludeFilter  string
-	ExcludeType    string
-	TestTimeout    int
-	MaxFailedTimes int
-	Providers      []provider.ProxyProvider
+	Name            string
+	Type            C.AdapterType
+	Filter          string
+	ExcludeFilter   string
+	ExcludeType     string
+	TestTimeout     int
+	MaxFailedTimes  int
+	CloseOnSelected bool
+	Providers       []provider.ProxyProvider
 }
 
 func NewGroupBase(opt GroupBaseOption) *GroupBase {
@@ -82,6 +86,7 @@ func NewGroupBase(opt GroupBaseOption) *GroupBase {
 		failedTesting:     atomic.NewBool(false),
 		TestTimeout:       opt.TestTimeout,
 		maxFailedTimes:    opt.MaxFailedTimes,
+		closeOnSelected:   opt.CloseOnSelected,
 	}
 
 	if gb.TestTimeout == 0 {
@@ -306,3 +311,15 @@ func (gb *GroupBase) onDialSuccess() {
 		gb.failedTimes = 0
 	}
 }
+
+func (gb *GroupBase) closeRelatedConns() {
+	if !gb.closeOnSelected {
+		return
+	}
+	statistic.DefaultManager.Range(func(tracker statistic.Tracker) bool {
+		if lo.Contains(tracker.Chains(), gb.Name()) {
+			_ = tracker.Close()
+		}
+		return true
+	})
+}

adapter/outboundgroup/parser.go

@@ -43,6 +43,7 @@ type GroupCommonOption struct {
 	IncludeAllProviders bool     `group:"include-all-providers,omitempty"`
 	Hidden              bool     `group:"hidden,omitempty"`
 	Icon                string   `group:"icon,omitempty"`
+	CloseOnSelected     bool     `group:"close-on-selected,omitempty"`
 
 	// removed configs, only for error logging
 	Interface   string `group:"interface-name,omitempty"`

adapter/outboundgroup/selector.go

@@ -88,6 +88,10 @@ func (s *Selector) Set(name string) error {
 	return errors.New("proxy not exist")
 }
 
+func (s *Selector) CloseRelatedConns() {
+	s.closeRelatedConns()
+}
+
 func (s *Selector) ForceSet(name string) {
 	s.selected = name
 }
@@ -111,14 +115,15 @@ func (s *Selector) selectedProxy(touch bool) C.Proxy {
 func NewSelector(option *GroupCommonOption, providers []provider.ProxyProvider) *Selector {
 	return &Selector{
 		GroupBase: NewGroupBase(GroupBaseOption{
-			Name:           option.Name,
-			Type:           C.Selector,
-			Filter:         option.Filter,
-			ExcludeFilter:  option.ExcludeFilter,
-			ExcludeType:    option.ExcludeType,
-			TestTimeout:    option.TestTimeout,
-			MaxFailedTimes: option.MaxFailedTimes,
-			Providers:      providers,
+			Name:            option.Name,
+			Type:            C.Selector,
+			Filter:          option.Filter,
+			ExcludeFilter:   option.ExcludeFilter,
+			ExcludeType:     option.ExcludeType,
+			TestTimeout:     option.TestTimeout,
+			MaxFailedTimes:  option.MaxFailedTimes,
+			CloseOnSelected: option.CloseOnSelected,
+			Providers:       providers,
 		}),
 		selected:   "COMPATIBLE",
 		disableUDP: option.DisableUDP,

adapter/outboundgroup/urltest.go

@@ -54,6 +54,10 @@ func (u *URLTest) Set(name string) error {
 	return nil
 }
 
+func (u *URLTest) CloseRelatedConns() {
+	u.closeRelatedConns()
+}
+
 func (u *URLTest) ForceSet(name string) {
 	u.selected = name
 	u.fastSingle.Reset()
@@ -205,14 +209,15 @@ func parseURLTestOption(config map[string]any) []urlTestOption {
 func NewURLTest(option *GroupCommonOption, providers []provider.ProxyProvider, options ...urlTestOption) *URLTest {
 	urlTest := &URLTest{
 		GroupBase: NewGroupBase(GroupBaseOption{
-			Name:           option.Name,
-			Type:           C.URLTest,
-			Filter:         option.Filter,
-			ExcludeFilter:  option.ExcludeFilter,
-			ExcludeType:    option.ExcludeType,
-			TestTimeout:    option.TestTimeout,
-			MaxFailedTimes: option.MaxFailedTimes,
-			Providers:      providers,
+			Name:            option.Name,
+			Type:            C.URLTest,
+			Filter:          option.Filter,
+			ExcludeFilter:   option.ExcludeFilter,
+			ExcludeType:     option.ExcludeType,
+			TestTimeout:     option.TestTimeout,
+			MaxFailedTimes:  option.MaxFailedTimes,
+			CloseOnSelected: option.CloseOnSelected,
+			Providers:       providers,
 		}),
 		fastSingle:     singledo.NewSingle[C.Proxy](time.Second * 10),
 		disableUDP:     option.DisableUDP,

adapter/outboundgroup/util.go

@@ -3,8 +3,11 @@ package outboundgroup
 type SelectAble interface {
 	Set(string) error
 	ForceSet(name string)
+	CloseRelatedConns()
 }
 
-var _ SelectAble = (*Fallback)(nil)
-var _ SelectAble = (*URLTest)(nil)
-var _ SelectAble = (*Selector)(nil)
+var (
+	_ SelectAble = (*Fallback)(nil)
+	_ SelectAble = (*URLTest)(nil)
+	_ SelectAble = (*Selector)(nil)
+)

config/config.go

@@ -65,6 +65,7 @@ type General struct {
 	KeepAliveIdle           int               `json:"keep-alive-idle"`
 	KeepAliveInterval       int               `json:"keep-alive-interval"`
 	DisableKeepAlive        bool              `json:"disable-keep-alive"`
+	CloseOnSelected         bool              `json:"close-on-selected"`
 }
 
 // Inbound config
@@ -270,7 +271,7 @@ type RawTun struct {
 	MTU        uint32 `yaml:"mtu" json:"mtu,omitempty"`
 	GSO        bool   `yaml:"gso" json:"gso,omitempty"`
 	GSOMaxSize uint32 `yaml:"gso-max-size" json:"gso-max-size,omitempty"`
-	//Inet4Address           []netip.Prefix `yaml:"inet4-address" json:"inet4-address,omitempty"`
+	// Inet4Address           []netip.Prefix `yaml:"inet4-address" json:"inet4-address,omitempty"`
 	Inet6Address           []netip.Prefix `yaml:"inet6-address" json:"inet6-address,omitempty"`
 	IPRoute2TableIndex     int            `yaml:"iproute2-table-index" json:"iproute2-table-index,omitempty"`
 	IPRoute2RuleIndex      int            `yaml:"iproute2-rule-index" json:"iproute2-rule-index,omitempty"`
@@ -427,6 +428,7 @@ type RawConfig struct {
 	KeepAliveIdle           int               `yaml:"keep-alive-idle" json:"keep-alive-idle"`
 	KeepAliveInterval       int               `yaml:"keep-alive-interval" json:"keep-alive-interval"`
 	DisableKeepAlive        bool              `yaml:"disable-keep-alive" json:"disable-keep-alive"`
+	CloseOnSelected         bool              `yaml:"close-on-selected" json:"close-on-selected"`
 
 	ProxyProvider map[string]map[string]any `yaml:"proxy-providers" json:"proxy-providers"`
 	RuleProvider  map[string]map[string]any `yaml:"rule-providers" json:"rule-providers"`
@@ -595,7 +597,7 @@ func UnmarshalRawConfig(buf []byte) (*RawConfig, error) {
 
 func ParseRawConfig(rawCfg *RawConfig) (*Config, error) {
 	config := &Config{}
-	log.Infoln("Start initial configuration in progress") //Segment finished in xxm
+	log.Infoln("Start initial configuration in progress") // Segment finished in xxm
 	startTime := time.Now()
 
 	general, err := parseGeneral(rawCfg)
@@ -721,7 +723,7 @@ func ParseRawConfig(rawCfg *RawConfig) (*Config, error) {
 	}
 
 	elapsedTime := time.Since(startTime) / time.Millisecond                     // duration in ms
-	log.Infoln("Initial configuration complete, total time: %dms", elapsedTime) //Segment finished in xxm
+	log.Infoln("Initial configuration complete, total time: %dms", elapsedTime) // Segment finished in xxm
 
 	return config, nil
 }
@@ -772,6 +774,7 @@ func parseGeneral(cfg *RawConfig) (*General, error) {
 		KeepAliveIdle:           cfg.KeepAliveIdle,
 		KeepAliveInterval:       cfg.KeepAliveInterval,
 		DisableKeepAlive:        cfg.DisableKeepAlive,
+		CloseOnSelected:         cfg.CloseOnSelected,
 	}, nil
 }
 
@@ -916,8 +919,16 @@ func parseProxies(cfg *RawConfig) (proxies map[string]C.Proxy, providersMap map[
 	slices.Sort(AllProxies)
 	slices.Sort(AllProviders)
 
+	globalCloseOnSelected := cfg.CloseOnSelected
+
 	// parse proxy group
 	for idx, mapping := range groupsConfig {
+		if groupCloseOnSelected, ok := mapping["close-on-selected"].(bool); ok {
+			mapping["close-on-selected"] = groupCloseOnSelected
+		} else {
+			mapping["close-on-selected"] = globalCloseOnSelected
+		}
+
 		group, err := outboundgroup.ParseProxyGroup(mapping, proxies, providersMap, AllProxies, AllProviders)
 		if err != nil {
 			return nil, nil, fmt.Errorf("proxy group[%d]: %w", idx, err)

docs/config.yaml

@@ -1062,6 +1062,10 @@ proxies: # socks5
     type: direct
     interface-name: en1
     routing-mark: 6667
+
+# 可选择类型的代理组（select/urltest/fallback）在通过 api 选择节点后是否关闭之前的连接，默认为 false
+# close-on-selected: true 
+
 proxy-groups:
   # 代理链，目前 relay 可以支持 udp 的只有 vmess/vless/trojan/ss/ssr/tuic
   # wireguard 目前不支持在 relay 中使用，请使用 proxy 中的 dialer-proxy 配置项
@@ -1077,6 +1081,7 @@ proxy-groups:
   # url-test 将按照 url 测试结果使用延迟最低节点
   - name: "auto"
     type: url-test
+    # close-on-selected: false
     proxies:
       - ss1
       - ss2

go.mod

@@ -46,7 +46,7 @@ require (
 	github.com/oschwald/maxminddb-golang v1.12.0 // lastest version compatible with golang1.20
 	github.com/sagernet/cors v1.2.1
 	github.com/sagernet/netlink v0.0.0-20240612041022-b9a21c07ac6a
-	github.com/samber/lo v1.51.0
+	github.com/samber/lo v1.52.0
 	github.com/sirupsen/logrus v1.9.3
 	github.com/stretchr/testify v1.11.1
 	github.com/vmihailenco/msgpack/v5 v5.4.1

go.sum

@@ -175,8 +175,8 @@ github.com/sagernet/cors v1.2.1 h1:Cv5Z8y9YSD6Gm+qSpNrL3LO4lD3eQVvbFYJSG7JCMHQ=
 github.com/sagernet/cors v1.2.1/go.mod h1:O64VyOjjhrkLmQIjF4KGRrJO/5dVXFdpEmCW/eISRAI=
 github.com/sagernet/netlink v0.0.0-20240612041022-b9a21c07ac6a h1:ObwtHN2VpqE0ZNjr6sGeT00J8uU7JF4cNUdb44/Duis=
 github.com/sagernet/netlink v0.0.0-20240612041022-b9a21c07ac6a/go.mod h1:xLnfdiJbSp8rNqYEdIW/6eDO4mVoogml14Bh2hSiFpM=
-github.com/samber/lo v1.51.0 h1:kysRYLbHy/MB7kQZf5DSN50JHmMsNEdeY24VzJFu7wI=
-github.com/samber/lo v1.51.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0=
+github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw=
+github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0=
 github.com/sina-ghaderi/poly1305 v0.0.0-20220724002748-c5926b03988b h1:rXHg9GrUEtWZhEkrykicdND3VPjlVbYiLdX9J7gimS8=
 github.com/sina-ghaderi/poly1305 v0.0.0-20220724002748-c5926b03988b/go.mod h1:X7qrxNQViEaAN9LNZOPl9PfvQtp3V3c7LTo0dvGi0fM=
 github.com/sina-ghaderi/rabaead v0.0.0-20220730151906-ab6e06b96e8c h1:DjKMC30y6yjG3IxDaeAj3PCoRr+IsO+bzyT+Se2m2Hk=