Update to new Review system

irfan-dahir commented 2 years ago

I thought it would be better to get a draft PR up first as the changes are more larger than I thought - so it'd be better to have a definition to keep track of.

MAL rehauled their review system.

Affects: #446

Possibly Affected Requests/Endpoints

Anime/Reviews
User Reviews (from user profile)
Recent Reviews

Changes

Apart from the HTML changes MAL has removed/added some things.

Added reactions for reviews:
Removed Overall Scorings provided by the reviewer.

In the process of increasing the textbox area and improving the display of the write a review page, we removed the old score sections (Story, Art, ...) There were two main reasons for this: (1) these scores weren't visible on the main view of the review (unless you knew the trick to make it appear), and (2) we found it gave writers the impression that they were required to break their reviews down into these sections, which we wanted to avoid. 🔖　If you entered scores in the Story, Art,... sections on old reviews, these scores have been appended to the end of your review text.

This is possibly replaced with just this:

MAL also introduced a global review tag based on the reactions:

New review categories/tags　✅ Different users have different scoring tendencies, and it is difficult to tell from an overall rating alone whether the review writer is recommending the anime/manga to the reader or not. To make it easier for readers to find and compare contrasting perspectives ("You should watch this", "Don't go near it"), we have categorized reviews into three groups: Recommended → Placeholder: Overall 7-10 Mixed Feelings → Placeholder: Overall 5-6 Not Recommended → Placeholder: Overall 1-4 　　🔖　As a placeholder, we automatically labelled existing reviews. 　　🔖　Writers can edit their existing reviews to adjust the tag (as necessary) without needing to modify their score.

To help find reviews written with a specific style, we have also added four categories/tags which will be based on reader feedback: Informational, Well-written → For truly "Helpful" and eloquent reviews Funny, Creative → For writers who prefer to write (for example) in poem or overly theatrical prose 　　🔖　Review moderators will be able to add/remove labels as necessary to preserve the feature's intended use.

So we can expect the following tags: Recommended, Mixed Feelings, Not Recommended

Prelimary reviews only return the no of episodes watched and are tagged as such.
Spoiler warning

Show who has voted on a review　🔜 The main reason for showing the username list of review votes is to make botting easily visible to all members. Understandably, negative reactions more easily incite anger in the community, so this was the reason the updated list of feedback options do not contain noticeably negative responses.

　　🔖　Clicking the area which displays the total review votes will bring up a pop-up with the username list.

It's to note that MAL will be adding a way to know who reacted what on the review. Ignoring this for this PR as it's not implemented yet.

New Featuers Added

[x] User Reactions
[x] Review Category/Tags
[x] Spoiler warning
[x] Preliminary notice

Schema Updates

[x] Anime Review
[x] Manga Review
[x] User Anime Review
[x] User Manga Review
[x] Recent Anime Review
[x] Recent Manga Review

Request Updates

[x] Anime Reviews Page
[x] Manga Reviews Page
[x] User Reviews (Profile) Page
[x] Reviews (previously Recent Reviews)

irfan-dahir commented 2 years ago

getRecentReviews will be renamed to getReviews.

MAL has removed the mixed recent reviews page. It's just now 1 review page with 2 tabs; Anime and Manga. And they both the same filters as Anime/Manga Review pages.

None of this is backward compatible as this will change some method names and parameters. Should tag this as a v4 release.

Constants removed

    public const RECENT_REVIEW_ANIME = 'anime';
    public const RECENT_REVIEW_MANGA = 'manga';
    public const RECENT_REVIEW_BEST_VOTED = 'bestvoted';

irfan-dahir commented 2 years ago

Alright, it should be good for review (pun unintended).

Reviews

$data = $jikan->getReviews(
    new \Jikan\Request\Reviews\ReviewsRequest(
        \Jikan\Helper\Constants::MANGA, // type
        1, // page
        \Jikan\Helper\Constants::REVIEWS_SORT_MOST_VOTED, // sort
        true, // show spoilers
        true // show preliminary
    )
);

Parses: https://myanimelist.net/reviews.php?t=manga&spoiler=on&preliminary=on&sort=mostvoted

Anime/Manga Reviews

$data = $jikan->getAnimeReviews(
    new \Jikan\Request\Anime\AnimeReviewsRequest(
        1, // MAL ID
        1, // page
        \Jikan\Helper\Constants::REVIEWS_SORT_MOST_VOTED, //sort
        true, // show spoilers
        false // show preliminary
        )
);

Parses: https://myanimelist.net/anime/1/Cowboy_Bebop/reviews?sort=mostvoted&spoiler=on&preliminary=off

User Reviews

$data = $jikan->getUserReviews(
    new \Jikan\Request\User\UserReviewsRequest('Stark700', 1) // username and page
);

Parses: https://myanimelist.net/profile/Stark700/reviews

jikan-me / jikan