Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return nulls from MultibindingWorkerFactory for non-existent Worker classes instead of throwing exceptions #96

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.deliveryhero.whetstone.worker

import android.content.Context
import androidx.annotation.RestrictTo
import androidx.work.ListenableWorker
import androidx.work.WorkerFactory
import androidx.work.WorkerParameters
Expand All @@ -21,22 +22,32 @@ public class MultibindingWorkerFactory @Inject constructor(
workerParameters: WorkerParameters
): ListenableWorker? {
val workerComponent = workerComponentFactory.create(appContext, workerParameters)
val workerClass = loadClass(appContext.classLoader, workerClassName)
val workerClass = loadClass(appContext.classLoader, workerClassName) ?: return null

return workerComponent.workerMap[workerClass]?.get()
}

private companion object {
internal companion object {

// Implementation adapted from androidx.fragment.app.FragmentFactory#loadClass
private val classCache: MutableMap<ClassLoader, MutableMap<String, Class<out ListenableWorker>>> = hashMapOf()
private val classCache: MutableMap<ClassLoader, MutableMap<String, Class<out ListenableWorker>>> =
hashMapOf()

@Throws(ClassNotFoundException::class)
private fun loadClass(classLoader: ClassLoader, className: String): Class<out ListenableWorker> {
@RestrictTo(RestrictTo.Scope.LIBRARY)
internal fun loadClass(
classLoader: ClassLoader,
className: String,
): Class<out ListenableWorker>? {
val classMap = classCache.getOrPut(classLoader) { hashMapOf() }
return classMap.getOrPut(className) {
val rawClass = Class.forName(className, false, classLoader)
rawClass.asSubclass(ListenableWorker::class.java)
try {
Class.forName(className, false, classLoader)
.asSubclass(ListenableWorker::class.java)
} catch (e: ClassNotFoundException) {
return null
} catch (e: ClassCastException) {
return null
}
}
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package com.deliveryhero.whetstone.worker

import android.content.Context
import androidx.work.Worker
import androidx.work.WorkerParameters
import org.junit.Test
import kotlin.test.assertEquals
import kotlin.test.assertNull

internal class LoadClassTest {
@Test
fun `loadClass returns null for non-existing class`() {
val result = MultibindingWorkerFactory.loadClass(
this.javaClass.classLoader!!,
"non.existent.worker.Class"
)
assertNull(result)
}

@Test
fun `loadClass returns null for class which is not ListenableWorker subclass`() {
val result = MultibindingWorkerFactory.loadClass(
this.javaClass.classLoader!!,
"com.deliveryhero.whetstone.worker.LoadClassTest\$TestClass"
)
assertNull(result)
}

@Test
fun `loadClass returns class for existing classname`() {
val result = MultibindingWorkerFactory.loadClass(
this.javaClass.classLoader!!,
"com.deliveryhero.whetstone.worker.LoadClassTest\$TestWorker"
)
assertEquals(TestWorker::class.java, result)
}

private class TestWorker(
context: Context,
workerParams: WorkerParameters,
) : Worker(context, workerParams) {
override fun doWork(): Result {
TODO("Not implemented")
}
}

@Suppress("unused")
private class TestClass
}
Loading