MediaPlayer: Mark as read on audio/video completion #2684

ztec · 2024-06-07T13:46:28Z

When listening to enclosure media like Podcasts or Peertube feeds, you now have an option to mark the entry as read when the playback reach 90% instead of right after viewing the entry page.

In order to do that, I had to modify every place where the MarkAsReadOnView decision was made. To centralize the new condition I moved it in the entry entity. It create a coupling with the user model. I could have put it in the user model but the coupling would be the same. I'm not aware of a more suitable place to put this kind of small code (such as an utils module)

If the new option is enabled, the existing option mark as read on view will only trigger if the entry has no audio or video enclosure at all. Image enclosure are excluded because they are not relevant for the feature in my opinon.

I've rename the handlePlayerProgressionSave to accommodate the new behavior. I could have created another function but this would have duplicate some code, I felt it is better to just add the new behavior in the end. Debatable of course. In order to mark as read I reused the handleEntryStatus function. This has the advantage to show the status change on the unread/read button on top.

The user model have a new setting, and I've added a new DB migration to add the field as well.

The completion trigger is defined by the data-mark-read-on-completion value. It is a percentage (from 0 to 1).
For now I've hardcoded the value to 0.9 => 90% but maybe we will feel the need to make it configurable at some point. (on a by feed basis)

I've tested the feature on

firefox - linux
vivaldi - android

I've checked the mark as read button and player behavior on

unread entry pages
search entry pages
categories entry pages
history entry pages
unread list
categories list
history list

TODO before getting the PR out of Draft

i18n integration

Do you follow the guidelines?

I have tested my changes
There is no breaking changes
I really tested my changes and there is no regression
Ideally, my commit messages use the same convention as the Go project: https://go.dev/doc/contribute#commit_messages
I read this document: https://miniflux.app/faq.html#pull-request

When listening to enclosure media like Podcasts or Peertube feeds, you now have an option to mark the entry as read when the playback reach 90% instead of right after viewing the entry page. In order to do that, I had to modify every place where the MarkAsReadOnView decision was made. To centralize the new condition I moved it in the `entry` entity. It creates a coupling with the `user` model. I could have put it in the user model but the coupling would be the same. I'm not aware of a more suitable place to put this kind of small code (such as an `utils` module) If the new option is enabled, the existing option `mark as read on view` will only trigger if the entry has no audio or video enclosure at all. Image enclosure are excluded because they are not relevant for the feature in my opinion. I've renamed the `handlePlayerProgressionSave` to accommodate the new behavior. I could have created another function but this would have duplicate some code, I felt it is better to just add the new behavior in the end. Debatable of course. In order to `mark as read` I reused the `handleEntryStatus` function. This has the advantage to show the status change on the `unread/read` button on top. The user model have a new setting, and I've added a new DB migration to add the field as well. The completion trigger is defined by the `data-mark-read-on-completion` value. It is a percentage (from 0 to 1). For now, I've hardcoded the value to 0.9 => 90%, but maybe we will feel the need to make it configurable at some point. (on a by feed basis) I've tested the feature on - firefox - linux - vivaldi - android I've included English and French i18n version. I've checked the `mark as read` button and player behavior on - unread entry pages - search entry pages - categories entry pages - history entry pages - unread list - categories list - history pages

ztec · 2024-06-13T10:13:02Z

The PR is ready for review.

As mentioned by @rdelaage in the issue #1847 (comment), Maybe this option should be complemented by a feed override option. Depending of how the global option is welcomed and how people use it I can implement it.
Considering minimalist philosophy I'm personally convinced it's best to have only one global option.

internal/model/entry.go

fguillot · 2024-06-16T18:33:04Z

internal/template/templates/views/settings.html

@@ -114,6 +114,7 @@ <h1 id="page-header-title">{{ t "page.settings.title" }}</h1>
 <label><input type="checkbox" name="show_reading_time" value="1" {{ if .form.ShowReadingTime }}checked{{ end }}> {{ t "form.prefs.label.show_reading_time" }}</label>

 <label><input type="checkbox" name="mark_read_on_view" value="1" {{ if .form.MarkReadOnView }}checked{{ end }}> {{ t "form.prefs.label.mark_read_on_view" }}</label>
+ <label>↳ <input type="checkbox" name="mark_read_on_enclosure_completion" value="1" {{ if .form.MarkReadOnEnclosureCompletion }}checked{{ end }}> {{ t "form.prefs.label.mark_read_on_EnclosureCompletion" }}</label>


I would remove the ↳

The ↳ is here to show that this options modify the previous option's behavior. Initially it was directly included in the wording but I found it a bit misleading and reworded it.
The two options are independently enablable but the second will affect the first when enabled (actually disabling it when audio/video enclosures are present)

Of course I can remove the arrow, you decide in the end. I just feel there is something missing without it and I don't have any better proposition that would not require a complete paragraph to explain properly the option in the UI.
Are you sure you want to remove it ?

My main concern is from an accessibility point of view. I don't know how ↳ will be interpreted by screen readers. Also, from a usability perspective it might confuse some users.

Perhaps, the web ui could be changed to a list of choices to make things more explicit:

The logic to process the form might be more complex, but at least no additional Javascript is required.

fguillot · 2024-06-16T18:37:24Z

internal/database/migrations.go

@@ -903,4 +903,9 @@ var migrations = []func(tx *sql.Tx) error{
 _, err = tx.Exec(sql)
 return err
 },
+ func(tx *sql.Tx) (err error) {
+ sql := `ALTER TABLE users ADD COLUMN mark_read_on_enclosure_completion bool default 'f';`


I would rename this field since it's only for the media player (audio/video). Perhaps, something like this: mark_read_on_media_player_completion.

Same for MarkReadOnEnclosureCompletion -> MarkReadOnMediaPlayerCompletion.

I will rename all occurrence 👍

internal/locale/translations/fr_FR.json

ztec · 2024-06-17T11:57:18Z

I've re-tested on firefox-linux all the usecase I listed previously after the changes.

ztec mentioned this pull request Jun 7, 2024

Media player: Mark as read when playback reached the end #1847

Open

ztec force-pushed the markAsReadWhenListened branch from a6045e0 to 41626fa Compare June 13, 2024 10:00

ztec force-pushed the markAsReadWhenListened branch from 41626fa to 5d2621b Compare June 13, 2024 10:05

ztec marked this pull request as ready for review June 13, 2024 10:13

fguillot reviewed Jun 16, 2024

View reviewed changes

ztec added 4 commits June 17, 2024 13:34

Fix orthographe

b13dfaf

Rename option name in DB, i18n key and forms

d6ee7b1

Rename option name in Code

b05a3ef

Owner's preferences

dd9c540

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MediaPlayer: Mark as read on audio/video completion #2684

MediaPlayer: Mark as read on audio/video completion #2684

ztec commented Jun 7, 2024 •

edited

ztec commented Jun 13, 2024

fguillot Jun 16, 2024

ztec Jun 17, 2024 •

edited

fguillot Jun 18, 2024

fguillot Jun 16, 2024

ztec Jun 17, 2024

ztec Jun 17, 2024

ztec commented Jun 17, 2024 •

edited

MediaPlayer: Mark as read on audio/video completion #2684

Are you sure you want to change the base?

MediaPlayer: Mark as read on audio/video completion #2684

Conversation

ztec commented Jun 7, 2024 • edited

ztec commented Jun 13, 2024

fguillot Jun 16, 2024

Choose a reason for hiding this comment

ztec Jun 17, 2024 • edited

Choose a reason for hiding this comment

fguillot Jun 18, 2024

Choose a reason for hiding this comment

fguillot Jun 16, 2024

Choose a reason for hiding this comment

ztec Jun 17, 2024

Choose a reason for hiding this comment

ztec Jun 17, 2024

Choose a reason for hiding this comment

ztec commented Jun 17, 2024 • edited

ztec commented Jun 7, 2024 •

edited

ztec Jun 17, 2024 •

edited

ztec commented Jun 17, 2024 •

edited