Refactor data sources and feed model
This commit is contained in:
@@ -2,60 +2,7 @@
|
||||
// Candidate.swift
|
||||
// iris
|
||||
//
|
||||
// Created by Codex.
|
||||
// Deprecated: data sources now return typed data and the orchestrator produces `FeedItem`s.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import WeatherKit
|
||||
|
||||
struct Candidate: Codable, Equatable {
|
||||
let id: String
|
||||
let type: WinnerType
|
||||
let title: String
|
||||
let subtitle: String
|
||||
let confidence: Double
|
||||
let createdAt: Int
|
||||
let ttlSec: Int
|
||||
let condition: WeatherKit.WeatherCondition?
|
||||
let metadata: [String: String]?
|
||||
|
||||
enum CodingKeys: String, CodingKey {
|
||||
case id
|
||||
case type
|
||||
case title
|
||||
case subtitle
|
||||
case confidence
|
||||
case createdAt
|
||||
case ttlSec
|
||||
case condition
|
||||
case metadata
|
||||
}
|
||||
|
||||
init(id: String,
|
||||
type: WinnerType,
|
||||
title: String,
|
||||
subtitle: String,
|
||||
confidence: Double,
|
||||
createdAt: Int,
|
||||
ttlSec: Int,
|
||||
condition: WeatherKit.WeatherCondition? = nil,
|
||||
metadata: [String: String]? = nil) {
|
||||
self.id = id
|
||||
self.type = type
|
||||
self.title = title
|
||||
self.subtitle = subtitle
|
||||
self.confidence = confidence
|
||||
self.createdAt = createdAt
|
||||
self.ttlSec = ttlSec
|
||||
self.condition = condition
|
||||
self.metadata = metadata
|
||||
}
|
||||
|
||||
func isExpired(at now: Int) -> Bool {
|
||||
if ttlSec > 0 {
|
||||
createdAt + ttlSec <= now
|
||||
} else {
|
||||
true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ import WeatherKit
|
||||
struct FeedEnvelope: Codable, Equatable {
|
||||
let schema: Int
|
||||
let generatedAt: Int
|
||||
let feed: [FeedCard]
|
||||
let feed: [FeedItem]
|
||||
let meta: FeedMeta
|
||||
|
||||
enum CodingKeys: String, CodingKey {
|
||||
@@ -22,19 +22,20 @@ struct FeedEnvelope: Codable, Equatable {
|
||||
}
|
||||
}
|
||||
|
||||
struct FeedCard: Codable, Equatable {
|
||||
struct FeedItem: Codable, Equatable {
|
||||
enum Bucket: String, Codable {
|
||||
case rightNow = "RIGHT_NOW"
|
||||
case fyi = "FYI"
|
||||
}
|
||||
|
||||
let id: String
|
||||
let type: WinnerType
|
||||
let type: FeedItemType
|
||||
let title: String
|
||||
let subtitle: String
|
||||
let priority: Double
|
||||
let ttlSec: Int
|
||||
let condition: WeatherKit.WeatherCondition?
|
||||
let startsAt: Int?
|
||||
let bucket: Bucket
|
||||
let actions: [String]
|
||||
|
||||
@@ -46,17 +47,19 @@ struct FeedCard: Codable, Equatable {
|
||||
case priority
|
||||
case ttlSec = "ttl_sec"
|
||||
case condition
|
||||
case startsAt = "starts_at"
|
||||
case bucket
|
||||
case actions
|
||||
}
|
||||
|
||||
init(id: String,
|
||||
type: WinnerType,
|
||||
type: FeedItemType,
|
||||
title: String,
|
||||
subtitle: String,
|
||||
priority: Double,
|
||||
ttlSec: Int,
|
||||
condition: WeatherKit.WeatherCondition? = nil,
|
||||
startsAt: Int? = nil,
|
||||
bucket: Bucket,
|
||||
actions: [String]) {
|
||||
self.id = id
|
||||
@@ -66,6 +69,7 @@ struct FeedCard: Codable, Equatable {
|
||||
self.priority = priority
|
||||
self.ttlSec = ttlSec
|
||||
self.condition = condition
|
||||
self.startsAt = startsAt
|
||||
self.bucket = bucket
|
||||
self.actions = actions
|
||||
}
|
||||
@@ -73,13 +77,14 @@ struct FeedCard: Codable, Equatable {
|
||||
init(from decoder: Decoder) throws {
|
||||
let container = try decoder.container(keyedBy: CodingKeys.self)
|
||||
id = try container.decode(String.self, forKey: .id)
|
||||
type = try container.decode(WinnerType.self, forKey: .type)
|
||||
type = try container.decode(FeedItemType.self, forKey: .type)
|
||||
title = try container.decode(String.self, forKey: .title)
|
||||
subtitle = try container.decode(String.self, forKey: .subtitle)
|
||||
priority = try container.decode(Double.self, forKey: .priority)
|
||||
ttlSec = try container.decode(Int.self, forKey: .ttlSec)
|
||||
bucket = try container.decode(Bucket.self, forKey: .bucket)
|
||||
actions = try container.decode([String].self, forKey: .actions)
|
||||
startsAt = try container.decodeIfPresent(Int.self, forKey: .startsAt)
|
||||
|
||||
if let encoded = try container.decodeIfPresent(String.self, forKey: .condition) {
|
||||
condition = WeatherKit.WeatherCondition.irisDecode(encoded)
|
||||
@@ -98,6 +103,7 @@ struct FeedCard: Codable, Equatable {
|
||||
try container.encode(ttlSec, forKey: .ttlSec)
|
||||
try container.encode(bucket, forKey: .bucket)
|
||||
try container.encode(actions, forKey: .actions)
|
||||
try container.encodeIfPresent(startsAt, forKey: .startsAt)
|
||||
if let condition {
|
||||
try container.encode(condition.irisScreamingCase(), forKey: .condition)
|
||||
}
|
||||
@@ -114,50 +120,9 @@ struct FeedMeta: Codable, Equatable {
|
||||
}
|
||||
}
|
||||
|
||||
extension FeedEnvelope {
|
||||
static func fromWinnerAndWeather(now: Int, winner: WinnerEnvelope, weather: Candidate?) -> FeedEnvelope {
|
||||
var cards: [FeedCard] = []
|
||||
|
||||
let winnerCard = FeedCard(
|
||||
id: winner.winner.id,
|
||||
type: winner.winner.type,
|
||||
title: winner.winner.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: winner.winner.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
priority: min(max(winner.winner.priority, 0.0), 1.0),
|
||||
ttlSec: max(1, winner.winner.ttlSec),
|
||||
condition: nil,
|
||||
bucket: .rightNow,
|
||||
actions: ["DISMISS"]
|
||||
)
|
||||
cards.append(winnerCard)
|
||||
|
||||
if let weather, weather.id != winner.winner.id {
|
||||
let weatherCard = FeedCard(
|
||||
id: weather.id,
|
||||
type: weather.type,
|
||||
title: weather.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: weather.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
priority: min(max(weather.confidence, 0.0), 1.0),
|
||||
ttlSec: max(1, weather.ttlSec),
|
||||
condition: weather.condition,
|
||||
bucket: .fyi,
|
||||
actions: ["DISMISS"]
|
||||
)
|
||||
cards.append(weatherCard)
|
||||
}
|
||||
|
||||
return FeedEnvelope(
|
||||
schema: 1,
|
||||
generatedAt: now,
|
||||
feed: cards,
|
||||
meta: FeedMeta(winnerId: winner.winner.id, unreadCount: cards.count)
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
extension FeedEnvelope {
|
||||
static func allQuiet(now: Int, reason: String = "no_candidates", source: String = "engine") -> FeedEnvelope {
|
||||
let card = FeedCard(
|
||||
let item = FeedItem(
|
||||
id: "quiet-000",
|
||||
type: .allQuiet,
|
||||
title: "All Quiet",
|
||||
@@ -165,29 +130,14 @@ extension FeedEnvelope {
|
||||
priority: 0.05,
|
||||
ttlSec: 300,
|
||||
condition: nil,
|
||||
startsAt: nil,
|
||||
bucket: .rightNow,
|
||||
actions: ["DISMISS"]
|
||||
)
|
||||
return FeedEnvelope(schema: 1, generatedAt: now, feed: [card], meta: FeedMeta(winnerId: card.id, unreadCount: 1))
|
||||
return FeedEnvelope(schema: 1, generatedAt: now, feed: [item], meta: FeedMeta(winnerId: item.id, unreadCount: 1))
|
||||
}
|
||||
|
||||
func winnerCard() -> FeedCard? {
|
||||
func winnerItem() -> FeedItem? {
|
||||
feed.first(where: { $0.id == meta.winnerId }) ?? feed.first
|
||||
}
|
||||
|
||||
func asWinnerEnvelope() -> WinnerEnvelope {
|
||||
let now = generatedAt
|
||||
guard let winnerCard = winnerCard() else {
|
||||
return WinnerEnvelope.allQuiet(now: now)
|
||||
}
|
||||
let winner = Winner(
|
||||
id: winnerCard.id,
|
||||
type: winnerCard.type,
|
||||
title: winnerCard.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: winnerCard.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
priority: min(max(winnerCard.priority, 0.0), 1.0),
|
||||
ttlSec: max(1, winnerCard.ttlSec)
|
||||
)
|
||||
return WinnerEnvelope(schema: 1, generatedAt: now, winner: winner, debug: nil)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@ import Foundation
|
||||
final class FeedStore {
|
||||
struct CardKey: Hashable, Codable {
|
||||
let id: String
|
||||
let type: WinnerType
|
||||
let type: FeedItemType
|
||||
}
|
||||
|
||||
struct CardState: Codable, Equatable {
|
||||
@@ -58,17 +58,17 @@ final class FeedStore {
|
||||
}
|
||||
}
|
||||
|
||||
func lastShownAt(candidateId: String) -> Int? {
|
||||
func lastShownAt(feedItemId: String) -> Int? {
|
||||
queue.sync {
|
||||
let matches = states.compactMap { (key, value) -> Int? in
|
||||
guard key.hasSuffix("|" + candidateId) else { return nil }
|
||||
guard key.hasSuffix("|" + feedItemId) else { return nil }
|
||||
return value.lastShownAt
|
||||
}
|
||||
return matches.max()
|
||||
}
|
||||
}
|
||||
|
||||
func isSuppressed(id: String, type: WinnerType, now: Int) -> Bool {
|
||||
func isSuppressed(id: String, type: FeedItemType, now: Int) -> Bool {
|
||||
queue.sync {
|
||||
let key = Self.keyString(id: id, type: type)
|
||||
guard let state = states[key] else { return false }
|
||||
@@ -78,7 +78,7 @@ final class FeedStore {
|
||||
}
|
||||
}
|
||||
|
||||
func dismiss(id: String, type: WinnerType, until: Int? = nil) {
|
||||
func dismiss(id: String, type: FeedItemType, until: Int? = nil) {
|
||||
queue.sync {
|
||||
let key = Self.keyString(id: id, type: type)
|
||||
var state = states[key] ?? CardState()
|
||||
@@ -88,7 +88,7 @@ final class FeedStore {
|
||||
}
|
||||
}
|
||||
|
||||
func snooze(id: String, type: WinnerType, until: Int) {
|
||||
func snooze(id: String, type: FeedItemType, until: Int) {
|
||||
queue.sync {
|
||||
let key = Self.keyString(id: id, type: type)
|
||||
var state = states[key] ?? CardState()
|
||||
@@ -98,7 +98,7 @@ final class FeedStore {
|
||||
}
|
||||
}
|
||||
|
||||
func clearSuppression(id: String, type: WinnerType) {
|
||||
func clearSuppression(id: String, type: FeedItemType) {
|
||||
queue.sync {
|
||||
let key = Self.keyString(id: id, type: type)
|
||||
var state = states[key] ?? CardState()
|
||||
@@ -119,11 +119,11 @@ final class FeedStore {
|
||||
}
|
||||
|
||||
private func normalizedFeed(_ feed: FeedEnvelope, now: Int, applyingSuppression: Bool = true) -> FeedEnvelope {
|
||||
let normalizedCards = feed.feed.compactMap { card -> FeedCard? in
|
||||
let normalizedCards = feed.feed.compactMap { card -> FeedItem? in
|
||||
let ttl = max(1, card.ttlSec)
|
||||
if feed.generatedAt + ttl <= now { return nil }
|
||||
if applyingSuppression, isSuppressedUnlocked(id: card.id, type: card.type, now: now) { return nil }
|
||||
return FeedCard(
|
||||
return FeedItem(
|
||||
id: card.id,
|
||||
type: card.type,
|
||||
title: card.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
@@ -131,6 +131,7 @@ final class FeedStore {
|
||||
priority: min(max(card.priority, 0.0), 1.0),
|
||||
ttlSec: ttl,
|
||||
condition: card.condition,
|
||||
startsAt: card.startsAt,
|
||||
bucket: card.bucket,
|
||||
actions: card.actions
|
||||
)
|
||||
@@ -146,7 +147,7 @@ final class FeedStore {
|
||||
return normalized
|
||||
}
|
||||
|
||||
private func isSuppressedUnlocked(id: String, type: WinnerType, now: Int) -> Bool {
|
||||
private func isSuppressedUnlocked(id: String, type: FeedItemType, now: Int) -> Bool {
|
||||
let key = Self.keyString(id: id, type: type)
|
||||
guard let state = states[key] else { return false }
|
||||
if let until = state.dismissedUntil, until > now { return true }
|
||||
@@ -159,7 +160,7 @@ final class FeedStore {
|
||||
Self.save(persisted, to: fileURL)
|
||||
}
|
||||
|
||||
private static func keyString(id: String, type: WinnerType) -> String {
|
||||
private static func keyString(id: String, type: FeedItemType) -> String {
|
||||
"\(type.rawValue)|\(id)"
|
||||
}
|
||||
|
||||
|
||||
@@ -27,49 +27,65 @@ final class HeuristicRanker {
|
||||
self.lastShownAtProvider = lastShownAt
|
||||
}
|
||||
|
||||
func pickWinner(from candidates: [Candidate], now: Int? = nil, context: UserContext) -> Winner {
|
||||
struct Ranked: Equatable {
|
||||
let item: FeedItem
|
||||
let confidence: Double
|
||||
let isEligibleForRightNow: Bool
|
||||
}
|
||||
|
||||
struct WinnerSelection: Equatable {
|
||||
let item: FeedItem
|
||||
let priority: Double
|
||||
}
|
||||
|
||||
func pickWinner(from items: [Ranked], now: Int? = nil, context: UserContext) -> WinnerSelection? {
|
||||
let currentTime = now ?? nowProvider()
|
||||
|
||||
let valid = candidates
|
||||
.filter { !$0.isExpired(at: currentTime) }
|
||||
let valid = items
|
||||
.filter { $0.item.ttlSec > 0 }
|
||||
.filter { $0.confidence >= 0.0 }
|
||||
.filter { $0.isEligibleForRightNow }
|
||||
|
||||
guard !valid.isEmpty else {
|
||||
return WinnerEnvelope.allQuiet(now: currentTime).winner
|
||||
}
|
||||
guard !valid.isEmpty else { return nil }
|
||||
|
||||
var best: (candidate: Candidate, score: Double)?
|
||||
for candidate in valid {
|
||||
let baseWeight = baseWeight(for: candidate.type)
|
||||
var score = baseWeight * min(max(candidate.confidence, 0.0), 1.0)
|
||||
if let shownAt = lastShownAtProvider(candidate.id),
|
||||
var best: (item: FeedItem, score: Double, confidence: Double)?
|
||||
for proposed in valid {
|
||||
let baseWeight = baseWeight(for: proposed.item.type)
|
||||
var score = baseWeight * min(max(proposed.confidence, 0.0), 1.0)
|
||||
if let shownAt = lastShownAtProvider(proposed.item.id),
|
||||
currentTime - shownAt <= 2 * 60 * 60 {
|
||||
score -= 0.4
|
||||
}
|
||||
if best == nil || score > best!.score {
|
||||
best = (candidate, score)
|
||||
best = (proposed.item, score, proposed.confidence)
|
||||
}
|
||||
}
|
||||
|
||||
guard let best else {
|
||||
return WinnerEnvelope.allQuiet(now: currentTime).winner
|
||||
return nil
|
||||
}
|
||||
|
||||
let priority = min(max(best.score, 0.0), 1.0)
|
||||
return Winner(
|
||||
id: best.candidate.id,
|
||||
type: best.candidate.type,
|
||||
title: best.candidate.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: best.candidate.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
let item = FeedItem(
|
||||
id: best.item.id,
|
||||
type: best.item.type,
|
||||
title: best.item.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: best.item.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
priority: priority,
|
||||
ttlSec: max(1, best.candidate.ttlSec)
|
||||
ttlSec: max(1, best.item.ttlSec),
|
||||
condition: best.item.condition,
|
||||
startsAt: best.item.startsAt,
|
||||
bucket: .rightNow,
|
||||
actions: ["DISMISS"]
|
||||
)
|
||||
return WinnerSelection(item: item, priority: priority)
|
||||
}
|
||||
|
||||
private func baseWeight(for type: WinnerType) -> Double {
|
||||
private func baseWeight(for type: FeedItemType) -> Double {
|
||||
switch type {
|
||||
case .weatherWarning: return 1.0
|
||||
case .weatherAlert: return 0.9
|
||||
case .calendarEvent: return 0.8
|
||||
case .transit: return 0.75
|
||||
case .poiNearby: return 0.6
|
||||
case .info: return 0.4
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
import Foundation
|
||||
|
||||
enum WinnerType: String, Codable, CaseIterable {
|
||||
enum FeedItemType: String, Codable, CaseIterable {
|
||||
case weatherAlert = "WEATHER_ALERT"
|
||||
case weatherWarning = "WEATHER_WARNING"
|
||||
case transit = "TRANSIT"
|
||||
@@ -15,23 +15,6 @@ enum WinnerType: String, Codable, CaseIterable {
|
||||
case info = "INFO"
|
||||
case nowPlaying = "NOW_PLAYING"
|
||||
case currentWeather = "CURRENT_WEATHER"
|
||||
case calendarEvent = "CALENDAR_EVENT"
|
||||
case allQuiet = "ALL_QUIET"
|
||||
}
|
||||
|
||||
struct Winner: Codable, Equatable {
|
||||
let id: String
|
||||
let type: WinnerType
|
||||
let title: String
|
||||
let subtitle: String
|
||||
let priority: Double
|
||||
let ttlSec: Int
|
||||
|
||||
enum CodingKeys: String, CodingKey {
|
||||
case id
|
||||
case type
|
||||
case title
|
||||
case subtitle
|
||||
case priority
|
||||
case ttlSec = "ttl_sec"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,82 +7,6 @@
|
||||
|
||||
import Foundation
|
||||
|
||||
struct WinnerEnvelope: Codable, Equatable {
|
||||
struct DebugInfo: Codable, Equatable {
|
||||
let reason: String
|
||||
let source: String
|
||||
}
|
||||
|
||||
let schema: Int
|
||||
let generatedAt: Int
|
||||
let winner: Winner
|
||||
let debug: DebugInfo?
|
||||
|
||||
enum CodingKeys: String, CodingKey {
|
||||
case schema
|
||||
case generatedAt = "generated_at"
|
||||
case winner
|
||||
case debug
|
||||
}
|
||||
|
||||
static func allQuiet(now: Int, reason: String = "no_candidates", source: String = "engine") -> WinnerEnvelope {
|
||||
let winner = Winner(
|
||||
id: "quiet-000",
|
||||
type: .allQuiet,
|
||||
title: "All Quiet",
|
||||
subtitle: "No urgent updates",
|
||||
priority: 0.05,
|
||||
ttlSec: 300
|
||||
)
|
||||
return WinnerEnvelope(schema: 1, generatedAt: now, winner: winner, debug: .init(reason: reason, source: source))
|
||||
}
|
||||
}
|
||||
|
||||
enum EnvelopeValidationError: Error, LocalizedError {
|
||||
case invalidSchema(Int)
|
||||
case invalidPriority(Double)
|
||||
case invalidTTL(Int)
|
||||
|
||||
var errorDescription: String? {
|
||||
switch self {
|
||||
case .invalidSchema(let schema):
|
||||
return "Invalid schema \(schema). Expected 1."
|
||||
case .invalidPriority(let priority):
|
||||
return "Invalid priority \(priority). Must be between 0 and 1."
|
||||
case .invalidTTL(let ttl):
|
||||
return "Invalid ttl \(ttl). Must be greater than 0."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func validateEnvelope(_ envelope: WinnerEnvelope) throws -> WinnerEnvelope {
|
||||
guard envelope.schema == 1 else {
|
||||
throw EnvelopeValidationError.invalidSchema(envelope.schema)
|
||||
}
|
||||
guard envelope.winner.priority >= 0.0, envelope.winner.priority <= 1.0 else {
|
||||
throw EnvelopeValidationError.invalidPriority(envelope.winner.priority)
|
||||
}
|
||||
guard envelope.winner.ttlSec > 0 else {
|
||||
throw EnvelopeValidationError.invalidTTL(envelope.winner.ttlSec)
|
||||
}
|
||||
|
||||
let validatedWinner = Winner(
|
||||
id: envelope.winner.id,
|
||||
type: envelope.winner.type,
|
||||
title: envelope.winner.title.truncated(maxLength: TextConstraints.titleMax),
|
||||
subtitle: envelope.winner.subtitle.truncated(maxLength: TextConstraints.subtitleMax),
|
||||
priority: envelope.winner.priority,
|
||||
ttlSec: envelope.winner.ttlSec
|
||||
)
|
||||
|
||||
return WinnerEnvelope(
|
||||
schema: envelope.schema,
|
||||
generatedAt: envelope.generatedAt,
|
||||
winner: validatedWinner,
|
||||
debug: envelope.debug
|
||||
)
|
||||
}
|
||||
|
||||
enum TextConstraints {
|
||||
static let titleMax = 26
|
||||
static let subtitleMax = 30
|
||||
@@ -97,4 +21,3 @@ extension String {
|
||||
return String(prefix(maxLength - ellipsisCount)) + TextConstraints.ellipsis
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user