feat(db): add postgresql support

scottmckendry · scottmckendry · commit f642298ba76a · 2026-05-23T17:20:02.000+12:00
diff --git a/go.mod b/go.mod
@@ -103,6 +103,11 @@ require (
 	github.com/hdevalence/ed25519consensus v0.2.0 // indirect
 	github.com/huandu/xstrings v1.5.0 // indirect
 	github.com/huin/goupnp v1.3.0 // indirect
+	github.com/jackc/pgerrcode v0.0.0-20220416144525-469b46aa5efa // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/pgx/v5 v5.9.2 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
 	github.com/jsimonetti/rtnetlink v1.4.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/compress v1.18.2 // indirect
diff --git a/go.sum b/go.sum
@@ -251,6 +251,16 @@ github.com/illarion/gonotify/v3 v3.0.2 h1:O7S6vcopHexutmpObkeWsnzMJt/r1hONIEogeV
 github.com/illarion/gonotify/v3 v3.0.2/go.mod h1:HWGPdPe817GfvY3w7cx6zkbzNZfi3QjcBm/wgVvEL1U=
 github.com/insomniacslk/dhcp v0.0.0-20231206064809-8c70d406f6d2 h1:9K06NfxkBh25x56yVhWWlKFE8YpicaSfHwoV8SFbueA=
 github.com/insomniacslk/dhcp v0.0.0-20231206064809-8c70d406f6d2/go.mod h1:3A9PQ1cunSDF/1rbTq99Ts4pVnycWg+vlPkfeD2NLFI=
+github.com/jackc/pgerrcode v0.0.0-20220416144525-469b46aa5efa h1:s+4MhCQ6YrzisK6hFJUX53drDT4UsSW3DEhKn0ifuHw=
+github.com/jackc/pgerrcode v0.0.0-20220416144525-469b46aa5efa/go.mod h1:a/s9Lp5W7n/DD0VrVoyJ00FbP2ytTPDVOivvn2bMlds=
+github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
+github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
+github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
+github.com/jackc/pgx/v5 v5.9.2 h1:3ZhOzMWnR4yJ+RW1XImIPsD1aNSz4T4fyP7zlQb56hw=
+github.com/jackc/pgx/v5 v5.9.2/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
+github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
+github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
 github.com/jcmturner/aescts/v2 v2.0.0 h1:9YKLH6ey7H4eDBXW8khjYslgyqG2xZikXP0EQFKrle8=
 github.com/jcmturner/aescts/v2 v2.0.0/go.mod h1:AiaICIRyfYg35RUkr8yESTqvSy7csK90qZ5xfvvsoNs=
 github.com/jcmturner/dnsutils/v2 v2.0.0 h1:lltnkeZGL0wILNvrNiVCR6Ro5PGU/SeBvVO/8c/iPbo=
@@ -398,6 +408,7 @@ github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpE
 github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
 github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
diff --git a/internal/assets/assets.go b/internal/assets/assets.go
@@ -11,5 +11,5 @@ var FrontendAssets embed.FS
 
 // Migrations
 //
-//go:embed migrations/sqlite/*.sql
+//go:embed migrations/sqlite/*.sql migrations/postgres/*.sql
 var Migrations embed.FS
diff --git a/internal/assets/migrations/postgres/000001_init_postgres.down.sql b/internal/assets/migrations/postgres/000001_init_postgres.down.sql
@@ -0,0 +1 @@
+DROP TABLE IF EXISTS "sessions";
diff --git a/internal/assets/migrations/postgres/000001_init_postgres.up.sql b/internal/assets/migrations/postgres/000001_init_postgres.up.sql
@@ -0,0 +1,10 @@
+CREATE TABLE IF NOT EXISTS "sessions" (
+    "uuid"         TEXT    NOT NULL PRIMARY KEY,
+    "username"     TEXT    NOT NULL,
+    "email"        TEXT    NOT NULL,
+    "name"         TEXT    NOT NULL,
+    "provider"     TEXT    NOT NULL,
+    "totp_pending" BOOLEAN NOT NULL,
+    "oauth_groups" TEXT    NOT NULL DEFAULT '',
+    "expiry"       BIGINT  NOT NULL
+);
diff --git a/internal/assets/migrations/postgres/000002_oauth_name.down.sql b/internal/assets/migrations/postgres/000002_oauth_name.down.sql
@@ -0,0 +1 @@
+ALTER TABLE "sessions" DROP COLUMN "oauth_name";
diff --git a/internal/assets/migrations/postgres/000002_oauth_name.up.sql b/internal/assets/migrations/postgres/000002_oauth_name.up.sql
@@ -0,0 +1,9 @@
+ALTER TABLE "sessions" ADD COLUMN "oauth_name" TEXT NOT NULL DEFAULT '';
+
+UPDATE "sessions"
+SET "oauth_name" = CASE
+  WHEN LOWER("provider") = 'github' THEN 'GitHub'
+  WHEN LOWER("provider") = 'google' THEN 'Google'
+  ELSE UPPER(SUBSTR("provider", 1, 1)) || SUBSTR("provider", 2)
+END
+WHERE "oauth_name" = '' AND "provider" IS NOT NULL;
diff --git a/internal/assets/migrations/postgres/000003_oauth_sub.down.sql b/internal/assets/migrations/postgres/000003_oauth_sub.down.sql
@@ -0,0 +1 @@
+ALTER TABLE "sessions" DROP COLUMN "oauth_sub";
diff --git a/internal/assets/migrations/postgres/000003_oauth_sub.up.sql b/internal/assets/migrations/postgres/000003_oauth_sub.up.sql
@@ -0,0 +1 @@
+ALTER TABLE "sessions" ADD COLUMN "oauth_sub" TEXT NOT NULL DEFAULT '';
diff --git a/internal/assets/migrations/postgres/000004_created_at.down.sql b/internal/assets/migrations/postgres/000004_created_at.down.sql
@@ -0,0 +1 @@
+ALTER TABLE "sessions" DROP COLUMN "created_at";
diff --git a/internal/assets/migrations/postgres/000004_created_at.up.sql b/internal/assets/migrations/postgres/000004_created_at.up.sql
@@ -0,0 +1 @@
+ALTER TABLE "sessions" ADD COLUMN "created_at" BIGINT NOT NULL DEFAULT 0;
diff --git a/internal/assets/migrations/postgres/000005_oidc_session.down.sql b/internal/assets/migrations/postgres/000005_oidc_session.down.sql
@@ -0,0 +1,3 @@
+DROP TABLE IF EXISTS "oidc_tokens";
+DROP TABLE IF EXISTS "oidc_userinfo";
+DROP TABLE IF EXISTS "oidc_codes";
diff --git a/internal/assets/migrations/postgres/000005_oidc_session.up.sql b/internal/assets/migrations/postgres/000005_oidc_session.up.sql
@@ -0,0 +1,27 @@
+CREATE TABLE IF NOT EXISTS "oidc_codes" (
+    "sub"          TEXT   NOT NULL UNIQUE,
+    "code_hash"    TEXT   NOT NULL PRIMARY KEY,
+    "scope"        TEXT   NOT NULL,
+    "redirect_uri" TEXT   NOT NULL,
+    "client_id"    TEXT   NOT NULL,
+    "expires_at"   BIGINT NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS "oidc_tokens" (
+    "sub"                      TEXT   NOT NULL UNIQUE,
+    "access_token_hash"        TEXT   NOT NULL PRIMARY KEY,
+    "refresh_token_hash"       TEXT   NOT NULL,
+    "scope"                    TEXT   NOT NULL,
+    "client_id"                TEXT   NOT NULL,
+    "token_expires_at"         BIGINT NOT NULL,
+    "refresh_token_expires_at" BIGINT NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS "oidc_userinfo" (
+    "sub"                TEXT   NOT NULL PRIMARY KEY,
+    "name"               TEXT   NOT NULL,
+    "preferred_username" TEXT   NOT NULL,
+    "email"              TEXT   NOT NULL,
+    "groups"             TEXT   NOT NULL,
+    "updated_at"         BIGINT NOT NULL
+);
diff --git a/internal/assets/migrations/postgres/000006_oidc_nonce.down.sql b/internal/assets/migrations/postgres/000006_oidc_nonce.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE "oidc_codes"  DROP COLUMN "nonce";
+ALTER TABLE "oidc_tokens" DROP COLUMN "nonce";
diff --git a/internal/assets/migrations/postgres/000006_oidc_nonce.up.sql b/internal/assets/migrations/postgres/000006_oidc_nonce.up.sql
@@ -0,0 +1,2 @@
+ALTER TABLE "oidc_codes"  ADD COLUMN "nonce" TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_tokens" ADD COLUMN "nonce" TEXT NOT NULL DEFAULT '';
diff --git a/internal/assets/migrations/postgres/000007_oidc_pkce.down.sql b/internal/assets/migrations/postgres/000007_oidc_pkce.down.sql
@@ -0,0 +1 @@
+ALTER TABLE "oidc_codes" DROP COLUMN "code_challenge";
diff --git a/internal/assets/migrations/postgres/000007_oidc_pkce.up.sql b/internal/assets/migrations/postgres/000007_oidc_pkce.up.sql
@@ -0,0 +1 @@
+ALTER TABLE "oidc_codes" ADD COLUMN "code_challenge" TEXT NOT NULL DEFAULT '';
diff --git a/internal/assets/migrations/postgres/000008_oidc_code_reuse.down.sql b/internal/assets/migrations/postgres/000008_oidc_code_reuse.down.sql
@@ -0,0 +1 @@
+ALTER TABLE "oidc_tokens" DROP COLUMN "code_hash";
diff --git a/internal/assets/migrations/postgres/000008_oidc_code_reuse.up.sql b/internal/assets/migrations/postgres/000008_oidc_code_reuse.up.sql
@@ -0,0 +1 @@
+ALTER TABLE "oidc_tokens" ADD COLUMN "code_hash" TEXT NOT NULL DEFAULT '';
diff --git a/internal/assets/migrations/postgres/000009_oidc_userinfo_profile.down.sql b/internal/assets/migrations/postgres/000009_oidc_userinfo_profile.down.sql
@@ -0,0 +1,13 @@
+ALTER TABLE "oidc_userinfo" DROP COLUMN "given_name";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "family_name";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "middle_name";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "nickname";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "profile";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "picture";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "website";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "gender";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "birthdate";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "zoneinfo";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "locale";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "phone_number";
+ALTER TABLE "oidc_userinfo" DROP COLUMN "address";
diff --git a/internal/assets/migrations/postgres/000009_oidc_userinfo_profile.up.sql b/internal/assets/migrations/postgres/000009_oidc_userinfo_profile.up.sql
@@ -0,0 +1,13 @@
+ALTER TABLE "oidc_userinfo" ADD COLUMN "given_name"   TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "family_name"  TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "middle_name"  TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "nickname"     TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "profile"      TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "picture"      TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "website"      TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "gender"       TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "birthdate"    TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "zoneinfo"     TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "locale"       TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "phone_number" TEXT NOT NULL DEFAULT '';
+ALTER TABLE "oidc_userinfo" ADD COLUMN "address"      TEXT NOT NULL DEFAULT '{}';
diff --git a/internal/bootstrap/db_bootstrap.go b/internal/bootstrap/db_bootstrap.go
@@ -6,15 +6,18 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/tinyauthapp/tinyauth/internal/assets"
-	"github.com/tinyauthapp/tinyauth/internal/repository"
-	"github.com/tinyauthapp/tinyauth/internal/repository/memory"
-	"github.com/tinyauthapp/tinyauth/internal/repository/sqlite"
-
 	"github.com/golang-migrate/migrate/v4"
+	pgxmigrate "github.com/golang-migrate/migrate/v4/database/pgx/v5"
 	"github.com/golang-migrate/migrate/v4/database/sqlite3"
 	"github.com/golang-migrate/migrate/v4/source/iofs"
+	_ "github.com/jackc/pgx/v5/stdlib"
 	_ "modernc.org/sqlite"
+
+	"github.com/tinyauthapp/tinyauth/internal/assets"
+	"github.com/tinyauthapp/tinyauth/internal/repository"
+	"github.com/tinyauthapp/tinyauth/internal/repository/memory"
+	"github.com/tinyauthapp/tinyauth/internal/repository/postgres"
+	"github.com/tinyauthapp/tinyauth/internal/repository/sqlite"
 )
 
 func (app *BootstrapApp) SetupStore() (repository.Store, error) {
@@ -23,8 +26,10 @@ func (app *BootstrapApp) SetupStore() (repository.Store, error) {
 		return memory.New(), nil
 	case "sqlite", "":
 		return app.setupSQLite(app.config.Database.Path)
+	case "postgres":
+		return app.setupPostgres(app.config.Database.Path)
 	default:
-		return nil, fmt.Errorf("unknown database driver %q: valid values are sqlite, memory", app.config.Database.Driver)
+		return nil, fmt.Errorf("unknown database driver %q: valid values are sqlite, postgres, memory", app.config.Database.Driver)
 	}
 }
 
@@ -78,3 +83,44 @@ func (app *BootstrapApp) setupSQLite(databasePath string) (repository.Store, err
 
 	return sqlite.NewStore(sqlite.New(db)), nil
 }
+
+func (app *BootstrapApp) setupPostgres(databaseURL string) (repository.Store, error) {
+	db, err := sql.Open("pgx", databaseURL)
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to open database: %w", err)
+	}
+
+	// Close the database if there is an error during migration
+	defer func() {
+		if err != nil {
+			db.Close()
+		}
+	}()
+
+	migrations, err := iofs.New(assets.Migrations, "migrations/postgres")
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to create migrations: %w", err)
+	}
+
+	target, err := pgxmigrate.WithInstance(db, &pgxmigrate.Config{})
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to create postgres instance: %w", err)
+	}
+
+	migrator, err := migrate.NewWithInstance("iofs", migrations, "pgx", target)
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to create migrator: %w", err)
+	}
+
+	if err := migrator.Up(); err != nil && err != migrate.ErrNoChange {
+		return nil, fmt.Errorf("failed to migrate database: %w", err)
+	}
+
+	app.db = db
+
+	return postgres.NewStore(postgres.New(db)), nil
+}
diff --git a/internal/model/config.go b/internal/model/config.go
@@ -91,8 +91,8 @@ type Config struct {
 }
 
 type DatabaseConfig struct {
-	Driver string `description:"The database driver to use. Valid values: sqlite, memory." yaml:"driver"`
-	Path   string `description:"The path to the SQLite database, including file name. Only used when driver is sqlite." yaml:"path"`
+	Driver string `description:"The database driver to use. Valid values: sqlite, postgres, memory." yaml:"driver"`
+	Path   string `description:"The path to the SQLite database file, or connection URL when driver is postgres." yaml:"path"`
 }
 
 type AnalyticsConfig struct {
diff --git a/internal/repository/postgres/db.go b/internal/repository/postgres/db.go
diff --git a/internal/repository/postgres/generate.go b/internal/repository/postgres/generate.go
@@ -0,0 +1,3 @@
+package postgres
+
+//go:generate go run github.com/tinyauthapp/tinyauth/gen/sqlc-wrapper -pkg github.com/tinyauthapp/tinyauth/internal/repository/postgres
diff --git a/internal/repository/postgres/models.go b/internal/repository/postgres/models.go
diff --git a/internal/repository/postgres/oidc_queries.sql.go b/internal/repository/postgres/oidc_queries.sql.go
diff --git a/internal/repository/postgres/session_queries.sql.go b/internal/repository/postgres/session_queries.sql.go
diff --git a/internal/repository/postgres/store.go b/internal/repository/postgres/store.go
diff --git a/sql/postgres/oidc_queries.sql b/sql/postgres/oidc_queries.sql
diff --git a/sql/postgres/oidc_schemas.sql b/sql/postgres/oidc_schemas.sql
diff --git a/sql/postgres/session_queries.sql b/sql/postgres/session_queries.sql
diff --git a/sql/postgres/session_schemas.sql b/sql/postgres/session_schemas.sql
diff --git a/sqlc.yml b/sqlc.yml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE "sessions" DROP COLUMN "oauth_name";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE "sessions" ADD COLUMN "oauth_sub" TEXT NOT NULL DEFAULT '';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE "sessions" DROP COLUMN "created_at";`