Better error diagnostic for SDK errors

denik · denik · commit 84f6733f757b · 2025-08-08T11:15:56.000+02:00
Takes advantage of databricks/databricks-sdk-go#1261
diff --git a/acceptance/bundle/resources/jobs/create-error/output.txt b/acceptance/bundle/resources/jobs/create-error/output.txt
@@ -6,7 +6,12 @@ Warning: required field "new_cluster" is not set
 
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
-Error: deploying jobs.foo: creating: Method=Jobs.Create *retries.Err *apierr.APIError StatusCode=400 ErrorCode="INVALID_PARAMETER_VALUE" Message="Shared job cluster feature is only supported in multi-task jobs."
+Error: deploying jobs.foo: creating: Shared job cluster feature is only supported in multi-task jobs. (400 INVALID_PARAMETER_VALUE)
+
+Endpoint: POST [DATABRICKS_URL]/api/2.2/jobs/create
+HTTP Status: 400 Bad Request
+API error_code: INVALID_PARAMETER_VALUE
+API message: Shared job cluster feature is only supported in multi-task jobs.
 
 Updating deployment state...
 
diff --git a/bundle/terranova/tnresources/app.go b/bundle/terranova/tnresources/app.go
@@ -33,7 +33,7 @@ func (r *ResourceApp) DoCreate(ctx context.Context) (string, error) {
 	}
 	waiter, err := r.client.Apps.Create(ctx, request)
 	if err != nil {
-		return "", SDKError{Method: "Apps.Create", Err: err}
+		return "", err
 	}
 
 	// TODO: Store waiter for Wait method
@@ -48,7 +48,7 @@ func (r *ResourceApp) DoUpdate(ctx context.Context, id string) error {
 	}
 	response, err := r.client.Apps.Update(ctx, request)
 	if err != nil {
-		return SDKError{Method: "Apps.Update", Err: err}
+		return err
 	}
 
 	if response.Name != id {
diff --git a/bundle/terranova/tnresources/job.go b/bundle/terranova/tnresources/job.go
@@ -33,7 +33,7 @@ func (r *ResourceJob) DoCreate(ctx context.Context) (string, error) {
 	}
 	response, err := r.client.Jobs.Create(ctx, request)
 	if err != nil {
-		return "", SDKError{Method: "Jobs.Create", Err: err}
+		return "", err
 	}
 	return strconv.FormatInt(response.JobId, 10), nil
 }
@@ -43,23 +43,15 @@ func (r *ResourceJob) DoUpdate(ctx context.Context, id string) error {
 	if err != nil {
 		return err
 	}
-	err = r.client.Jobs.Reset(ctx, request)
-	if err != nil {
-		return SDKError{Method: "Jobs.Reset", Err: err}
-	}
-	return nil
+	return r.client.Jobs.Reset(ctx, request)
 }
 
 func DeleteJob(ctx context.Context, client *databricks.WorkspaceClient, id string) error {
 	idInt, err := strconv.ParseInt(id, 10, 64)
 	if err != nil {
 		return err
 	}
-	err = client.Jobs.DeleteByJobId(ctx, idInt)
-	if err != nil {
-		return SDKError{Method: "Jobs.DeleteByJobId", Err: err}
-	}
-	return nil
+	return client.Jobs.DeleteByJobId(ctx, idInt)
 }
 
 func (r *ResourceJob) WaitAfterCreate(ctx context.Context) error {
diff --git a/bundle/terranova/tnresources/pipeline.go b/bundle/terranova/tnresources/pipeline.go
@@ -27,7 +27,7 @@ func (r *ResourcePipeline) Config() any {
 func (r *ResourcePipeline) DoCreate(ctx context.Context) (string, error) {
 	response, err := r.client.Pipelines.Create(ctx, r.config)
 	if err != nil {
-		return "", SDKError{Method: "Pipelines.Create", Err: err}
+		return "", err
 	}
 	return response.PipelineId, nil
 }
@@ -68,19 +68,11 @@ func (r *ResourcePipeline) DoUpdate(ctx context.Context, id string) error {
 		ForceSendFields:      filterFields[pipelines.EditPipeline](r.config.ForceSendFields),
 	}
 
-	err := r.client.Pipelines.Update(ctx, request)
-	if err != nil {
-		return SDKError{Method: "Pipelines.Update", Err: err}
-	}
-	return nil
+	return r.client.Pipelines.Update(ctx, request)
 }
 
 func DeletePipeline(ctx context.Context, client *databricks.WorkspaceClient, id string) error {
-	err := client.Pipelines.DeleteByPipelineId(ctx, id)
-	if err != nil {
-		return SDKError{Method: "Pipelines.DeleteByPipelineId", Err: err}
-	}
-	return nil
+	return client.Pipelines.DeleteByPipelineId(ctx, id)
 }
 
 func (r *ResourcePipeline) WaitAfterCreate(ctx context.Context) error {
diff --git a/bundle/terranova/tnresources/schema.go b/bundle/terranova/tnresources/schema.go
@@ -28,7 +28,7 @@ func (r *ResourceSchema) Config() any {
 func (r *ResourceSchema) DoCreate(ctx context.Context) (string, error) {
 	response, err := r.client.Schemas.Create(ctx, r.config)
 	if err != nil {
-		return "", SDKError{Method: "Schemas.Create", Err: err}
+		return "", err
 	}
 	return response.FullName, nil
 }
@@ -46,7 +46,7 @@ func (r *ResourceSchema) DoUpdate(ctx context.Context, id string) error {
 
 	response, err := r.client.Schemas.Update(ctx, updateRequest)
 	if err != nil {
-		return SDKError{Method: "Schemas.Update", Err: err}
+		return err
 	}
 
 	if response.FullName != id {
@@ -57,15 +57,11 @@ func (r *ResourceSchema) DoUpdate(ctx context.Context, id string) error {
 }
 
 func DeleteSchema(ctx context.Context, client *databricks.WorkspaceClient, id string) error {
-	err := client.Schemas.Delete(ctx, catalog.DeleteSchemaRequest{
+	return client.Schemas.Delete(ctx, catalog.DeleteSchemaRequest{
 		FullName:        id,
 		Force:           true,
 		ForceSendFields: nil,
 	})
-	if err != nil {
-		return SDKError{Method: "Schemas.Delete", Err: err}
-	}
-	return nil
 }
 
 func (r *ResourceSchema) WaitAfterCreate(ctx context.Context) error {
diff --git a/bundle/terranova/tnresources/sdk_error.go b/bundle/terranova/tnresources/sdk_error.go
diff --git a/bundle/terranova/tnresources/sql_warehouse.go b/bundle/terranova/tnresources/sql_warehouse.go
@@ -28,7 +28,7 @@ func (r *ResourceSqlWarehouse) Config() any {
 func (r *ResourceSqlWarehouse) DoCreate(ctx context.Context) (string, error) {
 	waiter, err := r.client.Warehouses.Create(ctx, r.config)
 	if err != nil {
-		return "", SDKError{Method: "Warehouses.Create", Err: err}
+		return "", err
 	}
 
 	return waiter.Id, nil
@@ -55,7 +55,7 @@ func (r *ResourceSqlWarehouse) DoUpdate(ctx context.Context, id string) error {
 
 	waiter, err := r.client.Warehouses.Edit(ctx, request)
 	if err != nil {
-		return SDKError{Method: "Warehouses.Edit", Err: err}
+		return err
 	}
 
 	if waiter.Id != id {
@@ -76,9 +76,5 @@ func (r *ResourceSqlWarehouse) WaitAfterUpdate(ctx context.Context) error {
 }
 
 func DeleteSqlWarehouse(ctx context.Context, client *databricks.WorkspaceClient, oldID string) error {
-	err := client.Warehouses.DeleteById(ctx, oldID)
-	if err != nil {
-		return SDKError{Method: "Warehouses.DeleteById", Err: err}
-	}
-	return nil
+	return client.Warehouses.DeleteById(ctx, oldID)
 }
diff --git a/bundle/terranova/tnresources/volume.go b/bundle/terranova/tnresources/volume.go
@@ -32,7 +32,7 @@ func (r *ResourceVolume) Config() any {
 func (r *ResourceVolume) DoCreate(ctx context.Context) (string, error) {
 	response, err := r.client.Volumes.Create(ctx, r.config)
 	if err != nil {
-		return "", SDKError{Method: "Volumes.Create", Err: err}
+		return "", err
 	}
 	return response.FullName, nil
 }
@@ -58,7 +58,7 @@ func (r *ResourceVolume) DoUpdate(ctx context.Context, id string) error {
 
 	response, err := r.client.Volumes.Update(ctx, updateRequest)
 	if err != nil {
-		return SDKError{Method: "Volumes.Update", Err: err}
+		return err
 	}
 
 	if id != response.FullName {
@@ -91,7 +91,7 @@ func (r *ResourceVolume) DoUpdateWithID(ctx context.Context, id string) (string,
 
 	response, err := r.client.Volumes.Update(ctx, updateRequest)
 	if err != nil {
-		return "", SDKError{Method: "Volumes.Update", Err: err}
+		return "", err
 	}
 
 	return response.FullName, nil
@@ -100,7 +100,7 @@ func (r *ResourceVolume) DoUpdateWithID(ctx context.Context, id string) (string,
 func DeleteVolume(ctx context.Context, client *databricks.WorkspaceClient, id string) error {
 	err := client.Volumes.DeleteByName(ctx, id)
 	if err != nil {
-		return SDKError{Method: "Volumes.Delete", Err: err}
+		return err
 	}
 	return nil
 }
diff --git a/libs/diag/diagnostic.go b/libs/diag/diagnostic.go
@@ -48,7 +48,8 @@ func FromErr(err error) Diagnostics {
 	return []Diagnostic{
 		{
 			Severity: Error,
-			Summary:  err.Error(),
+			Summary:  FormatAPIErrorSummary(err),
+			Detail:   FormatAPIErrorDetails(err),
 		},
 	}
 }
diff --git a/libs/diag/sdk_error.go b/libs/diag/sdk_error.go
@@ -0,0 +1,61 @@
+package diag
+
+import (
+	"errors"
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/databricks/databricks-sdk-go/apierr"
+)
+
+func findApiErr(e error) *apierr.APIError {
+	for {
+		cast, ok := e.(*apierr.APIError)
+		if ok {
+			return cast
+		}
+
+		inner := errors.Unwrap(e)
+		if inner == nil {
+			break
+		}
+		e = inner
+	}
+	return nil
+}
+
+func FormatAPIErrorSummary(e error) string {
+	extra := ""
+	apiErr := findApiErr(e)
+	if apiErr != nil {
+		extra = strings.TrimSpace(fmt.Sprintf("%d %s", apiErr.StatusCode, apiErr.ErrorCode))
+		extra = " (" + extra + ")"
+	}
+
+	return e.Error() + extra
+}
+
+func FormatAPIErrorDetails(e error) string {
+	apiErr := findApiErr(e)
+	if apiErr == nil {
+		return ""
+	}
+	endpoint := "n/a"
+	httpStatus := ""
+	w := apiErr.ResponseWrapper
+	if w != nil {
+		resp := w.Response
+		if resp != nil {
+			httpStatus = resp.Status
+			req := resp.Request
+			if req != nil {
+				endpoint = fmt.Sprintf("%s %s", req.Method, req.URL)
+			}
+		}
+	}
+	if len(httpStatus) == 0 {
+		httpStatus = strconv.Itoa(apiErr.StatusCode)
+	}
+	return fmt.Sprintf("Endpoint: %s\nHTTP Status: %s\nAPI error_code: %s\nAPI message: %s", endpoint, httpStatus, apiErr.ErrorCode, apiErr.Message)
+}

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func (r *ResourceApp) DoCreate(ctx context.Context) (string, error) {`
`33`	`33`	`}`
`34`	`34`	`waiter, err := r.client.Apps.Create(ctx, request)`
`35`	`35`	`if err != nil {`
`36`		`- return "", SDKError{Method: "Apps.Create", Err: err}`
	`36`	`+ return "", err`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`// TODO: Store waiter for Wait method`
`@@ -48,7 +48,7 @@ func (r *ResourceApp) DoUpdate(ctx context.Context, id string) error {`
`48`	`48`	`}`
`49`	`49`	`response, err := r.client.Apps.Update(ctx, request)`
`50`	`50`	`if err != nil {`
`51`		`- return SDKError{Method: "Apps.Update", Err: err}`
	`51`	`+ return err`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`if response.Name != id {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func (r *ResourceJob) DoCreate(ctx context.Context) (string, error) {`
`33`	`33`	`}`
`34`	`34`	`response, err := r.client.Jobs.Create(ctx, request)`
`35`	`35`	`if err != nil {`
`36`		`- return "", SDKError{Method: "Jobs.Create", Err: err}`
	`36`	`+ return "", err`
`37`	`37`	`}`
`38`	`38`	`return strconv.FormatInt(response.JobId, 10), nil`
`39`	`39`	`}`
`@@ -43,23 +43,15 @@ func (r *ResourceJob) DoUpdate(ctx context.Context, id string) error {`
`43`	`43`	`if err != nil {`
`44`	`44`	`return err`
`45`	`45`	`}`
`46`		`- err = r.client.Jobs.Reset(ctx, request)`
`47`		`- if err != nil {`
`48`		`- return SDKError{Method: "Jobs.Reset", Err: err}`
`49`		`- }`
`50`		`- return nil`
	`46`	`+ return r.client.Jobs.Reset(ctx, request)`
`51`	`47`	`}`
`52`	`48`
`53`	`49`	`func DeleteJob(ctx context.Context, client *databricks.WorkspaceClient, id string) error {`
`54`	`50`	`idInt, err := strconv.ParseInt(id, 10, 64)`
`55`	`51`	`if err != nil {`
`56`	`52`	`return err`
`57`	`53`	`}`
`58`		`- err = client.Jobs.DeleteByJobId(ctx, idInt)`
`59`		`- if err != nil {`
`60`		`- return SDKError{Method: "Jobs.DeleteByJobId", Err: err}`
`61`		`- }`
`62`		`- return nil`
	`54`	`+ return client.Jobs.DeleteByJobId(ctx, idInt)`
`63`	`55`	`}`
`64`	`56`
`65`	`57`	`func (r *ResourceJob) WaitAfterCreate(ctx context.Context) error {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func (r *ResourcePipeline) Config() any {`
`27`	`27`	`func (r *ResourcePipeline) DoCreate(ctx context.Context) (string, error) {`
`28`	`28`	`response, err := r.client.Pipelines.Create(ctx, r.config)`
`29`	`29`	`if err != nil {`
`30`		`- return "", SDKError{Method: "Pipelines.Create", Err: err}`
	`30`	`+ return "", err`
`31`	`31`	`}`
`32`	`32`	`return response.PipelineId, nil`
`33`	`33`	`}`
`@@ -68,19 +68,11 @@ func (r *ResourcePipeline) DoUpdate(ctx context.Context, id string) error {`
`68`	`68`	`ForceSendFields: filterFields[pipelines.EditPipeline](r.config.ForceSendFields),`
`69`	`69`	`}`
`70`	`70`
`71`		`- err := r.client.Pipelines.Update(ctx, request)`
`72`		`- if err != nil {`
`73`		`- return SDKError{Method: "Pipelines.Update", Err: err}`
`74`		`- }`
`75`		`- return nil`
	`71`	`+ return r.client.Pipelines.Update(ctx, request)`
`76`	`72`	`}`
`77`	`73`
`78`	`74`	`func DeletePipeline(ctx context.Context, client *databricks.WorkspaceClient, id string) error {`
`79`		`- err := client.Pipelines.DeleteByPipelineId(ctx, id)`
`80`		`- if err != nil {`
`81`		`- return SDKError{Method: "Pipelines.DeleteByPipelineId", Err: err}`
`82`		`- }`
`83`		`- return nil`
	`75`	`+ return client.Pipelines.DeleteByPipelineId(ctx, id)`
`84`	`76`	`}`
`85`	`77`
`86`	`78`	`func (r *ResourcePipeline) WaitAfterCreate(ctx context.Context) error {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ func (r *ResourceSchema) Config() any {`
`28`	`28`	`func (r *ResourceSchema) DoCreate(ctx context.Context) (string, error) {`
`29`	`29`	`response, err := r.client.Schemas.Create(ctx, r.config)`
`30`	`30`	`if err != nil {`
`31`		`- return "", SDKError{Method: "Schemas.Create", Err: err}`
	`31`	`+ return "", err`
`32`	`32`	`}`
`33`	`33`	`return response.FullName, nil`
`34`	`34`	`}`
`@@ -46,7 +46,7 @@ func (r *ResourceSchema) DoUpdate(ctx context.Context, id string) error {`
`46`	`46`
`47`	`47`	`response, err := r.client.Schemas.Update(ctx, updateRequest)`
`48`	`48`	`if err != nil {`
`49`		`- return SDKError{Method: "Schemas.Update", Err: err}`
	`49`	`+ return err`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`if response.FullName != id {`
`@@ -57,15 +57,11 @@ func (r *ResourceSchema) DoUpdate(ctx context.Context, id string) error {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`func DeleteSchema(ctx context.Context, client *databricks.WorkspaceClient, id string) error {`
`60`		`- err := client.Schemas.Delete(ctx, catalog.DeleteSchemaRequest{`
	`60`	`+ return client.Schemas.Delete(ctx, catalog.DeleteSchemaRequest{`
`61`	`61`	`FullName: id,`
`62`	`62`	`Force: true,`
`63`	`63`	`ForceSendFields: nil,`
`64`	`64`	`})`
`65`		`- if err != nil {`
`66`		`- return SDKError{Method: "Schemas.Delete", Err: err}`
`67`		`- }`
`68`		`- return nil`
`69`	`65`	`}`
`70`	`66`
`71`	`67`	`func (r *ResourceSchema) WaitAfterCreate(ctx context.Context) error {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ func (r *ResourceSqlWarehouse) Config() any {`
`28`	`28`	`func (r *ResourceSqlWarehouse) DoCreate(ctx context.Context) (string, error) {`
`29`	`29`	`waiter, err := r.client.Warehouses.Create(ctx, r.config)`
`30`	`30`	`if err != nil {`
`31`		`- return "", SDKError{Method: "Warehouses.Create", Err: err}`
	`31`	`+ return "", err`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`return waiter.Id, nil`
`@@ -55,7 +55,7 @@ func (r *ResourceSqlWarehouse) DoUpdate(ctx context.Context, id string) error {`
`55`	`55`
`56`	`56`	`waiter, err := r.client.Warehouses.Edit(ctx, request)`
`57`	`57`	`if err != nil {`
`58`		`- return SDKError{Method: "Warehouses.Edit", Err: err}`
	`58`	`+ return err`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`if waiter.Id != id {`
`@@ -76,9 +76,5 @@ func (r *ResourceSqlWarehouse) WaitAfterUpdate(ctx context.Context) error {`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`func DeleteSqlWarehouse(ctx context.Context, client *databricks.WorkspaceClient, oldID string) error {`
`79`		`- err := client.Warehouses.DeleteById(ctx, oldID)`
`80`		`- if err != nil {`
`81`		`- return SDKError{Method: "Warehouses.DeleteById", Err: err}`
`82`		`- }`
`83`		`- return nil`
	`79`	`+ return client.Warehouses.DeleteById(ctx, oldID)`
`84`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func (r *ResourceVolume) Config() any {`
`32`	`32`	`func (r *ResourceVolume) DoCreate(ctx context.Context) (string, error) {`
`33`	`33`	`response, err := r.client.Volumes.Create(ctx, r.config)`
`34`	`34`	`if err != nil {`
`35`		`- return "", SDKError{Method: "Volumes.Create", Err: err}`
	`35`	`+ return "", err`
`36`	`36`	`}`
`37`	`37`	`return response.FullName, nil`
`38`	`38`	`}`
`@@ -58,7 +58,7 @@ func (r *ResourceVolume) DoUpdate(ctx context.Context, id string) error {`
`58`	`58`
`59`	`59`	`response, err := r.client.Volumes.Update(ctx, updateRequest)`
`60`	`60`	`if err != nil {`
`61`		`- return SDKError{Method: "Volumes.Update", Err: err}`
	`61`	`+ return err`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`if id != response.FullName {`
`@@ -91,7 +91,7 @@ func (r *ResourceVolume) DoUpdateWithID(ctx context.Context, id string) (string,`
`91`	`91`
`92`	`92`	`response, err := r.client.Volumes.Update(ctx, updateRequest)`
`93`	`93`	`if err != nil {`
`94`		`- return "", SDKError{Method: "Volumes.Update", Err: err}`
	`94`	`+ return "", err`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`return response.FullName, nil`
`@@ -100,7 +100,7 @@ func (r *ResourceVolume) DoUpdateWithID(ctx context.Context, id string) (string,`
`100`	`100`	`func DeleteVolume(ctx context.Context, client *databricks.WorkspaceClient, id string) error {`
`101`	`101`	`err := client.Volumes.DeleteByName(ctx, id)`
`102`	`102`	`if err != nil {`
`103`		`- return SDKError{Method: "Volumes.Delete", Err: err}`
	`103`	`+ return err`
`104`	`104`	`}`
`105`	`105`	`return nil`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,8 @@ func FromErr(err error) Diagnostics {`
`48`	`48`	`return []Diagnostic{`
`49`	`49`	`{`
`50`	`50`	`Severity: Error,`
`51`		`- Summary: err.Error(),`
	`51`	`+ Summary: FormatAPIErrorSummary(err),`
	`52`	`+ Detail: FormatAPIErrorDetails(err),`
`52`	`53`	`},`
`53`	`54`	`}`
`54`	`55`	`}`