Component used:WorkManager Version used:2.4.0 Devices/Android versions reproduced on:Pixel 4

Hi, I am experimenting with the work manager API and stumbled upon an issue. First of all I used the snippet from the documentation here https://developer.android.com/topic/libraries/architecture/workmanager/advanced/long-running. I changed it a little bit, so it looks like this:

class DownloadWorker @WorkerInject constructor(
    @Assisted appContext: Context,
    @Assisted params: WorkerParameters
) :
    CoroutineWorker(
        appContext,
        params
    ) {

    private val notificationManager =
        appContext.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager

    override suspend fun doWork(): Result {
        Timber.d("started worker in %s", Thread.currentThread().name)
        setForeground(createForegroundInfo())
        delay(10_000)
        Timber.d("ended worker in %s", Thread.currentThread().name)
        return Result.success()
    }

    // Creates an instance of ForegroundInfo which can be used to update the
    // ongoing notification.
    private fun createForegroundInfo(): ForegroundInfo {
        val id = "CHANNEL_ID"
        // Create a Notification channel if necessary
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            createChannel(id)
        }

        val notification = NotificationCompat.Builder(applicationContext, id)
            .setSmallIcon(R.drawable.ic_launcher_background)
            .setOngoing(true)
            .build()

        return ForegroundInfo(0, notification)
    }

    @RequiresApi(Build.VERSION_CODES.O)
    private fun createChannel(@Suppress("SameParameterValue") channelId: String) {
        // Create the NotificationChannel
        val name = "Test channel name"
        val descriptionText = "Test channel description"
        val importance = NotificationManager.IMPORTANCE_DEFAULT
        val channel = NotificationChannel(channelId, name, importance)
        channel.description = descriptionText
        channel.setSound(null, null)
        channel.enableVibration(false)
        // Register the channel with the system; you can't change the importance
        // or other notification behaviors after this
        notificationManager.createNotificationChannel(channel)
    }

}

The issue is that when the worker is done the notification is not cancelled and stays visible indefinitely. I tried looking at the library code to find out what I am doing wrong and found that some methods are called in the way that is basically not consistent with the requirement of canceling the notification. Specifically in the class SystemForegroundDispatcher the method onExecuted() is called after the method handleStop(). In the method onExecuted() we set mLastForegroundInfo field, and in handleStop() we check this field if it is not null and in this case cancel the notification. I don't know if it's really the issue or If am I doing something wrong, so I am asking if you could please check this issue.

Issue 171649746

Links (2)

Issue metadata