dataconnect: integrate codegen into the gradle build

.github/workflows/android.yml

@@ -16,11 +16,12 @@ jobs:
         java-version: 17
     - name: Setup Gradle
       uses: gradle/gradle-build-action@v2
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 22
     - name: Check Snippets
       run: python scripts/checksnippets.py
-    # TODO(thatfiredev): remove this once github.com/firebase/quickstart-android/issues/1672 is fixed
-    - name: Remove Firebase Data Connect from CI
-      run: python scripts/ci_remove_fdc.py
     - name: Copy mock google_services.json
       run: ./copy_mock_google_services_json.sh
     - name: Build with Gradle (Pull Request)

dataconnect/README.md

@@ -71,3 +71,20 @@ open `quickstart-android/dataconnect/movie-connector/queries.gql` and run the `L
 ### 5. Running the app
 
 Press the Run button in Android Studio to run the sample app on your device.
+
+### 6. Re-generating the source code for Data Connect connectors
+
+This project defines a custom Gradle plugin that looks after generating the Kotlin code for the
+queries and mutations defined in the GraphQL files. The code will be generated on-demand when
+needed by a build. To generate the code manually, run:
+
+```
+../gradlew generateDebugDataConnectSources
+```
+
+If you are making frequent changes to the GraphQL files, it may be convenient to run the code
+generation upon _every_ change, without waiting for a build. To do that, run:
+
+```
+../gradlew generateDebugDataConnectSources --continuous
+```

dataconnect/app/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.google.services)
     alias(libs.plugins.compose.compiler)
+    id("com.google.firebase.example.dataconnect.gradle")
 }
 
 android {
@@ -50,9 +51,6 @@ android {
             excludes += "/META-INF/{AL2.0,LGPL2.1}"
         }
     }
-    sourceSets.getByName("main") {
-        java.srcDirs("build/generated/sources")
-    }
 }
 
 dependencies {
@@ -83,3 +81,13 @@ dependencies {
     debugImplementation(libs.androidx.ui.tooling)
     debugImplementation(libs.androidx.ui.test.manifest)
 }
+
+dataconnect {
+    // The version of https://www.npmjs.com/package/firebase-tools to use to perform the
+    // Data Connect code generation.
+    firebaseToolsVersion = "13.23.0"
+
+    // The directory that contains dataconnect.yaml to use as input when performing
+    // the Data Connect code generation.
+    dataConnectConfigDir = file("../dataconnect")
+}

dataconnect/buildSrc/build.gradle.kts

@@ -0,0 +1,45 @@
+/*
+ * 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.
+ */
+
+plugins {
+  // See https://docs.gradle.org/current/userguide/kotlin_dsl.html#sec:kotlin-dsl_plugin
+  `kotlin-dsl`
+  alias(libs.plugins.spotless)
+}
+
+java { toolchain { languageVersion.set(JavaLanguageVersion.of(17)) } }
+
+dependencies {
+  implementation(libs.android.gradlePlugin.api)
+  implementation(libs.snakeyaml)
+}
+
+gradlePlugin {
+  plugins {
+    create("dataconnect") {
+      id = "com.google.firebase.example.dataconnect.gradle"
+      implementationClass = "com.google.firebase.example.dataconnect.gradle.DataConnectGradlePlugin"
+    }
+  }
+}
+
+spotless {
+  kotlin { ktfmt(libs.versions.ktfmt.get()).googleStyle() }
+  kotlinGradle {
+    target("*.gradle.kts")
+    ktfmt(libs.versions.ktfmt.get()).googleStyle()
+  }
+}

dataconnect/buildSrc/settings.gradle.kts

@@ -0,0 +1,15 @@
+pluginManagement {
+  repositories {
+    gradlePluginPortal()
+    google()
+    mavenCentral()
+  }
+}
+
+dependencyResolutionManagement {
+  repositories {
+    google()
+    mavenCentral()
+  }
+  versionCatalogs { create("libs") { from(files("../../gradle/libs.versions.toml")) } }
+}

dataconnect/buildSrc/src/main/kotlin/com/google/firebase/example/dataconnect/gradle/CodegenTask.kt

@@ -0,0 +1,75 @@
+/*
+ * 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.
+ */
+
+package com.google.firebase.example.dataconnect.gradle
+
+import java.io.File
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
+
+abstract class CodegenTask : DefaultTask() {
+
+  @get:InputDirectory abstract val dataConnectConfigDir: DirectoryProperty
+
+  @get:InputFile abstract val firebaseExecutable: RegularFileProperty
+
+  @get:OutputDirectory abstract val outputDirectory: DirectoryProperty
+
+  @get:Internal abstract val tweakedDataConnectConfigDir: DirectoryProperty
+
+  @TaskAction
+  fun run() {
+    val dataConnectConfigDir = dataConnectConfigDir.get().asFile
+    val firebaseExecutable = firebaseExecutable.get().asFile
+    val outputDirectory = outputDirectory.get().asFile
+    val tweakedDataConnectConfigDir = tweakedDataConnectConfigDir.get().asFile
+
+    logger.info("dataConnectConfigDir: {}", dataConnectConfigDir)
+    logger.info("firebaseExecutable: {}", firebaseExecutable)
+    logger.info("outputDirectory: {}", outputDirectory)
+    logger.info("tweakedDataConnectConfigDir: {}", tweakedDataConnectConfigDir)
+
+    project.delete(outputDirectory)
+    project.delete(tweakedDataConnectConfigDir)
+    project.mkdir(tweakedDataConnectConfigDir)
+
+    project.copy {
+      from(dataConnectConfigDir)
+      into(tweakedDataConnectConfigDir)
+    }
+    tweakConnectorYamlFiles(tweakedDataConnectConfigDir, outputDirectory.absolutePath)
+
+    runCommand(File(tweakedDataConnectConfigDir, "generate.log.txt")) {
+      commandLine(firebaseExecutable.absolutePath, "--debug", "dataconnect:sdk:generate")
+      // Specify a fake project because dataconnect:sdk:generate unnecessarily
+      // requires one. The actual value does not matter.
+      args("--project", "zzyzx")
+      workingDir(tweakedDataConnectConfigDir)
+    }
+  }
+
+  internal fun configureFrom(providers: MyVariantProviders) {
+    dataConnectConfigDir.set(providers.dataConnectConfigDir)
+    firebaseExecutable.set(providers.firebaseExecutable)
+    tweakedDataConnectConfigDir.set(providers.buildDirectory.map { it.dir("config") })
+  }
+}

dataconnect/buildSrc/src/main/kotlin/com/google/firebase/example/dataconnect/gradle/Commands.kt

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+package com.google.firebase.example.dataconnect.gradle
+
+import java.io.File
+import org.gradle.api.Task
+import org.gradle.process.ExecSpec
+
+internal fun Task.runCommand(logFile: File, configure: ExecSpec.() -> Unit) {
+  val effectiveLogFile = if (logger.isInfoEnabled) null else logFile
+  val result =
+    effectiveLogFile?.outputStream().use { logStream ->
+      project.runCatching {
+        exec {
+          isIgnoreExitValue = false
+          if (logStream !== null) {
+            standardOutput = logStream
+            errorOutput = logStream
+          }
+          configure(this)
+        }
+      }
+    }
+  result.onFailure { exception ->
+    effectiveLogFile?.let { logger.warn("{}", it.readText()) }
+    throw exception
+  }
+}

dataconnect/buildSrc/src/main/kotlin/com/google/firebase/example/dataconnect/gradle/ConnectorYamlTweaking.kt

@@ -0,0 +1,89 @@
+/*
+ * 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.
+ */
+
+package com.google.firebase.example.dataconnect.gradle
+
+import java.io.File
+import org.gradle.api.GradleException
+import org.gradle.api.Task
+import org.yaml.snakeyaml.Yaml
+
+internal fun Task.tweakConnectorYamlFiles(dir: File, newOutputDir: String) {
+  logger.info("Tweaking connector.yaml files in {}", dir.absolutePath)
+  dir.walk().forEach { file ->
+    if (file.isFile && file.name == "connector.yaml") {
+      tweakConnectorYamlFile(file, newOutputDir)
+    } else {
+      logger.debug("skipping file: {}", file.absolutePath)
+    }
+  }
+}
+
+internal fun Task.tweakConnectorYamlFile(file: File, newOutputDir: String) {
+  logger.info("Tweaking connector.yaml file: {}", file.absolutePath)
+
+  fun Map<*, *>.withTweakedKotlinSdk() =
+    filterKeys { it == "kotlinSdk" }
+      .mapValues { (_, value) ->
+        val kotlinSdkMap =
+          value as? Map<*, *>
+            ?: throw GradleException(
+              "Parsing ${file.absolutePath} failed: \"kotlinSdk\" is " +
+                (if (value === null) "null" else value::class.qualifiedName) +
+                ", but expected ${Map::class.qualifiedName} " +
+                "(error code m697s27yxn)"
+            )
+        kotlinSdkMap.mapValues { (key, value) ->
+          if (key == "outputDir") {
+            newOutputDir
+          } else {
+            value
+          }
+        }
+      }
+
+  fun Map<*, *>.withTweakedGenerateNode() = mapValues { (key, value) ->
+    if (key != "generate") {
+      value
+    } else {
+      val generateMap =
+        value as? Map<*, *>
+          ?: throw GradleException(
+            "Parsing ${file.absolutePath} failed: \"generate\" is " +
+              (if (value === null) "null" else value::class.qualifiedName) +
+              ", but expected ${Map::class.qualifiedName} " +
+              "(error code 9c2p857gq6)"
+          )
+      generateMap.withTweakedKotlinSdk()
+    }
+  }
+
+  val yaml = Yaml()
+  val rootObject = file.reader(Charsets.UTF_8).use { reader -> yaml.load<Any?>(reader) }
+
+  val rootMap =
+    rootObject as? Map<*, *>
+      ?: throw GradleException(
+        "Parsing ${file.absolutePath} failed: root is " +
+          (if (rootObject === null) "null" else rootObject::class.qualifiedName) +
+          ", but expected ${Map::class.qualifiedName} " +
+          "(error code 45dw8jx8jd)"
+      )
+
+  val newRootMap = rootMap.withTweakedGenerateNode()
+
+  file.writer(Charsets.UTF_8).use { writer -> yaml.dump(newRootMap, writer) }
+}

dataconnect/buildSrc/src/main/kotlin/com/google/firebase/example/dataconnect/gradle/DataConnectExtension.kt

@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+package com.google.firebase.example.dataconnect.gradle
+
+import java.io.File
+
+interface DataConnectExtension {
+  var firebaseToolsVersion: String?
+  var dataConnectConfigDir: File?
+}