Merge remote-tracking branch 'origin/master' into stable

.github/workflows/ci.yaml

@@ -42,7 +42,7 @@ jobs:
     strategy:
       matrix:
         go_version:
-          - ^1.18
+          - ^1.19
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -114,12 +114,12 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: ^1.18
+          go-version: ^1.19
 
       - name: Run linter
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.45.0
+          version: v1.48.0
 
   docker:
     name: Docker

.golangci.toml

@@ -9,4 +9,14 @@ format = "colored-line-number"
 
 [linters]
 enable-all = true
-disable = ["thelper", "ireturn", "varnamelen", "gochecknoglobals", "gas", "goerr113", "exhaustivestruct", "containedctx"]
+disable = [
+    "containedctx",
+    "exhaustivestruct",
+    "exhaustruct",
+    "gas",
+    "gochecknoglobals",
+    "goerr113",
+    "ireturn",
+    "thelper",
+    "varnamelen",
+]

Dockerfile

@@ -1,7 +1,7 @@
 ###############################################################################
 # BUILD STAGE
 
-FROM golang:1.18-alpine AS build
+FROM golang:1.19-alpine AS build
 
 RUN set -x \
   && apk --no-cache --update add \

Makefile

@@ -2,7 +2,7 @@ ROOT_DIR     := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 IMAGE_NAME   := mtg
 APP_NAME     := $(IMAGE_NAME)
 
-GOLANGCI_LINT_VERSION := v1.45.0
+GOLANGCI_LINT_VERSION := v1.48.0
 
 VERSION            := $(shell git describe --exact-match HEAD 2>/dev/null || git describe --tags --always)
 COMMON_BUILD_FLAGS := -trimpath -mod=readonly -ldflags="-extldflags '-static' -s -w -X 'main.version=$(VERSION)'"

README.md

@@ -190,7 +190,7 @@ surprises. Always choose some version tag.
 Also, if you have `go` installed, you can always download this tool with `go get`:
 
 ```console
-go get github.com/9seconds/mtg/v2
+go install github.com/9seconds/mtg/v2@latest
 ```
 
 #### Build from sources
@@ -338,7 +338,7 @@ $ sudo systemctl start mtg
 or you can run a docker image
 
 ```console
-docker run -d -v /etc/mtg.toml:/config.toml -p 443:3128 --name mtg-proxy --restart=unless-stopped nineseconds/mtg:2
+docker run -d -v $PWD/config.toml:config.toml -p 443:3128 --name mtg-proxy --restart=unless-stopped nineseconds/mtg:2
 ```
 
 where _443_ is a host port (a port you want to connect to from a

antireplay/init.go

@@ -1,17 +1,17 @@
-// Antireplay package has cache implementations that are effective
+// Antireplay package has cache implementations that are effective against
-// against replay attacks.
+// replay attacks.
 //
-// To understand more about replay attacks, please read documentation
+// To understand more about replay attacks, please read documentation for
-// for mtglib.AntiReplayCache interface. This package has a list of some
+// [mtglib.AntiReplayCache] interface. This package has a list of some
 // implementations of this interface.
 package antireplay
 
 const (
-	// DefaultStableBloomFilterMaxSize is a recommended byte size for a
+	// DefaultStableBloomFilterMaxSize is a recommended byte size for a stable
-	// stable bloom filter.
+	// bloom filter.
 	DefaultStableBloomFilterMaxSize = 1024 * 1024 // 1MiB
 
-	// DefaultStableBloomFilterErrorRate is a recommended default error
+	// DefaultStableBloomFilterErrorRate is a recommended default error rate for a
-	// rate for a stable bloom filter.
+	// stable bloom filter.
 	DefaultStableBloomFilterErrorRate = 0.001
 )

antireplay/noop.go

@@ -6,9 +6,8 @@ type noop struct{}
 
 func (n noop) SeenBefore(_ []byte) bool { return false }
 
-// NewNoop returns an implementation that does nothing. A corresponding
+// NewNoop returns an implementation that does nothing. A corresponding method
-// method always returns false, so this cache accepts everything you
+// always returns false, so this cache accepts everything you pass to it.
-// pass to it.
 func NewNoop() mtglib.AntiReplayCache {
 	return noop{}
 }

antireplay/stable_bloom_filter.go

@@ -20,19 +20,19 @@ func (s *stableBloomFilter) SeenBefore(digest []byte) bool {
 	return s.filter.TestAndAdd(digest)
 }
 
-// NewStableBloomFilter returns an implementation of AntiReplayCache
+// NewStableBloomFilter returns an implementation of AntiReplayCache based on
-// based on stable bloom filter.
+// stable bloom filter.
 //
 // http://webdocs.cs.ualberta.ca/~drafiei/papers/DupDet06Sigmod.pdf
 //
-// The basic idea of a stable bloom filter is quite simple: each time
+// The basic idea of a stable bloom filter is quite simple: each time when you
-// when you set a new element, you randomly reset P elements. There is a
+// set a new element, you randomly reset P elements. There is a hardcore math
-// hardcore math which proves that if you choose this P correctly, you
+// which proves that if you choose this P correctly, you can maintain the same
-// can maintain the same error rate for a stream of elements.
+// error rate for a stream of elements.
 //
 // byteSize is the number of bytes you want to give to a bloom filter.
-// errorRate is desired false-positive error rate. If you want to use
+// errorRate is desired false-positive error rate. If you want to use default
-// default values, please pass 0 for byteSize and <0 for errorRate.
+// values, please pass 0 for byteSize and <0 for errorRate.
 func NewStableBloomFilter(byteSize uint, errorRate float64) mtglib.AntiReplayCache {
 	if byteSize == 0 {
 		byteSize = DefaultStableBloomFilterMaxSize

buildinfo.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"crypto/sha256"
+	"encoding/base64"
+	"encoding/binary"
+	"fmt"
+	"io"
+	"runtime/debug"
+	"sort"
+	"strconv"
+	"time"
+)
+
+var version = "dev" // has to be set by ldflags
+
+const (
+	buildInfoModuleStart byte = iota
+	buildInfoModuleFinish
+	buildInfoModuleDelimeter
+)
+
+func getVersion() string {
+	buildInfo, ok := debug.ReadBuildInfo()
+	if !ok {
+		return version
+	}
+
+	date := time.Now()
+	commit := ""
+	goVersion := buildInfo.GoVersion
+	dirtySuffix := ""
+
+	for _, setting := range buildInfo.Settings {
+		switch setting.Key {
+		case "vcs.time":
+			date, _ = time.Parse(time.RFC3339, setting.Value)
+		case "vcs.revision":
+			commit = setting.Value
+		case "vcs.modified":
+			if dirty, _ := strconv.ParseBool(setting.Value); dirty {
+				dirtySuffix = " [dirty]"
+			}
+		}
+	}
+
+	hasher := sha256.New()
+
+	checksumModule := func(mod *debug.Module) {
+		hasher.Write([]byte{buildInfoModuleStart})
+
+		io.WriteString(hasher, mod.Path) //nolint: errcheck
+		hasher.Write([]byte{buildInfoModuleDelimeter})
+
+		io.WriteString(hasher, mod.Version) //nolint: errcheck
+		hasher.Write([]byte{buildInfoModuleDelimeter})
+
+		io.WriteString(hasher, mod.Sum) //nolint: errcheck
+
+		hasher.Write([]byte{buildInfoModuleFinish})
+	}
+
+	io.WriteString(hasher, buildInfo.Path) //nolint: errcheck
+
+	binary.Write(hasher, binary.LittleEndian, uint64(1+len(buildInfo.Deps))) //nolint: errcheck
+
+	sort.Slice(buildInfo.Deps, func(i, j int) bool {
+		return buildInfo.Deps[i].Path > buildInfo.Deps[j].Path
+	})
+
+	checksumModule(&buildInfo.Main)
+
+	for _, module := range buildInfo.Deps {
+		checksumModule(module)
+	}
+
+	return fmt.Sprintf("%s (%s: %s on %s%s, modules checksum %s)",
+		version,
+		goVersion,
+		date.Format(time.RFC3339),
+		commit,
+		dirtySuffix,
+		base64.StdEncoding.EncodeToString(hasher.Sum(nil)))
+}

essentials/conns.go

@@ -5,19 +5,19 @@ import (
 	"net"
 )
 
-// CloseableReader is a reader interface that can close its reading end.
+// CloseableReader is an [io.Reader] interface that can close its reading end.
 type CloseableReader interface {
 	io.Reader
 	CloseRead() error
 }
 
-// CloseableWriter is a writer that can close its writing end.
+// CloseableWriter is an [io.Writer] that can close its writing end.
 type CloseableWriter interface {
 	io.Writer
 	CloseWrite() error
 }
 
-// Conn is an extension of net.Conn that can close its ends. This mostly
+// Conn is an extension of [net.Conn] that can close its ends. This mostly
 // implies TCP connections.
 type Conn interface {
 	net.Conn

events/event_stream.go

@@ -9,7 +9,7 @@ import (
 	"github.com/OneOfOne/xxhash"
 )
 
-// EventStream is a default implementation of the mtglib.EventStream
+// EventStream is a default implementation of the [mtglib.EventStream]
 // interface.
 //
 // EventStream manages a set of goroutines, observers. Main

events/init.go

@@ -1,19 +1,19 @@
 // Events has a default implementations of EventStream for mtglib.
 //
-// Please see documentation for mtglib.EventStream interface to get an
+// Please see documentation for [mtglib.EventStream] interface to get an idea
-// idea of such an abstraction. This package has implementations for the
+// of such an abstraction. This package has implementations for the default
-// default event stream.
+// event stream.
 //
-// Default event stream has a list of its own concepts. First, all it
+// Default event stream has a list of its own concepts. First, all it does is a
-// does is a routing of messages to known observers. It takes an event,
+// routing of messages to known observers. It takes an event, defines its type
-// defines its type and pass this message to a method of the observer.
+// and pass this message to a method of the observer.
 //
-// There might be many observers, but default event stream has a
+// There might be many observers, but default event stream has a guarantee
-// guarantee though. It uses StreamID as a sharding key and guarantees
+// though. It uses StreamID as a sharding key and guarantees that a message
-// that a message with the same StreamID will be devlivered to the same
+// with the same StreamID will be devlivered to the same observer instance. So,
-// observer instance. So, each producer is guarateed to get all relevant
+// each producer is guarateed to get all relevant messages related to the same
-// messages related to the same session. It is not possible that it will
+// session. It is not possible that it will get EventFinish if it has not seen
-// get EventFinish if it has not seen EventStart for that session yet.
+// EventStart for that session yet.
 package events
 
 import "github.com/9seconds/mtg/v2/mtglib"
@@ -21,10 +21,10 @@ import "github.com/9seconds/mtg/v2/mtglib"
 // Observer is an instance that listens for the incoming events.
 //
 // As it is said in the package description, the default event stream
-// guarantees that all events with the same StreamID are going to be
+// guarantees that all events with the same StreamID are going to be routed to
-// routed to the same instance of the observer. So, there is no need
+// the same instance of the observer. So, there is no need to synchronize
-// to synchronize information about streams between many observers
+// information about streams between many observers instances, they can have
-// instances, they can have their local storage.
+// their local storage.
 type Observer interface {
 	// EventStart reacts on incoming mtglib.EventStart event.
 	EventStart(mtglib.EventStart)
@@ -65,8 +65,8 @@ type Observer interface {
 
 // ObserverFactory creates a new instance of the observer.
 //
-// Default event stream creates a small set of goroutines to manage
+// Default event stream creates a small set of goroutines to manage incoming
-// incoming messages. Each message is routed to an appropriate observer
+// messages. Each message is routed to an appropriate observer based on a
-// based on a sharding key, stream id. So, it is possible that an
+// sharding key, stream id. So, it is possible that an instance of mtg will
-// instance of mtg will have many observer instances, not a single one.
+// have many observer instances, not a single one.
 type ObserverFactory func() Observer

go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/OneOfOne/xxhash v1.2.8
-	github.com/alecthomas/kong v0.5.0
+	github.com/alecthomas/kong v0.6.1
 	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137
 	github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5
 	github.com/babolivier/go-doh-client v0.0.0-20201028162107-a76cff4cb8b6
@@ -13,24 +13,24 @@ require (
 	github.com/gotd/td v0.34.0
 	github.com/jarcoal/httpmock v1.0.8
 	github.com/mccutchen/go-httpbin v1.1.1
-	github.com/panjf2000/ants/v2 v2.4.8
+	github.com/panjf2000/ants/v2 v2.5.0
-	github.com/pelletier/go-toml v1.9.4
+	github.com/pelletier/go-toml v1.9.5
-	github.com/prometheus/client_golang v1.12.1
+	github.com/prometheus/client_golang v1.13.0
-	github.com/prometheus/common v0.32.1 // indirect
+	github.com/prometheus/common v0.37.0 // indirect
-	github.com/prometheus/procfs v0.7.3 // indirect
+	github.com/prometheus/procfs v0.8.0 // indirect
-	github.com/rs/zerolog v1.26.1
+	github.com/rs/zerolog v1.27.0
 	github.com/smira/go-statsd v1.3.2
 	github.com/stretchr/objx v0.3.0 // indirect
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.7.2
 	github.com/tylertreat/BoomFilters v0.0.0-20210315201527-1a82519a3e43
-	golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd
+	golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa
-	golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 // indirect
+	golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
-	golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8
+	golang.org/x/sys v0.0.0-20220804214406-8e32c043e418
-	google.golang.org/protobuf v1.27.1 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 )
 
 require (
-	github.com/txthinking/socks5 v0.0.0-20220212043548-414499347d4a
+	github.com/txthinking/socks5 v0.0.0-20220615051428-39268faee3e6
 	github.com/yl2chen/cidranger v1.0.2
 )
 
@@ -41,9 +41,10 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/gotd/ige v0.1.5 // indirect
 	github.com/gotd/xor v0.1.1 // indirect
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 	github.com/patrickmn/go-cache v2.1.0+incompatible // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.2.0 // indirect
 	github.com/txthinking/runnergroup v0.0.0-20220212043759-8da8edb7dae8 // indirect
@@ -51,7 +52,7 @@ require (
 	go.uber.org/atomic v1.7.0 // indirect
 	go.uber.org/multierr v1.6.0 // indirect
 	go.uber.org/zap v1.16.0 // indirect
-	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c // indirect
+	golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f // indirect
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -37,8 +37,8 @@ github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym
 github.com/OneOfOne/xxhash v1.2.8 h1:31czK/TI9sNkxIKfaUfGlU47BAxQ0ztGgd9vPyqimf8=
 github.com/OneOfOne/xxhash v1.2.8/go.mod h1:eZbhyaAYD41SGSSsnmcpxVoRiQ/MPUTjUdIIOT9Um7Q=
 github.com/PuerkitoBio/goquery v1.6.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc=
-github.com/alecthomas/kong v0.5.0 h1:u8Kdw+eeml93qtMZ04iei0CFYve/WPcA5IFh+9wSskE=
+github.com/alecthomas/kong v0.6.1 h1:1kNhcFepkR+HmasQpbiKDLylIL8yh5B5y1zPp5bJimA=
-github.com/alecthomas/kong v0.5.0/go.mod h1:uzxf/HUh0tj43x1AyJROl3JT7SgsZ5m+icOv1csRhc0=
+github.com/alecthomas/kong v0.6.1/go.mod h1:JfHWDzLmbh/puW6I3V7uWenoh56YNVONW+w8eKeUr9I=
 github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142 h1:8Uy0oSf5co/NZXje7U1z8Mpep++QJOldL2hs/sBQf48=
 github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142/go.mod h1:2kn6fqh/zIyPLmm3ugklbEi5hg5wS435eygvNfaDQL8=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
@@ -69,7 +69,7 @@ github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5P
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
-github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/d4l3k/messagediff v1.2.1 h1:ZcAIMYsUg0EAp9X+tt8/enBE/Q8Yd5kzPynLyKptt9U=
 github.com/d4l3k/messagediff v1.2.1/go.mod h1:Oozbb1TVXFac9FtSIxHBMnBCq2qeH/2KkEQxENCrlLo=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -85,9 +85,11 @@ github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2
 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
 github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
 github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=
+github.com/go-kit/log v0.2.0/go.mod h1:NwTd00d/i8cPZ3xOwwiv2PO5MOcx78fFErGNcVmBjv0=
 github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
 github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
 github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A=
+github.com/go-logfmt/logfmt v0.5.1/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs=
 github.com/go-openapi/inflect v0.19.0/go.mod h1:lHpZVlpIQqLyKwJ4N+YSc9hchQy/i12fJykb83CRBH4=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
@@ -130,8 +132,8 @@ github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
@@ -182,8 +184,12 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
+github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
+github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mattn/go-isatty v0.0.9/go.mod h1:YNRxwqDuOph6SZLI9vUUz6OYw3QyUt7WiY2yME+cCiQ=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
 github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU=
 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
 github.com/mccutchen/go-httpbin v1.1.1 h1:aEws49HEJEyXHLDnshQVswfUlCVoS8g6h9YaDyaW7RE=
@@ -195,12 +201,12 @@ github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3Rllmb
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
 github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
-github.com/panjf2000/ants/v2 v2.4.8 h1:JgTbolX6K6RreZ4+bfctI0Ifs+3mrE5BIHudQxUDQ9k=
+github.com/panjf2000/ants/v2 v2.5.0 h1:1rWGWSnxCsQBga+nQbA4/iY6VMeNoOIAM0ZWh9u3q2Q=
-github.com/panjf2000/ants/v2 v2.4.8/go.mod h1:f6F0NZVFsGCp5A7QW/Zj/m92atWwOkY0OIhFxRNFr4A=
+github.com/panjf2000/ants/v2 v2.5.0/go.mod h1:cU93usDlihJZ5CfRGNDYsiBYvoilLvBF5Qp/BT2GNRE=
 github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
-github.com/pelletier/go-toml v1.9.4 h1:tjENF6MfZAg8e4ZmZTeWaWiT2vXtsoO6+iuOjFhECwM=
+github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
-github.com/pelletier/go-toml v1.9.4/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
+github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
@@ -212,8 +218,9 @@ github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXP
 github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo=
 github.com/prometheus/client_golang v1.7.1/go.mod h1:PY5Wy2awLA44sXw4AOSfFBetzPP4j5+D6mVACh+pe2M=
 github.com/prometheus/client_golang v1.11.0/go.mod h1:Z6t4BnS23TR94PD6BsDNk8yVqroYurpAkEiz0P2BEV0=
-github.com/prometheus/client_golang v1.12.1 h1:ZiaPsmm9uiBeaSMRznKsCDNtPCS0T3JVDGF+06gjBzk=
 github.com/prometheus/client_golang v1.12.1/go.mod h1:3Z9XVyYiZYEO+YQWt3RD2R3jrbd179Rt297l4aS6nDY=
+github.com/prometheus/client_golang v1.13.0 h1:b71QUfeo5M8gq2+evJdTPfZhYMAU0uKPkyPJ7TPsloU=
+github.com/prometheus/client_golang v1.13.0/go.mod h1:vTeo+zgvILHsnnj/39Ou/1fPN5nJFOEMgftOUOmlvYQ=
 github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo=
 github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
@@ -222,20 +229,22 @@ github.com/prometheus/client_model v0.2.0/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6T
 github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4=
 github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB80sz/V91rCo=
 github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc=
-github.com/prometheus/common v0.32.1 h1:hWIdL3N2HoUx3B8j3YN9mWor0qhY/NlEKZEaXxuIRh4=
 github.com/prometheus/common v0.32.1/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
+github.com/prometheus/common v0.37.0 h1:ccBbHCgIiT9uSoFY0vX8H3zsNR5eLt17/RQLUvn8pXE=
+github.com/prometheus/common v0.37.0/go.mod h1:phzohg0JFMnBEFGxTDbfu3QyL5GI8gTQJFhYO5B3mfA=
 github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
 github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA=
 github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
 github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
-github.com/prometheus/procfs v0.7.3 h1:4jVXhlkAyzOScmCkXBTOLRLTz8EeU+eyjrwB/EPq0VU=
 github.com/prometheus/procfs v0.7.3/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA=
+github.com/prometheus/procfs v0.8.0 h1:ODq8ZFEaYeCaZOJlZZdJA2AbQR98dSHSM1KW/You5mo=
+github.com/prometheus/procfs v0.8.0/go.mod h1:z7EfXMXOkbkqb9IINtpCn86r/to3BnA0uaxHdg830/4=
 github.com/quasilyte/go-ruleguard/dsl v0.3.2/go.mod h1:KeCP03KrjuSO0H1kTuZQCWlQPulDV6YMIXmpQss17rU=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
 github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
 github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.26.1 h1:/ihwxqH+4z8UxyI70wM1z9yCvkWcfz/a3mj48k/Zngc=
+github.com/rs/zerolog v1.27.0 h1:1T7qCieN22GVc8S4Q2yuexzBb1EqjbgjSH9RohbMjKs=
-github.com/rs/zerolog v1.26.1/go.mod h1:/wSSJWX7lVrsOwlbyTRSOJvqRlc+WjWlfes+CiJ+tmc=
+github.com/rs/zerolog v1.27.0/go.mod h1:7frBqO0oezxmnO7GF86FY++uy8I0Tk/If5ni1G9Qc0U=
 github.com/sebdah/goldie/v2 v2.5.3/go.mod h1:oZ9fp0+se1eapSRjfYbsV/0Hqhbuu3bJVvKI/NNtssI=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
@@ -252,13 +261,14 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
+github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
 github.com/txthinking/runnergroup v0.0.0-20210608031112-152c7c4432bf/go.mod h1:CLUSJbazqETbaR+i0YAhXBICV9TrKH93pziccMhmhpM=
 github.com/txthinking/runnergroup v0.0.0-20220212043759-8da8edb7dae8 h1:iYc+JnXtzv6sdMx9Q7OTKkDAn7FhDPDogcjeSfEQcLY=
 github.com/txthinking/runnergroup v0.0.0-20220212043759-8da8edb7dae8/go.mod h1:CLUSJbazqETbaR+i0YAhXBICV9TrKH93pziccMhmhpM=
-github.com/txthinking/socks5 v0.0.0-20220212043548-414499347d4a h1:BOqgJ4jku0LHPDoR51RD8Mxmo0LHxCzJT/M9MemYdHo=
+github.com/txthinking/socks5 v0.0.0-20220615051428-39268faee3e6 h1:8DkPbOq/EPxbD5VJajKuvssiYZJSrlpeetcGfrBoBVE=
-github.com/txthinking/socks5 v0.0.0-20220212043548-414499347d4a/go.mod h1:7NloQcrxaZYKURWph5HLxVDlIwMHJXCPkeWPtpftsIg=
+github.com/txthinking/socks5 v0.0.0-20220615051428-39268faee3e6/go.mod h1:7NloQcrxaZYKURWph5HLxVDlIwMHJXCPkeWPtpftsIg=
 github.com/txthinking/x v0.0.0-20210326105829-476fab902fbe h1:gMWxZxBFRAXqoGkwkYlPX2zvyyKNWJpxOxCrjqJkm5A=
 github.com/txthinking/x v0.0.0-20210326105829-476fab902fbe/go.mod h1:WgqbSEmUYSjEV3B1qmee/PpP2NYEz4bL9/+mF1ma+s4=
 github.com/tylertreat/BoomFilters v0.0.0-20210315201527-1a82519a3e43 h1:QEePdg0ty2r0t1+qwfZmQ4OOl/MB2UXIeJSpIZv56lg=
@@ -268,7 +278,6 @@ github.com/yl2chen/cidranger v1.0.2/go.mod h1:9U1yz7WPYDwf0vpNWFaeRh0bjwz5RVgRy/
 github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
-github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
 go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
 go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
 go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
@@ -290,9 +299,8 @@ golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.0.0-20211215165025-cf75a172585e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
+golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa h1:zuSxTR4o9y82ebqCUJYNGJbGPo6sKVl54f/TVDObg1c=
-golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd h1:XcWmESyNjXJMLahc3mqVQJcgSTDxFxhETVlfk9uGc38=
+golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
-golang.org/x/crypto v0.0.0-20220315160706-3147a52a75dd/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
@@ -323,9 +331,8 @@ golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY=
 golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
 golang.org/x/mod v0.1.1-0.20191107180719-034126e5016b/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
 golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
+golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
-golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo=
-golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
@@ -356,17 +363,17 @@ golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81R
 golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
 golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
-golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
 golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
-golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 h1:CIJ76btIcR3eFI5EgSo6k1qKw9KJexJuRLI9G7Hp5wE=
+golang.org/x/net v0.0.0-20220225172249-27dd8689420f h1:oA4XRj0qtSt8Yo1Zms0CUlsT3KG69V2UGQWPBxujDmc=
-golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
+golang.org/x/oauth2 v0.0.0-20220223155221-ee480838109b/go.mod h1:DAh4E804XQdzx2j+YRIaUnCqCV2RuMz24cGBJ5QYIrc=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -376,8 +383,8 @@ golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
+golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f h1:Ax0t5p6N38Ga0dThY21weqDEyz2oklo4IvDkpigvkD8=
-golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -416,17 +423,22 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8 h1:OH54vjqzRWmbJ62fjuhxy7AxFFgoHN0/DPc/UrL8cAs=
+golang.org/x/sys v0.0.0-20220804214406-8e32c043e418 h1:9vYwv7OjYaky/tlAeD7C4oC9EsPTlaFl1H2jS++V+ME=
-golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220804214406-8e32c043e418/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
@@ -472,9 +484,8 @@ golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roY
 golang.org/x/tools v0.0.0-20200729194436-6467de6f59a7/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
 golang.org/x/tools v0.0.0-20200804011535-6c149bb5ef0d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
 golang.org/x/tools v0.0.0-20200820010801-b793a1359eac/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
+golang.org/x/tools v0.0.0-20200825202427-b303f430e36d h1:W07d4xkoAUSNOkOzdzXCdFGxT7o2rW4q8M34tB2i//k=
 golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
-golang.org/x/tools v0.1.7 h1:6j8CgantCy3yc8JGBqkDLMKWqZ0RDU2g1HVgacojGWQ=
-golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
@@ -555,8 +566,8 @@ google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGj
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
-google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
+google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w=
-google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
@@ -567,13 +578,12 @@ gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

internal/cli/run_proxy.go

@@ -127,7 +127,12 @@ func makeIPAllowlist(conf config.ListConfig,
 	logger mtglib.Logger,
 	ntw mtglib.Network,
 	updateCallback ipblocklist.FireholUpdateCallback,
-) (allowlist mtglib.IPBlocklist, err error) {
+) (mtglib.IPBlocklist, error) {
+	var (
+		allowlist mtglib.IPBlocklist
+		err       error
+	)
+
 	if !conf.Enabled.Get(false) {
 		allowlist, err = ipblocklist.NewFireholFromFiles(
 			logger.Named("ipblocklist"),

internal/cli/simple_run.go

@@ -20,10 +20,11 @@ type SimpleRun struct {
 	DomainFrontingPort  uint64        `kong:"name='domain-fronting-port',short='p',default='443',help='A port to access for domain fronting.'"`                        //nolint: lll
 	DOHIP               net.IP        `kong:"name='doh-ip',short='n',default='9.9.9.9',help='IP address of DNS-over-HTTP to use.'"`                                    //nolint: lll
 	Timeout             time.Duration `kong:"name='timeout',short='t',default='10s',help='Network timeout to use'"`                                                    //nolint: lll
+	Socks5Proxies       []string      `kong:"name='socks5-proxy',short='s',help='Socks5 proxies to use for network access.'"`                                          //nolint: lll
 	AntiReplayCacheSize string        `kong:"name='antireplay-cache-size',short='a',default='1MB',help='A size of anti-replay cache to use.'"`                         //nolint: lll
 }
 
-func (s *SimpleRun) Run(cli *CLI, version string) error { // nolint: cyclop
+func (s *SimpleRun) Run(cli *CLI, version string) error { //nolint: cyclop,funlen
 	conf := &config.Config{}
 
 	if err := conf.BindTo.Set(s.BindTo); err != nil {
@@ -66,6 +67,16 @@ func (s *SimpleRun) Run(cli *CLI, version string) error { // nolint: cyclop
 		return fmt.Errorf("incorrect antireplay-cache-size: %w", err)
 	}
 
+	for _, v := range s.Socks5Proxies {
+		proxyURL := config.TypeProxyURL{}
+
+		if err := proxyURL.Set(v); err != nil {
+			return fmt.Errorf("incorrect socks5 proxy URL: %w", err)
+		}
+
+		conf.Network.Proxies = append(conf.Network.Proxies, proxyURL)
+	}
+
 	conf.Debug.Value = s.Debug
 	conf.AllowFallbackOnUnknownDC.Value = true
 	conf.Defense.AntiReplay.Enabled.Value = true

internal/utils/rlimit.go

@@ -1,25 +0,0 @@
-//go:build !windows
-// +build !windows
-
-package utils
-
-import (
-	"fmt"
-
-	"golang.org/x/sys/unix"
-)
-
-func SetLimits() error {
-	rLimit := unix.Rlimit{}
-	if err := unix.Getrlimit(unix.RLIMIT_NOFILE, &rLimit); err != nil {
-		return fmt.Errorf("cannot get rlimit: %w", err)
-	}
-
-	rLimit.Cur = rLimit.Max
-
-	if err := unix.Setrlimit(unix.RLIMIT_NOFILE, &rLimit); err != nil {
-		return fmt.Errorf("cannot set rlimit: %w", err)
-	}
-
-	return nil
-}

internal/utils/rlimit_windows.go

@@ -1,8 +0,0 @@
-//go:build windows
-// +build windows
-
-package utils
-
-func SetLimits() error {
-	return nil
-}

ipblocklist/files/doc.go

@@ -0,0 +1,8 @@
+// files defines a set of abstraction for 'files': an openable entities that
+// could be read after.
+//
+// This is not a file on a filesystem of your local machine, it also can
+// include "in memory" files or even remote ones, like HTTP endpoints. If you
+// make a GET request to HTTP endpoint, then a body is readable and you can
+// consider it as an openable file.
+package files

ipblocklist/files/http.go

@@ -40,6 +40,8 @@ func (h httpFile) String() string {
 	return h.url
 }
 
+// NewHTTP returns a file abstraction for HTTP/HTTPS endpoint. You also need to
+// provide a valid instance of [http.Client] to access it.
 func NewHTTP(client *http.Client, endpoint string) (File, error) {
 	if client == nil {
 		return nil, ErrBadHTTPClient

ipblocklist/files/init.go

@@ -6,9 +6,16 @@ import (
 	"io"
 )
 
+// ErrBadHTTPClient is returned if given HTTP client is initialized
+// incorrectly.
 var ErrBadHTTPClient = errors.New("incorrect http client")
 
+// File is an abstraction for a entity that can be opened in some context.
 type File interface {
+	// Open returns an readable entity for a file. It is important to not forget
+	// to close it after the usage.
 	Open(context.Context) (io.ReadCloser, error)
+
+	// String returns a short text description for the file
 	String() string
 }

ipblocklist/files/local.go

@@ -19,6 +19,7 @@ func (l localFile) String() string {
 	return l.path
 }
 
+// NewLocal returns an openable File for a path on a local file system.
 func NewLocal(path string) (File, error) {
 	if stat, err := os.Stat(path); os.IsNotExist(err) || stat.IsDir() || stat.Mode().Perm()&0o400 == 0 {
 		return nil, fmt.Errorf("%s is not a readable file", path)

ipblocklist/files/mem.go

@@ -19,6 +19,7 @@ func (m memFile) String() string {
 	return "mem"
 }
 
+// NewMem returns an openable file that is kept in RAM.
 func NewMem(networks []*net.IPNet) File {
 	builder := strings.Builder{}
 

ipblocklist/firehol.go

@@ -27,12 +27,12 @@ var (
 // execute when ip list is updated.
 type FireholUpdateCallback func(context.Context, int)
 
-// Firehol is IPBlocklist which uses lists from FireHOL:
+// Firehol is [mtglib.IPBlocklist] which uses lists from FireHOL:
 // https://iplists.firehol.org/
 //
-// It can use both local files and remote URLs. This is not necessary
+// It can use both local files and remote URLs. This is not necessary that
-// that blocklists should be taken from this website, we expect only
+// blocklists should be taken from this website, we expect only compatible
-// compatible formats here.
+// formats here.
 //
 // Example of the format:
 //
@@ -78,8 +78,7 @@ func (f *Firehol) Contains(ip net.IP) bool {
 
 // Run starts a background update process.
 //
-// This is a blocking method so you probably want to run it in a
+// This is a blocking method so you probably want to run it in a goroutine.
-// goroutine.
 func (f *Firehol) Run(updateEach time.Duration) {
 	if updateEach == 0 {
 		updateEach = DefaultFireholUpdateEach
@@ -211,8 +210,8 @@ func (f *Firehol) updateParseLine(text string) (*net.IPNet, error) {
 
 // NewFirehol creates a new instance of FireHOL IP blocklist.
 //
-// This method does not start an update process so please execute Run
+// This method does not start an update process so please execute Run when it
-// when it is necessary.
+// is necessary.
 func NewFirehol(logger mtglib.Logger, network mtglib.Network,
 	downloadConcurrency uint,
 	urls []string,
@@ -244,6 +243,9 @@ func NewFirehol(logger mtglib.Logger, network mtglib.Network,
 	return NewFireholFromFiles(logger, downloadConcurrency, blocklists, updateCallback)
 }
 
+// NewFirehol creates a new instance of FireHOL IP blocklist.
+//
+// This method creates this instances from a given list of files.
 func NewFireholFromFiles(logger mtglib.Logger,
 	downloadConcurrency uint,
 	blocklists []files.File,

ipblocklist/init.go

@@ -1,8 +1,8 @@
 // Package ipblocklist contains default implementation of the
-// IPBlocklist for mtg.
+// [mtglib.IPBlocklist] for mtg.
 //
-// Please check documentation for mtglib.IPBlocklist interface to get an
+// Please check documentation for [mtglib.IPBlocklist] interface to get an idea
-// idea of this abstraction.
+// of this abstraction.
 package ipblocklist
 
 import "time"
@@ -12,7 +12,7 @@ const (
 	// concurrent downloads of ip blocklists for Firehol.
 	DefaultFireholDownloadConcurrency = 1
 
-	// DefaultFireholUpdateEach defines a default time period when
+	// DefaultFireholUpdateEach defines a default time period when Firehol
-	// Firehol requests updates of the blocklists.
+	// requests updates of the blocklists.
 	DefaultFireholUpdateEach = 6 * time.Hour
 )

ipblocklist/noop.go

@@ -13,8 +13,7 @@ func (n noop) Contains(ip net.IP) bool      { return false }
 func (n noop) Run(updateEach time.Duration) {}
 func (n noop) Shutdown()                    {}
 
-// NewNoop returns a dummy ipblocklist which allows all incoming
+// NewNoop returns a dummy ipblocklist which allows all incoming connections.
-// connections.
 func NewNoop() mtglib.IPBlocklist {
 	return noop{}
 }

logger/init.go

@@ -1,14 +1,12 @@
-// Package logger has implementation of loggers for mtglib.Logger
+// Package logger has implementation of loggers for [mtglib.Logger] interface.
-// interface.
 //
-// Please see a description of that interface to get some agreements
+// Please see a description of that interface to get some agreements which are
-// which are used by mtglib.
+// used by mtglib.
 package logger
 
-// StdLikeLogger is an interface which is close to log.Logger. This is
+// StdLikeLogger is an interface which is close to [log.Logger]. This is
-// commonly used by many 3pp tools. While mtglib itself does not need
+// commonly used by many 3pp tools. While mtglib itself does not need it, it is
-// it, it is always a good idea to support it and have a transient end
+// always a good idea to support it and have a transient end to end logging.
-// to end logging.
 type StdLikeLogger interface {
 	Printf(format string, args ...interface{})
 }

main.go

@@ -9,55 +9,19 @@
 package main
 
 import (
-	"fmt"
 	"math/rand"
-	"runtime/debug"
-	"strconv"
 	"time"
 
 	"github.com/9seconds/mtg/v2/internal/cli"
-	"github.com/9seconds/mtg/v2/internal/utils"
 	"github.com/alecthomas/kong"
 )
 
-var version = "dev" // has to be set by ldflags
-
 func main() {
 	rand.Seed(time.Now().UTC().UnixNano())
 
-	if err := utils.SetLimits(); err != nil {
-		panic(err)
-	}
-
-	if buildInfo, ok := debug.ReadBuildInfo(); ok {
-		vcsCommit := "<no-commit>"
-		vcsDate := time.Now()
-		vcsDirty := ""
-
-		for _, setting := range buildInfo.Settings {
-			switch setting.Key {
-			case "vcs.time":
-				vcsDate, _ = time.Parse(time.RFC3339, setting.Value)
-			case "vcs.revision":
-				vcsCommit = setting.Value
-			case "vcs.modified":
-				if isDirty, _ := strconv.ParseBool(setting.Value); isDirty {
-					vcsDirty = " [dirty]"
-				}
-			}
-		}
-
-		version = fmt.Sprintf("%s (%s: %s on %s%s)",
-			version,
-			buildInfo.GoVersion,
-			vcsDate.Format(time.RFC3339),
-			vcsCommit,
-			vcsDirty)
-	}
-
 	cli := &cli.CLI{}
 	ctx := kong.Parse(cli, kong.Vars{
-		"version": version,
+		"version": getVersion(),
 	})
 
 	ctx.FatalIfErrorf(ctx.Run(cli, version))

mtglib/events.go

@@ -29,13 +29,13 @@ type EventStart struct {
 	RemoteIP net.IP
 }
 
-// EventConnectedToDC is emitted when mtg proxy has connected to a
+// EventConnectedToDC is emitted when mtg proxy has connected to a Telegram
-// Telegram server.
+// server.
 type EventConnectedToDC struct {
 	eventBase
 
-	// RemoteIP is an IP address of the Telegram server proxy has been
+	// RemoteIP is an IP address of the Telegram server proxy has been connected
-	// connected to.
+	// to.
 	RemoteIP net.IP
 
 	// DC is an index of the datacenter proxy has been connected to.
@@ -49,15 +49,15 @@ type EventTraffic struct {
 	// Traffic is a count of bytes which were transmitted.
 	Traffic uint
 
-	// IsRead defines if we _read_ or _write_ to connection. A rule of
+	// IsRead defines if we _read_ or _write_ to connection. A rule of thumb is
-	// thumb is simple: EventTraffic is bound to a remote connection. Not
+	// simple: EventTraffic is bound to a remote connection. Not to a client one,
-	// to a client one, but either to Telegram or front domain one.
+	// but either to Telegram or front domain one.
 	//
-	// In the case of Telegram, isRead means that we've fetched some bytes
+	// In the case of Telegram, isRead means that we've fetched some bytes from
-	// from Telegram to send it to a client.
+	// Telegram to send it to a client.
 	//
-	// In the case of the front domain, it means that we've fetched some
+	// In the case of the front domain, it means that we've fetched some bytes
-	// bytes from this domain to send it to a client.
+	// from this domain to send it to a client.
 	IsRead bool
 }
 
@@ -66,20 +66,20 @@ type EventFinish struct {
 	eventBase
 }
 
-// EventDomainFronting is emitted when we connect to a front domain
+// EventDomainFronting is emitted when we connect to a front domain instead of
-// instead of Telegram server.
+// Telegram server.
 type EventDomainFronting struct {
 	eventBase
 }
 
-// EventConcurrencyLimited is emitted when connection was declined
+// EventConcurrencyLimited is emitted when connection was declined because of
-// because of the concurrency limit of the worker pool.
+// the concurrency limit of the worker pool.
 type EventConcurrencyLimited struct {
 	eventBase
 }
 
-// EventIPBlocklisted is emitted when connection was declined because
+// EventIPBlocklisted is emitted when connection was declined because IP
-// IP address was found in IP blocklist.
+// address was found in IP blocklist.
 type EventIPBlocklisted struct {
 	eventBase
 

mtglib/init.go

@@ -1,20 +1,19 @@
 // mtglib defines a package with MTPROTO proxy.
 //
-// Since mtg itself is build as an example of how to work with mtglib,
+// Since mtg itself is build as an example of how to work with mtglib, it worth
-// it worth to telling a couple of words about a project organization.
+// to telling a couple of words about a project organization.
 //
-// A core object of the project is mtglib.Proxy. This is a proxy you
+// A core object of the project is [mtglib.Proxy]. This is a proxy you expect:
-// expect: that one which you configure, set to serve on a listener
+// that one which you configure, set to serve on a listener and/or shutdown on
-// and/or shutdown on application termination.
+// application termination.
 //
-// But it also has a core logic unrelated to Telegram per se: anti
+// But it also has a core logic unrelated to Telegram per se: anti replay
-// replay cache, network connectivity (who knows, maybe you want to have
+// cache, network connectivity (who knows, maybe you want to have a native
-// a native VMESS integration) and so on.
+// VMESS integration) and so on.
 //
-// You can supply such parts to a proxy with interfaces. The rest of
+// You can supply such parts to a proxy with interfaces. The rest of the
-// the packages in mtg define some default implementations of these
+// packages in mtg define some default implementations of these interfaces. But
-// interfaces. But if you want to integrate it with, let say, influxdb,
+// if you want to integrate it with, let say, influxdb, you can do it easily.
-// you can do it easily.
 package mtglib
 
 import (
@@ -28,42 +27,42 @@ import (
 )
 
 var (
-	// ErrSecretEmpty is returned if you are trying to create a proxy
+	// ErrSecretEmpty is returned if you are trying to create a proxy but do not
-	// but do not provide a secret.
+	// provide a secret.
 	ErrSecretEmpty = errors.New("secret is empty")
 
-	// ErrSecretInvalid is returned if you are trying to create a proxy
+	// ErrSecretInvalid is returned if you are trying to create a proxy but secret
-	// but secret value is invalid (no host or payload are zeroes).
+	// value is invalid (no host or payload are zeroes).
 	ErrSecretInvalid = errors.New("secret is invalid")
 
-	// ErrNetworkIsNotDefined is returned if you are trying to create a
+	// ErrNetworkIsNotDefined is returned if you are trying to create a proxy but
-	// proxy but network value is undefined.
+	// network value is undefined.
 	ErrNetworkIsNotDefined = errors.New("network is not defined")
 
-	// ErrAntiReplayCacheIsNotDefined is returned if you are trying to
+	// ErrAntiReplayCacheIsNotDefined is returned if you are trying to create a
-	// create a proxy but anti replay cache value is undefined.
+	// proxy but anti replay cache value is undefined.
 	ErrAntiReplayCacheIsNotDefined = errors.New("anti-replay cache is not defined")
 
-	// ErrIPBlocklistIsNotDefined is returned if you are trying to
+	// ErrIPBlocklistIsNotDefined is returned if you are trying to create a proxy
-	// create a proxy but ip blocklist instance is not defined.
+	// but ip blocklist instance is not defined.
 	ErrIPBlocklistIsNotDefined = errors.New("ip blocklist is not defined")
 
-	// ErrIPAllowlistIsNotDefined is returned if you are trying to
+	// ErrIPAllowlistIsNotDefined is returned if you are trying to create a proxy
-	// create a proxy but ip allowlist instance is not defined.
+	// but ip allowlist instance is not defined.
 	ErrIPAllowlistIsNotDefined = errors.New("ip allowlist is not defined")
 
-	// ErrEventStreamIsNotDefined is returned if you are trying to create a
+	// ErrEventStreamIsNotDefined is returned if you are trying to create a proxy
-	// proxy but event stream instance is not defined.
+	// but event stream instance is not defined.
 	ErrEventStreamIsNotDefined = errors.New("event stream is not defined")
 
-	// ErrLoggerIsNotDefined is returned if you are trying to
+	// ErrLoggerIsNotDefined is returned if you are trying to create a proxy but
-	// create a proxy but logger is not defined.
+	// logger is not defined.
 	ErrLoggerIsNotDefined = errors.New("logger is not defined")
 )
 
 const (
-	// DefaultConcurrency is a default max count of simultaneously
+	// DefaultConcurrency is a default max count of simultaneously connected
-	// connected clients.
+	// clients.
 	DefaultConcurrency = 4096
 
 	// DefaultBufferSize is a default size of a copy buffer.
@@ -71,31 +70,29 @@ const (
 	// Deprecated: this setting no longer makes any effect.
 	DefaultBufferSize = 16 * 1024 // 16 kib
 
-	// DefaultDomainFrontingPort is a default port (HTTPS) to connect to in
+	// DefaultDomainFrontingPort is a default port (HTTPS) to connect to in case
-	// case of probe-resistance activity.
+	// of probe-resistance activity.
 	DefaultDomainFrontingPort = 443
 
-	// DefaultIdleTimeout is a default timeout for closing a connection
+	// DefaultIdleTimeout is a default timeout for closing a connection in case of
-	// in case of idling.
+	// idling.
 	//
-	// Deprecated: no longer in use because of changed TCP relay
+	// Deprecated: no longer in use because of changed TCP relay algorithm.
-	// algorithm.
 	DefaultIdleTimeout = time.Minute
 
-	// DefaultTolerateTimeSkewness is a default timeout for time
+	// DefaultTolerateTimeSkewness is a default timeout for time skewness on a
-	// skewness on a faketls timeout verification.
+	// faketls timeout verification.
 	DefaultTolerateTimeSkewness = 3 * time.Second
 
-	// DefaultPreferIP is a default value for Telegram IP connectivity
+	// DefaultPreferIP is a default value for Telegram IP connectivity preference.
-	// preference.
 	DefaultPreferIP = "prefer-ipv6"
 
-	// SecretKeyLength defines a length of the secret bytes used
+	// SecretKeyLength defines a length of the secret bytes used by Telegram and a
-	// by Telegram and a proxy.
+	// proxy.
 	SecretKeyLength = 16
 
-	// ConnectionIDBytesLength defines a count of random bytes used to generate
+	// ConnectionIDBytesLength defines a count of random bytes used to generate a
-	// a stream/connection ids.
+	// stream/connection ids.
 	ConnectionIDBytesLength = 16
 
 	// TCPRelayReadTimeout defines a max time period between two consecuitive
@@ -104,81 +101,76 @@ const (
 	TCPRelayReadTimeout = 20 * time.Second
 )
 
-// Network defines a knowledge how to work with a network. It may sound
+// Network defines a knowledge how to work with a network. It may sound fun but
-// fun but it encapsulates all the knowledge how to properly establish
+// it encapsulates all the knowledge how to properly establish connections to
-// connections to remote hosts and configure HTTP clients.
+// remote hosts and configure HTTP clients.
 //
-// For example, if you want to use SOCKS5 proxy, you probably want to
+// For example, if you want to use SOCKS5 proxy, you probably want to have all
-// have all traffic routed to this proxy: telegram connections, http
+// traffic routed to this proxy: telegram connections, http requests and so on.
-// requests and so on. This knowledge is encapsulated into instances of
+// This knowledge is encapsulated into instances of such interface.
-// such interface.
 //
 // mtglib uses Network for:
-//
 //  1. Dialing to Telegram
-//
 //  2. Dialing to front domain
-//
 //  3. Doing HTTP requests (for example, for FireHOL ipblocklist).
 type Network interface {
 	// Dial establishes context-free TCP connections.
 	Dial(network, address string) (essentials.Conn, error)
 
-	// DialContext dials using a context. This is a preferrable
+	// DialContext dials using a context. This is a preferrable way of
-	// way of establishing TCP connections.
+	// establishing TCP connections.
 	DialContext(ctx context.Context, network, address string) (essentials.Conn, error)
 
-	// MakeHTTPClient build an HTTP client with given dial function. If
+	// MakeHTTPClient build an HTTP client with given dial function. If nothing is
-	// nothing is provided, then DialContext of this interface is going
+	// provided, then DialContext of this interface is going to be used.
-	// to be used.
 	MakeHTTPClient(func(ctx context.Context, network, address string) (essentials.Conn, error)) *http.Client
 }
 
-// AntiReplayCache is an interface that is used to detect replay attacks
+// AntiReplayCache is an interface that is used to detect replay attacks based
-// based on some traffic fingerprints.
+// on some traffic fingerprints.
 //
-// Replay attacks are probe attacks whose main goal is to identify if
+// Replay attacks are probe attacks whose main goal is to identify if server
-// server software can be classified in some way. For example, if you
+// software can be classified in some way. For example, if you send some HTTP
-// send some HTTP request to a web server, then you can expect that this
+// request to a web server, then you can expect that this server will respond
-// server will respond with HTTP response back.
+// with HTTP response back.
 //
-// There is a problem though. Let's imagine, that connection is
+// There is a problem though. Let's imagine, that connection is encrypted.
-// encrypted. Let's imagine, that it is encrypted with some static key
+// Let's imagine, that it is encrypted with some static key like [ShadowSocks].
-// like ShadowSocks (https://shadowsocks.org/assets/whitepaper.pdf).
+// In that case, in theory, if you repeat the same bytes, you can get the same
-// In that case, in theory, if you repeat the same bytes, you can get
+// responses. Let's imagine, that you've cracked the key. then if you send the
-// the same responses. Let's imagine, that you've cracked the key. then
+// same bytes, you can decrypt a response and see its structure. Based on its
-// if you send the same bytes, you can decrypt a response and see its
+// structure you can identify if this server is SOCKS5, MTPROTO proxy etc.
-// structure. Based on its structure you can identify if this server is
-// SOCKS5, MTPROTO proxy etc.
 //
-// This is just one example, maybe not the best or not the most
+// This is just one example, maybe not the best or not the most relevant. In
-// relevant. In real life, different organizations use such replay
+// real life, different organizations use such replay attacks to perform some
-// attacks to perform some reverse engineering of the proxy, do some
+// reverse engineering of the proxy, do some statical analysis to identify
-// statical analysis to identify server software.
+// server software.
 //
-// There are many ways how to protect your proxy against them. One
+// There are many ways how to protect your proxy against them. One is domain
-// is domain fronting which is a core part of mtg. Another one is to
+// fronting which is a core part of mtg. Another one is to collect some
-// collect some 'handshake fingerprints' and forbid duplication.
+// 'handshake fingerprints' and forbid duplication.
 //
-// So, it one is sending the same byte flow right after you (or a couple
+// So, it one is sending the same byte flow right after you (or a couple of
-// of hours after), mtg should detect that and reject this connection
+// hours after), mtg should detect that and reject this connection (or redirect
-// (or redirect to fronting domain).
+// to fronting domain).
+//
+// [ShadowSocks]: https://shadowsocks.org/assets/whitepaper.pdf
 type AntiReplayCache interface {
-	// Seen before checks if this set of bytes was observed before or
+	// Seen before checks if this set of bytes was observed before or not. If it
-	// not. If it is required to store this information somewhere else,
+	// is required to store this information somewhere else, then it has to do
-	// then it has to do that.
+	// that.
 	SeenBefore(data []byte) bool
 }
 
 // IPBlocklist filters requests based on IP address.
 //
-// If this filter has an IP address, then mtg closes a request without
+// If this filter has an IP address, then mtg closes a request without reading
-// reading anything from a socket. It also does not give such request to
+// anything from a socket. It also does not give such request to a worker pool,
-// a worker pool, so in worst cases you can expect that you invoke this
+// so in worst cases you can expect that you invoke this object more frequent
-// object more frequent than defined proxy concurrency.
+// than defined proxy concurrency.
 type IPBlocklist interface {
-	// Contains checks if given IP address belongs to this blocklist If.
+	// Contains checks if given IP address belongs to this blocklist If. it is, a
-	// it is, a connection is terminated                               .
+	// connection is terminated .
 	Contains(net.IP) bool
 
 	// Run starts a background update procedure for a blocklist
@@ -188,40 +180,35 @@ type IPBlocklist interface {
 	Shutdown()
 }
 
-// Event is a data structure which is populated during mtg request
+// Event is a data structure which is populated during mtg request processing
-// processing lifecycle. Each request popluates many events:
+// lifecycle. Each request popluates many events:
-//
 //  1. Client connected
-//
 //  2. Request is finished
-//
 //  3. Connection to Telegram server is established
 //
-// and so on. All these events are data structures but all of them
+// and so on. All these events are data structures but all of them must conform
-// must conform the same interface.
+// the same interface.
 type Event interface {
-	// StreamID returns an identifier of the stream, connection,
+	// StreamID returns an identifier of the stream, connection, request, you name
-	// request, you name it. All events within the same stream returns
+	// it. All events within the same stream returns the same stream id.
-	// the same stream id.
 	StreamID() string
 
 	// Timestamp returns a timestamp when this event was generated.
 	Timestamp() time.Time
 }
 
-// EventStream is an abstraction that accepts a set of events produced
+// EventStream is an abstraction that accepts a set of events produced by mtg.
-// by mtg. Its main goal is to inject your logging or monitoring system.
+// Its main goal is to inject your logging or monitoring system.
 //
-// The idea is simple. When mtg works, it emits a set of events during
+// The idea is simple. When mtg works, it emits a set of events during a
-// a lifecycle of the requestor: EventStart, EventFinish etc. mtg is a
+// lifecycle of the requestor: EventStart, EventFinish etc. mtg is a producer
-// producer which puts these events into a stream. Responsibility of
+// which puts these events into a stream. Responsibility of the stream is to
-// the stream is to deliver this event to consumers/observers. There
+// deliver this event to consumers/observers. There might be many different
-// might be many different observers (for example, you want to have both
+// observers (for example, you want to have both statsd and prometheus), mtg
-// statsd and prometheus), mtg should know nothing about them.
+// should know nothing about them.
 type EventStream interface {
-	// Send delivers an event to observers. Given context has to be
+	// Send delivers an event to observers. Given context has to be respected. If
-	// respected. If the context is closed, all blocking operations should
+	// the context is closed, all blocking operations should be released ASAP.
-	// be released ASAP.
 	//
 	// It is possible that context is closed but the message is delivered.
 	// EventStream implementations should solve this issue somehow.
@@ -230,27 +217,26 @@ type EventStream interface {
 
 // Logger defines an interface of the logger used by mtglib.
 //
-// Each logger has a name. It is possible to stack names to organize
+// Each logger has a name. It is possible to stack names to organize poor-man
-// poor-man namespaces. Also, each logger must be able to bind
+// namespaces. Also, each logger must be able to bind parameters to avoid
-// parameters to avoid pushing them all the time.
+// pushing them all the time.
 //
 // Example
 //
-//     logger := SomeLogger{}
+//	logger := SomeLogger{} logger = logger.BindStr("ip", net.IP{127, 0, 0, 1})
-//     logger = logger.BindStr("ip", net.IP{127, 0, 0, 1})
 //	logger.Info("Hello")
 //
-// In that case, ip is bound as a parameter. It is a great idea to
+// In that case, ip is bound as a parameter. It is a great idea to put this
-// put this parameter somewhere in a log message.
+// parameter somewhere in a log message.
 //
-//     logger1 = logger.BindStr("param1", "11")
+//	logger1 = logger.BindStr("param1", "11") logger2 = logger.BindInt("param2",
-//     logger2 = logger.BindInt("param2", 11)
+//	11)
 //
 // logger1 should see no param2 and vice versa, logger2 should not see param1
 // If you attach a parameter to a logger, parents should not know about that.
 type Logger interface {
-	// Named returns a new logger with a bound name. Name chaining is
+	// Named returns a new logger with a bound name. Name chaining is allowed and
-	// allowed and appreciated.
+	// appreciated.
 	Named(name string) Logger
 
 	// BindInt binds new integer parameter to a new logger instance.
@@ -268,22 +254,21 @@ type Logger interface {
 	// Info puts a message about some normal situation.
 	Info(msg string)
 
-	// InfoError puts a message about some normal situation but this
+	// InfoError puts a message about some normal situation but this situation is
-	// situation is related to a given error.
+	// related to a given error.
 	InfoError(msg string, err error)
 
-	// Warning puts a message about some extraordinary situation
+	// Warning puts a message about some extraordinary situation worth to look at.
-	// worth to look at.
 	Warning(msg string)
 
-	// WarningError puts a message about some extraordinary situation
+	// WarningError puts a message about some extraordinary situation worth to
-	// worth to look at. This situation is related to a given error.
+	// look at. This situation is related to a given error.
 	WarningError(msg string, err error)
 
 	// Debug puts a message useful for debugging only.
 	Debug(msg string)
 
-	// Debug puts a message useful for debugging only. This message is
+	// Debug puts a message useful for debugging only. This message is related to
-	// related to a given error.
+	// a given error.
 	DebugError(msg string, err error)
 }

mtglib/proxy.go

@@ -44,8 +44,8 @@ func (p *Proxy) DomainFrontingAddress() string {
 	return net.JoinHostPort(p.secret.Host, strconv.Itoa(p.domainFrontingPort))
 }
 
-// ServeConn serves a connection. We do not check IP blocklist and
+// ServeConn serves a connection. We do not check IP blocklist and concurrency
-// concurrency limit here.
+// limit here.
 func (p *Proxy) ServeConn(conn essentials.Conn) {
 	p.streamWaitGroup.Add(1)
 	defer p.streamWaitGroup.Done()
@@ -138,8 +138,8 @@ func (p *Proxy) Serve(listener net.Listener) error {
 	}
 }
 
-// Shutdown 'gracefully' shutdowns all connections. Please remember that
+// Shutdown 'gracefully' shutdowns all connections. Please remember that it
-// it does not close an underlying listener.
+// does not close an underlying listener.
 func (p *Proxy) Shutdown() {
 	p.ctxCancel()
 	p.streamWaitGroup.Wait()

mtglib/proxy_opts.go

@@ -4,16 +4,16 @@ import "time"
 
 // ProxyOpts is a structure with settings to mtg proxy.
 //
-// This is not required per se, but this is to shorten function
+// This is not required per se, but this is to shorten function signature and
-// signature and give an ability to conveniently provide default values.
+// give an ability to conveniently provide default values.
 type ProxyOpts struct {
 	// Secret defines a secret which should be used by a proxy.
 	//
 	// This is a mandatory setting.
 	Secret Secret
 
-	// Network defines a network instance which should be used for all
+	// Network defines a network instance which should be used for all network
-	// network communications made by proxies.
+	// communications made by proxies.
 	//
 	// This is a mandatory setting.
 	Network Network
@@ -45,9 +45,8 @@ type ProxyOpts struct {
 
 	// BufferSize is a size of the copy buffer in bytes.
 	//
-	// Please remember that we multiply this number in 2, because when
+	// Please remember that we multiply this number in 2, because when we relay
-	// we relay between proxies, we have to create 2 intermediate
+	// between proxies, we have to create 2 intermediate buffers: to and from.
-	// buffers: to and from.
 	//
 	// This is an optional setting.
 	//
@@ -62,22 +61,20 @@ type ProxyOpts struct {
 	// This is an optional setting.
 	Concurrency uint
 
-	// IdleTimeout is a timeout for relay when we have to break a
+	// IdleTimeout is a timeout for relay when we have to break a stream.
-	// stream.
 	//
-	// This is a timeout for any activity. So, if we have any message
+	// This is a timeout for any activity. So, if we have any message which will
-	// which will pass to either direction, a timer is reset. If we have
+	// pass to either direction, a timer is reset. If we have no any reads or
-	// no any reads or writes for this timeout, a connection will be
+	// writes for this timeout, a connection will be aborted.
-	// aborted.
 	//
 	// This is an optional setting.
 	IdleTimeout time.Duration
 
-	// TolerateTimeSkewness is a time boundary that defines a time
+	// TolerateTimeSkewness is a time boundary that defines a time range where
-	// range where faketls timestamp is acceptable.
+	// faketls timestamp is acceptable.
 	//
-	// This means that if if you got a timestamp X, now is Y, then
+	// This means that if if you got a timestamp X, now is Y, then if |X-Y| <
-	// if |X-Y| < TolerateTimeSkewness, then you accept a packet.
+	// TolerateTimeSkewness, then you accept a packet.
 	//
 	// This is an optional setting.
 	TolerateTimeSkewness time.Duration
@@ -88,30 +85,29 @@ type ProxyOpts struct {
 	// This is an optional setting.
 	PreferIP string
 
-	// DomainFrontingPort is a port we use to connect to a fronting
+	// DomainFrontingPort is a port we use to connect to a fronting domain.
-	// domain.
 	//
-	// This is required because secret does not specify a port. It
+	// This is required because secret does not specify a port. It specifies a
-	// specifies a hostname only.
+	// hostname only.
 	//
 	// This is an optional setting.
 	DomainFrontingPort uint
 
 	// AllowFallbackOnUnknownDC defines how proxy behaves if unknown DC was
-	// requested. If this setting is set to false, then such connection
+	// requested. If this setting is set to false, then such connection will be
-	// will be rejected. Otherwise, proxy will chose any DC.
+	// rejected. Otherwise, proxy will chose any DC.
 	//
-	// Telegram is designed in a way that any DC can serve any request,
+	// Telegram is designed in a way that any DC can serve any request, the
-	// the problem is a latency.
+	// problem is a latency.
 	//
 	// This is an optional setting.
 	AllowFallbackOnUnknownDC bool
 
-	// UseTestDCs defines if we have to connect to production or to staging
+	// UseTestDCs defines if we have to connect to production or to staging DCs of
-	// DCs of Telegram.
+	// Telegram.
 	//
-	// This is required if you use mtglib as an integration library for
+	// This is required if you use mtglib as an integration library for your
-	// your Telegram-related projects.
+	// Telegram-related projects.
 	//
 	// This is an optional setting.
 	UseTestDCs bool

mtglib/secret.go

@@ -21,24 +21,23 @@ var secretEmptyKey [SecretKeyLength]byte
 //	|-|-------------------------------|-------------------------------------------
 //	p key                             hostname
 //
-// Serialized secret starts with 'ee'. Actually, in the past we also had
+// Serialized secret starts with 'ee'. Actually, in the past we also had 'dd'
-// 'dd' secrets and prefixless ones. But this is history. Currently,
+// secrets and prefixless ones. But this is history. Currently, we do have only
-// we do have only 'ee' secrets which mean faketls + protection from
+// 'ee' secrets which mean faketls + protection from statistical attacks on a
-// statistical attacks on a length. 'ee' is a byte 238 (0xee).
+// length. 'ee' is a byte 238 (0xee).
 //
-// After that, we have 16 bytes of the key. This is a random generated
+// After that, we have 16 bytes of the key. This is a random generated secret
-// secret data of the proxy and this data is used to derive
+// data of the proxy and this data is used to derive authentication schemas.
-// authentication schemas. These secrets are mixed into hmacs and sha256
+// These secrets are mixed into hmacs and sha256 checksums which are used to
-// checksums which are used to build AEAD ciphers for obfuscated2
+// build AEAD ciphers for obfuscated2 protocol and ensure faketls handshake.
-// protocol and ensure faketls handshake.
 //
-// Host is a domain fronting hostname in latin1 (ASCII) encoding. This
+// Host is a domain fronting hostname in latin1 (ASCII) encoding. This hostname
-// hostname should be used for SNI in faketls and MTG verifies it. Also,
+// should be used for SNI in faketls and MTG verifies it. Also, this is when
-// this is when mtg gets about a domain fronting hostname.
+// mtg gets about a domain fronting hostname.
 //
-// Secrets can be serialized into 2 forms: hex and base64. If
+// Secrets can be serialized into 2 forms: hex and base64. If you decode both
-// you decode both forms into bytes, you'll get the same byte array.
+// forms into bytes, you'll get the same byte array. Telegram clients nowadays
-// Telegram clients nowadays accept all forms.
+// accept all forms.
 type Secret struct {
 	// Key is a set of bytes used for traffic authentication.
 	Key [SecretKeyLength]byte

mtglib/stream_context_internal_test.go

@@ -24,7 +24,7 @@ func (suite *StreamContextTestSuite) SetupSuite() {
 
 func (suite *StreamContextTestSuite) SetupTest() {
 	ctx, cancel := context.WithCancel(context.Background())
-	ctx = context.WithValue(ctx, "key", "value") // nolint: golint, revive, staticcheck
+	ctx = context.WithValue(ctx, "key", "value") //nolint: golint, staticcheck
 
 	suite.ctxCancel = cancel
 	suite.connMock = &testlib.EssentialsConnMock{}

network/dns_resolver.go

@@ -85,13 +85,13 @@ func (d *dnsResolver) LookupAAAA(hostname string) []string {
 	return ips
 }
 
-func newDNSResolver(hostname string, httpClient *http.Client) (ret *dnsResolver) {
+func newDNSResolver(hostname string, httpClient *http.Client) *dnsResolver {
 	if net.ParseIP(hostname).To4() == nil {
 		// the hostname is an IPv6 address
 		hostname = fmt.Sprintf("[%s]", hostname)
 	}
 
-	ret = &dnsResolver{
+	return &dnsResolver{
 		resolver: doh.Resolver{
 			Host:       hostname,
 			Class:      doh.IN,
@@ -99,6 +99,4 @@ func newDNSResolver(hostname string, httpClient *http.Client) (ret *dnsResolver)
 		},
 		cache: map[string]dnsResolverCacheEntry{},
 	}
-
-	return
 }

network/init.go

@@ -1,19 +1,15 @@
 // Network contains a default implementation of the network.
 //
-// Please see mtglib.Network interface to get some basic idea behind
+// Please see [mtglib.Network] interface to get some basic idea behind this
-// this abstraction.
+// abstraction.
 //
 // Some notable feature of this implementation:
 //
-// 1. It detaches dialer from a network. Dialer is something which
+//  1. It detaches dialer from a network. Dialer is something which implements a
-// implements a real dialer and network completes it with more higher
+//     real dialer and network completes it with more higher level details.
-// level details.
-//
 //  2. It uses only TCP connections. Even for DNS it uses DNS-Over-HTTPS
-//
+//  3. It has some simple implementation of DNS cache which is good enough for
-// 3. It has some simple implementation of DNS cache which is good
+//     our purpose.
-// enough for our purpose.
-//
 //  4. It sets uses SO_REUSEPORT port if applicable.
 package network
 
@@ -26,53 +22,47 @@ import (
 )
 
 const (
-	// DefaultTimeout is a default timeout for establishing TCP
+	// DefaultTimeout is a default timeout for establishing TCP connection.
-	// connection.
 	DefaultTimeout = 10 * time.Second
 
-	// DefaultHTTPTimeout defines a default timeout for making HTTP
+	// DefaultHTTPTimeout defines a default timeout for making HTTP request.
-	// request.
 	DefaultHTTPTimeout = 10 * time.Second
 
 	// Deprecated:
 	//
-	// DefaultBufferSize defines a TCP buffer size. Both read and write, so
+	// DefaultBufferSize defines a TCP buffer size. Both read and write, so for
-	// for real size, please multiply this number by 2.
+	// real size, please multiply this number by 2.
 	DefaultBufferSize = 16 * 1024 // 16 kib
 
-	// DefaultTCPKeepAlivePeriod defines a time period between 2
+	// DefaultTCPKeepAlivePeriod defines a time period between 2 consequitive
-	// consequitive probes.
+	// probes.
 	DefaultTCPKeepAlivePeriod = 10 * time.Second
 
-	// ProxyDialerOpenThreshold is used for load balancing SOCKS5 dialer
+	// ProxyDialerOpenThreshold is used for load balancing SOCKS5 dialer only.
-	// only.
 	//
-	// This dialer uses circuit breaker with of 3 stages: OPEN,
+	// This dialer uses circuit breaker with of 3 stages: OPEN, HALF_OPEN and
-	// HALF_OPEN and CLOSED. If state is CLOSED, all requests go in
+	// CLOSED. If state is CLOSED, all requests go in a normal mode. If you get
-	// a normal mode. If you get more that ProxyDialerOpenThreshold
+	// more that ProxyDialerOpenThreshold errors, circuit breaker goes into OPEN
-	// errors, circuit breaker goes into OPEN mode.
+	// mode.
 	//
-	// When circuit breaker is in OPEN mode, it forbids all request to
+	// When circuit breaker is in OPEN mode, it forbids all request to a given
-	// a given proxy. But after ProxyDialerHalfOpenTimeout it gives a
+	// proxy. But after ProxyDialerHalfOpenTimeout it gives a second chance and
-	// second chance and opens an access for a SINGLE request. If this
+	// opens an access for a SINGLE request. If this request success, then circuit
-	// request success, then circuit breaker closes, otherwise opens
+	// breaker closes, otherwise opens again.
-	// again.
 	//
 	// When circuit breaker is closed, it clears an error states each
 	// ProxyDialerResetFailuresTimeout.
 	ProxyDialerOpenThreshold = 5
 
-	// ProxyDialerHalfOpenTimeout defines a halfopen timeout for circuit
+	// ProxyDialerHalfOpenTimeout defines a halfopen timeout for circuit breaker.
-	// breaker.
 	ProxyDialerHalfOpenTimeout = time.Minute
 
-	// ProxyDialerResetFailuresTimeout defines a timeout for resetting a
+	// ProxyDialerResetFailuresTimeout defines a timeout for resetting a failure.
-	// failure.
 	ProxyDialerResetFailuresTimeout = 10 * time.Second
 
-	// DefaultDOHHostname defines a default IP address for DOH host.
+	// DefaultDOHHostname defines a default IP address for DOH host. Since mtg is
-	// Since mtg is simple, please pass IP address here. We do not
+	// simple, please pass IP address here. We do not have bootstrap servers here
-	// have bootstrap servers here embedded.
+	// embedded.
 	DefaultDOHHostname = "9.9.9.9"
 
 	// DNSTimeout defines a timeout for DNS queries.
@@ -84,12 +74,12 @@ const (
 )
 
 var (
-	// ErrCircuitBreakerOpened is returned when proxy is being accessed
+	// ErrCircuitBreakerOpened is returned when proxy is being accessed but
-	// but circuit breaker is opened.
+	// circuit breaker is opened.
 	ErrCircuitBreakerOpened = errors.New("circuit breaker is opened")
 
-	// ErrCannotDialWithAllProxies is returned when load balancing
+	// ErrCannotDialWithAllProxies is returned when load balancing client is
-	// client is trying to access proxies but all of them are failed.
+	// trying to access proxies but all of them are failed.
 	ErrCannotDialWithAllProxies = errors.New("cannot dial with all proxies")
 )
 

network/load_balanced_socks5.go

@@ -33,16 +33,14 @@ func (l loadBalancedSocks5Dialer) DialContext(ctx context.Context, network, addr
 	return nil, ErrCannotDialWithAllProxies
 }
 
-// NewLoadBalancedSocks5Dialer builds a new load balancing SOCKS5
+// NewLoadBalancedSocks5Dialer builds a new load balancing SOCKS5 dialer.
-// dialer.
 //
-// The main difference from one which is made by NewSocks5Dialer is that
+// The main difference from one which is made by NewSocks5Dialer is that we
-// we actually have a list of these proxies. When dial is requested,
+// actually have a list of these proxies. When dial is requested, any proxy is
-// any proxy is picked and used. If proxy fails for some reason, we try
+// picked and used. If proxy fails for some reason, we try another one.
-// another one.
 //
-// So, it is mostly useful if you have some routes with proxies which
+// So, it is mostly useful if you have some routes with proxies which are not
-// are not always online or having buggy network.
+// always online or having buggy network.
 func NewLoadBalancedSocks5Dialer(baseDialer Dialer, proxyURLs []*url.URL) (Dialer, error) {
 	dialers := make([]Dialer, 0, len(proxyURLs))
 

network/network.go

@@ -118,8 +118,8 @@ func (n *network) dnsResolve(protocol, address string) ([]string, error) {
 	return ips, nil
 }
 
-// NewNetwork assembles an mtglib.Network compatible structure
+// NewNetwork assembles an mtglib.Network compatible structure based on a
-// based on a dialer and given params.
+// dialer and given params.
 //
 // It brings simple DNS cache and DNS-Over-HTTPS when necessary.
 func NewNetwork(dialer Dialer,

network/sockopts_unix.go

@@ -14,14 +14,14 @@ func setSocketReuseAddrPort(conn syscall.RawConn) error {
 	var err error
 
 	conn.Control(func(fd uintptr) { //nolint: errcheck
-		err = unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_REUSEADDR, 1)
+		err = unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_REUSEADDR, 1) //nolint: nosnakecase
 		if err != nil {
 			err = fmt.Errorf("cannot set SO_REUSEADDR: %w", err)
 
 			return
 		}
 
-		err = unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_REUSEPORT, 1)
+		err = unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_REUSEPORT, 1) //nolint: nosnakecase
 		if err != nil {
 			err = fmt.Errorf("cannot set SO_REUSEPORT: %w", err)
 		}

network/socks5.go

@@ -136,8 +136,8 @@ func (s socks5Dialer) connect(conn io.ReadWriter, address string) error {
 	return nil
 }
 
-// NewSocks5Dialer build a new dialer from a given one (so, in theory
+// NewSocks5Dialer build a new dialer from a given one (so, in theory you can
-// you can chain here). Proxy parameters are passed with URI in a form of:
+// chain here). Proxy parameters are passed with URI in a form of:
 //
 //	socks5://[user:[password]]@host:port
 func NewSocks5Dialer(baseDialer Dialer, proxyURL *url.URL) (Dialer, error) {

stats/init.go

@@ -1,4 +1,4 @@
-// Stats package has implementations of events.Observers for different
+// Stats package has implementations of [events.Observer] for different
 // monitoring systems.
 //
 // Observer is a consumer of events produced by mtg. Consumers, defined

stats/prometheus.go

@@ -139,12 +139,11 @@ func (p prometheusProcessor) Shutdown() {
 	}
 }
 
-// PrometheusFactory is a factory of events.Observers which collect
+// PrometheusFactory is a factory of [events.Observer] which collect
 // information in a format suitable for Prometheus.
 //
-// This factory can also serve on a given listener. In that case it
+// This factory can also serve on a given listener. In that case it starts HTTP
-// starts HTTP server with a single endpoint - a Prometheus-compatible
+// server with a single endpoint - a Prometheus-compatible scrape output.
-// scrape output.
 type PrometheusFactory struct {
 	httpServer *http.Server
 

stats/statsd.go

@@ -147,13 +147,13 @@ func (s statsdProcessor) Shutdown() {
 	}
 }
 
-// StatsdFactory is a factory of events.Observers which dumps
+// StatsdFactory is a factory of [events.Observer] which dumps information to
-// information to statsd.
+// statsd.
 //
-// Please beware that we support ONLY UDP endpoints there. And this
+// Please beware that we support ONLY UDP endpoints there. And this factory
-// factory won't use mtglib.Network so it won't use a proxy if you
+// won't use [mtglib.Network] so it won't use a proxy if you provide any. If
-// provide any. If you need it, I would recommend starting a local
+// you need it, I would recommend starting a local statsd and route metrics
-// statsd and route metrics further by features of the chosen server.
+// further by features of the chosen server.
 type StatsdFactory struct {
 	client *statsd.Client
 }
@@ -171,8 +171,7 @@ func (s StatsdFactory) Make() events.Observer {
 	}
 }
 
-// NewStatsd builds an events.ObserverFactory that sends events
+// NewStatsd builds an [events.ObserverFactory] that sends events to statsd.
-// to statsd.
 //
 // Valid tagFormats are 'datadog', 'influxdb' and 'graphite'.
 func NewStatsd(address string, log logger.StdLikeLogger,