Improve JSON output for pg update command (#482)

Improves JSON output for `render ea pg update` to include the updated postgres details and before/after for all changed fields.

Removes the full API shape for Project and Environment that were previously riding along for all Postgres commands

GROW-2588

GitOrigin-RevId: 8f4cb481ae51801ed1e3afea0ee08143563dc418

Author: davidharting

cmd/pgupdate.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"
@@ -102,22 +101,17 @@ mutually exclusive.`,
 		input.ProjectIDOrName = types.OptionalNonZeroString(input.ProjectIDOrName)
 		input.EnvironmentIDOrName = types.OptionalNonZeroString(input.EnvironmentIDOrName)
 
-		// Captured by both closures so the text formatter can render a diff
-		// while JSON/YAML output stays simple — just the new state, matching
-		// pg create's output shape.
-		var before *client.PostgresDetail
-
 		_, err := command.NonInteractive(cmd,
-			func() (*client.PostgresDetail, error) {
+			func() (*postgres.PostgresUpdateOut, error) {
 				result, err := deps.PostgresService().Update(cmd.Context(), input)
 				if err != nil {
 					return nil, err
 				}
-				before = result.Before
-				return result.After, nil
+				out := postgres.NewPostgresUpdateOut(result.Before, result.After)
+				return &out, nil
 			},
-			func(after *client.PostgresDetail) string {
-				return pgUpdateSuccessMessage(before, after)
+			func(out *postgres.PostgresUpdateOut) string {
+				return pgUpdateSuccessMessage(out)
 			},
 		)
 		return err
@@ -126,9 +120,9 @@ mutually exclusive.`,
 	return cmd
 }
 
-func pgUpdateSuccessMessage(before, after *client.PostgresDetail) string {
-	details := "Full details:\n  " + strings.ReplaceAll(text.PostgresAPIDetail(after), "\n", "\n  ")
-	diff := text.PostgresUpdateDiff(before, after)
+func pgUpdateSuccessMessage(out *postgres.PostgresUpdateOut) string {
+	details := "Full details:\n  " + strings.ReplaceAll(text.PostgresDetail(&out.Data), "\n", "\n  ")
+	diff := text.PostgresUpdateDiff(out.Diff)
 	if diff == "" {
 		return fmt.Sprintf("No changes applied to Postgres database\n\n%s\n", details)
 	}

cmd/pgupdate_test.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"encoding/json"
 	"strings"
 	"testing"
 
@@ -11,6 +10,7 @@ import (
 	renderapi "github.com/render-oss/cli/internal/fakes/renderapi"
 	"github.com/render-oss/cli/internal/testassert"
 	"github.com/render-oss/cli/internal/testids"
+	"github.com/render-oss/cli/internal/testrequire"
 	"github.com/render-oss/cli/pkg/client"
 	pgclient "github.com/render-oss/cli/pkg/client/postgres"
 	"github.com/render-oss/cli/pkg/pointers"
@@ -164,22 +164,27 @@ func TestPGUpdate_NameCollision_Errors(t *testing.T) {
 	assert.Contains(t, err.Error(), "Multiple Postgres databases")
 }
 
-func TestPGUpdate_JSONOutput_ReturnsNewState(t *testing.T) {
+func TestPGUpdate_JSONOutput_ReturnsDataAndDiff(t *testing.T) {
 	harness := newPGUpdateHarness(t)
-	pg := seedPG(harness.server, "json-db")
+	project := harness.server.CreateProject(
+		renderapi.ProjectAttrs{Name: "My Project", OwnerId: pgActiveWorkspaceID},
+		renderapi.EnvAttrs{Name: "production"},
+	)
+	pg := seedPGInEnv(harness.server, "json-db", project.Env("production").Id)
 
 	result, err := harness.execute(pg.Id, "--name", "json-renamed", "--output", "json")
 	require.NoError(t, err)
 
-	var body struct {
-		ID   string `json:"id"`
-		Name string `json:"name"`
-	}
-	require.NoError(t, json.Unmarshal([]byte(result.Stdout), &body))
-	assert.Equal(t, pg.Id, body.ID)
-	assert.Equal(t, "json-renamed", body.Name)
-	// JSON returns just the new state, not a before/after wrapper.
-	assert.NotContains(t, result.Stdout, "Changes:")
+	body := unmarshalPGJSONOutput(t, result.Stdout)
+	data := testrequire.SubMap(t, body, "data")
+	diff := testrequire.SubMap(t, body, "diff")
+	nameDiff := testrequire.SubMap(t, diff, "name")
+	assert.Equal(t, pg.Id, data["id"])
+	assert.Equal(t, "json-renamed", data["name"])
+	assert.Equal(t, project.Project.Id, data["projectId"])
+	assert.Equal(t, project.Env("production").Id, data["environmentId"])
+	assert.Equal(t, "json-db", nameDiff["before"])
+	assert.Equal(t, "json-renamed", nameDiff["after"])
 }
 
 func TestPGUpdate_UnknownID_Errors(t *testing.T) {

pkg/postgres/output.go

@@ -132,11 +132,11 @@ func NewPostgresUpdateOut(before *client.PostgresDetail, after *ResolvedPostgres
 	if before == nil {
 		return out
 	}
-	out.Diff = NewPostgresUpdateDiff(before, &out.Data)
+	out.Diff = newPostgresUpdateDiff(before, &out.Data)
 	return out
 }
 
-func NewPostgresUpdateDiff(before *client.PostgresDetail, after *PostgresOut) PostgresUpdateDiff {
+func newPostgresUpdateDiff(before *client.PostgresDetail, after *PostgresOut) PostgresUpdateDiff {
 	var diff PostgresUpdateDiff
 	if before == nil || after == nil {
 		return diff

pkg/postgres/service.go

@@ -186,7 +186,14 @@ func (s *Service) Update(ctx context.Context, input pgtypes.UpdatePostgresInput)
 		return nil, err
 	}
 
-	return &UpdateResult{Before: before, After: after}, nil
+	return &UpdateResult{
+		Before: before,
+		After: &ResolvedPostgres{
+			Postgres:    after,
+			Project:     resolvedBefore.Project,
+			Environment: resolvedBefore.Environment,
+		},
+	}, nil
 }
 
 func (s *Service) hydratePostgresModel(ctx context.Context, postgres *client.Postgres, projects []*client.Project) (*Model, error) {

pkg/postgres/update.go

@@ -12,7 +12,7 @@ import (
 // more information than just the new state.
 type UpdateResult struct {
 	Before *client.PostgresDetail `json:"before"`
-	After  *client.PostgresDetail `json:"after"`
+	After  *ResolvedPostgres      `json:"after"`
 }
 
 // BuildUpdateRequest converts an UpdatePostgresInput into the API PATCH body.

pkg/text/postgres.go

@@ -3,13 +3,11 @@ package text
 import (
 	"fmt"
 	"maps"
-	"reflect"
 	"slices"
 	"strings"
 
 	"github.com/jedib0t/go-pretty/table"
 
-	"github.com/render-oss/cli/internal/ipallowlist"
 	"github.com/render-oss/cli/pkg/client"
 	"github.com/render-oss/cli/pkg/postgres"
 )
@@ -128,38 +126,37 @@ func diskSizeLabel(gb *int) string {
 	return fmt.Sprintf("%d GB", *gb)
 }
 
-// PostgresUpdateDiff renders the user-visible changes between before and after
-// snapshots of a Postgres instance, showing only the fields that actually
-// changed. Returns an empty string when nothing changed (the cmd layer can
-// then surface a "no changes" message).
+// PostgresUpdateDiff renders the user-visible changes from the public update
+// diff contract. Returns an empty string when nothing changed (the cmd layer
+// can then surface a "no changes" message).
 //
 // Label column is padded to 20 characters so the arrows align:
 //
 //	"  High availability: disabled → enabled"
-func PostgresUpdateDiff(before, after *client.PostgresDetail) string {
+func PostgresUpdateDiff(diff postgres.PostgresUpdateDiff) string {
 	var lines []string
 
-	if before.Name != after.Name {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Name:", before.Name, after.Name))
+	if diff.Name != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Name:", diff.Name.Before, diff.Name.After))
 	}
-	if before.Plan != after.Plan {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Plan:", string(before.Plan), string(after.Plan)))
+	if diff.Plan != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Plan:", string(diff.Plan.Before), string(diff.Plan.After)))
 	}
-	if diskSizeLabel(before.DiskSizeGB) != diskSizeLabel(after.DiskSizeGB) {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Disk size:", diskSizeLabel(before.DiskSizeGB), diskSizeLabel(after.DiskSizeGB)))
+	if diff.DiskSizeGB != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Disk size:", diskSizeLabel(diff.DiskSizeGB.Before), diskSizeLabel(diff.DiskSizeGB.After)))
 	}
-	if before.DiskAutoscalingEnabled != after.DiskAutoscalingEnabled {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Disk autoscaling:", boolLabel(before.DiskAutoscalingEnabled), boolLabel(after.DiskAutoscalingEnabled)))
+	if diff.DiskAutoscalingEnabled != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "Disk autoscaling:", boolLabel(diff.DiskAutoscalingEnabled.Before), boolLabel(diff.DiskAutoscalingEnabled.After)))
 	}
-	if before.HighAvailabilityEnabled != after.HighAvailabilityEnabled {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "High availability:", boolLabel(before.HighAvailabilityEnabled), boolLabel(after.HighAvailabilityEnabled)))
+	if diff.HighAvailabilityEnabled != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "High availability:", boolLabel(diff.HighAvailabilityEnabled.Before), boolLabel(diff.HighAvailabilityEnabled.After)))
 	}
-	if !ipallowlist.Equal(before.IpAllowList, after.IpAllowList) {
-		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "IP allow-list:", ipAllowListLabel(before.IpAllowList), ipAllowListLabel(after.IpAllowList)))
+	if diff.IPAllowList != nil {
+		lines = append(lines, fmt.Sprintf("  %-20s%s → %s", "IP allow-list:", ipAllowListLabel(diff.IPAllowList.Before), ipAllowListLabel(diff.IPAllowList.After)))
 	}
 	// ParameterOverrides is a map; rather than a noisy per-key diff we flag that
 	// it changed. The full new state is shown in the PostgresDetail block below.
-	if !reflect.DeepEqual(before.ParameterOverrides, after.ParameterOverrides) {
+	if diff.ParameterOverrides != nil {
 		lines = append(lines, fmt.Sprintf("  %-20s %s", "Parameter overrides:", "updated"))
 	}
 

pkg/text/postgres_test.go

@@ -28,6 +28,11 @@ func basicPostgres() *client.PostgresDetail {
 	}
 }
 
+func postgresUpdateDiff(before, after *client.PostgresDetail) postgres.PostgresUpdateDiff {
+	out := postgres.NewPostgresUpdateOut(before, &postgres.ResolvedPostgres{Postgres: after})
+	return out.Diff
+}
+
 func TestPostgresDetail_BasicFields(t *testing.T) {
 	out := text.PostgresAPIDetail(basicPostgres())
 
@@ -137,15 +142,15 @@ func TestPostgresTable(t *testing.T) {
 func TestPostgresUpdateDiff(t *testing.T) {
 	t.Run("returns empty string when nothing changed", func(t *testing.T) {
 		pg := basicPostgres()
-		assert.Empty(t, text.PostgresUpdateDiff(pg, pg))
+		assert.Empty(t, text.PostgresUpdateDiff(postgresUpdateDiff(pg, pg)))
 	})
 
 	t.Run("single changed field: name", func(t *testing.T) {
 		before := basicPostgres()
 		after := basicPostgres()
 		after.Name = "new-name"
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "Name:", "my-pg → new-name")
 	})
 
@@ -154,7 +159,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 		after := basicPostgres()
 		after.Plan = pgclient.Basic256mb
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "Plan:", "free → basic_256mb")
 	})
 
@@ -163,7 +168,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 		after := basicPostgres()
 		after.DiskSizeGB = pointers.From(100)
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "Disk size:", "(unset) → 100 GB")
 	})
 
@@ -174,7 +179,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 		after.DiskAutoscalingEnabled = true
 		after.HighAvailabilityEnabled = false
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		// Disk autoscaling renders before high availability, so assert the full
 		// layout in order: a field that turned on, then one that turned off.
 		testassert.ContainsInOrder(t, out,
@@ -189,7 +194,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 			{CidrBlock: "10.0.0.0/8", Description: "internal"},
 		}
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "IP allow-list:", "(empty) → 1 entry")
 	})
 
@@ -198,7 +203,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 		after := basicPostgres()
 		after.ParameterOverrides = &client.PostgresParameterOverrides{"max_connections": "200"}
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "Parameter overrides:", "updated")
 	})
 
@@ -208,7 +213,7 @@ func TestPostgresUpdateDiff(t *testing.T) {
 		after.Name = "renamed"
 		after.HighAvailabilityEnabled = true
 
-		out := text.PostgresUpdateDiff(before, after)
+		out := text.PostgresUpdateDiff(postgresUpdateDiff(before, after))
 		testassert.ContainsInOrder(t, out, "Name:", "High availability:")
 
 		// Only changed fields appear; untouched fields are omitted.