Merge pull request #837 from gotd/feat/add-exchange-timeout-option

feat(client): add ExchangeTimeout, DialTimeout to options
gotd · Aug 7, 2022 · 97c64c0 · 97c64c0
2 parents 26f5d01 + b47cc20
commit 97c64c0
Show file tree

Hide file tree

Showing 29 changed files with 80 additions and 78 deletions.
diff --git a/bin/bin.go b/bin/bin.go
@@ -4,8 +4,8 @@
 // This package is not intended to be used directly.
 //
 // Ref:
-//	* https://core.telegram.org/mtproto/serialize
-//	* https://core.telegram.org/mtproto/TL-abstract-types
+//   - https://core.telegram.org/mtproto/serialize
+//   - https://core.telegram.org/mtproto/TL-abstract-types
 package bin
 
 // Basic TL types.

diff --git a/clock/clock.go b/clock/clock.go
@@ -27,5 +27,5 @@ func StopTimer(t Timer) {
 	}
 }
 
-// Ticker abstracts a channel that delivers ``ticks'' of a clock at intervals.
+// Ticker abstracts a channel that delivers “ticks” of a clock at intervals.
 type Ticker = neo.Ticker
diff --git a/constant/credentials.go b/constant/credentials.go
@@ -4,7 +4,7 @@ package constant
 // test authentication.
 //
 // Reference:
-//	* https://github.com/telegramdesktop/tdesktop/blob/5f665b8ecb48802cd13cfb48ec834b946459274a/docs/api_credentials.md
+//   - https://github.com/telegramdesktop/tdesktop/blob/5f665b8ecb48802cd13cfb48ec834b946459274a/docs/api_credentials.md
 const (
 	TestAppID   = 17349
 	TestAppHash = "344583e45741c457fe1862106095a5eb"

diff --git a/gorules/rules.go b/gorules/rules.go
@@ -7,11 +7,11 @@ import (
 
 // ZapPreferNoWith suggests replace expressions like
 //
-// 	l.With(...).Debug("")
+//	l.With(...).Debug("")
 //
 // to
 //
-// 	l.Debug("", ...).
+//	l.Debug("", ...).
 //
 // where l is a *zap.Logger.
 func ZapPreferNoWith(m dsl.Matcher) {
@@ -25,11 +25,11 @@ func ZapPreferNoWith(m dsl.Matcher) {
 
 // UberStyleErrors detects error messages like
 //
-// 	errors.Wrap(err, "failed to do something")
+//	errors.Wrap(err, "failed to do something")
 //
 // but you should avoid "failed to" and use
 //
-// 	errors.Wrap(err, "do something")
+//	errors.Wrap(err, "do something")
 //
 // according to https://github.com/uber-go/guide/blob/master/style.md#error-wrapping.
 func UberStyleErrors(m dsl.Matcher) {
@@ -48,12 +48,11 @@ func UberStyleErrors(m dsl.Matcher) {
 
 // UnnecessaryErrorFormat detects unnecessary error formatting like
 //
-// 	errors.New("error")
+//	errors.New("error")
 //
 // and suggests instead
 //
-// 	errors.New("error")
-//
+//	errors.New("error")
 func UnnecessaryErrorFormat(m dsl.Matcher) {
 	m.Match("fmt.Errorf($msg)").Suggest("errors.New($msg)")
 	m.Match("errors.Errorf($msg)").Suggest("errors.New($msg)")

diff --git a/internal/crypto/dh_test.go b/internal/crypto/dh_test.go
@@ -15,6 +15,7 @@ import (
 // See https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
 //
 // Values:
+//
 //	gA is g_a
 //	dhPrime is dh_prime
 //	gB is g_b

diff --git a/internal/crypto/doc.go b/internal/crypto/doc.go
@@ -1,5 +1,5 @@
 // Package crypto implements cryptographical primitives for MTproto.
 //
 // Reference:
-//	* https://core.telegram.org/mtproto/auth_key
+//   - https://core.telegram.org/mtproto/auth_key
 package crypto
diff --git a/internal/crypto/keys.go b/internal/crypto/keys.go
@@ -98,6 +98,7 @@ func aesIV(sha256a, sha256b []byte, v *bin.Int256) {
 // See https://core.telegram.org/mtproto/description#defining-aes-key-and-initialization-vector
 //
 // Example:
+//
 //	key, iv := crypto.Keys(authKey, messageKey, crypto.Client)
 //	cipher, err := aes.NewCipher(key[:])
 //	if err != nil {

diff --git a/internal/crypto/keys_old.go b/internal/crypto/keys_old.go
@@ -60,6 +60,7 @@ func sha1d(r []byte, authKey Key, msgKey bin.Int128, x int) []byte {
 // See https://core.telegram.org/mtproto/description_v1#defining-aes-key-and-initialization-vector
 //
 // Example:
+//
 //	key, iv := crypto.OldKeys(authKey, messageKey, crypto.Client)
 //	cipher, err := aes.NewCipher(key[:])
 //	if err != nil {

diff --git a/internal/gen/names.go b/internal/gen/names.go
@@ -89,13 +89,12 @@ func splitByWords(s string) []string {
 
 // pascal converts the given name into a PascalCase.
 //
-//	user_info 	 => UserInfo
-//	full_name 	 => FullName
-//	user_id   	 => UserID
-//	full-admin	 => FullAdmin
-//  cdnConfig    => CDNConfig
-//  cdn_1_config => CDN1Config
-//
+//		user_info 	 => UserInfo
+//		full_name 	 => FullName
+//		user_id   	 => UserID
+//		full-admin	 => FullAdmin
+//	 cdnConfig    => CDNConfig
+//	 cdn_1_config => CDN1Config
 func pascal(s string) string {
 	words := splitByWords(s)
 	return pascalWords(words)
@@ -107,7 +106,6 @@ func pascal(s string) string {
 //	full_name  => fullName
 //	user_id    => userID
 //	full-admin => fullAdmin
-//
 func camel(s string) string {
 	words := splitByWords(s)
 	if len(words) == 1 {

diff --git a/internal/mtproto/connect.go b/internal/mtproto/connect.go
@@ -62,6 +62,17 @@ func (c *Conn) createAuthKey(ctx context.Context) error {
 	c.exchangeLock.Lock()
 	defer c.exchangeLock.Unlock()
 
+	if ce := c.log.Check(zap.DebugLevel, "Initializing new key exchange"); ce != nil {
+		// Useful for debugging i/o timeout errors on tcp reads or writes.
+		fields := []zap.Field{
+			zap.Duration("timeout", c.exchangeTimeout),
+		}
+		if deadline, ok := ctx.Deadline(); ok {
+			fields = append(fields, zap.Time("context_deadline", deadline))
+		}
+		ce.Write(fields...)
+	}
+
 	r, err := exchange.NewExchanger(c.conn, c.dcID).
 		WithClock(c.clock).
 		WithLogger(c.log.Named("exchange")).

diff --git a/internal/mtproto/options.go b/internal/mtproto/options.go
@@ -122,7 +122,7 @@ func (opt *Options) setDefaults() {
 		opt.MaxRetries = 5
 	}
 	if opt.DialTimeout == 0 {
-		opt.DialTimeout = 15 * time.Second
+		opt.DialTimeout = 35 * time.Second
 	}
 	if opt.ExchangeTimeout == 0 {
 		opt.ExchangeTimeout = exchange.DefaultTimeout

diff --git a/internal/tdsync/cancel_group.go b/internal/tdsync/cancel_group.go
@@ -20,13 +20,14 @@ type CancellableGroup struct {
 // NewCancellableGroup creates new CancellableGroup.
 //
 // Example:
-//		g := NewCancellableGroup(ctx)
-//		g.Go(func(ctx context.Context) error {
-//			<-ctx.Done()
-//			return ctx.Err()
-//		})
-//		g.Cancel()
-//		g.Wait()
+//
+//	g := NewCancellableGroup(ctx)
+//	g.Go(func(ctx context.Context) error {
+//		<-ctx.Done()
+//		return ctx.Err()
+//	})
+//	g.Cancel()
+//	g.Wait()
 func NewCancellableGroup(parent context.Context) *CancellableGroup {
 	ctx, cancel := context.WithCancel(parent)
 	group, groupCtx := errgroup.WithContext(ctx)

diff --git a/internal/testutil/external.go b/internal/testutil/external.go
@@ -14,7 +14,8 @@ import (
 // like TestExternalE2EConnect.
 //
 // Run all tests with following command in module root:
-// 	GOTD_TEST_EXTERNAL=1 go test -v -run ^TestExternalE2E ./...
+//
+//	GOTD_TEST_EXTERNAL=1 go test -v -run ^TestExternalE2E ./...
 func SkipExternal(tb testing.TB) {
 	const env = "GOTD_TEST_EXTERNAL"
 

diff --git a/session/tdesktop/tdesktop.go b/session/tdesktop/tdesktop.go
@@ -24,7 +24,6 @@ type Account struct {
 // Shorthand for:
 //
 //	ReadFS(os.DirFS(root), passcode)
-//
 func Read(root string, passcode []byte) ([]Account, error) {
 	return ReadFS(os.DirFS(root), passcode)
 }

diff --git a/telegram/builder.go b/telegram/builder.go
@@ -39,9 +39,10 @@ func sessionDir() (string, error) {
 // using environment variables.
 //
 // Variables:
-// 	SESSION_FILE:        path to session file
-// 	SESSION_DIR:         path to session directory, if SESSION_FILE is not set
-// 	ALL_PROXY, NO_PROXY: see https://pkg.go.dev/golang.org/x/net/proxy#FromEnvironment
+//
+//	SESSION_FILE:        path to session file
+//	SESSION_DIR:         path to session directory, if SESSION_FILE is not set
+//	ALL_PROXY, NO_PROXY: see https://pkg.go.dev/golang.org/x/net/proxy#FromEnvironment
 func OptionsFromEnvironment(opts Options) (Options, error) {
 	// Setting up session storage if not provided.
 	if opts.SessionStorage == nil {
@@ -77,8 +78,9 @@ func OptionsFromEnvironment(opts Options) (Options, error) {
 // but does not connect to server.
 //
 // Variables:
-// 	APP_ID:   app_id of Telegram app.
-// 	APP_HASH: app_hash of Telegram app.
+//
+//	APP_ID:   app_id of Telegram app.
+//	APP_HASH: app_hash of Telegram app.
 func ClientFromEnvironment(opts Options) (*Client, error) {
 	appID, err := strconv.Atoi(os.Getenv("APP_ID"))
 	if err != nil {

diff --git a/telegram/cfg.go b/telegram/cfg.go
@@ -21,7 +21,7 @@ const (
 // test authentication.
 //
 // Reference:
-//	* https://github.com/telegramdesktop/tdesktop/blob/5f665b8ecb48802cd13cfb48ec834b946459274a/docs/api_credentials.md
+//   - https://github.com/telegramdesktop/tdesktop/blob/5f665b8ecb48802cd13cfb48ec834b946459274a/docs/api_credentials.md
 const (
 	TestAppID   = constant.TestAppID
 	TestAppHash = constant.TestAppHash

diff --git a/telegram/client.go b/telegram/client.go
@@ -182,6 +182,8 @@ func NewClient(appID int, appHash string, opt Options) *Client {
 		MaxRetries:        opt.MaxRetries,
 		CompressThreshold: opt.CompressThreshold,
 		MessageID:         opt.MessageID,
+		ExchangeTimeout:   opt.ExchangeTimeout,
+		DialTimeout:       opt.DialTimeout,
 		Clock:             opt.Clock,
 
 		Types: getTypesMapping(),

diff --git a/telegram/message/inline/message_geo.go b/telegram/message/inline/message_geo.go
@@ -30,7 +30,7 @@ func MessageGeo(point tg.InputGeoPointClass) *MessageMediaGeoBuilder {
 // Heading sets for live locations¹, a direction in which the location moves, in degrees; 1-360.
 //
 // Links:
-//  1) https://core.telegram.org/api/live-location
+//  1. https://core.telegram.org/api/live-location
 func (b *MessageMediaGeoBuilder) Heading(heading int) *MessageMediaGeoBuilder {
 	b.message.Heading = heading
 	return b
@@ -51,7 +51,7 @@ func (b *MessageMediaGeoBuilder) PeriodSeconds(period int) *MessageMediaGeoBuild
 // alerts, in meters (0-100000)
 //
 // Links:
-//  1) https://core.telegram.org/api/live-location
+//  1. https://core.telegram.org/api/live-location
 func (b *MessageMediaGeoBuilder) ProximityNotificationRadius(radius int) *MessageMediaGeoBuilder {
 	b.message.ProximityNotificationRadius = radius
 	return b

diff --git a/telegram/message/join.go b/telegram/message/join.go
@@ -14,13 +14,12 @@ import (
 // JoinLink joins to private chat using given link or hash.
 // Input examples:
 //
-//  t.me/+AAAAAAAAAAAAAAAA
-//  https://t.me/+AAAAAAAAAAAAAAAA
-//  t.me/joinchat/AAAAAAAAAAAAAAAA
-//  https://t.me/joinchat/AAAAAAAAAAAAAAAA
-//  tg:join?invite=AAAAAAAAAAAAAAAA
-//  tg://join?invite=AAAAAAAAAAAAAAAA
-//
+//	t.me/+AAAAAAAAAAAAAAAA
+//	https://t.me/+AAAAAAAAAAAAAAAA
+//	t.me/joinchat/AAAAAAAAAAAAAAAA
+//	https://t.me/joinchat/AAAAAAAAAAAAAAAA
+//	tg:join?invite=AAAAAAAAAAAAAAAA
+//	tg://join?invite=AAAAAAAAAAAAAAAA
 func (s *Sender) JoinLink(ctx context.Context, link string) (tg.UpdatesClass, error) {
 	hash := link
 	if deeplink.IsDeeplinkLike(link) {

diff --git a/telegram/message/markup/hide.go b/telegram/message/markup/hide.go
@@ -10,8 +10,8 @@ func Hide() tg.ReplyMarkupClass {
 // SelectiveHide creates markup to hide markup.
 // Use this builder if you want to remove the keyboard for specific users only.
 // Targets:
-// 	1) users that are @mentioned in the text of the Message object;
-// 	2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+//  1. users that are @mentioned in the text of the Message object;
+//  2. if the bot's message is a reply (has reply_to_message_id), sender of the original message.
 //
 // Example: A user votes in a poll, bot returns confirmation message in reply to the vote
 // and removes the keyboard for that user, while still showing the keyboard with poll

diff --git a/telegram/message/markup/keyboard.go b/telegram/message/markup/keyboard.go
@@ -27,8 +27,8 @@ func (b *ReplyKeyboardMarkupBuilder) SingleUse() *ReplyKeyboardMarkupBuilder {
 
 // Selective sets flag to show the keyboard to specific users only.
 // Targets:
-// 	1) users that are @mentioned in the text of the Message object;
-// 	2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+//  1. users that are @mentioned in the text of the Message object;
+//  2. if the bot's message is a reply (has reply_to_message_id), sender of the original message.
 //
 // Example: A user requests to change the bot‘s language, bot replies to the request
 // with a keyboard to select the new language.

diff --git a/telegram/message/peer.go b/telegram/message/peer.go
@@ -77,7 +77,6 @@ func (s *Sender) Self() *RequestBuilder {
 //	+13115552368
 //	+1 (311) 555-0123
 //	+1 311 555-6162
-//
 func (s *Sender) Resolve(from string, decorators ...peer.PromiseDecorator) *RequestBuilder {
 	return s.builder(peer.Resolve(s.resolver, from), decorators)
 }
@@ -86,9 +85,9 @@ func (s *Sender) Resolve(from string, decorators ...peer.PromiseDecorator) *Requ
 // It resolves peer of message using given Resolver.
 // Input example:
 //
-// 	+13115552368
-// 	+1 (311) 555-0123
-// 	+1 311 555-6162
+//	+13115552368
+//	+1 (311) 555-0123
+//	+1 311 555-6162
 //
 // NB: ResolvePhone just deletes any non-digit symbols from phone argument.
 // For now, Telegram sends contact number as string like "13115552368".
@@ -103,7 +102,6 @@ func (s *Sender) ResolvePhone(phone string, decorators ...peer.PromiseDecorator)
 //
 //	@telegram
 //	telegram
-//
 func (s *Sender) ResolveDomain(domain string, decorators ...peer.PromiseDecorator) *RequestBuilder {
 	return s.builder(peer.ResolveDomain(s.resolver, domain), decorators)
 }
@@ -117,7 +115,6 @@ func (s *Sender) ResolveDomain(domain string, decorators ...peer.PromiseDecorato
 //	https://t.me/telegram
 //	tg:resolve?domain=telegram
 //	tg://resolve?domain=telegram
-//
 func (s *Sender) ResolveDeeplink(link string, decorators ...peer.PromiseDecorator) *RequestBuilder {
 	return s.builder(peer.ResolveDeeplink(s.resolver, link), decorators)
 }
@@ -171,8 +168,7 @@ func (s *Sender) Answer(
 // Reply uses given message update to create message for same chat and create a reply.
 // Shorthand for
 //
-// 	sender.Answer(uctx, upd).ReplyMsg(upd.GetMessage())
-//
+//	sender.Answer(uctx, upd).ReplyMsg(upd.GetMessage())
 func (s *Sender) Reply(uctx tg.Entities, upd AnswerableMessageUpdate, decorators ...peer.PromiseDecorator) *Builder {
 	return s.Answer(uctx, upd, decorators...).ReplyMsg(upd.GetMessage())
 }
diff --git a/telegram/message/peer/resolve.go b/telegram/message/peer/resolve.go
@@ -28,7 +28,6 @@ type Promise func(ctx context.Context) (tg.InputPeerClass, error)
 //	+1 (311) 555-0123
 //	+1 311 555-6162
 //	13115556162
-//
 func Resolve(r Resolver, from string) Promise {
 	from = strings.TrimSpace(from)
 
@@ -88,7 +87,6 @@ func ResolvePhone(r Resolver, phone string) Promise {
 //
 //	@telegram
 //	telegram
-//
 func ResolveDomain(r Resolver, domain string) Promise {
 	return func(ctx context.Context) (tg.InputPeerClass, error) {
 		domain = strings.TrimPrefix(domain, "@")
@@ -114,7 +112,6 @@ func validateDomain(domain string) error {
 //	https://t.me/telegram
 //	tg:resolve?domain=telegram
 //	tg://resolve?domain=telegram
-//
 func ResolveDeeplink(r Resolver, u string) Promise {
 	return func(ctx context.Context) (tg.InputPeerClass, error) {
 		link, err := deeplink.Expect(u, deeplink.Resolve)

diff --git a/telegram/options.go b/telegram/options.go
@@ -74,6 +74,10 @@ type Options struct {
 	RetryInterval time.Duration
 	// MaxRetries is limit of send retries.
 	MaxRetries int
+	// ExchangeTimeout is timeout of every key exchange request.
+	ExchangeTimeout time.Duration
+	// DialTimeout is timeout of creating connection.
+	DialTimeout time.Duration
 
 	// CompressThreshold is a threshold in bytes to determine that message
 	// is large enough to be compressed using GZIP.