refactor: validate and parse the endpoint and proxy at program load by peterguy · Pull Request #1267 · sourcegraph/src-cli

peterguy · 2026-03-07T02:37:45Z

Summary

Parse the endpoint URL at program load instead of passing around an unparsed string and needing to check/parse it in multiple places.

Parse the proxy url at program load, supporting HTTP_PROXY, HTTPS_PROXY and NO_PROXY in addition to SRC_PROXY. SRC_PROXY takes precedence.

Changes

`config` struct (`cmd/src/main.go`)

Split out a configFromFile struct containing the JSON elements
Un-export fields (all consumers are in package main)
Use endpointURL - Endpoint and Proxy are now in configFromFile
Parse endpointURL in readConfig - consumers use the parsed URL

`api.ClientOpts` (`internal/api/api.go`)

Endpoint string → EndpointURL *url.URL
Use JoinPath for URL construction instead of string concatenation with TrimRight

`login` command (`cmd/src/login.go`)

loginCmd now uses the config's endpointURL
Endpoint conflict detection moved from loginCmd into the handler, where the CLI arg is parsed and compared before entering the command

`code_intel_upload` (`cmd/src/code_intel_upload.go`)

makeCodeIntelUploadURL uses a stack copy (u := *cfg.endpointURL) instead of re-parsing the URL
Error return removed since there's nothing that can fail

Tests

Updated all test call sites to pass *url.URL

Testing

All affected packages pass:

ok  github.com/sourcegraph/src-cli/cmd/src
ok  github.com/sourcegraph/src-cli/internal/api
ok  github.com/sourcegraph/src-cli/internal/batches/repozip
ok  github.com/sourcegraph/src-cli/internal/batches/executor

- config struct: unexport fields, replace Endpoint/Proxy strings with endpointURL/proxyURL (*url.URL) and proxyPath, parse once in readConfig - api.ClientOpts: Endpoint string → EndpointURL *url.URL - login: accept *url.URL, move endpoint conflict check to handler - code_intel_upload: simplify makeCodeIntelUploadURL with stack copy, remove error return - api.go: use JoinPath for URL construction instead of string concat - Update all call sites and tests Amp-Thread-ID: https://ampcode.com/threads/T-019cc5da-fb05-71f8-962b-689cfc5b494d Co-authored-by: Amp <amp@ampcode.com>

peterguy · 2026-03-07T21:39:44Z

cmd/src/code_intel_upload.go

-	}
-
+func makeCodeIntelUploadURL(uploadID int) string {
+	u := *cfg.endpointURL


coy by dereference makes a shallow copy - affects User mostly/only - should we include a comment to that effect here?

peterguy · 2026-03-07T21:52:30Z

cmd/src/login.go

+			if parsed.String() != cfg.endpointURL.String() {
+				return cmderrors.Usage(fmt.Sprintf("endpoint argument %s conflicts with configured endpoint %s", parsed, cfg.endpointURL))
+			}


The existence of this check calls into question the command-line parameter - SRC_ENDPOINT (or the value from the config file) is the source[1] of truth, forcing the user to put the same value on the command line.
Adding to the confusion is that if there is nothing in the config file or in SRC_ENDPOINT, cfg.endpointURL defaults to https://sourcegraph.com, which is probably wrong pretty much all of the time, and still invalidates anything different on the command line.
I kept the error condition and message (although I did change the semantics by changing from an exit error to a usage error) because I didn't want to rip that rug out from under anyone at this point.
Thoughts?

[1] no pun intended, but I do like it

peterguy · 2026-03-07T23:44:48Z

cmd/src/login.go

+	if cfg.configFilePath != "" {
 		fmt.Fprintln(out)
-		fmt.Fprintf(out, "⚠️  Warning: Configuring src with a JSON file is deprecated. Please migrate to using the env vars SRC_ENDPOINT, SRC_ACCESS_TOKEN, and SRC_PROXY instead, and then remove %s. See https://github.com/sourcegraph/src-cli#readme for more information.\n", cfg.ConfigFilePath)
+		fmt.Fprintf(out, "⚠️  Warning: Configuring src with a JSON file is deprecated. Please migrate to using the env vars SRC_ENDPOINT, SRC_ACCESS_TOKEN, and SRC_PROXY instead, and then remove %s. See https://github.com/sourcegraph/src-cli#readme for more information.\n", cfg.configFilePath)


The config file has been deprecated for a long time, but if it ever is finally removed, the ability to set additional headers will go also. Do we need to keep the ability to set additional headers around? If so, we should probably introduce yet another environment variable for those and delay the config file removal. If not, let's complete the config file deprecation!

peterguy · 2026-03-08T03:32:27Z

This change is part of the following stack:

refactor: validate and parse the endpoint and proxy at program load #1267 ◀
- Add support for HTTP_PROXY, HTTPS_PROXY, and NO_PROXY #1260

_{Change managed by git-spice.}

peterguy and others added 2 commits March 6, 2026 18:37

fix formatting and error messages

a6113fb

peterguy changed the title ~~refactor: use parsed *url.URL types instead of string endpoints~~ refactor: validate and parse the endpoint up front instead of keeping it as a string Mar 7, 2026

peterguy commented Mar 7, 2026

View reviewed changes

peterguy added 3 commits March 7, 2026 14:01

clear any auth from the endpoint url at program load

fb49d7a

rename variables

5c98127

fixup main tests

2cd44d0

peterguy commented Mar 7, 2026

View reviewed changes

peterguy added 4 commits March 7, 2026 16:16

restore indirection

e2b8d62

fix capitalization

23d6f0c

standardize url parsing

b7faaa3

standardize url parsing

a1620bd

peterguy changed the title ~~refactor: validate and parse the endpoint up front instead of keeping it as a string~~ refactor: validate and parse the endpoint and proxy at program load Mar 8, 2026

remove support for HTTP(S)_PROXY - that will come later

2475734

peterguy self-assigned this Mar 8, 2026

peterguy marked this pull request as ready for review March 8, 2026 01:34

peterguy requested a review from a team March 8, 2026 01:34

peterguy mentioned this pull request Mar 8, 2026

Add support for HTTP_PROXY, HTTPS_PROXY, and NO_PROXY #1260

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: validate and parse the endpoint and proxy at program load#1267

refactor: validate and parse the endpoint and proxy at program load#1267
peterguy wants to merge 10 commits intomainfrom
peterguy/clean-up-config

peterguy commented Mar 7, 2026 •

edited

Loading

Uh oh!

peterguy Mar 7, 2026

Uh oh!

peterguy Mar 7, 2026

Uh oh!

peterguy Mar 7, 2026 •

edited

Loading

Uh oh!

peterguy commented Mar 8, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

peterguy commented Mar 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

config struct (cmd/src/main.go)

api.ClientOpts (internal/api/api.go)

login command (cmd/src/login.go)

code_intel_upload (cmd/src/code_intel_upload.go)

Tests

Testing

Uh oh!

peterguy Mar 7, 2026

Choose a reason for hiding this comment

Uh oh!

peterguy Mar 7, 2026

Choose a reason for hiding this comment

Uh oh!

peterguy Mar 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peterguy commented Mar 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

peterguy commented Mar 7, 2026 •

edited

Loading

`config` struct (`cmd/src/main.go`)

`api.ClientOpts` (`internal/api/api.go`)

`login` command (`cmd/src/login.go`)

`code_intel_upload` (`cmd/src/code_intel_upload.go`)

peterguy Mar 7, 2026 •

edited

Loading

peterguy commented Mar 8, 2026 •

edited

Loading