From c3f271bcfdaa3d17746fb6861d5c3a7d11c60a9f Mon Sep 17 00:00:00 2001 From: Drew Bednar Date: Sun, 28 Jul 2024 19:00:41 +0000 Subject: [PATCH] Adding SQL support to application. (#1) Adds new packages to support sqlite3 database as a supported backend. Reviewed-on: https://git.runcible.io/androiddrew/flux-feed/pulls/1 --- .env.template | 3 ++ .gitignore | 6 ++- cmd/migrate/main.go | 40 +++++++++++++++ config/config.go | 26 ++++++++++ config/database.go | 18 +++++++ database/sqlx.go | 33 ++++++++++++ go.mod | 16 +++++- go.sum | 34 +++++++++++++ main.go | 17 ------- main_test.go | 18 ------- migrations/10_initial_schema.down.sql | 3 ++ migrations/10_initial_schema.up.sql | 72 +++++++++++++++++++++++++++ 12 files changed, 249 insertions(+), 37 deletions(-) create mode 100644 .env.template create mode 100644 cmd/migrate/main.go create mode 100644 config/config.go create mode 100644 config/database.go create mode 100644 database/sqlx.go create mode 100644 go.sum delete mode 100644 main.go delete mode 100644 main_test.go create mode 100644 migrations/10_initial_schema.down.sql create mode 100644 migrations/10_initial_schema.up.sql diff --git a/.env.template b/.env.template new file mode 100644 index 0000000..2c38b8d --- /dev/null +++ b/.env.template @@ -0,0 +1,3 @@ +FLUX_DATABASE_DRIVER=sqlite3 +FLUX_DATABASE_DSN=./flux-local.db +FLUX_MIGRATIONS_PATH=./migrations diff --git a/.gitignore b/.gitignore index f65ce7f..2ac73c2 100644 --- a/.gitignore +++ b/.gitignore @@ -21,4 +21,8 @@ # Go workspace file go.work -fluxfeed \ No newline at end of file +# Flux Feed +fluxfeed +flux-feed +.env +flux-local.db \ No newline at end of file diff --git a/cmd/migrate/main.go b/cmd/migrate/main.go new file mode 100644 index 0000000..e26b0d6 --- /dev/null +++ b/cmd/migrate/main.go @@ -0,0 +1,40 @@ +// Entry point for applying database migrations for flux-feed application +package main + +import ( + "database/sql" + "log" + + "git.runcible.io/androiddrew/flux-feed/config" + "github.com/golang-migrate/migrate/v4" + "github.com/golang-migrate/migrate/v4/database/sqlite3" + _ "github.com/golang-migrate/migrate/v4/source/file" + _ "github.com/mattn/go-sqlite3" +) + +func main() { + cfg := config.New() + db, err := sql.Open(cfg.DatabaseDriver, cfg.DatabaseDSN) + defer db.Close() + + err = db.Ping() + if err != nil { + log.Fatal(err) + } + log.Printf("Connected to Database: %s", cfg.DatabaseDSN) + + driver, err := sqlite3.WithInstance(db, &sqlite3.Config{}) + + log.Printf("Using migrations path: %s", cfg.MigrationsPath) + + m, err := migrate.NewWithDatabaseInstance( + cfg.MigrationsPath, cfg.DatabaseDriver, driver) + if err != nil { + log.Fatal(err) + } + log.Printf("Migrating: %s", cfg.DatabaseDSN) + err = m.Up() + if err != nil { + log.Fatal(err) + } +} diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..3ea15dc --- /dev/null +++ b/config/config.go @@ -0,0 +1,26 @@ +// Package config provides configuration structures and methods to load +// environment variables for the application. +package config + +import ( + "log" + + "github.com/joho/godotenv" +) + +// Config holds the configuration for the application, including the database settings. It contains multiple embedded configuration structs. +type Config struct { + Database +} + +// New loads environment variables and returns a new configured Config instance. +func New() *Config { + err := godotenv.Load() + if err != nil { + log.Println(err) + } + + return &Config{ + Database: DataStore(), + } +} diff --git a/config/database.go b/config/database.go new file mode 100644 index 0000000..bbdb1b0 --- /dev/null +++ b/config/database.go @@ -0,0 +1,18 @@ +package config + +import "github.com/kelseyhightower/envconfig" + +// Database holds the configuration for the database connection. +type Database struct { + DatabaseDriver string `split_words:"true"` + DatabaseDSN string `split_words:"true"` + MigrationsPath string `default:"head" split_words:"true"` +} + +// DataStore processes environment variables and returns a configured Database configuration struct. +func DataStore() Database { + var db Database + envconfig.MustProcess("flux", &db) + + return db +} diff --git a/database/sqlx.go b/database/sqlx.go new file mode 100644 index 0000000..937a731 --- /dev/null +++ b/database/sqlx.go @@ -0,0 +1,33 @@ +// Package database provides utility functions for connecting to and +// interacting with various database backends. +// +// This package supports multiple database drivers including: +// - sqlite3 +// - others coming soon...maybe +package database + +import ( + "log" + + "git.runcible.io/androiddrew/flux-feed/config" + "github.com/jmoiron/sqlx" +) + +// NewSqlx configures a new sqlx.DB from application config +func NewSqlx(cfg config.Database) *sqlx.DB { + var dsn string + + // TODO add additional database driver support + switch cfg.DatabaseDriver { + case "sqlite3": + dsn = cfg.DatabaseDSN + default: + log.Fatal("Must choose a database driver") + + } + + db := sqlx.MustConnect(cfg.DatabaseDriver, dsn) + + return db + +} diff --git a/go.mod b/go.mod index aa70edb..9a74ba8 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,17 @@ -module git.runcible.io/androiddrew/fluxfeed +module git.runcible.io/androiddrew/flux-feed go 1.22.5 + +require ( + github.com/golang-migrate/migrate/v4 v4.17.1 + github.com/jmoiron/sqlx v1.4.0 + github.com/joho/godotenv v1.5.1 + github.com/kelseyhightower/envconfig v1.4.0 + github.com/mattn/go-sqlite3 v1.14.22 +) + +require ( + github.com/hashicorp/errwrap v1.1.0 // indirect + github.com/hashicorp/go-multierror v1.1.1 // indirect + go.uber.org/atomic v1.7.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..73dd23f --- /dev/null +++ b/go.sum @@ -0,0 +1,34 @@ +filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= +filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y= +github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg= +github.com/golang-migrate/migrate/v4 v4.17.1 h1:4zQ6iqL6t6AiItphxJctQb3cFqWiSpMnX7wLTPnnYO4= +github.com/golang-migrate/migrate/v4 v4.17.1/go.mod h1:m8hinFyWBn0SA4QKHuKh175Pm9wjmxj3S2Mia7dbXzM= +github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= +github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= +github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= +github.com/jmoiron/sqlx v1.4.0 h1:1PLqN7S1UYp5t4SrVVnt4nUVNemrDAtxlulVe+Qgm3o= +github.com/jmoiron/sqlx v1.4.0/go.mod h1:ZrZ7UsYB/weZdl2Bxg6jCRO9c3YHl8r3ahlKmRT4JLY= +github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= +github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= +github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8= +github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg= +github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw= +github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= +github.com/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o4kU= +github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= +github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw= +go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/main.go b/main.go deleted file mode 100644 index ead7e6a..0000000 --- a/main.go +++ /dev/null @@ -1,17 +0,0 @@ -package main - -import ( - "fmt" - "io" - "os" -) - -const FluxGreeting string = "Welcome to Flux Feed\n" - -func HelloFluxFeed(out io.Writer) { - fmt.Fprint(out, FluxGreeting) -} - -func main() { - HelloFluxFeed(os.Stdout) -} diff --git a/main_test.go b/main_test.go deleted file mode 100644 index 66d6cfc..0000000 --- a/main_test.go +++ /dev/null @@ -1,18 +0,0 @@ -package main - -import ( - "bytes" - "testing" -) - -func TestCliGreeting(t *testing.T) { - buffer := &bytes.Buffer{} - - HelloFluxFeed(buffer) - got := buffer.String() - want := FluxGreeting - - if got != want { - t.Errorf("Got %s but wanted %s", got, want) - } -} diff --git a/migrations/10_initial_schema.down.sql b/migrations/10_initial_schema.down.sql new file mode 100644 index 0000000..a5875e4 --- /dev/null +++ b/migrations/10_initial_schema.down.sql @@ -0,0 +1,3 @@ +DROP TABLE IF EXISTS user; +DROP TABLE IF EXISTS feed; +DROP TABLE IF EXISTS entry; \ No newline at end of file diff --git a/migrations/10_initial_schema.up.sql b/migrations/10_initial_schema.up.sql new file mode 100644 index 0000000..9b9013b --- /dev/null +++ b/migrations/10_initial_schema.up.sql @@ -0,0 +1,72 @@ +PRAGMA foreign_keys=1; +CREATE TABLE user ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + email TEXT UNIQUE NOT NULL, + password TEXT NOT NULL, + kindle_email TEXT +); + +CREATE TABLE feed ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + user_id INTEGER UNIQUE NOT NULL, + url TEXT, + type TEXT NOT NULL, + name TEXT UNIQUE, + icon_url TEXT, + created TIMESTAMP NOT NULL, + updated TIMESTAMP NOT NULL, + last_fetch TIMESTAMP, + raw_data TEXT, + folder TEXT, + etag TEXT, + modified_header TEXT, + filters TEXT, + FOREIGN KEY(user_id) REFERENCES user(id) +); + +CREATE TABLE entry ( + id INTEGER PRIMARY KEY AUTOINCREMENT, + feed_id INTEGER UNIQUE, + user_id INTEGER NOT NULL, + remote_id TEXT UNIQUE NOT NULL, + title TEXT, + username TEXT, + user_url TEXT, + display_name TEXT, + avatar_url TEXT, + content_short TEXT, + content_full TEXT, + target_url TEXT, + content_url TEXT, + comments_url TEXT, + media_url TEXT, + created TIMESTAMP NOT NULL, + updated TIMESTAMP NOT NULL, + display_date TIMESTAMP NOT NULL, + sort_date TIMESTAMP NOT NULL, + viewed TIMESTAMP, + favorited TIMESTAMP, + pinned TIMESTAMP, + sent_to_kindle TIMESTAMP, + raw_data TEXT, + header TEXT, + icon_url TEXT, + FOREIGN KEY(feed_id) REFERENCES feed(id), + FOREIGN KEY(user_id) REFERENCES user(id) +); + + +CREATE INDEX ix_feed_folder ON feed(folder); +CREATE INDEX ix_feed_user_id ON feed(user_id); +CREATE INDEX ix_name_user ON feed(user_id, name); +CREATE INDEX ix_feed_created ON feed(created); + +CREATE INDEX ix_entry_favorited ON entry(favorited); +CREATE INDEX ix_entry_created ON entry(created); +CREATE INDEX ix_entry_sort_date ON entry(sort_date); +CREATE INDEX ix_entry_sent_to_kindle ON entry(sent_to_kindle); +CREATE INDEX entry_sort_ts ON entry(sort_date DESC); +CREATE INDEX ix_entry_viewed ON entry(viewed); +CREATE INDEX ix_entry_pinned ON entry(pinned); +CREATE INDEX ix_entry_user_id ON entry(user_id); +CREATE INDEX ix_entry_username ON entry(username);