Skip to content

Support Postgres branches in BranchInfrastructure #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickvanw merged 1 commit into from
Jul 8, 2026
Merged

Support Postgres branches in BranchInfrastructure #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 87 additions & 4 deletions planetscale/branch_infrastructure.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,56 @@ package planetscale

import (
"context"
"encoding/json"
"fmt"
"net/http"
"path"
"time"
)

// BranchInfrastructure represents the infrastructure (pods) for a branch.
// BranchInfrastructure represents the infrastructure for a branch. Exactly one
// of Vitess or Postgres is set, depending on the branch's database engine.
type BranchInfrastructure struct {
Type string `json:"type"`
Ready bool `json:"ready"`
Pods []*BranchInfraPod `json:"pods"`
Type string
Vitess *VitessBranchInfrastructure
Postgres *PostgresBranchInfrastructure
}

func (b *BranchInfrastructure) UnmarshalJSON(data []byte) error {
var discriminator struct {
Type string `json:"type"`
}
if err := json.Unmarshal(data, &discriminator); err != nil {
return err
}
b.Type = discriminator.Type

switch b.Type {
case "PostgresInfrastructure":
b.Postgres = &PostgresBranchInfrastructure{}
return json.Unmarshal(data, b.Postgres)
default:
b.Vitess = &VitessBranchInfrastructure{}
return json.Unmarshal(data, b.Vitess)
}
}

// VitessBranchInfrastructure represents the infrastructure (pods) for a Vitess
// branch.
type VitessBranchInfrastructure struct {
Ready bool `json:"ready"`
Pods []*BranchInfraPod `json:"pods"`
}

// PostgresBranchInfrastructure represents the infrastructure (nodes and
// bouncers) for a Postgres branch.
type PostgresBranchInfrastructure struct {
State string `json:"state"`
PrimaryName string `json:"primary_name"`
PrimaryPromotedAt *time.Time `json:"primary_promoted_at"`
VolumeModificationsBlockedUntil *time.Time `json:"volume_modifications_blocked_until"`
Nodes []*PostgresInfraNode `json:"nodes"`
Bouncers []*PostgresInfraBouncer `json:"bouncers"`
}

// BranchInfraPod represents a single pod in the branch infrastructure.
Expand All @@ -30,6 +69,50 @@ type BranchInfraPod struct {
TabletType *string `json:"tablet_type"`
}

// PostgresInfraNode represents a single Postgres instance in the branch
// infrastructure.
type PostgresInfraNode struct {
Name string `json:"name"`
NormalizedName string `json:"normalized_name"`
Role string `json:"role"`
AvailabilityZone string `json:"availability_zone"`
ClusterName string `json:"cluster_name"`
ClusterDisplayName string `json:"cluster_display_name"`
PeersCount int `json:"peers_count"`
VolumeUsageBytes *int64 `json:"volume_usage_bytes"`
VolumeCapacityBytes *int64 `json:"volume_capacity_bytes"`
VolumeShrinkThresholdPercent *float64 `json:"volume_shrink_threshold_percent"`
Region Region `json:"region"`
DiskReplacement *PostgresInfraDiskReplacement `json:"disk_replacement"`
}

// PostgresInfraDiskReplacement represents a scheduled disk replacement for a
// Postgres node.
type PostgresInfraDiskReplacement struct {
Reason string `json:"reason"`
Bytes int64 `json:"bytes"`
ScheduledAt *time.Time `json:"scheduled_at"`
}

// PostgresInfraBouncer represents a PgBouncer deployment in the branch
// infrastructure.
type PostgresInfraBouncer struct {
ID string `json:"id"`
Name string `json:"name"`
Target string `json:"target"`
ReplicasPerCell int `json:"replicas_per_cell"`
Region Region `json:"region"`
SKU *PostgresInfraBouncerSKU `json:"sku"`
}

// PostgresInfraBouncerSKU represents the size of a PgBouncer deployment.
type PostgresInfraBouncerSKU struct {
Name string `json:"name"`
DisplayName string `json:"display_name"`
CPU string `json:"cpu"`
RAM int64 `json:"ram"`
}

// GetBranchInfrastructureRequest encapsulates the request for getting branch infrastructure.
type GetBranchInfrastructureRequest struct {
Organization string
Expand Down
192 changes: 171 additions & 21 deletions planetscale/branch_infrastructure_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,25 +72,175 @@ func TestBranchInfrastructure_Get(t *testing.T) {

c.Assert(err, qt.IsNil)
c.Assert(infra.Type, qt.Equals, "PS-10")
c.Assert(infra.Ready, qt.IsTrue)
c.Assert(len(infra.Pods), qt.Equals, 2)

c.Assert(infra.Pods[0].Name, qt.Equals, "vttablet-abc123")
c.Assert(infra.Pods[0].Status, qt.Equals, "Running")
c.Assert(infra.Pods[0].Component, qt.Equals, "vttablet")
c.Assert(infra.Pods[0].Ready, qt.Equals, "1/1")
c.Assert(infra.Pods[0].RestartCount, qt.Equals, 0)
c.Assert(infra.Pods[0].CreatedAt, qt.DeepEquals, &createdAt)
c.Assert(infra.Pods[0].Cell, qt.Equals, "us-east-1")
c.Assert(infra.Pods[0].Size, qt.Equals, "PS-10")
c.Assert(infra.Pods[0].Keyspace, qt.DeepEquals, &keyspace)
c.Assert(infra.Pods[0].Shard, qt.DeepEquals, &shard)
c.Assert(infra.Pods[0].TabletType, qt.DeepEquals, &tabletType)

c.Assert(infra.Pods[1].Name, qt.Equals, "vtgate-def456")
c.Assert(infra.Pods[1].Component, qt.Equals, "vtgate")
c.Assert(infra.Pods[1].RestartCount, qt.Equals, 2)
c.Assert(infra.Pods[1].Keyspace, qt.IsNil)
c.Assert(infra.Pods[1].Shard, qt.IsNil)
c.Assert(infra.Pods[1].TabletType, qt.IsNil)
c.Assert(infra.Postgres, qt.IsNil)
c.Assert(infra.Vitess, qt.IsNotNil)
c.Assert(infra.Vitess.Ready, qt.IsTrue)
c.Assert(len(infra.Vitess.Pods), qt.Equals, 2)

pods := infra.Vitess.Pods
c.Assert(pods[0].Name, qt.Equals, "vttablet-abc123")
c.Assert(pods[0].Status, qt.Equals, "Running")
c.Assert(pods[0].Component, qt.Equals, "vttablet")
c.Assert(pods[0].Ready, qt.Equals, "1/1")
c.Assert(pods[0].RestartCount, qt.Equals, 0)
c.Assert(pods[0].CreatedAt, qt.DeepEquals, &createdAt)
c.Assert(pods[0].Cell, qt.Equals, "us-east-1")
c.Assert(pods[0].Size, qt.Equals, "PS-10")
c.Assert(pods[0].Keyspace, qt.DeepEquals, &keyspace)
c.Assert(pods[0].Shard, qt.DeepEquals, &shard)
c.Assert(pods[0].TabletType, qt.DeepEquals, &tabletType)

c.Assert(pods[1].Name, qt.Equals, "vtgate-def456")
c.Assert(pods[1].Component, qt.Equals, "vtgate")
c.Assert(pods[1].RestartCount, qt.Equals, 2)
c.Assert(pods[1].Keyspace, qt.IsNil)
c.Assert(pods[1].Shard, qt.IsNil)
c.Assert(pods[1].TabletType, qt.IsNil)
}

func TestBranchInfrastructure_GetPostgres(t *testing.T) {
c := qt.New(t)

ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(200)
c.Assert(r.Method, qt.Equals, http.MethodGet)
c.Assert(r.URL.String(), qt.Equals, "/v1/organizations/my-org/databases/planetscale-go-test-db/branches/planetscale-go-test-db-branch/infrastructure")

out := `{
"type": "PostgresInfrastructure",
"state": "ready",
"primary_name": "hzi-abc123-aws-useast2a-1-1735266582-9c83d493",
"primary_promoted_at": "2025-12-09T13:15:00.000Z",
"volume_modifications_blocked_until": null,
"nodes": [
{
"type": "PostgresNode",
"cluster_display_name": "PS-40",
"cluster_name": "PS_40",
"availability_zone": "Availability zone A",
"normalized_name": "aws-useast2a-1",
"name": "hzi-abc123-aws-useast2a-1-1735266582-9c83d493",
"peers_count": 0,
"role": "primary",
"volume_usage_bytes": 325369856,
"volume_capacity_bytes": 10737418240,
"volume_shrink_threshold_percent": 12.5,
"region": {
"slug": "us-east-2",
"provider": "AWS",
"display_name": "AWS us-east-2",
"enabled": true
},
"disk_replacement": {
"type": "PostgresNodeDiskReplacement",
"reason": "ShrinkSuggested",
"bytes": 21474836480,
"scheduled_at": "2025-12-09T14:00:00.000Z"
}
},
{
"type": "PostgresNode",
"cluster_display_name": "PS-40",
"cluster_name": "PS_40",
"availability_zone": "Availability zone C",
"normalized_name": "aws-useast2c-1",
"name": "hzi-abc123-aws-useast2c-1-3012702306-89b0e759",
"peers_count": 0,
"role": "replica",
"volume_usage_bytes": 341385216,
"volume_capacity_bytes": 10737418240,
"volume_shrink_threshold_percent": null,
"region": {
"slug": "us-east-2",
"provider": "AWS",
"display_name": "AWS us-east-2",
"enabled": true
},
"disk_replacement": null
}
],
"bouncers": [
{
"type": "PostgresBouncerNode",
"id": "bouncer123",
"name": "primary-bouncer",
"target": "primary",
"replicas_per_cell": 1,
"region": {
"slug": "us-east-2",
"provider": "AWS",
"display_name": "AWS us-east-2",
"enabled": true
},
"sku": {
"name": "HZB_C1_AMD64_PICO",
"display_name": "Pico",
"cpu": "0.25",
"ram": 268435456
}
}
]
}`
_, err := w.Write([]byte(out))
c.Assert(err, qt.IsNil)
}))

client, err := NewClient(WithBaseURL(ts.URL))
c.Assert(err, qt.IsNil)

ctx := context.Background()

infra, err := client.BranchInfrastructure.Get(ctx, &GetBranchInfrastructureRequest{
Organization: testOrg,
Database: testDatabase,
Branch: testBranch,
})

c.Assert(err, qt.IsNil)
c.Assert(infra.Type, qt.Equals, "PostgresInfrastructure")
c.Assert(infra.Vitess, qt.IsNil)
c.Assert(infra.Postgres, qt.IsNotNil)

pg := infra.Postgres
c.Assert(pg.State, qt.Equals, "ready")
c.Assert(pg.PrimaryName, qt.Equals, "hzi-abc123-aws-useast2a-1-1735266582-9c83d493")
c.Assert(pg.PrimaryPromotedAt, qt.DeepEquals, ptrTime(time.Date(2025, 12, 9, 13, 15, 0, 0, time.UTC)))
c.Assert(pg.VolumeModificationsBlockedUntil, qt.IsNil)
c.Assert(len(pg.Nodes), qt.Equals, 2)
c.Assert(len(pg.Bouncers), qt.Equals, 1)

primary := pg.Nodes[0]
c.Assert(primary.Name, qt.Equals, "hzi-abc123-aws-useast2a-1-1735266582-9c83d493")
c.Assert(primary.NormalizedName, qt.Equals, "aws-useast2a-1")
c.Assert(primary.Role, qt.Equals, "primary")
c.Assert(primary.AvailabilityZone, qt.Equals, "Availability zone A")
c.Assert(primary.ClusterName, qt.Equals, "PS_40")
c.Assert(primary.ClusterDisplayName, qt.Equals, "PS-40")
c.Assert(*primary.VolumeUsageBytes, qt.Equals, int64(325369856))
c.Assert(*primary.VolumeCapacityBytes, qt.Equals, int64(10737418240))
c.Assert(*primary.VolumeShrinkThresholdPercent, qt.Equals, 12.5)
c.Assert(primary.Region.Slug, qt.Equals, "us-east-2")
c.Assert(primary.DiskReplacement.Reason, qt.Equals, "ShrinkSuggested")
c.Assert(primary.DiskReplacement.Bytes, qt.Equals, int64(21474836480))
c.Assert(primary.DiskReplacement.ScheduledAt, qt.DeepEquals, ptrTime(time.Date(2025, 12, 9, 14, 0, 0, 0, time.UTC)))

replica := pg.Nodes[1]
c.Assert(replica.Role, qt.Equals, "replica")
c.Assert(replica.VolumeShrinkThresholdPercent, qt.IsNil)
c.Assert(replica.DiskReplacement, qt.IsNil)

bouncer := pg.Bouncers[0]
c.Assert(bouncer.ID, qt.Equals, "bouncer123")
c.Assert(bouncer.Name, qt.Equals, "primary-bouncer")
c.Assert(bouncer.Target, qt.Equals, "primary")
c.Assert(bouncer.ReplicasPerCell, qt.Equals, 1)
c.Assert(bouncer.Region.Slug, qt.Equals, "us-east-2")
c.Assert(bouncer.SKU.Name, qt.Equals, "HZB_C1_AMD64_PICO")
c.Assert(bouncer.SKU.DisplayName, qt.Equals, "Pico")
c.Assert(bouncer.SKU.CPU, qt.Equals, "0.25")
c.Assert(bouncer.SKU.RAM, qt.Equals, int64(268435456))
}

func ptrTime(t time.Time) *time.Time {
return &t
}
Loading