Move front and back into internal

2020-10-11 12:21:17 -06:00
parent 1d8694846f
commit 6c885d25c2
6 changed files with 4 additions and 5 deletions
--- a/internal/back/genstring.go
+++ b/internal/back/genstring.go
@ -0,0 +1,27 @@
+package back
+
+import (
+	"bytes"
+	"crypto/rand"
+	"math/big"
+)
+
+var chars = []byte("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
+
+func SecureGenString(length int) (string, error) {
+	charsLength := big.NewInt(int64(len(chars)))
+	var maxN big.Int
+	maxN.Exp(charsLength, big.NewInt(int64(length)), nil)
+	n, err := rand.Int(rand.Reader, &maxN)
+	if err != nil {
+		return "", err
+	}
+
+	var buf bytes.Buffer
+	for n.Cmp(&big.Int{}) == 1 {
+		var charIdx big.Int
+		n.DivMod(n, charsLength, &charIdx)
+		_ = buf.WriteByte(chars[charIdx.Int64()])
+	}
+	return buf.String(), nil
+}
--- a/internal/back/store.go
+++ b/internal/back/store.go
@ -0,0 +1,430 @@
+package back
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"log"
+	"os"
+
+	"crawshaw.io/sqlite"
+	"crawshaw.io/sqlite/sqlitex"
+	"github.com/rickb777/date"
+)
+
+var ErrNotFound = errors.New("not found")
+
+type UnauthorizedError struct {
+	EventID   string
+	AdminCode string
+}
+
+func (u UnauthorizedError) Error() string {
+	return fmt.Sprintf("unauthorized: EventID = %s, AdminCode = %s", u.EventID, u.AdminCode)
+}
+
+type GenString func(length int) (string, error)
+
+type Store struct {
+	pool      *sqlitex.Pool
+	genString GenString
+}
+
+func NewStore(filename string, genString GenString) (*Store, error) {
+	var needCreate bool
+	if _, err := os.Stat(filename); os.IsNotExist(err) {
+		needCreate = true
+	}
+	// If the file exists, then assume it was created properly.
+
+	pool, err := sqlitex.Open(filename, 0, 10)
+	if err != nil {
+		return nil, err
+	}
+	store := &Store{
+		pool:      pool,
+		genString: genString,
+	}
+	if needCreate {
+		log.Println("creating schema")
+		err = store.createSchema()
+		if err != nil {
+			defer pool.Close()
+			return nil, err
+		}
+	}
+
+	return store, nil
+}
+
+func NewMemoryStore(genString GenString) (*Store, error) {
+	pool, err := sqlitex.Open("file::memory:?mode=memory&cache=shared", 0, 10)
+	if err != nil {
+		return nil, err
+	}
+	store := &Store{
+		pool:      pool,
+		genString: genString,
+	}
+
+	err = store.createSchema()
+	if err != nil {
+		defer pool.Close()
+		return nil, err
+	}
+	return store, nil
+}
+
+func (s *Store) Close() error {
+	return s.pool.Close()
+}
+
+const schema = `
+	CREATE TABLE event (
+		id TEXT NOT NULL PRIMARY KEY,
+		admin_code TEXT NOT NULL,
+		name TEXT NOT NULL,
+		description TEXT NOT NULL,
+		earliest_date DATE NOT NULL,
+		latest_date DATE NOT NULL
+	);
+
+	CREATE TABLE response (
+		id TEXT NOT NULL,
+		event_id TEXT NOT NULL,
+		guest_name TEXT NOT NULL,
+
+		PRIMARY KEY (id, event_id),
+		FOREIGN KEY (event_id) REFERENCES event(id)
+	);
+
+	CREATE TABLE response_time (
+		event_id TEXT NOT NULL,
+		response_id TEXT NOT NULL,
+		date DATE NOT NULL,
+		time INTEGER NOT NULL,
+
+		CHECK (0 <= time < 24),
+		UNIQUE (response_id, date, time),
+		FOREIGN KEY(event_id, response_id) REFERENCES response(event_id, id)
+	);
+	
+	CREATE TRIGGER enforce_valid_response_dates
+	BEFORE INSERT ON response_time
+	BEGIN
+		SELECT
+			CASE
+				WHEN NEW.date NOT BETWEEN event.earliest_date AND event.latest_date
+					THEN RAISE(ABORT, 'response date is out of range')
+			END
+		FROM response
+		JOIN event ON response.event_id = event.id
+		WHERE response.id = NEW.response_id;
+	END;`
+
+func (s *Store) createSchema() error {
+	conn := s.pool.Get(context.Background())
+	defer s.pool.Put(conn)
+	return sqlitex.ExecScript(conn, schema)
+}
+
+type CreateEventCommand struct {
+	Name             string
+	Description      string
+	Earliest, Latest date.Date
+}
+
+type CreateEventResult struct {
+	EventID, AdminCode string
+}
+
+const dbDateLayout = "2006-01-02"
+
+func (s *Store) CreateEvent(ctx context.Context, cmd CreateEventCommand) (result CreateEventResult, err error) {
+	const idLength = 10
+	const adminCodeLength = 10
+
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	id, err := s.genString(idLength)
+	if err != nil {
+		return
+	}
+
+	adminCode, err := s.genString(adminCodeLength)
+	if err != nil {
+		return
+	}
+
+	const query = `
+		INSERT INTO event(id, admin_code, name, description, earliest_date, latest_date)
+		VALUES (?, ?, ?, ?, ?, ?);`
+	err = sqlitex.Exec(conn, query, nil,
+		id,
+		adminCode,
+		cmd.Name,
+		cmd.Description,
+		cmd.Earliest.Format(dbDateLayout),
+		cmd.Latest.Format(dbDateLayout),
+	)
+	if err != nil {
+		return
+	}
+
+	result.AdminCode = adminCode
+	result.EventID = id
+	return
+}
+
+type CheckEventAdminCodeQuery struct {
+	EventID   string
+	AdminCode string
+}
+
+func (s *Store) AuthorizeEventAdmin(ctx context.Context, query CheckEventAdminCodeQuery) error {
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	const dbQuery = `
+		SELECT 1
+		FROM event
+		WHERE id = ? AND admin_code = ?;`
+	var doesMatch bool
+	err := sqlitex.Exec(conn, dbQuery,
+		func(stmt *sqlite.Stmt) error {
+			doesMatch = true
+			return nil
+		}, query.EventID, query.AdminCode)
+	if err != nil {
+		return err
+	}
+	if !doesMatch {
+		return UnauthorizedError{
+			EventID:   query.EventID,
+			AdminCode: query.AdminCode,
+		}
+	}
+	return nil
+}
+
+type GetEventMetadataQuery struct {
+	EventID string
+}
+
+type GetEventMetadataResult struct {
+	Name             string
+	Description      string
+	Earliest, Latest date.Date
+}
+
+func (s *Store) GetEventMetadata(ctx context.Context, query GetEventMetadataQuery) (GetEventMetadataResult, error) {
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	const dbQuery = `
+		SELECT name, description, earliest_date, latest_date
+		FROM event
+		WHERE id = ?;`
+	var result GetEventMetadataResult
+	var found bool
+	err := sqlitex.Exec(conn, dbQuery,
+		func(stmt *sqlite.Stmt) error {
+			found = true
+
+			result.Name = stmt.ColumnText(0)
+			result.Description = stmt.ColumnText(1)
+			earliestDateString := stmt.ColumnText(2)
+			latestDateString := stmt.ColumnText(3)
+
+			var err error
+			result.Earliest, err = date.Parse(dbDateLayout, earliestDateString)
+			if err != nil {
+				return err
+			}
+			result.Latest, err = date.Parse(dbDateLayout, latestDateString)
+			return err
+		}, query.EventID)
+	if err != nil {
+		return GetEventMetadataResult{}, err
+	}
+	if !found {
+		return GetEventMetadataResult{}, ErrNotFound
+	}
+	return result, nil
+}
+
+type GetEventResponseSummaryQuery struct {
+	EventID string
+}
+
+type GetEventResponseSummaryResult struct {
+	RespondentNames []string
+	PerHourCounts   map[date.Date]map[int]int
+}
+
+func (s *Store) GetEventResponseSummary(ctx context.Context, query GetEventResponseSummaryQuery) (GetEventResponseSummaryResult, error) {
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	var found bool
+
+	const eventIDQuery = `
+		SELECT 1
+		FROM event
+		WHERE id = ?`
+	var err = sqlitex.Exec(conn, eventIDQuery,
+		func(stmt *sqlite.Stmt) error {
+			found = true
+			return nil
+		}, query.EventID)
+	if err != nil {
+		return GetEventResponseSummaryResult{}, err
+	}
+	if !found {
+		return GetEventResponseSummaryResult{}, ErrNotFound
+	}
+
+	var result GetEventResponseSummaryResult
+	const respondentNameQuery = `
+		SELECT guest_name
+		FROM response
+		WHERE event_id = ?
+		ORDER BY guest_name ASC;`
+	err = sqlitex.Exec(conn, respondentNameQuery,
+		func(stmt *sqlite.Stmt) error {
+			result.RespondentNames = append(result.RespondentNames, stmt.ColumnText(0))
+			return nil
+		}, query.EventID)
+	if err != nil {
+		return GetEventResponseSummaryResult{}, err
+	}
+
+	result.PerHourCounts = make(map[date.Date]map[int]int)
+	const perHourCountQuery = `
+		SELECT date, time, COUNT(*)
+		FROM response_time
+		WHERE event_id = ?
+		GROUP BY date, time;`
+	err = sqlitex.Exec(conn, perHourCountQuery,
+		func(stmt *sqlite.Stmt) error {
+			d, err := date.Parse(dbDateLayout, stmt.ColumnText(0))
+			if err != nil {
+				return err
+			}
+			if result.PerHourCounts[d] == nil {
+				result.PerHourCounts[d] = make(map[int]int)
+			}
+			result.PerHourCounts[d][stmt.ColumnInt(1)] = stmt.ColumnInt(2)
+			return nil
+		}, query.EventID)
+	if err != nil {
+		return GetEventResponseSummaryResult{}, err
+	}
+	return result, nil
+}
+
+type CreateEventResponseCommand struct {
+	EventID   string
+	GuestName string
+	DateHours map[date.Date]map[int]struct{}
+}
+
+type CreateEventResponseResult struct {
+	ResponseID string
+}
+
+func (s *Store) CreateEventResponse(ctx context.Context, cmd CreateEventResponseCommand) (result CreateEventResponseResult, err error) {
+	const responseIDLength = 10
+
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	defer sqlitex.Save(conn)(&err)
+	responseID, err := s.genString(responseIDLength)
+	if err != nil {
+		return
+	}
+
+	const responseQuery = `
+		INSERT INTO response(event_id, id, guest_name)
+		VALUES (?, ?, ?);`
+	err = sqlitex.Exec(conn, responseQuery, nil, cmd.EventID, responseID, cmd.GuestName)
+	if err != nil {
+		return
+	}
+
+	const responseTimeQuery = `
+		INSERT INTO response_time(event_id, response_id, date, time)
+		VALUES (?, ?, ?, ?);`
+	for d, hs := range cmd.DateHours {
+		for h := range hs {
+			err = sqlitex.Exec(conn, responseTimeQuery, nil,
+				cmd.EventID, responseID, d.Format(dbDateLayout), h)
+			if err != nil {
+				return
+			}
+		}
+	}
+
+	return CreateEventResponseResult{
+		ResponseID: responseID,
+	}, nil
+}
+
+type GetEventResponseQuery struct {
+	EventID    string
+	ResponseID string
+}
+
+type GetEventResponseResult struct {
+	GuestName string
+	DateHours map[date.Date]map[int]struct{}
+}
+
+func (s *Store) GetEventResponse(ctx context.Context, query GetEventResponseQuery) (GetEventResponseResult, error) {
+	conn := s.pool.Get(ctx)
+	defer s.pool.Put(conn)
+
+	var found bool
+	var result GetEventResponseResult
+
+	const responseQuery = `
+		SELECT guest_name
+		FROM response
+		WHERE id = ? AND event_id = ?;`
+	var err = sqlitex.Exec(conn, responseQuery,
+		func(stmt *sqlite.Stmt) error {
+			found = true
+			result.GuestName = stmt.ColumnText(0)
+			return nil
+		}, query.ResponseID, query.EventID)
+	if err != nil {
+		return GetEventResponseResult{}, err
+	}
+	if !found {
+		return GetEventResponseResult{}, ErrNotFound
+	}
+
+	result.DateHours = make(map[date.Date]map[int]struct{})
+	const responseTimeQuery = `
+		SELECT date, time
+		FROM response_time
+		WHERE  event_id = ? AND response_id = ?`
+	err = sqlitex.Exec(conn, responseTimeQuery,
+		func(stmt *sqlite.Stmt) error {
+			d, err := date.Parse(dbDateLayout, stmt.ColumnText(0))
+			if err != nil {
+				return err
+			}
+			if result.DateHours[d] == nil {
+				result.DateHours[d] = make(map[int]struct{})
+			}
+			result.DateHours[d][stmt.ColumnInt(1)] = struct{}{}
+			return nil
+		}, query.EventID, query.ResponseID)
+	if err != nil {
+		return GetEventResponseResult{}, err
+	}
+	return result, nil
+}
--- a/internal/back/store_test.go
+++ b/internal/back/store_test.go
@ -0,0 +1,302 @@
+package back_test
+
+import (
+	"context"
+	"math/rand"
+	"sort"
+	"testing"
+	"time"
+
+	"github.com/matryer/is"
+	"github.com/rickb777/date"
+	"gitlab.codemonkeysoftware.net/b/henwen/internal/back"
+)
+
+func TestNewMemoryStore(t *testing.T) {
+	is := is.New(t)
+	store, err := back.NewMemoryStore(back.SecureGenString)
+	is.NoErr(err)
+	is.True(store != nil)
+	store.Close()
+}
+
+func TestCreateEvent(t *testing.T) {
+	is := is.New(t)
+	store, err := back.NewMemoryStore(back.SecureGenString)
+	is.NoErr(err)
+	defer store.Close()
+
+	earliest := date.New(2020, 4, 5)
+	latest := date.New(2020, 4, 5)
+	const name = "abc"
+	const description = "def"
+	createResult, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+		Name:        name,
+		Description: description,
+		Earliest:    earliest,
+		Latest:      latest,
+	})
+	is.NoErr(err)
+
+	metadataResult, err := store.GetEventMetadata(context.Background(), back.GetEventMetadataQuery{
+		EventID: createResult.EventID,
+	})
+	is.NoErr(err)
+	is.Equal(metadataResult.Name, name)
+	is.Equal(metadataResult.Description, description)
+	is.True(metadataResult.Earliest.Equal(earliest))
+	is.True(metadataResult.Latest.Equal(latest))
+}
+
+func TestGetEventResponseSummary(t *testing.T) {
+	store, err := back.NewMemoryStore(back.SecureGenString)
+	is.New(t).NoErr(err)
+	defer store.Close()
+
+	createEvent := func(is *is.I) (eventID string) {
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "blah",
+			Description: "stuff happening",
+			Earliest:    date.Today(),
+			Latest:      date.Today().Add(1),
+		})
+		is.NoErr(err)
+		return event.EventID
+	}
+
+	t.Run("does not include responses to other events", func(t *testing.T) {
+		is := is.New(t)
+
+		d := date.New(1999, 12, 31)
+		wrongEvent, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "Beach party",
+			Description: "Come on in! The water's fine!",
+			Earliest:    d,
+			Latest:      d,
+		})
+		is.NoErr(err)
+
+		_, err = store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+			EventID:   wrongEvent.EventID,
+			GuestName: "Matt Hooper",
+			DateHours: map[date.Date]map[int]struct{}{d: {0: {}}},
+		})
+		is.NoErr(err)
+
+		summary, err := store.GetEventResponseSummary(context.Background(), back.GetEventResponseSummaryQuery{
+			EventID: createEvent(is),
+		})
+		is.NoErr(err)
+
+		is.Equal(summary, back.GetEventResponseSummaryResult{
+			RespondentNames: nil,
+			PerHourCounts:   map[date.Date]map[int]int{},
+		})
+	})
+
+	t.Run("RespondentNames lists all respondents alphabetically", func(t *testing.T) {
+		is := is.New(t)
+
+		var names = []string{"a", "b", "c", "d", "e", "f", "g", "h", "i", "j"}
+		rand.Shuffle(len(names), func(i, j int) {
+			names[i], names[j] = names[j], names[i]
+		})
+
+		d := date.New(1963, time.May, 1)
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "It's my party!",
+			Description: "I can cry if I want to.",
+			Latest:      d,
+			Earliest:    d,
+		})
+		is.NoErr(err)
+
+		for _, name := range names {
+			_, err = store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+				EventID:   event.EventID,
+				GuestName: name,
+			})
+			is.NoErr(err)
+		}
+
+		summary, err := store.GetEventResponseSummary(context.Background(), back.GetEventResponseSummaryQuery{
+			EventID: event.EventID,
+		})
+		is.NoErr(err)
+
+		sort.Strings(names)
+		is.Equal(summary.RespondentNames, names)
+	})
+
+	t.Run("PerHourCounts counts votes per hour", func(t *testing.T) {
+		is := is.New(t)
+
+		dayOne := date.New(2012, 12, 21)
+		dayTwo := dayOne.Add(1)
+		createResult, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "Apocalypse",
+			Description: "It's over.",
+			Earliest:    dayOne,
+			Latest:      dayTwo,
+		})
+		is.NoErr(err)
+
+		_, err = store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+			EventID:   createResult.EventID,
+			GuestName: "Thanos",
+			DateHours: map[date.Date]map[int]struct{}{
+				dayOne: {0: {}, 1: {}, 2: {}, 3: {}},
+				dayTwo: {1: {}, 2: {}, 3: {}, 4: {}},
+			},
+		})
+		is.NoErr(err)
+
+		_, err = store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+			EventID:   createResult.EventID,
+			GuestName: "Magog",
+			DateHours: map[date.Date]map[int]struct{}{
+				dayOne: {1: {}, 2: {}, 3: {}, 4: {}},
+				dayTwo: {2: {}, 3: {}, 4: {}, 5: {}},
+			},
+		})
+		is.NoErr(err)
+
+		summary, err := store.GetEventResponseSummary(context.Background(), back.GetEventResponseSummaryQuery{
+			EventID: createResult.EventID,
+		})
+		is.NoErr(err)
+		is.Equal(summary.PerHourCounts, map[date.Date]map[int]int{
+			dayOne: {0: 1, 1: 2, 2: 2, 3: 2, 4: 1},
+			dayTwo: {1: 1, 2: 2, 3: 2, 4: 2, 5: 1},
+		})
+	})
+}
+
+func TestCreateEventResponse(t *testing.T) {
+	store, err := back.NewMemoryStore(back.SecureGenString)
+	is.New(t).NoErr(err)
+	defer store.Close()
+
+	createEvent := func(is *is.I) (eventID string) {
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "blah",
+			Description: "stuff happening",
+			Earliest:    date.Today(),
+			Latest:      date.Today().Add(1),
+		})
+		is.NoErr(err)
+		return event.EventID
+	}
+
+	t.Run("saves GuestName", func(t *testing.T) {
+		is := is.New(t)
+		eventID := createEvent(is)
+
+		const guestName = "Etaoin Shrdlu"
+		createResult, err := store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+			EventID:   eventID,
+			GuestName: guestName,
+		})
+		is.NoErr(err)
+
+		getResult, err := store.GetEventResponse(context.Background(), back.GetEventResponseQuery{
+			EventID:    eventID,
+			ResponseID: createResult.ResponseID,
+		})
+		is.NoErr(err)
+		is.Equal(getResult.GuestName, guestName)
+	})
+
+	t.Run("DateHours saves multiple times on multiple dates", func(t *testing.T) {
+		is := is.New(t)
+
+		earliest := date.Today()
+		latest := earliest.Add(1)
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "blah",
+			Description: "stuff happening",
+			Earliest:    earliest,
+			Latest:      latest,
+		})
+		is.NoErr(err)
+
+		var dateHours = map[date.Date]map[int]struct{}{
+			earliest: {1: {}, 3: {}, 5: {}, 7: {}},
+			latest:   {2: {}, 4: {}, 6: {}},
+		}
+		createResponseResult, err := store.CreateEventResponse(context.Background(), back.CreateEventResponseCommand{
+			EventID:   event.EventID,
+			GuestName: "Etaoin Shrdlu",
+			DateHours: dateHours,
+		})
+		is.NoErr(err)
+
+		response, err := store.GetEventResponse(context.Background(), back.GetEventResponseQuery{
+			EventID:    event.EventID,
+			ResponseID: createResponseResult.ResponseID,
+		})
+		is.NoErr(err)
+		is.Equal(dateHours, response.DateHours)
+	})
+}
+
+func TestAuthorizeEventAdmin(t *testing.T) {
+	store, err := back.NewMemoryStore(back.SecureGenString)
+	is.New(t).NoErr(err)
+	defer store.Close()
+
+	t.Run("returns ErrUnauthorized if admin code is wrong", func(t *testing.T) {
+		is := is.New(t)
+
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "my event",
+			Description: "stuff happening",
+			Earliest:    date.Today(),
+			Latest:      date.Today(),
+		})
+		is.NoErr(err)
+
+		badAdminCode := event.AdminCode + "x"
+		err = store.AuthorizeEventAdmin(context.Background(), back.CheckEventAdminCodeQuery{
+			EventID:   event.EventID,
+			AdminCode: badAdminCode,
+		})
+		is.Equal(err, back.UnauthorizedError{
+			EventID:   event.EventID,
+			AdminCode: badAdminCode,
+		})
+	})
+
+	t.Run("return ErrUnauthorized if event does not exist", func(t *testing.T) {
+		is := is.New(t)
+
+		randString, err := back.SecureGenString(10)
+		is.NoErr(err)
+		err = store.AuthorizeEventAdmin(context.Background(), back.CheckEventAdminCodeQuery{
+			EventID:   randString,
+			AdminCode: randString,
+		})
+		is.Equal(err, back.UnauthorizedError{
+			EventID:   randString,
+			AdminCode: randString,
+		})
+	})
+
+	t.Run("returns nil if admin code is correct", func(t *testing.T) {
+		is := is.New(t)
+
+		event, err := store.CreateEvent(context.Background(), back.CreateEventCommand{
+			Name:        "my event",
+			Description: "stuff happening",
+			Earliest:    date.Today(),
+			Latest:      date.Today(),
+		})
+		is.NoErr(err)
+
+		err = store.AuthorizeEventAdmin(context.Background(), back.CheckEventAdminCodeQuery{
+			EventID:   event.EventID,
+			AdminCode: event.AdminCode,
+		})
+		is.NoErr(err)
+	})
+}