Status Field for Race Response

api/go.mod

@@ -1,6 +1,6 @@
 module github.com/ashleyjlive/entain/api
 
-go 1.16
+go 1.17
 
 require (
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.5.0
@@ -13,3 +13,13 @@ require (
 	gopkg.in/yaml.v2 v2.3.0 // indirect
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )
+
+require (
+	github.com/ghodss/yaml v1.0.0 // indirect
+	github.com/golang/glog v0.0.0-20210429001901-424d2337a529 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/magefile/mage v1.10.0 // indirect
+	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
+	golang.org/x/sys v0.0.0-20210510120138-977fb7262007 // indirect
+	golang.org/x/text v0.3.5 // indirect
+)

api/proto/racing/racing.proto

@@ -50,4 +50,11 @@ message Race {
   bool visible = 5;
   // AdvertisedStartTime is the time the race is advertised to run.
   google.protobuf.Timestamp advertised_start_time = 6;
+  enum Status {
+    CLOSED = 0;
+    OPEN = 1;
+  }
+  // Status reflects whether the Race is open or closed, based off the 
+  // advertised start time being in the past.
+  Status status = 7;
 }

racing/db/db.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ashleyjlive/entain/racing/proto/racing"
 	"github.com/golang/protobuf/ptypes"
+	"google.golang.org/protobuf/types/known/timestamppb"
 	"syreclabs.com/go/faker"
 )
 
@@ -58,10 +59,7 @@ func (r *racesRepo) listAll() ([]*racing.Race, error) {
 
 			return nil, err
 		}
-		ts, err := ptypes.TimestampProto(advertisedStart)
-		if err != nil {
-			return nil, err
-		}
+		ts := timestamppb.New(advertisedStart)
 
 		race.AdvertisedStartTime = ts
 

racing/db/races.go

@@ -8,8 +8,8 @@ import (
 	"time"
 	"unicode"
 
-	"github.com/golang/protobuf/ptypes"
 	_ "github.com/mattn/go-sqlite3"
+	"google.golang.org/protobuf/types/known/timestamppb"
 
 	"github.com/ashleyjlive/entain/racing/proto/racing"
 )
@@ -154,16 +154,16 @@ func toOrderBySql(input string) (*string, error) {
 		words := strings.Fields(str)
 		wordCount := len(words)
 		if wordCount > 2 || wordCount < 1 {
-			return nil, errors.New("Invalid order by term count.")
+			return nil, errors.New("invalid order by term count")
 		}
 		sortField := words[0]
 		if strings.IndexFunc(sortField, isUnsafeColumnChar) != -1 {
-			return nil, errors.New("Invalid column name.")
+			return nil, errors.New("invalid column name")
 		}
 		if wordCount == 2 {
 			sort := words[1]
 			if !(strings.EqualFold(sort, "asc") || strings.EqualFold(sort, "desc")) {
-				return nil, errors.New("Invalid order by dir parameter.")
+				return nil, errors.New("invalid order by dir parameter")
 			}
 			sortField += " " + sort
 		}
@@ -203,11 +203,16 @@ func (m *racesRepo) scanRaces(
 			return nil, err
 		}
 
-		ts, err := ptypes.TimestampProto(advertisedStart)
-		if err != nil {
-			return nil, err
-		}
+		ts := timestamppb.New(advertisedStart)
 
+		if advertisedStart.Before(time.Now()) {
+			// All races that have an `advertised_start_time` in the past should
+			// reflect `CLOSED`
+			// Note that this depends on the system having the correct time.
+			race.Status = racing.Race_CLOSED
+		} else {
+			race.Status = racing.Race_OPEN
+		}
 		race.AdvertisedStartTime = ts
 
 		races = append(races, &race)

racing/db/races_test.go

@@ -10,8 +10,9 @@ import (
 
 	"github.com/ashleyjlive/entain/racing/db"
 	"github.com/ashleyjlive/entain/racing/proto/racing"
-	"github.com/golang/protobuf/ptypes"
 	"syreclabs.com/go/faker"
+
+	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
 func TestRepo(t *testing.T) {
@@ -183,7 +184,7 @@ func TestOrderBy(t *testing.T) {
 	racesRepo := db.NewRacesRepo(racingDB)
 	_ = racesRepo.Init(false)
 
-	tm1, _ := ptypes.TimestampProto(time.Now().AddDate(0, 0, 2))
+	tm1 := timestamppb.New(time.Now().AddDate(0, 0, 2))
 	race1 :=
 		racing.Race{Id: int64(1), MeetingId: int64(5),
 			Name: "Test1", Number: int64(5),
@@ -192,7 +193,7 @@ func TestOrderBy(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to insert first race %v.", err)
 	}
-	tm2, _ := ptypes.TimestampProto(time.Now().AddDate(0, 0, 2))
+	tm2 := timestamppb.New(time.Now().AddDate(0, 0, -2))
 	race2 :=
 		racing.Race{Id: int64(5), MeetingId: int64(3),
 			Name: "Test2", Number: int64(9),
@@ -259,6 +260,50 @@ func TestOrderBy(t *testing.T) {
 	}
 }
 
+func TestStatusField(t *testing.T) {
+	racingDB, err := GetTestDB("races", "TestStatusField")
+	if err != nil {
+		t.Fatalf("Failed to open testdb %v", err)
+	}
+	racesRepo := db.NewRacesRepo(racingDB)
+	_ = racesRepo.Init(false)
+
+	tm1 := timestamppb.New(time.Now().AddDate(0, 0, 2))
+	race1 :=
+		racing.Race{Id: int64(1), MeetingId: int64(5),
+			Name: "Test1", Number: int64(5),
+			Visible: true, AdvertisedStartTime: tm1}
+	err = racesRepo.InsertRace(&race1)
+	if err != nil {
+		t.Fatalf("Failed to insert first race %v.", err)
+	}
+	tm2 := timestamppb.New(time.Now().AddDate(0, 0, -2))
+	race2 :=
+		racing.Race{Id: int64(5), MeetingId: int64(3),
+			Name: "Test2", Number: int64(9),
+			Visible: false, AdvertisedStartTime: tm2}
+	err = racesRepo.InsertRace(&race2)
+	if err != nil {
+		t.Fatalf("Failed to insert second race %v.", err)
+	}
+
+	// Test case
+	rq := racing.ListRacesRequest{}
+	rsp, err := racesRepo.List(&rq)
+	if err != nil {
+		t.Fatalf("Unable to retrieve races list.")
+	}
+	if len(rsp) != 2 {
+		t.Fatalf("Returned incorrect amount of races.")
+	}
+	if rsp[0].Status != racing.Race_CLOSED {
+		t.Fatalf("Returned invalid status flag for closed event %v.", rsp[0].Id)
+	}
+	if rsp[1].Status != racing.Race_OPEN {
+		t.Fatalf("Returned invalid status flag for open event %v.", rsp[1].Id)
+	}
+}
+
 // Helpers //
 
 func GetRaces() []*racing.Race {
@@ -270,7 +315,7 @@ func GetRaces() []*racing.Race {
 		name := faker.Team().Name()
 		number, _ := strconv.Atoi(faker.Number().Between(1, 12))
 		visible := randBool()
-		tm, _ := ptypes.TimestampProto(
+		tm := timestamppb.New(
 			faker.Time().Between(
 				time.Now().AddDate(0, 0, -1), time.Now().AddDate(0, 0, 2)))
 		race :=

racing/go.mod

@@ -1,6 +1,6 @@
 module github.com/ashleyjlive/entain/racing
 
-go 1.16
+go 1.17
 
 require (
 	github.com/golang/protobuf v1.5.2
@@ -17,3 +17,11 @@ require (
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 	syreclabs.com/go/faker v1.2.3
 )
+
+require (
+	github.com/ghodss/yaml v1.0.0 // indirect
+	github.com/golang/glog v0.0.0-20210429001901-424d2337a529 // indirect
+	github.com/magefile/mage v1.10.0 // indirect
+	golang.org/x/sys v0.0.0-20210510120138-977fb7262007 // indirect
+	golang.org/x/text v0.3.5 // indirect
+)

racing/proto/README.md

@@ -23,4 +23,5 @@ This defines the protobuf message types for the racing API.
 - The unique identifier for the races meeting (int64).
 - The name of the race (string).
 - The visibility of the race (bool).
-- The advertised start time of the race (Timestamp).
+- The advertised start time of the race (Timestamp).
+- A status flag indicating if the event is `OPEN` or `CLOSED` - this is based off the advertised start time with the systems current time.