dataconnect: add ktfmt support to gradle plugin (#6439)

Author: dconeybe

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectDslExtension.kt

@@ -63,6 +63,19 @@ abstract class DataConnectDslExtension @Inject constructor(objectFactory: Object
   @Suppress("unused")
   fun emulator(block: DataConnectEmulatorDslExtension.() -> Unit): Unit = block(emulator)
 
+  /**
+   * Values to use when running ktfmt to format the code generated by the Data Connect toolkit,
+   * which override the values from those defined in the outer scope.
+   */
+  val ktfmt: DataConnectKtfmtDslExtension =
+    objectFactory.newInstance<DataConnectKtfmtDslExtension>()
+
+  /**
+   * Configure values to use when running ktfmt to format the code generated by the Data Connect
+   * toolkit, which override the values from those defined in the outer scope.
+   */
+  @Suppress("unused") fun ktfmt(block: DataConnectKtfmtDslExtension.() -> Unit): Unit = block(ktfmt)
+
   /**
    * Values to use when performing code generation, which override the values from those defined in
    * the outer scope.
@@ -85,6 +98,14 @@ abstract class DataConnectDslExtension @Inject constructor(objectFactory: Object
     abstract var schemaExtensionsOutputEnabled: Boolean?
   }
 
+  /**
+   * Values to use when running ktfmt to format the code generated by the Data Connect toolkit,
+   * which override the values from those defined in the outer scope.
+   */
+  abstract class DataConnectKtfmtDslExtension {
+    abstract var jarFile: File?
+  }
+
   interface DataConnectExecutableBuilder {
     var version: String?
     var file: File?

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectGenerateCodeTask.kt

@@ -17,6 +17,7 @@ package com.google.firebase.dataconnect.gradle.plugin
 
 import java.io.File
 import org.gradle.api.DefaultTask
+import org.gradle.api.Task
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
@@ -40,19 +41,23 @@ abstract class DataConnectGenerateCodeTask : DefaultTask() {
 
   @get:OutputDirectory abstract val outputDirectory: DirectoryProperty
 
+  @get:Optional @get:InputFile abstract val ktfmtJarFile: RegularFileProperty
+
   @TaskAction
   fun run() {
     val dataConnectExecutable: File = dataConnectExecutable.get().asFile
     val configDirectory: File? = configDirectory.orNull?.asFile
     val connectors: Collection<String> = connectors.get().distinct().sorted()
     val buildDirectory: File = buildDirectory.get().asFile
     val outputDirectory: File = outputDirectory.get().asFile
+    val ktfmtJarFile: File? = ktfmtJarFile.orNull?.asFile
 
     logger.info("dataConnectExecutable={}", dataConnectExecutable.absolutePath)
     logger.info("configDirectory={}", configDirectory?.absolutePath)
     logger.info("connectors={}", connectors.joinToString(", "))
     logger.info("buildDirectory={}", buildDirectory.absolutePath)
     logger.info("outputDirectory={}", outputDirectory.absolutePath)
+    logger.info("ktfmtJarFile={}", ktfmtJarFile?.absolutePath)
 
     if (outputDirectory.exists()) {
       logger.info("Deleting directory: $outputDirectory")
@@ -71,9 +76,50 @@ abstract class DataConnectGenerateCodeTask : DefaultTask() {
     ) {
       this.connectors = connectors
       this.outputDirectory = outputDirectory
-      this.logFile = File(buildDirectory, "log.txt")
+      this.logFile = File(buildDirectory, "codegen.log.txt")
+    }
+
+    if (ktfmtJarFile !== null) {
+      logger.info("Running ktfmt on generated code")
+      runKtfmt(
+        ktfmtJarFile = ktfmtJarFile,
+        directory = outputDirectory,
+        logFile = File(buildDirectory, "ktfmt.log.txt")
+      )
     }
 
     logger.info("Completed successfully")
   }
 }
+
+private fun Task.runKtfmt(
+  ktfmtJarFile: File,
+  directory: File,
+  logFile: File,
+) {
+  project.mkdir(logFile.parentFile)
+  val logFileStream = logFile.outputStream()
+
+  try {
+    project.javaexec { execSpec ->
+      execSpec.run {
+        classpath(ktfmtJarFile)
+        mainClass.set("com.facebook.ktfmt.cli.Main")
+        args("--google-style")
+        args(directory.absolutePath)
+        isIgnoreExitValue = false
+        standardOutput = logFileStream
+        errorOutput = logFileStream
+      }
+    }
+  } catch (e: Exception) {
+    logFileStream.close()
+    logFile.forEachLine { logger.error(it.trimEnd()) }
+    throw e
+  } finally {
+    logFileStream.close()
+    if (logger.isInfoEnabled) {
+      logFile.forEachLine { logger.error(it.trimEnd()) }
+    }
+  }
+}

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectGradlePlugin.kt

@@ -185,6 +185,7 @@ abstract class DataConnectGradlePlugin : Plugin<Project> {
           }
           connectors.set(dataConnectProviders.connectors)
           buildDirectory.set(baseBuildDirectory.map { it.dir("generateCode") })
+          ktfmtJarFile.set(dataConnectProviders.ktfmtJarFile)
         }
 
       variant.sources.java!!.addGeneratedSourceDirectory(

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectLocalSettings.kt

@@ -17,6 +17,7 @@ package com.google.firebase.dataconnect.gradle.plugin
 
 import java.util.Properties
 import org.gradle.api.Project
+import org.gradle.api.file.RegularFile
 import org.gradle.api.provider.Provider
 
 class DataConnectLocalSettings(project: Project) {
@@ -68,12 +69,18 @@ class DataConnectLocalSettings(project: Project) {
       }
     }
 
+  val ktfmtJarFile: Provider<RegularFile> =
+    project.providerForDataConnectLocalSetting(KEY_KTFMT_JAR_FILE) { settingValue, project ->
+      project.layout.projectDirectory.file(settingValue)
+    }
+
   companion object {
     const val FILE_NAME = "dataconnect.local.properties"
     const val KEY_DATA_CONNECT_EXECUTABLE_FILE = "dataConnectExecutable.file"
     const val KEY_DATA_CONNECT_EXECUTABLE_VERSION = "dataConnectExecutable.version"
     const val KEY_POSTGRES_CONNECTION_URL = "emulator.postgresConnectionUrl"
     const val KEY_SCHEMA_EXTENSIONS_OUTPUT_ENABLED = "emulator.schemaExtensionsOutputEnabled"
+    const val KEY_KTFMT_JAR_FILE = "ktfmt.jar.file"
 
     fun Project.providerForDataConnectLocalSetting(settingName: String): Provider<String> =
       providerForDataConnectLocalSetting(settingName) { value, _ -> value }

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectProviders.kt

@@ -17,6 +17,7 @@ package com.google.firebase.dataconnect.gradle.plugin
 
 import org.gradle.api.Project
 import org.gradle.api.file.Directory
+import org.gradle.api.file.RegularFile
 import org.gradle.api.provider.Provider
 
 class DataConnectProviders(
@@ -120,6 +121,24 @@ class DataConnectProviders(
       .orElse(valueFromProject)
   }
 
+  val ktfmtJarFile: Provider<RegularFile> = run {
+    val gradlePropertyName = "ktfmt.jar.file"
+    val valueFromLocalSettings: Provider<RegularFile> = localSettings.ktfmtJarFile
+    val valueFromGradleProperty: Provider<RegularFile> =
+      project.providers.gradleProperty(gradlePropertyName).flatMap {
+        project.layout.file(project.provider { project.file(it) })
+      }
+    val valueFromVariant: Provider<RegularFile> =
+      project.layout.file(variantExtension.ktfmt.jarFile)
+    val valueFromProject: Provider<RegularFile> =
+      project.layout.file(project.provider { projectExtension.ktfmt.jarFile })
+
+    valueFromLocalSettings
+      .orElse(valueFromGradleProperty)
+      .orElse(valueFromVariant)
+      .orElse(valueFromProject)
+  }
+
   val customConfigDir: Provider<Directory> = run {
     val valueFromVariant: Provider<Directory> = project.layout.dir(variantExtension.configDir)
     val valueFromProject: Provider<Directory> =

firebase-dataconnect/gradleplugin/plugin/src/main/kotlin/com/google/firebase/dataconnect/gradle/plugin/DataConnectVariantDslExtension.kt

@@ -22,11 +22,12 @@ import com.android.build.api.variant.VariantExtension
 import com.android.build.api.variant.VariantExtensionConfig
 import com.google.firebase.dataconnect.gradle.plugin.DataConnectDslExtension.DataConnectCodegenDslExtension
 import com.google.firebase.dataconnect.gradle.plugin.DataConnectDslExtension.DataConnectEmulatorDslExtension
+import com.google.firebase.dataconnect.gradle.plugin.DataConnectDslExtension.DataConnectKtfmtDslExtension
 import java.io.File
 import javax.inject.Inject
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
-import org.gradle.kotlin.dsl.*
+import org.gradle.kotlin.dsl.newInstance
 
 /**
  * This is the extension type for extending [com.android.build.api.variant.Variant].
@@ -104,6 +105,14 @@ abstract class DataConnectVariantDslExtension(
       productFlavorExtensions.map { it.emulator },
     )
 
+  /** @see DataConnectDslExtension.ktfmt */
+  val ktfmt: DataConnectKtfmtVariantDslExtension =
+    objectFactory.newInstance(
+      variant,
+      buildTypeExtension.ktfmt,
+      productFlavorExtensions.map { it.ktfmt },
+    )
+
   /** Values to use when performing code generation. */
   abstract class DataConnectCodegenVariantDslExtension
   @Inject
@@ -158,6 +167,27 @@ abstract class DataConnectVariantDslExtension(
     }
   }
 
+  /** Values to use formatting code with ktfmt. */
+  abstract class DataConnectKtfmtVariantDslExtension
+  @Inject
+  constructor(
+    variant: Variant,
+    buildTypeExtension: DataConnectKtfmtDslExtension,
+    productFlavorExtensions: List<DataConnectKtfmtDslExtension>,
+  ) {
+    /** @see DataConnectKtfmtDslExtension.jarFile */
+    abstract val jarFile: Property<File>
+    init {
+      jarFile.setFrom(
+        variant,
+        buildTypeExtension,
+        productFlavorExtensions,
+        "jarFile",
+        DataConnectKtfmtDslExtension::jarFile
+      )
+    }
+  }
+
   private companion object {
 
     fun <PropertyType : Any, ExtensionType : Any> Property<PropertyType>.setFrom(

firebase-dataconnect/scripts/generate_data_connect_sources.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euo pipefail
+
+if [[ $# -gt 0 ]] ; then
+  echo "ERROR: no command-line arguments are supported, but got $*" >&2
+  exit 2
+fi
+
+readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+
+readonly TARGETS=(
+  ":firebase-dataconnect:connectors:generateDebugDataConnectSources"
+)
+
+readonly args=(
+  "${PROJECT_ROOT_DIR}/gradlew"
+  "-p"
+  "${PROJECT_ROOT_DIR}"
+  "--configure-on-demand"
+  "${TARGETS[@]}"
+)
+
+echo "${args[*]}"
+exec "${args[@]}"