Add true up review status history, add migration for persisting history, add store to create, get, and update true up review history entries, cleanup errors, etc.

store/sqlstore/store.go

@@ -112,6 +112,7 @@ type SqlStoreStores struct {
 	notifyAdmin          store.NotifyAdminStore
 	postPriority         store.PostPriorityStore
 	postAcknowledgement  store.PostAcknowledgementStore
+	trueUpReviewStatus   store.TrueUpReviewStore
 }
 
 type SqlStore struct {
@@ -220,6 +221,7 @@ func New(settings model.SqlSettings, metrics einterfaces.MetricsInterface) *SqlS
 	store.stores.notifyAdmin = newSqlNotifyAdminStore(store)
 	store.stores.postPriority = newSqlPostPriorityStore(store)
 	store.stores.postAcknowledgement = newSqlPostAcknowledgementStore(store)
+	store.stores.trueUpReviewStatus = newSqlTrueUpReviewStore(store)
 
 	store.stores.preference.(*SqlPreferenceStore).deleteUnusedFeatures()
 
@@ -973,6 +975,10 @@ func (ss *SqlStore) PostAcknowledgement() store.PostAcknowledgementStore {
 	return ss.stores.postAcknowledgement
 }
 
+func (ss *SqlStore) TrueUpReview() store.TrueUpReviewStore {
+	return ss.stores.trueUpReviewStatus
+}
+
 func (ss *SqlStore) DropAllTables() {
 	if ss.DriverName() == model.DatabaseDriverPostgres {
 		ss.masterX.Exec(`DO

store/sqlstore/true_up_review_store.go

@@ -0,0 +1,77 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package sqlstore
+
+import (
+	"github.com/mattermost/mattermost-server/v6/model"
+	"github.com/mattermost/mattermost-server/v6/store"
+	sq "github.com/mattermost/squirrel"
+	"github.com/pkg/errors"
+)
+
+// SqlLicenseStore encapsulates the database writes and reads for
+// model.LicenseRecord objects.
+type SqlTrueUpReviewStore struct {
+	*SqlStore
+}
+
+func newSqlTrueUpReviewStore(sqlStore *SqlStore) store.TrueUpReviewStore {
+	return &SqlTrueUpReviewStore{sqlStore}
+}
+
+func trueUpReviewStatusColumns() []string {
+	return []string{
+		"DueDate",
+		"Completed",
+	}
+}
+
+func (s *SqlTrueUpReviewStore) GetTrueUpReviewStatus(dueDate string) (*model.TrueUpReviewStatus, error) {
+	query := s.getQueryBuilder().
+		Select("*").
+		From("TrueUpReviewHistory").
+		Where(sq.Eq{"DueDate": dueDate})
+
+	queryString, args, err := query.ToSql()
+	if err != nil {
+		return nil, errors.Wrap(err, "get_trueUpReviewStatusRecord_tosql")
+	}
+	var trueUpReviewStatus model.TrueUpReviewStatus
+	if err := s.GetReplicaX().Get(&trueUpReviewStatus, queryString, args...); err != nil {
+		trueUpReviewStatus.Completed = false
+		trueUpReviewStatus.DueDate = dueDate
+
+		// If no record is available, create one so there is a record trail.
+		return s.CreateTrueUpReviewStatusRecord(&trueUpReviewStatus)
+	}
+
+	return &trueUpReviewStatus, nil
+}
+
+func (s *SqlTrueUpReviewStore) CreateTrueUpReviewStatusRecord(reviewStatus *model.TrueUpReviewStatus) (*model.TrueUpReviewStatus, error) {
+	builder := s.getQueryBuilder().Insert("TrueUpReviewHistory").Columns(trueUpReviewStatusColumns()...).Values(reviewStatus.ToSlice()...)
+	query, args, err := builder.ToSql()
+	if err != nil {
+		return nil, errors.Wrap(err, "create_trueUpReviewStatusRecord_tosql")
+	}
+
+	if _, err = s.GetMasterX().Exec(query, args...); err != nil {
+		return nil, errors.Wrap(err, "fail to create true up review status record")
+	}
+
+	return reviewStatus, nil
+}
+
+func (s *SqlTrueUpReviewStore) Update(reviewStatus *model.TrueUpReviewStatus) (*model.TrueUpReviewStatus, error) {
+	query := s.getQueryBuilder().
+		Update("TrueUpReviewHistory").
+		Set("Completed", reviewStatus.Completed).
+		Where(sq.Eq{"DueDate": reviewStatus.DueDate})
+
+	if _, err := s.GetMasterX().ExecBuilder(query); err != nil {
+		return nil, errors.Wrapf(err, "failed to update true up review status with DueDate=%s", reviewStatus.DueDate)
+	}
+
+	return reviewStatus, nil
+}