Introduce ProvidesSensor annotation + KSP + Lint (#7031)

* Introduce CatalogSensor annotation + KSP + Lint

* Annotate all BasicSensor with CatalogSensor annotation

* Apply suggestions

* Update lockfile

* Remove the catalog mention all the way

* Apply copilot suggestion

Author: TimoPtr

app/build.gradle.kts

@@ -50,4 +50,5 @@ firebaseAppDistributionDefault {
 dependencies {
     // Most of the dependencies are coming from the convention plugin to avoid duplication with `:automotive` module.
     "fullImplementation"(libs.car.projected)
+    ksp(project(":provides-sensor-processor"))
 }

app/gradle.lockfile

@@ -359,8 +359,7 @@ com.google.dagger:hilt-android-testing:2.60=fullDebugAndroidTestCompileClasspath
 com.google.dagger:hilt-android:2.60=fullDebugAndroidTestCompileClasspath,fullDebugAndroidTestLintChecksClasspath,fullDebugAndroidTestRuntimeClasspath,fullDebugCompileClasspath,fullDebugLintChecksClasspath,fullDebugRuntimeClasspath,fullDebugScreenshotTestCompileClasspath,fullDebugScreenshotTestLintChecksClasspath,fullDebugScreenshotTestRuntimeClasspath,fullDebugUnitTestCompileClasspath,fullDebugUnitTestLintChecksClasspath,fullDebugUnitTestRuntimeClasspath,fullReleaseCompileClasspath,fullReleaseLintChecksClasspath,fullReleaseRuntimeClasspath,fullReleaseScreenshotTestCompileClasspath,fullReleaseScreenshotTestLintChecksClasspath,fullReleaseScreenshotTestRuntimeClasspath,minimalDebugAndroidTestCompileClasspath,minimalDebugAndroidTestLintChecksClasspath,minimalDebugAndroidTestRuntimeClasspath,minimalDebugCompileClasspath,minimalDebugLintChecksClasspath,minimalDebugRuntimeClasspath,minimalDebugScreenshotTestCompileClasspath,minimalDebugScreenshotTestLintChecksClasspath,minimalDebugScreenshotTestRuntimeClasspath,minimalDebugUnitTestCompileClasspath,minimalDebugUnitTestLintChecksClasspath,minimalDebugUnitTestRuntimeClasspath,minimalReleaseCompileClasspath,minimalReleaseLintChecksClasspath,minimalReleaseRuntimeClasspath,minimalReleaseScreenshotTestCompileClasspath,minimalReleaseScreenshotTestLintChecksClasspath,minimalReleaseScreenshotTestRuntimeClasspath
 com.google.dagger:hilt-compiler:2.60=hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease
 com.google.dagger:hilt-core:2.60=fullDebugAndroidTestCompileClasspath,fullDebugAndroidTestLintChecksClasspath,fullDebugAndroidTestRuntimeClasspath,fullDebugCompileClasspath,fullDebugLintChecksClasspath,fullDebugRuntimeClasspath,fullDebugScreenshotTestCompileClasspath,fullDebugScreenshotTestLintChecksClasspath,fullDebugScreenshotTestRuntimeClasspath,fullDebugUnitTestCompileClasspath,fullDebugUnitTestLintChecksClasspath,fullDebugUnitTestRuntimeClasspath,fullReleaseCompileClasspath,fullReleaseLintChecksClasspath,fullReleaseRuntimeClasspath,fullReleaseScreenshotTestCompileClasspath,fullReleaseScreenshotTestLintChecksClasspath,fullReleaseScreenshotTestRuntimeClasspath,minimalDebugAndroidTestCompileClasspath,minimalDebugAndroidTestLintChecksClasspath,minimalDebugAndroidTestRuntimeClasspath,minimalDebugCompileClasspath,minimalDebugLintChecksClasspath,minimalDebugRuntimeClasspath,minimalDebugScreenshotTestCompileClasspath,minimalDebugScreenshotTestLintChecksClasspath,minimalDebugScreenshotTestRuntimeClasspath,minimalDebugUnitTestCompileClasspath,minimalDebugUnitTestLintChecksClasspath,minimalDebugUnitTestRuntimeClasspath,minimalReleaseCompileClasspath,minimalReleaseLintChecksClasspath,minimalReleaseRuntimeClasspath,minimalReleaseScreenshotTestCompileClasspath,minimalReleaseScreenshotTestLintChecksClasspath,minimalReleaseScreenshotTestRuntimeClasspath
-com.google.devtools.ksp:symbol-processing-api:2.3.7=_agp_internal_fullDebug_kspClasspath,_agp_internal_fullRelease_kspClasspath,_agp_internal_minimalDebug_kspClasspath,_agp_internal_minimalRelease_kspClasspath,hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease,kspFullDebugAndroidTestKotlinProcessorClasspath,kspFullDebugKotlinProcessorClasspath,kspFullDebugScreenshotTestKotlinProcessorClasspath,kspFullDebugUnitTestKotlinProcessorClasspath,kspFullReleaseKotlinProcessorClasspath,kspFullReleaseScreenshotTestKotlinProcessorClasspath,kspMinimalDebugAndroidTestKotlinProcessorClasspath,kspMinimalDebugKotlinProcessorClasspath,kspMinimalDebugScreenshotTestKotlinProcessorClasspath,kspMinimalDebugUnitTestKotlinProcessorClasspath,kspMinimalReleaseKotlinProcessorClasspath,kspMinimalReleaseScreenshotTestKotlinProcessorClasspath
-com.google.devtools.ksp:symbol-processing-api:2.3.9=kotlinCompilerPluginClasspathFullDebug,kotlinCompilerPluginClasspathFullDebugAndroidTest,kotlinCompilerPluginClasspathFullDebugScreenshotTest,kotlinCompilerPluginClasspathFullDebugUnitTest,kotlinCompilerPluginClasspathFullRelease,kotlinCompilerPluginClasspathFullReleaseScreenshotTest,kotlinCompilerPluginClasspathMinimalDebug,kotlinCompilerPluginClasspathMinimalDebugAndroidTest,kotlinCompilerPluginClasspathMinimalDebugScreenshotTest,kotlinCompilerPluginClasspathMinimalDebugUnitTest,kotlinCompilerPluginClasspathMinimalRelease,kotlinCompilerPluginClasspathMinimalReleaseScreenshotTest,kspPluginClasspath,kspPluginClasspathNonEmbeddable
+com.google.devtools.ksp:symbol-processing-api:2.3.9=_agp_internal_fullDebug_kspClasspath,_agp_internal_fullRelease_kspClasspath,_agp_internal_minimalDebug_kspClasspath,_agp_internal_minimalRelease_kspClasspath,hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease,kotlinCompilerPluginClasspathFullDebug,kotlinCompilerPluginClasspathFullDebugAndroidTest,kotlinCompilerPluginClasspathFullDebugScreenshotTest,kotlinCompilerPluginClasspathFullDebugUnitTest,kotlinCompilerPluginClasspathFullRelease,kotlinCompilerPluginClasspathFullReleaseScreenshotTest,kotlinCompilerPluginClasspathMinimalDebug,kotlinCompilerPluginClasspathMinimalDebugAndroidTest,kotlinCompilerPluginClasspathMinimalDebugScreenshotTest,kotlinCompilerPluginClasspathMinimalDebugUnitTest,kotlinCompilerPluginClasspathMinimalRelease,kotlinCompilerPluginClasspathMinimalReleaseScreenshotTest,kspFullDebugAndroidTestKotlinProcessorClasspath,kspFullDebugKotlinProcessorClasspath,kspFullDebugScreenshotTestKotlinProcessorClasspath,kspFullDebugUnitTestKotlinProcessorClasspath,kspFullReleaseKotlinProcessorClasspath,kspFullReleaseScreenshotTestKotlinProcessorClasspath,kspMinimalDebugAndroidTestKotlinProcessorClasspath,kspMinimalDebugKotlinProcessorClasspath,kspMinimalDebugScreenshotTestKotlinProcessorClasspath,kspMinimalDebugUnitTestKotlinProcessorClasspath,kspMinimalReleaseKotlinProcessorClasspath,kspMinimalReleaseScreenshotTestKotlinProcessorClasspath,kspPluginClasspath,kspPluginClasspathNonEmbeddable
 com.google.errorprone:error_prone_annotation:2.41.0=fullDebugUnitTestLintChecksClasspath,fullDebugUnitTestRuntimeClasspath,minimalDebugUnitTestLintChecksClasspath,minimalDebugUnitTestRuntimeClasspath
 com.google.errorprone:error_prone_annotations:2.23.0=unified-test-platform-android-driver-instrumentation,unified-test-platform-android-test-plugin,unified-test-platform-core,unified-test-platform-launcher
 com.google.errorprone:error_prone_annotations:2.28.0=androidLintTool,fullDebugAndroidTestRuntimeClasspath,fullDebugLintChecksClasspath,fullDebugRuntimeClasspath,fullDebugScreenshotTestLintChecksClasspath,fullDebugScreenshotTestRuntimeClasspath,fullReleaseLintChecksClasspath,fullReleaseRuntimeClasspath,fullReleaseScreenshotTestLintChecksClasspath,fullReleaseScreenshotTestRuntimeClasspath,minimalDebugAndroidTestRuntimeClasspath,minimalDebugLintChecksClasspath,minimalDebugRuntimeClasspath,minimalDebugScreenshotTestLintChecksClasspath,minimalDebugScreenshotTestRuntimeClasspath,minimalReleaseLintChecksClasspath,minimalReleaseRuntimeClasspath,minimalReleaseScreenshotTestLintChecksClasspath,minimalReleaseScreenshotTestRuntimeClasspath,unified-test-platform-android-device-provider-ddmlib,unified-test-platform-android-test-plugin-host-additional-test-output,unified-test-platform-android-test-plugin-host-apk-installer,unified-test-platform-android-test-plugin-host-coverage,unified-test-platform-android-test-plugin-host-device-info,unified-test-platform-android-test-plugin-host-logcat,unified-test-platform-android-test-plugin-result-listener-gradle,unified-test-platform-gradle-work-action
@@ -465,6 +464,7 @@ com.squareup.retrofit2:retrofit-bom:3.0.0=fullDebugAndroidTestCompileClasspath,f
 com.squareup.retrofit2:retrofit:3.0.0=fullDebugAndroidTestCompileClasspath,fullDebugAndroidTestLintChecksClasspath,fullDebugCompileClasspath,fullDebugLintChecksClasspath,fullDebugRuntimeClasspath,fullDebugScreenshotTestCompileClasspath,fullDebugScreenshotTestLintChecksClasspath,fullDebugScreenshotTestRuntimeClasspath,fullDebugUnitTestCompileClasspath,fullDebugUnitTestLintChecksClasspath,fullDebugUnitTestRuntimeClasspath,fullReleaseCompileClasspath,fullReleaseLintChecksClasspath,fullReleaseRuntimeClasspath,fullReleaseScreenshotTestCompileClasspath,fullReleaseScreenshotTestLintChecksClasspath,fullReleaseScreenshotTestRuntimeClasspath,minimalDebugAndroidTestCompileClasspath,minimalDebugAndroidTestLintChecksClasspath,minimalDebugCompileClasspath,minimalDebugLintChecksClasspath,minimalDebugRuntimeClasspath,minimalDebugScreenshotTestCompileClasspath,minimalDebugScreenshotTestLintChecksClasspath,minimalDebugScreenshotTestRuntimeClasspath,minimalDebugUnitTestCompileClasspath,minimalDebugUnitTestLintChecksClasspath,minimalDebugUnitTestRuntimeClasspath,minimalReleaseCompileClasspath,minimalReleaseLintChecksClasspath,minimalReleaseRuntimeClasspath,minimalReleaseScreenshotTestCompileClasspath,minimalReleaseScreenshotTestLintChecksClasspath,minimalReleaseScreenshotTestRuntimeClasspath
 com.squareup:javapoet:1.13.0=_agp_internal_fullDebug_kspClasspath,_agp_internal_fullRelease_kspClasspath,_agp_internal_minimalDebug_kspClasspath,_agp_internal_minimalRelease_kspClasspath,hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease,kspFullDebugAndroidTestKotlinProcessorClasspath,kspFullDebugKotlinProcessorClasspath,kspFullDebugScreenshotTestKotlinProcessorClasspath,kspFullDebugUnitTestKotlinProcessorClasspath,kspFullReleaseKotlinProcessorClasspath,kspFullReleaseScreenshotTestKotlinProcessorClasspath,kspMinimalDebugAndroidTestKotlinProcessorClasspath,kspMinimalDebugKotlinProcessorClasspath,kspMinimalDebugScreenshotTestKotlinProcessorClasspath,kspMinimalDebugUnitTestKotlinProcessorClasspath,kspMinimalReleaseKotlinProcessorClasspath,kspMinimalReleaseScreenshotTestKotlinProcessorClasspath
 com.squareup:javawriter:2.1.1=fullDebugUnitTestLintChecksClasspath,fullDebugUnitTestRuntimeClasspath,minimalDebugUnitTestLintChecksClasspath,minimalDebugUnitTestRuntimeClasspath
+com.squareup:kotlinpoet-ksp:1.11.0=_agp_internal_fullDebug_kspClasspath,_agp_internal_fullRelease_kspClasspath,_agp_internal_minimalDebug_kspClasspath,_agp_internal_minimalRelease_kspClasspath,hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease,kspFullDebugAndroidTestKotlinProcessorClasspath,kspFullDebugKotlinProcessorClasspath,kspFullDebugScreenshotTestKotlinProcessorClasspath,kspFullDebugUnitTestKotlinProcessorClasspath,kspFullReleaseKotlinProcessorClasspath,kspFullReleaseScreenshotTestKotlinProcessorClasspath,kspMinimalDebugAndroidTestKotlinProcessorClasspath,kspMinimalDebugKotlinProcessorClasspath,kspMinimalDebugScreenshotTestKotlinProcessorClasspath,kspMinimalDebugUnitTestKotlinProcessorClasspath,kspMinimalReleaseKotlinProcessorClasspath,kspMinimalReleaseScreenshotTestKotlinProcessorClasspath
 com.squareup:kotlinpoet:1.11.0=_agp_internal_fullDebug_kspClasspath,_agp_internal_fullRelease_kspClasspath,_agp_internal_minimalDebug_kspClasspath,_agp_internal_minimalRelease_kspClasspath,hiltAnnotationProcessorFullDebug,hiltAnnotationProcessorFullDebugAndroidTest,hiltAnnotationProcessorFullDebugUnitTest,hiltAnnotationProcessorFullRelease,hiltAnnotationProcessorMinimalDebug,hiltAnnotationProcessorMinimalDebugAndroidTest,hiltAnnotationProcessorMinimalDebugUnitTest,hiltAnnotationProcessorMinimalRelease,kspFullDebugAndroidTestKotlinProcessorClasspath,kspFullDebugKotlinProcessorClasspath,kspFullDebugScreenshotTestKotlinProcessorClasspath,kspFullDebugUnitTestKotlinProcessorClasspath,kspFullReleaseKotlinProcessorClasspath,kspFullReleaseScreenshotTestKotlinProcessorClasspath,kspMinimalDebugAndroidTestKotlinProcessorClasspath,kspMinimalDebugKotlinProcessorClasspath,kspMinimalDebugScreenshotTestKotlinProcessorClasspath,kspMinimalDebugUnitTestKotlinProcessorClasspath,kspMinimalReleaseKotlinProcessorClasspath,kspMinimalReleaseScreenshotTestKotlinProcessorClasspath
 com.sun.istack:istack-commons-runtime:3.0.8=androidLintTool,unified-test-platform-android-test-plugin-result-listener-gradle
 com.sun.xml.fastinfoset:FastInfoset:1.2.16=androidLintTool,unified-test-platform-android-test-plugin-result-listener-gradle

app/src/full/kotlin/io/homeassistant/companion/android/sensors/ActivitySensorManager.kt

@@ -14,6 +14,7 @@ import com.google.android.gms.location.SleepSegmentEvent
 import com.google.android.gms.location.SleepSegmentRequest
 import dagger.hilt.android.AndroidEntryPoint
 import io.homeassistant.companion.android.common.R as commonR
+import io.homeassistant.companion.android.common.sensors.ProvidesSensor
 import io.homeassistant.companion.android.common.sensors.SensorManager
 import io.homeassistant.companion.android.common.sensors.SensorReceiverBase
 import io.homeassistant.companion.android.common.util.STATE_UNKNOWN
@@ -39,7 +40,8 @@ class ActivitySensorManager :
             "io.homeassistant.companion.android.background.SLEEP_ACTIVITY"
         private var sleepRegistration = false
 
-        private val activity = SensorManager.BasicSensor(
+        @ProvidesSensor
+        internal val activity = SensorManager.BasicSensor(
             "detected_activity",
             "sensor",
             commonR.string.basic_sensor_name_activity,
@@ -48,7 +50,8 @@ class ActivitySensorManager :
             deviceClass = "enum",
         )
 
-        private val sleepConfidence = SensorManager.BasicSensor(
+        @ProvidesSensor
+        internal val sleepConfidence = SensorManager.BasicSensor(
             "sleep_confidence",
             "sensor",
             commonR.string.basic_sensor_name_sleep_confidence,
@@ -59,7 +62,8 @@ class ActivitySensorManager :
             updateType = SensorManager.BasicSensor.UpdateType.CUSTOM,
         )
 
-        private val sleepSegment = SensorManager.BasicSensor(
+        @ProvidesSensor
+        internal val sleepSegment = SensorManager.BasicSensor(
             "sleep_segment",
             "sensor",
             commonR.string.basic_sensor_name_sleep_segment,

app/src/full/kotlin/io/homeassistant/companion/android/sensors/AndroidAutoSensorManager.kt

@@ -5,6 +5,7 @@ import android.os.Build
 import androidx.car.app.connection.CarConnection
 import androidx.lifecycle.Observer
 import io.homeassistant.companion.android.common.R as commonR
+import io.homeassistant.companion.android.common.sensors.ProvidesSensor
 import io.homeassistant.companion.android.common.sensors.SensorManager
 import io.homeassistant.companion.android.common.util.SdkVersion
 import kotlinx.coroutines.launch
@@ -15,7 +16,8 @@ class AndroidAutoSensorManager :
     Observer<Int> {
 
     companion object {
-        private val androidAutoConnected = SensorManager.BasicSensor(
+        @ProvidesSensor
+        internal val androidAutoConnected = SensorManager.BasicSensor(
             "android_auto",
             "binary_sensor",
             commonR.string.basic_sensor_name_android_auto,

app/src/full/kotlin/io/homeassistant/companion/android/sensors/LocationSensorManager.kt

@@ -33,6 +33,7 @@ import io.homeassistant.companion.android.common.data.integration.UpdateLocation
 import io.homeassistant.companion.android.common.data.integration.containsWithAccuracy
 import io.homeassistant.companion.android.common.data.prefs.PrefsRepository
 import io.homeassistant.companion.android.common.notifications.DeviceCommandData
+import io.homeassistant.companion.android.common.sensors.ProvidesSensor
 import io.homeassistant.companion.android.common.sensors.SensorManager
 import io.homeassistant.companion.android.common.sensors.SensorReceiverBase
 import io.homeassistant.companion.android.common.util.DisabledLocationHandler
@@ -102,6 +103,7 @@ class LocationSensorManager :
         const val ACTION_FORCE_HIGH_ACCURACY =
             "io.homeassistant.companion.android.background.FORCE_HIGH_ACCURACY"
 
+        @ProvidesSensor
         val backgroundLocation = SensorManager.BasicSensor(
             "location_background",
             "",
@@ -110,6 +112,8 @@ class LocationSensorManager :
             "mdi:map-marker-multiple",
             updateType = SensorManager.BasicSensor.UpdateType.LOCATION,
         )
+
+        @ProvidesSensor
         val zoneLocation = SensorManager.BasicSensor(
             "zone_background",
             "",
@@ -118,6 +122,8 @@ class LocationSensorManager :
             "mdi:map-marker-radius",
             updateType = SensorManager.BasicSensor.UpdateType.LOCATION,
         )
+
+        @ProvidesSensor
         val singleAccurateLocation = SensorManager.BasicSensor(
             "accurate_location",
             "",
@@ -127,6 +133,7 @@ class LocationSensorManager :
             updateType = SensorManager.BasicSensor.UpdateType.LOCATION,
         )
 
+        @ProvidesSensor
         val highAccuracyMode = SensorManager.BasicSensor(
             "high_accuracy_mode",
             "binary_sensor",
@@ -137,6 +144,7 @@ class LocationSensorManager :
             updateType = SensorManager.BasicSensor.UpdateType.INTENT,
         )
 
+        @ProvidesSensor
         val highAccuracyUpdateInterval = SensorManager.BasicSensor(
             "high_accuracy_update_interval",
             "sensor",

app/src/main/kotlin/io/homeassistant/companion/android/sensors/AppProvidesSensorModule.kt

@@ -0,0 +1,28 @@
+package io.homeassistant.companion.android.sensors
+
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import dagger.multibindings.ElementsIntoSet
+import io.homeassistant.companion.android.common.sensors.SensorManager
+import io.homeassistant.companion.android.sensors.generated.GeneratedProvidesSensorApp
+
+/**
+ * Contributes the `:app` module's `@ProvidesSensor` sensors into the `Set<BasicSensor>`.
+ *
+ * This Hilt module is hand-written (not generated) on purpose: Hilt's KSP processor does not
+ * reliably aggregate an `@InstallIn` module that is itself *generated* by another KSP processor (the
+ * KSP2 round model doesn't feed it to Hilt). So the provides-sensor processor generates only a plain
+ * data object ([GeneratedProvidesSensorApp]), and this source module turns it into the binding.
+ *
+ * `:automotive` reuses this source set, so it must also generate `GeneratedProvidesSensorApp` (its
+ * `providesSensorModuleSuffix` is set to `app`).
+ */
+@Module
+@InstallIn(SingletonComponent::class)
+internal object AppProvidesSensorModule {
+    @Provides
+    @ElementsIntoSet
+    fun appProvidesSensors(): Set<SensorManager.BasicSensor> = GeneratedProvidesSensorApp.sensors
+}