Accept ?w= URL query parameter alongside ?o= (#5373)

## Summary

The Databricks UI is migrating from `?o=<workspace-id>` to
`?w=<workspace-id>` as the SPOG URL query parameter, matching the new
workspace addressing header. This PR extends the CLI's URL parsers to
recognize `?w=` in addition to the existing `?o=` and `?workspace_id=`
spellings. Pure addition; no existing URL changes meaning.

Stacked on top of #5368 (which renames the request header to
`X-Databricks-Workspace-Id`); the two together complete the input + wire
side of the URL/header migration for the core CLI.

## Affected entry points

- `databricks api <verb> <path?w=...>` — workspace ID is extracted from
the path and sent as the routing header on the call.
- `databricks auth login --host "https://...?w=..."` — workspace ID is
extracted from the host URL and persisted to the profile.
- `workspace.host` in `databricks.yml` — uses the same shared parser
(`libs/auth.ExtractHostQueryParams`).

## Precedence

When more than one spelling appears on a single URL, **`?o=` > `?w=` >
`?workspace_id=`**. The `o`-first rule preserves the resolution of any
URL already pasted from older UI builds, shell history, or committed
`databricks.yml` files.

## Rename

`extractOrgIDFromQuery` (in `cmd/api/api.go`) →
`extractWorkspaceIDFromQuery`. The helper now returns the value under
any of the recognized parameter names, so the old name became
misleading. Unexported, single call site; updated atomically.

## Files

- `libs/auth/hostparams.go` — adds the `q.Get("w")` branch in
`ExtractHostQueryParams`; comment refreshed to document the three
accepted forms and precedence.
- `cmd/api/api.go` — adds `workspaceIDQueryParam = "w"` const; renames
extractor and updates its body to check `o` then `w`.
- `cmd/auth/login.go` — help text updated to recommend `?w=` and note
that `?o=` / `?workspace_id=` are still accepted.
- `libs/auth/hostparams_test.go` — new cases for `?w=`, precedence, and
non-numeric rejection.
- `cmd/api/api_test.go` — new cases in `TestExtractWorkspaceIDFromQuery`
(renamed) and `TestResolveOrgID` covering `?w=` and the
`o`-wins-over-`w` precedence.
- `acceptance/cmd/api/workspace-id-from-w-query/` — new acceptance test
mirroring `workspace-id-from-query/` but exercising the `?w=` path. The
original `?o=` test stays unchanged as a regression check.

## Test plan

- [x] \`go test ./libs/auth/... ./cmd/api/... ./cmd/auth/... -count=1\`
— green
- [x] \`go test ./acceptance -run
'TestAccept/cmd/api|TestAccept/cmd/auth|TestAccept/auth'\` — green
- [x] \`./task lint-q\` — 0 issues
- [x] \`./task fmt\` — no changes

Author: Divyansh-db

acceptance/cmd/api/workspace-id-from-w-query/out.test.toml

@@ -0,0 +1,21 @@
+{}
+
+>>> print_requests.py --get //api/2.0/clusters/list
+{
+  "headers": {
+    "Authorization": [
+      "Bearer [DATABRICKS_TOKEN]"
+    ],
+    "User-Agent": [
+      "cli/[DEV_VERSION] databricks-sdk-go/[SDK_VERSION] go/[GO_VERSION] os/[OS] cmd/api_get cmd-exec-id/[UUID] interactive/none auth/pat"
+    ],
+    "X-Databricks-Workspace-Id": [
+      "999"
+    ]
+  },
+  "method": "GET",
+  "path": "/api/2.0/clusters/list",
+  "q": {
+    "w": "999"
+  }
+}

acceptance/cmd/api/workspace-id-from-w-query/output.txt

@@ -0,0 +1,2 @@
+MSYS_NO_PATHCONV=1 $CLI api get "/api/2.0/clusters/list?w=999"
+trace print_requests.py --get //api/2.0/clusters/list | contains.py "X-Databricks-Workspace-Id" "999"

acceptance/cmd/api/workspace-id-from-w-query/script

@@ -27,12 +27,18 @@ const (
 	// header for rollback safety.
 	workspaceIDHeader = "X-Databricks-Workspace-Id"
 
-	// orgIDQueryParam is the SPOG (single-page-of-glass) URL convention used
-	// by the Databricks UI: "?o=<workspace-id>" identifies the workspace a URL
-	// targets. When present on the path, we treat it as a per-call override
-	// for the workspace routing identifier so that pasted SPOG URLs route
-	// correctly without requiring --workspace-id.
-	orgIDQueryParam = "o"
+	// orgIDQueryParam and workspaceIDQueryParam are the SPOG
+	// (single-page-of-glass) URL convention used by the Databricks UI:
+	// "?o=<workspace-id>" or "?w=<workspace-id>" identifies the workspace a
+	// URL targets. When present on the path, we treat it as a per-call
+	// override for the workspace routing identifier so that pasted SPOG URLs
+	// route correctly without requiring --workspace-id. "w" is the new
+	// spelling that matches the X-Databricks-Workspace-Id header; "o" stays
+	// accepted for URLs already pasted from older UI builds, shell history,
+	// or committed databricks.yml files. "o" takes precedence when both are
+	// present to preserve the meaning of existing URLs.
+	orgIDQueryParam       = "o"
+	workspaceIDQueryParam = "w"
 )
 
 // accountSegmentRe matches a non-empty segment immediately after "accounts/",
@@ -165,14 +171,19 @@ func hasAccountSegment(rawPath string) (bool, error) {
 	return accountSegmentRe.MatchString(p), nil
 }
 
-// extractOrgIDFromQuery returns the value of the "o" query parameter on path
-// (the SPOG URL convention), or "" if absent or empty.
-func extractOrgIDFromQuery(rawPath string) (string, error) {
+// extractWorkspaceIDFromQuery returns the workspace ID encoded in the path's
+// query string (the SPOG URL convention). It checks "o" first, then "w";
+// returns "" if neither is present or non-empty.
+func extractWorkspaceIDFromQuery(rawPath string) (string, error) {
 	u, err := url.Parse(rawPath)
 	if err != nil {
 		return "", fmt.Errorf("parse path: %w", err)
 	}
-	return u.Query().Get(orgIDQueryParam), nil
+	q := u.Query()
+	if v := q.Get(orgIDQueryParam); v != "" {
+		return v, nil
+	}
+	return q.Get(workspaceIDQueryParam), nil
 }
 
 // resolveOrgID picks the value (if any) for the workspace routing identifier
@@ -197,12 +208,12 @@ func resolveOrgID(
 		}
 		return workspaceIDFlag, nil
 	}
-	orgIDFromQuery, err := extractOrgIDFromQuery(path)
+	workspaceIDFromQuery, err := extractWorkspaceIDFromQuery(path)
 	if err != nil {
 		return "", err
 	}
-	if orgIDFromQuery != "" {
-		return orgIDFromQuery, nil
+	if workspaceIDFromQuery != "" {
+		return workspaceIDFromQuery, nil
 	}
 	isAccount, err := hasAccountSegment(path)
 	if err != nil {

cmd/api/api.go

@@ -46,7 +46,7 @@ func TestHasAccountSegment(t *testing.T) {
 	}
 }
 
-func TestExtractOrgIDFromQuery(t *testing.T) {
+func TestExtractWorkspaceIDFromQuery(t *testing.T) {
 	cases := []struct {
 		name string
 		path string
@@ -60,10 +60,15 @@ func TestExtractOrgIDFromQuery(t *testing.T) {
 		{"unrelated o-prefixed param ignored", "/api/2.0/clusters/list?other=1", ""},
 		{"absolute URL", "https://example.com/api/2.0/clusters/list?o=42", "42"},
 		{"first value wins on duplicate", "/api/2.0/clusters/list?o=1&o=2", "1"},
+		{"w param present", "/api/2.2/jobs/list?w=7474644166319138", "7474644166319138"},
+		{"w param empty", "/api/2.0/clusters/list?w=", ""},
+		{"w among other params", "/api/2.0/clusters/list?foo=bar&w=123", "123"},
+		{"o wins over w when both present", "/api/2.0/clusters/list?o=111&w=222", "111"},
+		{"w used when o is empty", "/api/2.0/clusters/list?o=&w=222", "222"},
 	}
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {
-			got, err := extractOrgIDFromQuery(c.path)
+			got, err := extractWorkspaceIDFromQuery(c.path)
 			require.NoError(t, err)
 			assert.Equal(t, c.want, got)
 		})
@@ -76,6 +81,7 @@ func TestResolveOrgID(t *testing.T) {
 		accountPath     = "/api/2.0/accounts/abc-123/network-policies"
 		proxyPath       = "/api/2.0/preview/accounts/access-control/rule-sets"
 		spogPath        = "/api/2.2/jobs/list?o=7474644166319138"
+		spogPathW       = "/api/2.2/jobs/list?w=7474644166319138"
 		spogAccountPath = "/api/2.0/accounts/abc-123/network-policies?o=7474644166319138"
 		spogWorkspaceID = "7474644166319138"
 		resolvedWSID    = "900800700600"
@@ -189,6 +195,26 @@ func TestResolveOrgID(t *testing.T) {
 			path:           spogAccountPath,
 			want:           spogWorkspaceID,
 		},
+		{
+			name:           "?w=<id> sets identifier when no flag and no profile WorkspaceID",
+			cfgWorkspaceID: "",
+			path:           spogPathW,
+			want:           spogWorkspaceID,
+		},
+		{
+			name:           "?w=<id> overrides profile WorkspaceID",
+			cfgWorkspaceID: resolvedWSID,
+			path:           spogPathW,
+			want:           spogWorkspaceID,
+		},
+		{
+			name:            "--workspace-id wins over ?w=",
+			workspaceIDFlag: flagWSID,
+			flagSet:         true,
+			cfgWorkspaceID:  resolvedWSID,
+			path:            spogPathW,
+			want:            flagWSID,
+		},
 	}
 	for _, c := range cases {
 		t.Run(c.name, func(t *testing.T) {

cmd/api/api_test.go

@@ -118,9 +118,11 @@ use the flags directly to specify both.
 
 The host URL may include query parameters to set the workspace and account ID:
 
-  databricks auth login --host "https://<host>?o=<workspace_id>&account_id=<id>"
+  databricks auth login --host "https://<host>?w=<workspace_id>&account_id=<id>"
 
-Note: URLs containing "?" must be quoted to prevent shell interpretation.
+The workspace ID may be passed as ?w= (preferred), ?o= (legacy), or
+?workspace_id=. Note: URLs containing "?" must be quoted to prevent shell
+interpretation.
 
 If a profile with the given name already exists, it is updated. Otherwise
 a new profile is created.

cmd/auth/login.go

@@ -11,8 +11,10 @@ type HostParams struct {
 	// Host is the URL with query parameters stripped.
 	Host string
 
-	// WorkspaceID extracted from ?o= or ?workspace_id=.
-	// Empty if not present or not numeric.
+	// WorkspaceID extracted from ?o=, ?w=, or ?workspace_id=.
+	// Empty if not present. ?o= and ?workspace_id= are legacy spellings that
+	// remain numeric-only; ?w= is the new spelling and is passed through
+	// unchanged so non-numeric connection-style identifiers reach the server.
 	WorkspaceID string
 
 	// AccountID extracted from ?a= or ?account_id=.
@@ -21,9 +23,15 @@ type HostParams struct {
 }
 
 // ExtractHostQueryParams parses recognized query parameters from a host URL.
-// Recognized parameters: o (workspace_id), workspace_id, a (account_id), account_id.
-// Workspace IDs must be numeric; non-numeric values are ignored.
-// The returned Host has all query parameters and fragments stripped.
+// Recognized parameters: o (workspace_id), w (workspace_id), workspace_id,
+// a (account_id), account_id. The "w" spelling matches the new
+// X-Databricks-Workspace-Id routing header and accepts any non-empty value
+// (including non-numeric connection-style identifiers). The legacy "o" and
+// "workspace_id" spellings remain numeric-only — they predate the broader
+// identifier shapes and historical URLs carrying those forms are always
+// numeric. When more than one spelling is present, "o" wins to preserve the
+// meaning of existing URLs. The returned Host has all query parameters and
+// fragments stripped.
 func ExtractHostQueryParams(host string) HostParams {
 	u, err := url.Parse(host)
 	if err != nil || u.RawQuery == "" {
@@ -37,6 +45,8 @@ func ExtractHostQueryParams(host string) HostParams {
 		if _, err := strconv.ParseInt(v, 10, 64); err == nil {
 			workspaceID = v
 		}
+	} else if v := q.Get("w"); v != "" {
+		workspaceID = v
 	} else if v := q.Get("workspace_id"); v != "" {
 		if _, err := strconv.ParseInt(v, 10, 64); err == nil {
 			workspaceID = v

libs/auth/hostparams.go

@@ -27,26 +27,51 @@ func TestExtractHostQueryParams(t *testing.T) {
 			host: "https://spog.example.com/?account_id=abc",
 			want: HostParams{Host: "https://spog.example.com", AccountID: "abc"},
 		},
+		{
+			name: "extract workspace_id from ?w=",
+			host: "https://spog.example.com/?w=12345",
+			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "12345"},
+		},
 		{
 			name: "extract workspace_id from ?workspace_id=",
 			host: "https://spog.example.com/?workspace_id=99999",
 			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "99999"},
 		},
+		{
+			name: "?o= wins over ?w= when both present",
+			host: "https://spog.example.com/?o=11111&w=22222",
+			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "11111"},
+		},
+		{
+			name: "?w= wins over ?workspace_id= when both present",
+			host: "https://spog.example.com/?w=11111&workspace_id=22222",
+			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "11111"},
+		},
 		{
 			name: "no query params leaves host unchanged",
 			host: "https://spog.example.com",
 			want: HostParams{Host: "https://spog.example.com"},
 		},
 		{
-			name: "non-numeric ?o= is skipped",
+			name: "non-numeric ?o= is skipped (legacy spelling stays numeric-only)",
 			host: "https://spog.example.com/?o=abc",
 			want: HostParams{Host: "https://spog.example.com"},
 		},
 		{
-			name: "non-numeric ?workspace_id= is skipped",
+			name: "non-numeric ?w= is passed through",
+			host: "https://spog.example.com/?w=abc",
+			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "abc"},
+		},
+		{
+			name: "non-numeric ?workspace_id= is skipped (legacy spelling stays numeric-only)",
 			host: "https://spog.example.com/?workspace_id=abc",
 			want: HostParams{Host: "https://spog.example.com"},
 		},
+		{
+			name: "connection-id-style ?w= value passed through",
+			host: "https://spog.example.com/?w=123e4567-e89b-12d3-a456-426614174000",
+			want: HostParams{Host: "https://spog.example.com", WorkspaceID: "123e4567-e89b-12d3-a456-426614174000"},
+		},
 		{
 			name: "invalid URL is left unchanged",
 			host: "not a valid url ://???",