Serializer for class 'ChatCompletionRequest' is not found.

[CazimirRoman]

Description

When building a release version for my Android app with R8 i get the error: "Serializer for class 'ChatCompletionRequest' is not found."

Steps to Reproduce

1. Build release APK
2. Install APK
3. Send a chat completion request: public suspend fun chatCompletion(request: ChatCompletionRequest): ChatCompletion
4. App crashes with this exception:

com.aallam.openai.api.exception.OpenAIHttpException: Serializer for class 'ChatCompletionRequest' is not found. Mark the class as @Serializable or provide the serializer explicitly. at com.aallam.openai.client.internal.http.HttpTransport.handleException(HttpTransport.kt:46) at com.aallam.openai.client.internal.http.HttpTransport.perform(HttpTransport.kt:25) at com.aallam.openai.client.internal.http.HttpTransport$perform$1.invokeSuspend(HttpTransport.kt:0) at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33) at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:104) at androidx.compose.ui.platform.AndroidUiDispatcher.performTrampolineDispatch(AndroidUiDispatcher.android.kt:81) at androidx.compose.ui.platform.AndroidUiDispatcher.access$performTrampolineDispatch(AndroidUiDispatcher.android.kt:41) at androidx.compose.ui.platform.AndroidUiDispatcher$dispatchCallback$1.run(AndroidUiDispatcher.android.kt:57) at android.os.Handler.handleCallback(Handler.java:942) at android.os.Handler.dispatchMessage(Handler.java:99) at android.os.Looper.loopOnce(Looper.java:226) at android.os.Looper.loop(Looper.java:313) at android.app.ActivityThread.main(ActivityThread.java:8757) at java.lang.reflect.Method.invoke(Native Method) at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:571) at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1067) Suppressed: kotlinx.coroutines.DiagnosticCoroutineContextException: [androidx.compose.ui.platform.MotionDurationScaleImpl@a692934, androidx.compose.runtime.BroadcastFrameClock@b8c935d, StandaloneCoroutine{Cancelling}@6af44d2, AndroidUiDispatcher@c0479a3] Caused by: kotlinx.serialization.SerializationException: Serializer for class 'ChatCompletionRequest' is not found. Mark the class as @Serializable or provide the serializer explicitly. at kotlinx.serialization.internal.Platform_commonKt.serializerNotRegistered(Platform.common.kt:91) at kotlinx.serialization.SerializersKt__SerializersKt.serializer(Serializers.kt:149) at kotlinx.serialization.SerializersKt.serializer(Unknown Source:1) at io.ktor.serialization.kotlinx.SerializerLookupKt.guessSerializer(SerializerLookup.kt:44) at io.ktor.serialization.kotlinx.KotlinxSerializationBase.serialize$ktor_serialization_kotlinx(KotlinxSerializationBase.kt:34) at io.ktor.serialization.kotlinx.KotlinxSerializationConverter.serializeNullable(KotlinxSerializationConverter.kt:54) at io.ktor.client.plugins.contentnegotiation.ContentNegotiation.convertRequest$ktor_client_content_negotiation(ContentNegotiation.kt:156) at io.ktor.client.plugins.contentnegotiation.ContentNegotiation$Plugin$install$1.invokeSuspend(ContentNegotiation.kt:202) at io.ktor.client.plugins.contentnegotiation.ContentNegotiation$Plugin$install$1.invoke(ContentNegotiation.kt:0) at io.ktor.client.plugins.contentnegotiation.ContentNegotiation$Plugin$install$1.invoke(ContentNegotiation.kt:0) at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:120) at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:78) at io.ktor.util.pipeline.SuspendFunctionGun.proceedWith(SuspendFunctionGun.kt:88) at io.ktor.client.plugins.HttpCallValidator$Companion$install$1.invokeSuspend(HttpCallValidator.kt:130) at io.ktor.client.plugins.HttpCallValidator$Companion$install$1.invoke(HttpCallValidator.kt:0) at io.ktor.client.plugins.HttpCallValidator$Companion$install$1.invoke(HttpCallValidator.kt:0) at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:120) at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:78) at io.ktor.client.plugins.HttpRequestLifecycle$Plugin$install$1.invokeSuspend(HttpRequestLifecycle.kt:38) at io.ktor.client.plugins.HttpRequestLifecycle$Plugin$install$1.invoke(HttpRequestLifecycle.kt:0) 2023-04-04 10:41:06.532 21048-21048 AndroidRuntime com.carosoftware.cortex E at io.ktor.client.plugins.HttpRequestLifecycle$Plugin$install$1.invoke(HttpRequestLifecycle.kt:0) at io.ktor.util.pipeline.SuspendFunctionGun.loop(SuspendFunctionGun.kt:120) at io.ktor.util.pipeline.SuspendFunctionGun.proceed(SuspendFunctionGun.kt:78) at io.ktor.util.pipeline.SuspendFunctionGun.execute$ktor_utils(SuspendFunctionGun.kt:98) at io.ktor.util.pipeline.Pipeline.execute(Pipeline.kt:77) at io.ktor.client.HttpClient.execute$ktor_client_core(HttpClient.kt:191) at io.ktor.client.statement.HttpStatement.executeUnsafe(HttpStatement.kt:108) at io.ktor.client.statement.HttpStatement.execute(HttpStatement.kt:47) at io.ktor.client.statement.HttpStatement.execute(HttpStatement.kt:62) at com.aallam.openai.client.internal.api.ChatApi$chatCompletion$2.invokeSuspend(ChatApi.kt:22) at com.aallam.openai.client.internal.api.ChatApi$chatCompletion$2.invoke(ChatApi.kt:0) at com.aallam.openai.client.internal.api.ChatApi$chatCompletion$2.invoke(ChatApi.kt:0) at com.aallam.openai.client.internal.http.HttpTransport.perform(HttpTransport.kt:22) at com.aallam.openai.client.internal.api.ChatApi.chatCompletion(ChatApi.kt:34) at com.aallam.openai.client.internal.OpenAIApi.chatCompletion(OpenAIApi.kt:0)

Environment

• openai-kotlin version: [e.g. 3.2.0]
• Kotlin version: [e.g. 1.8.10]
• OS: [macOS]

Additional Info

Tried adding the proguard rules in the proguard-rules.pro file like mentioned in the README:

`-keepattributes InnerClasses

-if @kotlinx.serialization.Serializable class
com.aallam.openai.api.**
{
static *$ *;
}
-keepnames class <1>$$serializer {
static <1>$$serializer INSTANCE;
}`

[aallam]

Hello @CazimirRoman, applying the Kotlin serialization plugin (discussion) to your project should fix the issue. However, could you please share your Gradle configuration for the release build, so that I can reproduce it? thanks!

[CazimirRoman]

Hi Mouaad, Thank you for your quick response. Here is my gradle file:

`plugins {
id("com.android.application")
kotlin("android")
id("kotlin-kapt")
id("dagger.hilt.android.plugin")
id("com.google.gms.google-services")
}

android {
compileSdk = ProjectConfig.compileSdk

defaultConfig {
    applicationId = ProjectConfig.appId
    minSdk = ProjectConfig.minSdk
    targetSdk = ProjectConfig.targetSdk
    versionCode = ProjectConfig.versionCode
    versionName = ProjectConfig.versionName

    testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
    vectorDrawables {
        useSupportLibrary = true
    }
}

buildTypes {
    getByName("release") {
        isMinifyEnabled = true
        isShrinkResources = false
        proguardFiles(
            getDefaultProguardFile("proguard-android-optimize.txt"),
            "proguard-rules.pro"
        )
    }

    getByName("debug") {
        applicationIdSuffix = ".dev"
        isDebuggable = true
        multiDexEnabled = true
    }
}

buildFeatures {
    dataBinding = true
    compose = true
}

composeOptions {
    kotlinCompilerExtensionVersion = Compose.composeCompilerVersion
}

compileOptions {
    sourceCompatibility = JavaVersion.VERSION_11
    targetCompatibility = JavaVersion.VERSION_11
}

kotlinOptions {
    freeCompilerArgs += "-opt-in=kotlin.RequiresOptIn"
}

externalNativeBuild {
    ndkBuild {
        path("src/main/jni/Android.mk")
    }
}

ndkVersion = "25.2.9519653"

}

dependencies {

implementation(project(Modules.core))
implementation(project(Modules.coreUi))
implementation(project(Modules.logger))
implementation(project(Modules.billing))
implementation(project(Modules.tracking))
implementation(project(Modules.rating))
implementation(project(Modules.settings))
implementation(project(Modules.buyTokens))
implementation(project(Modules.authentication))
implementation(project(Modules.onboarding))
implementation(project(Modules.openAi))

implementation(AndroidX.coreKtx)
implementation(AndroidX.appCompat)
implementation(Compose.viewModelKtx)

// implementation(Google.firebaseAds)
implementation(Google.firebaseMessaging)
implementation(Google.material)
implementation(Google.pager)
implementation(Google.pagerIndicators)
implementation(Google.gmsPlayServicesAds)
implementation(Compose.material)
implementation(Compose.compiler)
implementation (Compose.ui)
implementation (Compose.uiTooling)
implementation (Compose.hiltNavigationCompose)
implementation (Compose.material)
implementation (Compose.runtime)
implementation (Compose.navigation)
implementation (Compose.viewModelCompose)
implementation (Compose.viewModelKtx)
implementation (Compose.activityCompose)
implementation (Glide.glideLandscapist)

implementation(Compose.iconsExtended)

implementation("androidx.fragment:fragment-ktx:1.5.2")

implementation(DaggerHilt.hiltAndroid)
implementation(AndroidX.coreKtx)
implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0")
implementation("com.google.firebase:firebase-database-ktx:20.0.4")
kapt(DaggerHilt.hiltCompiler)

implementation("androidx.legacy:legacy-support-v4:1.0.0")
implementation("androidx.lifecycle:lifecycle-extensions:2.2.0")
implementation("androidx.preference:preference:1.2.0")
implementation("com.google.firebase:firebase-core:21.1.0")
implementation("androidx.viewpager2:viewpager2:1.1.0-beta01")
implementation("com.jakewharton.timber:timber:4.7.1")
implementation("com.stepstone.apprating:app-rating:2.3.1")

testImplementation ("junit:junit:4.13.2")
androidTestImplementation ("androidx.test.ext:junit:1.1.3")
androidTestImplementation ("androidx.test.espresso:espresso-core:3.4.0")

testImplementation ("androidx.test.ext:junit-ktx:1.1.3")
testImplementation ("androidx.test:core-ktx:1.4.0")
testImplementation ("org.robolectric:robolectric:4.6")
testImplementation ("androidx.arch.core:core-testing:2.1.0")

debugImplementation ("androidx.customview:customview-poolingcontainer:1.0.0")

}`

I managed a quick workaround by keeping everything from your library :D But then i get a huge APK size.

-keep class com.aallam.openai.** { *; }

[aallam]

Thank you, @CazimirRoman, for sharing! I have a quick question: did adding kotlin("plugin.serialization") to your plugins in Gradle help resolve the issue? Meanwhile, I will run some tests and get back to you :)

[CazimirRoman]

I am trying that now. should I also add the pro guard rules or are these changes mutually exclusive?

[CazimirRoman]

Even with the serializer dependencies i still get:

Caused by: kotlinx.serialization.SerializationException: Serializer for class 'ChatCompletionRequest' is not found.

What currently works is just to keep everything in the com.aallam.openai.api.chat package:

-keep class com.aallam.openai.api.chat.* { *; }

[lx1549181884]

I solved it.

Step:

1. Add proguard rules:

-keepattributes InnerClasses
-if @kotlinx.serialization.Serializable class com.aallam.openai.api.**{static **$* *;}
-keepnames class <1>$$serializer {static <1>$$serializer INSTANCE;}

2. Apply the Kotlin serialization Gradle plugin

plugins {
    id 'org.jetbrains.kotlin.plugin.serialization' version '1.8.20'
}

3. Add the JSON serialization library dependency:

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.0'
}

Refer to
ProGuard Rules
Serialization

[Melodeiro]

I am still having issues using 3.2.1 version. Serializer plugin and dependency has been added. None of the described solutions here worked. The narrowest thing that helps is:

-keep class com.aallam.openai.api.chat.ChatCompletionRequest* { *; }
-keep class com.aallam.openai.api.chat.ChatCompletion* { *; }

When adding those wildcards at the end of the class, i can see a few extra notifications in the proguard logs:

Note: the configuration keeps the entry point 'com.aallam.openai.api.chat.ChatCompletionRequest { void write$Self(com.aallam.openai.api.chat.ChatCompletionRequest,kotlinx.serialization.encoding.CompositeEncoder,kotlinx.serialization.descriptors.SerialDescriptor); }', but not the descriptor class 'kotlinx.serialization.encoding.CompositeEncoder'
Note: the configuration keeps the entry point 'com.aallam.openai.api.chat.ChatCompletionRequest { void write$Self(com.aallam.openai.api.chat.ChatCompletionRequest,kotlinx.serialization.encoding.CompositeEncoder,kotlinx.serialization.descriptors.SerialDescriptor); }', but not the descriptor class 'kotlinx.serialization.descriptors.SerialDescriptor'
Note: the configuration keeps the entry point 'com.aallam.openai.api.chat.ChatCompletionRequest { ChatCompletionRequest(int,java.lang.String,java.util.List,java.lang.Double,java.lang.Double,java.lang.Integer,java.util.List,java.lang.Integer,java.lang.Double,java.lang.Double,java.util.Map,java.lang.String,kotlinx.serialization.internal.SerializationConstructorMarker); }', but not the descriptor class 'kotlinx.serialization.internal.SerializationConstructorMarker'
Note: the configuration keeps the entry point 'com.aallam.openai.api.chat.ChatCompletionRequest { ChatCompletionRequest(int,java.lang.String,java.util.List,java.lang.Double,java.lang.Double,java.lang.Integer,java.util.List,java.lang.Integer,java.lang.Double,java.lang.Double,java.util.Map,java.lang.String,kotlinx.serialization.internal.SerializationConstructorMarker,kotlin.jvm.internal.DefaultConstructorMarker); }', but not the descriptor class 'kotlinx.serialization.internal.SerializationConstructorMarker'

Hope that helps.