Skip to content

setDynamicShortcuts() is called from the Activity main thread #439

@venkyqz

Description

@venkyqz

Hi, I'm working on a research prototype static analyzer targeting Kotlin-based Android apps, and running it against this repo. It detected a small threading issue.

Checklist

  • I can reproduce the bug with the latest version given here.
  • I made sure that there are no existing issues - open or closed - to which I could contribute my information.
  • I made sure that there are no existing discussions - open or closed - to which I could contribute my information.
  • I have read the FAQs inside the app (Menu -> About -> FAQs) and my problem isn't listed.
  • I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise.
  • This issue contains only one bug.
  • I have read and understood the contribution guidelines.

Affected app version

Trunk

Checked file:

app/src/main/kotlin/org/fossify/clock/activities/MainActivity.kt

What I found

In MainActivity, onResume() calls checkShortcuts(). Inside checkShortcuts(), the stopwatch shortcut is published like this:

shortcutManager.dynamicShortcuts = listOf(stopWatchShortcutInfo)

This property setter calls ShortcutManager.setDynamicShortcuts(...). Android's API documentation warns that this method may take several seconds to complete and should only be called from a worker thread.

Verified bug trace

org.fossify.clock.activities.MainActivity.onResume()
  -> checkShortcuts()
  -> MainActivity.kt, around line 133:
       shortcutManager.dynamicShortcuts = listOf(stopWatchShortcutInfo)
  -> Kotlin property setter calls:
       ShortcutManager.setDynamicShortcuts(List<ShortcutInfo>)
  -> platform shortcut state is updated through ShortcutManager
  -> documented as potentially taking several seconds
  -> call is reached from the Activity main-thread lifecycle path
  -> possible UI stall / delayed startup / ANR risk

I did not see a worker-thread boundary around this specific shortcut publishing call. There is an ensureBackgroundThread { ... } used elsewhere in the same Activity for alarm rescheduling, but not around shortcutManager.dynamicShortcuts.

Why I think this is worth changing

This probably does not fail every time, and it may be fast on many devices. The problem is that the platform API is documented as potentially slow, and the work may depend on system/launcher behavior. If it takes longer than expected, it can block UI drawing and input handling.

Suggested change

Move just the publishing call to a worker thread:

val shortcuts = listOf(stopWatchShortcutInfo)

lifecycleScope.launch(Dispatchers.IO) {
    shortcutManager.dynamicShortcuts = shortcuts
}

This keeps the UI thread free while preserving the same shortcut behavior.

Reference

Android documents ShortcutManager#setDynamicShortcuts(...) as a potentially slow call:

This method may take several seconds to complete, so it should only be called from a worker thread.

https://developer.android.com/reference/android/content/pm/ShortcutManager#setDynamicShortcuts(java.util.List%3Candroid.content.pm.ShortcutInfo%3E)

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething is not workingneeds triageIssue is not yet ready for PR authors to take up

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions