Describe the bug I wanted to write some fake data source to return some data in tests and be a bit more realistic. I decided to use MockEngine and create Ktorfit instance in test. But when I try to create Ktorfit instance, I get a strange exception:

This function has a reified type parameter and thus can only be inlined at compilation time, not called directly.
java.lang.UnsupportedOperationException: This function has a reified type parameter and thus can only be inlined at compilation time, not called directly.
	at kotlin.jvm.internal.Intrinsics.throwUndefinedForReified(Intrinsics.java:207)
	at kotlin.jvm.internal.Intrinsics.throwUndefinedForReified(Intrinsics.java:201)
	at kotlin.jvm.internal.Intrinsics.reifiedOperationMarker(Intrinsics.java:211)
	at io.github.fobo66.data.source.NetworkDataSourceImplTest.setUp(NetworkDataSourceImplTest.kt:57)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:59)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:56)
	at org.junit.internal.runners.statements.RunBefores.invokeMethod(RunBefores.java:33)
	at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:24)
	at org.junit.internal.runners.statements.RunAfters.evaluate(RunAfters.java:27)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.BlockJUnit4ClassRunner$1.evaluate(BlockJUnit4ClassRunner.java:100)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:366)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:103)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:63)
	at org.junit.runners.ParentRunner$4.run(ParentRunner.java:331)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:79)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:329)
	at org.junit.runners.ParentRunner.access$100(ParentRunner.java:66)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:293)
	at org.junit.runners.ParentRunner$3.evaluate(ParentRunner.java:306)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:413)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.runTestClass(JUnitTestClassExecutor.java:110)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.execute(JUnitTestClassExecutor.java:58)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.execute(JUnitTestClassExecutor.java:38)
	at org.gradle.api.internal.tasks.testing.junit.AbstractJUnitTestClassProcessor.processTestClass(AbstractJUnitTestClassProcessor.java:62)
	at org.gradle.api.internal.tasks.testing.SuiteTestClassProcessor.processTestClass(SuiteTestClassProcessor.java:51)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:36)
	at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:24)
	at org.gradle.internal.dispatch.ContextClassLoaderDispatch.dispatch(ContextClassLoaderDispatch.java:33)
	at org.gradle.internal.dispatch.ProxyDispatchAdapter$DispatchingInvocationHandler.invoke(ProxyDispatchAdapter.java:94)
	at com.sun.proxy.$Proxy2.processTestClass(Unknown Source)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker$2.run(TestWorker.java:176)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.executeAndMaintainThreadName(TestWorker.java:129)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:100)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:60)
	at org.gradle.process.internal.worker.child.ActionExecutionWorker.execute(ActionExecutionWorker.java:56)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:133)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:71)
	at worker.org.gradle.process.internal.worker.GradleWorkerMain.run(GradleWorkerMain.java:69)
	at worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74)

It seems to work fine in the app. ksp is working and code is generated, but there is extra file for debugUnitTest flavor that has no implementation of my API interface.

Here's the generated code for debug flavor:

// Generated by Ktorfit
package de.jensklingenberg.ktorfit

import de.jensklingenberg.ktorfit.`internal`.KtorfitClient

public inline fun <reified T> Ktorfit.create(): T = when(T::class){
  io.github.fobo66.data.api.MatchmakingRatingApi::class ->{
      io.github.fobo66.data.api._MatchmakingRatingApiImpl(KtorfitClient(this)) as T
      }

  else ->{
  throw IllegalArgumentException("Could not find any Ktorfit annotations in class"+
      T::class.qualifiedName  )
  }
}

And here is the generated code for debugUnitTest:

// Generated by Ktorfit
package de.jensklingenberg.ktorfit

import de.jensklingenberg.ktorfit.`internal`.KtorfitClient

public inline fun <reified T> Ktorfit.create(): T = when(T::class){

  else ->{
  throw IllegalArgumentException("Could not find any Ktorfit annotations in class"+
      T::class.qualifiedName  )
  }
}

To Reproduce Steps to reproduce the behavior:

1. Create instance of Ktorfit API
2. Run test
3. See error

Expected behavior Ktorfit API should be created just fine

Software used

Android Studio Electric Eel | 2022.1.1 Canary 10
Build #AI-221.6008.13.2211.8963757, built on August 18, 2022
Runtime version: 11.0.15+0-b2043.56-8887301 x86_64
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
macOS 12.5.1
GC: G1 Young Generation, G1 Old Generation
Memory: 4096M
Cores: 8
Registry:
    external.system.auto.import.disabled=true
    ide.text.editor.with.preview.show.floating.toolbar=false
    ide.instant.shutdown=false

Non-Bundled Plugins:
    wu.seal.tool.jsontokotlin (3.7.4)
    some.awesome (1.14)
    monokai-pro (1.8.1)
    detekt (1.21.3-android)
    String Manipulation (9.5.0)
    com.nbadal.ktlint (0.10.0)

Additional context Just in case here's how I set up Ktorfit instance:

    private val engine: MockEngine by lazy {
        MockEngine {
            if (it.url.encodedPath.contains('1')) {
                respondOk("test")
            } else {
                respondError(HttpStatusCode.InternalServerError)
            }
        }
    }

    private val ktorfit: Ktorfit by lazy {
        ktorfit {
            baseUrl("https://localhost/")
            httpClient(engine) {
                install(ContentNegotiation) {
                    json(
                        json = Json {
                            ignoreUnknownKeys = true
                        },
                        contentType = ContentType.Any
                    )
                }
            }
        }
    }

Describe the bug When using @FormUrlEncoded, ktor will throw an error io.ktor.http.UnsafeHeaderException: Header(s) [Content-Type] are controlled by the engine and cannot be set explicitly, I think it's a limitation from ktor since there's already an issue about it. But I haven't got a solution yet.

To Reproduce Steps to reproduce the behavior: Make an api interface with @FormUrlEncoded

Expected behavior We can make @FormUrlEncoded request

Software used

Android Studio Electric Eel | 2022.1.1 Canary 2
Build #AI-213.7172.25.2211.8571212, built on May 11, 2022
Runtime version: 11.0.13+0-b1751.21-8125866 amd64
Manjaro

Describe the bug I'm using following function to make network request

@GET("v2/list")
suspend fun getAllImages(
    @Query("page") page: Int,
    @Query("size") size: Int = 30
): ApiResponse<List<Image>>

However, when I try to run the app, it throws compilation error and display error that Type mismatch: inferred type is Int but Boolean was expected Whatever data type i use for @Query("page") page: Int or String, QueryData(false,"page",page,QueryType.QUERY) always generate boolean value type.

Below is the Implementation class generated by Ktorfir

public class _ImageApiImpl(
  private val client: KtorfitClient,
) : ImageApi {
  public override suspend fun getAllImages(page: Int, size: Int): ApiResponse<List<Image>> {
    val requestData = RequestData(method="GET",
        relativeUrl="v2/list",
        queries = listOf(QueryData(false,"page",page,QueryType.QUERY),  //This is error
            QueryData(false,"size",size,QueryType.QUERY)), //This is error
        qualifiedRawTypeName="com.hadiyarajesh.flower_core.ApiResponse") 

    return client.suspendRequest<ApiResponse<List<Image>>, List<Image>>(requestData)
  }
}

To Reproduce Steps to reproduce the behavior: Just use the same code I've mentioned

Expected behavior App should compile and run without any issue

Screenshots NA

Software used

Android studio Chipmank
Windows 11

Additional context NA

Describe the bug

Not sure if it's a bug or a feature request.

However I recently discovered that Ktorfit isn't compatible with Windows. I contributed to another project and everything worked fine for me (as I'm on Linux) but another person (using Windows) could not retrive the native library as it's not published for the windows target.

To Reproduce

Steps to reproduce the behavior:

1. Create a native library/application
2. Boot into a Windows machine
3. Open and build the project
4. See error

Expected behavior

The library should be available on the Windows platform.

I saw that the gradle files are missing the Windows target, adding it should resolve the problem.

Describe the bug Query parameters are not being encoded correctly, I think it's encoding it twice

To Reproduce

startDate = 2022-07-10T00:00
endDate = 2022-07-13T23:59
timeTrunc = hour

This should the url https://apidatos.ree.es/es/datos/mercados/precios-mercados-tiempo-real?start_date=2022-07-10T00:00&end_date=2022-07-13T23:59&time_trunc=hour and encoded url https://apidatos.ree.es/es/datos/mercados/precios-mercados-tiempo-real?start_date=2022-07-10T00%3A00&end_date=2022-07-13T23%3A59&time_trunc=hour

but app is calling this url: https://apidatos.ree.es/es/datos/mercados/precios-mercados-tiempo-real?start_date=2022-07-10T00%253A00&end_date=2022-07-13T23%253A59&time_trunc=hour

Software used

Android Studio Chipmunk | 2021.2.1 Patch 1
Kotlin v1.7.0
KSP 1v.7.0-1.0.6
Ktor v2.0.3
Ktorfit v1.0.0-beta08

I use ktorfit in my app. I tried to update the version of the ksp plugin to the latest one, different from the one in the example. After the update, the generated class _ApiServiceImpl began to inherit from some _AnyImpl. Because of this, I got this error: Only interfaces can by delegated to and also Unresolved reference: _AnyImpl When downgrading, everything becomes fine, but I would like to use a newer version of Kotlin in my project, which the old version of the ksp plugin does not allow.

More specifically about versions: Old version of ksp: 1.6.10-1.0.4 New version of ksp: 1.6.21-1.0.5 Old kotlin version: 1.5.31 New kotlin version: 1.6.20

Class code with an error: class _ApiServiceImpl(val client : KtorfitClient) : ApiService , kotlin.Any by kotlin._AnyImpl(client){ // Other maybe normal code }

can you suggest me how to solve this problem? Maybe I missed something, or is it a problem of the library itself?

The suspend API functions ignore any defined ResponseConverters - is that by design? A look into the source code confirms this, only the non-suspend code in KtorfitClient.request uses getResponseConverters().

*(I created a similar GH issue before and I closed it because it contained a lot of other noise)

Field in FormUrlEncoded requests on Android with OkHttp gets encoded twice. For example @ is encoded as %2540 instead of %40. I suspect that OkHttp is doing encoding too. Tested on beta09.

Describe the bug The processor generates invalid code which does not compile.

To Reproduce

interface GitHubService {
    @GET("repos/{user}/{repo}/releases/latest")
    suspend fun getLatestRelease(
        @Path("user") user: String,
        @Path("repo") repo: String,
    ): String
}

Expected behavior The code should work fine.

Instead, the generated code does not compile with these Errors:

Only interfaces can be delegated to.
Unresolved reference: _AnyImpl

public class _GitHubServiceImpl(
  private val client: KtorfitClient,
) : GitHubService, Any by kotlin._AnyImpl(client) {
  public override suspend fun getLatestRelease(user: String, repo: String): String {
    val requestData = RequestData(method="GET",
        relativeUrl="repos/${client.encode(user)}/${client.encode(repo)}/releases/latest",
        qualifiedRawTypeName="kotlin.String") 

    return client.suspendRequest<String, String>(requestData)
  }
}

Software used

IntelliJ IDEA 2022.1 (Ultimate Edition)
Build #IU-221.5080.210, built on April 12, 2022
Runtime version: 11.0.3+12-b304.10 amd64
Runtime version: 11.0.14.1+1-b2043.25 amd64
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
Windows 10 10.0

Library Versions:

• Kotlin 1.6.21
• ksp 1.6.21-1.0.5
• ktorfit 1.0.0-beta05

Ktorfit version

1.0.0-beta16

What happened and how can we reproduce this issue?

Ktor client configured with JSON content negotiation

Example:

@POST("auth/verify")
suspend fun verify(@Body verifyRequest: VerifyRequest)

Error:

java.lang.IllegalStateException: Fail to prepare request body for sending. The body type is: class *.VerifyRequest (Kotlin reflection is not available), with Content-Type: null.

If you expect serialized body, please check that you have installed the corresponding plugin(like ContentNegotiation) and set Content-Type header.

What did you expect to happen?

Content type to be automatically determined based on client configuration (same as Retrofit)

Is there anything else we need to know about?

Works if the header is set:

@POST("auth/verify")
suspend fun verify(@Body verifyRequest: VerifyRequest, @Header("Content-Type") contentType: String = "application/json")

Ktorfit version

1.0.0-beta15

What happened and how can we reproduce this issue?

I am trying to port a Android app to KMM, but before I started to actually create the KMM project I wanted to move all my Android specific libraries to ones that support KMP so I switched from Room to SQLDelight, and from LiveData to Flow, not it was up to the web service to be migrated from Retrofit. While searching the internet I came to this nice library that basically mimics Retrofit. I followed the guide on how to set it up but I only found documentation for multiplatform projects, which didn't exactly worked in my situation since this is still a standalone Android app so at first I tried to use the gradle dependencies like so:

def ktorfit_version = '1.0.0-beta15'
implementation "de.jensklingenberg.ktorfit:ktorfit-ksp:$ktorfit_version"
implementation "de.jensklingenberg.ktorfit:ktorfit-lib:$ktorfit_version"

This compiled fine but I was getting an error saying that no KPS files were generated so I checked the build/generated/source folder and indeed no files were generated. After some more reading I finally found some info on the KPS website and tried also adding in the dependencies under the lines shown above

ksp "de.jensklingenberg.ktorfit:ktorfit-ksp:$ktorfit_version"

Although it is stated clearly this is deprecated, at least it manage to generate the files in build/generated/kps but I am getting a compilation error saying that my interface cannot be found : Unresolved reference: BusApi and that my methods have nothing to override

My configuration looks like this

    private val api: BusApi by lazy {
        val ktorClient = HttpClient() {
            install(ContentNegotiation) {
                json(Json { isLenient = true; ignoreUnknownKeys = true })
            }
        }

        Ktorfit.Builder()
            .baseUrl(BASE_URL)
            .httpClient(ktorClient)
            .build()
            .create<BusApi>()
...
    companion object {
        const val BASE_URL = "https://mywebsitehere/api/"
    }

and my interface like this:

    interface BusApi {

        @GET("buslines")
        suspend fun getBusLines(): List<BusLineDto>

        @GET("busstations/{lineNumberLink}")
        suspend fun getBusStations(
            @Path("lineNumberLink") lineNumberLink: String
        ): List<BusStationDto>

        @GET("bustimetables/{scheduleLink}")
        suspend fun getBusTimetables(
            @Path("scheduleLink") scheduleLink: String
        ): List<BusTimetableDto>
    }

    

Unfortunately I am not an expert on Gradle or KPS so I don't know if my configuration is good or actually what I am trying to do even supported on non multiplatform apps

Any help would be appreciated

What did you expect to happen?

To have no compilation errors

Is there anything else we need to know about?

No response

Bumps com.vanniktech.maven.publish from 0.21.0 to 0.23.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Ktorfit version

1.0.0-beta16

What happened and how can we reproduce this issue?

Sending a request using @FormUrlEncoded results in data being encoded twice if string contains special characters.

What did you expect to happen?

Special characters should be encoded once.

Is there anything else we need to know about?

As a work around I am using @Field("whatever", true) and using unencoded strings. Data is still encoded, but only once. I assume that Ktor is also encoding form data so Ktorfit probably doesn't need to. But that's just a guess.

I want to copy Ktorfit instance with some edition, add a request converter or change base url for example. Retrofit have similar function Retrofit.newBuilder

For now i use this extension:

fun Ktorfit.newBuilder(): Ktorfit.Builder {
    return Ktorfit.Builder()
        .baseUrl(baseUrl)
        .httpClient(httpClient)
        .apply {
            responseConverters.forEach {
                responseConverter(it)
            }
            suspendResponseConverters.forEach {
                responseConverter(it)
            }
            requestConverters.forEach {
                requestConverter(it)
            }
        }
}

This extension has extra cost for new allocations and etc., also it must be updated every time when Ktorfit properties changed

I tried to fix the issues related to Ktorfit used in multiple modules and saw that there is an issue with how Ktorfit currently works and i don`t know a good way to fix this. If you have any ideas, let me know.

I will explain in short how Ktorfit currently works

How Ktorfit works:

package com.example

import com.example.model.People
import de.jensklingenberg.ktorfit.http.GET


interface ExampleApi  {
    @GET("/test")
    suspend fun exampleGet(): People
}

Let`s say we a interface like this.

At compile time Ktorfit/KSP checks for all functions that are annotated with Ktorfit annotations like @GET.

Then it looks at the parent interfaces of that functions and generates, the source code of a Kotlin class that implements the interface. The classes are named like the interfaces but with an underscore at the beginning and "Impl" at the end and they have the same package as the interfaces. In this case a class named _ExampleApiImpl will be generated.

public class _ExampleApiImpl(
  private val client: KtorfitClient,
) : ExampleApi {
  public override suspend fun exampleGet(): People {
    val requestData = RequestData(method="GET",
        relativeUrl="/test",
        returnTypeData=TypeData("com.example.model.People")) 

    return client.suspendRequest<People, People>(requestData)!!
  }
}

public fun Ktorfit.createExampleApi(): ExampleApi = _ExampleApiImpl(KtorfitClient(this))

After that the source code of the Ktorfit.create() will be generated. The same function in the Ktorfit-lib is only there to enable code completion inside IntelliJ.

The source code of the generated function will look something likes this :

public inline fun <reified T> Ktorfit.create(): T = when(T::class){
  com.example.ExampleApi::class ->{
      this.createExampleApi() as T
      }
      
  else ->{
  throw IllegalArgumentException("Could not find any Ktorfit annotations in class"+ T::class.simpleName  )
  }
}

For every interface with annotations that KSP found there will be a case in the when block. And an instance of the implementation will be returned. Otherwise the IllegalArgumentException will be thrown.

The problem

This works when the interfaces are in the inside the same module where the create-function is used.

This does not work when you use a interface that is inside another module.

Example: Module A: Uses MyService from ModuleB -> create< MyService>() Module B: contains the MyService.kt

KSP only knows about the files that are used inside the module, where it is currently used.

KSP in ModuleA will generate the create() function and doesn't know that ModuleB exists. So no code for MyService will be generated and it can't be used and at Runtime it will throw the IllegalArgumentException from the else case

KSP in Module B will generate the create() and the implementation class of MyService.

Why is Ktorfit implemented this way?

I wanted to provide a similar easy usage like Retrofit and i want that this library can be used in multiplatform projects. The big problem is, unlike Retrofit i can`t use reflection, because their is basically none for KotlinJS and Kotlin Native available.

Because of this, we need to know the possible interfaces at compile time to add them to Ktorfit.create() and can't just generate code on runtime.

Ideas

• Maybe there is a option in KSP, that i don`t know
• Maybe completely removing the generic create-function and only using the other extension functions like "createExampleApi()" could be a way. In the example above, when Module B adds "build/generated" as source folder. Then Module A should be able to find the createMyService() function. And it should work.

Is your feature request related to a problem? Please describe. I am working on a shared KMM library to be used in an Android app and an iOS app. The project consists of several gradle modules, ModuleA and ModuleB, where both are using KtorFit to make requests to Api-A and Api-B. Building the .aar's to be included in the Android project works fine, but when the shared library is included in the Android project the Android build fails with

Duplicate class de.jensklingenberg.ktorfit.KtorfitExtKt found in modules ModuleA and ModuleB

And when trying to build the iOS binary it fails with:

e: Compilation failed: IrSimpleFunctionPublicSymbolImpl for de.jensklingenberg.ktorfit/create|-6976474634225900979[0] is already bound: FUN name:create visibility:public modality:FINAL <T> ($receiver:<unbound IrClassPublicSymbolImpl>) returnType:T of de.jensklingenberg.ktorfit.create [inline]

It seems currently we are limited to only including Ktorfit 1 gradle module.

Describe the solution you'd like I would like to be able to use Ktorfit in several gradle modules which are used for different features and API's, but i am currently unsure about what changes would be required for that.

If there is a workaround for this, please let me now. I'd also be happy to help out with implementing any required changes in Ktorfit, but could perhaps need some guidance on what is required.

Is your feature request related to a problem? Please describe. Add support for Response return type similar to Retrofit.

Additional context Currently the supported types are:

interface StarWarsApi {

    @GET("people/{id}/")
    suspend fun getPerson(@Path("id") personId: Int): Person

    @GET("people")
    fun getPeopleFlow(@Query("page") page: Int): Flow<Person>

    @GET("people/{id}/")
    fun getPersonCall(@Path("id") personId: Int): Call<Person>

}

We also need this use case:

@GET("people/{id}/")
fun getPersonCall(@Path("id") personId: Int): Response<Person>

This will allow us to check the status code and other parameters similar to Retrofit Response: https://github.com/square/retrofit/blob/fbf1225e28e2094bec35f587b8933748b705d167/retrofit/src/main/java/retrofit2/Response.java

We can also copy these tests: https://github.com/square/retrofit/blob/fbf1225e28e2094bec35f587b8933748b705d167/retrofit/src/test/java/retrofit2/ResponseTest.java

Additional Benefits Make it easier to migrate from Retrofit by reusing existing Response<DataType> return values and Response interface api.