Warn users against setting Timeout on http.Client

nhooyr · nhooyr · commit 0e8d46d075c2 · 2019-04-24T20:11:36.000-04:00
Closes #67
diff --git a/dial.go b/dial.go
@@ -47,6 +47,9 @@ func dial(ctx context.Context, u string, opts DialOptions) (_ *Conn, _ *http.Res
 	if opts.HTTPClient == nil {
 		opts.HTTPClient = http.DefaultClient
 	}
+	if opts.HTTPClient.Timeout > 0 {
+		return nil, nil, xerrors.Errorf("please use context for cancellation instead of http.Client.Timeout; see issue nhooyr.io/websocket#67")
+	}
 	if opts.HTTPHeader == nil {
 		opts.HTTPHeader = http.Header{}
 	}

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,9 @@ func dial(ctx context.Context, u string, opts DialOptions) (_ Conn, _ http.Res`
`47`	`47`	`if opts.HTTPClient == nil {`
`48`	`48`	`opts.HTTPClient = http.DefaultClient`
`49`	`49`	`}`
	`50`	`+ if opts.HTTPClient.Timeout > 0 {`
	`51`	`+ return nil, nil, xerrors.Errorf("please use context for cancellation instead of http.Client.Timeout; see issue nhooyr.io/websocket#67")`
	`52`	`+ }`
`50`	`53`	`if opts.HTTPHeader == nil {`
`51`	`54`	`opts.HTTPHeader = http.Header{}`
`52`	`55`	`}`