Migrating to Apollo Kotlin 4

Apollo Kotlin 3 was a major rewrite of Apollo in Kotlin multiplatform.

Apollo Kotlin 4 focuses on tooling, stability and fixing some API regrets that came with 3.

While most of the common APIs stayed the same, Apollo Kotlin 4 contains a few binary breaking changes. To account for that, and in order to be more future proof, we changed the package name to com.apollographql.apollo.

Apollo Kotlin 4 removes some deprecated symbols. We strongly recommend removing deprecated usages before migrating to version 4.

If you are using a library that depends on Apollo Kotlin transitively, you need it to update to version 4 before you can update your own application to version 4.

Automatic migration using the Android Studio plugin

Apollo Kotlin 4 ships with a companion Android Studio plugin that automates most of the migration.

It automates most of the API changes but cannot deal with behavior changes like error handling.

We recommend using the plugin to automate the repetitive tasks but still go through this document for the details.

Error handling

Fetch errors do not throw

In Apollo Kotlin 3, non-GraphQL errors like network errors, cache misses, and parsing errors were surfaced by throwing exceptions in ApolloCall.execute() and in Flows (ApolloCall.toFlow(), ApolloCall.watch()). This was problematic because it was a difference in how to handle GraphQL errors vs other errors. Moreover, throwing terminates a Flow and consumers would have to handle re-collection.

In Apollo Kotlin 4, a new field ApolloResponse.exception has been added and these errors are now surfaced by returning (for execute()) or emitting (for Flows) an ApolloResponse with a non-null exception instead of throwing it.

This allows consumers to handle different kinds of errors at the same place, and it prevents Flows from being terminated.

Queries and mutations:

1
// Replace
2
try {
3
  val response = client.query(MyQuery()).execute()
4
  if (response.hasErrors()) {
5
    // Handle GraphQL errors
6
  } else {
7
    // No errors
8
    val data = response.data
9
    // ...
10
  }
11
} catch (e: ApolloException) {
12
  // Handle network error
13
}
14

15
// With
16
val response = client.query(MyQuery()).execute()
17
if (response.data != null) {
18
  // Handle (potentially partial) data
19
} else {
20
  // Something wrong happened
21
  if (response.exception != null) {
22
    // Handle non-GraphQL errors
23
  } else {
24
    // Handle GraphQL errors in response.errors
25
  }
26
}

Subscriptions:

1
// Replace
2
client.subscription(MySubscription()).toFlow().collect { response ->
3
  if (response.hasErrors()) {
4
    // Handle GraphQL errors
5
  }
6
}.catch { e ->
7
  // Handle network error
8
}
9

10
// With
11
client.subscription(MySubscription()).toFlow().collect { response ->
12
  val data = response.data
13
  if (data != null) {
14
    // Handle (potentially partial) data
15
  } else {
16
    // Something wrong happened
17
    if (response.exception != null) {
18
      // Handle non-GraphQL errors
19
    } else {
20
      // Handle GraphQL errors in response.errors
21
    }
22
  }
23
}

Note that this is true for all Flows, including watchers. If you don't want to receive error responses, filter them out:

1
// Replace
2
apolloClient.query(query).watch()
3

4
// With
5
apolloClient.query(query).watch().filter { it.exception == null }

ApolloCompositeException is not thrown anymore

When using the cache, Apollo Kotlin 3 threw ApolloCompositeException if no response could be found. For an example, a CacheFirst fetch policy would throw ApolloCompositeException(cacheMissException, apolloNetworkException) if both cache and network failed.

In those cases, Apollo Kotlin 4 throws the first exception and adds the second as a suppressed exception:

1
// Replace
2
if (exception is ApolloCompositeException) {
3
  val cacheMissException = exception.first
4
  val networkException = exception.second
5
}
6

7
// With
8
val cacheMissException = exception
9
val networkException = exception.suppressedExceptions.firstOrNull()

emitCacheMisses(Boolean) is removed

In Apollo Kotlin 3, when using the normalized cache, you could set emitCacheMisses to true to emit cache misses instead of throwing.

In Apollo Kotlin 4, this is now the default behavior and emitCacheMisses has been removed.

With the CacheFirst, NetworkFirst and CacheAndNetwork policies, cache misses and network errors are now emitted in ApolloResponse.exception.

Migration helpers

To ease the migration from Apollo Kotlin 3, drop-in helpers functions are provided that restore the version 3 behavior:

• ApolloCall.executeV3()
• ApolloCall.toFlowV3()

Those helper functions:

• throw on fetch errors
• make CacheFirst, NetworkFirst and CacheAndNetwork policies ignore fetch errors.
• throw ApolloComposite exception if needed.

Because of the number of different options in version 3 and the complexity of error handling, these functions may not 100% match the 3 behavior, especially in the advanced cases involving watchers. If you are in one of those cases, we strongly recommend using the 4 functions that are easier to reason about.

Other Apollo Runtime changes

Non standard HTTP headers are not sent by default

X-APOLLO-OPERATION-NAME and X-APOLLO-OPERATION-ID are non-standard headers and are not sent by default anymore. If you used them for logging purposes or if you are using Apollo Server CSRF prevention, you can add them back using an ApolloInterceptor:

1
val apolloClient = ApolloClient.Builder()
2
    .serverUrl(mockServer.url())
3
    .addInterceptor(object : ApolloInterceptor {
4
      override fun <D : Operation.Data> intercept(request: ApolloRequest<D>, chain: ApolloInterceptorChain): Flow<ApolloResponse<D>> {
5
        return chain.proceed(request.newBuilder()
6
            .addHttpHeader("X-APOLLO-OPERATION-NAME", request.operation.name())
7
            .addHttpHeader("X-APOLLO-OPERATION-ID", request.operation.id())
8
            .build()
9
        )
10
      }
11
    })
12
    .build()

ApolloCall.Builder.httpHeaders is additive

In Apollo Kotlin 3, if HTTP headers were set on an ApolloCall, they would replace the ones set on ApolloClient. In Apollo Kotlin 4 they are added instead by default. To replace them, call ApolloCall.Builder.ignoreApolloClientHttpHeaders(true).

1
// Replace
2
val call = client.query(MyQuery())
3
  .httpHeaders(listOf("key", "value"))
4
  .execute()
5

6
// With
7
val call = client.query(MyQuery())
8
  .httpHeaders(listOf("key", "value"))
9
  .ignoreApolloClientHttpHeaders(true)
10
  .execute()

HttpEngine now implements Closeable

HttpEngine now implements Closeable and has its dispose method renamed to close. If you have a custom HttpEngine, you need to implement close instead of dispose.

Maven artifacts reorganization

Over the years, a lot of support functionality was added alongside apollo-api and apollo-runtime. While useful, most of this functionality doesn't share the same level of stability and maturity as the main artifacts and bundling them did not make much sense.

Moving forward, some artifacts are released separately and have new Maven coordinates, GitHub repositories and package names. Others are deprecated.

For the initial version 4 release, most artifacts are kept with deprecation warnings and will be removed in the future.

The artifacts are:

• apollo-mockserver
  • MockServer was born out of our own internal needs for a KMP-ready mockserver. Most of its public API is subject to change, and it has been moved to a separate repository.
• apollo-cli-incubating
  • The Apollo CLI contract is subject to change and it has been moved to a separate repository.
• apollo-rx-support
  • The RxJava{2-3} artifacts are very thin wrappers around kotlinx-coroutines-rx{2-3} and we recommend using those instead.
• apollo-idling-resource
  • ApolloIdlingResource is deprecated. We recommend using reactive patterns to test your UI instead. See this article about ways to do so for more details.

Summary

Gradle Plugin

Multi-module dependsOn

In Apollo Kotlin 3, you could depend on an upstream GraphQL module by using the apolloMetadata configuration.

In Apollo Kotlin 4, this is now done with the Service.dependsOn(). This allows better management of dependencies when multiple services are used as better symmetry with isADependencyOf below.

1
// feature1/build.gradle.kts
2

3
// Replace
4
dependencies {
5
  // ...
6

7
  // Get the generated schema types (and fragments) from the upstream schema module 
8
  apolloMetadata(project(":schema"))
9

10
  // You also need to declare the schema module as a regular dependency
11
  implementation(project(":schema"))
12
}
13

14
// With
15
dependencies {
16
  // ...
17
  
18
  // You still need to declare the schema module as a regular dependency
19
  implementation(project(":schema"))
20
}
21

22
apollo {
23
  service("service") {
24
    // ...
25

26
    // Get the generated schema types (and fragments) from the upstream schema module 
27
    dependsOn(project(":schema"))
28
  }
29
}

Auto-detection of used types

In multi-module projects, by default, all the types of an upstream module are generated because there is no way to know in advance what types are going to be used by downstream modules. For large projects this can lead to a lot of unused code and an increased build time.

To avoid this, in Apollo Kotlin 3 you could manually specify which types to generate by using alwaysGenerateTypesMatching. In Apollo Kotlin 4 this can now be computed automatically by detecting which types are used by the downstream modules.

To enable this, add the "opposite" link of dependencies with isADependencyOf().

1
// schema/build.gradle.kts
2

3
// Replace
4
apollo {
5
  service("service") {
6
    // ...
7
    
8
    // Generate all the types in the schema module
9
    alwaysGenerateTypesMatching.set(listOf(".*"))
10

11
    // Enable generation of metadata for use by downstream modules 
12
    generateApolloMetadata.set(true)
13
  }
14
}
15

16
// With
17
apollo {
18
  service("service") {
19
    // ...
20

21
    // Enable generation of metadata for use by downstream modules 
22
    generateApolloMetadata.set(true)
23

24
    // Get used types from the downstream module1
25
    isADependencyOf(project(":feature1"))
26

27
    // Get used types from the downstream module2
28
    isADependencyOf(project(":feature2"))
29
    
30
    // ...
31
  }
32
}

If you were using apolloUsedCoordinates, you can also remove it:

1
dependencies {
2
  // Remove this 
3
  apolloUsedCoordinates(project(":feature1"))
4
}

Custom scalars declaration

customScalarsMapping is removed and replaced with mapScalar() which makes it easier to map to built-in types and/or provide a compile type adapter for a given type:

1
// Replace
2
customScalarsMapping.set(mapOf(
3
    "Date" to "kotlinx.datetime.LocalDate"
4
))
5

6
// With
7
mapScalar("Date", "kotlinx.datetime.LocalDate")
8

9
// Replace
10
customScalarsMapping.put("MyLong", "kotlin.Long")
11

12
// With
13
mapScalarToKotlinLong("MyLong")

schemaFile is deprecated

Because there might be several schema files, schemaFile is deprecated. Instead use schemaFiles:

1
// replace
2
    schemaFile.set("src/main/graphql/com/example/schema.graphqls")
3

4
    // with
5
    schemaFiles.from("src/main/graphql/com/example/schema.graphqls")

If you are using packageNamesFromFilePaths and schemaFile, you'll need to use a Gradle FileTree to carry the appropriate normalized path.

1
packageNameFromFilePaths()
2

3
    // replace
4
    schemaFile.set("src/main/graphql/com/example/schema.graphqls")
5

6
    // with
7
    schemaFiles.from(fileTree("src/main/graphql/").apply {
8
      include("com/example/schema.graphqls")
9
    })

Migrating to ApolloCompilerPlugin

Apollo Kotlin 4 introduces ApolloCompilerPlugin as a way to customize code generation. ApolloCompilerPlugin are loaded using the ServiceLoader API and run in a separate classloader from your Gradle build. As a result, using Service.operationIdGenerator/Service.operationOutputGenerator together with ApolloCompilerPlugin is not possible.

Service.operationIdGenerator/Service.operationOutputGenerator are deprecated and will be removed in a future release. You can migrate to ApolloCompilerPlugin using the instructions from the dedicated page and the ApolloCompilerPlugin.operationIds() method:

1
// Replace (in your build scripts) 
2
val operationOutputGenerator = object: OperationOutputGenerator {
3
  override fun generate(operationDescriptorList: Collection<OperationDescriptor>): OperationOutput {
4
    return operationDescriptorList.associateBy {
5
      it.source.sha1()
6
    }
7
  }
8
  override val version: String = "v1"
9
}
10

11
// Or, if using OperationIdGenerator, replace
12
val operationIdGenerator = object: OperationIdGenerator {
13
  override fun apply(operationDocument: String, operationName: String): String {
14
    return operationDocument.sha1()
15
  }
16

17
  override val version: String = "v1"
18
}
19

20
// With (in your build compiler plugin module) 
21
class MyPlugin: ApolloCompilerPlugin {
22
  override fun operationIds(descriptors: List<OperationDescriptor>): List<OperationId>? {
23
    return descriptors.map {
24
      OperationId(it.source.sha1(), it.name)
25
    }
26
  }
27
}

Publishing is no longer configured automatically

In Apollo Kotlin 3, maven publishing was automatically configured. In Apollo Kotlin 4, this is no longer the case, and you need to configure the publishing tasks yourself.

Operation manifest file location

Since Apollo Kotlin now supports different operation manifest formats, the operationOutput.json file will be generated in "build/generated/manifest/apollo/$service/operationOutput.json" instead of "build/generated/operationOutput/apollo/$service/operationOutput.json".

useSchemaPackageNameForFragments is removed

This was provided for compatibility with 2.x and is now removed. If you need specific package names for fragments, you can use a compiler plugin and ApolloCompilerPlugin.layout() instead.

Apollo Compiler

"compat" codegenModels is removed

The "compat" codegen models was provided for compatibility with 2.x and is now removed. "operationBased" is more consistent and generates less code:

1
// Replace
2
apollo {
3
  service("service") {
4
    codegenModels.set("compat")
5
  }
6
}
7

8
// With
9
apollo {
10
  service("service") {
11
    codegenModels.set("codegenModels")
12
  }
13
}

In the generated models, inline fragments accessors are prefixed with on:

1
// Replace
2
data.hero.asDroid
3

4
// With
5
data.hero.onDroid

The fragments synthetic property is not needed anymore:

1
// Replace
2
data.hero.fragments.heroDetails
3

4
// With
5
data.hero.heroDetails

Finally some fields that were merged from inline fragments in their parents must now be accessed through the inline fragment:

1
// Replace
2
/**
3
 * {
4
 *   hero {
5
 *     # this condition is always true
6
 *     # allowing to merge the name field
7
 *     ... on Character {
8
 *       name
9
 *     }
10
 *   }
11
 * }
12
 */
13
data.hero.name
14

15
// With 
16
/**
17
 * name is not marged anymore
18
 */
19
data.hero.onCharacter?.name

Test builders are removed

Test builders were an experimental feature that have been superseded by data builders, a simpler version that also plays nicer with custom scalars.

In Apollo Kotlin 4, test builders are no longer available - please refer to the data builders documentation for more information.

Enum class names now have their first letter capitalized

For consistency with other types, GraphQL enums are now capitalized in Kotlin. You can restore the previous behavior using @targetName:

1
# Make sure `someEnum` isn't renamed to `SomeEnum`
2
enum someEnum @targetName(name: "someEnum"){
3
  A
4
  B
5
}

__Schema is in the schema subpackage

When using the generateSchema option, to avoid a name clash with the introspection type of the same name, the __Schema type is now generated in a schema subpackage (instead of type):

1
// Replace
2
import com.example.type.__Schema
3

4
// With
5
import data.builders.schema.__Schema

KotlinLabs directives are now at version 0.3

The embedded kotlin_labs directives are now at version 0.3.

These are the client directives supported by Apollo Kotlin. They are imported automatically but if you relied on an explicit import for renames or another reason, you'll need to bump the version:

1
# Replace
2
extend schema @link(url: "https://specs.apollo.dev/kotlin_labs/v0.1/", import: ["@typePolicy"])
3

4
# With
5
extend schema @link(url: "https://specs.apollo.dev/kotlin_labs/v0.3/", import: ["@typePolicy"])

This is a backward compatible change.

Directive usages are validated and require a matching directive definition

In Apollo Kotlin 4, all directive usages are validated against their definition. If you have queries using client side directives:

1
query HeroName {
2
  hero {
3
    # WARNING: '@required' is not defined by the schema
4
    name @required
5
  }
6
}

Those queries now required to have a matching directive definition in the schema. If the directive is a server directive, and you downloaded your schema using introspection, the directive definition should be present.

In some cases, for client directives and/or if you did not use introspection, the directive definition might be missing. For those cases, you can add it explicitely in a extra.graphqls file:

1
directive @required on FIELD

Sealed class UNKNOWN__ constructors are private

When generating enums as sealed classes with the sealedClassesForEnumsMatching option, the UNKNOWN__ constructor is now generated as private, to prevent its accidental usage.

It is recommended to update your schema instead of instantiating an UNKNOWN__ value, but if you need to, use the safeValueOf method instead:

1
// Replace
2
val myEnum = MyEnum.UNKNOWN__("foo")
3

4
// With
5
val myEnum = MyEnum.safeValueOf("foo")

Cache

Configuration order

The normalized cache must be configured before the auto persisted queries, configuring it after will now fail (see https://github.com/apollographql/apollo-kotlin/pull/4709).

1
// Replace
2
val apolloClient = ApolloClient.Builder()
3
  .serverUrl(...)
4
  .autoPersistedQueries(...)
5
  .normalizedCache(...)
6
  .build()
7

8
// With
9
val apolloClient = ApolloClient.Builder()
10
  .serverUrl(...)
11
  .normalizedCache(...)
12
  .autoPersistedQueries(...)
13
  .build()

apollo-ast

The AST classes (GQLNode and subclasses) as well as Introspection classes are not data classes anymore (see https://github.com/apollographql/apollo-kotlin/pull/4704/). The class hierarchy has been tweaked so that GQLNamed, GQLDescribed and GQLHasDirectives are more consistently inherited from.

GQLSelectionSet and GQLArguments are deprecated and removed from GQLField and GQLInlineFragment. Use .selections directly

GQLInlineFragment.typeCondition is now nullable to account for inline fragments who inherit their type condition.

SourceLocation.position is renamed to SourceLocation.column and is now 1-indexed. GQLNode.sourceLocation is now nullable to account for the cases where the nodes are constructed programmatically.

It is not possible to create a Schema from a File or String directly anymore. Instead, create a GQLDocument first and convert it to a schema with toSchema().

Using RxJava artifacts is now an error

The apollo-rx2-support and apollo-rx3-support artifacts are very thin wrappers around kotlinx-coroutines-rx2 or kotlinx-coroutines-rx3 and will be removed in a future version.

In Apollo Kotlin 4, use kotlinx-coroutines-rx${version} instead. Replace the artifact in your build script:

1
dependencies {
2
  // Replace
3
  implementation("com.apollographql.apollo3:apollo-rx2-support:$version")
4
  
5
  // With
6
  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-rx2:$version")
7
}

In your code, use asFLowable():

1
// Replace
2
apolloClient.query().rxFlowable()
3

4
// With
5
apolloClient.query().toFlow().asFlowable()
6

7
// Replace
8
apolloClient.query().rxSingle()
9

10
// With
11
apolloClient.query().toFlow().asFlowable().firstOrError()

Example of a migration

If you are looking for inspiration, we updated the version 3 integration tests to use version 4. If you have an open source project that migrated, feel free to share it and we'll include it here.