animedb 0.6.2

Local-first anime and manga metadata catalog for Rust media servers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
//! Orchestrates paginated provider-to-catalog sync runs.
//!
//! ## Sync flow
//!
//! 1. Load persisted [`PersistedSyncState`] for the provider + scope (if any)
//! 2. Fetch one page from the provider via [`Provider::fetch_page`]
//! 3. Upsert each media item into the catalog (merge engine runs automatically)
//! 4. Persist the updated cursor to `sync_state`
//! 5. Repeat until the provider returns an empty page or `max_pages` is reached
//!
//! ## Provider rate limiting
//!
//! Each provider declares a [`Provider::min_interval`]; the service enforces it
//! by calling `thread::sleep` between page fetches. The sync loop is therefore
//! cooperative and will not hammer a provider's API.

use crate::db::AnimeDb;
use crate::error::{Error, Result};
use crate::model::*;
use crate::provider::*;
use std::path::Path;
use std::thread;

/// Orchestrates sync operations against one open [`AnimeDb`] instance.
///
/// Obtain via [`AnimeDb::sync_service`](crate::db::AnimeDb::sync_service).
pub struct SyncService<'a> {
    /// The database instance to sync into.
    pub db: &'a mut AnimeDb,
}

impl<'a> SyncService<'a> {
    /// Syncs from a single provider using a custom [`SyncRequest`].
    ///
    /// Validates that `provider.source()` matches `request.source`, then
    /// iterates over pages until the provider is exhausted or `max_pages` is reached.
    ///
    /// Cursor state is persisted after every page, so interrupted syncs can be
    /// resumed by calling this again with the same provider + request.
    pub fn sync_from<P: Provider>(
        &mut self,
        provider: &P,
        request: SyncRequest,
    ) -> Result<SyncOutcome> {
        if provider.source() != request.source {
            return Err(Error::Validation(format!(
                "sync source mismatch: request={} provider={}",
                request.source,
                provider.source()
            )));
        }

        let scope = request
            .media_kind
            .map(|kind| kind.as_str().to_string())
            .unwrap_or_else(|| "all".to_string());

        let mut cursor = request
            .start_cursor
            .clone()
            .or_else(|| {
                self.db
                    .sync_state()
                    .load_sync_state(request.source, &scope)
                    .ok()
                    .and_then(|state| state.cursor)
            })
            .unwrap_or_default();

        let max_pages = request.max_pages.unwrap_or(usize::MAX);
        let mut fetched_pages = 0usize;
        let mut upserted_records = 0usize;
        let mut last_cursor = None;

        while fetched_pages < max_pages {
            let page = provider.fetch_page(&request, cursor.clone())?;
            if page.items.is_empty() {
                self.db.sync_state().save_sync_state(PersistedSyncState {
                    source: request.source,
                    scope: scope.clone(),
                    cursor: last_cursor.clone(),
                    last_success_at: Some(now_string()),
                    last_error: None,
                    last_page: last_cursor.as_ref().map(|value| value.page as i64),
                    mode: request.mode,
                })?;
                break;
            }

            for item in &page.items {
                let _media_id = self.db.upsert_media(item)?;
                upserted_records += 1;
            }
            fetched_pages += 1;
            last_cursor = Some(cursor.clone());

            self.db
                .sync_state()
                .save_sync_state(PersistedSyncState {
                    source: request.source,
                    scope: scope.clone(),
                    cursor: last_cursor.clone(),
                    last_success_at: Some(now_string()),
                    last_error: None,
                    last_page: Some(cursor.page as i64),
                    mode: request.mode,
                })
                .expect("save_sync_state should not fail");

            let Some(next_cursor) = page.next_cursor else {
                break;
            };

            cursor = next_cursor;
            let sleep_for = provider.min_interval();
            if !sleep_for.is_zero() {
                thread::sleep(sleep_for);
            }
        }

        Ok(SyncOutcome {
            source: request.source,
            media_kind: request.media_kind,
            fetched_pages,
            upserted_records,
            last_cursor,
        })
    }

    /// Syncs all default providers: AniList, Jikan, Kitsu (anime + manga),
    /// TVmaze (shows), and IMDb (shows + movies).
    pub fn sync_default_sources(&mut self) -> Result<SyncReport> {
        let anilist = AniListProvider::default();
        let jikan = JikanProvider::default();
        let kitsu = KitsuProvider::default();
        let tvmaze = TvmazeProvider::default();
        let imdb = ImdbProvider::default();
        let mut outcomes = Vec::new();

        for media_kind in [MediaKind::Anime, MediaKind::Manga] {
            outcomes.push(self.sync_from(
                &anilist,
                SyncRequest::new(SourceName::AniList).with_media_kind(media_kind),
            )?);
            outcomes.push(self.sync_from(
                &jikan,
                SyncRequest::new(SourceName::Jikan).with_media_kind(media_kind),
            )?);
            outcomes.push(self.sync_from(
                &kitsu,
                SyncRequest::new(SourceName::Kitsu).with_media_kind(media_kind),
            )?);
        }

        outcomes.push(self.sync_from(
            &tvmaze,
            SyncRequest::new(SourceName::Tvmaze).with_media_kind(MediaKind::Show),
        )?);

        for media_kind in [MediaKind::Show, MediaKind::Movie] {
            outcomes.push(self.sync_from(
                &imdb,
                SyncRequest::new(SourceName::Imdb).with_media_kind(media_kind),
            )?);
        }

        let total_upserted_records = outcomes.iter().map(|item| item.upserted_records).sum();

        Ok(SyncReport {
            outcomes,
            total_upserted_records,
        })
    }

    /// Convenience — opens a database at `path`, runs [`SyncService::sync_default_sources`],
    /// and returns the report.
    pub fn sync_database(path: impl AsRef<Path>) -> Result<SyncReport> {
        let mut db = AnimeDb::open(path)?;
        db.sync_default_sources()
    }

    /// Syncs AniList for one media kind.
    pub fn sync_anilist(&mut self, media_kind: MediaKind) -> Result<SyncOutcome> {
        self.sync_from(
            &AniListProvider::default(),
            SyncRequest::new(SourceName::AniList).with_media_kind(media_kind),
        )
    }

    /// Syncs Jikan for one media kind.
    pub fn sync_jikan(&mut self, media_kind: MediaKind) -> Result<SyncOutcome> {
        self.sync_from(
            &JikanProvider::default(),
            SyncRequest::new(SourceName::Jikan).with_media_kind(media_kind),
        )
    }

    /// Syncs Kitsu for one media kind.
    pub fn sync_kitsu(&mut self, media_kind: MediaKind) -> Result<SyncOutcome> {
        self.sync_from(
            &KitsuProvider::default(),
            SyncRequest::new(SourceName::Kitsu).with_media_kind(media_kind),
        )
    }

    /// Syncs TVmaze (shows only).
    pub fn sync_tvmaze(&mut self) -> Result<SyncOutcome> {
        self.sync_from(
            &TvmazeProvider::default(),
            SyncRequest::new(SourceName::Tvmaze).with_media_kind(MediaKind::Show),
        )
    }

    /// Syncs IMDb for one media kind.
    pub fn sync_imdb(&mut self, media_kind: MediaKind) -> Result<SyncOutcome> {
        self.sync_from(
            &ImdbProvider::default(),
            SyncRequest::new(SourceName::Imdb).with_media_kind(media_kind),
        )
    }

    /// Syncs episodes for all media items currently in the catalog.
    ///
    /// For IMDb, downloads the full `.tsv.gz` episode dumps and maps them efficiently.
    /// For TVMaze, Jikan, and Kitsu, queries the REST API per-media item.
    pub fn sync_all_episodes(&mut self) -> Result<usize> {
        let mut total_upserted = 0;

        let mut imdb_parents = std::collections::HashMap::new();
        let mut api_targets = Vec::new();

        {
            let mut stmt = self
                .db
                .connection()
                .prepare("SELECT media_id, media_kind, source, source_id FROM media_external_id")?;
            let rows = stmt.query_map([], |row| {
                Ok((
                    row.get::<_, i64>(0)?,
                    row.get::<_, String>(1)?,
                    row.get::<_, String>(2)?,
                    row.get::<_, String>(3)?,
                ))
            })?;

            for row in rows {
                let (media_id, kind_str, source_str, source_id) = row?;
                if let (Ok(source), Ok(kind)) = (
                    source_str.parse::<SourceName>(),
                    kind_str.parse::<MediaKind>(),
                ) {
                    if source == SourceName::Imdb {
                        imdb_parents.insert(source_id, media_id);
                    } else if matches!(
                        source,
                        SourceName::Tvmaze | SourceName::Jikan | SourceName::Kitsu
                    ) {
                        api_targets.push((source, source_id, media_id, kind));
                    }
                }
            }
        }

        let registry = crate::provider::registry::default_registry();
        for (source, source_id, media_id, kind) in api_targets {
            if let Ok(provider) = registry.get(source) {
                if let Ok(episodes) = provider.fetch_episodes(kind, &source_id) {
                    for ep in episodes {
                        if self
                            .db
                            .episodes()
                            .upsert_episode_source_record_no_merge(&ep, media_id)
                            .is_ok()
                        {
                            total_upserted += 1;
                        }
                    }
                    let _ = self.db.episodes().merge_episodes_for_media(media_id);
                }

                let sleep_for = provider.min_interval();
                if !sleep_for.is_zero() {
                    thread::sleep(sleep_for);
                }
            }
        }

        if !imdb_parents.is_empty() {
            let imdb = ImdbProvider::default();
            let valid_parents: std::collections::HashSet<String> =
                imdb_parents.keys().cloned().collect();
            let mut media_ids_to_merge = std::collections::HashSet::new();

            imdb.fetch_all_episodes(&valid_parents, |ep| {
                if let Some(parent_id) = ep
                    .raw_json
                    .as_ref()
                    .and_then(|j| j.get("parentTconst"))
                    .and_then(|v| v.as_str())
                {
                    if let Some(&media_id) = imdb_parents.get(parent_id) {
                        if self
                            .db
                            .episodes()
                            .upsert_episode_source_record_no_merge(&ep, media_id)
                            .is_ok()
                        {
                            total_upserted += 1;
                        }
                        media_ids_to_merge.insert(media_id);
                    }
                }
            })?;

            for media_id in media_ids_to_merge {
                let _ = self.db.episodes().merge_episodes_for_media(media_id);
            }
        }

        Ok(total_upserted)
    }
}

fn now_string() -> String {
    let unix = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .unwrap_or_default()
        .as_secs();
    unix.to_string()
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::error::Result;
    use crate::model::{CanonicalEpisode, ExternalId, SourcePayload};
    use std::sync::{Arc, Mutex};
    use std::time::Duration;

    struct CallLog {
        fetch_page_calls: Vec<SyncCursor>,
        fetch_episodes_calls: Vec<String>,
    }

    impl CallLog {
        fn new() -> Self {
            Self {
                fetch_page_calls: Vec::new(),
                fetch_episodes_calls: Vec::new(),
            }
        }
    }

    struct MockProvider {
        source_name: SourceName,
        min_interval_: Duration,
        pages: Vec<Vec<CanonicalMedia>>,
        episodes: Vec<CanonicalEpisode>,
        call_log: Arc<Mutex<CallLog>>,
    }

    impl MockProvider {
        fn new(source: SourceName) -> Self {
            Self {
                source_name: source,
                min_interval_: Duration::from_millis(10),
                pages: Vec::new(),
                episodes: Vec::new(),
                call_log: Arc::new(Mutex::new(CallLog::new())),
            }
        }

        fn with_pages(mut self, pages: Vec<Vec<CanonicalMedia>>) -> Self {
            self.pages = pages;
            self
        }

        fn with_episodes(mut self, episodes: Vec<CanonicalEpisode>) -> Self {
            self.episodes = episodes;
            self
        }
    }

    impl Provider for MockProvider {
        fn source(&self) -> SourceName {
            self.source_name
        }

        fn min_interval(&self) -> Duration {
            self.min_interval_
        }

        fn fetch_page(&self, _request: &SyncRequest, cursor: SyncCursor) -> Result<FetchPage> {
            self.call_log
                .lock()
                .unwrap()
                .fetch_page_calls
                .push(cursor.clone());
            let idx = cursor.page.saturating_sub(1) as usize;
            let items = self.pages.get(idx).cloned().unwrap_or_default();
            let next_cursor = if cursor.page < self.pages.len() {
                Some(SyncCursor {
                    page: cursor.page + 1,
                })
            } else {
                None
            };
            Ok(FetchPage { items, next_cursor })
        }

        fn search(&self, _query: &str, _options: SearchOptions) -> Result<Vec<CanonicalMedia>> {
            Ok(Vec::new())
        }

        fn get_by_id(
            &self,
            _media_kind: MediaKind,
            _source_id: &str,
        ) -> Result<Option<CanonicalMedia>> {
            Ok(None)
        }

        fn fetch_episodes(
            &self,
            _media_kind: MediaKind,
            source_id: &str,
        ) -> Result<Vec<CanonicalEpisode>> {
            self.call_log
                .lock()
                .unwrap()
                .fetch_episodes_calls
                .push(source_id.to_string());
            Ok(self.episodes.clone())
        }
    }

    fn make_media(id: i64, source: SourceName, source_id: &str) -> CanonicalMedia {
        CanonicalMedia {
            media_kind: MediaKind::Anime,
            title_display: format!("Media {}", id),
            title_romaji: None,
            title_english: None,
            title_native: None,
            synopsis: None,
            format: None,
            status: None,
            season: None,
            season_year: None,
            episodes: None,
            chapters: None,
            volumes: None,
            country_of_origin: None,
            cover_image: None,
            banner_image: None,
            provider_rating: None,
            nsfw: false,
            aliases: Vec::new(),
            genres: Vec::new(),
            tags: Vec::new(),
            external_ids: vec![ExternalId {
                source,
                source_id: source_id.to_string(),
                url: None,
            }],
            source_payloads: vec![SourcePayload {
                source,
                source_id: source_id.to_string(),
                url: None,
                remote_updated_at: None,
                raw_json: None,
            }],
            field_provenance: Vec::new(),
        }
    }

    fn make_episode(source_id: &str) -> CanonicalEpisode {
        CanonicalEpisode {
            source: SourceName::Jikan,
            source_id: source_id.to_string(),
            media_kind: MediaKind::Anime,
            season_number: Some(1),
            episode_number: Some(1),
            absolute_number: None,
            title_display: Some("Episode 1".into()),
            title_original: None,
            synopsis: None,
            air_date: None,
            runtime_minutes: None,
            thumbnail_url: None,
            raw_titles_json: None,
            raw_json: None,
        }
    }

    #[test]
    fn sync_from_paginates_through_all_pages() {
        let mut db = AnimeDb::open_in_memory().unwrap();
        let call_log = Arc::new(Mutex::new(CallLog::new()));

        let provider = MockProvider {
            source_name: SourceName::Jikan,
            min_interval_: Duration::ZERO,
            pages: vec![
                vec![make_media(1, SourceName::Jikan, "1")],
                vec![make_media(2, SourceName::Jikan, "2")],
            ],
            episodes: vec![],
            call_log: call_log.clone(),
        };

        let outcome = db
            .sync_from(&provider, SyncRequest::new(SourceName::Jikan))
            .unwrap();

        assert_eq!(outcome.fetched_pages, 2);
        assert_eq!(outcome.upserted_records, 2);
        assert_eq!(
            outcome.last_cursor.as_ref().map(|c| c.page),
            Some(2),
            "last_cursor should be page 2 after exhausting 2 pages"
        );

        let calls = call_log.lock().unwrap().fetch_page_calls.clone();
        assert_eq!(calls.len(), 2);
        assert_eq!(calls[0].page, 1);
        assert_eq!(calls[1].page, 2);
    }

    #[test]
    fn sync_from_does_not_call_fetch_episodes_inline() {
        let mut db = AnimeDb::open_in_memory().unwrap();
        let call_log = Arc::new(Mutex::new(CallLog::new()));

        let provider = MockProvider {
            source_name: SourceName::Jikan,
            min_interval_: Duration::ZERO,
            pages: vec![vec![make_media(1, SourceName::Jikan, "1")]],
            episodes: vec![make_episode("1")],
            call_log: call_log.clone(),
        };

        let _ = db
            .sync_from(&provider, SyncRequest::new(SourceName::Jikan))
            .unwrap();

        let episodes_calls = call_log.lock().unwrap().fetch_episodes_calls.clone();
        assert!(
            episodes_calls.is_empty(),
            "sync_from should not call fetch_episodes inline; got calls: {episodes_calls:?}"
        );
    }

    #[test]
    fn sync_from_validates_source_mismatch() {
        let mut db = AnimeDb::open_in_memory().unwrap();

        let provider = MockProvider {
            source_name: SourceName::Tvmaze,
            min_interval_: Duration::ZERO,
            pages: vec![],
            episodes: vec![],
            call_log: Arc::new(Mutex::new(CallLog::new())),
        };

        let result = db.sync_from(
            &provider,
            SyncRequest::new(SourceName::Jikan).with_max_pages(1),
        );

        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(
            err.to_string().contains("mismatch"),
            "expected mismatch error, got: {err}"
        );
    }

    #[test]
    fn sync_from_respects_rate_limiting() {
        let mut db = AnimeDb::open_in_memory().unwrap();
        let call_log = Arc::new(Mutex::new(CallLog::new()));

        let provider = MockProvider {
            source_name: SourceName::Jikan,
            min_interval_: Duration::from_millis(50),
            pages: vec![
                vec![make_media(1, SourceName::Jikan, "1")],
                vec![make_media(2, SourceName::Jikan, "2")],
            ],
            episodes: vec![],
            call_log: call_log.clone(),
        };

        let start = std::time::Instant::now();
        let _ = db
            .sync_from(&provider, SyncRequest::new(SourceName::Jikan))
            .unwrap();
        let elapsed = start.elapsed();

        assert!(
            elapsed >= Duration::from_millis(50),
            "rate limiting should introduce at least 50ms delay between pages, got {:?}",
            elapsed
        );
    }

    #[test]
    fn sync_from_persists_cursor_after_each_page() {
        let mut db = AnimeDb::open_in_memory().unwrap();
        let call_log = Arc::new(Mutex::new(CallLog::new()));

        let provider = MockProvider {
            source_name: SourceName::Jikan,
            min_interval_: Duration::ZERO,
            pages: vec![
                vec![make_media(1, SourceName::Jikan, "1")],
                vec![make_media(2, SourceName::Jikan, "2")],
            ],
            episodes: vec![],
            call_log: call_log.clone(),
        };

        let _ = db
            .sync_from(&provider, SyncRequest::new(SourceName::Jikan))
            .unwrap();

        let state = db
            .sync_state()
            .load_sync_state(SourceName::Jikan, "all")
            .expect("sync state should be persisted after sync");
        eprintln!("DEBUG: state.cursor = {:?}", state.cursor);
        assert!(
            state.cursor.is_some(),
            "cursor should be persisted after sync completes"
        );
        assert_eq!(
            state.cursor.as_ref().unwrap().page,
            2,
            "cursor should be the last fetched page (2) after exhausting pages"
        );
    }

    #[test]
    fn sync_from_resumes_from_prior_cursor() {
        let mut db = AnimeDb::open_in_memory().unwrap();
        let call_log = Arc::new(Mutex::new(CallLog::new()));

        let provider = MockProvider {
            source_name: SourceName::Jikan,
            min_interval_: Duration::ZERO,
            pages: vec![
                vec![make_media(1, SourceName::Jikan, "1")],
                vec![make_media(2, SourceName::Jikan, "2")],
                vec![make_media(3, SourceName::Jikan, "3")],
            ],
            episodes: vec![],
            call_log: call_log.clone(),
        };

        db.sync_from(
            &provider,
            SyncRequest::new(SourceName::Jikan).with_start_cursor(SyncCursor { page: 2 }),
        )
        .unwrap();

        let calls = call_log.lock().unwrap().fetch_page_calls.clone();
        assert_eq!(
            calls.first().map(|c| c.page),
            Some(2),
            "resume should start from saved cursor page 2"
        );
    }

    #[test]
    fn sync_all_episodes_fetches_episodes_for_each_target() {
        let mut db = AnimeDb::open_in_memory().unwrap();

        db.upsert_media(&make_media(1, SourceName::Tvmaze, "tvmaze_1"))
            .unwrap();
        db.upsert_media(&make_media(2, SourceName::Jikan, "jikan_2"))
            .unwrap();

        let registry = crate::provider::registry::default_registry();

        let tvmaze_count = if let Ok(p) = registry.get(SourceName::Tvmaze) {
            let _ = p.fetch_episodes(MediaKind::Show, "tvmaze_1");
            1
        } else {
            0
        };

        let jikan_count = if let Ok(p) = registry.get(SourceName::Jikan) {
            let _ = p.fetch_episodes(MediaKind::Anime, "jikan_2");
            1
        } else {
            0
        };

        assert_eq!(
            tvmaze_count + jikan_count,
            2,
            "both TVmaze and Jikan should be retrievable from the registry"
        );
    }
}