Add a homescreen widget #144

Abestanis · 2024-07-14T21:52:12Z

Depends on #130.

Adds a adaptable homescreen widget. Closes #111.

Pictures

nt4f04uNd · 2024-10-19T21:24:05Z

First impression - this works crazy awesome!

nt4f04uNd · 2024-10-19T21:25:07Z

Can we give this bar some bottom padding? Around 8 dp

android/app/src/main/kotlin/com/nt4f04und/sweyer/MusicPlayerAppWidget.kt

nt4f04uNd · 2024-10-19T22:05:07Z

android/app/src/main/res/drawable-nodpi/music_player_widget_preview.png

I'm curious, how did you generate this preview? Can we document this process somehow somewhere?

Also, we need to update the preview image after you added padding

I'm curious, how did you generate this preview? Can we document this process somehow somewhere?

Android emulators with an API <= 26 have a Widget Preview app that can generate the preview. I added a a comment in the preview XML layout with a reminder and instructions on how to update it.

lib/logic/app_widget.dart

pubspec.yaml

test/routes/home_route_test.dart

nt4f04uNd · 2024-10-19T22:19:41Z

test/routes/home_route_test.dart

@@ -133,6 +135,11 @@ void main() {

  testWidgets('home screen - shows when permissions are granted and not searching for tracks',
      (WidgetTester tester) async {
+    late AppWidgetChannelObserver appWidgetChannelObserver;
+    await tester.runAsync(() => tester.pump()); // Wait for widget events from old app start to process.


I had a lot of problems getting these tests to work reliably. This is a workaround because due to our singleton architecture and because tests can end before all futures complete, we were getting events from previous tests on the appWidgetChannelObserver.

old app start is poorly worded, other tests might be better, I'll rephrase it.

nt4f04uNd · 2024-10-19T22:20:22Z

test/routes/home_route_test.dart

@@ -141,6 +148,9 @@ void main() {
        tester.getRect(find.byType(App)).height,
        reason: 'Player route must be offscreen',
      );
+      await tester.runAsync(() => tester.pump()); // Wait for widget events from start to process.


This comment is even more confusing than the one above

I've reworded it. This is another workaround to let some of the callback on streams called in ContentControl.init fire, so the widget events reach the app method channel.

I think it's this chain that needs to complete: ContentControl.init -> MusicPlayer.instance.init -> restoreLastSong -> setSong -> PlaybackControl.instance.changeSong -> PlaybackControl.onSongChange.add -> triggers AppWidgetControl.update.

nt4f04uNd · 2024-10-19T23:05:25Z

As a side note - we probably would like to show title and artist in the widget, but I'm in favor of doing this in a separate PR

Co-authored-by: nt4f04uNd <nt4f04uNd@gmail.com>

nt4f04uNd · 2024-10-20T12:50:39Z

android/app/src/main/res/values/dimens.xml

+<resources>
+    <dimen name="musicPlayerWidgetButtonSize">48dp</dimen>
+    <dimen name="appWidgetRadius">16dp</dimen>
+    <dimen name="appWidgetInnerRadius">8dp</dimen>


Why do they differ?

Can you also help me understand what do these radiuses practically mean?

This is part of the rounded corner implementation, see the docs.
The appWidgetRadius refers to the corner radius of the background element of the widget (in our case it's the album art), and the appWidgetInnerRadius is the corner radius of any foreground element in the widget (in our case it's the button bar).

Prior to Android 31 there was no guideline about these, but on 31 and up they are given by the launcher via @android:dimen/system_app_widget_background_radius and @android:dimen/system_app_widget_inner_radius, and the description of system_app_widget_inner_radius says:

This is exactly 8 dp less than the background radius, to align nicely when using an 8 dp padding.

I renamed appWidgetRadius to appWidgetBackgroundRadius which hopefully makes it a bit clearer.

android/app/src/main/res/drawable/music_player_widget_button_bar_background.xml

nt4f04uNd · 2024-10-20T18:03:42Z

While I was testing the buld from this PR, one time after changing a song and then immediately minimizing the app to the home page, where there was a widget visible, I got the "The app is not responding notification" from the system. It was also the default art.

I didn't get it anymore since, but maybe it's something to dig into. Maybe it was reported to firebase, I didn't check

nt4f04uNd · 2024-10-20T22:16:28Z

I suppose that's the error I got

  Fatal Exception: io.flutter.plugins.firebase.crashlytics.FlutterError: PlatformException(error, Service.startForeground() not allowed due to mAllowStartForeground false: service com.nt4f04und.sweyer/com.ryanheise.audioservice.AudioService, null, android.app.ForegroundServiceStartNotAllowedException: Service.startForeground() not allowed due to mAllowStartForeground false: service com.nt4f04und.sweyer/com.ryanheise.audioservice.AudioService
	at android.app.ForegroundServiceStartNotAllowedException$1.createFromParcel(ForegroundServiceStartNotAllowedException.java:54)
	at android.app.ForegroundServiceStartNotAllowedException$1.createFromParcel(ForegroundServiceStartNotAllowedException.java:50)
	at android.os.Parcel.readParcelableInternal(Parcel.java:4804)
	at android.os.Parcel.readParcelable(Parcel.java:4772)
	at android.os.Parcel.createExceptionOrNull(Parcel.java:3035)
	at android.os.Parcel.createException(Parcel.java:3024)
	at android.os.Parcel.readException(Parcel.java:3007)
	at android.os.Parcel.readException(Parcel.java:2949)
	at android.app.IActivityManager$Stub$Proxy.setServiceForeground(IActivityManager.java:6079)
	at android.app.Service.startForeground(Service.java:797)
	at com.ryanheise.audioservice.AudioService.Q(Unknown Source:21)
	at com.ryanheise.audioservice.AudioService.F(Unknown Source:34)
	at com.ryanheise.audioservice.AudioService.Z(Unknown Source:159)
	at com.ryanheise.audioservice.a$d.E(Unknown Source:481)
	at i6.k$a.a(Unknown Source:17)
	at w5.c.l(Unknown Source:18)
	at w5.c.m(Unknown Source:40)
	at w5.c.i(Unknown Source:0)
	at w5.b.run(Unknown Source:12)
	at android.os.Handler.handleCallback(Handler.java:942)
	at android.os.Handler.dispatchMessage(Handler.java:99)
	at android.os.Looper.loopOnce(Looper.java:240)
	at android.os.Looper.loop(Looper.java:351)
	at android.app.ActivityThread.main(ActivityThread.java:8370)
	at java.lang.reflect.Method.invoke(Native Method)
	at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:568)
	at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1013)
)
#00 pc 0x64c647 com.nt4f04und.sweyer (StandardMethodCodec.decodeEnvelope [message_codecs.dart:653]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#01 pc 0x6a2c23 com.nt4f04und.sweyer (MethodChannel._invokeMethod [platform_channel.dart:315]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#02 pc 0x6909f7 com.nt4f04und.sweyer (_SuspendState._createAsyncStarCallback.<anonymous closure> [async_patch.dart:353]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#03 pc 0x1bff8b com.nt4f04und.sweyer (_FutureListener.handleValue [zone.dart:1660]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#04 pc 0x696353 com.nt4f04und.sweyer (Future._propagateToListeners.handleValueCallback [future_impl.dart:767]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#05 pc 0x1bed8f com.nt4f04und.sweyer (Future._propagateToListeners [future_impl.dart:796]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#06 pc 0x1c3dfb com.nt4f04und.sweyer (Future._completeWithValue [future_impl.dart:567]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#07 pc 0x1c098f com.nt4f04und.sweyer (Future._asyncCompleteWithValue.<anonymous closure> [future_impl.dart:640]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#08 pc 0x1be45f com.nt4f04und.sweyer (_microtaskLoop [schedule_microtask.dart:40]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#09 pc 0x6953c7 com.nt4f04und.sweyer (_startMicrotaskLoop [schedule_microtask.dart:49]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)
#10 pc 0x1be3d3 com.nt4f04und.sweyer (_startMicrotaskLoop [schedule_microtask.dart:44]) (BuildId: bca64abf2e8413c431bb8f1cc572ed9d)

https://console.firebase.google.com/u/0/project/sweyer-def42/crashlytics/app/android:com.nt4f04und.sweyer/issues/46654a54d48703098a19382a34e51e44?time=last-ninety-days&types=crash&sessionEventKey=6714C7E6005600013DE77BBFCAB31106_2006310376430476968

It's almost an exact duplicate of the other one that we have

https://console.firebase.google.com/u/0/project/sweyer-def42/crashlytics/app/android:com.nt4f04und.sweyer/issues/74dfca6f536b0c14f4e05937e3aaf53f?time=last-ninety-days&types=crash

          Fatal Exception: io.flutter.plugins.firebase.crashlytics.FlutterError: PlatformException(error, Service.startForeground() not allowed due to mAllowStartForeground false: service com.nt4f04und.sweyer/com.ryanheise.audioservice.AudioService, null, android.app.ForegroundServiceStartNotAllowedException: Service.startForeground() not allowed due to mAllowStartForeground false: service com.nt4f04und.sweyer/com.ryanheise.audioservice.AudioService
	at android.app.ForegroundServiceStartNotAllowedException$1.createFromParcel(ForegroundServiceStartNotAllowedException.java:54)
	at android.app.ForegroundServiceStartNotAllowedException$1.createFromParcel(ForegroundServiceStartNotAllowedException.java:50)
	at android.os.Parcel.readParcelableInternal(Parcel.java:5016)
	at android.os.Parcel.readParcelable(Parcel.java:4998)
	at android.os.Parcel.createExceptionOrNull(Parcel.java:3178)
	at android.os.Parcel.createException(Parcel.java:3167)
	at android.os.Parcel.readException(Parcel.java:3150)
	at android.os.Parcel.readException(Parcel.java:3092)
	at android.app.IActivityManager$Stub$Proxy.setServiceForeground(IActivityManager.java:6960)
	at android.app.Service.startForeground(Service.java:863)
	at com.ryanheise.audioservice.AudioService.internalStartForeground(AudioService.java:684)
	at com.ryanheise.audioservice.AudioService.enterPlayingState(AudioService.java:665)
	at com.ryanheise.audioservice.AudioService.setState(AudioService.java:529)
	at com.ryanheise.audioservice.AudioServicePlugin$AudioHandlerInterface.onMethodCall(AudioServicePlugin.java:864)
	at io.flutter.plugin.common.MethodChannel$IncomingMethodCallHandler.onMessage(MethodChannel.java:267)
	at io.flutter.embedding.engine.dart.DartMessenger.invokeHandler(DartMessenger.java:292)
	at io.flutter.embedding.engine.dart.DartMessenger.lambda$dispatchMessageToQueue$0$io-flutter-embedding-engine-dart-DartMessenger(DartMessenger.java:319)
	at io.flutter.embedding.engine.dart.DartMessenger$$ExternalSyntheticLambda0.run(Unknown Source:12)
	at android.os.Handler.handleCallback(Handler.java:959)
	at android.os.Handler.dispatchMessage(Handler.java:100)<truncated: 358 chars>
       at StandardMethodCodec.decodeEnvelope(message_codecs.dart:648)
       at MethodChannel._invokeMethod(platform_channel.dart:334)
       at MethodChannelAudioService.setState(method_channel_audio_service.dart:19)
       at AudioService.init.<fn>(audio_service.dart:958)

Abestanis · 2024-10-21T00:30:34Z

As a side note - we probably would like to show title and artist in the widget, but I'm in favor of doing this in a separate PR

I personally am not a fan of having any text in the widget, but we can definiert provide a second widget with more information, or maybe even allow to configure it when creating the widget.

Abestanis · 2024-10-21T14:30:11Z

android/app/src/main/kotlin/com/nt4f04und/sweyer/MusicPlayerAppWidget.kt

+            intent.type = keyEvent.toString()
+        }
+        return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            PendingIntent.getForegroundService(context, 0, intent, flags)


I'm looking into the ANR, but we definitely need to use getForegroundService, because otherwise the intent will be ignored on newer Android versions.

Looks like we might be able to work around this issue by using the broadcast receiver that listens to media playback button presses and that starts the service for us.

During my testing this worked very well, except for one time where we failed to create a notification with an ForegroundServiceStartNotAllowedException. This was after killing the app and I think it was caused by an extremely slow startup, which might have caused us to exceed some timeframe. But I have not been able to replicate that, it worked every other attempt.

Abestanis · 2024-10-21T14:38:24Z

android/app/src/main/res/layout/music_player_widget.xml

+        android:layout_width="match_parent"
+        android:layout_height="@dimen/musicPlayerWidgetButtonSize"
+        android:layout_alignParentStart="true"
+        android:layout_alignParentEnd="true"


Suggested change

android:layout_width="match_parent"

android:layout_height="@dimen/musicPlayerWidgetButtonSize"

android:layout_alignParentStart="true"

android:layout_alignParentEnd="true"

android:layout_width="wrap_content"

android:layout_height="@dimen/musicPlayerWidgetButtonSize"

android:layout_centerHorizontal="true"

We could also not stretch the button bar over the entire width, which would look like this:

Would you prefer that?

Abestanis force-pushed the feature/homescreen_widget branch from 101e1f8 to 2c94781 Compare July 14, 2024 21:56

Abestanis force-pushed the feature/homescreen_widget branch 2 times, most recently from 8301183 to d9b576d Compare October 14, 2024 09:38

Abestanis marked this pull request as ready for review October 14, 2024 09:38

Abestanis added 5 commits October 16, 2024 00:11

Add home widget

9f2ef97

Add app widget tests

a3dc1c0

Use a widget preview layout and change the default size to 2x3

f2c2da5

Update home_widget

d4cc23d

Remove usage of tuple in the tests

ac09a01

Abestanis force-pushed the feature/homescreen_widget branch from d9b576d to ac09a01 Compare October 15, 2024 22:13

Abestanis requested a review from nt4f04uNd October 19, 2024 18:28

Add a bottom padding to the button bar of the home screen widget

16cdcf2

nt4f04uNd reviewed Oct 19, 2024

View reviewed changes

Abestanis and others added 3 commits October 20, 2024 03:41

Update preview image

bc0fbac

Add comment about updating the home widget preview

df36780

Fix comment

f6461bd

Co-authored-by: nt4f04uNd <nt4f04uNd@gmail.com>

nt4f04uNd reviewed Oct 20, 2024

View reviewed changes

Abestanis added 6 commits October 21, 2024 01:05

Improve comments in test

afd7dfe

Add app_widget to logic.dart

c80429d

Update home_widget dependency

0c43ef6

Normalize string key naming

f5d4d07

Use resources.configuration.orientation instead of bool resource

e2efeda

Make some AppWidgetControl variables private

38efc38

Fix radius of app widget button bar

7a1dee0

Abestanis force-pushed the feature/homescreen_widget branch from 06c3309 to 7a1dee0 Compare October 21, 2024 02:07

Abestanis commented Oct 21, 2024

View reviewed changes

Use a broadcast intent instead of starting the foreground service

4613e44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a homescreen widget #144

Add a homescreen widget #144

Abestanis commented Jul 14, 2024 •

edited

Loading

nt4f04uNd commented Oct 19, 2024

nt4f04uNd commented Oct 19, 2024

nt4f04uNd Oct 19, 2024

nt4f04uNd Oct 19, 2024

Abestanis Oct 20, 2024

nt4f04uNd Oct 19, 2024

Abestanis Oct 20, 2024

nt4f04uNd Oct 19, 2024

Abestanis Oct 20, 2024

nt4f04uNd commented Oct 19, 2024

nt4f04uNd Oct 20, 2024

nt4f04uNd Oct 20, 2024 •

edited

Loading

Abestanis Oct 21, 2024

Abestanis Oct 21, 2024

nt4f04uNd commented Oct 20, 2024

nt4f04uNd commented Oct 20, 2024 •

edited

Loading

Abestanis commented Oct 21, 2024

Abestanis Oct 21, 2024

Abestanis Oct 22, 2024

Abestanis Oct 21, 2024

Add a homescreen widget #144

Are you sure you want to change the base?

Add a homescreen widget #144

Conversation

Abestanis commented Jul 14, 2024 • edited Loading

nt4f04uNd commented Oct 19, 2024

nt4f04uNd commented Oct 19, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nt4f04uNd commented Oct 19, 2024

Choose a reason for hiding this comment

nt4f04uNd Oct 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nt4f04uNd commented Oct 20, 2024

nt4f04uNd commented Oct 20, 2024 • edited Loading

Abestanis commented Oct 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Abestanis commented Jul 14, 2024 •

edited

Loading

nt4f04uNd Oct 20, 2024 •

edited

Loading

nt4f04uNd commented Oct 20, 2024 •

edited

Loading