db: add VSC

ops/devcontainer/Dockerfile

@@ -1,13 +1,13 @@
 # A dev container.
 
-FROM alpine:3.22
+FROM alpine:3.24
 
 RUN apk add build-base git go sqlite vim shellcheck curl jq sudo bash docker
 
 # Busybox `less` doesn't appear to support colors (makes git diff lose color)
 RUN apk add less
 
-RUN curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b /usr/local/bin v2.0.2
+RUN curl -sSfL https://golangci-lint.run/install.sh | sh -s -- -b /usr/local/bin v2.14.0
 RUN GOBIN=/usr/local/bin go install git.offline-twitter.com/offline-labs/gocheckout@v0.0.2
 
 COPY etc/group /etc/group

pkg/codegen/modelgenerate/generate_model.go

@@ -296,9 +296,8 @@ func GenerateSaveItemFunc(tbl schema.Table) *ast.FuncDecl {
 	updatePairs := make([]string, 0, len(tbl.Columns))
 
 	hasCreatedAt, hasUpdatedAt := tbl.HasAutoTimestamps()
-	hasSoftDelete := tbl.HasSoftDelete()
 
-	// Assemble data for building SQL "insert" and "update" strings
+	// Assemble SQL "insert" string
 	for _, col := range tbl.Columns {
 		if col.Name == "rowid" {
 			continue
@@ -309,23 +308,20 @@ func GenerateSaveItemFunc(tbl schema.Table) *ast.FuncDecl {
 			val = fmt.Sprintf("nullif(%s, 0)", val)
 		}
 		insertVals = append(insertVals, val)
-		// created_at should not be updated after creation
-		if col.Name == "created_at" && hasCreatedAt {
-			continue
-		}
-		// Soft-delete state is managed by SoftDeleteXyz(), not by updates
-		if hasSoftDelete && (col.Name == "is_deleted" || col.Name == "deleted_at") {
-			continue
-		}
-		if !col.IsPrimaryKey { // Don't try to update primary key columns (mainly for w/o rowid tables)
-			updatePairs = append(updatePairs, col.Name+"="+val)
-		}
 	}
 	insertStmt := fmt.Sprintf("\n\t\t    insert into %s (%s)\n\t\t         values (%s)\n\t\t",
 		tbl.TableName,
 		strings.Join(insertCols, ", "),
 		strings.Join(insertVals, ", "),
 	)
+	// ...and "update" string
+	for _, col := range tbl.GetUpdateableColumns() {
+		val := ":" + col.Name
+		if col.IsNullableForeignKey() {
+			val = fmt.Sprintf("nullif(%s, 0)", val)
+		}
+		updatePairs = append(updatePairs, col.Name+"="+val)
+	}
 	updateStmt := fmt.Sprintf("\n\t\t    update %s\n\t\t       set %s\n\t\t     where rowid = :rowid\n\t\t",
 		tbl.TableName,
 		strings.Join(updatePairs, ",\n\t\t           "),

pkg/codegen/modelgenerate/generate_testfile.go

@@ -67,26 +67,18 @@ func SampleValue(c pkgschema.Column, offset int) ast.Expr {
 }
 
 // UpdateTestFields returns the columns for which the test generator should assign its own
-// sample values, in the MakeXyz() factory and in the create/update test: the same columns
-// that GenerateSaveItemFunc's "update" branch writes to, minus foreign keys (which can't be
-// given plausible values here), the auto-managed "created_at"/"updated_at" columns, and the
-// soft-delete columns (which SoftDeleteXyz() manages).
+// sample values in MakeXyz() and the create/update test. It starts with Table.GetUpdateableColumns()
+// and removes fields the generated test should not assign directly: foreign keys and auto-managed
+// updated_at.
 func UpdateTestFields(tbl pkgschema.Table) (ret []pkgschema.Column) {
-	hasCreatedAt, hasUpdatedAt := tbl.HasAutoTimestamps()
-	hasSoftDelete := tbl.HasSoftDelete()
-	for _, c := range tbl.Columns {
-		if c.Name == "rowid" || c.IsPrimaryKey || c.IsForeignKey {
-			continue
-		}
-		if c.Name == "created_at" && hasCreatedAt {
+	_, hasUpdatedAt := tbl.HasAutoTimestamps()
+	for _, c := range tbl.GetUpdateableColumns() {
+		if c.IsForeignKey {
 			continue
 		}
 		if c.Name == "updated_at" && hasUpdatedAt {
 			continue
 		}
-		if hasSoftDelete && (c.Name == "is_deleted" || c.Name == "deleted_at") {
-			continue
-		}
 		ret = append(ret, c)
 	}
 	return
@@ -101,12 +93,55 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 
 	hasCreatedAt, hasUpdatedAt := tbl.HasAutoTimestamps()
 	updateTestFields := UpdateTestFields(tbl)
+	uniqueColumns := map[string]bool{}
+	for _, index := range schema.Indexes {
+		if index.TableName != tbl.TableName || !index.IsUnique {
+			continue
+		}
+		for _, columnName := range index.Columns {
+			uniqueColumns[columnName] = true
+		}
+	}
+	hasRandomUniqueField := false
+	for _, c := range updateTestFields {
+		if uniqueColumns[c.Name] {
+			hasRandomUniqueField = true
+			break
+		}
+	}
+	requiredForeignKeys := []pkgschema.Column{}
+	for _, c := range tbl.Columns {
+		// Only ordinary object foreign keys use a distinct TargetObjectID Go type;
+		// code-table foreign keys retain their underlying SQLite type in the generated model.
+		if c.IsNotNull && c.IsNonCodeTableForeignKey() {
+			requiredForeignKeys = append(requiredForeignKeys, c)
+		}
+	}
+	requiredForeignKeyParamNames := paramNamesFor(requiredForeignKeys)
+
+	// Calls made by this generated test do not create related objects themselves. Pass a
+	// zero ID so the generated test remains syntactically valid; callers of MakeXyz provide
+	// IDs of the related objects they create.
+	makeItemArgs := func() (ret []ast.Expr) {
+		for range requiredForeignKeys {
+			ret = append(ret, &ast.BasicLit{Kind: token.INT, Value: "0"})
+		}
+		return
+	}()
 
 	// func MakeItem() Item { return Item{} }
 	makeItemFunc := &ast.FuncDecl{
 		Name: makeHelperName,
 		Type: &ast.FuncType{
-			Params: &ast.FieldList{},
+			Params: &ast.FieldList{List: func() (ret []*ast.Field) {
+				for i, c := range requiredForeignKeys {
+					ret = append(ret, &ast.Field{
+						Names: []*ast.Ident{ast.NewIdent(requiredForeignKeyParamNames[i])},
+						Type:  GoTypeForColumn(c),
+					})
+				}
+				return
+			}()},
 			Results: &ast.FieldList{
 				List: []*ast.Field{
 					{Type: ast.NewIdent(tbl.GoTypeName)},
@@ -114,24 +149,71 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 			},
 		},
 		Body: &ast.BlockStmt{
-			List: []ast.Stmt{
-				&ast.ReturnStmt{
-					Results: []ast.Expr{
-						&ast.CompositeLit{
-							Type: ast.NewIdent(tbl.GoTypeName),
-							Elts: func() (ret []ast.Expr) {
-								for _, c := range updateTestFields {
-									ret = append(ret, &ast.KeyValueExpr{
-										Key:   ast.NewIdent(c.GoFieldName()),
-										Value: SampleValue(c, 0),
-									})
-								}
-								return
-							}(),
+			List: append(
+				func() []ast.Stmt {
+					if !hasRandomUniqueField {
+						return nil
+					}
+					return []ast.Stmt{&ast.AssignStmt{
+						Lhs: []ast.Expr{ast.NewIdent("id")},
+						Tok: token.DEFINE,
+						Rhs: []ast.Expr{&ast.CallExpr{Fun: &ast.SelectorExpr{X: ast.NewIdent("rand"), Sel: ast.NewIdent("Int")}}},
+					}}
+				}(),
+				[]ast.Stmt{
+					&ast.ReturnStmt{
+						Results: []ast.Expr{
+							&ast.CompositeLit{
+								Type: ast.NewIdent(tbl.GoTypeName),
+								Elts: func() (ret []ast.Expr) {
+									// `UpdateTestFields()` skips foreign keys, so this will not cause duplicates
+									for i, c := range requiredForeignKeys {
+										ret = append(ret, &ast.KeyValueExpr{
+											Key:   ast.NewIdent(c.GoFieldName()),
+											Value: ast.NewIdent(requiredForeignKeyParamNames[i]),
+										})
+									}
+									for _, c := range updateTestFields {
+										value := SampleValue(c, 0)
+										if uniqueColumns[c.Name] {
+											switch c.Type {
+											case "integer", "int":
+												value = ast.NewIdent("id")
+											case "text":
+												value = &ast.CallExpr{
+													Fun: &ast.SelectorExpr{X: ast.NewIdent("fmt"), Sel: ast.NewIdent("Sprintf")},
+													Args: []ast.Expr{
+														&ast.BasicLit{Kind: token.STRING, Value: `"%s-%d"`},
+														SampleValue(c, 0),
+														ast.NewIdent("id"),
+													},
+												}
+											case "blob":
+												value = &ast.CallExpr{
+													Fun: &ast.ArrayType{Elt: ast.NewIdent("byte")},
+													Args: []ast.Expr{&ast.CallExpr{
+														Fun: &ast.SelectorExpr{X: ast.NewIdent("fmt"), Sel: ast.NewIdent("Sprintf")},
+														Args: []ast.Expr{
+															&ast.BasicLit{Kind: token.STRING, Value: `"%s-%d"`},
+															&ast.CallExpr{Fun: ast.NewIdent("string"), Args: []ast.Expr{SampleValue(c, 0)}},
+															ast.NewIdent("id"),
+														},
+													}},
+												}
+											}
+										}
+										ret = append(ret, &ast.KeyValueExpr{
+											Key:   ast.NewIdent(c.GoFieldName()),
+											Value: value,
+										})
+									}
+									return
+								}(),
+							},
 						},
 					},
-				},
-			},
+				}...,
+			),
 		},
 	}
 
@@ -242,7 +324,8 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 							Tok: map[bool]token.Token{true: token.DEFINE, false: token.ASSIGN}[isFirst],
 							Rhs: []ast.Expr{
 								&ast.CallExpr{
-									Fun: ast.NewIdent("Make" + tbl.GoTypeName),
+									Fun:  ast.NewIdent("Make" + tbl.GoTypeName),
+									Args: makeItemArgs,
 								},
 							},
 						},
@@ -329,7 +412,7 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 					&ast.AssignStmt{
 						Lhs: []ast.Expr{testObj},
 						Tok: token.DEFINE,
-						Rhs: []ast.Expr{&ast.CallExpr{Fun: makeHelperName, Args: nil}},
+						Rhs: []ast.Expr{&ast.CallExpr{Fun: makeHelperName, Args: makeItemArgs}},
 					},
 					// item.Description = <sample value, offset 1>
 					// ...one assignment per updatable field
@@ -395,39 +478,41 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 					makeDeepEqual(testObj, testObj2),
 				)
 
-				stmts = append(stmts,
-					BlankLine(),
-					Comment("Update"),
-				)
+				if len(tbl.GetUpdateableColumns()) > 0 { // Skip if no mutable fields
+					stmts = append(stmts,
+						BlankLine(),
+						Comment("Update"),
+					)
 
-				// item.Description = <sample value, offset 2>
-				// ...one assignment per updatable field
-				for _, c := range updateTestFields {
-					stmts = append(stmts, &ast.AssignStmt{
-						Lhs: []ast.Expr{&ast.SelectorExpr{X: testObj, Sel: ast.NewIdent(c.GoFieldName())}},
-						Tok: token.ASSIGN,
-						Rhs: []ast.Expr{SampleValue(c, 2)},
-					})
+					// item.Description = <sample value, offset 2>
+					// ...one assignment per updatable field
+					for _, c := range updateTestFields {
+						stmts = append(stmts, &ast.AssignStmt{
+							Lhs: []ast.Expr{&ast.SelectorExpr{X: testObj, Sel: ast.NewIdent(c.GoFieldName())}},
+							Tok: token.ASSIGN,
+							Rhs: []ast.Expr{SampleValue(c, 2)},
+						})
+					}
+
+					stmts = append(stmts,
+						// TestDB.SaveItem(&item)
+						&ast.ExprStmt{X: &ast.CallExpr{
+							Fun:  &ast.SelectorExpr{X: testDB, Sel: ast.NewIdent("Save" + tbl.GoTypeName)},
+							Args: []ast.Expr{&ast.UnaryExpr{Op: token.AND, X: testObj}},
+						}},
+
+						// item2 = must.Get(TestDB.GetItemByID(item.ID))
+						&ast.AssignStmt{
+							Lhs: []ast.Expr{testObj2},
+							Tok: token.ASSIGN,
+							Rhs: []ast.Expr{mustCall(getItemByPKCall(testObj))},
+						},
+
+						// if deep.Equal(...) {...}
+						makeDeepEqual(testObj, testObj2),
+					)
 				}
 
-				stmts = append(stmts,
-					// TestDB.SaveItem(&item)
-					&ast.ExprStmt{X: &ast.CallExpr{
-						Fun:  &ast.SelectorExpr{X: testDB, Sel: ast.NewIdent("Save" + tbl.GoTypeName)},
-						Args: []ast.Expr{&ast.UnaryExpr{Op: token.AND, X: testObj}},
-					}},
-
-					// item2 = must.Get(TestDB.GetItemByID(item.ID))
-					&ast.AssignStmt{
-						Lhs: []ast.Expr{testObj2},
-						Tok: token.ASSIGN,
-						Rhs: []ast.Expr{mustCall(getItemByPKCall(testObj))},
-					},
-
-					// if deep.Equal(...) {...}
-					makeDeepEqual(testObj, testObj2),
-				)
-
 				indexGets, hasIndexedGets := []ast.Stmt{
 					BlankLine(),
 					Comment("Indexed lookups"),
@@ -560,23 +645,33 @@ func GenerateModelTestAST(tbl pkgschema.Table, schema pkgschema.Schema, gomodNam
 		Decls: append([]ast.Decl{
 			&ast.GenDecl{
 				Tok: token.IMPORT,
-				Specs: []ast.Spec{
-					&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"testing"`}},
-					&ast.ImportSpec{
-						Path: &ast.BasicLit{Kind: token.STRING, Value: `"git.offline-twitter.com/offline-labs/gas-stack/pkg/db"`},
-						Name: ast.NewIdent("."),
-					},
-					&ast.ImportSpec{
-						Path: &ast.BasicLit{Kind: token.STRING, Value: `"git.offline-twitter.com/offline-labs/gas-stack/pkg/must"`},
-					},
-					&ast.ImportSpec{
-						Path: &ast.BasicLit{Kind: token.STRING, Value: fmt.Sprintf(`"%s/pkg/%s"`, gomodName, packageName)},
-						Name: ast.NewIdent("."),
-					},
-					&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/go-test/deep"`}},
-					&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/stretchr/testify/assert"`}},
-					&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/stretchr/testify/require"`}},
-				},
+				Specs: func() []ast.Spec {
+					specs := []ast.Spec{}
+					if hasRandomUniqueField {
+						specs = append(specs,
+							&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"fmt"`}},
+							&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"math/rand"`}},
+						)
+					}
+					specs = append(specs, []ast.Spec{
+						&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"testing"`}},
+						&ast.ImportSpec{
+							Path: &ast.BasicLit{Kind: token.STRING, Value: `"git.offline-twitter.com/offline-labs/gas-stack/pkg/db"`},
+							Name: ast.NewIdent("."),
+						},
+						&ast.ImportSpec{
+							Path: &ast.BasicLit{Kind: token.STRING, Value: `"git.offline-twitter.com/offline-labs/gas-stack/pkg/must"`},
+						},
+						&ast.ImportSpec{
+							Path: &ast.BasicLit{Kind: token.STRING, Value: fmt.Sprintf(`"%s/pkg/%s"`, gomodName, packageName)},
+							Name: ast.NewIdent("."),
+						},
+						&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/go-test/deep"`}},
+						&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/stretchr/testify/assert"`}},
+						&ast.ImportSpec{Path: &ast.BasicLit{Kind: token.STRING, Value: `"github.com/stretchr/testify/require"`}},
+					}...)
+					return specs
+				}(),
 			},
 		}, testList...),
 	}

pkg/db/vsc.go

@@ -0,0 +1,51 @@
+package db
+
+import (
+	"database/sql/driver"
+	"encoding/json"
+	"errors"
+	"strings"
+)
+
+const separator = "\x1f"
+
+type VSC []string
+
+// MarshalJSON replaces `nil` with `[]` for hygiene.
+func (vs VSC) MarshalJSON() ([]byte, error) {
+	if vs == nil {
+		vs = VSC{}
+	}
+	return json.Marshal([]string(vs)) //nolint: wrapcheck // Passthrough
+}
+
+func (vs VSC) Value() (driver.Value, error) {
+	fields := make([]string, len(vs))
+	for i, v := range vs {
+		fields[i] = strings.ReplaceAll(v, separator, "")
+	}
+	return strings.Join(fields, separator), nil
+}
+
+var ErrWrongVSCType = errors.New("incompatible DB type for VSC")
+
+func (vs *VSC) Scan(src any) error {
+	var s string
+	switch v := src.(type) {
+	case string:
+		s = v
+	case []byte:
+		s = string(v)
+	case nil:
+		*vs = nil
+		return nil
+	default:
+		return ErrWrongVSCType
+	}
+	if s == "" {
+		*vs = VSC{}
+		return nil
+	}
+	*vs = strings.Split(s, separator)
+	return nil
+}

pkg/db/vsc_test.go

@@ -0,0 +1,48 @@
+package db_test
+
+import (
+	"testing"
+
+	"github.com/jmoiron/sqlx"
+	_ "github.com/mattn/go-sqlite3"
+	"github.com/stretchr/testify/require"
+
+	"git.offline-twitter.com/offline-labs/gas-stack/pkg/db"
+)
+
+func TestVSCDBRoundTrip(t *testing.T) {
+	conn, err := sqlx.Open("sqlite3", ":memory:")
+	require.NoError(t, err)
+	t.Cleanup(func() { require.NoError(t, conn.Close()) })
+
+	_, err = conn.Exec(`create table vsc_items (id integer primary key, items text not null)`)
+	require.NoError(t, err)
+
+	type vscRow struct {
+		ID    int    `db:"id"`
+		Items db.VSC `db:"items"`
+	}
+
+	for _, want := range []vscRow{
+		{ID: 1, Items: db.VSC{"email"}},
+		{ID: 2, Items: db.VSC{"email", "profile"}},
+		{ID: 3, Items: db.VSC{}},
+	} {
+		_, err = conn.NamedExec(`insert into vsc_items (id, items) values (:id, :items)`, want)
+		require.NoError(t, err)
+
+		var got vscRow
+		require.NoError(t, conn.Get(&got, `select id, items from vsc_items where id = ?`, want.ID))
+		require.Equal(t, want, got)
+	}
+	t.Run("nil gets upgrade to empty list", func(t *testing.T) {
+		want := vscRow{ID: 4, Items: nil}
+		_, err = conn.NamedExec(`insert into vsc_items (id, items) values (:id, :items)`, want)
+		require.NoError(t, err)
+
+		var got vscRow
+		require.NoError(t, conn.Get(&got, `select id, items from vsc_items where id = ?`, want.ID))
+		require.NotNil(t, got.Items)
+		require.Equal(t, db.VSC{}, got.Items)
+	})
+}

pkg/schema/table.go

@@ -76,3 +76,21 @@ func (t Table) HasSoftDelete() bool {
 	}
 	return hasIsDeleted && hasDeletedAt
 }
+
+// GetUpdateableColumns returns the columns that should be written to by an "update" operation.
+func (t Table) GetUpdateableColumns() (ret []Column) {
+	hasCreatedAt, _ := t.HasAutoTimestamps()
+	for _, col := range t.Columns {
+		if col.Name == "rowid" || col.IsPrimaryKey {
+			continue // Rowid / primary key is never updateable
+		}
+		if col.Name == "created_at" && hasCreatedAt {
+			continue // Update shouldn't write `created_at`
+		}
+		if t.HasSoftDelete() && (col.Name == "is_deleted" || col.Name == "deleted_at") {
+			continue // Soft-delete state is managed by SoftDeleteXyz(), not by updates
+		}
+		ret = append(ret, col)
+	}
+	return
+}

pkg/schema/table_test.go

@@ -0,0 +1,34 @@
+package schema
+
+import "testing"
+
+func TestTableGetUpdateableColumns(t *testing.T) {
+	tbl := Table{
+		Columns: []Column{
+			{Name: "rowid"},
+			{Name: "version", Type: "integer", IsPrimaryKey: true},
+			{Name: "created_at", Type: "integer"},
+			{Name: "updated_at", Type: "integer"},
+			{Name: "is_deleted", Type: "integer"},
+			{Name: "deleted_at", Type: "integer"},
+			{Name: "owner_id", Type: "integer", IsForeignKey: true},
+			{Name: "name", Type: "text"},
+		},
+	}
+
+	gotColumns := tbl.GetUpdateableColumns()
+	got := make([]string, 0, len(gotColumns))
+	for _, col := range gotColumns {
+		got = append(got, col.Name)
+	}
+
+	want := []string{"updated_at", "owner_id", "name"}
+	if len(got) != len(want) {
+		t.Fatalf("GetUpdateableColumns() = %v, want %v", got, want)
+	}
+	for i := range want {
+		if got[i] != want[i] {
+			t.Fatalf("GetUpdateableColumns() = %v, want %v", got, want)
+		}
+	}
+}