updating tests and readme based on feedback

Author: JCPistell

go/README.md

@@ -122,6 +122,10 @@ func main() {
 
 If you want even greater control over the lifecycle of the HTTP requests consider providing a [context](https://pkg.go.dev/context). Contexts can be set for all requests or per request.
 
+If you wish to include timeout functionality in your custom context then you should leverage [context.WithTimeout](https://pkg.go.dev/context#WithTimeout).
+
+> Note: Setting a context will override any "Timeout" settings that you have applied! 
+
 #### Custom Context for all requests
 
 Follow the example code snippet below if you want all requests to use the same context:
@@ -131,7 +135,7 @@ import "context"
 
 func main() {
     // sets a timeout of 5 minutes
-    ctx, cancel := context.WithTimout(context.Background(), 5*time.Minute)
+    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
     defer cancel()
 
     cfg, err := rtl.NewSettingsFromFile("path/to/looker.ini", nil)
@@ -142,16 +146,20 @@ func main() {
 }
 ```
 
+> Note: A context set here will also apply to background requests to fetch/refresh oauth tokens, which are normally separated from contexts set via the Timeout property.
+
 #### Custom Context per request
 
-Follow the example here to set a context for a specific request. **This will override any context set in the SDK config as outlined in the previous section.**
+Follow the example here to set a context for a specific request.
+
+> Note: This will override any "Timeout" settings that you have applied, as well as any context set in the SDK config as outlined in the previus section!
 
 ```go
 import "context"
 
 func main() {
     // sets a timeout of 5 minutes
-    ctx, cancel := context.WithTimout(context.Background(), 5*time.Minute)
+    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
     defer cancel()
 
     cfg, err := rtl.NewSettingsFromFile("path/to/looker.ini", nil)
@@ -160,4 +168,7 @@ func main() {
 
     sdk.Me("", &ApiSettings{Context: ctx})
 }
-```
+```
+
+> Note: Setting a context per request will NOT affect the context used for the background token fetching requests. If you have also set a context for all requests as mentioned above then that context
+will still be used for the token requests, otherwise the SDK will fall back on using a completely separate context for the token fetching requests.

go/rtl/auth_test.go

@@ -694,6 +694,105 @@ func TestAuthSession_Do_Timeout(t *testing.T) {
 			t.Errorf("Do() call did not error with context.DeadlineExceeded, got=%v", err)
 		}
 	})
+
+	t.Run("Timeout set in Do()'s options overrides Authsession", func(t *testing.T) {
+		mux := http.NewServeMux()
+		setupApi40Login(mux, foreverValidTestToken, http.StatusOK)
+		server := httptest.NewServer(mux)
+		defer server.Close()
+
+		mux.HandleFunc("/api"+apiVersion+path, func(w http.ResponseWriter, r *http.Request) {
+			time.Sleep(4 * time.Second)
+		})
+
+		session := NewAuthSession(ApiSettings{
+			BaseUrl:    server.URL,
+			ApiVersion: apiVersion,
+			Timeout:    5,
+		})
+
+		options := ApiSettings{
+			Timeout: 1, //seconds
+		}
+
+		err := session.Do(nil, "GET", apiVersion, path, nil, nil, &options)
+
+		if err == nil {
+			t.Errorf("Do() call did not error/timeout")
+		} else if !errors.Is(err, context.DeadlineExceeded) {
+			t.Errorf("Do() call did not error with context.DeadlineExceeded, got=%v", err)
+		}
+	})
+
+	t.Run("Context set in AuthSession config overrides Timeouts", func(t *testing.T) {
+		mux := http.NewServeMux()
+		setupApi40Login(mux, foreverValidTestToken, http.StatusOK)
+		server := httptest.NewServer(mux)
+		defer server.Close()
+
+		mux.HandleFunc("/api"+apiVersion+path, func(w http.ResponseWriter, r *http.Request) {
+			time.Sleep(4 * time.Second)
+		})
+
+		ctx, cncl := context.WithTimeout(context.Background(), 1*time.Second)
+		defer cncl()
+
+		session := NewAuthSession(ApiSettings{
+			BaseUrl:    server.URL,
+			ApiVersion: apiVersion,
+			Context:    ctx,
+			Timeout:    5,
+		})
+
+		options := ApiSettings{
+			Timeout: 5,
+		}
+
+		err := session.Do(nil, "GET", apiVersion, path, nil, nil, &options)
+
+		if err == nil {
+			t.Errorf("Do() call did not error/timeout")
+		} else if !errors.Is(err, context.DeadlineExceeded) {
+			t.Errorf("Do() call did not error with context.DeadlineExceeded, got=%v", err)
+		}
+	})
+
+	t.Run("Context set in options overrides config ctx and all Timeouts", func(t *testing.T) {
+		mux := http.NewServeMux()
+		setupApi40Login(mux, foreverValidTestToken, http.StatusOK)
+		server := httptest.NewServer(mux)
+		defer server.Close()
+
+		mux.HandleFunc("/api"+apiVersion+path, func(w http.ResponseWriter, r *http.Request) {
+			time.Sleep(4 * time.Second)
+		})
+
+		octx, ocncl := context.WithTimeout(context.Background(), 1*time.Second)
+		defer ocncl()
+
+		sctx, scncl := context.WithTimeout(context.Background(), 5*time.Second)
+		defer scncl()
+
+		session := NewAuthSession(ApiSettings{
+			BaseUrl:    server.URL,
+			ApiVersion: apiVersion,
+			Context:    sctx,
+			Timeout:    5,
+		})
+
+		options := ApiSettings{
+			Timeout: 5,
+			Context: octx,
+		}
+
+		err := session.Do(nil, "GET", apiVersion, path, nil, nil, &options)
+
+		if err == nil {
+			t.Errorf("Do() call did not error/timeout")
+		} else if !errors.Is(err, context.DeadlineExceeded) {
+			t.Errorf("Do() call did not error with context.DeadlineExceeded, got=%v", err)
+		}
+	})
 }
 
 func TestSetQuery(t *testing.T) {