Improve JSON output for postgres create and list commands (#483)

Cleans up JSON output for `render ea pg list` and `render ea pg create`

GROW-2588

GitOrigin-RevId: 022645efcf365da80a39b3b7836bf2217cb140c7

Author: davidharting

cmd/pgcreate.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/render-oss/cli/pkg/client"
 	"github.com/render-oss/cli/pkg/command"
 	"github.com/render-oss/cli/pkg/dependencies"
 	"github.com/render-oss/cli/pkg/postgres"
@@ -101,11 +100,16 @@ Examples:
 		// this gate. command.NonInteractive returns (false, nil) only when the resolved
 		// output format is still interactive, without calling loadData.
 		nonInteractive, err := command.NonInteractive(cmd,
-			func() (*client.PostgresDetail, error) {
-				return deps.PostgresService().Create(cmd.Context(), input)
+			func() (*postgres.CreateOut, error) {
+				resolved, err := deps.PostgresService().Create(cmd.Context(), input)
+				if err != nil {
+					return nil, err
+				}
+				out := postgres.NewPostgresCreateOut(resolved)
+				return &out, nil
 			},
-			func(pg *client.PostgresDetail) string {
-				return pgCreateSuccessMessage(pg)
+			func(out *postgres.CreateOut) string {
+				return pgCreateSuccessMessage(out)
 			},
 		)
 		if err != nil || nonInteractive {
@@ -125,9 +129,9 @@ Examples:
 	return cmd
 }
 
-func pgCreateSuccessMessage(pg *client.PostgresDetail) string {
+func pgCreateSuccessMessage(out *postgres.CreateOut) string {
 	return fmt.Sprintf(
 		"Created Postgres database\n\n%s\n",
-		text.PostgresAPIDetail(pg),
+		text.PostgresDetail(&out.Data),
 	)
 }

cmd/pgcreate_test.go

@@ -1,13 +1,13 @@
 package cmd
 
 import (
-	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	renderapi "github.com/render-oss/cli/internal/fakes/renderapi"
+	"github.com/render-oss/cli/internal/testrequire"
 	"github.com/render-oss/cli/pkg/client"
 	pgclient "github.com/render-oss/cli/pkg/client/postgres"
 )
@@ -82,16 +82,26 @@ func TestPGCreate_AllFlags(t *testing.T) {
 
 func TestPGCreate_OutputJSON_IsMachineReadable(t *testing.T) {
 	server := renderapi.NewServer(t)
+	project := server.CreateProject(
+		renderapi.ProjectAttrs{Name: "My Project", OwnerId: pgActiveWorkspaceID},
+		renderapi.EnvAttrs{Name: "production"},
+	)
+
 	result, err := executePGCreate(t, server,
 		"--name", "my-pg",
+		"--project", "My Project",
 		"--output", "json",
 	)
 	require.NoError(t, err)
 
-	var decoded map[string]any
-	require.NoError(t, json.Unmarshal([]byte(result.Stdout), &decoded))
-	assert.Equal(t, "my-pg", decoded["name"])
-	assert.NotEmpty(t, decoded["id"])
+	body := unmarshalPGJSONOutput(t, result.Stdout)
+	data := testrequire.SubMap(t, body, "data")
+	assert.Equal(t, "my-pg", data["name"])
+	assert.NotEmpty(t, data["id"])
+	assert.Equal(t, project.Project.Id, data["projectId"])
+	assert.Equal(t, project.Env("production").Id, data["environmentId"])
+	testrequire.SubSlice(t, data, "ipAllowList")
+	testrequire.SubSlice(t, data, "readReplicas")
 }
 
 // Verifies that --confirm in interactive output mode creates without launching the wizard.

cmd/pglist.go

@@ -52,9 +52,16 @@ resolved within that project.`,
 		}
 		input = pgtypes.NormalizeListInput(input)
 
-		_, err := command.NonInteractive(cmd, func() ([]*postgres.Model, error) {
-			return deps.PostgresService().List(cmd.Context(), input)
-		}, text.PostgresTable)
+		_, err := command.NonInteractive(cmd, func() (*postgres.PostgresListOut, error) {
+			models, err := deps.PostgresService().List(cmd.Context(), input)
+			if err != nil {
+				return nil, err
+			}
+			out := postgres.NewPostgresListOut(models)
+			return &out, nil
+		}, func(out *postgres.PostgresListOut) string {
+			return text.PostgresTable(out.Data)
+		})
 		return err
 	}
 

cmd/pglist_test.go

@@ -1,13 +1,13 @@
 package cmd
 
 import (
-	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	renderapi "github.com/render-oss/cli/internal/fakes/renderapi"
+	"github.com/render-oss/cli/internal/testrequire"
 	"github.com/render-oss/cli/pkg/client"
 )
 
@@ -46,13 +46,8 @@ func TestPGList_NoDatabases(t *testing.T) {
 	result, err = harness.execute("--output", "json")
 	require.NoError(t, err)
 
-	var body []struct {
-		Postgres struct {
-			ID string `json:"id"`
-		} `json:"postgres"`
-	}
-	require.NoError(t, json.Unmarshal([]byte(result.Stdout), &body))
-	assert.Empty(t, body)
+	body := unmarshalPGJSONOutput(t, result.Stdout)
+	assert.Empty(t, testrequire.SubSlice(t, body, "data"))
 }
 
 func TestPGList_MultipleDatabases(t *testing.T) {
@@ -146,20 +141,17 @@ func TestPGList_JSONOutput(t *testing.T) {
 	result, err := harness.execute("--output", "json")
 	require.NoError(t, err)
 
-	var body []struct {
-		Postgres struct {
-			ID   string `json:"id"`
-			Name string `json:"name"`
-		} `json:"postgres"`
-	}
-	require.NoError(t, json.Unmarshal([]byte(result.Stdout), &body))
-	require.Len(t, body, 2)
+	body := unmarshalPGJSONOutput(t, result.Stdout)
+	data := testrequire.SubSlice(t, body, "data")
+	require.Len(t, data, 2)
 
 	// Build an _un-ordered_ object to assert against
 	// Order is just determined by our fake render api, so not meaningful
 	got := map[string]string{}
-	for _, item := range body {
-		got[item.Postgres.ID] = item.Postgres.Name
+	for _, item := range data {
+		itemMap, ok := item.(map[string]any)
+		require.True(t, ok)
+		got[itemMap["id"].(string)] = itemMap["name"].(string)
 	}
 	assert.Equal(t, map[string]string{
 		pg1.Id: "json-db-one",

pkg/postgres/service.go

@@ -126,7 +126,7 @@ func (s *Service) ResumePostgres(ctx context.Context, id string) error {
 // Create applies defaults, resolves workspace/project/environment scope,
 // and calls the Postgres create endpoint. The non-interactive flag path
 // and (eventually) the interactive wizard both go through here.
-func (s *Service) Create(ctx context.Context, input pgtypes.CreatePostgresInput) (*client.PostgresDetail, error) {
+func (s *Service) Create(ctx context.Context, input pgtypes.CreatePostgresInput) (*ResolvedPostgres, error) {
 	scope, err := s.resolver.ResolveScope(ctx, resolve.ScopeInput{
 		WorkspaceIDOrName:   input.WorkspaceIDOrName,
 		ProjectIDOrName:     input.ProjectIDOrName,
@@ -143,13 +143,28 @@ func (s *Service) Create(ctx context.Context, input pgtypes.CreatePostgresInput)
 			return nil, err
 		}
 	}
+	env := scope.Environment
+	if env == nil && environmentID != nil {
+		env, err = s.environmentRepo.GetEnvironment(ctx, *environmentID)
+		if err != nil {
+			return nil, err
+		}
+	}
 
 	body, err := BuildCreateRequest(buildRequestInput(input, scope.WorkspaceID, environmentID))
 	if err != nil {
 		return nil, err
 	}
 
-	return s.repo.CreatePostgres(ctx, body)
+	created, err := s.repo.CreatePostgres(ctx, body)
+	if err != nil {
+		return nil, err
+	}
+	return &ResolvedPostgres{
+		Postgres:    created,
+		Project:     scope.Project,
+		Environment: env,
+	}, nil
 }
 
 // Update resolves the target Postgres database (by ID or name, optionally

pkg/postgres/service_test.go

@@ -136,11 +136,11 @@ func TestServiceCreate_UsesResolvedWorkspaceAndDefaults(t *testing.T) {
 	created, err := harness.service.Create(context.Background(), pgtypes.CreatePostgresInput{})
 	require.NoError(t, err)
 
-	assert.NotEmpty(t, created.Id)
-	assert.NotEmpty(t, created.Name)
-	assert.Equal(t, harness.workspaceID, created.Owner.Id)
-	assert.Equal(t, "free", string(created.Plan))
-	assert.Equal(t, "18", string(created.Version))
+	assert.NotEmpty(t, created.Postgres.Id)
+	assert.NotEmpty(t, created.Postgres.Name)
+	assert.Equal(t, harness.workspaceID, created.Postgres.Owner.Id)
+	assert.Equal(t, "free", string(created.Postgres.Plan))
+	assert.Equal(t, "18", string(created.Postgres.Version))
 	assert.Len(t, harness.server.Postgres.Instances, 1)
 }
 
@@ -167,8 +167,12 @@ func TestServiceCreate_AutoSelectsSingleEnvironmentWhenOnlyProjectGiven(t *testi
 	})
 	require.NoError(t, err)
 
-	require.NotNil(t, created.EnvironmentId)
-	assert.Equal(t, env.Id, *created.EnvironmentId)
+	require.NotNil(t, created.Postgres.EnvironmentId)
+	assert.Equal(t, env.Id, *created.Postgres.EnvironmentId)
+	require.NotNil(t, created.Environment)
+	assert.Equal(t, env.Id, created.Environment.Id)
+	require.NotNil(t, created.Project)
+	assert.Equal(t, proj.Id, created.Project.Id)
 }
 
 func TestServiceDelete_DeletesByID(t *testing.T) {

pkg/text/postgres.go

@@ -12,35 +12,26 @@ import (
 	"github.com/render-oss/cli/pkg/postgres"
 )
 
-func PostgresTable(v []*postgres.Model) string {
+func PostgresTable(v []postgres.PostgresListItemOut) string {
 	t := newTable()
 	t.AppendHeader(table.Row{"Name", "Project", "Environment", "Plan", "Region", "Status", "ID"})
 	if len(v) == 0 {
 		t.SetCaption("No Postgres databases found.")
 	}
-	for _, m := range v {
+	for _, pg := range v {
 		t.AppendRow(table.Row{
-			m.Name(),
-			m.ProjectName(),
-			m.EnvironmentName(),
-			string(m.Postgres.Plan),
-			string(m.Postgres.Region),
-			string(m.Postgres.Status),
-			m.ID(),
+			pg.Name,
+			pg.ProjectName,
+			pg.EnvironmentName,
+			string(pg.Plan),
+			string(pg.Region),
+			string(pg.Status),
+			pg.Id,
 		})
 	}
 	return FormatString(t.Render())
 }
 
-// PostgresAPIDetail formats a raw API Postgres detail for text output.
-//
-// TODO(GROW-2588): delete this once all Postgres commands render from
-// postgres.PostgresOut.
-func PostgresAPIDetail(pg *client.PostgresDetail) string {
-	out := postgres.NewPostgresGetOut(&postgres.ResolvedPostgres{Postgres: pg})
-	return PostgresDetail(&out.Data)
-}
-
 // PostgresDetail formats a Postgres instance detail for text output.
 // Does NOT include an action prefix (e.g., "Created") — callers should prepend
 // their own action prefix in the formatText closure passed to command.NonInteractive.