-
Notifications
You must be signed in to change notification settings - Fork 0
Add structured data using JSON-LD for TV series in search results #1250
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
src/main/kotlin/fr/shikkanime/services/seo/JsonLdBuilder.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package fr.shikkanime.services.seo | ||
|
|
||
| import com.google.gson.annotations.SerializedName | ||
| import fr.shikkanime.dtos.AnimePlatformDto | ||
| import fr.shikkanime.dtos.PlatformDto | ||
| import fr.shikkanime.dtos.SeasonDto | ||
| import fr.shikkanime.dtos.animes.AnimeDto | ||
| import fr.shikkanime.utils.Constant | ||
| import fr.shikkanime.utils.ObjectParser | ||
|
|
||
| class JsonLdBuilder { | ||
| private data class TvSeriesJsonLd( | ||
| @SerializedName("@context") val context: String = "https://schema.org", | ||
| @SerializedName("@type") val type: String = "TVSeries", | ||
| val name: String, | ||
| val alternateName: String, | ||
| val url: String, | ||
| val thumbnailUrl: String, | ||
| val image: String, | ||
| val description: String?, | ||
| val startDate: String, | ||
| val dateModified: String, | ||
| val inLanguage: Collection<String>?, | ||
| val provider: Collection<ProviderJsonLd>?, | ||
| val numberOfEpisodes: Long, | ||
| val numberOfSeasons: Int, | ||
| val containsSeason: Collection<SeasonJsonLd>?, | ||
| val keywords: String?, | ||
| ) | ||
|
|
||
| private data class ProviderJsonLd( | ||
| @SerializedName("@type") val type: String = "Organization", | ||
| val name: String, | ||
| val url: String, | ||
| val logo: String, | ||
| ) | ||
|
|
||
| private data class SeasonJsonLd( | ||
| @SerializedName("@type") val type: String = "TVSeason", | ||
| val name: String, | ||
| val seasonNumber: Int, | ||
| val startDate: String, | ||
| val dateModified: String, | ||
| val numberOfEpisodes: Long, | ||
| ) | ||
|
|
||
| fun build(anime: AnimeDto, seasons: Set<SeasonDto>, platforms: Set<AnimePlatformDto>): String { | ||
| val sortedSeasons = seasons.sortedBy { it.number } | ||
| val containsSeason = sortedSeasons.map { season -> | ||
| SeasonJsonLd( | ||
| name = "Saison ${season.number}", | ||
| seasonNumber = season.number, | ||
| startDate = season.releaseDateTime, | ||
| dateModified = season.lastReleaseDateTime, | ||
| numberOfEpisodes = season.episodes | ||
| ) | ||
| } | ||
|
|
||
| val totalEpisodes = sortedSeasons.sumOf { it.episodes } | ||
|
|
||
| val uniqueProviders = platforms | ||
| .map(AnimePlatformDto::platform) | ||
| .distinctBy(PlatformDto::id) | ||
| .map { platform -> | ||
| ProviderJsonLd( | ||
| name = platform.name, | ||
| url = platform.url, | ||
| logo = "${Constant.baseUrl}/assets/img/platforms/${platform.image}", | ||
| ) | ||
| } | ||
|
|
||
| val jsonLd = TvSeriesJsonLd( | ||
| name = anime.name, | ||
| alternateName = anime.shortName, | ||
| url = "${Constant.baseUrl}/animes/${anime.slug}", | ||
| thumbnailUrl = "${Constant.apiUrl}/v1/attachments?uuid=${anime.uuid}&type=THUMBNAIL", | ||
| image = "${Constant.apiUrl}/v1/attachments?uuid=${anime.uuid}&type=BANNER", | ||
| description = anime.description, | ||
| startDate = anime.releaseDateTime, | ||
| dateModified = anime.lastUpdateDateTime, | ||
| inLanguage = anime.audioLocales, | ||
| provider = uniqueProviders.takeIf { it.isNotEmpty() }, | ||
| numberOfEpisodes = totalEpisodes, | ||
| numberOfSeasons = sortedSeasons.size, | ||
| containsSeason = containsSeason.takeIf { it.isNotEmpty() }, | ||
| keywords = anime.simulcasts?.joinToString(", ") { it.label } | ||
| ) | ||
|
|
||
| return ObjectParser.toJson(jsonLd) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a bug here. The
JsonLdBuilder.buildmethod is called with the original, unfilteredplatformsset. However, theAnimeDto'splatformIdsproperty is assigned a filtered set of platforms on the previous line. This causes a discrepancy where the generated JSON-LD for search engines includes all platforms (even non-streaming ones when they should be hidden), while the UI shows a filtered list. The JSON-LD should be consistent with the displayed data.You can fix this by passing the filtered
platformIdsfrom the DTO to the builder, which is available within thealsoblock.