Skip to content

Support tags field of streams #775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tymmesyde wants to merge 2 commits into
base: development
Choose a base branch
from
Draft

Support tags field of streams #775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
164933f
feat: add tags field to Stream
tymmesyde Jun 5, 2024
221768b
Merge branch 'development' of https://github.com/Stremio/stremio-core…
tymmesyde Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/types/addon/response.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ use crate::types::{
/// description: Some("South Park - Seasons 1 to 25 (S01-S25) Collectors Edition The Movie and Extras [NVEnc 10Bit 1080p to 2160p HEVC][DD DDP & TrueHD 5.1Ch]\nSeason 02/South Park - S02E05 - Conjoined Fetus Lady.mp4".into()),
/// thumbnail: None,
/// subtitles: vec![],
/// tags: vec![],
/// behavior_hints: StreamBehaviorHints::default(),
/// }
/// ]
Expand Down
2 changes: 2 additions & 0 deletions src/types/resource/meta_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use core::cmp::Ordering;

use std::borrow::Cow;
use std::collections::HashMap;
use std::vec;

use chrono::{DateTime, Utc};
use either::Either;
Expand Down Expand Up @@ -214,6 +215,7 @@ impl From<MetaItemPreviewLegacy> for MetaItemPreview {
},
name: None,
description: None,
tags: vec![],
thumbnail: None,
subtitles: vec![],
behavior_hints: Default::default(),
Expand Down
14 changes: 14 additions & 0 deletions src/types/resource/stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ use crate::types::resource::Subtitles;
/// description: None,
/// thumbnail: None,
/// subtitles: vec![],
/// tags: vec![],
/// behavior_hints: StreamBehaviorHints::default(),
/// };
///
Expand All @@ -47,6 +48,7 @@ use crate::types::resource::Subtitles;
/// "description": null,
/// "thumbnail": null,
/// "subtitles": null,
/// "tags": null,
/// "behaviorHints": null,
/// });
///
Expand All @@ -69,6 +71,9 @@ pub struct Stream {
#[serde(default, skip_serializing_if = "Vec::is_empty")]
#[serde_as(as = "DefaultOnNull<VecSkipError<_>>")]
pub subtitles: Vec<Subtitles>,
#[serde(default, skip_serializing_if = "Vec::is_empty")]
#[serde_as(as = "DefaultOnNull<VecSkipError<_>>")]
pub tags: Vec<Tag>,
#[serde(default, skip_serializing_if = "is_default_value")]
#[serde_as(as = "DefaultOnNull")]
pub behavior_hints: StreamBehaviorHints,
Expand Down Expand Up @@ -146,6 +151,7 @@ impl Stream {
},
name: None,
description: None,
tags: vec![],
thumbnail: None,
subtitles: vec![],
behavior_hints: Default::default(),
Expand Down Expand Up @@ -548,6 +554,14 @@ pub struct StreamBehaviorHints {
pub other: HashMap<String, serde_json::Value>,
}

#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug)]
#[cfg_attr(test, derive(Derivative))]
#[cfg_attr(test, derivative(Default))]
pub struct Tag {
pub name: String,
pub value: String,
}

fn is_default_value<T: Default + PartialEq>(value: &T) -> bool {
*value == T::default()
}
1 change: 1 addition & 0 deletions src/unit_tests/ctx/notifications/update_notifications.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ fn test_pull_notifications_and_play_in_player() {
},
name: None,
description: None,
tags: vec![],
thumbnail: None,
subtitles: vec![],
behavior_hints: Default::default(),
Expand Down
1 change: 1 addition & 0 deletions src/unit_tests/ctx/uninstall_addon.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ fn create_addon_streams_item(addon: &Descriptor) -> StreamsItem {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints::default(),
};
Expand Down
6 changes: 6 additions & 0 deletions src/unit_tests/deep_links/external_player_link.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ fn external_player_link_magnet() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand All @@ -40,6 +41,7 @@ fn external_player_link_http() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -68,6 +70,7 @@ fn external_player_link_torrent() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -109,6 +112,7 @@ fn external_player_link_external() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand All @@ -129,6 +133,7 @@ fn external_player_link_youtube() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -157,6 +162,7 @@ fn external_player_link_player_frame() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down
1 change: 1 addition & 0 deletions src/unit_tests/deep_links/library_item_deep_links.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ static TORRENT_STREAMS_ITEM: Lazy<StreamsItem> = Lazy::new(|| {
name: Some("PaidTV".to_owned()),
description: Some("Ahsoka S01E05 Part Five 1080p".to_owned()),
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints::default(),
};
Expand Down
10 changes: 10 additions & 0 deletions src/unit_tests/deep_links/stream_deep_links.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ fn stream_deep_links_magnet() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand All @@ -48,6 +49,7 @@ fn stream_deep_links_http() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -79,6 +81,7 @@ fn stream_deep_links_http_with_request_headers() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints {
not_web_ready: false,
Expand Down Expand Up @@ -116,6 +119,7 @@ fn stream_deep_links_http_with_request_response_headers_and_query_params() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints {
not_web_ready: false,
Expand Down Expand Up @@ -166,6 +170,7 @@ fn stream_deep_links_torrent() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -228,6 +233,7 @@ fn stream_deep_links_torrent_without_file_index() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -285,6 +291,7 @@ fn stream_deep_links_external() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand All @@ -308,6 +315,7 @@ fn stream_deep_links_youtube() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down Expand Up @@ -343,6 +351,7 @@ fn stream_deep_links_player_frame() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand All @@ -363,6 +372,7 @@ fn stream_deep_links_requests() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: Default::default(),
};
Expand Down
1 change: 1 addition & 0 deletions src/unit_tests/player/next_stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ fn create_stream(binge_group: &str) -> Stream {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints {
binge_group: Some(binge_group.to_owned()),
Expand Down
18 changes: 17 additions & 1 deletion src/unit_tests/serde/default_tokens_ext.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use crate::types::library::LibraryItemState;
use crate::types::profile::{Auth, AuthKey, GDPRConsent, Settings, User};
use crate::types::resource::{
MetaItem, MetaItemBehaviorHints, PosterShape, SeriesInfo, StreamBehaviorHints, StreamSource,
Subtitles,
Subtitles, Tag,
};
use crate::types::True;
use serde_test::Token;
Expand Down Expand Up @@ -51,6 +51,22 @@ impl DefaultTokens for LibraryItemState {
}
}

impl DefaultTokens for Tag {
fn default_tokens() -> Vec<Token> {
vec![
Token::Struct {
name: "Tag",
len: 2,
},
Token::Str("name"),
Token::Str(""),
Token::Str("value"),
Token::Str(""),
Token::StructEnd,
]
}
}

impl DefaultTokens for Subtitles {
fn default_tokens() -> Vec<Token> {
vec![
Expand Down
3 changes: 3 additions & 0 deletions src/unit_tests/serde/meta_item_preview.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ fn meta_item_preview_de_legacy_links() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints::default(),
},
Expand All @@ -435,6 +436,7 @@ fn meta_item_preview_de_legacy_links() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints::default(),
}
Expand Down Expand Up @@ -515,6 +517,7 @@ fn meta_item_preview_de_ignore_legacy_when_links() {
name: None,
description: None,
thumbnail: None,
tags: vec![],
subtitles: vec![],
behavior_hints: StreamBehaviorHints::default(),
}],
Expand Down
14 changes: 13 additions & 1 deletion src/unit_tests/serde/stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::types::resource::{Stream, StreamBehaviorHints, StreamSource, Subtitles};
use crate::types::resource::{Stream, StreamBehaviorHints, StreamSource, Subtitles, Tag};
use crate::unit_tests::serde::default_tokens_ext::{DefaultFlattenTokens, DefaultTokens};
use serde_test::{assert_de_tokens, assert_tokens, Configure, Token};

Expand All @@ -12,6 +12,7 @@ fn stream() {
description: None,
thumbnail: None,
subtitles: vec![],
tags: vec![],
behavior_hints: StreamBehaviorHints::default(),
},
Stream {
Expand All @@ -20,6 +21,7 @@ fn stream() {
description: Some("description".to_owned()),
thumbnail: Some("thumbnail".to_owned()),
subtitles: vec![Subtitles::default()],
tags: vec![Tag::default()],
behavior_hints: StreamBehaviorHints {
not_web_ready: true,
..StreamBehaviorHints::default()
Expand Down Expand Up @@ -49,6 +51,13 @@ fn stream() {
Token::Seq { len: Some(1) },
],
Subtitles::default_tokens(),
vec![
Token::SeqEnd,
Token::Str("tags"),
Token::Some,
Token::Seq { len: Some(1) },
],
Tag::default_tokens(),
vec![
Token::SeqEnd,
Token::Str("behaviorHints"),
Expand All @@ -70,6 +79,7 @@ fn stream() {
description: None,
thumbnail: None,
subtitles: vec![],
tags: vec![],
behavior_hints: StreamBehaviorHints::default(),
}
.readable(),
Expand All @@ -85,6 +95,8 @@ fn stream() {
Token::None,
Token::Str("subtitles"),
Token::None,
Token::Str("tags"),
Token::None,
Token::Str("behaviorHints"),
Token::None,
],
Expand Down
2 changes: 2 additions & 0 deletions src/unit_tests/serde/video.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ fn video() {
description: None,
thumbnail: None,
subtitles: vec![],
tags: vec![],
behavior_hints: StreamBehaviorHints::default(),
}],
series_info: None,
Expand All @@ -123,6 +124,7 @@ fn video() {
description: None,
thumbnail: None,
subtitles: vec![],
tags: vec![],
behavior_hints: StreamBehaviorHints::default(),
}],
series_info: None,
Expand Down
Loading