v3.7.0

This version adds multiple new low level features. These new features expose a lot of API surface, and they will probably stay experimental until 4.0. Feedback is always very welcome.

✨️ [new & experimental] compiler hooks API (#4474, #4026)

Compiler hooks allow you to tweak the generated models by exposing the underlying JavaPoet/KotlinPoet structures. You can use it for an example to:

• Add a 'null' default value to model arguments (source)
• Introduce a common interface for all models that implement __typename (source)
• Add a prefix to generated models (source)
• Any other thing you can think of

To do so, make sure to use the "external" version of the plugin:

plugins {
  // Note: using the external plugin here to be able to reference KotlinPoet classes
  id("com.apollographql.apollo3.external")
}

And then register your hook to the plugin:

apollo {
  service("defaultnullvalues") {
    packageName.set("hooks.defaultnullvalues")
    compilerKotlinHooks.set(listOf(DefaultNullValuesHooks()))
  }
}

✨️ [new & experimental] operationBasedWithInterfaces codegen (#4370)

By default, Apollo Kotlin models fragments with synthetic nullable fields. If you have a lot of fragments, checking these fields requires using if statements. For an example, with a query like so:

{
  animal {
    species
    ... on WarmBlooded {
      temperature
    }
    ... on Pet {
      name
    }
    ... on Cat {
      mustaches
    }
  }
}

you can access data like so:

if (animal.onWarmBlooded != null) {
  // Cannot smart cast because of https://youtrack.jetbrains.com/issue/KT-8819/
  println(animal.onWarmBlooded!!.temperature)
}
if (animal.onPet != null) {
  println(animal.onPet!!.name) 
}
if (animal.onCat != null) {
  println(animal.onCat!!.mustaches)
}

Some of the combinations could be impossible. Maybe all the pets in your schema are warm blooded. Or maybe only cat is a warm blooded. To model this better and work around KT-8819, @chalermpong implemented a new codegen that adds a base sealed interface. Different implementations contain the same synthetic fragment fields as in the default codegen except that their nullability will be updated depending the branch:

when (animal) {
  is WarmBloodedPetAnimal -> {
    println(animal.onWarmBlooded!!.temperature)
    println(animal.onPet!!.name)
  }
  is PetAnimal -> {
    // Some pet that is not warm blooded, e.g. a Turtle maybe?
    println(animal.onPet!!.name)
  }
  is OtherAnimal -> {
    println(animal.species)
  }
  // Note how there is no branch for Cat because it's a WarmBloodedPetAnimal
  // Also no branch for WarmBlooded animal because all pets in this (fictional) sample schema are WarmBlooded. This could be different in another schema
}

To try it out, add this to your Gradle scripts:

apollo {
  codegenModels.set("experimental_operationBasedWithInterfaces") 
}

Many many thanks to @chalermpong for diving into this 💙

✨️ [new & experimental] usedCoordinates auto detection (#4494)

By default, Apollo Kotlin only generates the types that are used in your queries. This is important because some schemas are really big and generating all the types would waste a lot of CPU cycles. In multi-modules scenarios, the codegen only knows about types that are used locally in that module. If two sibling modules use the same type and that type is not used upstream, that could lead to errors like this:

duplicate Type '$Foo' generated in modules: feature1, feature2
Use 'alwaysGenerateTypesMatching' in a parent module to generate the type only once

This version introduces new options to detect the used types automatically. It does so by doing a first pass at the GraphQL queries to determine the used type. Upstream modules can use the results of that computation without creating a circular dependency. To set up auto detection of used coordinates, configure your schema module to get the used coordinates from the feature module using the apolloUsedCoordinates configuration:

// schema/build.gradle.kts
dependencies {
  implementation("com.apollographql.apollo3:apollo-runtime")
  // Get the used coordinates from your feature module
  apolloUsedCoordinates(project(":feature"))
  // If you have several, add several dependencies
  apolloUsedCoordinates(project(":feature-2"))
}
apollo {
  service("my-api") {
    packageName.set("com.example.schema")
    generateApolloMetadata.set(true)
  }
}

And in each of your feature module, configure the apolloSchema dependency:

// feature/build.gradle.kts
dependencies {
  implementation("com.apollographql.apollo3:apollo-runtime")
  // Depend on the codegen from the schema
  apolloMetadata(project(":schema"))
  // But also from the schema so as not to create a circular dependency
  apolloSchema(project(":schema"))
}
apollo {
  // The service names must match
  service("my-api") {
    packageName.set("com.example.feature")
  }
}

👷‍ All changes

• Add usedCoordinates configuration and use it to automatically compute the used coordinates (#4494)
• Compiler hooks (#4474)
• 🐘 Use registerJavaGeneratingTask, fixes lint trying to scan generated sources (#4486)
• Rename generateModelBuilder to generateModelBuilders and add test (#4476)
• Data builders: only generate used fields (#4472)
• Only generate used types when generateSchema is true (#4471)
• Suppress deprecation warnings, and opt-in in generated code (#4470)
• Multi-module: fail if inconsistent generateDataBuilders parameters (#4462)
• Add a decapitalizeFields option (#4454)
• Pass protocols to WebSocket constructor in JSWebSocketEngine (#4445)
• SQLNormalized cache: implement selectAll, fixes calling dump() (#4437)
• Java codegen: Nullability annotations on generics (#4419)
• Java codegen: nullability annotations (#4415)
• OperationBasedWithInterfaces (#4370)
• Connect test sourceSet only when testBuilders are enabled (#4412)
• Java codegen: add support for Optional or nullable fields (#4411)
• Add generatePrimitiveTypes option to Java codegen (#4407)
• Add classesForEnumsMatching codegen option to generate enums as Java enums (#4404)
• Fix data builders + multi module (#4402)
• Relocate the plugin without obfuscating it (#4376)

v3.6.2

A patch version to fix compatibility with Kotlin 1.7.20 and another fix when calling ApolloStore.dump() with the SQL normalized cache.

👷‍ All changes

• Add support for Kotlin Gradle Plugin 1.7.20 (#4439)
• Fix SQLNormalizedCache.dump() (#4437)

v3.6.1

A patch version to fix an issue with data builder and multi modules. Many thanks to @agrosner and @eduardb for catching this.

👷‍ All changes

• Fix data builders in multi-modules scenarios (#4402)

v3.6.0

This version brings initial support for @defer as well as data builders.

💙️ External contributors

Many thanks to @engdorm, @Goooler, @pt2121 and @StylianosGakis for their contributions!

✨️ [new] @defer support

@defer support is experimental in the Kotlin Client and currently a Stage 2 GraphQL specification draft to allow incremental delivery of response payloads.

@defer allows you to specify a fragment as deferrable, meaning it can be omitted in the initial response and delivered as a subsequent payload. This improves latency for all fields that are not in that fragment. You can read more about @defer in the RFC and contribute/ask question in the @defer working group.

Apollo Kotlin supports @defer by default and will deliver the successive payloads as Flow items. Given the below query:

query GetComputer {
  computer {
    __typename
    id
    ...ComputerFields @defer
  }
}

fragment ComputerFields on Computer {
  cpu
  year
  screen {
    resolution
  }
}

And the following server payloads:

payload 1:

{
  "data": {
    "computer": {
      "__typename": "Computer",
      "id": "Computer1"
    }
  },
  "hasNext": true
}

payload 2:

{
  "incremental": [
    {
      "data": {
        "cpu": "386",
        "year": 1993,
        "screen": {
          "resolution": "640x480"
        }
      },
      "path": [
        "computer",
      ]
    }
  ],
  "hasNext": true
}

You can listen to payloads by using toFlow():

apolloClient.query(query).toFlow().collectIndexed { index, response ->
  // This will be called twice

  if (index == 0) {
    // First time without the fragment
    assertNull(response.data?.computer?.computerFields)
  } else if (index == 1) {
    // Second time with the fragment
    assertNotNull(response.data?.computer?.computerFields)
  }
}

You can read more about it in the documentation.

As always, feedback is very welcome. Let us know what you think of the feature by
either opening an issue on our GitHub repo
, joining the community
or stopping by our channel in the KotlinLang Slack(get your
invite here).

✨️ [new] Data Builders (#4321)

Apollo Kotlin 3.0 introduced test builders. While they are working, they have several limitations. The main one was that being response based, they could generate a lot of code. Also, they required passing custom scalars using their Json encoding, which is cumbersome.

The data builders are a simpler version of the test builders that generate builders based on schema types. This means most of the generated code is shared between all your implementations except for a top level Data {} function in each of your operation:

// Replace
val data = GetHeroQuery.Data {
  hero = humanHero {
    name = "Luke"
  }
} 

// With
val data = GetHeroQuery.Data {
  hero = buildHuman {
    name = "Luke"
  }
} 

✨️ [new] Kotlin 1.7 (#4314)

Starting with this release, Apollo Kotlin is built with Kotlin 1.7.10. This doesn't impact Android and JVM projects (the minimum supported version of Kotlin continues to be 1.5) but if you are on a project using Native, you will need to update the Kotlin version to 1.7.0+.

👷‍ All changes

• fix registering Java scalars. Many thanks @parker for catching this. (#4375)
• Data builders (#4359, #4338, #4331, #4330, #4328, #4323, #4321)
• Add a flag to disable fieldsCanMerge validation on disjoint types (#4342)
• Re-introduce @defer and use new payload format (#4351)
• Multiplatform: add enableCompatibilityMetadataVariant flag (#4329)
• Remove an unnecessary file.source().buffer() (#4326)
• Always use String for defaultValue in introspection Json (#4315)
• Update Kotlin dependency to 1.7.10 (#4314)
• Remove schema and AST from the IR (#4303)

v2.5.13

A 2.x maintainance release with a couple of bugfixes. Many thanks to @eduardb for diving into #2818 💙

What's Changed

• Fix converting introspection to SDL by @martinbonnin in #4316
• Fix writing fragments overwrites cache entries (#2818) by @eduardb in #4358

Full Changelog: v2.5.12...v2.5.13

v3.5.0

With this release, Apollo Kotlin now uses Kotlin Native's new memory model. It also contains a number of other improvements and bug fixes.

💙️ External contributors

Many thanks to @glureau for carefully adding new watch targets ⌚💙

✨️ [new] Kotlin Native: new memory manager (#4287)

Apollo Kotlin is now requiring applications to use the new memory manager, a.k.a. new memory model. Thanks to this change, the restriction that operations had to be executed from the main thread on Apple targets is now removed. You can also use kotlinx.coroutines.test.runTest. Last but not least, benchmarks seem to indicate that performance is better under the new memory manager!

✨️ [new] @targetName directive (#4243)

This directive was introduced in v3.3.1 to allow overriding the name of enum values in the generated code. It has now been extended to allow configuring the generated name of Interfaces, Enums, Unions, Scalars and Input objects. This can be used to make the generated code nicer to use, or to avoid name clashes with Kotlin types (e.g. Long) in Kotlin Native.

✨️ [new] Automatic resolution of Apollo artifacts versions from the plugin version (#4279)

From now on, you no longer need to specify explicitly the versions of Apollo dependencies: if omitted, the same version as the Apollo Gradle plugin will be used. This should facilitate upgrades and avoid potential mistakes:

plugins {
  plugins {
    id("org.jetbrains.kotlin.jvm").version("1.7.10")
    id("com.apollographql.apollo3").version("3.5.0")
  }

  dependencies {
    // Replace this
    // implementation("com.apollographql.apollo3:apollo-runtime:3.5.0")
    
    // with
    implementation("com.apollographql.apollo3:apollo-runtime")
  }
}

🚧 [deprecated] runTest (#4292)

With the new memory model, Apollo's specific runTest method from apollo-testing-support is no longer useful and has been deprecated. If you were using it, you should now be able to use Kotlin's runTest instead, or simply runBlocking.

🚧 [breaking] Automatic detection of type enum values.

If you have an enum with a type value, this value used to name clash with the generated type property. This version now detects this case automatically and escapes type to type_. If you had previously used @targetName to workaround this issue, you can now remove it to avoid it being escaped twice:

# Remove this
extend enum SomeEnum {
  type @targetName(name: "type_")
}

👷‍ All changes

• Support watchosArm32 (#4260)
• Support @TargetNAME on Interfaces, Enums, Unions, Scalars and Input objects (#4243)
• 🐘 support lazy APIs for newer AGP versions (#4264)
• Pagination: add connectionFields argument to @typePolicy (#4265)
• 🐘 Get the dependencies version from the plugin automagically (#4279)
• Automatically escape type in enum values (#4295)
• Fix inferred variables in both nullable and non-nullable locations (#4306)
• Native: assume New Memory Manager (#4287)
• Use internal runTest in all tests (#4292)

v3.4.0

Version 3.4.0

2022-07-11

This release contains a few important bug fixes (#4214, #4224, #4247, #4256) and makes it possible to compile with Gradle 7.4 and apollo-gradle-plugin (#4218).

It also introduces incubating cache artifacts.

💙️ External contributors

Many thanks to @ArjanSM, @zebehringer, @mm-kk-experiments, @mune0903, @stengvac, @elenigen, @shamsidinb and @StylianosGakis for the awesome contributions 😃!

✨️ [new] incubating cache artifacts.

This version introduces the below artifacts:

• apollo-normalized-cache-incubating
• apollo-normalized-cache-api-incubating
• apollo-normalized-cache-sqlite-incubating

These artifacts introduce new APIs to work with cache expiration and pagination (as well as other cache improvements in the future).

These artifacts have no backward compatibility guarantees and most likely have worse performance than the non-incubating artifacts. Documentation will be added once the API stabilize. In the short term, the best place to look for examples are the integration tests:

• Expiration tests
• Pagination tests

Note: The experimental withDates: Boolean argument was introduced in 3.3.1 in the regular artifacts and is removed as part of this release. Use the incubating artifacts to use it.

👷‍ All changes

• add TrimmableNormalizedCacheFactory (#4239)
• 🚧 remove withDates (#4257)
• 🗄️ Chunk parameters in large responses (#4256)
• Fix for improper handling of JsonNumber in BufferedSinkJsonWriter (#4247)
• Incubating modules for the next gen cache (#4241)
• Pagination: fixes in FieldRecordMerger and MemoryCache (#4237)
• make it possible to reuse a File Upload (#4228)
• Persist Record arguments/metadata with the SQL Json backend (#4211)
• requestedDispatcher -> dispatcher (#4220)
• Fix test errors were emitted outside the Flow (#4224)
• Make it possible to compile with Kotlin 1.5 and apollo-gradle-plugin (#4218)
• 🏖️ Relax MapJsonReader endObject, fixes reading inline + named fragments with compat models (#4214)
• Introduce RecordMerger (#4197)
• Add @typePolicy(embeddedFields: String! = "") (#4196)

v3.3.2

This is a hot fix release that fixes a crash that could happen in the codegen when using responseBased codegen in a
multimodule setup. It also includes a fix for incorrect generated code when using certain reserved names in enum values.

👷‍ All changes

• Update to KotlinPoet 1.12.0, fixes generating enum values whose name clashes with other symbols (#4034)
• Update to Ktor 2 (#4190)
• Fix NPE in checkCapitalizedFields (#4201)

v2.5.12

Version 2.5.12 is a maintenance release with a fix to restore downloading schemas as SDL, and a fix for Kotlin 1.7 compatibility.

💜 Many thanks to @eg-ndobrijevic and @remcomokveld for raising these issues! 💜

👷 All Changes

• [2.x] restore SDL download (#4046)
• Fix Kotlin 1.7 compatibility (#4187)

v3.3.1

This release introduces @typePolicy on interface/enums, improvements on subscription error handling, and on Test Builders. It also contains a number of other improvements and bug fixes!

✨️ [new] @typePolicy on interfaces and unions (#4131)

The @typePolicy directive can now be declared on interfaces and unions. Thank you @bubba for the contribution!

🔌 WebSockets / Subscriptions error handling (#4147)

An issue where websocketReopenWhen was not called in some cases was fixed. Also, this release introduces SubscriptionOperationException. A SubscriptionOperationException will be thrown instead of the more generic ApolloNetworkError if a subscription fails due to a specific operation error.

📐 Test Builders improvements and fixes

• A DslMarker was added to improve usage with nested builders (#4089)
• When calling a builder, but not assigning it to a field, an error is now thrown, preventing mistakes (#4122)
• The error message displayed when __typename is missing was made clearer (#4146)
• Fix: use rawValue instead of name for enums (#4121)

✨️ [new] ApolloClient implements Closable (#4142)

ApolloClient now implements okio.Closable so you can use use with it. Thanks @yogurtearl for this contribution!

✨️ [new] experimental @targetName directive on enum values (#4144)

If an enum value name is clashing with a reserved name (e.g. type) you can now use this directive to instruct the codeGen to use the specified name for the value instead. This directive is experimental for now.

✨️ [new] experimental support for renaming directives (#4174)

As we add more client directives, the risk of nameclash with existing schema directives increases. If this happens, you can now import Apollo client directives using @link:

# extra.graphqls
extend schema @link(url: "https://specs.apollo.dev/kotlin_labs/v0.1") 

This adds a @kotlin_labs__ prefix to all Apollo client directives:

{
  hero {
    name @kotlin_labs__nonnull
  }
}

🤖 SqlNormalizedCacheFactory initialization on Android (#4104)

It is no longer necessary to pass a Context when initializing the SqlNormalizedCacheFactory on Android. A Context is automatically provided, via App Startup.

// Before
val sqlNormalizedCacheFactory = SqlNormalizedCacheFactory(context, "apollo.db")
// After
val sqlNormalizedCacheFactory = SqlNormalizedCacheFactory("apollo.db")

📝 [new] Public API tracking

This release starts tracking the public API of all modules, including MockServer. Even if the API remains experimental, we'll try to keep the number of breaking changes low in the future.

👷‍ All changes

• 🐘 publish apollo-gradle-plugin-external (#4078)
• publish the R8 mapping file along the relocated jar (#4085)
• Fix test directories not cleared (#4083)
• Do not use 'header' as a enum value name as it breaks the Kotlin compiler (#4086)
• 🧪 @experimental support (#4091)
• @experimental -> @requiresOptIn (#4175)
• Do not buffer entire body in Http Cache (#4076)
• ⬇️ add SchemaDownloader.download() (#4088)
• add DslMarker for test builders (#4089)
• MockServer: make MockResponse.body a Flow (#4096)
• Issue-3909: add ApolloResponse cache headers (#4102)
• Use rawValue instead of name for enums in test builders (#4121)
• 💧 first drop for a SQLite backend that stores when each field was last updated (#4104)
• Add Operation.Data.toJsonString() convenience function for the jvm (#4124)
• Check for unassigned fields in Test Builders (#4122)
• Add non-breaking spaces after 'return' (#4127)
• 🧶 Use a getter instead of a const val OPERATION_QUERY (#4130)
• Uploads should be read only once even when logging (#4125)
• Keep the 'interfaces' field on the JSON introspection (#4129)
• Allow @typePolicy directive on interfaces and unions (#4131)
• typePolicy on interface: exclude empty keyfields (#4140)
• Sort the type names in the list so the code gen is deterministic. (#4138)
• Use okio.Closable.close instead of dispose on ApolloClient (#4142)
• Parse the interface's interface field in introspection (#4143)
• TestBuilders: improve error message when __typename is missing (#4146)
• Do not bypass websocketReopenWhen {} (#4147)
• SDLWriter: join implemented interfaces with & instead of space (#4151)
• Escape "type" in enums and sealed classes (#4144)
• 🧰 introduce apollo-tooling and apollo-cli (#4153)
• Fix incorrect content-length in MockServer (#4162)
• Allow capitalized field names if flattenModels is true (#4154)
• 🏷️ Allow namespacing and renaming of directives (#4174)

❤️ External contributors

Many thanks to @tajchert, @asimonigh, @hrach, @ArjanSM, @yshrsmz, @ephemient, @bubba, @eboudrant and @yogurtearl for contributing to this release! 🙏