Hi, I've a problem trying to use OpenApi with mosh...

# http4k

[Nicola]

Hi, I've a problem trying to use OpenApi with moshi/Kotshi
At this line:

renderer = OpenApi3(
    apiInfo = ApiInfo("Payment renderer service API", "0.0.1")
    json = moshiLite
    apiRenderer = OpenApi3ApiRenderer(moshiLite)
)

I get the error
Cannot access class 'org.http4k.format.ConfigurableJackson'. Check your module classpath for missing or conflicting dependencies
I indeed removed jackson from dependencies, trying to use moshi/kotshi.
The var moshiList is as follows:

@KotshiJsonAdapterFactory
object ApplicationJsonAdapterFactory : JsonAdapter.Factory by KotshiApplicationJsonAdapterFactory

val moshiLite = ConfigurableMoshi(
    Moshi.Builder()
        .add(ApplicationJsonAdapterFactory)
        .add(ListAdapter)
        .add(MapAdapter)
        .asConfigurable()
        .withStandardMappings()
        .done()
)

where could be the problem? thanks in advance ..

[dave]

yep - openAPI generation is not supported with anything other than Jackson at the moment

[Nicola]

ah! i overlooked that .. but leaving it just for open-api will be a performance penalty? (in aws lambda environment I mean) ?
Or will it be used when invoking the openapi endpoint only? (sorry for my english)

[Nicola]

btw this project by Andrew https://github.com/oharaandrew314/http4k-api-on-lambda doesn't seem to include jackson, at least I don't see it
but it builds correctly

[dave]

Yes - @Andrew O'Hara is using some magic to do the same thing. WE hope to eventually push some of this stuff back into the library,. I wonder where it's referencing JSON then?

[Andrew O'Hara]

The ConfigurableMoshi via Kotshi is defined here and it uses the same AutomMarshalling to generate the OpenAPI spec with the reflectionless OpenApi3Renderer here. As far as I can tell, it is completely reflectionless.

[Nicola]

I tried to do the same (my code is above) but there must be something different obviously

[dave]

I'd try and work out where it's referencing the Jackson.

[dave]

Is there a stack trace?

[Andrew O'Hara]

Kotshi doesn't have the best documentation, but here's essentially what you need to do.

1. Add the KSP plugin to your build.gradle like this (ensure you're using the right plugin for your Kotlin version)
2. Define a Kotshi adapter and reference the one built by the code generator like this

[Nicola]

about 1 I am using jvm 11 and got a warning could be it the problem?

[Nicola]

@dave sorry I have deleted the openapi part to test the rest, I will reproduce and paste the stack

[Andrew O'Hara]

Ok, looking back, I can see you've already done most of what I suggested, so David's suggestion to look through the stacktrace (or follow the debugger) is going to be the best way to find out why Jackson is being used

[dave]

sorry I have deleted the openapi part to test the rest, I will reproduce and paste the stack

IntelliJ local history is very good btw 🙂

[Nicola]

I get a compilation error, not a stack trace actually ....

[Nicola]

Intellij in the "Problems" view says:
Cannot access class 'org.http4k.format.ConfigurableJackson'. Check your module classpath for missing or conflicting dependencies

[Nicola]

In the tooltip IntelliJ show this:

public fun OpenApi3(
apiInfo: ApiInfo,
json: [Error type: Unresolved type for org.http4k.format.ConfigurableJackson],
extensions: List<OpenApiExtension>,
servers: List<ApiServer>,
version: OpenApiVersion
): OpenApi3<[Error type: Unresolved type for com.fasterxml.jackson.databind.JsonNode]

[Nicola]

It seems that my "moshiLite" is not visible

[dave]

you can try 2 things:

[dave]

1. include jackson for compileOnly

[dave]

(band aid)

[dave]

2. try to call that function manually by passing all of the args

[Nicola]

ook

[dave]

Not sure why it's not working - it shouldn't even reference the Jackson really

[Nicola]

maybe I have the wrong import? If I navigate to the definition of OpenApi3 in my project I land to jacksonExt.kt

[Nicola]

while, in the Andrew''s, I land to OpenApi3

[dave]

ah - you're calling the wrong overload

[Nicola]

ah ... but where ? 😢

[Nicola]

my build.gradle is this

[Nicola]

buildscript {
    repositories {
        mavenCentral()
        gradlePluginPortal()
    }
}

plugins {
    id "org.jetbrains.kotlin.jvm" version "${kotlinVersion}"
    id "com.github.johnrengelman.shadow" version "7.1.2"
    id "com.google.devtools.ksp" version "1.8.10-1.0.9"
}

apply plugin: "com.github.johnrengelman.shadow"
apply plugin: "java"

repositories {
    mavenCentral()
}

compileKotlin.kotlinOptions.jvmTarget = "11"
compileTestKotlin.kotlinOptions.jvmTarget = "11"

sourceCompatibility = JavaVersion.VERSION_11
targetCompatibility = JavaVersion.VERSION_11

test {
    useJUnitPlatform()
    testLogging.showStandardStreams = true
}

dependencies {
    implementation platform("org.http4k:http4k-bom:${http4kVersion}")
    implementation "org.http4k:http4k-core"
    implementation "org.http4k:http4k-serverless-lambda"
    implementation "org.http4k:http4k-cloudnative"
    implementation "org.http4k:http4k-contract"
    implementation("org.http4k:http4k-format-moshi") {
        exclude group: "org.jetbrains.kotlin", module: "kotlin-reflect"
    }
    implementation("se.ansman.kotshi:api:$kotshiVersion")
    ksp("se.ansman.kotshi:compiler:$kotshiVersion")

    implementation "org.http4k:http4k-opentelemetry:${http4kVersion}"
    implementation "org.apache.pdfbox:pdfbox:2.0.27"
    implementation "de.redsix:pdfcompare:1.1.61"
    implementation "net.sf.barcode4j:barcode4j:2.1"

    testImplementation platform("org.junit:junit-bom:${junitVersion}")
    testImplementation "org.http4k:http4k-testing-hamkrest"
    testImplementation "org.junit.jupiter:junit-jupiter-api"
    testImplementation "org.junit.jupiter:junit-jupiter-engine"
}

shadowJar {
    manifest.attributes['Main-Class'] = 'it.multidialogo.multiprinter.MultiprinterKt'
    archiveBaseName.set("multiprinter")
    archiveClassifier.set(null)
    archiveVersion.set(null)
    mergeServiceFiles()
}

task buildZip(type: Zip) {
    from compileKotlin
    from processResources
    into('lib') {
        from configurations.compileClasspath
    }
}

[Nicola]

imports where I have the problem are these:

import com.squareup.moshi.JsonAdapter
import com.squareup.moshi.Moshi
import it.multidialogo.multiprinter.domain.Payment
import it.multidialogo.multiprinter.domain.PaymentParty
import it.multidialogo.multiprinter.domain.PaymentType
import it.multidialogo.multiprinter.dto.MemoryMetricsDto
import it.multidialogo.multiprinter.dto.PaymentRenderRequestDto
import it.multidialogo.multiprinter.dto.PaymentRenderResponseDto
import it.multidialogo.multiprinter.dto.RenderMetricsDto
import it.multidialogo.multiprinter.services.RenderService
import it.multidialogo.multiprinter.utils.RenderMetricsDurationMillisAdapter
import org.http4k.cloudnative.env.Environment
import org.http4k.cloudnative.env.EnvironmentKey
import org.http4k.contract.contract
import org.http4k.contract.meta
import org.http4k.contract.openapi.ApiInfo
import org.http4k.contract.openapi.v3.OpenApi3
import org.http4k.contract.openapi.v3.OpenApi3ApiRenderer
import org.http4k.core.*
import org.http4k.core.Status.Companion.ACCEPTED
import org.http4k.format.*
import org.http4k.lens.Lens
import <http://org.http4k.lens.int|org.http4k.lens.int>
import org.http4k.lens.string
import org.http4k.routing.routes
import org.http4k.server.SunHttp
import org.http4k.server.asServer
import se.ansman.kotshi.KotshiJsonAdapterFactory

[Nicola]

I don't see jackson 🤔

[dave]

jackson isn't in there.

[dave]

but the contract stuff ships with some bindings which will automatically pick up and use the definitions in jacksonExt.kt, The overloaded function looks like the OpenApi constructor

[dave]

fun OpenApi3(....)

[dave]

if you make sure to pass all of the args to the ORIGINAL OpenApi3 function, it will pick up the correct one

[Nicola]

I am using the same parameters of the other project ... I will try anyway thaks a lot!

[Nicola]

there is a (big) difference though ...
one is a class, jackson version is a fun

[Nicola]

this is the jacksonExt:

fun OpenApi3(
    apiInfo: ApiInfo,
    json: ConfigurableJackson = OpenAPIJackson,
    extensions: List<OpenApiExtension> = emptyList(),
    servers: List<ApiServer> = emptyList(),
    version: OpenApiVersion = OpenApiVersion._3_0_0
) =
    OpenApi3(apiInfo, json, extensions, ApiRenderer.Auto(json, AutoJsonToJsonSchema(json)), servers = servers, version = version)

[Nicola]

the "working" version is this

class OpenApi3<NODE : Any>(
    private val apiInfo: ApiInfo,
    private val json: Json<NODE>,
    private val extensions: List<OpenApiExtension> = emptyList(),
    private val apiRenderer: ApiRenderer<Api<NODE>, NODE> = OpenApi3ApiRenderer(json),
    // note that this is the basic OpenApi renderer - if you want reflective Schema generation
    // then you want to use ApiRenderer.Auto() instead with a compatible JSON instance
    private val securityRenderer: SecurityRenderer = OpenApi3SecurityRenderer,
    private val errorResponseRenderer: ErrorResponseRenderer = JsonErrorResponseRenderer(json),
    private val servers: List<ApiServer> = emptyList(),
    private val version: OpenApiVersion = _3_0_0
) : ContractRenderer, ErrorResponseRenderer by errorResponseRenderer {

[dave]

I wonder if it's because you're using named parameters?

[Andrew O'Hara]

The arguments in their first example look the same as mine... not sure why the jackson overload is being called

[Nicola]

I've tried in this form

renderer = OpenApi3<MoshiNode>(
    ApiInfo("Renderer API", "0.0.1"),
    moshiLite,
    OpenApi3ApiRenderer(moshiLite)
)

but still the jackson version is catched first

[dave]

version of Java? version of Kotlin? The key will be to call a version of the function which isn't handled by the JacksonExt.kt

[Nicola]

java 11 I've tried 1.8 too but with same results

[Nicola]

I will try, there are some parameters that are in the not-jackson version only

[dave]

that should definitely work. Are you working on windows/mac/linux?

[Andrew O'Hara]

What version of http4k are you using? It's not defined in your gradle file.

[Nicola]

forcing securityRenderer (which does not exist in the jackson version) it works:

renderer = OpenApi3(
    apiInfo = ApiInfo("Renderer API", "0.0.1"),
    json = moshiLite,
    apiRenderer = OpenApi3ApiRenderer(moshiLite),
    securityRenderer = OpenApi3SecurityRenderer
)

[Nicola]

I am working on ubuntu 18.04

[Nicola]

junitVersion=5.7.2
kotlinVersion=1.8.10
http4kVersion=4.41.0.0
kotshiVersion=2.10.2

[Andrew O'Hara]

Bizarre. Forcing apiRenderer should have worked, because it's not even an option for the Jackson overload. But glad it's working for you now 🤷

[Nicola]

I will re-try removing securityRenderer, but maybe tomorrow 🙂 thanks a lot again

[Nicola]

Not sure it may be a useful information but I think the problem was that I was using
http4k 4.41.0.0
updating to
4.41.1.0 solves the problem (i have the right overload without adding securityRenderer)

[dave]

I've no idea what changed, but "always be updatin'!" 😂

[dave]

it could have just been clearing gradle/build caches would have done it. Sometimes I get the impression that all may not be totally deterministic around this stuff.. 😉