@@ -21,18 +21,19 @@ type OAuth2Config interface {
2121// InstrumentedOAuth2Config extends OAuth2Config with a `Do` method that allows
2222// external oauth related calls to be instrumented. This is to support
2323// "ValidateToken" which is not an oauth2 specified method.
24+ // These calls still count against the api rate limit, and should be instrumented.
2425type InstrumentedOAuth2Config interface {
2526OAuth2Config
2627
2728// Do is provided as a convenience method to make a request with the oauth2 client.
2829// It mirrors `http.Client.Do`.
29- // We need this because Coder adds some extra functionality to
30- // oauth clients such as the `ValidateToken()` method.
3130Do (ctx context.Context ,source string ,req * http.Request ) (* http.Response ,error )
3231}
3332
3433var _ OAuth2Config = (* Config )(nil )
3534
35+ // Factory allows us to have 1 set of metrics for all oauth2 providers.
36+ // Primarily to avoid any prometheus errors registering duplicate metrics.
3637type Factory struct {
3738metrics * metrics
3839}
@@ -107,10 +108,11 @@ func (c *Config) wrapClient(ctx context.Context, source string) context.Context
107108return context .WithValue (ctx ,oauth2 .HTTPClient ,c .oauthHTTPClient (ctx ,source ))
108109}
109110
111+ // oauthHTTPClient returns an http client that will instrument every request made.
110112func (c * Config )oauthHTTPClient (ctx context.Context ,source string )* http.Client {
111113cli := & http.Client {}
112114
113- // Check if the context hasan http client already.
115+ // Check if the context hasa http client already.
114116if hc ,ok := ctx .Value (oauth2 .HTTPClient ).(* http.Client );ok {
115117cli = hc
116118}
@@ -126,6 +128,8 @@ type instrumentedTripper struct {
126128underlying http.RoundTripper
127129}
128130
131+ // newInstrumentedTripper intercepts a http request, and increments the
132+ // externalRequestCount metric.
129133func newInstrumentedTripper (c * Config ,source string ,under http.RoundTripper )* instrumentedTripper {
130134if under == nil {
131135under = http .DefaultTransport