Skip to content

Update retrofit monorepo to v3 (major) #5321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update retrofit monorepo to v3 (major) #5321

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 18, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
com.squareup.retrofit2:converter-jackson 2.9.0 -> 3.0.0 age adoption passing confidence
com.squareup.retrofit2:retrofit 2.9.0 -> 3.0.0 age adoption passing confidence

Release Notes

square/retrofit (com.squareup.retrofit2:converter-jackson)

v3.0.0

Compare Source

Changed

  • Upgrade to OkHttp 4.12 (from 3.14).

    This is the version of OkHttp that is written in Kotlin, and as a result Retrofit now has a transitive Kotlin dependency. However, this is also the supported version of OkHttp whereas the previous version was out of support for nearly 4 years.

Note: The 3.x versions of Retrofit maintain forward binary-compatibility with the 2.x versions.
This means libraries compiled against 2.x can still be used with the 3.x versions.

v2.12.0

Compare Source

New

  • First-party converters now support deferring serialization to happen when the request body is written (i.e., during HTTP execution) rather than when the HTTP request is created. In some cases this moves conversion from a calling thread to a background thread, such as in the case when using Call.enqueue directly.

    The following converters support this feature through a new withStreaming() factory method:

    • Gson
    • Jackson
    • Moshi
    • Protobuf
    • Wire

Fixed

  • Primitive types used with @Tag now work by storing the value boxed with the boxed class as the key.

v2.11.0

Compare Source

New

  • The built-in OptionalConverterFactory is now public to allow installing it before other converters which consume all types (e.g., Moshi, Gson, Jackson, etc.).

Fixed

  • Ensure that exceptions thrown from failure to parse method annotations can be observed by multiple threads/callers. Previously only the first caller would see the actual parsing exception and other callers would get a cryptic ClassCastException.

v2.10.0

Compare Source

New

  • Support using Unit as a response type. This can be used for non-body HTTP methods like HEAD or body-containing HTTP methods like GET where the body will be discarded without deserialization.

  • kotlinx.serialization converter!

    This was imported from github.com/JakeWharton/retrofit2-kotlinx-serialization-converter/ and remains unchanged from its 1.0.0 release.

    The Maven coordinates are com.squareup.retrofit2:converter-kotlinx-serialization.

  • JAXB 3 converter!

    The Maven coordinates are com.squareup.retrofit2:converter-jaxb3.

  • @Header, @Headers, and @HeaderMap can now set non-ASCII values through the allowUnsafeNonAsciiValues annotation property. These are not technically compliant with the HTTP specification, but are often supported or required by services.

  • Publish a BOM of all modules. The Maven coordinates are com.squareup.retrofit2:retrofit-bom.

  • Invocation now exposes the service Class<?> and the instance on which the method was invoked. This disambiguates the source when service inheritence is used.

  • A response type keeper annotation processor is now available for generating shrinker rules for all referenced types in your service interface. In some cases, it's impossible for static shrinker rules to keep the entirety of what Retrofit needs at runtime. This annotation processor generates those additional rules. For more info see its README.

Changed

  • Add shrinker rules to retain the generic signatures of built-in types (Call, Response, etc.) which are used via reflection at runtime.
  • Remove backpressure support from RxJava 2 and 3 adapters. Since we only deliver a single value and the Reactive Streams specification states that callers must request a non-zero subscription value, we never need to honor backpressure.
  • Kotlin Retrofit.create function now has a non-null lower bound. Even if you specified a nullable type before this function would never return null.
  • Suspend functions now capture and defer all Throwable subtypes (not just Exception subtypes) to avoid Java's UndeclaredThrowableException when thrown synchronously.
  • Eagerly reject suspend fun functions that return Call<Body>. These are never correct, and should declare a return type of Body directly.
  • Support for Java 14-specific and Java 16-specific reflection needed to invoke default methods on interfaces have been moved to separate versions of a class through a multi-release jar. This should have no observable impact other than the jar now contains classes which target Java 14 and Java 16 bytecode that might trip up some static analysis tools which are not aware of multi-release jars.
  • Parameter names are now displayed in exception messages when available in the underlying Java bytecode.
  • Jackson converter now supports binary formats by using byte streams rather than character streams in its implementation. Use the create(ObjectMapper, MediaType) overload to supply the value of the Content-Type header for your format.

Fixed

  • Do not include synthetic methods when doing eager validation.
  • Use per-method rather than per-class locking when parsing annotations. This eliminates contention when multiple calls are made in quick succession at the beginning of the process lifetime.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 18, 2025 •
edited
Loading

Test Results

 29 files   29 suites   3m 28s ⏱️
 94 tests  92 ✅ 0 💤 2 ❌
114 runs  112 ✅ 0 💤 2 ❌

For more details on these failures, see this check.

Results for commit 09cfe1c.

♻️ This comment has been updated with latest results.

@TimoPtr TimoPtr mentioned this pull request May 19, 2025
Closed
1 task
@jpelgrom
Copy link
Member

Failure because of the Jackson dependency update raising the minimum required API level -> requires #5279

@renovate renovate bot force-pushed the renovate/major-retrofit-monorepo branch from 71d239d to 09cfe1c Compare May 28, 2025 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jpelgrom