apollo-android/CHANGELOG and apollo-android Releases

All Versions

Latest Version

3.7.1

Avg Release Cycle

13 days

Latest Release

Changelog History

Page 1

v3.7.1 Changes
2022-11-18

🚀 A patch release with a few fixes.

👷‍ All changes
- 🏗 👷Data Builders: make DefaultFakeResolver open and stateless (#4468)
- Kotlin 1.7.21 (#4511)
- Introduce HttpFetchPolicyContext (#4509)
- 🛠 Fix usedCoordinates on interfaces (#4506)
Many thanks to @Holoceo, @juliagarrigos, @davidshepherd7 and @eduardb for the feedbacks 💙
v3.7.0 Changes
2022-11-08

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)

0️⃣ 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)

0️⃣ 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 Changes
2022-10-05

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 KGP 1.7.20 (#4439)
- 🛠 Fix SQLNormalizedCache.dump() (#4437)
v3.6.1 Changes
2022-10-03

🏗 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 Changes
2022-09-08

🏗 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] 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 or JS, you will need to update the Kotlin version to 1.7.0+.

👍 ✨️ [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"
  }
} 
```
👷‍ 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)
- 0️⃣ 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)
v3.5.0 Changes
2022-08-01

🚀 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:
v3.4.0 Changes
2022-07-11

🚀 This release contains a few important bug fixes (#4214, #4224, #4247, #4256), 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, @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 Changes
2022-06-17

🚀 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)
v3.3.1 Changes
2022-06-13

🚀 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:
v3.3.0 Changes
2022-05-04

🚀 This is the first release with HMPP support. If you're using ⚡️ multiplatform, updating to Kotlin 1.6.21 is strongly encouraged.

🚀 This release also brings WebSocket related improvements and other fixes!

✨️ [new] Hierarchical MultiPlatform Project (HMPP) (#4033)

🚀 When using Apollo Kotlin on a multiplatform project, this release is compatible with 📄 the hierarchical project structure, which makes it easier to 🛠 share common code among several targets. Using HMPP in your project also fixes some issues when compiling Kotlin 📇 metadata. See https://github.com/apollographql/apollo-kotlin/issues/4019 and https://youtrack.jetbrains.com/issue/KT-51970/ for more details.

✋ Note: If you're using multiplatform, we strongly encourage updating to Kotlin 1.6.21. If that is not an option, you might have issues resolving dependencies. More infos in this issue.

✨️ [new] WebSocketNetworkTransport.closeConnection (#4049)

This new method can be used in conjunction 🏗 with reopenWhen to force a reconnection to the server. This could be useful for instance when needing to pass new auth tokens in the headers. If you were using subscriptionManager.reconnect() in 2.x, closeConnection is a simple way to achieve the same behaviour.

🛰 ✨️ [new] GraphQLWsProtocol.connectionPayload is now a lambda (#4043)

🛰 With GraphQLWsProtocol, if you need to pass parameters to the connection payload, previously you would pass them as a 🏗 static map to the builder. With this change you can now pass a lambda providing them as needed. This facilitates passing fresh auth tokens when connecting.

✨️ [new] Add insecure option to download schema (#4021)

You can now use the --insecure flag when downloading a schema 🔧 with downloadApolloSchema 🔧 , to bypass the certificate check, which can be useful if a server is configured with a self-signed certificate for instance.

👷‍ All changes
- ➕ Add WebSocketNetworkTransport.closeConnection (#4049)
- 🛰 Made connectionPayload as suspend function in GraphQLWsProtocol (#4043)
- ⚡ Ignore unknown websocket messages (#4066)
- Kotlin 1.6.21 & HMPP (#4033)
- Provide a Content-Length when using Upload (#4056)
- ☁️ add HttpRequest.newBuilder(url, method) (#4038)
- Escape enum constants (#4035)
- 🛠 Fix the Moshi adapter used for OperationOutput. Moshi cannot get the type parameters from the typealias automagically (#4022)
- ➕ Add insecure option to download schema (#4021)
- Try to reduce allocations in MapJsonReader (#3935)
- ✅ 🔒 Deprecate BearerTokenInterceptor and provide tests and docs instead (#4068)
❤️ External contributors

🚀 Many thanks to @CureleaAndrei and @kdk96 for contributing to this release! 🙏

🗄 ⚙️ Deprecations
- BearerTokenInterceptor was provided as an example but is too simple for most use cases, and has therefore been deprecated in this release. This page provides more details about authentication.
- 👀 The previous ways of passing parameters to the connection payload with GraphQLWsProtocol has been deprecated (see above).

apollo-android changelog

:robot: A strongly-typed, caching GraphQL client for the JVM, Android, and Kotlin multiplatform.

Changelog History Page 1

👷‍ All changes

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

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

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

👷‍ All changes

👷‍ All changes

👷‍ All changes

💙️ External contributors

✨️ [new] Kotlin 1.7 (#4314)

👍 ✨️ [new] @defer support

🏗 ✨️ [new] Data Builders (#4321)

👷‍ All changes

💙️ External contributors

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

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

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

✅ 🚧 [deprecated] runTest (#4292)

🚧 [breaking] Automatic detection of type enum values.

💙️ External contributors

✨️ [new] -incubating cache artifacts.

👷‍ All changes

👷‍ All changes

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

🔌 WebSockets / Subscriptions error handling (#4147)

🏗 📐 Test Builders improvements and fixes

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

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

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

✨️ [new] Hierarchical MultiPlatform Project (HMPP) (#4033)

✨️ [new] WebSocketNetworkTransport.closeConnection (#4049)

🛰 ✨️ [new] GraphQLWsProtocol.connectionPayload is now a lambda (#4043)

✨️ [new] Add insecure option to download schema (#4021)

👷‍ All changes

❤️ External contributors

🗄 ⚙️ Deprecations

Changelog History

Page 1

👍 ✨️ [new] `@defer` support

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

✅ 🚧 [deprecated] `runTest` (#4292)

🚧 [breaking] Automatic detection of `type` enum values.

✨️ [new] `-incubating` cache artifacts.

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

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

✨️ [new] `WebSocketNetworkTransport.closeConnection` (#4049)

🛰 ✨️ [new] `GraphQLWsProtocol.connectionPayload` is now a lambda (#4043)