Merge pull request #272 from planetscale/allow-replicas-to-be-set-to-zero

Change Replicas type from int to *int in CreateDatabaseRequest

Author: no-itsbackpack

planetscale/databases.go

@@ -23,7 +23,7 @@ type CreateDatabaseRequest struct {
 	Region       string         `json:"region,omitempty"`
 	ClusterSize  string         `json:"cluster_size,omitempty"`
 	Kind         DatabaseEngine `json:"kind,omitempty"`
-	Replicas     int            `json:"replicas,omitempty"`
+	Replicas     *int           `json:"replicas,omitempty"`
 }
 
 // DatabaseRequest encapsulates the request for getting a single database.

planetscale/databases_test.go

@@ -127,13 +127,66 @@ func TestDatabases_CreateWithReplicas(t *testing.T) {
 	org := "my-org"
 	name := "planetscale-go-test-db"
 	notes := "This is a test DB created from the planetscale-go API library"
+	replicas := 3
 
 	db, err := client.Databases.Create(ctx, &CreateDatabaseRequest{
 		Organization: org,
 		Region:       "us-west",
 		Name:         name,
 		Notes:        notes,
-		Replicas:     3,
+		Replicas:     &replicas,
+	})
+
+	want := &Database{
+		Name:  name,
+		Notes: notes,
+		State: DatabaseReady,
+		Region: Region{
+			Slug: "us-west",
+			Name: "US West",
+		},
+		CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
+		UpdatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC),
+	}
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(db, qt.DeepEquals, want)
+}
+
+func TestDatabases_CreateWithReplicasZero(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+		var body map[string]any
+		err := json.NewDecoder(r.Body).Decode(&body)
+		c.Assert(err, qt.IsNil)
+
+		// With omitempty and *int type, replicas field SHOULD be present when explicitly set to 0
+		replicas, hasReplicas := body["replicas"]
+		c.Assert(hasReplicas, qt.IsTrue, qt.Commentf("replicas field should be present when explicitly set to 0"))
+		c.Assert(replicas, qt.Equals, float64(0))
+
+		out := `{"id":"planetscale-go-test-db","type":"database","name":"planetscale-go-test-db","notes":"This is a test DB created from the planetscale-go API library","created_at":"2021-01-14T10:19:23.000Z","updated_at":"2021-01-14T10:19:23.000Z", "region": { "slug": "us-west", "display_name": "US West" },"state":"ready"}`
+		_, err = w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+	org := "my-org"
+	name := "planetscale-go-test-db"
+	notes := "This is a test DB created from the planetscale-go API library"
+	replicas := 0
+
+	db, err := client.Databases.Create(ctx, &CreateDatabaseRequest{
+		Organization: org,
+		Region:       "us-west",
+		Name:         name,
+		Notes:        notes,
+		Replicas:     &replicas,
 	})
 
 	want := &Database{