14083564902

Committed 26 Mar 2025 12:43PM UTC coverage: 51.052% (-0.008%) from 51.06%

Build # 14083564902

Build Type

push

github

Committed by

web-flow

Commit Message

fix: account for declared schemas in config file (#3355)

Run Details

2 of 18 new or added lines in 1 file covered. (11.11%)

3 existing lines in 2 files now uncovered.

6961 of 13635 relevant lines covered (51.05%)

186.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.19

/internal/db/diff/diff.go

package diff

import (
        "context"
        _ "embed"
        "fmt"
        "io"
        "io/fs"
        "os"
        "path/filepath"
        "regexp"
        "strconv"
        "strings"
        "time"

        "github.com/cenkalti/backoff/v4"
        "github.com/docker/docker/api/types/container"
        "github.com/docker/docker/api/types/network"
        "github.com/docker/go-connections/nat"
        "github.com/go-errors/errors"
        "github.com/jackc/pgconn"
        "github.com/jackc/pgx/v4"
        "github.com/spf13/afero"
        "github.com/supabase/cli/internal/db/start"
        "github.com/supabase/cli/internal/gen/keys"
        "github.com/supabase/cli/internal/utils"
        "github.com/supabase/cli/pkg/migration"
        "github.com/supabase/cli/pkg/parser"
)

type DiffFunc func(context.Context, string, string, []string) (string, error)

func Run(ctx context.Context, schema []string, file string, config pgconn.Config, differ DiffFunc, fsys afero.Fs, options ...func(*pgx.ConnConfig)) (err error) {
        // Sanity checks.
        if utils.IsLocalDatabase(config) {
                if declared, err := loadDeclaredSchemas(fsys); err != nil {
                        return err
                } else if container, err := createShadowIfNotExists(ctx, declared); err != nil {
                        return err
                } else if len(container) > 0 {
                        defer utils.DockerRemove(container)
                        if err := start.WaitForHealthyService(ctx, start.HealthTimeout, container); err != nil {
                                return err
                        }
                        if err := migrateBaseDatabase(ctx, container, declared, fsys, options...); err != nil {
                                return err
                        }
                }
        }
        // 1. Load all user defined schemas
        if len(schema) == 0 {
                schema, err = loadSchema(ctx, config, options...)
                if err != nil {
                        return err
                }
        }
        // 3. Run migra to diff schema
        out, err := DiffDatabase(ctx, schema, config, os.Stderr, fsys, differ, options...)
        if err != nil {
                return err
        }
        branch := keys.GetGitBranch(fsys)
        fmt.Fprintln(os.Stderr, "Finished "+utils.Aqua("supabase db diff")+" on branch "+utils.Aqua(branch)+".\n")
        if err := SaveDiff(out, file, fsys); err != nil {
                return err
        }
        drops := findDropStatements(out)
        if len(drops) > 0 {
                fmt.Fprintln(os.Stderr, "Found drop statements in schema diff. Please double check if these are expected:")
                fmt.Fprintln(os.Stderr, utils.Yellow(strings.Join(drops, "\n")))
        }
        return nil
}

func createShadowIfNotExists(ctx context.Context, migrations []string) (string, error) {
        if len(migrations) == 0 {
                return "", nil
        }
        if err := utils.AssertSupabaseDbIsRunning(); !errors.Is(err, utils.ErrNotRunning) {
                return "", err
        }
        fmt.Fprintln(os.Stderr, "Creating local database from declarative schemas:")
        msg := make([]string, len(migrations))
        for i, m := range migrations {
                msg[i] = fmt.Sprintf(" • %s", utils.Bold(m))
        }
        fmt.Fprintln(os.Stderr, strings.Join(msg, "\n"))
        return CreateShadowDatabase(ctx, utils.Config.Db.Port)
}

func loadDeclaredSchemas(fsys afero.Fs) ([]string, error) {
        if schemas := utils.Config.Db.Migrations.SchemaPaths; len(schemas) > 0 {
                return schemas.Files(afero.NewIOFS(fsys))
        }
        if exists, err := afero.DirExists(fsys, utils.SchemasDir); err != nil {
                return nil, errors.Errorf("failed to check schemas: %w", err)
        } else if !exists {
                return nil, nil
        }
        var declared []string
        if err := afero.Walk(fsys, utils.SchemasDir, func(path string, info fs.FileInfo, err error) error {
                if err != nil {
                        return err
                }
                if info.Mode().IsRegular() && filepath.Ext(info.Name()) == ".sql" {
                        declared = append(declared, path)
                }
                return nil
        }); err != nil {
                return nil, errors.Errorf("failed to walk dir: %w", err)
        }
        return declared, nil
}

// https://github.com/djrobstep/migra/blob/master/migra/statements.py#L6
var dropStatementPattern = regexp.MustCompile(`(?i)drop\s+`)

func findDropStatements(out string) []string {
        lines, err := parser.SplitAndTrim(strings.NewReader(out))
        if err != nil {
                return nil
        }
        var drops []string
        for _, line := range lines {
                if dropStatementPattern.MatchString(line) {
                        drops = append(drops, line)
                }
        }
        return drops
}

func loadSchema(ctx context.Context, config pgconn.Config, options ...func(*pgx.ConnConfig)) ([]string, error) {
        conn, err := utils.ConnectByConfig(ctx, config, options...)
        if err != nil {
                return nil, err
        }
        defer conn.Close(context.Background())
        // RLS policies in auth and storage schemas can be included with -s flag
        return migration.ListUserSchemas(ctx, conn)
}

func CreateShadowDatabase(ctx context.Context, port uint16) (string, error) {
        config := start.NewContainerConfig()
        hostPort := strconv.FormatUint(uint64(port), 10)
        hostConfig := container.HostConfig{
                PortBindings: nat.PortMap{"5432/tcp": []nat.PortBinding{{HostPort: hostPort}}},
                AutoRemove:   true,
        }
        networkingConfig := network.NetworkingConfig{}
        if utils.Config.Db.MajorVersion <= 14 {
                config.Entrypoint = nil
                hostConfig.Tmpfs = map[string]string{"/docker-entrypoint-initdb.d": ""}
        }
        return utils.DockerStart(ctx, config, hostConfig, networkingConfig, "")
}

func ConnectShadowDatabase(ctx context.Context, timeout time.Duration, options ...func(*pgx.ConnConfig)) (conn *pgx.Conn, err error) {
        // Retry until connected, cancelled, or timeout
        policy := start.NewBackoffPolicy(ctx, timeout)
        config := pgconn.Config{Port: utils.Config.Db.ShadowPort}
        connect := func() (*pgx.Conn, error) {
                return utils.ConnectLocalPostgres(ctx, config, options...)
        }
        return backoff.RetryWithData(connect, policy)
}

func MigrateShadowDatabase(ctx context.Context, container string, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
        migrations, err := migration.ListLocalMigrations(utils.MigrationsDir, afero.NewIOFS(fsys))
        if err != nil {
                return err
        }
        conn, err := ConnectShadowDatabase(ctx, 10*time.Second, options...)
        if err != nil {
                return err
        }
        defer conn.Close(context.Background())
        if err := start.SetupDatabase(ctx, conn, container[:12], os.Stderr, fsys); err != nil {
                return err
        }
        return migration.ApplyMigrations(ctx, migrations, conn, afero.NewIOFS(fsys))
}

func migrateBaseDatabase(ctx context.Context, container string, migrations []string, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
        conn, err := utils.ConnectLocalPostgres(ctx, pgconn.Config{}, options...)
        if err != nil {
                return err
        }
        defer conn.Close(context.Background())
        if err := start.SetupDatabase(ctx, conn, container[:12], os.Stderr, fsys); err != nil {
                return err
        }
        return migration.SeedGlobals(ctx, migrations, conn, afero.NewIOFS(fsys))
}

func DiffDatabase(ctx context.Context, schema []string, config pgconn.Config, w io.Writer, fsys afero.Fs, differ func(context.Context, string, string, []string) (string, error), options ...func(*pgx.ConnConfig)) (string, error) {
        fmt.Fprintln(w, "Creating shadow database...")
        shadow, err := CreateShadowDatabase(ctx, utils.Config.Db.ShadowPort)
        if err != nil {
                return "", err
        }
        defer utils.DockerRemove(shadow)
        if err := start.WaitForHealthyService(ctx, start.HealthTimeout, shadow); err != nil {
                return "", err
        }
        if err := MigrateShadowDatabase(ctx, shadow, fsys, options...); err != nil {
                return "", err
        }
        fmt.Fprintln(w, "Diffing schemas:", strings.Join(schema, ","))
        source := utils.ToPostgresURL(pgconn.Config{
                Host:     utils.Config.Hostname,
                Port:     utils.Config.Db.ShadowPort,
                User:     "postgres",
                Password: utils.Config.Db.Password,
                Database: "postgres",
        })
        target := utils.ToPostgresURL(config)
        return differ(ctx, source, target, schema)
}

1	package diff
2
3	import (
4	"context"
5	_ "embed"
6	"fmt"
7	"io"
8	"io/fs"
9	"os"
10	"path/filepath"
11	"regexp"
12	"strconv"
13	"strings"
14	"time"
15
16	"github.com/cenkalti/backoff/v4"
17	"github.com/docker/docker/api/types/container"
18	"github.com/docker/docker/api/types/network"
19	"github.com/docker/go-connections/nat"
20	"github.com/go-errors/errors"
21	"github.com/jackc/pgconn"
22	"github.com/jackc/pgx/v4"
23	"github.com/spf13/afero"
24	"github.com/supabase/cli/internal/db/start"
25	"github.com/supabase/cli/internal/gen/keys"
26	"github.com/supabase/cli/internal/utils"
27	"github.com/supabase/cli/pkg/migration"
28	"github.com/supabase/cli/pkg/parser"
29	)
30
31	type DiffFunc func(context.Context, string, string, []string) (string, error)
32
33	func Run(ctx context.Context, schema []string, file string, config pgconn.Config, differ DiffFunc, fsys afero.Fs, options ...func(*pgx.ConnConfig)) (err error) {	3✔
34	// Sanity checks.	3✔
35	if utils.IsLocalDatabase(config) {	3✔
NEW 36	if declared, err := loadDeclaredSchemas(fsys); err != nil {	×
NEW 37	return err	×
NEW 38	} else if container, err := createShadowIfNotExists(ctx, declared); err != nil {	×
39	return err	×
40	} else if len(container) > 0 {	×
41	defer utils.DockerRemove(container)	×
42	if err := start.WaitForHealthyService(ctx, start.HealthTimeout, container); err != nil {	×
43	return err	×
44	}	×
NEW 45	if err := migrateBaseDatabase(ctx, container, declared, fsys, options...); err != nil {	×
46	return err	×
47	}	×
48	}
49	}
50	// 1. Load all user defined schemas
51	if len(schema) == 0 {	4✔
52	schema, err = loadSchema(ctx, config, options...)	1✔
53	if err != nil {	2✔
54	return err	1✔
55	}	1✔
56	}
57	// 3. Run migra to diff schema
58	out, err := DiffDatabase(ctx, schema, config, os.Stderr, fsys, differ, options...)	2✔
59	if err != nil {	3✔
60	return err	1✔
61	}	1✔
62	branch := keys.GetGitBranch(fsys)	1✔
63	fmt.Fprintln(os.Stderr, "Finished "+utils.Aqua("supabase db diff")+" on branch "+utils.Aqua(branch)+".\n")	1✔
64	if err := SaveDiff(out, file, fsys); err != nil {	1✔
65	return err	×
66	}	×
67	drops := findDropStatements(out)	1✔
68	if len(drops) > 0 {	1✔
69	fmt.Fprintln(os.Stderr, "Found drop statements in schema diff. Please double check if these are expected:")	×
70	fmt.Fprintln(os.Stderr, utils.Yellow(strings.Join(drops, "\n")))	×
71	}	×
72	return nil	1✔
73	}
74
NEW 75	func createShadowIfNotExists(ctx context.Context, migrations []string) (string, error) {	×
NEW 76	if len(migrations) == 0 {	×
77	return "", nil	×
78	}	×
79	if err := utils.AssertSupabaseDbIsRunning(); !errors.Is(err, utils.ErrNotRunning) {	×
80	return "", err	×
81	}	×
NEW 82	fmt.Fprintln(os.Stderr, "Creating local database from declarative schemas:")	×
NEW 83	msg := make([]string, len(migrations))	×
NEW 84	for i, m := range migrations {	×
NEW 85	msg[i] = fmt.Sprintf(" • %s", utils.Bold(m))	×
NEW 86	}	×
NEW 87	fmt.Fprintln(os.Stderr, strings.Join(msg, "\n"))	×
UNCOV 88	return CreateShadowDatabase(ctx, utils.Config.Db.Port)	×
89	}
90
91	func loadDeclaredSchemas(fsys afero.Fs) ([]string, error) {	1✔
92	if schemas := utils.Config.Db.Migrations.SchemaPaths; len(schemas) > 0 {	1✔
93	return schemas.Files(afero.NewIOFS(fsys))	×
94	}	×
95	if exists, err := afero.DirExists(fsys, utils.SchemasDir); err != nil {	1✔
NEW 96	return nil, errors.Errorf("failed to check schemas: %w", err)	×
97	} else if !exists {	1✔
NEW 98	return nil, nil	×
NEW 99	}	×
100	var declared []string	1✔
101	if err := afero.Walk(fsys, utils.SchemasDir, func(path string, info fs.FileInfo, err error) error {	10✔
102	if err != nil {	9✔
103	return err	×
104	}	×
105	if info.Mode().IsRegular() && filepath.Ext(info.Name()) == ".sql" {	13✔
106	declared = append(declared, path)	4✔
107	}	4✔
108	return nil	9✔
109	}); err != nil {	×
110	return nil, errors.Errorf("failed to walk dir: %w", err)	×
111	}	×
112	return declared, nil	1✔
113	}
114
115	// https://github.com/djrobstep/migra/blob/master/migra/statements.py#L6
116	var dropStatementPattern = regexp.MustCompile(`(?i)drop\s+`)
117
118	func findDropStatements(out string) []string {	2✔
119	lines, err := parser.SplitAndTrim(strings.NewReader(out))	2✔
120	if err != nil {	2✔
121	return nil	×
122	}	×
123	var drops []string	2✔
124	for _, line := range lines {	6✔
125	if dropStatementPattern.MatchString(line) {	6✔
126	drops = append(drops, line)	2✔
127	}	2✔
128	}
129	return drops	2✔
130	}
131
132	func loadSchema(ctx context.Context, config pgconn.Config, options ...func(*pgx.ConnConfig)) ([]string, error) {	1✔
133	conn, err := utils.ConnectByConfig(ctx, config, options...)	1✔
134	if err != nil {	1✔
135	return nil, err	×
136	}	×
137	defer conn.Close(context.Background())	1✔
138	// RLS policies in auth and storage schemas can be included with -s flag	1✔
139	return migration.ListUserSchemas(ctx, conn)	1✔
140	}
141
142	func CreateShadowDatabase(ctx context.Context, port uint16) (string, error) {	6✔
143	config := start.NewContainerConfig()	6✔
144	hostPort := strconv.FormatUint(uint64(port), 10)	6✔
145	hostConfig := container.HostConfig{	6✔
146	PortBindings: nat.PortMap{"5432/tcp": []nat.PortBinding{{HostPort: hostPort}}},	6✔
147	AutoRemove: true,	6✔
148	}	6✔
149	networkingConfig := network.NetworkingConfig{}	6✔
150	if utils.Config.Db.MajorVersion <= 14 {	10✔
151	config.Entrypoint = nil	4✔
152	hostConfig.Tmpfs = map[string]string{"/docker-entrypoint-initdb.d": ""}	4✔
153	}	4✔
154	return utils.DockerStart(ctx, config, hostConfig, networkingConfig, "")	6✔
155	}
156
157	func ConnectShadowDatabase(ctx context.Context, timeout time.Duration, options ...func(pgx.ConnConfig)) (conn pgx.Conn, err error) {	6✔
158	// Retry until connected, cancelled, or timeout	6✔
159	policy := start.NewBackoffPolicy(ctx, timeout)	6✔
160	config := pgconn.Config{Port: utils.Config.Db.ShadowPort}	6✔
161	connect := func() (*pgx.Conn, error) {	12✔
162	return utils.ConnectLocalPostgres(ctx, config, options...)	6✔
163	}	6✔
164	return backoff.RetryWithData(connect, policy)	6✔
165	}
166
167	func MigrateShadowDatabase(ctx context.Context, container string, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {	7✔
168	migrations, err := migration.ListLocalMigrations(utils.MigrationsDir, afero.NewIOFS(fsys))	7✔
169	if err != nil {	8✔
170	return err	1✔
171	}	1✔
172	conn, err := ConnectShadowDatabase(ctx, 10*time.Second, options...)	6✔
173	if err != nil {	7✔
174	return err	1✔
175	}	1✔
176	defer conn.Close(context.Background())	5✔
177	if err := start.SetupDatabase(ctx, conn, container[:12], os.Stderr, fsys); err != nil {	7✔
178	return err	2✔
179	}	2✔
180	return migration.ApplyMigrations(ctx, migrations, conn, afero.NewIOFS(fsys))	3✔
181	}
182
NEW 183	func migrateBaseDatabase(ctx context.Context, container string, migrations []string, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {	×
184	conn, err := utils.ConnectLocalPostgres(ctx, pgconn.Config{}, options...)	×
185	if err != nil {	×
186	return err	×
187	}	×
188	defer conn.Close(context.Background())	×
189	if err := start.SetupDatabase(ctx, conn, container[:12], os.Stderr, fsys); err != nil {	×
190	return err	×
191	}	×
192	return migration.SeedGlobals(ctx, migrations, conn, afero.NewIOFS(fsys))	×
193	}
194
195	func DiffDatabase(ctx context.Context, schema []string, config pgconn.Config, w io.Writer, fsys afero.Fs, differ func(context.Context, string, string, []string) (string, error), options ...func(*pgx.ConnConfig)) (string, error) {	6✔
196	fmt.Fprintln(w, "Creating shadow database...")	6✔
197	shadow, err := CreateShadowDatabase(ctx, utils.Config.Db.ShadowPort)	6✔
198	if err != nil {	8✔
199	return "", err	2✔
200	}	2✔
201	defer utils.DockerRemove(shadow)	4✔
202	if err := start.WaitForHealthyService(ctx, start.HealthTimeout, shadow); err != nil {	5✔
203	return "", err	1✔
204	}	1✔
205	if err := MigrateShadowDatabase(ctx, shadow, fsys, options...); err != nil {	4✔
206	return "", err	1✔
207	}	1✔
208	fmt.Fprintln(w, "Diffing schemas:", strings.Join(schema, ","))	2✔
209	source := utils.ToPostgresURL(pgconn.Config{	2✔
210	Host: utils.Config.Hostname,	2✔
211	Port: utils.Config.Db.ShadowPort,	2✔
212	User: "postgres",	2✔
213	Password: utils.Config.Db.Password,	2✔
214	Database: "postgres",	2✔
215	})	2✔
216	target := utils.ToPostgresURL(config)	2✔
217	return differ(ctx, source, target, schema)	2✔
218	}

supabase / cli / 14083564902

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous