wrap JSON encoding errors for understandability.

Author: n-g

internal/cli/cmd/auth/oidc.go

@@ -13,6 +13,7 @@ import (
 	"namespacelabs.dev/foundation/internal/cli/fncobra"
 	"namespacelabs.dev/foundation/internal/console"
 	"namespacelabs.dev/foundation/internal/fnapi"
+	"namespacelabs.dev/foundation/internal/fnerrors"
 )
 
 const (
@@ -49,7 +50,9 @@ func printResult(ctx context.Context, output string, resp fnapi.IssueIdTokenResp
 	case "json":
 		d := json.NewEncoder(console.Stdout(ctx))
 		d.SetIndent("", "  ")
-		return d.Encode(resp)
+		if err := d.Encode(resp); err != nil {
+			return fnerrors.InternalError("failed to encode token as JSON output: %w", err)
+		}
 
 	default:
 		if output != "" && output != "plain" {

internal/cli/cmd/cluster/buildx.go

@@ -660,7 +660,9 @@ func newStatusBuildxCommand() *cobra.Command {
 		case "json":
 			enc := json.NewEncoder(console.Stdout(ctx))
 			enc.SetIndent("", "  ")
-			return enc.Encode(descs)
+			if err := enc.Encode(descs); err != nil {
+				return fnerrors.InternalError("failed to encode status as JSON output: %w", err)
+			}
 
 		default:
 			if *output != "plain" {

internal/cli/cmd/cluster/create.go

@@ -163,11 +163,13 @@ func NewCreateCmd() *cobra.Command {
 			enc := json.NewEncoder(console.Stdout(ctx))
 			enc.SetIndent("", "  ")
 
-			return enc.Encode(createOutput{
+			if err := enc.Encode(createOutput{
 				ClusterId:     cluster.ClusterId,
 				ClusterUrl:    cluster.Cluster.AppURL,
 				IngressDomain: cluster.Cluster.IngressDomain,
-			})
+			}); err != nil {
+				return fnerrors.InternalError("failed to encode cluster as JSON output: %w", err)
+			}
 
 		default:
 			if *output != "plain" {

internal/cli/cmd/cluster/describe.go

@@ -15,6 +15,7 @@ import (
 	"golang.org/x/exp/slices"
 	"namespacelabs.dev/foundation/internal/cli/fncobra"
 	"namespacelabs.dev/foundation/internal/console"
+	"namespacelabs.dev/foundation/internal/fnerrors"
 	"namespacelabs.dev/foundation/internal/providers/nscloud/api"
 )
 
@@ -61,7 +62,11 @@ func NewDescribeCmd() *cobra.Command {
 		case "json":
 			enc := json.NewEncoder(console.Stdout(ctx))
 			enc.SetIndent("", "  ")
-			return enc.Encode(response.Summary)
+			if err := enc.Encode(response.Summary); err != nil {
+				return fnerrors.InternalError("failed to encode summary as JSON output: %w", err)
+			}
+
+			return nil
 
 		default:
 			if *output != "plain" {

internal/cli/cmd/cluster/expose.go

@@ -551,7 +551,9 @@ func newExposeKubernetesCmd() *cobra.Command {
 				URL:  "https://" + resp.Fqdn,
 			}
 
-			return json.NewEncoder(console.Stdout(ctx)).Encode(exported)
+			if err := json.NewEncoder(console.Stdout(ctx)).Encode(exported); err != nil {
+				return fnerrors.InternalError("failed to encode ingress output as JSON output: %w", err)
+			}
 
 		default:
 			if *output != "" && *output != "plain" {

internal/cli/cmd/cluster/history.go

@@ -12,6 +12,7 @@ import (
 	"github.com/spf13/cobra"
 	"namespacelabs.dev/foundation/internal/cli/fncobra"
 	"namespacelabs.dev/foundation/internal/console"
+	"namespacelabs.dev/foundation/internal/fnerrors"
 	"namespacelabs.dev/foundation/internal/providers/nscloud/api"
 )
 
@@ -43,7 +44,11 @@ func NewListCmd() *cobra.Command {
 			stdout := console.Stdout(ctx)
 			enc := json.NewEncoder(stdout)
 			enc.SetIndent("", "  ")
-			return enc.Encode(transform(clusters.Clusters))
+			if err := enc.Encode(transform(clusters.Clusters)); err != nil {
+				return fnerrors.InternalError("failed to encode cluster list as JSON output: %w", err)
+			}
+
+			return nil
 		}
 
 		if len(clusters.Clusters) == 0 {
@@ -121,7 +126,11 @@ func newHistoryCmd() *cobra.Command {
 			stdout := console.Stdout(ctx)
 			enc := json.NewEncoder(stdout)
 			enc.SetIndent("", "  ")
-			return enc.Encode(clusters.Clusters)
+			if err := enc.Encode(clusters.Clusters); err != nil {
+				return fnerrors.InternalError("failed to encode cluster history as JSON output: %w", err)
+			}
+
+			return nil
 		}
 
 		if len(clusters.Clusters) == 0 {

internal/cli/cmd/cluster/run.go

@@ -373,11 +373,13 @@ func PrintCreateContainersResult(ctx context.Context, output string, resp *api.C
 	case "json":
 		d := json.NewEncoder(console.Stdout(ctx))
 		d.SetIndent("", "  ")
-		return d.Encode(createOutput{
+		if err := d.Encode(createOutput{
 			ClusterId:  resp.ClusterId,
 			ClusterUrl: resp.ClusterUrl,
 			Container:  resp.Container,
-		})
+		}); err != nil {
+			return fnerrors.InternalError("failed to encode countainer creation output as JSON output: %w", err)
+		}
 
 	default:
 		if output != "" && output != "plain" {

internal/cli/cmd/workspace/cmd.go

@@ -13,6 +13,7 @@ import (
 	"namespacelabs.dev/foundation/internal/cli/fncobra"
 	"namespacelabs.dev/foundation/internal/console"
 	"namespacelabs.dev/foundation/internal/fnapi"
+	"namespacelabs.dev/foundation/internal/fnerrors"
 )
 
 func NewWorkspaceCmd() *cobra.Command {
@@ -46,7 +47,9 @@ func newDescribeCmd() *cobra.Command {
 		case "json":
 			d := json.NewEncoder(stdout)
 			d.SetIndent("", "  ")
-			return d.Encode(res.Tenant)
+			if err := d.Encode(res.Tenant); err != nil {
+				return fnerrors.InternalError("failed to encode tenant as JSON output: %w", err)
+			}
 
 		default:
 			fmt.Fprintf(stdout, "\nWorkspace details:\n\n")