Initial commit

.gitignore

@@ -0,0 +1,2 @@
+cover.out
+cover.html

.golangci.yaml

@@ -0,0 +1,38 @@
+linters:
+  enable-all: true
+  disable:
+    # re-enable when working
+    - rowserrcheck
+    - wastedassign
+    # maybe enable these
+    - wrapcheck
+    # leave these disabled
+    - cyclop
+    - deadcode
+    - dupl
+    - exhaustivestruct
+    - exhaustruct
+    - forbidigo
+    - forcetypeassert
+    - funlen
+    - gochecknoglobals
+    - gocognit
+    - goconst
+    - godox
+    - golint
+    - gomnd
+    - ifshort
+    - interfacer
+    - lll
+    - maintidx
+    - maligned
+    - nilnil
+    - nestif
+    - nlreturn
+    - nolintlint
+    - nosnakecase
+    - scopelint
+    - structcheck
+    - thelper
+    - varcheck
+    - varnamelen

go.mod

@@ -0,0 +1,17 @@
+module github.com/gopatchy/store
+
+go 1.19
+
+require (
+	github.com/gopatchy/metadata v0.0.0-20230420053349-25837551c11d
+	github.com/mattn/go-sqlite3 v1.14.16
+	github.com/stretchr/testify v1.8.2
+	go.uber.org/goleak v1.2.1
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,28 @@
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+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/gopatchy/metadata v0.0.0-20230420053349-25837551c11d h1:chunoM47vkWSanIvLx4uRSkLMG6chDZOy09L2tt/bv8=
+github.com/gopatchy/metadata v0.0.0-20230420053349-25837551c11d/go.mod h1:VgD33raUShjDePCDBo55aj+eSXFtUEpMzs+Ie39g2zo=
+github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mattn/go-sqlite3 v1.14.16 h1:yOQRA0RpS5PFz/oikGwBEqvAWhWg5ufRz4ETLjwpU1Y=
+github.com/mattn/go-sqlite3 v1.14.16/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
+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/rogpeppe/go-internal v1.8.1-0.20211023094830-115ce09fd6b4 h1:Ha8xCaq6ln1a+R91Km45Oq6lPXj2Mla6CRJYcuV2h1w=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+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.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+go.uber.org/goleak v1.2.1 h1:NBol2c7O1ZokfZ0LEU9K6Whx/KnwvepVetCUhtKja4A=
+go.uber.org/goleak v1.2.1/go.mod h1:qlT2yGI9QafXHhZZLxlSuNsMw3FFLxBr+tBRlmO1xH4=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

justfile

@@ -0,0 +1,18 @@
+go := env_var_or_default('GOCMD', 'go')
+
+default: tidy test
+
+tidy:
+	{{go}} mod tidy
+	goimports -l -w .
+	gofumpt -l -w .
+	{{go}} fmt ./...
+
+test:
+	{{go}} vet ./...
+	golangci-lint run ./...
+	{{go}} test -race -coverprofile=cover.out -timeout=60s -parallel=10 ./...
+	{{go}} tool cover -html=cover.out -o=cover.html
+
+todo:
+	-git grep -e TODO --and --not -e ignoretodo

pkg_test.go

@@ -0,0 +1,11 @@
+package store_test
+
+import (
+	"testing"
+
+	"go.uber.org/goleak"
+)
+
+func TestMain(m *testing.M) {
+	goleak.VerifyTestMain(m)
+}

sqlitestore.go

@@ -0,0 +1,160 @@
+package store
+
+import (
+	"context"
+	"database/sql"
+	"encoding/json"
+	"fmt"
+
+	"github.com/gopatchy/metadata"
+	// Register sqlite3 db handler.
+	_ "github.com/mattn/go-sqlite3"
+)
+
+type SQLiteStore struct {
+	db *sql.DB
+}
+
+func NewSQLiteStore(conn string) (*SQLiteStore, error) {
+	db, err := sql.Open("sqlite3", conn)
+	if err != nil {
+		return nil, err
+	}
+
+	// TODO: Keep a set of prepared statements with PrepareContext()
+	// TODO: Consider tuning per https://phiresky.github.io/blog/2020/sqlite-performance-tuning/
+
+	return &SQLiteStore{
+		db: db,
+	}, nil
+}
+
+func (sls *SQLiteStore) Close() {
+	sls.db.Close()
+}
+
+func (sls *SQLiteStore) Write(ctx context.Context, t string, obj any) error {
+	id := metadata.GetMetadata(obj).ID
+
+	js, err := json.Marshal(obj)
+	if err != nil {
+		return err
+	}
+
+	err = sls.exec(ctx, "INSERT INTO `%s` (id, obj) VALUES (?,?) ON CONFLICT(id) DO UPDATE SET obj=?;", t, id, js, js)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (sls *SQLiteStore) Delete(ctx context.Context, t, id string) error {
+	err := sls.exec(ctx, "DELETE FROM `%s` WHERE id=?", t, id)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (sls *SQLiteStore) Read(ctx context.Context, t, id string, factory func() any) (any, error) {
+	rows, err := sls.query(ctx, "SELECT obj FROM `%s` WHERE id=?;", t, id)
+	if err != nil {
+		return nil, err
+	}
+
+	defer rows.Close()
+
+	if !rows.Next() {
+		return nil, nil
+	}
+
+	var js []byte
+
+	err = rows.Scan(&js)
+	if err != nil {
+		return nil, err
+	}
+
+	obj := factory()
+
+	err = json.Unmarshal(js, obj)
+	if err != nil {
+		return nil, err
+	}
+
+	return obj, nil
+}
+
+func (sls *SQLiteStore) List(ctx context.Context, t string, factory func() any) ([]any, error) {
+	rows, err := sls.query(ctx, "SELECT obj FROM `%s`;", t)
+	if err != nil {
+		return nil, err
+	}
+
+	defer rows.Close()
+
+	ret := []any{}
+
+	for rows.Next() {
+		var js []byte
+
+		err = rows.Scan(&js)
+		if err != nil {
+			return nil, err
+		}
+
+		obj := factory()
+
+		err = json.Unmarshal(js, obj)
+		if err != nil {
+			return nil, err
+		}
+
+		ret = append(ret, obj)
+	}
+
+	return ret, nil
+}
+
+func (sls *SQLiteStore) exec(ctx context.Context, query, t string, args ...any) error {
+	query = fmt.Sprintf(query, t)
+
+	_, err := sls.db.ExecContext(ctx, query, args...)
+	if err == nil {
+		return nil
+	}
+
+	_, err = sls.db.ExecContext(ctx, sls.tableSQL(t))
+	if err != nil {
+		return err
+	}
+
+	_, err = sls.db.ExecContext(ctx, query, args...)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (sls *SQLiteStore) query(ctx context.Context, query, t string, args ...any) (*sql.Rows, error) {
+	query = fmt.Sprintf(query, t)
+
+	rows, err := sls.db.QueryContext(ctx, query, args...)
+	if err == nil {
+		return rows, nil
+	}
+
+	_, err = sls.db.ExecContext(ctx, sls.tableSQL(t))
+	if err != nil {
+		return nil, err
+	}
+
+	return sls.db.QueryContext(ctx, query, args...)
+}
+
+func (sls *SQLiteStore) tableSQL(t string) string {
+	return fmt.Sprintf("CREATE TABLE IF NOT EXISTS `%s` (id TEXT NOT NULL PRIMARY KEY, obj TEXT NOT NULL);", t)
+}

sqlitestore_test.go

@@ -0,0 +1,41 @@
+package store_test
+
+import (
+	"testing"
+
+	"github.com/gopatchy/store"
+	"github.com/stretchr/testify/require"
+)
+
+func TestSQLiteStore(t *testing.T) {
+	t.Parallel()
+
+	st, err := store.NewSQLiteStore("file:testStore?mode=memory&cache=shared")
+	require.NoError(t, err)
+
+	defer st.Close()
+
+	testStorer(t, st)
+}
+
+func TestSQLiteDelete(t *testing.T) {
+	t.Parallel()
+
+	st, err := store.NewSQLiteStore("file:testDelete?mode=memory&cache=shared")
+	require.NoError(t, err)
+
+	defer st.Close()
+
+	testDelete(t, st)
+}
+
+func TestSQLiteList(t *testing.T) {
+	t.Parallel()
+
+	st, err := store.NewSQLiteStore("file:testList?mode=memory&cache=shared")
+	require.NoError(t, err)
+
+	defer st.Close()
+
+	testList(t, st)
+}

storer.go

@@ -0,0 +1,11 @@
+package store
+
+import "context"
+
+type Storer interface {
+	Close()
+	Write(context.Context, string, any) error
+	Delete(context.Context, string, string) error
+	Read(context.Context, string, string, func() any) (any, error)
+	List(context.Context, string, func() any) ([]any, error)
+}

storer_test.go

@@ -0,0 +1,109 @@
+package store_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/gopatchy/metadata"
+	"github.com/gopatchy/store"
+	"github.com/stretchr/testify/require"
+)
+
+func testStorer(t *testing.T, st store.Storer) {
+	ctx := context.Background()
+
+	err := st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id1",
+		},
+		Opaque: "foo",
+	})
+	require.NoError(t, err)
+
+	err = st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id2",
+		},
+		Opaque: "bar",
+	})
+	require.NoError(t, err)
+
+	err = st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id2",
+		},
+		Opaque: "zig",
+	})
+	require.NoError(t, err)
+
+	out1, err := st.Read(ctx, "storeTest", "id1", newStoreTest)
+	require.NoError(t, err)
+	require.NotNil(t, out1)
+	require.Equal(t, "foo", out1.(*storeTest).Opaque)
+
+	out2, err := st.Read(ctx, "storeTest", "id2", newStoreTest)
+	require.NoError(t, err)
+	require.NotNil(t, out1)
+	require.Equal(t, "zig", out2.(*storeTest).Opaque)
+}
+
+func testDelete(t *testing.T, st store.Storer) {
+	ctx := context.Background()
+
+	err := st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id1",
+		},
+		Opaque: "foo",
+	})
+	require.NoError(t, err)
+
+	out1, err := st.Read(ctx, "storeTest", "id1", newStoreTest)
+	require.NoError(t, err)
+	require.Equal(t, "foo", out1.(*storeTest).Opaque)
+
+	err = st.Delete(ctx, "storeTest", "id1")
+	require.NoError(t, err)
+
+	out2, err := st.Read(ctx, "storeTest", "id1", newStoreTest)
+	require.NoError(t, err)
+	require.Nil(t, out2)
+}
+
+func testList(t *testing.T, st store.Storer) {
+	ctx := context.Background()
+
+	objs, err := st.List(ctx, "storeTest", func() any { return &storeTest{} })
+	require.NoError(t, err)
+	require.Len(t, objs, 0)
+
+	err = st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id1",
+		},
+		Opaque: "foo",
+	})
+	require.NoError(t, err)
+
+	err = st.Write(ctx, "storeTest", &storeTest{
+		Metadata: metadata.Metadata{
+			ID: "id2",
+		},
+		Opaque: "bar",
+	})
+	require.NoError(t, err)
+
+	objs, err = st.List(ctx, "storeTest", func() any { return &storeTest{} })
+	require.NoError(t, err)
+	require.Len(t, objs, 2)
+	require.ElementsMatch(t, []string{"foo", "bar"}, []string{objs[0].(*storeTest).Opaque, objs[1].(*storeTest).Opaque})
+}
+
+type storeTest struct {
+	metadata.Metadata
+	Opaque string
+}
+
+func newStoreTest() any {
+	return &storeTest{}
+}