WStarRating: don't update track directly, use signals/slots #11565

ronso0 · 2023-05-17T09:35:59Z

changes to the star rating are now handled via change signals, like with the QLineEdits

edit: instead of working around the symptom, as per @uklotzde's suggestion, this PR now adds slots and signals for track rating. Now it's consistent with other track properties and WStarRating now much smaller.

Note: updating the rating (or any other track property) elsewhere emits the trackCganged signal and will therefore still wipe pending changes in the properties dialog. This is not a bug.

uklotzde · 2023-05-17T10:57:47Z

src/widget/wstarrating.cpp

@@ -166,7 +174,11 @@ void WStarRating::mouseReleaseEvent(QMouseEvent* /*unused*/) {
        return;
    }

-    m_pCurrentTrack->setRating(m_starRating.starCount());
+    m_currRating = m_starRating.starCount();
+    if (m_updateTrack) {


Thanks for addressing these issues. QML will hopefully help to prevent those mistakes in the (far away) future.

The widget should never directly update the track state on its own. Instead the receiver of the signal could do that if desired or otherwise reject the proposed new value by resetting the widget -> unidirectional data flow.

Offering both options is confusing and not maintainable. But I am afraid that trying to avoid this mixed behavior could open another Pandora's Box.

Ideally the widget would only offer a slot for setting the rating (input, write-only) and emit a signal when the rating changed (output, read-only). Maybe a getter for reading the current rating on demand. No track pointer, no implicit context management.

I understand what you're saying, and I agree that WStarRating becomes more complex and bit harder to maintain. Looks like this can be changed without too much hazzle, with a few changes to Track and BaseTrackPlayer(Impl) (and mediators like LegacySkinParser, and DlgTrackinfo, of course), and WStarRating would be quite clean then.

I think I'll take a stab at this for 2.4 beta, though it's out of scope for this quick bug fix.

Then try to add the basic building blocks to the current design and (important!) TODO comments, i.e. to remove m_pCurrentTrack. Otherwise the direction is unclear.

ronso0 · 2023-05-18T16:31:06Z

@uklotzde That was easier than I thought, though tedious.
I went back to square one and reverted the previous commit.
Please take a look.

uklotzde

Glad to hear that this was easier than expected. The refactoring avoids to pile up more legacy code.

src/widget/wstarrating.h

src/mixer/basetrackplayer.h

uklotzde · 2023-05-18T18:23:53Z

src/widget/wstarrating.cpp

-        m_starRating.setStarCount(star);
-        update();
-        m_pCurrentTrack->setRating(star);
+        emit ratingChangeRequest(star);


The signal should only be emitted if the value has actually changed to prevent cycles.

Sure. This just handles the group,stars_up CO and changes the current value. The cycle prevention is in Track::setRating.

However, I changed this method to work with m_currRating, i.e. the stored value delivered by Track::ratingUpdated, not the visual state (which avoids confusion in the unlikely case a user hovers the rating and uses the CO).

uklotzde · 2023-05-18T18:25:58Z

src/widget/wstarrating.cpp

 }

 void WStarRating::fillDebugTooltip(QStringList* debug) {
    WWidget::fillDebugTooltip(debug);

-    QString currentRating = "-";
+    QString currentRating;
+    currentRating.setNum(m_currRating);


What's the difference between m_currRating and m_starRating? The widget should not store any redundant state that could get inconsistent.

m_starRating.starCount() is the current value of StarRating, i.e. what you see (for example while hovering).
m_currRating is the confirmed value of the track / pending track record value in DlgTrackInfo, after LeaveEvent.

Then m_currRating is redundant. The widget should maintain only a single value and don't care about the state of its clients or subscribers.

Then m_currRating is redundant.

Redundant with what?
The current value of StarRating (separate paint class!) (starCount()) just reflects the count of currently painted stars, be it final (clicked, not necessarily accepted by Track or DlgTrackInfo) or temporary (hovering, mouse moving).

Only m_currRating is storing the applied / real value and we need that for the COs and to restore the real value when leaving the widget (after mouse move, not clicked).

I'll check it later. Only viewed the diff, not the whole code.

Nevertheless my comments reveal that meaning and purpose of those member variables is unclear on first sight.

uklotzde · 2023-05-18T18:28:14Z

src/track/track.h

@@ -436,6 +436,7 @@ class Track : public QObject {
    // adjusted in the opposite direction to compensate (no audible change).
    void replayGainAdjusted(const mixxx::ReplayGain&);
    void colorUpdated(const mixxx::RgbColor::optional_t& color);
+    void ratingUpdated(int rating);


I would prefer the neutral and agnostic changed terminology. That would be inconsistent with the existing signals, but we could add a TODO to rename those later.

ronso0 · 2023-05-18T21:33:06Z

pushed some fixups which I'd like to squash if they're okay.

ronso0 · 2023-05-18T22:18:39Z

src/widget/wstarrating.cpp

-    if (m_pCurrentTrack) {
-        currentRating.setNum(m_pCurrentTrack->getRating());
-    }


showing - / 5 in the debug tooltip with no track would be the only reason to track the "track loaded" state. not worth the effort IMO

ronso0 · 2023-05-18T22:38:19Z

pushed some fixups which I'd like to squash if they're okay.

setting this to draft just to avoid accidental merge.

uklotzde · 2023-05-18T22:38:20Z

pushed some fixups which I'd like to squash if they're okay.

Sure. I will take a final look when done.

ronso0 · 2023-05-18T22:50:50Z

Go ahead, I'm done, I just addressed your review comments and packed the changes in small chunks for easy review.
Added a missing slotSetRating to DlgTrackInfo. All performs as expected.

uklotzde · 2023-05-20T09:17:10Z

Stopping my review here. I wasn't able to fully understand what the code is supposed to do, already wasted too much time. If it works, then feel free to merge it. This has to be rewritten for QML anyway.

Previously, WStarRating updated the track directly. Undesired side effect was that changing the rating in DlgTrackInfo causes Track::changed() to be emitted which in turn would clear other pending changes in the current dialog. Note that changing the rating or any other track property elsewhere (library or another DlgTrackInfo instance still causes track metadata to be reloaded.

ronso0 · 2023-05-20T12:55:55Z

@uklotzde Thanks for your time and ronso0#43.
Your renaming and cleanup commits are valuable so I'll pick them, I'll just revert (ammend) that one small thing I spotted.

It's working fine now: rating is synced if updated anywhere (library, decks, DlgTrackInfo), and (still) it's not possible to set the rating in an empty deck (or empty DlgTrackInfo, if that could be displayed).

daschuer · 2023-06-13T07:50:29Z

@ronso0 do you still plan to rebase this or does it put to much work on us?

daschuer · 2023-06-13T07:50:43Z

@ronso0 do you still plan to rebase this or does it put to much work on us?

ronso0 · 2023-06-13T08:10:38Z

Thanks for the reminder!
Yes, I can rebase onto 2.3

ronso0 · 2023-06-13T08:22:20Z

Meeh, too many conflicts IMO. Resolving those now and when merging to 2.4 is a PITA.

As far as I can tell, unitl now there are only minor issues reported for 2.3 (fixed since 2.3.5) that don't justify another bugfix release, so let's merge to 2.4 and save the time for more important stuff.
What do you think?

uklotzde · 2023-06-13T09:41:01Z

I also don't recommend rebasing. Too much has changed since then.

daschuer

LGTM and works good, Thank you.

ronso0 · 2023-07-02T12:25:06Z

Thanks for reviewing!

ronso0 · 2023-07-23T14:38:28Z

src/widget/wstarrating.cpp

-    Q_UNUSED(trackId);
-    updateRatingFromTrack();
+    m_starCount = starCount;
+    updateVisualRating(starCount);


had to add emit ratingChanged(m_starCount) in order to make the _up/_down controls to also update the track value
pushed a fix 0550e07

ronso0 added library ui regression labels May 17, 2023

ronso0 linked an issue May 17, 2023 that may be closed by this pull request

Updating Star rating in track properties clears other unsaved properties #11540

Closed

uklotzde reviewed May 17, 2023

View reviewed changes

WStarRating: remove unneeded group member

92c5560

ronso0 force-pushed the star-dlgtrackinfo branch from 7ad6ba4 to 92ff79f Compare May 18, 2023 16:29

uklotzde suggested changes May 18, 2023

View reviewed changes

ronso0 changed the title ~~DlgTrackInfo: don't update from track when user changes star rating~~ WStarRating: don't update track directly, use signals/slots May 18, 2023

ronso0 force-pushed the star-dlgtrackinfo branch from 92ff79f to 3fdcd42 Compare May 18, 2023 21:31

github-actions bot added the code quality label May 18, 2023

ronso0 commented May 18, 2023

View reviewed changes

WStarRating: Delete unused m_focused member

9516d6f

ronso0 force-pushed the star-dlgtrackinfo branch 2 times, most recently from 5a7f496 to 169189a Compare May 20, 2023 13:07

WStarRating: Distinguish between actual and visual star count

c43e6a3

ronso0 force-pushed the star-dlgtrackinfo branch from 169189a to c43e6a3 Compare May 20, 2023 13:26

ronso0 added this to the 2.4.0 milestone May 20, 2023

ronso0 mentioned this pull request Jun 8, 2023

Updating Star rating in track properties clears other unsaved properties #11540

Closed

add comment about the (track) ratingUpdated signal forwarding

57672f7

daschuer approved these changes Jul 2, 2023

View reviewed changes

daschuer merged commit b7911fe into mixxxdj:2.4 Jul 2, 2023
13 checks passed

ronso0 deleted the star-dlgtrackinfo branch July 2, 2023 12:25

ronso0 commented Jul 23, 2023

View reviewed changes

ronso0 mentioned this pull request Aug 31, 2023

star rating in library behaving strangely #10110

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WStarRating: don't update track directly, use signals/slots #11565

WStarRating: don't update track directly, use signals/slots #11565

ronso0 commented May 17, 2023 •

edited

Loading

uklotzde May 17, 2023

uklotzde May 17, 2023

ronso0 May 18, 2023

uklotzde May 18, 2023

ronso0 commented May 18, 2023

uklotzde left a comment

uklotzde May 18, 2023

ronso0 May 18, 2023

uklotzde May 18, 2023

ronso0 May 18, 2023

uklotzde May 18, 2023 •

edited

Loading

ronso0 May 18, 2023 •

edited

Loading

uklotzde May 18, 2023

uklotzde May 18, 2023

uklotzde May 18, 2023 •

edited

Loading

ronso0 commented May 18, 2023

ronso0 May 18, 2023

ronso0 commented May 18, 2023

uklotzde commented May 18, 2023

ronso0 commented May 18, 2023 •

edited

Loading

uklotzde commented May 20, 2023

ronso0 commented May 20, 2023 •

edited

Loading

daschuer commented Jun 13, 2023

daschuer commented Jun 13, 2023

ronso0 commented Jun 13, 2023

ronso0 commented Jun 13, 2023 •

edited

Loading

uklotzde commented Jun 13, 2023

daschuer left a comment

ronso0 commented Jul 2, 2023

ronso0 Jul 23, 2023

WStarRating: don't update track directly, use signals/slots #11565

WStarRating: don't update track directly, use signals/slots #11565

Conversation

ronso0 commented May 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronso0 commented May 18, 2023

uklotzde left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uklotzde May 18, 2023 • edited Loading

Choose a reason for hiding this comment

ronso0 May 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uklotzde May 18, 2023 • edited Loading

Choose a reason for hiding this comment

ronso0 commented May 18, 2023

Choose a reason for hiding this comment

ronso0 commented May 18, 2023

uklotzde commented May 18, 2023

ronso0 commented May 18, 2023 • edited Loading

uklotzde commented May 20, 2023

ronso0 commented May 20, 2023 • edited Loading

daschuer commented Jun 13, 2023

daschuer commented Jun 13, 2023

ronso0 commented Jun 13, 2023

ronso0 commented Jun 13, 2023 • edited Loading

uklotzde commented Jun 13, 2023

daschuer left a comment

Choose a reason for hiding this comment

ronso0 commented Jul 2, 2023

Choose a reason for hiding this comment

ronso0 commented May 17, 2023 •

edited

Loading

uklotzde May 18, 2023 •

edited

Loading

ronso0 May 18, 2023 •

edited

Loading

uklotzde May 18, 2023 •

edited

Loading

ronso0 commented May 18, 2023 •

edited

Loading

ronso0 commented May 20, 2023 •

edited

Loading

ronso0 commented Jun 13, 2023 •

edited

Loading