release: 2.20.1 (#567)

* fix(client): r8 support

* chore(internal): reduce proguard ci logging

* chore(internal): bump ci test timeout

* release: 2.20.1

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ on:
 
 jobs:
   lint:
-    timeout-minutes: 10
+    timeout-minutes: 15
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/openai-java' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
@@ -37,7 +37,7 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
   test:
-    timeout-minutes: 10
+    timeout-minutes: 15
     name: test
     runs-on: ${{ github.repository == 'stainless-sdks/openai-java' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     if: github.event_name == 'push' || github.event.pull_request.head.repo.fork

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.20.0"
+  ".": "2.20.1"
 }

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 2.20.1 (2025-07-31)
+
+Full Changelog: [v2.20.0...v2.20.1](https://github.com/openai/openai-java/compare/v2.20.0...v2.20.1)
+
+### Bug Fixes
+
+* **client:** r8 support ([aa76f63](https://github.com/openai/openai-java/commit/aa76f638ca761ef63b336ee3e960f7302b4ec9dc))
+
+
+### Chores
+
+* **internal:** bump ci test timeout ([0ea80f0](https://github.com/openai/openai-java/commit/0ea80f0f4e914919e95c6914e907617bfadea369))
+* **internal:** reduce proguard ci logging ([876aa8f](https://github.com/openai/openai-java/commit/876aa8fa7b801ff0ed62ff933088bead3f7d5d66))
+
 ## 2.20.0 (2025-07-30)
 
 Full Changelog: [v2.19.2...v2.20.0](https://github.com/openai/openai-java/compare/v2.19.2...v2.20.0)

README.md

@@ -2,16 +2,16 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/2.20.0)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/2.20.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/2.20.0)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/2.20.1)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/2.20.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/2.20.1)
 
 <!-- x-release-please-end -->
 
 The OpenAI Java SDK provides convenient access to the [OpenAI REST API](https://platform.openai.com/docs) from applications written in Java.
 
 <!-- x-release-please-start-version -->
 
-The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/2.20.0).
+The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/2.20.1).
 
 <!-- x-release-please-end -->
 
@@ -24,7 +24,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
 ### Gradle
 
 ```kotlin
-implementation("com.openai:openai-java:2.20.0")
+implementation("com.openai:openai-java:2.20.1")
 ```
 
 ### Maven
@@ -33,7 +33,7 @@ implementation("com.openai:openai-java:2.20.0")
 <dependency>
   <groupId>com.openai</groupId>
   <artifactId>openai-java</artifactId>
-  <version>2.20.0</version>
+  <version>2.20.1</version>
 </dependency>
 ```
 
@@ -1329,7 +1329,7 @@ If you're using Spring Boot, then you can use the SDK's [Spring Boot starter](ht
 #### Gradle
 
 ```kotlin
-implementation("com.openai:openai-java-spring-boot-starter:2.20.0")
+implementation("com.openai:openai-java-spring-boot-starter:2.20.1")
 ```
 
 #### Maven
@@ -1338,7 +1338,7 @@ implementation("com.openai:openai-java-spring-boot-starter:2.20.0")
 <dependency>
   <groupId>com.openai</groupId>
   <artifactId>openai-java-spring-boot-starter</artifactId>
-  <version>2.20.0</version>
+  <version>2.20.1</version>
 </dependency>
 ```
 

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.openai"
-    version = "2.20.0" // x-release-please-version
+    version = "2.20.1" // x-release-please-version
 }
 
 subprojects {

openai-java-core/src/main/resources/META-INF/proguard/openai-java-core.pro

@@ -1,5 +1,5 @@
 # Jackson uses reflection and depends heavily on runtime attributes.
--keepattributes
+-keepattributes Exceptions,InnerClasses,Signature,Deprecated,*Annotation*
 
 # Jackson uses Kotlin reflection utilities, which themselves use reflection to access things.
 -keep class kotlin.reflect.** { *; }
@@ -17,13 +17,13 @@
     *;
 }
 
-# Jackson uses reflection to access the default constructors of serializers and deserializers.
--keepclassmembers class * extends com.openai.core.BaseSerializer {
-    <init>();
-}
--keepclassmembers class * extends com.openai.core.BaseDeserializer {
-    <init>();
-}
+# Jackson uses reified type information to serialize and deserialize our classes (via `TypeReference`).
+-keep class com.fasterxml.jackson.core.type.TypeReference { *; }
+-keep class * extends com.fasterxml.jackson.core.type.TypeReference { *; }
+
+# Jackson uses reflection to access our class serializers and deserializers.
+-keep @com.fasterxml.jackson.databind.annotation.JsonSerialize class com.openai.** { *; }
+-keep @com.fasterxml.jackson.databind.annotation.JsonDeserialize class com.openai.** { *; }
 
 # Jackson uses reflection to serialize and deserialize our classes based on their constructors and annotated members.
 -keepclassmembers class com.openai.** {

openai-java-proguard-test/build.gradle.kts

@@ -4,8 +4,13 @@ plugins {
 }
 
 buildscript {
+    repositories {
+        google()
+    }
+
     dependencies {
         classpath("com.guardsquare:proguard-gradle:7.4.2")
+        classpath("com.android.tools:r8:8.3.37")
     }
 }
 
@@ -15,7 +20,6 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.3")
     testImplementation("org.assertj:assertj-core:3.25.3")
     testImplementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.13.4")
-    testImplementation("org.junit.platform:junit-platform-console:1.10.1")
 }
 
 tasks.shadowJar {
@@ -33,7 +37,6 @@ val proguardJar by tasks.registering(proguard.gradle.ProGuardTask::class) {
     outjars(proguardJarPath)
     printmapping("${layout.buildDirectory.get()}/proguard-mapping.txt")
 
-    verbose()
     dontwarn()
 
     val javaHome = System.getProperty("java.home")
@@ -58,17 +61,43 @@ val testProGuard by tasks.registering(JavaExec::class) {
     dependsOn(proguardJar)
     notCompatibleWithConfigurationCache("ProGuard")
 
-    mainClass.set("org.junit.platform.console.ConsoleLauncher")
+    mainClass.set("com.openai.proguard.ProGuardCompatibilityTest")
     classpath = files(proguardJarPath)
+}
+
+val r8JarPath = "${layout.buildDirectory.get()}/libs/${project.name}-${project.version}-r8.jar"
+val r8Jar by tasks.registering(JavaExec::class) {
+    group = "verification"
+    dependsOn(tasks.shadowJar)
+    notCompatibleWithConfigurationCache("R8")
+
+    mainClass.set("com.android.tools.r8.R8")
+    classpath = buildscript.configurations["classpath"]
+
     args = listOf(
-        "--classpath", proguardJarPath,
-        "--scan-classpath",
-        "--details", "verbose",
+        "--release",
+        "--classfile",
+        "--output", r8JarPath,
+        "--lib", System.getProperty("java.home"),
+        "--pg-conf", "./test.pro",
+        "--pg-conf", "../openai-java-core/src/main/resources/META-INF/proguard/openai-java-core.pro",
+        "--pg-map-output", "${layout.buildDirectory.get()}/r8-mapping.txt",
+        tasks.shadowJar.get().archiveFile.get().asFile.absolutePath,
     )
 }
 
+val testR8 by tasks.registering(JavaExec::class) {
+    group = "verification"
+    dependsOn(r8Jar)
+    notCompatibleWithConfigurationCache("R8")
+
+    mainClass.set("com.openai.proguard.ProGuardCompatibilityTest")
+    classpath = files(r8JarPath)
+}
+
 tasks.test {
     dependsOn(testProGuard)
+    dependsOn(testR8)
     // We defer to the tests run via the ProGuard JAR.
     enabled = false
 }

openai-java-proguard-test/src/test/kotlin/com/openai/proguard/ProGuardCompatibilityTest.kt

@@ -14,20 +14,31 @@ import com.openai.models.chat.completions.ChatCompletionMessageToolCall
 import com.openai.models.chat.completions.ChatCompletionModality
 import com.openai.models.chat.completions.ChatCompletionTokenLogprob
 import com.openai.models.completions.CompletionUsage
+import kotlin.reflect.full.memberFunctions
+import kotlin.reflect.jvm.javaMethod
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.Test
 
 internal class ProGuardCompatibilityTest {
 
     companion object {
 
-        @BeforeAll
         @JvmStatic
-        fun setUp() {
+        fun main(args: Array<String>) {
             // To debug that we're using the right JAR.
             val jarPath = this::class.java.getProtectionDomain().codeSource.location
             println("JAR being used: $jarPath")
+
+            // We have to manually run the test methods instead of using the JUnit runner because it
+            // seems impossible to get working with R8.
+            val test = ProGuardCompatibilityTest()
+            test::class
+                .memberFunctions
+                .asSequence()
+                .filter { function ->
+                    function.javaMethod?.isAnnotationPresent(Test::class.java) == true
+                }
+                .forEach { it.call(test) }
         }
     }
 

openai-java-proguard-test/test.pro

@@ -2,4 +2,7 @@
 -keep class com.openai.proguard.** { *; }
 
 # For the testing framework.
--keep class org.junit.** { *; }
+-keep class org.junit.** { *; }
+
+# Many warnings don't apply for our testing purposes.
+-dontwarn