0.2.75

server/internal/api/analytics.go

@@ -43,10 +43,15 @@ type journeyEventPayload struct {
 	Feature    string `json:"feature"`
 	Source     string `json:"source"`
 	Target     string `json:"target"`
+	ItemID     string `json:"itemId"`
 	ItemName   string `json:"itemName"`
 	ItemType   string `json:"itemType"`
-	Outcome    string `json:"outcome"`
-	OccurredAt string `json:"occurredAt"`
+	// The Emby play session a playback step belongs to. Validated like every other
+	// controlled field: it is Emby's string rather than ours, and an event carrying one this
+	// cannot read is dropped whole, so the television sanitises it before sending.
+	PlaySessionID string `json:"playSessionId"`
+	Outcome       string `json:"outcome"`
+	OccurredAt    string `json:"occurredAt"`
 }
 
 type journeyAnalyticsRequest struct {
@@ -100,7 +105,8 @@ func toJourneyEvent(payload journeyEventPayload, userID string, now time.Time) (
 		!journeyOutcomes[payload.Outcome] {
 		return store.JourneyEvent{}, false
 	}
-	fields := []string{payload.Screen, payload.Feature, payload.Source, payload.Target, payload.ItemType}
+	fields := []string{payload.Screen, payload.Feature, payload.Source, payload.Target,
+		payload.ItemID, payload.ItemType, payload.PlaySessionID}
 	for _, field := range fields {
 		if !safeAnalyticsValue(field, 100) {
 			return store.JourneyEvent{}, false
@@ -114,8 +120,9 @@ func toJourneyEvent(payload journeyEventPayload, userID string, now time.Time) (
 	return store.JourneyEvent{OccurredAt: occurredAt, UserID: userID, JourneyID: payload.JourneyID,
 		Sequence: payload.Sequence, Category: payload.Category, Action: payload.Action,
 		Screen: payload.Screen, Feature: payload.Feature, Source: payload.Source,
-		Target: payload.Target, ItemName: strings.TrimSpace(payload.ItemName), ItemType: payload.ItemType,
-		Outcome: payload.Outcome}, true
+		Target: payload.Target, ItemID: payload.ItemID,
+		ItemName: strings.TrimSpace(payload.ItemName), ItemType: payload.ItemType,
+		PlaySessionID: payload.PlaySessionID, Outcome: payload.Outcome}, true
 }
 
 func safeAnalyticsValue(value string, max int) bool {