[API-51] Implement events (#62)

raymondjacobson · web-flow · commit 4050b5148d17 · 2025-05-02T10:18:26.000-07:00
diff --git a/api/dbv1/full_events.go b/api/dbv1/full_events.go
@@ -0,0 +1,42 @@
+package dbv1
+
+import (
+	"context"
+
+	"bridgerton.audius.co/trashid"
+)
+
+type FullEvent struct {
+	GetEventsRow
+
+	EventId  trashid.HashId `json:"event_id"`
+	UserId   trashid.HashId `json:"user_id"`
+	EntityId trashid.HashId `json:"entity_id"`
+}
+
+func (q *Queries) FullEventsKeyed(ctx context.Context, arg GetEventsParams) (map[int32]FullEvent, error) {
+	events, err := q.GetEvents(ctx, arg)
+	if err != nil {
+		return nil, err
+	}
+	eventMap := map[int32]FullEvent{}
+	for _, event := range events {
+		eventMap[int32(event.EventID)] = FullEvent{
+			GetEventsRow: event,
+			EventId:      trashid.HashId(event.EventID),
+			UserId:       trashid.HashId(event.UserID),
+			EntityId:     trashid.HashId(event.EntityID.Int32),
+		}
+	}
+
+	return eventMap, nil
+}
+
+func (q *Queries) ToFullEvent(event GetEventsRow) FullEvent {
+	return FullEvent{
+		GetEventsRow: event,
+		EventId:      trashid.HashId(event.EventID),
+		UserId:       trashid.HashId(event.UserID),
+		EntityId:     trashid.HashId(event.EntityID.Int32),
+	}
+}
diff --git a/api/dbv1/get_events.sql.go b/api/dbv1/get_events.sql.go
diff --git a/api/dbv1/jsonb_types.go b/api/dbv1/jsonb_types.go
@@ -54,3 +54,8 @@ type FullRemixOfTrack struct {
 type FullRemixOf struct {
 	Tracks []FullRemixOfTrack `json:"tracks"`
 }
+
+type EventData struct {
+	PrizeInfo   string `json:"prize_info"`
+	Description string `json:"description"`
+}
diff --git a/api/dbv1/models.go b/api/dbv1/models.go
diff --git a/api/dbv1/queries/get_events.sql b/api/dbv1/queries/get_events.sql
@@ -0,0 +1,21 @@
+-- name: GetEvents :many
+SELECT
+  event_id,
+  entity_type::event_entity_type,
+  user_id,
+  entity_id,
+  event_type::event_type,
+  end_date,
+  is_deleted,
+  created_at,
+  updated_at,
+  event_data
+FROM events
+WHERE
+  (@entity_ids::int[] = '{}' OR entity_id = ANY(@entity_ids::int[]))
+  AND (@entity_type::text = '' OR entity_type = @entity_type::event_entity_type)
+  AND (@event_type::text = '' OR event_type = @event_type::event_type)
+  AND (@filter_deleted::boolean IS NULL OR is_deleted = @filter_deleted)
+ORDER BY created_at DESC, event_id ASC
+LIMIT @limit_val
+OFFSET @offset_val;
diff --git a/api/fixture_test.go b/api/fixture_test.go
@@ -193,6 +193,22 @@ var (
 		"txhash":      "0x1",
 		"blockhash":   "0x2",
 	}
+
+	eventBaseRow = map[string]any{
+		"txhash":      "0x1",
+		"blockhash":   "0x2",
+		"blocknumber": 101,
+		"event_id":    nil,
+		"entity_type": nil,
+		"user_id":     nil,
+		"entity_id":   nil,
+		"event_type":  nil,
+		"end_date":    time.Now().Add(time.Hour * 24 * 30),
+		"is_deleted":  false,
+		"created_at":  time.Now(),
+		"updated_at":  time.Now(),
+		"event_data":  nil,
+	}
 )
 
 func insertFixtures(table string, baseRow map[string]any, csvFile string) {
diff --git a/api/server.go b/api/server.go
@@ -281,6 +281,12 @@ func NewApiServer(config config.Config) *ApiServer {
 
 		// Comments
 		g.Get("/comments/unclaimed_id", app.v1CommentsUnclaimedId)
+
+		// Events
+		g.Get("/events/unclaimed_id", app.v1EventsUnclaimedId)
+		g.Get("/events", app.v1Events)
+		g.Get("/events/all", app.v1Events)
+		g.Get("/events/entity", app.v1Events)
 	}
 
 	app.Static("/", "./static")
diff --git a/api/server_test.go b/api/server_test.go
@@ -84,6 +84,7 @@ func TestMain(m *testing.M) {
 	insertFixtures("grants", grantBaseRow, "testdata/grants_fixtures.csv")
 	insertFixtures("comments", commentBaseRow, "testdata/comment_fixtures.csv")
 	insertFixtures("comment_threads", map[string]any{}, "testdata/comment_thread_fixtures.csv")
+	insertFixtures("events", eventBaseRow, "testdata/event_fixtures.csv")
 
 	// index to es / os
 
diff --git a/api/testdata/event_fixtures.csv b/api/testdata/event_fixtures.csv
@@ -0,0 +1,7 @@
+event_id,entity_type,user_id,entity_id,event_type,is_deleted
+1,track,200,100,remix_contest,f
+2,track,200,100,live_event,f
+3,track,200,100,remix_contest,t
+4,track,200,101,remix_contest,f
+5,track,200,101,live_event,f
+6,track,201,102,remix_contest,f
diff --git a/api/testdata/user_fixtures.csv b/api/testdata/user_fixtures.csv
@@ -11,3 +11,5 @@ user_id,handle,handle_lc,is_deactivated,wallet,playlist_library
 100,authtest1,authtest1,f,0x681c616ae836ceca1effe00bd07f2fdbf9a082bc,
 101,authtest2,authtest2,f,0xc451c1f8943b575158310552b41230c61844a1c1,
 102,authtest3,authtest3,f,0x5f1a372b28956c8363f8bc3a231a6e9e1186ead8,
+200,eventsuser,eventsuser,f,0xffffffffff,
+201,eventsuser2,eventsuser2,f,0xffffffffff,
diff --git a/api/v1_events.go b/api/v1_events.go
@@ -0,0 +1,44 @@
+package api
+
+import (
+	"bridgerton.audius.co/api/dbv1"
+	"bridgerton.audius.co/trashid"
+	"github.com/gofiber/fiber/v2"
+)
+
+func (app *ApiServer) v1Events(c *fiber.Ctx) error {
+	limit := c.QueryInt("limit", 25)
+	offset := c.QueryInt("offset", 0)
+	eventType := c.Query("event_type", "")
+	entityType := c.Query("entity_type", "")
+	filterDeleted := c.QueryBool("filter_deleted", true)
+	entityIDs := queryMutli(c, "entity_id")
+
+	entityIds := []int32{}
+	for _, id := range entityIDs {
+		if id, err := trashid.DecodeHashId(id); err == nil {
+			entityIds = append(entityIds, int32(id))
+		}
+	}
+
+	recentEvents, err := app.queries.GetEvents(c.Context(), dbv1.GetEventsParams{
+		EntityIds:     entityIds,
+		EventType:     eventType,
+		EntityType:    entityType,
+		LimitVal:      int32(limit),
+		OffsetVal:     int32(offset),
+		FilterDeleted: !filterDeleted,
+	})
+	if err != nil {
+		return err
+	}
+
+	data := []dbv1.FullEvent{}
+	for _, event := range recentEvents {
+		data = append(data, app.queries.ToFullEvent(event))
+	}
+
+	return c.JSON(fiber.Map{
+		"data": data,
+	})
+}
diff --git a/api/v1_events_test.go b/api/v1_events_test.go
@@ -0,0 +1,53 @@
+package api
+
+import (
+	"testing"
+
+	"bridgerton.audius.co/api/dbv1"
+	"bridgerton.audius.co/trashid"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetEvents(t *testing.T) {
+	var eventsResponse struct {
+		Data []dbv1.FullEvent
+	}
+
+	status, body := testGet(t, "/v1/events", &eventsResponse)
+	assert.Equal(t, 200, status)
+
+	jsonAssert(t, body, map[string]string{
+		"data.0.event_id":  trashid.MustEncodeHashID(1),
+		"data.0.entity_id": trashid.MustEncodeHashID(100),
+
+		"data.1.event_id":  trashid.MustEncodeHashID(2),
+		"data.1.entity_id": trashid.MustEncodeHashID(100),
+
+		"data.2.event_id":  trashid.MustEncodeHashID(4),
+		"data.2.entity_id": trashid.MustEncodeHashID(101),
+
+		"data.3.event_id":  trashid.MustEncodeHashID(5),
+		"data.3.entity_id": trashid.MustEncodeHashID(101),
+
+		"data.4.event_id":  trashid.MustEncodeHashID(6),
+		"data.4.entity_id": trashid.MustEncodeHashID(102),
+	})
+}
+
+func TestGetEventsEntity(t *testing.T) {
+	var eventsResponse struct {
+		Data []dbv1.FullEvent
+	}
+
+	status, body := testGet(
+		t,
+		"/v1/events/entity?entity_id="+trashid.MustEncodeHashID(102),
+		&eventsResponse,
+	)
+	assert.Equal(t, 200, status)
+
+	jsonAssert(t, body, map[string]string{
+		"data.0.event_id":  trashid.MustEncodeHashID(6),
+		"data.0.entity_id": trashid.MustEncodeHashID(102),
+	})
+}
diff --git a/api/v1_unclaimed_id.go b/api/v1_unclaimed_id.go
@@ -51,3 +51,7 @@ func (app *ApiServer) v1PlaylistsUnclaimedId(c *fiber.Ctx) error {
 func (app *ApiServer) v1CommentsUnclaimedId(c *fiber.Ctx) error {
 	return app.v1UnclaimedId(c, "comments", "comment_id", 4_000_000, math.MaxInt32)
 }
+
+func (app *ApiServer) v1EventsUnclaimedId(c *fiber.Ctx) error {
+	return app.v1UnclaimedId(c, "events", "event_id", 1, math.MaxInt32)
+}
diff --git a/sql/schema1.sql b/sql/schema1.sql
diff --git a/sqlc.yaml b/sqlc.yaml
diff --git a/static/apidiff.html b/static/apidiff.html

Original file line number	Diff line number	Diff line change
`@@ -54,3 +54,8 @@ type FullRemixOfTrack struct {`
`54`	`54`	`type FullRemixOf struct {`
`55`	`55`	Tracks []FullRemixOfTrack `json:"tracks"`
`56`	`56`	`}`
	`57`	`+`
	`58`	`+type EventData struct {`
	`59`	+ PrizeInfo string `json:"prize_info"`
	`60`	+ Description string `json:"description"`
	`61`	`+}`