Add support for HTTP_PROXY, HTTPS_PROXY, and NO_PROXY

cmd/src/login.go

@@ -65,7 +65,7 @@ Examples:
 }
 
 func loginCmd(ctx context.Context, cfg *config, client api.Client, endpointArg string, out io.Writer) error {
-	endpointArg = cleanEndpoint(endpointArg)
+	endpointArg = strings.TrimSuffix(endpointArg, "/")
 
 	printProblem := func(problem string) {
 		fmt.Fprintf(out, "❌ Problem: %s\n", problem)

cmd/src/login_test.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"net/http"
 	"net/http/httptest"
+	"net/url"
 	"strings"
 	"testing"
 
@@ -63,7 +64,8 @@ func TestLogin(t *testing.T) {
 		defer s.Close()
 
 		endpoint := s.URL
-		out, err := check(t, &config{Endpoint: endpoint, AccessToken: "x"}, endpoint)
+		u, _ := url.ParseRequestURI(endpoint)
+		out, err := check(t, &config{Endpoint: endpoint, EndpointURL: u, AccessToken: "x"}, endpoint)
 		if err != cmderrors.ExitCode1 {
 			t.Fatal(err)
 		}
@@ -82,7 +84,8 @@ func TestLogin(t *testing.T) {
 		defer s.Close()
 
 		endpoint := s.URL
-		out, err := check(t, &config{Endpoint: endpoint, AccessToken: "x"}, endpoint)
+		u, _ := url.ParseRequestURI(endpoint)
+		out, err := check(t, &config{Endpoint: endpoint, EndpointURL: u, AccessToken: "x"}, endpoint)
 		if err != nil {
 			t.Fatal(err)
 		}

cmd/src/main.go

@@ -3,9 +3,11 @@
 import (
 	"encoding/json"
 	"flag"
+	"fmt"
 	"io"
 	"log"
 	"net"
+	"net/http"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -107,6 +109,20 @@
 	return args
 }
 
+func parseEndpoint(endpoint string) (*url.URL, error) {
+	u, err := url.ParseRequestURI(strings.TrimSuffix(endpoint, "/"))
+	if err != nil {
+		return nil, err
+	}
+	if !(u.Scheme == "http" || u.Scheme == "https") {
+		return nil, errors.Newf("Invalid scheme %s. Require http or https", u.Scheme)
+	}
+	if u.Host == "" {
+		return nil, errors.Newf("Empty host")
+	}
+	return u, nil
+}
+
 var cfg *config
 
 // config represents the config format.
@@ -118,12 +134,13 @@
 	ProxyURL          *url.URL
 	ProxyPath         string
 	ConfigFilePath    string
+	EndpointURL       *url.URL
 }
 
 // apiClient returns an api.Client built from the configuration.
 func (c *config) apiClient(flags *api.Flags, out io.Writer) api.Client {
 	return api.NewClient(api.ClientOpts{
-		Endpoint:          c.Endpoint,
+		EndpointURL:       c.EndpointURL,
 		AccessToken:       c.AccessToken,
 		AdditionalHeaders: c.AdditionalHeaders,
 		Flags:             flags,
@@ -133,7 +150,8 @@
 	})
 }
 
-// readConfig reads the config file from the given path.
+// readConfig reads the config from the standard config file, the (deprecated) user-specified config file,
+// the environment variables, and the (deprecated) command-line flags.
 func readConfig() (*config, error) {
 	cfgFile := *configPath
 	userSpecified := *configPath != ""
@@ -189,9 +207,21 @@
 		cfg.Proxy = envProxy
 	}
 
+	// Lastly, apply endpoint flag if set
+	if endpoint != nil && *endpoint != "" {
+		cfg.Endpoint = *endpoint
+	}
+
+	if endpointURL, err := parseEndpoint(cfg.Endpoint); err != nil {
+		return nil, errors.Newf("invalid endpoint: %s", cfg.Endpoint)
+	} else {
+		cfg.EndpointURL = endpointURL
+		cfg.Endpoint = endpointURL.String()
+	}
+
 	if cfg.Proxy != "" {
 
-		parseEndpoint := func(endpoint string) (scheme string, address string) {
+		parseProxyEndpoint := func(endpoint string) (scheme string, address string) {
 			parts := strings.SplitN(endpoint, "://", 2)
 			if len(parts) == 2 {
 				return parts[0], parts[1]
@@ -205,7 +235,7 @@
 			return slices.Contains(urlSchemes, scheme)
 		}
 
-		scheme, address := parseEndpoint(cfg.Proxy)
+		scheme, address := parseProxyEndpoint(cfg.Proxy)
 
 		if isURLScheme(scheme) {
 			endpoint := cfg.Proxy
@@ -227,11 +257,19 @@
 				return nil, errors.Newf("Invalid proxy configuration: %w", err)
 			}
 			if !isValidUDS {
-				return nil, errors.Newf("invalid proxy socket: %s", path)
+				return nil, errors.Newf("Invalid proxy socket: %s", path)
 			}
 			cfg.ProxyPath = path
 		} else {
-			return nil, errors.Newf("invalid proxy endpoint: %s", cfg.Proxy)
+			return nil, errors.Newf("Invalid proxy endpoint: %s", cfg.Proxy)
+		}
+	} else {
+		// no SRC_PROXY; check for the standard proxy env variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY
+		if u, err := http.ProxyFromEnvironment(&http.Request{URL: cfg.EndpointURL}); err != nil {
+			// when there's an error, the value for the env variable is not a legit URL
+			return nil, fmt.Errorf("Invalid HTTP_PROXY or HTTPS_PROXY value: %w", err)
+		} else {
+			cfg.ProxyURL = u
 		}
 	}
 
@@ -242,20 +280,9 @@
 		return nil, errConfigAuthorizationConflict
 	}
 
-	// Lastly, apply endpoint flag if set
-	if endpoint != nil && *endpoint != "" {
-		cfg.Endpoint = *endpoint
-	}
-
-	cfg.Endpoint = cleanEndpoint(cfg.Endpoint)
-
 	return &cfg, nil
 }
 
-func cleanEndpoint(urlStr string) string {
-	return strings.TrimSuffix(urlStr, "/")
-}
-
 // isValidUnixSocket checks if the given path is a valid Unix socket.
 //
 // Parameters:

cmd/src/main_test.go

@@ -42,7 +42,11 @@
 		{
 			name: "defaults",
 			want: &config{
-				Endpoint:          "https://sourcegraph.com",
+				Endpoint: "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				AdditionalHeaders: map[string]string{},
 			},
 		},
@@ -54,7 +58,11 @@
 				Proxy:       "https://proxy.com:8080",
 			},
 			want: &config{
-				Endpoint:          "https://example.com",
+				Endpoint: "https://example.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "example.com",
+				},
 				AccessToken:       "deadbeef",
 				AdditionalHeaders: map[string]string{},
 				Proxy:             "https://proxy.com:8080",
@@ -94,7 +102,11 @@
 			},
 			envProxy: "socks5://other.proxy.com:9999",
 			want: &config{
 				Endpoint:    "https://example.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "example.com",
+				},
 				AccessToken: "deadbeef",
 				Proxy:       "socks5://other.proxy.com:9999",
 				ProxyPath:   "",
@@ -117,6 +129,10 @@
 			envProxy:    "socks5://other.proxy.com:9999",
 			want: &config{
 				Endpoint:    "https://override.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "override.com",
+				},
 				AccessToken: "abc",
 				Proxy:       "socks5://other.proxy.com:9999",
 				ProxyPath:   "",
@@ -132,6 +148,10 @@
 			envToken: "abc",
 			want: &config{
 				Endpoint:          "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				AccessToken:       "abc",
 				AdditionalHeaders: map[string]string{},
 			},
@@ -141,6 +161,10 @@
 			envEndpoint: "https://example.com",
 			want: &config{
 				Endpoint:          "https://example.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "example.com",
+				},
 				AccessToken:       "",
 				AdditionalHeaders: map[string]string{},
 			},
@@ -150,6 +174,10 @@
 			envProxy: "https://proxy.com:8080",
 			want: &config{
 				Endpoint:    "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				AccessToken: "",
 				Proxy:       "https://proxy.com:8080",
 				ProxyPath:   "",
@@ -167,6 +195,10 @@
 			envProxy:    "https://proxy.com:8080",
 			want: &config{
 				Endpoint:    "https://example.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "example.com",
+				},
 				AccessToken: "abc",
 				Proxy:       "https://proxy.com:8080",
 				ProxyPath:   "",
@@ -182,6 +214,10 @@
 			envProxy: "unix://" + socketPath,
 			want: &config{
 				Endpoint:          "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				Proxy:             "unix://" + socketPath,
 				ProxyPath:         socketPath,
 				ProxyURL:          nil,
@@ -193,6 +229,10 @@
 			envProxy: socketPath,
 			want: &config{
 				Endpoint:          "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				Proxy:             socketPath,
 				ProxyPath:         socketPath,
 				ProxyURL:          nil,
@@ -204,6 +244,10 @@
 			envProxy: "socks://localhost:1080",
 			want: &config{
 				Endpoint:  "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				Proxy:     "socks://localhost:1080",
 				ProxyPath: "",
 				ProxyURL: &url.URL{
@@ -218,6 +262,10 @@
 			envProxy: "socks5h://localhost:1080",
 			want: &config{
 				Endpoint:  "https://sourcegraph.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "sourcegraph.com",
+				},
 				Proxy:     "socks5h://localhost:1080",
 				ProxyPath: "",
 				ProxyURL: &url.URL{
@@ -237,6 +285,10 @@
 			},
 			want: &config{
 				Endpoint:          "https://override.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "override.com",
+				},
 				AccessToken:       "deadbeef",
 				AdditionalHeaders: map[string]string{},
 			},
@@ -248,6 +300,10 @@
 			envToken:     "abc",
 			want: &config{
 				Endpoint:          "https://override.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "override.com",
+				},
 				AccessToken:       "abc",
 				AdditionalHeaders: map[string]string{},
 			},
@@ -260,6 +316,10 @@
 			envFooHeader: "bar",
 			want: &config{
 				Endpoint:          "https://override.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "override.com",
+				},
 				AccessToken:       "abc",
 				AdditionalHeaders: map[string]string{"foo": "bar"},
 			},
@@ -272,6 +332,10 @@
 			envHeaders:   "foo:bar\nfoo-bar:bar-baz",
 			want: &config{
 				Endpoint:          "https://override.com",
+				EndpointURL: &url.URL{
+					Scheme: "https",
+					Host:   "override.com",
+				},
 				AccessToken:       "abc",
 				AdditionalHeaders: map[string]string{"foo-bar": "bar-baz", "foo": "bar"},
 			},

cmd/src/search_jobs.go

@@ -156,7 +156,7 @@ func parseColumns(columnsFlag string) []string {
 // createSearchJobsClient creates a reusable API client for search jobs commands
 func createSearchJobsClient(out *flag.FlagSet, apiFlags *api.Flags) api.Client {
 	return api.NewClient(api.ClientOpts{
-		Endpoint:    cfg.Endpoint,
+		EndpointURL: cfg.EndpointURL,
 		AccessToken: cfg.AccessToken,
 		Out:         out.Output(),
 		Flags:       apiFlags,
@@ -259,11 +259,11 @@ func init() {
 	usage := `'src search-jobs' is a tool that manages search jobs on a Sourcegraph instance.
 
 	Usage:
-	
+
 		src search-jobs command [command options]
-	
+
 	The commands are:
-	
+
 		cancel     cancels a search job by ID
 		create     creates a search job
 		delete     deletes a search job by ID
@@ -272,11 +272,11 @@ func init() {
 		logs       fetches logs for a search job by ID
 		restart    restarts a search job by ID
 		results    fetches results for a search job by ID
-	
+
 	Common options for all commands:
 		-c          Select columns to display (e.g., -c id,query,state,username)
 		-json       Output results in JSON format
-	
+
 	Use "src search-jobs [command] -h" for more information about a command.
 	`