Convert STAR sample to KMP

.github/workflows/ci.yml

@@ -49,6 +49,11 @@ jobs:
               detektTest \
               assembleAndroidTest
 
+      - name: Verify STAR desktop builds
+        id: gradle-build-star-desktop
+        run: |
+          ./gradlew :samples:star:jvmJar -Pcircuit.buildDesktop
+
       # Defer these until after the above run, no need to waste resources running them if there are other failures first
       - name: Run instrumentation tests via emulator.wtf (main repo only)
         if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository

build.gradle.kts

@@ -15,7 +15,7 @@ import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import java.net.URI
 import org.jetbrains.compose.ComposeExtension
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
-import org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_11
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
@@ -95,7 +95,12 @@ allprojects {
     format("license") {
       licenseHeaderFile(rootProject.file("spotless/spotless.kt"), "(package|@file:)")
       target("src/**/*.kt")
-      targetExclude("**/circuit/backstack/**/*.kt")
+      targetExclude(
+        "**/circuit/backstack/**/*.kt",
+        "**/HorizontalPagerIndicator.kt",
+        "**/FilterList.kt",
+        "**/Remove.kt",
+      )
     }
   }
   configure<SpotlessExtension> {
@@ -131,6 +136,8 @@ fun Project.configureComposeBom(dependencyHandler: DependencyHandler) {
   }
 }
 
+val jvmTargetVersion = libs.versions.jvmTarget
+
 subprojects {
   pluginManager.withPlugin("java") {
     configure<JavaPluginExtension> {
@@ -141,7 +148,9 @@ subprojects {
       }
     }
 
-    tasks.withType<JavaCompile>().configureEach { options.release.set(11) }
+    tasks.withType<JavaCompile>().configureEach {
+      options.release.set(jvmTargetVersion.map(String::toInt))
+    }
 
     // This is the default base plugin applied on all projects, so safe to add this hook here
     configureComposeBom(dependencies)
@@ -154,7 +163,7 @@ subprojects {
       compilerOptions {
         allWarningsAsErrors.set(true)
         if (this is KotlinJvmCompilerOptions) {
-          jvmTarget.set(JVM_11)
+          jvmTarget.set(jvmTargetVersion.map(JvmTarget::fromTarget))
           // Stub gen copies args from the parent compilation
           if (this@configureEach !is KaptGenerateStubsTask) {
             freeCompilerArgs.addAll(

circuit-codegen/src/main/kotlin/com/slack/circuit/codegen/CircuitSymbolProcessorProvider.kt

@@ -124,6 +124,8 @@ private class CircuitSymbolProcessor(
   private val platforms: List<PlatformInfo>,
 ) : SymbolProcessor {
 
+  private val lenient = options["circuit.codegen.lenient"]?.toBoolean() ?: false
+
   override fun process(resolver: Resolver): List<KSAnnotated> {
     val symbols = CircuitSymbols.create(resolver) ?: return emptyList()
     val codegenMode =
@@ -375,23 +377,28 @@ private class CircuitSymbolProcessor(
           }
       }
       InstantiationType.CLASS -> {
-        val cd = annotatedElement as KSClassDeclaration
-        cd.checkVisibility(logger) {
+        val declaration = annotatedElement as KSClassDeclaration
+        declaration.checkVisibility(logger) {
           return null
         }
-        val isAssisted = cd.isAnnotationPresent(AssistedFactory::class)
+        val isAssisted =
+          if (lenient) {
+            declaration.annotations.any { it.shortName.asString().contains("AssistedFactory") }
+          } else {
+            declaration.isAnnotationPresent(AssistedFactory::class)
+          }
         val creatorOrConstructor: KSFunctionDeclaration?
         val targetClass: KSClassDeclaration
         if (isAssisted) {
-          val creatorFunction = cd.getAllFunctions().filter { it.isAbstract }.single()
+          val creatorFunction = declaration.getAllFunctions().filter { it.isAbstract }.single()
           creatorOrConstructor = creatorFunction
           targetClass = creatorFunction.returnType!!.resolve().declaration as KSClassDeclaration
           targetClass.checkVisibility(logger) {
             return null
           }
         } else {
-          creatorOrConstructor = cd.primaryConstructor
-          targetClass = cd
+          creatorOrConstructor = declaration.primaryConstructor
+          targetClass = declaration
         }
         val useProvider =
           !isAssisted && creatorOrConstructor?.isAnnotationPresent(Inject::class) == true
@@ -409,10 +416,16 @@ private class CircuitSymbolProcessor(
             }
             .firstOrNull()
             ?: run {
+              val annotationsString =
+                declaration.annotations.toList().joinToString {
+                  it.annotationType.resolve().toTypeName().toString()
+                }
               logger.error(
                 "Factory must be for a UI or Presenter class, but was " +
-                  "${targetClass.qualifiedName?.asString()}. " +
-                  "Supertypes: ${targetClass.getAllSuperTypes().toList()}",
+                  "${targetClass.qualifiedName?.asString()}.\n" +
+                  "Supertypes: ${targetClass.getAllSuperTypes().toList()}.\n" +
+                  "isAssisted? ${isAssisted}\n" +
+                  "Annotations: $annotationsString}",
                 targetClass
               )
               return null
@@ -442,7 +455,9 @@ private class CircuitSymbolProcessor(
             CodeBlock.of("provider.get()")
           } else if (isAssisted) {
             // Inject the target class's assisted factory that we'll call its create() on.
-            constructorParams.add(ParameterSpec.builder("factory", cd.toClassName()).build())
+            constructorParams.add(
+              ParameterSpec.builder("factory", declaration.toClassName()).build()
+            )
             CodeBlock.of(
               "factory.%L(%L)",
               creatorOrConstructor!!.simpleName.getShortName(),

circuit-codegen/src/test/kotlin/com/slack/circuit/codegen/CircuitSymbolProcessorTest.kt

@@ -1091,9 +1091,7 @@ class CircuitSymbolProcessorTest {
         )
     ) { messages ->
       assertThat(messages)
-        .contains(
-          "Factory must be for a UI or Presenter class, but was test.Favorites. Supertypes: [Any]"
-        )
+        .contains("Factory must be for a UI or Presenter class, but was test.Favorites.")
     }
   }
 

circuitx/gesture-navigation/src/commonMain/kotlin/com/slack/circuitx/gesturenavigation/OptionalLayout.kt

@@ -12,7 +12,7 @@ import androidx.compose.ui.layout.layout
  * A composable which optionally lays out the given [content], depending on what [shouldLayout]
  * returns, whilst still keeping [content] attached to composition.
  *
- * This is useful when used in conjuction with `movableContentOf`, as that will destroy the
+ * This is useful when used in conjunction with `movableContentOf`, as that will destroy the
  * content's state 'very soon' after the content is detached from composition. By using this
  * composable, the content can remain attached to composition, but can avoid being measured, laid
  * out or drawn, allowing us to reduce wasted work.

docs/code-gen.md

@@ -24,6 +24,16 @@ ksp {
 }
 ```
 
+If using Kotlin multiplatform with typealias annotations for Dagger annotations (i.e. expect 
+annotations in common with actual typealias declarations in JVM source sets), you can match on just 
+annotation short names alone to support this case via `circuit.codegen.lenient` mode.
+
+```kotlin
+ksp {
+  arg("circuit.codegen.lenient", "true")
+}
+```
+
 ## Usage
 
 The primary entry point is the `CircuitInject` annotation.

gradle.properties

@@ -31,11 +31,17 @@ org.gradle.parallel=true
 org.gradle.configureondemand=true
 org.gradle.caching=true
 
+# Disable noisy DAGP stability warning
+dependency.analysis.compatibility=NONE
+
 # Disable noisy stability warning
 kotlin.mpp.stability.nowarn=true
 kotlin.mpp.androidSourceSetLayoutVersion=2
 kotlin.mpp.androidGradlePluginCompatibility.nowarn=true
 
+# https://kotlinlang.org/docs/ksp-multiplatform.html#avoid-the-ksp-configuration-on-ksp-1-0-1
+systemProp.allowAllTargetConfiguration=false
+
 # Enable for Compose iOS
 org.jetbrains.compose.experimental.uikit.enabled=true
 # Enable for Compose Web

gradle/libs.versions.toml

@@ -10,6 +10,7 @@ anvil = "2.4.8"
 atomicfu = "0.23.1"
 benchmark = "1.2.2"
 coil = "2.5.0"
+coil3 = "3.0.0-alpha01"
 compose-animation = "1.5.4"
 # Pre-release versions for testing Kotlin previews can be found here
 # https://androidx.dev/storage/compose-compiler/repository
@@ -31,14 +32,15 @@ detekt = "1.23.4"
 dokka = "1.9.10"
 eithernet = "1.8.0"
 jdk = "20"
+jvmTarget = "11"
 kct = "0.4.0"
 kotlin = "1.9.22"
 kotlinpoet = "1.15.3"
 kotlinx-coroutines = "1.7.3"
 ksp = "1.9.22-1.0.16"
 ktfmt = "0.46"
+ktor = "2.3.7"
 leakcanary = "2.13"
-material = "1.6.1"
 material-composeThemeAdapter = "1.2.1"
 mavenPublish = "0.26.0"
 molecule = "1.3.2"
@@ -79,6 +81,7 @@ kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref
 kotlin-plugin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlin" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp"}
 mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
+molecule = { id = "app.cash.molecule", version.ref = "molecule" }
 mosaic = { id = "com.jakewharton.mosaic", version.ref = "mosaic" }
 moshiGradlePlugin = { id = "dev.zacsweers.moshix", version.ref = "moshix" }
 paparazzi = { id = "app.cash.paparazzi", version.ref = "paparazzi" }
@@ -100,7 +103,6 @@ androidx-browser = { module = "androidx.browser:browser", version.ref = "android
 ####### Compose
 # You must enable the SlackProperties.enableCompose property to use these.
 androidx-compose-accompanist-appCompatThemeAdapter = { module = "com.google.accompanist:accompanist-appcompat-theme", version.ref = "accompanist" }
-androidx-compose-accompanist-coil = { module = "com.google.accompanist:accompanist-coil", version.ref = "accompanist" }
 androidx-compose-accompanist-flowlayout = { module = "com.google.accompanist:accompanist-flowlayout", version.ref = "accompanist" }
 androidx-compose-accompanist-pager = { module = "com.google.accompanist:accompanist-pager", version.ref = "accompanist" }
 androidx-compose-accompanist-pager-indicators = { module = "com.google.accompanist:accompanist-pager-indicators", version.ref = "accompanist" }
@@ -119,10 +121,8 @@ androidx-compose-integration-materialThemeAdapter = { module = "com.google.andro
 androidx-compose-integration-rxjava3 = { module = "androidx.compose.runtime:runtime-rxjava3", version.ref = "compose-runtime" }
 # Material design icons
 androidx-compose-material-icons = { module = "androidx.compose.material:material-icons-core", version.ref = "compose-material" }
-androidx-compose-material-iconsExtended = { module = "androidx.compose.material:material-icons-extended", version.ref = "compose-material" }
 androidx-compose-material-material = { module = "androidx.compose.material:material", version.ref = "compose-material" }
 androidx-compose-material-material3 = { module = "androidx.compose.material3:material3", version.ref = "compose-material3" }
-androidx-compose-material-material3-windowSizeClass = { module = "androidx.compose.material3:material3-window-size-class", version.ref = "compose-material3" }
 # Runtime artifact, must be manually applied.
 androidx-compose-runtime = { module = "androidx.compose.runtime:runtime", version.ref = "compose-runtime" }
 androidx-compose-runtime-livedata = { module = "androidx.compose.runtime:runtime-livedata", version.ref = "compose-runtime" }
@@ -158,6 +158,7 @@ androidx-test-monitor = "androidx.test:monitor:1.6.1"
 androidx-test-uiautomator = "androidx.test.uiautomator:uiautomator:2.3.0-beta01"
 
 anvil-annotations = { module = "com.squareup.anvil:annotations", version.ref = "anvil" }
+anvil-annotations-optional = { module = "com.squareup.anvil:annotations-optional", version.ref = "anvil" }
 
 atomicfu = { module = "org.jetbrains.kotlinx:atomicfu", version.ref = "atomicfu" }
 
@@ -171,19 +172,29 @@ clikt = "com.github.ajalt.clikt:clikt:4.2.1"
 coil = { module = "io.coil-kt:coil", version.ref = "coil" }
 coil-compose = { module = "io.coil-kt:coil-compose", version.ref = "coil" }
 coil-test = { module = "io.coil-kt:coil-test", version.ref = "coil" }
+coil3 = { module = "io.coil-kt.coil3:coil", version.ref = "coil3" }
+coil3-compose = { module = "io.coil-kt.coil3:coil-compose-core", version.ref = "coil3" }
+coil3-network = { module = "io.coil-kt.coil3:coil-network", version.ref = "coil3" }
+coil3-test = { module = "io.coil-kt.coil3:coil-test", version.ref = "coil3" }
 
 compose-compilerJb = { module = "org.jetbrains.compose.compiler:compiler", version.ref = "compose-jb-compiler" }
 compose-runtime = { module = "org.jetbrains.compose.runtime:runtime", version.ref = "compose-jb" }
 compose-runtime-saveable = { module = "org.jetbrains.compose.runtime:runtime-saveable", version.ref = "compose-jb" }
 compose-ui = { module = "org.jetbrains.compose.ui:ui", version.ref = "compose-jb" }
 compose-uiUtil = { module = "org.jetbrains.compose.ui:ui-util", version.ref = "compose-jb" }
 compose-ui-testing-junit = { module = "org.jetbrains.compose.ui:ui-test-junit4", version.ref = "compose-jb" }
+compose-ui-tooling = { module = "org.jetbrains.compose.ui:ui-tooling", version.ref = "compose-jb" }
+compose-ui-tooling-data = { module = "org.jetbrains.compose.ui:ui-tooling-data", version.ref = "compose-jb" }
+compose-ui-tooling-preview = { module = "org.jetbrains.compose.ui:ui-tooling-preview", version.ref = "compose-jb" }
 compose-foundation = { module = "org.jetbrains.compose.foundation:foundation", version.ref = "compose-jb" }
+compose-material-icons = { module = "org.jetbrains.compose.material:material-icons-core", version.ref = "compose-jb" }
+compose-material-iconsExtended = { module = "org.jetbrains.compose.material:material-icons-extended", version.ref = "compose-jb" }
 compose-material-material = { module = "org.jetbrains.compose.material:material", version.ref = "compose-jb" }
 compose-material-material3 = { module = "org.jetbrains.compose.material3:material3", version.ref = "compose-jb" }
 
 coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
 coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-android", version.ref = "kotlinx-coroutines" }
+coroutines-swing = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-swing", version.ref = "kotlinx-coroutines" }
 coroutines-rxjava = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-rx3", version.ref = "kotlinx-coroutines" }
 coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines" }
 
@@ -195,6 +206,7 @@ detektPlugins-twitterCompose = "com.twitter.compose.rules:detekt:0.0.26"
 desugarJdkLibs = "com.android.tools:desugar_jdk_libs:2.0.4"
 
 eithernet = { module = "com.slack.eithernet:eithernet", version.ref = "eithernet" }
+eithernet-testFixtures = { module = "com.slack.eithernet:eithernet", version.ref = "eithernet" }
 
 hilt = { module = "com.google.dagger:hilt-core", version.ref = "dagger" }
 jline = "org.jline:jline:3.25.0"
@@ -213,11 +225,20 @@ ksp = { module = "com.google.devtools.ksp:symbol-processing", version.ref = "ksp
 ksp-api = { module = "com.google.devtools.ksp:symbol-processing-api", version.ref = "ksp" }
 # Only present to trigger automatic renovate updates
 ktfmt = { module = "com.facebook:ktfmt", version.ref = "ktfmt" }
+
+ktor-client = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
+ktor-client-contentNegotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
+ktor-client-engine-okhttp = { module = "io.ktor:ktor-client-okhttp", version.ref = "ktor" }
+ktor-client-engine-js = { module = "io.ktor:ktor-client-js", version.ref = "ktor" }
+ktor-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
+
 leakcanary-android = { module = "com.squareup.leakcanary:leakcanary-android", version.ref = "leakcanary" }
 leakcanary-android-instrumentation = { module = "com.squareup.leakcanary:leakcanary-android-instrumentation", version.ref = "leakcanary" }
 
 lints-compose = "com.slack.lint.compose:compose-lint-checks:1.2.0"
 
+material = "com.google.android.material:material:1.11.0"
+
 molecule-runtime = { module = "app.cash.molecule:molecule-runtime", version.ref = "molecule" }
 moshi = { module = "com.squareup.moshi:moshi", version.ref = "moshi" }
 moshi-kotlin = { module = "com.squareup.moshi:moshi-kotlin", version.ref = "moshi" }
@@ -237,6 +258,7 @@ roborazzi-rules = { module = "io.github.takahirom.roborazzi:roborazzi-junit-rule
 rxjava = "io.reactivex.rxjava3:rxjava:3.1.8"
 
 sqldelight-driver-android = { module = "app.cash.sqldelight:android-driver", version.ref = "sqldelight" }
+sqldelight-driver-jdbc = { module = "app.cash.sqldelight:sqlite-driver", version.ref = "sqldelight" }
 sqldelight-coroutines = { module = "app.cash.sqldelight:coroutines-extensions-jvm", version.ref = "sqldelight" }
 sqldelight-primitiveAdapters = { module = "app.cash.sqldelight:primitive-adapters", version.ref = "sqldelight" }
 
@@ -252,6 +274,8 @@ turbine = { module = "app.cash.turbine:turbine", version.ref = "turbine" }
 # KMP UUID
 uuid = "com.benasher44:uuid:0.8.2"
 
+windowSizeClass = "dev.chrisbanes.material3:material3-window-size-class-multiplatform:0.3.2"
+
 [bundles]
 androidx-activity = ["androidx-activity", "androidx-activity-ktx"]
 compose-ui = ["androidx-compose-foundation", "androidx-compose-material-material", "androidx-compose-material-material3", "androidx-compose-ui-ui", "androidx-compose-ui-tooling-preview"]

samples/README.md

@@ -6,7 +6,7 @@ contexts.
 
 See the README.md files in each sample directory for more information.
 
-- `star` – A non-trivial Android app for Social Tees Animal Rescue (STAR) that demonstrates how to
+- `star` – A non-trivial multiplatform app for Social Tees Animal Rescue (STAR) that demonstrates how to
   use Circuit in a real-world app. Contains lots of cute dogs.
 - `counter` – A multiplatform counter circuit. This circuit is a simple counter that increments or
   decrements a count.

samples/counter/apps/build.gradle.kts

@@ -55,7 +55,6 @@ kotlin {
         implementation(libs.androidx.compose.integration.activity)
         implementation(libs.androidx.compose.integration.materialThemeAdapter)
         implementation(libs.androidx.compose.material.icons)
-        implementation(libs.androidx.compose.material.iconsExtended)
         implementation(libs.androidx.compose.accompanist.systemUi)
       }
     }

samples/counter/src/commonMain/kotlin/com/slack/circuit/sample/counter/Remove.kt

@@ -1,12 +1,25 @@
-// Copyright (C) 2022 Slack Technologies, LLC
-// SPDX-License-Identifier: Apache-2.0
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * 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.slack.circuit.sample.counter
 
 import androidx.compose.material.icons.materialIcon
 import androidx.compose.material.icons.materialPath
 import androidx.compose.ui.graphics.vector.ImageVector
 
-// Copied because it's not available in compose-desktop yet.
+// Copied because it's from the icons-extended dependency, which is huge
 @Suppress("MagicNumber")
 val Remove: ImageVector
   get() {