IssueTracker

Component used:work manager

Version used: 2.8.1

Devices/Android versions reproduced on:

Issue: Our application uses a WorkerFactory class to manage background tasks scheduled through WorkManager. When we refactor code and move worker classes around, the old class names used in existing work entries become invalid. This results in a ClassNotFoundException when the WorkManager tries to create instances of these workers.

Question:

Is there an elegant way to run code during app upgrades that cleans up outdated work entries associated with previously used worker classes? This would prevent the ClassNotFoundException and ensure smooth execution of scheduled tasks after a code refactoring.

Code Sample below*:

open class BackgroundWorkerFactory @Inject constructor(
    private val workerFactories: Map<Class<out ListenableWorker>, @JvmSuppressWildcards Provider<IBackgroundWorkerFactory>>,
) : WorkerFactory() {
    override fun createWorker(
        appContext: Context,
        workerClassName: String,
        workerParameters: WorkerParameters,
    ): ListenableWorker? {
        // returns null so it can delegate worker creation to the default WorkerFactory.
        return try {
            Log.d(TAG, "Creating worker factory for $workerClassName")
            val foundEntry =
                workerFactories.entries.find { Class.forName(workerClassName).isAssignableFrom(it.key) }
            val factoryProvider = foundEntry?.value
            factoryProvider?.get()?.create(appContext, workerParameters)
        } catch (e: ClassNotFoundException) {
            Log.e(TAG, "Unable to find class $workerClassName for worker")
            null
        }
    }

    companion object {
        private val TAG = BackgroundWorkerFactory::class.java.simpleName
    }
}

interface IBackgroundWorkerFactory {
    fun create(
        appContext: Context,
        params: WorkerParameters,
    ): ListenableWorker
}