feat!: WIP: support for device code authentication scheme

Author: easimon

Dockerfile

@@ -3,7 +3,7 @@ ARG TEST_IMAGE=eclipse-temurin:17
 ARG RUNTIME_IMAGE=eclipse-temurin:17-jre
 ARG MAVEN_OPTS="-Xmx2000m"
 
-FROM --platform=$BUILDPLATFORM $BUILD_IMAGE as builder
+FROM --platform=$BUILDPLATFORM $BUILD_IMAGE AS builder
 ARG MAVEN_OPTS
 
 WORKDIR /build
@@ -26,7 +26,7 @@ COPY tado-exporter/src /build/tado-exporter/src
 RUN ./mvnw -DskipTests -B package
 
 # Integration tests
-FROM --platform=$BUILDPLATFORM $TEST_IMAGE as test
+FROM --platform=$BUILDPLATFORM $TEST_IMAGE AS test
 ARG MAVEN_OPTS
 
 WORKDIR /build
@@ -43,4 +43,4 @@ COPY --from=builder /build/tado-exporter/target/tado-exporter-*.jar tado-exporte
 ENV JAVA_OPTS="-Xmx64m -Xms64m"
 EXPOSE 8080
 USER 65535:65535
-CMD exec java ${JAVA_OPTS} -jar tado-exporter.jar
+CMD [ "sh", "-c", "exec java $JAVA_OPTS -jar tado-exporter.jar" ]

pom.xml

@@ -51,7 +51,6 @@
   </properties>
 
   <modules>
-    <module>tado-util</module>
     <module>tado-api</module>
     <module>tado-exporter</module>
   </modules>

tado-exporter/pom.xml

@@ -28,10 +28,6 @@
       <groupId>click.dobel.tado</groupId>
       <artifactId>tado-api</artifactId>
     </dependency>
-    <dependency>
-      <groupId>click.dobel.tado</groupId>
-      <artifactId>tado-util</artifactId>
-    </dependency>
 
     <dependency>
       <groupId>org.springframework.boot</groupId>
@@ -60,7 +56,7 @@
       <groupId>io.github.microutils</groupId>
       <artifactId>kotlin-logging-jvm</artifactId>
     </dependency>
-    
+
     <dependency>
       <groupId>io.micrometer</groupId>
       <artifactId>micrometer-registry-prometheus</artifactId>
@@ -82,6 +78,12 @@
       <scope>runtime</scope>
     </dependency>
 
+    <dependency>
+      <groupId>com.fasterxml.jackson.datatype</groupId>
+      <artifactId>jackson-datatype-jsr310</artifactId>
+      <scope>runtime</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>

tado-exporter/src/main/kotlin/click/dobel/tado/exporter/TadoExporterConfiguration.kt

@@ -10,8 +10,7 @@ import click.dobel.tado.exporter.apiclient.TadoConfigurationProperties
 import click.dobel.tado.exporter.metrics.TadoMeterFactory
 import click.dobel.tado.exporter.metrics.ValueFilteringPrometheusRegistry
 import click.dobel.tado.exporter.ratelimit.OncePerIntervalRateLimiter
-import click.dobel.tado.exporter.ratelimit.RateLimiter
-import click.dobel.tado.util.aop.CallLoggingInterceptor
+import click.dobel.tado.exporter.ratelimit.RateLimiterFactory
 import com.github.benmanes.caffeine.cache.Caffeine
 import com.github.benmanes.caffeine.cache.stats.StatsCounter
 import io.micrometer.core.instrument.Meter
@@ -27,7 +26,6 @@ import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
 import org.springframework.scheduling.annotation.EnableScheduling
 import java.util.concurrent.TimeUnit
-import kotlin.time.Duration.Companion.minutes
 
 @Configuration
 @EnableCaching
@@ -79,13 +77,7 @@ class TadoExporterConfiguration {
   }
 
   @Bean
-  fun authRateLimiter(): RateLimiter = OncePerIntervalRateLimiter(
-    "Authentication attempt",
-    1.minutes
-  )
-
-  @Bean
-  fun aopLogger() = CallLoggingInterceptor()
+  fun rateLimiterFactory(): RateLimiterFactory = ::OncePerIntervalRateLimiter
 
   @Bean
   fun prometheusRegistry(): PrometheusRegistry {

tado-exporter/src/main/kotlin/click/dobel/tado/exporter/apiclient/RestTemplateEx.kt

@@ -1,29 +1,17 @@
 package click.dobel.tado.exporter.apiclient
 
-import org.springframework.http.ResponseEntity
+import click.dobel.tado.exporter.apiclient.auth.model.accesstoken.AccessToken
+import org.springframework.boot.web.client.RestTemplateBuilder
+import org.springframework.http.HttpHeaders
 import org.springframework.web.client.ResourceAccessException
-import org.springframework.web.client.RestTemplate
+import org.springframework.web.client.RestClient
+import org.springframework.web.client.RestClient.RequestHeadersSpec
 
-inline fun <reified T : Any> RestTemplate.getForEntity(
-  url: String,
-  vararg uriVariables: Any
-): ResponseEntity<T> {
-  return getForEntity(url, T::class.java, uriVariables)
-}
+fun RestTemplateBuilder.userAgent(): RestTemplateBuilder =
+  defaultHeader(HttpHeaders.USER_AGENT, "tado-exporter (https://github.com/easimon/tado-exporter)")
 
-inline fun <reified T : Any> RestTemplate.getForObject(
-  url: String,
-  vararg uriVariables: Any
-): T {
-  return getForObject(url, T::class.java, uriVariables)
-    ?: throw ResourceAccessException("I/O error on GET $url: null response.")
-}
+fun <S : RequestHeadersSpec<S>> RequestHeadersSpec<S>.bearerAuth(token: AccessToken.BearerToken) =
+  header(HttpHeaders.AUTHORIZATION, "Bearer ${token.value}")
 
-inline fun <reified R : Any, reified T : Any> RestTemplate.postForObject(
-  url: String,
-  body: R,
-  vararg uriVariables: Any
-): T {
-  return postForObject(url, body, T::class.java, uriVariables)
-    ?: throw ResourceAccessException("I/O error on POST $url: null response.")
-}
+inline fun <reified T> RestClient.ResponseSpec.bodyOrError(): T =
+  body(T::class.java) ?: throw ResourceAccessException("HTTP request returned null")

tado-exporter/src/main/kotlin/click/dobel/tado/exporter/apiclient/TadoApiClient.kt

@@ -5,22 +5,27 @@ import click.dobel.tado.api.HomeState
 import click.dobel.tado.api.User
 import click.dobel.tado.api.WeatherReport
 import click.dobel.tado.api.ZoneState
-import click.dobel.tado.exporter.apiclient.auth.TadoAuthFilter
+import click.dobel.tado.exporter.apiclient.auth.TadoAuthenticator
+import click.dobel.tado.exporter.apiclient.auth.model.accesstoken.AccessToken
+import click.dobel.tado.exporter.apiclient.logging.loggingIfConfigured
 import click.dobel.tado.exporter.apiclient.model.Zones
-import click.dobel.tado.util.aop.Logged
+import mu.KotlinLogging
 import org.springframework.boot.web.client.RestTemplateBuilder
 import org.springframework.cache.annotation.Cacheable
+import org.springframework.http.MediaType
 import org.springframework.stereotype.Component
-import org.springframework.web.client.RestTemplate
+import org.springframework.web.client.ResourceAccessException
+import org.springframework.web.client.RestClient
 
 @Component
 class TadoApiClient(
   private val configuration: TadoConfigurationProperties,
-  authFilter: TadoAuthFilter,
+  private val authenticationState: TadoAuthenticator,
   restTemplateBuilder: RestTemplateBuilder
 ) {
 
   companion object {
+    private val logger = KotlinLogging.logger {}
     const val BASE_URL = "/api/v2"
 
     const val ME_PATH = "/me"
@@ -30,6 +35,8 @@ class TadoApiClient(
     const val WEATHER_PATH = "/weather"
   }
 
+  val isAuthenticated: Boolean get() = authenticationState.accessToken is AccessToken.BearerToken
+
   @Cacheable("User", sync = true)
   fun me() = get<User>(ME_PATH)
 
@@ -46,19 +53,32 @@ class TadoApiClient(
     get("$HOMES_PATH/${homeId}/$ZONES_PATH")
 
   @Cacheable("ZoneState", sync = true)
-  @Logged("Retrieving fresh zone state for HomeId {}, ZoneId {}.", ["homeId", "zoneId"])
-  fun zoneState(homeId: Int, zoneId: Int): ZoneState =
-    get("$HOMES_PATH/${homeId}/$ZONES_PATH/${zoneId}/$STATE_PATH")
+  fun zoneState(homeId: Int, zoneId: Int): ZoneState = logger
+    .info { "Retrieving fresh zone state for HomeId $homeId, ZoneId $zoneId." }
+    .run { get("$HOMES_PATH/${homeId}/$ZONES_PATH/${zoneId}/$STATE_PATH") }
 
   @Cacheable("WeatherReport", sync = true)
-  @Logged("Retrieving fresh weather report for HomeId {}.", ["homeId"])
-  fun weather(homeId: Int): WeatherReport =
-    get("$HOMES_PATH/${homeId}/$WEATHER_PATH")
+  fun weather(homeId: Int): WeatherReport = logger
+    .info { "Retrieving fresh weather report for HomeId $homeId." }
+    .run { get("$HOMES_PATH/${homeId}/$WEATHER_PATH") }
 
   private inline fun <reified T : Any> get(
     path: String
-  ): T {
-    return restTemplate.getForObject(url(path))
+  ): T = when (val token = authenticationState.accessToken) {
+    is AccessToken.BearerToken -> {
+      restClient.get()
+        .uri(url(path))
+        .bearerAuth(token)
+        .accept(MediaType.APPLICATION_JSON)
+        .retrieve()
+        .bodyOrError()
+    }
+
+    else -> {
+      throw ResourceAccessException(
+        "Skipping request, not authenticated (${authenticationState.currentStateAsString})"
+      )
+    }
   }
 
   private fun url(
@@ -69,8 +89,10 @@ class TadoApiClient(
     path: String
   ): String = if (path.startsWith("/")) path else "/$path"
 
-  private val restTemplate: RestTemplate = restTemplateBuilder
-    .additionalInterceptors(authFilter)
-    .build()
+  private val restClient: RestClient = RestClient.create(
+    restTemplateBuilder
+      .loggingIfConfigured(configuration)
+      .userAgent()
+      .build()
+  )
 }
-

tado-exporter/src/main/kotlin/click/dobel/tado/exporter/apiclient/TadoConfigurationProperties.kt

@@ -1,16 +1,19 @@
 package click.dobel.tado.exporter.apiclient
 
 import org.springframework.boot.context.properties.ConfigurationProperties
-import java.time.Duration
 
 @ConfigurationProperties("tado")
-class TadoConfigurationProperties(
-  val username: String,
-  val password: String,
+data class TadoConfigurationProperties(
   val clientId: String,
-  val clientSecret: String,
-  val scope: String,
   val apiServer: String,
   val authServer: String,
-  val zoneDiscoveryInterval: Duration
+  val authCachePath: String,
+  val zoneDiscoveryInterval: JavaDuration,
+  val debug: TadoDebuggingConfig = TadoDebuggingConfig(),
 )
+
+data class TadoDebuggingConfig(
+  val http: Boolean = false
+)
+
+typealias JavaDuration = java.time.Duration