Use pointer storage for fake-server owners, projects, and environments (#450)

We have a fake server for render REST API that we can write tests against. We have factory-like methods to seed data for the server.

Across resources, we were storing a mix of struct literals and references.

For this use case, references are preferred, because then you can mutate the references in a test as needed to change the server state and simulate different situations. In real-life, the server state can change between CLI actions!

## Summary

Update `renderapi/fakes/server.go` to store references to structs for all of our seeded data.

This is PR 1 of 6 for PG resume / suspend.
See [GROW-2559: pg resume](https://linear.app/render-com/issue/GROW-2559/pg-resume).

This particular change is setting up better test helpers. I noticed that tests were getting long and hard to read, because so much of them was creating resources and wiring them together via foreign keys.

This change will let me set up better factory methods in the next PR that can produce projects and environments already wired together.

GitOrigin-RevId: 6941912d3d9207ee46b0b3fc491b58f9e3ed820b

Author: davidharting

internal/fakes/renderapi/server.go

@@ -111,7 +111,7 @@ func (pg *PostgresResource) nextError() (int, bool) {
 }
 
 // NewOwner returns an Owner with sensible defaults for any zero-value fields.
-func NewOwner(o client.Owner) client.Owner {
+func NewOwner(o client.Owner) *client.Owner {
 	if o.Id == "" {
 		o.Id = testids.RandomWorkspaceID()
 	}
@@ -121,7 +121,7 @@ func NewOwner(o client.Owner) client.Owner {
 	if o.Email == "" {
 		o.Email = "team@example.com"
 	}
-	return o
+	return &o
 }
 
 // ProjectAttrs defines the fields callers can specify when creating a fake project.
@@ -132,29 +132,29 @@ type ProjectAttrs struct {
 }
 
 // NewProject returns a Project with sensible defaults for any zero-value fields.
-func NewProject(attrs ProjectAttrs) client.Project {
+func NewProject(attrs ProjectAttrs) *client.Project {
 	if attrs.Id == "" {
 		attrs.Id = testids.RandomProjectID()
 	}
 	if attrs.Name == "" {
 		attrs.Name = "My Project"
 	}
-	return client.Project{
+	return &client.Project{
 		Id:    attrs.Id,
 		Name:  attrs.Name,
 		Owner: client.Owner{Id: attrs.OwnerId},
 	}
 }
 
 // NewEnvironment returns an Environment with sensible defaults for any zero-value fields.
-func NewEnvironment(e client.Environment) client.Environment {
+func NewEnvironment(e client.Environment) *client.Environment {
 	if e.Id == "" {
 		e.Id = testids.RandomEnvironmentID()
 	}
 	if e.Name == "" {
 		e.Name = "My Environment"
 	}
-	return e
+	return &e
 }
 
 // NewKV returns a KeyValueDetail with sensible defaults for any zero-value fields.
@@ -282,9 +282,9 @@ type Server struct {
 	server       *httptest.Server
 	Requests     []RecordedRequest
 	CurrentUser  *client.User
-	Owners       *Resource[client.Owner]
-	Projects     *Resource[client.Project]
-	Environments *Resource[client.Environment]
+	Owners       *Resource[*client.Owner]
+	Projects     *Resource[*client.Project]
+	Environments *Resource[*client.Environment]
 	KV           *KVResource
 	Postgres     *PostgresResource
 }
@@ -295,7 +295,7 @@ type Server struct {
 func (s *Server) ownerByID(id string) (client.Owner, bool) {
 	for _, o := range s.Owners.Instances {
 		if o.Id == id {
-			return o, true
+			return *o, true
 		}
 	}
 	return client.Owner{}, false
@@ -328,9 +328,9 @@ func NewServer(t *testing.T) *Server {
 	t.Helper()
 
 	s := &Server{
-		Owners:       &Resource[client.Owner]{},
-		Projects:     &Resource[client.Project]{},
-		Environments: &Resource[client.Environment]{},
+		Owners:       &Resource[*client.Owner]{},
+		Projects:     &Resource[*client.Project]{},
+		Environments: &Resource[*client.Environment]{},
 		KV:           &KVResource{},
 		Postgres:     &PostgresResource{},
 	}
@@ -361,7 +361,7 @@ func NewServer(t *testing.T) *Server {
 		record(r)
 		result := s.Owners.Instances
 		if name := r.URL.Query().Get("name"); name != "" {
-			var filtered []client.Owner
+			var filtered []*client.Owner
 			for _, o := range s.Owners.Instances {
 				if o.Name == name {
 					filtered = append(filtered, o)
@@ -371,8 +371,7 @@ func NewServer(t *testing.T) *Server {
 		}
 		wrapped := make([]client.OwnerWithCursor, len(result))
 		for i := range result {
-			o := result[i]
-			wrapped[i] = client.OwnerWithCursor{Owner: &o}
+			wrapped[i] = client.OwnerWithCursor{Owner: result[i]}
 		}
 		writeJSON(w, http.StatusOK, wrapped)
 	})
@@ -395,7 +394,7 @@ func NewServer(t *testing.T) *Server {
 		record(r)
 		result := s.Projects.Instances
 		if ownerIDs := queryListValues(r, "ownerId"); len(ownerIDs) > 0 {
-			var filtered []client.Project
+			var filtered []*client.Project
 			for _, p := range result {
 				if slices.Contains(ownerIDs, p.Owner.Id) {
 					filtered = append(filtered, p)
@@ -404,7 +403,7 @@ func NewServer(t *testing.T) *Server {
 			result = filtered
 		}
 		if name := r.URL.Query().Get("name"); name != "" {
-			var filtered []client.Project
+			var filtered []*client.Project
 			for _, p := range result {
 				if p.Name == name {
 					filtered = append(filtered, p)
@@ -414,7 +413,8 @@ func NewServer(t *testing.T) *Server {
 		}
 		wrapped := make([]client.ProjectWithCursor, len(result))
 		for i := range result {
-			p := result[i]
+			// Copy before setting Owner so the response doesn't mutate stored state.
+			p := *result[i]
 			owner, ok := s.ownerByID(p.Owner.Id)
 			if !ok {
 				http.Error(w, "fake server: project owner not seeded: "+p.Owner.Id, http.StatusInternalServerError)
@@ -430,8 +430,10 @@ func NewServer(t *testing.T) *Server {
 	mux.HandleFunc("GET /projects/{id}", func(w http.ResponseWriter, r *http.Request) {
 		record(r)
 		id := r.PathValue("id")
-		for _, p := range s.Projects.Instances {
-			if p.Id == id {
+		for _, stored := range s.Projects.Instances {
+			if stored.Id == id {
+				// Copy before setting Owner so the response doesn't mutate stored state.
+				p := *stored
 				owner, ok := s.ownerByID(p.Owner.Id)
 				if !ok {
 					http.Error(w, "fake server: project owner not seeded: "+p.Owner.Id, http.StatusInternalServerError)
@@ -450,7 +452,7 @@ func NewServer(t *testing.T) *Server {
 		record(r)
 		result := s.Environments.Instances
 		if projectIDs := queryListValues(r, "projectId"); len(projectIDs) > 0 {
-			var filtered []client.Environment
+			var filtered []*client.Environment
 			for _, e := range result {
 				if slices.Contains(projectIDs, e.ProjectId) {
 					filtered = append(filtered, e)
@@ -459,7 +461,7 @@ func NewServer(t *testing.T) *Server {
 			result = filtered
 		}
 		if name := r.URL.Query().Get("name"); name != "" {
-			var filtered []client.Environment
+			var filtered []*client.Environment
 			for _, e := range result {
 				if e.Name == name {
 					filtered = append(filtered, e)
@@ -469,7 +471,7 @@ func NewServer(t *testing.T) *Server {
 		}
 		wrapped := make([]client.EnvironmentWithCursor, len(result))
 		for i := range result {
-			wrapped[i] = client.EnvironmentWithCursor{Environment: result[i]}
+			wrapped[i] = client.EnvironmentWithCursor{Environment: *result[i]}
 		}
 		writeJSON(w, http.StatusOK, wrapped)
 	})
@@ -530,7 +532,7 @@ func NewServer(t *testing.T) *Server {
 		var owner client.Owner
 		for _, o := range s.Owners.Instances {
 			if o.Id == body.OwnerId {
-				owner = o
+				owner = *o
 				break
 			}
 		}

pkg/postgres/service_test.go

@@ -98,13 +98,13 @@ func (h testHarness) addProjectAndEnvironment(workspaceID string, projectName st
 	project.EnvironmentIds = []string{env.Id}
 	h.server.Projects.Add(project)
 	h.server.Environments.Add(env)
-	return env
+	return *env
 }
 
 func (h testHarness) requireOwner(workspaceID string) {
 	h.t.Helper()
 
-	idx := slices.IndexFunc(h.server.Owners.Instances, func(owner client.Owner) bool {
+	idx := slices.IndexFunc(h.server.Owners.Instances, func(owner *client.Owner) bool {
 		return owner.Id == workspaceID
 	})
 	require.NotEqual(h.t, -1, idx, "test setup: owner %q must be registered before use", workspaceID)
@@ -113,21 +113,21 @@ func (h testHarness) requireOwner(workspaceID string) {
 func (h testHarness) requireEnvironment(environmentID string) client.Environment {
 	h.t.Helper()
 
-	idx := slices.IndexFunc(h.server.Environments.Instances, func(env client.Environment) bool {
+	idx := slices.IndexFunc(h.server.Environments.Instances, func(env *client.Environment) bool {
 		return env.Id == environmentID
 	})
 	require.NotEqual(h.t, -1, idx, "test setup: environment %q must be registered before use", environmentID)
-	return h.server.Environments.Instances[idx]
+	return *h.server.Environments.Instances[idx]
 }
 
 func (h testHarness) requireProject(projectID string) client.Project {
 	h.t.Helper()
 
-	idx := slices.IndexFunc(h.server.Projects.Instances, func(project client.Project) bool {
+	idx := slices.IndexFunc(h.server.Projects.Instances, func(project *client.Project) bool {
 		return project.Id == projectID
 	})
 	require.NotEqual(h.t, -1, idx, "test setup: project %q must be registered before use", projectID)
-	return h.server.Projects.Instances[idx]
+	return *h.server.Projects.Instances[idx]
 }
 
 func TestServiceCreate_UsesResolvedWorkspaceAndDefaults(t *testing.T) {