Share workspace URL helpers between experimental and bundle open

Move shared workspace UI routes and base URL synthesis into libs/workspaceurls so experimental open and bundle resource URLs stay aligned, including vanity hosts that still require the ?o workspace suffix.

Author: simonfaltum

bundle/config/mutator/initialize_urls.go

@@ -2,12 +2,10 @@ package mutator
 
 import (
 	"context"
-	"net/url"
-	"strconv"
-	"strings"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/libs/diag"
+	"github.com/databricks/cli/libs/workspaceurls"
 )
 
 type initializeURLs struct{}
@@ -25,38 +23,24 @@ func (m *initializeURLs) Name() string {
 }
 
 func (m *initializeURLs) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
-	workspaceId, err := b.WorkspaceClient().CurrentWorkspaceID(ctx)
+	workspaceID, err := b.WorkspaceClient().CurrentWorkspaceID(ctx)
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	orgId := strconv.FormatInt(workspaceId, 10)
 	host := b.WorkspaceClient().Config.CanonicalHostName()
-	err = initializeForWorkspace(b, orgId, host)
+	err = initializeForWorkspace(b, workspaceID, host)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 	return nil
 }
 
-func initializeForWorkspace(b *bundle.Bundle, orgId, host string) error {
-	baseURL, err := url.Parse(host)
+func initializeForWorkspace(b *bundle.Bundle, workspaceID int64, host string) error {
+	baseURL, err := workspaceurls.WorkspaceBaseURL(host, workspaceID)
 	if err != nil {
 		return err
 	}
 
-	// Add ?o=<workspace id> only if <workspace id> wasn't in the subdomain already.
-	// The ?o= is needed when vanity URLs / legacy workspace URLs are used.
-	// If it's not needed we prefer to leave it out since these URLs are rather
-	// long for most terminals.
-	//
-	// See https://docs.databricks.com/en/workspace/workspace-details.html for
-	// further reading about the '?o=' suffix.
-	if !strings.Contains(baseURL.Hostname(), orgId) {
-		values := baseURL.Query()
-		values.Add("o", orgId)
-		baseURL.RawQuery = values.Encode()
-	}
-
 	for _, group := range b.Config.Resources.AllResources() {
 		for _, r := range group.Resources {
 			r.InitializeURL(*baseURL)

bundle/config/mutator/initialize_urls_test.go

@@ -109,7 +109,7 @@ func TestInitializeURLs(t *testing.T) {
 		"dashboard1":       "https://mycompany.databricks.com/dashboardsv3/01ef8d56871e1d50ae30ce7375e42478/published?o=123456",
 	}
 
-	err := initializeForWorkspace(b, "123456", "https://mycompany.databricks.com/")
+	err := initializeForWorkspace(b, 123456, "https://mycompany.databricks.com/")
 	require.NoError(t, err)
 
 	for _, group := range b.Config.Resources.AllResources() {
@@ -133,8 +133,28 @@ func TestInitializeURLsWithoutOrgId(t *testing.T) {
 		},
 	}
 
-	err := initializeForWorkspace(b, "123456", "https://adb-123456.azuredatabricks.net/")
+	err := initializeForWorkspace(b, 123456, "https://adb-123456.azuredatabricks.net/")
 	require.NoError(t, err)
 
 	require.Equal(t, "https://adb-123456.azuredatabricks.net/jobs/1", b.Config.Resources.Jobs["job1"].URL)
 }
+
+func TestInitializeURLsWithWorkspaceIDInVanityHostname(t *testing.T) {
+	b := &bundle.Bundle{
+		Config: config.Root{
+			Resources: config.Resources{
+				Jobs: map[string]*resources.Job{
+					"job1": {
+						BaseResource: resources.BaseResource{ID: "1"},
+						JobSettings:  jobs.JobSettings{Name: "job1"},
+					},
+				},
+			},
+		},
+	}
+
+	err := initializeForWorkspace(b, 123456, "https://workspace-123456.example.com/")
+	require.NoError(t, err)
+
+	require.Equal(t, "https://workspace-123456.example.com/jobs/1?o=123456", b.Config.Resources.Jobs["job1"].URL)
+}

bundle/config/resources/alerts.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/sql"
@@ -52,8 +53,7 @@ func (a *Alert) InitializeURL(baseURL url.URL) {
 	if a.ID == "" {
 		return
 	}
-	baseURL.Path = "sql/alerts-v2/" + a.ID
-	a.URL = baseURL.String()
+	a.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.AlertPattern, a.ID)
 }
 
 func (a *Alert) GetName() string {

bundle/config/resources/apps.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/apps"
@@ -83,8 +84,7 @@ func (a *App) InitializeURL(baseURL url.URL) {
 	if a.ModifiedStatus == "" || a.ModifiedStatus == ModifiedStatusCreated {
 		return
 	}
-	baseURL.Path = "apps/" + a.GetName()
-	a.URL = baseURL.String()
+	a.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.AppPattern, a.GetName())
 }
 
 func (a *App) GetName() string {

bundle/config/resources/clusters.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/compute"
@@ -47,8 +48,7 @@ func (s *Cluster) InitializeURL(baseURL url.URL) {
 	if s.ID == "" {
 		return
 	}
-	baseURL.Path = "compute/clusters/" + s.ID
-	s.URL = baseURL.String()
+	s.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.ClusterPattern, s.ID)
 }
 
 func (s *Cluster) GetName() string {

bundle/config/resources/dashboard.go

@@ -2,10 +2,10 @@ package resources
 
 import (
 	"context"
-	"fmt"
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/dashboards"
@@ -114,8 +114,7 @@ func (r *Dashboard) InitializeURL(baseURL url.URL) {
 		return
 	}
 
-	baseURL.Path = fmt.Sprintf("dashboardsv3/%s/published", r.ID)
-	r.URL = baseURL.String()
+	r.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.DashboardPattern, r.ID)
 }
 
 func (r *Dashboard) GetName() string {

bundle/config/resources/job.go

@@ -6,6 +6,7 @@ import (
 	"strconv"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
@@ -54,8 +55,7 @@ func (j *Job) InitializeURL(baseURL url.URL) {
 	if j.ID == "" {
 		return
 	}
-	baseURL.Path = "jobs/" + j.ID
-	j.URL = baseURL.String()
+	j.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.JobPattern, j.ID)
 }
 
 func (j *Job) GetName() string {

bundle/config/resources/mlflow_experiment.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/ml"
@@ -49,8 +50,7 @@ func (s *MlflowExperiment) InitializeURL(baseURL url.URL) {
 	if s.ID == "" {
 		return
 	}
-	baseURL.Path = "ml/experiments/" + s.ID
-	s.URL = baseURL.String()
+	s.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.ExperimentPattern, s.ID)
 }
 
 func (s *MlflowExperiment) GetName() string {

bundle/config/resources/mlflow_model.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/ml"
@@ -49,8 +50,7 @@ func (s *MlflowModel) InitializeURL(baseURL url.URL) {
 	if s.ID == "" {
 		return
 	}
-	baseURL.Path = "ml/models/" + s.ID
-	s.URL = baseURL.String()
+	s.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.ModelPattern, s.ID)
 }
 
 func (s *MlflowModel) GetName() string {

bundle/config/resources/model_serving_endpoint.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/cli/libs/workspaceurls"
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/serving"
@@ -54,8 +55,7 @@ func (s *ModelServingEndpoint) InitializeURL(baseURL url.URL) {
 	if s.ID == "" {
 		return
 	}
-	baseURL.Path = "ml/endpoints/" + s.ID
-	s.URL = baseURL.String()
+	s.URL = workspaceurls.ResourceURL(baseURL, workspaceurls.ModelServingEndpointPattern, s.ID)
 }
 
 func (s *ModelServingEndpoint) GetName() string {