[ksp] Dagger fails to resolved ViewBinding classes generated by the Android Gradle plugin #4049

Jean-Daniel · 2023-08-31T12:46:39Z

I have a class that uses ViewBinding as a generic parameter:

@AndroidEntryPoint
public class DownloadsFragment : BindingFragment<DownloadsListBinding>(DownloadsListBinding::inflate) {

   @Inject
    internal lateinit var db: Database
}

DownloadsListBinding is a class generated from a xml layout resource by the Android Gradle Plugin, and everything is working fine with kapt, but when trying to use KSP, the compilation fails with the following error:

e: [ksp] InjectProcessingStep was unable to process 'db' because 'error.NonExistentClass' could not be resolved.

Dependency trace:
    => element (CLASS): mypackage.downloads.DownloadsFragment
    => type (DECLARED superclass): mypackage.ui.BindingFragment<error.NonExistentClass>
    => type (ERROR type argument): error.NonExistentClass

If type 'error.NonExistentClass' is a generated type, check above for compilation errors that may have prevented the type from being generated. Otherwise, ensure that type 'error.NonExistentClass' is on your classpath.

Versions:
Gradle Plugin version: 8.1.1
Kotlin: 1.9.10
KSP: 1.9.10-1.0.13
Hilt: 2.48

The text was updated successfully, but these errors were encountered:

danysantiago · 2023-08-31T14:27:15Z

ViewBinding is a KAPT processor and thus not compatible with KSP processors, essentially you are running into the issue described here: https://dagger.dev/dev-guide/ksp#interaction-with-javackapt-processors. See also google/ksp#1388.

JakeWharton · 2023-08-31T14:29:26Z

ViewBinding does not rely on KAPT. It is its own code-generating task created by AGP.

danysantiago · 2023-08-31T14:56:07Z

Ups! I was thinking of DataBinding then which I believe has an annotation processor component that runs in KAPT for Kotlin sources. Sorry for the confusion. 😅

So, ViewBinding being a task in AGP then my guess is that it needs some extra wiring so that generates classes are part of KSP's inputs. I'll ask AGP team and investigate more...

ZOlbrys · 2023-09-09T16:53:42Z

I've made a simple minimum reproducible app, in case it helps: https://github.com/ZOlbrys/HiltKspViewBindingTestApp

The error only happens when you use view bindings in a generic manner, FWIW.

davidtrpchevski · 2023-09-19T12:30:00Z

Hey @danysantiago

Glad to hear that you are investigating this issue. Is there any progress on this one?

paladin952 · 2023-09-22T22:14:43Z

any updates on this one? thank you!

danysantiago · 2023-09-22T23:50:35Z

The AGP team is looking into it: https://issuetracker.google.com/301245705

AmrAfifiy · 2023-10-02T16:19:13Z

We're working on a proper fix for the issue by exposing an API for generated java sources by the android gradle plugin to be consumed by KSP gradle plugin. Meanwhile, you can add the following snippet to your build file as a workaround to wire databinding/viewbinding generated classes to the ksp task.

androidComponents {
    onVariants(selector().all(), { variant ->
        afterEvaluate {
            // This is a workaround for https://issuetracker.google.com/301245705 which depends on internal
            // implementations of the android gradle plugin and the ksp gradle plugin which might change in the future
            // in an unpredictable way.
            project.tasks.getByName("ksp" + variant.name.capitalize() + "Kotlin") {
                def dataBindingTask = (com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask) project.tasks.getByName("dataBindingGenBaseClasses" + variant.name.capitalize())

                ((org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool) it).setSource(
                        dataBindingTask.sourceOutFolder
                )
            }
        }
    })
}

findyourexit · 2023-10-05T14:51:15Z

We're working on a proper fix for the issue by exposing an API for generated java sources by the android gradle plugin to be consumed by KSP gradle plugin. Meanwhile, you can add the following snippet to your build file as a workaround to wire databinding/viewbinding generated classes to the ksp task.

androidComponents {
    onVariants(selector().all(), { variant ->
        afterEvaluate {
            // This is a workaround for https://issuetracker.google.com/301245705 which depends on internal
            // implementations of the android gradle plugin and the ksp gradle plugin which might change in the future
            // in an unpredictable way.
            project.tasks.getByName("ksp" + variant.name.capitalize() + "Kotlin") {
                def dataBindingTask = (com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask) project.tasks.getByName("dataBindingGenBaseClasses" + variant.name.capitalize())

                ((org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool) it).setSource(
                        dataBindingTask.sourceOutFolder
                )
            }
        }
    })
}

While this didn't quite work for me right away, it did highlight what I needed to do to get things working in my case. Sincere thanks for the stopgap solution @AmrAfifiy 🙏

Here's the modified code that fit my situation:

androidComponents {
        onVariants(selector().all(), { variant ->
            afterEvaluate {
                // This is a workaround for https://issuetracker.google.com/301245705 which depends on internal
                // implementations of the android gradle plugin and the ksp gradle plugin which might change in the future
                // in an unpredictable way.
                def dataBindingTask = (DataBindingGenBaseClassesTask) project.tasks.named("dataBindingGenBaseClasses" + variant.name.capitalize()).get()

                if (dataBindingTask != null) {
                    project.tasks.getByName("ksp" + variant.name.capitalize() + "Kotlin") {
                        ((AbstractKotlinCompileTool) it).setSource(dataBindingTask.sourceOutFolder)
                    }
                }
            }
        })
    }

The main difference included here was picked up by a user on IssueTracker, who raised a very valid point that not all modules that apply the ksp plugin use view binding. So with that in mind, it makes sense to optionally process DataBindingGenBaseClassesTask instances, as they could be null (when a module that applies the ksp plugin does not make use of view binding).

I hope that helps!

Goooler · 2023-11-24T09:48:10Z

There is a workaround for those who are facing a simular issue with AIDL using:

// Workaround for https://github.com/google/dagger/issues/4158
androidComponents {
    onVariants(selector().all(), { variant ->
        afterEvaluate {
            def capName = variant.name.capitalize()
            tasks.getByName("ksp${capName}Kotlin") {
                setSource(tasks.getByName("compile${capName}Aidl").outputs)
            }
        }
    })
}

Originally posted by @Goooler in #4158 (comment)

technoir42 · 2023-11-26T18:26:42Z

Facing the same issue with a custom plugin that generates Kotlin files and registers them using addGeneratedSourceDirectory:

val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
androidComponents.onVariants { variant ->
    val task = project.tasks.register("myTask${variant.name.capitalized()}", MyKotlinGeneratingTask::class.java)
    variant.sources.java!!.addGeneratedSourceDirectory(task) { it.outputDirectory }
}

Dagger KSP processor as of 2.48.1/KSP 1.0.13 cannot resolve any type generated by the custom task.

ArcherEmiya05 · 2023-12-03T08:33:25Z

Is there a version of snippet in Kotlin DSL? I am not really sure how to apply the Kotlin sample from the issue tracker. Thanks

LeonRa · 2023-12-03T13:00:52Z

Something like the following should work for you as a Kotlin DSL:

import com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
import org.gradle.api.UnknownTaskException
import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool

extensions.configure<LibraryAndroidComponentsExtension> {
  onVariants { variant ->
    afterEvaluate {
      project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
        val dataBindingTask =
          try {
            val taskName = "dataBindingGenBaseClasses${variant.name.capitalize()}"
              project.tasks.getByName(taskName) as DataBindingGenBaseClassesTask
          } catch (e: UnknownTaskException) {
            return@getByName
          }

          project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
            (this as AbstractKotlinCompileTool<*>).setSource(dataBindingTask.sourceOutFolder)
          }
       }
    }
  }
}

ArcherEmiya05 · 2023-12-03T13:08:07Z

Something like the following should work for you as a Kotlin DSL:

import com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
import org.gradle.api.UnknownTaskException
import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool

extensions.configure<LibraryAndroidComponentsExtension> {
  onVariants { variant ->
    afterEvaluate {
      project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
        val dataBindingTask =
          try {
            val taskName = "dataBindingGenBaseClasses${variant.name.capitalize()}"
              project.tasks.getByName(taskName) as DataBindingGenBaseClassesTask
          } catch (e: UnknownTaskException) {
            return@getByName
          }

          project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
            (this as AbstractKotlinCompileTool<*>).setSource(dataBindingTask.sourceOutFolder)
          }
       }
    }
  }
}

Which part of the build.gradle.kts should be placed? I tried it inside the app module build gradle right below dependencies block and I got syncing error.
Extension of type 'LibraryAndroidComponentsExtension' does not exist. Currently registered extension types: [ExtraPropertiesExtension, LibrariesForAdmob, LibrariesForFirebase, LibrariesForGms, LibrariesForLibs, LibrariesForMaterial, VersionCatalogsExtension, BasePluginExtension, DefaultArtifactPublicationSet, SourceSetContainer, ReportingExtension, JavaToolchainService, JavaPluginExtension, BaseAppModuleExtension, ApplicationAndroidComponentsExtension, NamedDomainObjectContainer<BaseVariantOutput>, KotlinAndroidProjectExtension, KotlinTestsRegistry, AppSweepExtension, PlayPublisherExtension, KspExtension, GoogleServicesPlugin.GoogleServicesPluginConfig]

LeonRa · 2023-12-03T13:20:47Z

Ah, apologies. I have this configured as a plugin. As a pure DSL within your app's build.gradle.kts, you should be able to do the same thing as suggested by others above:

import com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
import org.gradle.api.UnknownTaskException
import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool

androidComponents {
  onVariants(selector().all()) { variant ->
    afterEvaluate {
      project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
        val dataBindingTask =
          try {
            val taskName = "dataBindingGenBaseClasses${variant.name.capitalize()}"
            project.tasks.getByName(taskName) as DataBindingGenBaseClassesTask
          } catch (e: UnknownTaskException) {
            return@getByName
          }

        project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
          (this as AbstractKotlinCompileTool<*>).setSource(dataBindingTask.sourceOutFolder)
        }
      }
    }
  }
}

ArcherEmiya05 · 2023-12-03T13:56:46Z

Ah, apologies. I have this configured as a plugin. As a pure DSL within your app's build.gradle.kts, you should be able to do the same thing as suggested by others above:

import com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
import org.gradle.api.UnknownTaskException
import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool

androidComponents {
  onVariants(selector().all()) { variant ->
    afterEvaluate {
      project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
        val dataBindingTask =
          try {
            val taskName = "dataBindingGenBaseClasses${variant.name.capitalize()}"
            project.tasks.getByName(taskName) as DataBindingGenBaseClassesTask
          } catch (e: UnknownTaskException) {
            return@getByName
          }

        project.tasks.getByName("ksp${variant.name.capitalize()}Kotlin") {
          (this as AbstractKotlinCompileTool<*>).setSource(dataBindingTask.sourceOutFolder)
        }
      }
    }
  }
}

This work, thanks a lot!

Antimonit · 2023-12-08T10:17:13Z

As others pointed out, this is not an issue only of View Binding. BuildConfig, SafeArgs, AIDL, etc. are affected just the same. Here's a script covering all of them.

/*
 * AGP tasks do not get properly wired to the KSP task at the moment.
 * As a result, KSP sees `error.NonExistentClass` instead of generated types.
 *
 * https://github.com/google/dagger/issues/4049
 * https://github.com/google/dagger/issues/4051
 * https://github.com/google/dagger/issues/4061
 * https://github.com/google/dagger/issues/4158
 */
androidComponents {
    onVariants(selector().all()) { variant ->
        afterEvaluate {
            val variantName = variant.name.capitalize()
            val ksp = "ksp${variantName}Kotlin"
            val viewBinding = "dataBindingGenBaseClasses$variantName"
            val buildConfig = "generate${variantName}BuildConfig"
            val safeArgs = "generateSafeArgs$variantName"
            val aidl = "compile${variantName}Aidl"

            val kspTask = project.tasks.findByName(ksp)
                as? org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool<*>
            val viewBindingTask = project.tasks.findByName(viewBinding)
                as? com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
            val buildConfigTask = project.tasks.findByName(buildConfig)
                as? com.android.build.gradle.tasks.GenerateBuildConfig
            val aidlTask = project.tasks.findByName(aidl)
                as? com.android.build.gradle.tasks.AidlCompile
            val safeArgsTask = project.tasks.findByName(safeArgs)
                as? androidx.navigation.safeargs.gradle.ArgumentsGenerationTask

            kspTask?.run {
                viewBindingTask?.let { setSource(it.sourceOutFolder) }
                buildConfigTask?.let { setSource(it.sourceOutputDir) }
                aidlTask?.let { setSource(it.sourceOutputDir) }
                safeArgsTask?.let { setSource(it.outputDir) }
            }
        }
    }
}

pokerfaceCmy · 2023-12-29T02:28:09Z

As others pointed out, this is not an issue only of View Binding. BuildConfig, SafeArgs, AIDL, etc. are affected just the same. Here's a script covering all of them.

/*
 * AGP tasks do not get properly wired to the KSP task at the moment.
 * As a result, KSP sees `error.NonExistentClass` instead of generated types.
 *
 * https://github.com/google/dagger/issues/4049
 * https://github.com/google/dagger/issues/4051
 * https://github.com/google/dagger/issues/4061
 * https://github.com/google/dagger/issues/4158
 */
androidComponents {
    onVariants(selector().all()) { variant ->
        afterEvaluate {
            val variantName = variant.name.capitalize()
            val ksp = "ksp${variantName}Kotlin"
            val viewBinding = "dataBindingGenBaseClasses$variantName"
            val buildConfig = "generate${variantName}BuildConfig"
            val safeArgs = "generateSafeArgs$variantName"
            val aidl = "compile${variantName}Aidl"

            val kspTask = project.tasks.findByName(ksp)
                as? org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool<*>
            val viewBindingTask = project.tasks.findByName(viewBinding)
                as? com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
            val buildConfigTask = project.tasks.findByName(buildConfig)
                as? com.android.build.gradle.tasks.GenerateBuildConfig
            val aidlTask = project.tasks.findByName(aidl)
                as? com.android.build.gradle.tasks.AidlCompile
            val safeArgsTask = project.tasks.findByName(safeArgs)
                as? androidx.navigation.safeargs.gradle.ArgumentsGenerationTask

            kspTask?.run {
                viewBindingTask?.let { setSource(it.sourceOutFolder) }
                buildConfigTask?.let { setSource(it.sourceOutputDir) }
                aidlTask?.let { setSource(it.sourceOutputDir) }
                safeArgsTask?.let { setSource(it.outputDir) }
            }
        }
    }
}

thanks,it work for me!

RobinPcrd · 2024-02-19T10:11:29Z

As others pointed out, this is not an issue only of View Binding. BuildConfig, SafeArgs, AIDL, etc. are affected just the same. Here's a script covering all of them.

/*
 * AGP tasks do not get properly wired to the KSP task at the moment.
 * As a result, KSP sees `error.NonExistentClass` instead of generated types.
 *
 * https://github.com/google/dagger/issues/4049
 * https://github.com/google/dagger/issues/4051
 * https://github.com/google/dagger/issues/4061
 * https://github.com/google/dagger/issues/4158
 */
androidComponents {
    onVariants(selector().all()) { variant ->
        afterEvaluate {
            val variantName = variant.name.capitalize()
            val ksp = "ksp${variantName}Kotlin"
            val viewBinding = "dataBindingGenBaseClasses$variantName"
            val buildConfig = "generate${variantName}BuildConfig"
            val safeArgs = "generateSafeArgs$variantName"
            val aidl = "compile${variantName}Aidl"

            val kspTask = project.tasks.findByName(ksp)
                as? org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool<*>
            val viewBindingTask = project.tasks.findByName(viewBinding)
                as? com.android.build.gradle.internal.tasks.databinding.DataBindingGenBaseClassesTask
            val buildConfigTask = project.tasks.findByName(buildConfig)
                as? com.android.build.gradle.tasks.GenerateBuildConfig
            val aidlTask = project.tasks.findByName(aidl)
                as? com.android.build.gradle.tasks.AidlCompile
            val safeArgsTask = project.tasks.findByName(safeArgs)
                as? androidx.navigation.safeargs.gradle.ArgumentsGenerationTask

            kspTask?.run {
                viewBindingTask?.let { setSource(it.sourceOutFolder) }
                buildConfigTask?.let { setSource(it.sourceOutputDir) }
                aidlTask?.let { setSource(it.sourceOutputDir) }
                safeArgsTask?.let { setSource(it.outputDir) }
            }
        }
    }
}

Thanks! You might also want to add these lines if you use protobuf (with datastore for example)

androidComponents {
    onVariants(selector().all()) { variant ->
        afterEvaluate {
            //...
            val proto = "generate${variantName}Proto"

            //...
            val protoTask = project.tasks.findByName(proto)
                    as? com.google.protobuf.gradle.GenerateProtoTask

            kspTask?.run {
                //...
                protoTask?.let { setSource(it.outputSourceDirectorySet) }
            }
        }
    }
}

egorikftp · 2024-02-21T04:55:09Z

AGP issue fixed:
https://issuetracker.google.com/301245705

Can confirm, issue not reproduce anymore with ksp 1.9.22-1.0.18

rekaszeru · 2024-03-01T22:26:11Z

I've just updated to this version to check out if it works, but unfortunately I still have the same error:

Dependency trace:
    => element (CLASS): com.example.auth.data.SessionStore
    => element (CONSTRUCTOR): SessionStore(kotlinx.coroutines.CoroutineDispatcher, androidx.datastore.core.DataStore<error.NonExistentClass>)
    => type (EXECUTABLE constructor): (kotlinx.coroutines.CoroutineDispatcher,androidx.datastore.core.DataStore<error.NonExistentClass>)void
    => type (DECLARED parameter type): androidx.datastore.core.DataStore<error.NonExistentClass>
    => type (ERROR type argument): error.NonExistentClass

My SessionStore constructor looks like this:

internal class SessionStore @Injec constructor(
    @BackgroundDispatcher
    private val backgroundDispatcher: CoroutineDispatcher,
    private val stateStore: DataStore<Session> = context.sessionStore,
)

and Session is generated from proto using squareup's wire library.

I've tried the workarounds too (adapted to wire task), still no dice.

Chang-Eric added type: bug area: dagger area: ksp labels Sep 5, 2023

This was referenced Sep 7, 2023

[ksp] Non explicit type specification on @Provides causes error.NonExistentClass #4051

Open

[KSP][Android] Non existing type error on class generated from Android Navigation arguments #4061

Open

bcorso mentioned this issue Oct 16, 2023

[Ksp] InjectProcessingStep was unable to process 'test' because 'error.NonExistentClass' could not be resolved. #4097

Closed

Goooler mentioned this issue Nov 24, 2023

[ksp] InjectProcessingStep was unable to process a class which extends Binder Stub because 'error.NonExistentClass' could not be resolved. #4158

Closed

dmapr mentioned this issue Dec 3, 2023

KSP: InjectProcessingStep was unable to process 'glide' because 'error.NonExistentClass' could not be resolved. #4174

Closed

bcorso mentioned this issue Jan 30, 2024

Dagger 2.50 KSP fails to generate field in implementation for a @Named field #4225

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ksp] Dagger fails to resolved ViewBinding classes generated by the Android Gradle plugin #4049

[ksp] Dagger fails to resolved ViewBinding classes generated by the Android Gradle plugin #4049

Jean-Daniel commented Aug 31, 2023 •

edited

danysantiago commented Aug 31, 2023

JakeWharton commented Aug 31, 2023

danysantiago commented Aug 31, 2023

ZOlbrys commented Sep 9, 2023

davidtrpchevski commented Sep 19, 2023

paladin952 commented Sep 22, 2023

danysantiago commented Sep 22, 2023

AmrAfifiy commented Oct 2, 2023 •

edited

findyourexit commented Oct 5, 2023

Goooler commented Nov 24, 2023

technoir42 commented Nov 26, 2023

ArcherEmiya05 commented Dec 3, 2023

LeonRa commented Dec 3, 2023

ArcherEmiya05 commented Dec 3, 2023

LeonRa commented Dec 3, 2023

ArcherEmiya05 commented Dec 3, 2023

Antimonit commented Dec 8, 2023

pokerfaceCmy commented Dec 29, 2023

RobinPcrd commented Feb 19, 2024

egorikftp commented Feb 21, 2024 •

edited

rekaszeru commented Mar 1, 2024 •

edited

[ksp] Dagger fails to resolved ViewBinding classes generated by the Android Gradle plugin #4049

[ksp] Dagger fails to resolved ViewBinding classes generated by the Android Gradle plugin #4049

Comments

Jean-Daniel commented Aug 31, 2023 • edited

danysantiago commented Aug 31, 2023

JakeWharton commented Aug 31, 2023

danysantiago commented Aug 31, 2023

ZOlbrys commented Sep 9, 2023

davidtrpchevski commented Sep 19, 2023

paladin952 commented Sep 22, 2023

danysantiago commented Sep 22, 2023

AmrAfifiy commented Oct 2, 2023 • edited

findyourexit commented Oct 5, 2023

Goooler commented Nov 24, 2023

technoir42 commented Nov 26, 2023

ArcherEmiya05 commented Dec 3, 2023

LeonRa commented Dec 3, 2023

ArcherEmiya05 commented Dec 3, 2023

LeonRa commented Dec 3, 2023

ArcherEmiya05 commented Dec 3, 2023

Antimonit commented Dec 8, 2023

pokerfaceCmy commented Dec 29, 2023

RobinPcrd commented Feb 19, 2024

egorikftp commented Feb 21, 2024 • edited

rekaszeru commented Mar 1, 2024 • edited

Jean-Daniel commented Aug 31, 2023 •

edited

AmrAfifiy commented Oct 2, 2023 •

edited

egorikftp commented Feb 21, 2024 •

edited

rekaszeru commented Mar 1, 2024 •

edited