chore: unit tests for pg config

internal/postgresConfig/delete/delete.go

@@ -35,14 +35,15 @@ func Run(ctx context.Context, projectRef string, configKeys []string, noRestart
 
 	resp, err := utils.GetSupabase().V1UpdatePostgresConfigWithBodyWithResponse(ctx, projectRef, "application/json", bytes.NewReader(bts))
 	if err != nil {
-		return errors.Errorf("failed to update config overrides: %w", err)
-	}
-	if resp.JSON200 == nil {
-		if resp.StatusCode() == 400 {
-			return errors.Errorf("failed to update config overrides: %s (%s). This usually indicates that an unsupported or invalid config override was attempted. Please refer to https://supabase.com/docs/guides/platform/custom-postgres-config", resp.Status(), string(resp.Body))
-		}
-		return errors.Errorf("failed to update config overrides: %s (%s)", resp.Status(), string(resp.Body))
+		return errors.Errorf("failed to delete config overrides: %w", err)
+	} else if resp.JSON200 == nil {
+		return errors.Errorf("unexpected delete config overrides status %d: %s", resp.StatusCode(), string(resp.Body))
 	}
 
-	return get.Run(ctx, projectRef, fsys)
+	var config map[string]any
+	err = json.Unmarshal(resp.Body, &config)
+	if err != nil {
+		return errors.Errorf("failed to unmarshal delete response: %w", err)
+	}
+	return get.PrintOutPostgresConfigOverrides(config)
 }

internal/postgresConfig/delete/delete_test.go

@@ -0,0 +1,94 @@
+package delete
+
+import (
+	"context"
+	"net/http"
+	"testing"
+
+	"github.com/go-errors/errors"
+	"github.com/h2non/gock"
+	"github.com/stretchr/testify/assert"
+	"github.com/supabase/cli/internal/testing/apitest"
+	"github.com/supabase/cli/internal/testing/fstest"
+	"github.com/supabase/cli/internal/utils"
+	"github.com/supabase/cli/internal/utils/flags"
+	"github.com/supabase/cli/pkg/api"
+	"github.com/supabase/cli/pkg/cast"
+)
+
+func TestDeleteConfig(t *testing.T) {
+	flags.ProjectRef = apitest.RandomProjectRef()
+
+	t.Run("deletes postgres config", func(t *testing.T) {
+		t.Cleanup(fstest.MockStdout(t, `
+
+   Parameter | Value 
+  -----------|-------
+
+`))
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		gock.New(utils.DefaultApiHost).
+			Put("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{})
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{"max_connections"}, true, nil)
+		assert.NoError(t, err)
+	})
+
+	t.Run("throws error on missing project", func(t *testing.T) {
+		errNetwork := errors.New("network error")
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			ReplyError(errNetwork)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, false, nil)
+		assert.ErrorIs(t, err, errNetwork)
+	})
+
+	t.Run("throws error on network error", func(t *testing.T) {
+		errNetwork := errors.New("network error")
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		gock.New(utils.DefaultApiHost).
+			Put("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			ReplyError(errNetwork)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, false, nil)
+		assert.ErrorIs(t, err, errNetwork)
+	})
+
+	t.Run("throws error on service unavailable", func(t *testing.T) {
+		utils.OutputFormat.Value = utils.OutputEnv
+		t.Cleanup(func() { utils.OutputFormat.Value = utils.OutputPretty })
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		gock.New(utils.DefaultApiHost).
+			Put("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusServiceUnavailable)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, false, nil)
+		assert.ErrorContains(t, err, "unexpected delete config overrides status 503:")
+	})
+}

internal/postgresConfig/get/get.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"io"
 	"os"
 	"strings"
 
@@ -14,23 +13,18 @@ import (
 )
 
 func Run(ctx context.Context, projectRef string, fsys afero.Fs) error {
-	// 1. get current config
 	config, err := GetCurrentPostgresConfig(ctx, projectRef)
 	if err != nil {
 		return err
 	}
-	err = PrintOutPostgresConfigOverrides(config)
-	if err != nil {
-		return err
-	}
-	return nil
+	return PrintOutPostgresConfigOverrides(config)
 }
 
 func PrintOutPostgresConfigOverrides(config map[string]any) error {
 	if utils.OutputFormat.Value != utils.OutputPretty {
 		return utils.EncodeOutput(utils.OutputFormat.Value, os.Stdout, config)
 	}
-	fmt.Println("- Custom Postgres Config -")
+	fmt.Fprintln(os.Stderr, "- Custom Postgres Config -")
 	markdownTable := []string{
 		"|Parameter|Value|\n|-|-|\n",
 	}
@@ -43,26 +37,21 @@ func PrintOutPostgresConfigOverrides(config map[string]any) error {
 	if err := utils.RenderTable(strings.Join(markdownTable, "")); err != nil {
 		return err
 	}
-	fmt.Println("- End of Custom Postgres Config -")
+	fmt.Fprintln(os.Stderr, "- End of Custom Postgres Config -")
 	return nil
 }
 
 func GetCurrentPostgresConfig(ctx context.Context, projectRef string) (map[string]any, error) {
-	resp, err := utils.GetSupabase().V1GetPostgresConfig(ctx, projectRef)
+	resp, err := utils.GetSupabase().V1GetPostgresConfigWithResponse(ctx, projectRef)
 	if err != nil {
 		return nil, errors.Errorf("failed to retrieve Postgres config overrides: %w", err)
-	}
-	if resp.StatusCode != 200 {
-		return nil, errors.Errorf("error in retrieving Postgres config overrides: %s", resp.Status)
-	}
-	contents, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, errors.Errorf("failed to read response body: %w", err)
+	} else if resp.JSON200 == nil {
+		return nil, errors.Errorf("unexpected config overrides status %d: %s", resp.StatusCode(), string(resp.Body))
 	}
 	var config map[string]any
-	err = json.Unmarshal(contents, &config)
+	err = json.Unmarshal(resp.Body, &config)
 	if err != nil {
-		return nil, errors.Errorf("failed to unmarshal response body: %w. Contents were %s", err, contents)
+		return nil, errors.Errorf("failed to unmarshal response body: %w", err)
 	}
 	return config, nil
 }

internal/postgresConfig/get/get_test.go

@@ -0,0 +1,85 @@
+package get
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"testing"
+
+	"github.com/h2non/gock"
+	"github.com/stretchr/testify/assert"
+	"github.com/supabase/cli/internal/testing/apitest"
+	"github.com/supabase/cli/internal/testing/fstest"
+	"github.com/supabase/cli/internal/utils"
+	"github.com/supabase/cli/internal/utils/flags"
+	"github.com/supabase/cli/pkg/api"
+	"github.com/supabase/cli/pkg/cast"
+)
+
+func TestPostgresConfig(t *testing.T) {
+	flags.ProjectRef = apitest.RandomProjectRef()
+
+	t.Run("get postgres config", func(t *testing.T) {
+		t.Cleanup(fstest.MockStdout(t, `
+
+   Parameter       | Value 
+  -----------------|-------
+   max_connections | 100   
+
+`))
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, nil)
+		assert.NoError(t, err)
+	})
+
+	t.Run("encodes toml output", func(t *testing.T) {
+		utils.OutputFormat.Value = utils.OutputToml
+		t.Cleanup(func() { utils.OutputFormat.Value = utils.OutputPretty })
+		t.Cleanup(fstest.MockStdout(t, `max_connections = 100.0
+`))
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, nil)
+		assert.NoError(t, err)
+	})
+
+	t.Run("throws error on network error", func(t *testing.T) {
+		errNetwork := errors.New("network error")
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			ReplyError(errNetwork)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, nil)
+		assert.ErrorIs(t, err, errNetwork)
+	})
+
+	t.Run("throws error on service unavailable", func(t *testing.T) {
+		utils.OutputFormat.Value = utils.OutputEnv
+		t.Cleanup(func() { utils.OutputFormat.Value = utils.OutputPretty })
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusServiceUnavailable)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, nil)
+		assert.ErrorContains(t, err, "unexpected config overrides status 503:")
+	})
+}

internal/postgresConfig/update/update.go

@@ -67,13 +67,14 @@ func Run(ctx context.Context, projectRef string, values []string, replaceOverrid
 		resp, err := utils.GetSupabase().V1UpdatePostgresConfigWithBodyWithResponse(ctx, projectRef, "application/json", bytes.NewReader(bts))
 		if err != nil {
 			return errors.Errorf("failed to update config overrides: %w", err)
+		} else if resp.JSON200 == nil {
+			return errors.Errorf("unexpected update config overrides status %d: %s", resp.StatusCode(), string(resp.Body))
 		}
-		if resp.JSON200 == nil {
-			if resp.StatusCode() == 400 {
-				return errors.Errorf("failed to update config overrides: %s (%s). This usually indicates that an unsupported or invalid config override was attempted. Please refer to https://supabase.com/docs/guides/platform/custom-postgres-config", resp.Status(), string(resp.Body))
-			}
-			return errors.Errorf("failed to update config overrides: %s (%s)", resp.Status(), string(resp.Body))
+		var config map[string]any
+		err = json.Unmarshal(resp.Body, &config)
+		if err != nil {
+			return errors.Errorf("failed to unmarshal update response: %w", err)
 		}
+		return get.PrintOutPostgresConfigOverrides(config)
 	}
-	return get.Run(ctx, projectRef, fsys)
 }

internal/postgresConfig/update/update_test.go

@@ -0,0 +1,95 @@
+package update
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"testing"
+
+	"github.com/h2non/gock"
+	"github.com/stretchr/testify/assert"
+	"github.com/supabase/cli/internal/testing/apitest"
+	"github.com/supabase/cli/internal/testing/fstest"
+	"github.com/supabase/cli/internal/utils"
+	"github.com/supabase/cli/internal/utils/flags"
+	"github.com/supabase/cli/pkg/api"
+	"github.com/supabase/cli/pkg/cast"
+)
+
+func TestUpdatePostgresConfig(t *testing.T) {
+	flags.ProjectRef = apitest.RandomProjectRef()
+
+	t.Run("updates postgres config", func(t *testing.T) {
+		t.Cleanup(fstest.MockStdout(t, `
+
+   Parameter       | Value 
+  -----------------|-------
+   max_connections | 100   
+
+`))
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Put("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{
+			"max_connections=100",
+			"track_commit_timestamp=true",
+			"statement_timeout=600",
+			"wal_keep_size=1GB",
+		}, true, true, nil)
+		assert.NoError(t, err)
+	})
+
+	t.Run("throws error on missing key", func(t *testing.T) {
+		err := Run(context.Background(), flags.ProjectRef, []string{"value"}, true, true, nil)
+		assert.ErrorContains(t, err, "expected config value in key:value format")
+	})
+
+	t.Run("throws error on missing project", func(t *testing.T) {
+		errNetwork := errors.New("network error")
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			ReplyError(errNetwork)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, false, false, nil)
+		assert.ErrorIs(t, err, errNetwork)
+	})
+
+	t.Run("throws error on network error", func(t *testing.T) {
+		errNetwork := errors.New("network error")
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Get("v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusOK).
+			JSON(api.PostgresConfigResponse{
+				MaxConnections: cast.Ptr(100),
+			})
+		gock.New(utils.DefaultApiHost).
+			Put("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			ReplyError(errNetwork)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, false, false, nil)
+		assert.ErrorIs(t, err, errNetwork)
+	})
+
+	t.Run("throws error on service unavailable", func(t *testing.T) {
+		utils.OutputFormat.Value = utils.OutputEnv
+		t.Cleanup(func() { utils.OutputFormat.Value = utils.OutputPretty })
+		t.Cleanup(apitest.MockPlatformAPI(t))
+		// Setup mock api
+		gock.New(utils.DefaultApiHost).
+			Put("/v1/projects/" + flags.ProjectRef + "/config/database/postgres").
+			Reply(http.StatusServiceUnavailable)
+		// Run test
+		err := Run(context.Background(), flags.ProjectRef, []string{}, true, true, nil)
+		assert.ErrorContains(t, err, "unexpected update config overrides status 503:")
+	})
+}