OpenAPI router works with quarkus dev, fails in native image #44664

Stwissel · 2024-11-22T22:50:47Z

Stwissel
Nov 22, 2024

I'm trying to integrate the vert.x OpenAPI Router into a Quarkus Native app. I obtain the router object and mount the result of the OpenAPI as sub router.

// Paraphrasing here
public void init(@Observes Router rootRouter) {
OpenAPIContract.from(vertx, spec)
   .onSuccess(contract -> {
       Router router = RouterBuilder.create(vertx, contract).createRouter()
     rootRouter.route("/api").subRouter(router);
   });
}

Works like a charm. Until I tried to pack it in a native container with jib and quarkus-micro-image:2.0.

When I run it, it fails with an error:

2024-11-22 22:32:19,823 FATAL [com.bey.ope.OpenApiLoader] (vert.x-eventloop-thread-2) Could not load OpenAPI spec: io.vertx.openapi.contract.OpenAPIContractException: The passed OpenAPI contract is invalid: Found issue in specification for reference: Unable to read file at path 'json-schema.org/draft/2020-12/schema'
	at io.vertx.openapi.contract.OpenAPIContract.lambda$from$10(OpenAPIContract.java:140)

Interestingly https://son-schema.org/draft/2020-12/schema is a working URL. So it seems the OpenAPI router wants to call out and can't from the container?

What do I miss?

@EricWittmann · 2024-11-22T22:50:50Z

quarkus-bot[bot]
bot Nov 22, 2024

/cc @EricWittmann (openapi), @MikeEdgar (openapi), @geoand (jib), @phillip-kruger (openapi), @zakkak (native-image)

0 replies

Stwissel · 2024-11-22T23:16:18Z

Stwissel
Nov 22, 2024
Author

Update: the issue seems with the native executable, When I start the runner in target, I get the same error:

2024-11-23 07:11:55,273 ERROR [com.bey.ver.VerticleLauncher] (vert.x-eventloop-thread-2) java.lang.RuntimeException: No valid path to config found
2024-11-23 07:11:55,273 FATAL [com.bey.ope.OpenApiLoader] (vert.x-eventloop-thread-2) Could not load OpenAPI spec: io.vertx.openapi.contract.OpenAPIContractException: The passed OpenAPI contract is invalid: Found issue in specification for reference: Unable to read file at path 'json-schema.org/draft/2020-12/schema'
	at io.vertx.openapi.contract.OpenAPIContract.lambda$from$10(OpenAPIContract.java:140)
	at io.vertx.core.impl.future.Composition.onFailure(Composition.java:50)
	at io.vertx.core.impl.future.FutureBase.emitFailure(FutureBase.java:81)
	at io.vertx.core.impl.future.FutureImpl.tryFail(FutureImpl.java:278)
	at io.vertx.core.impl.future.Composition$1.onFailure(Composition.java:66)
	at io.vertx.core.impl.future.FutureBase.emitFailure(FutureBase.java:81)
	at io.vertx.core.impl.future.FailedFuture.addListener(FailedFuture.java:98)
	at io.vertx.core.impl.future.Composition.onFailure(Composition.java:55)
	at io.vertx.core.impl.future.FutureBase.emitFailure(FutureBase.java:81)
	at io.vertx.core.impl.future.FutureImpl.tryFail(FutureImpl.java:278)
	at io.vertx.core.impl.future.Composition$1.onFailure(Composition.java:66)
	at io.vertx.core.impl.future.FutureBase.emitFailure(FutureBase.java:81)
	at io.vertx.core.impl.future.FailedFuture.addListener(FailedFuture.java:98)
	at io.vertx.core.impl.future.Composition.onFailure(Composition.java:55)
	at io.vertx.core.impl.future.FutureBase.lambda$emitFailure$1(FutureBase.java:75)
	at io.netty.util.concurrent.AbstractEventExecutor.runTask(AbstractEventExecutor.java:173)
	at io.netty.util.concurrent.AbstractEventExecutor.safeExecute(AbstractEventExecutor.java:166)
	at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks(SingleThreadEventExecutor.java:469)
	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:569)
	at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:994)
	at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
	at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
	at [email protected]/java.lang.Thread.runWith(Thread.java:1596)
	at [email protected]/java.lang.Thread.run(Thread.java:1583)
	at org.graalvm.nativeimage.builder/com.oracle.svm.core.thread.PlatformThreads.threadStartRoutine(PlatformThreads.java:896)
	at org.graalvm.nativeimage.builder/com.oracle.svm.core.thread.PlatformThreads.threadStartRoutine(PlatformThreads.java:872)
Caused by: io.vertx.core.file.FileSystemException: Unable to read file at path 'json-schema.org/draft/2020-12/schema'
	at io.vertx.core.file.impl.FileSystemImpl$16.perform(FileSystemImpl.java:1070)
	at io.vertx.core.file.impl.FileSystemImpl$16.perform(FileSystemImpl.java:1063)
	at io.vertx.core.file.impl.FileSystemImpl.readFileBlocking(FileSystemImpl.java:418)
	at io.vertx.json.schema.impl.SchemaRepositoryImpl.preloadMetaSchema(SchemaRepositoryImpl.java:157)
	at io.vertx.json.schema.impl.SchemaRepositoryImpl.preloadMetaSchema(SchemaRepositoryImpl.java:132)
	at io.vertx.openapi.contract.OpenAPIVersion.lambda$getRepository$5(OpenAPIVersion.java:117)
	at io.vertx.core.impl.ContextImpl.lambda$executeBlocking$4(ContextImpl.java:192)
	at io.vertx.core.impl.ContextInternal.dispatch(ContextInternal.java:270)
	at io.vertx.core.impl.ContextImpl$1.execute(ContextImpl.java:221)
	at io.vertx.core.impl.WorkerTask.run(WorkerTask.java:56)
	at io.vertx.core.impl.TaskQueue.run(TaskQueue.java:81)
	at io.quarkus.vertx.core.runtime.VertxCoreRecorder$14.runWith(VertxCoreRecorder.java:632)
	at org.jboss.threads.EnhancedQueueExecutor$Task.doRunWith(EnhancedQueueExecutor.java:2675)
	at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2654)
	at org.jboss.threads.EnhancedQueueExecutor.runThreadBody(EnhancedQueueExecutor.java:1627)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1594)
	at org.jboss.threads.DelegatingRunnable.run(DelegatingRunnable.java:11)
	at org.jboss.threads.ThreadLocalResettingRunnable.run(ThreadLocalResettingRunnable.java:11)
	... 5 more
Caused by: java.nio.file.NoSuchFileException: json-schema.org/draft/2020-12/schema
	at [email protected]/sun.nio.fs.UnixFileSystemProvider.newByteChannel(UnixFileSystemProvider.java:261)
	at [email protected]/java.nio.file.Files.newByteChannel(Files.java:379)
	at [email protected]/java.nio.file.Files.newByteChannel(Files.java:431)
	at [email protected]/java.nio.file.Files.readAllBytes(Files.java:3268)
	at io.vertx.core.file.impl.FileSystemImpl$16.perform(FileSystemImpl.java:1067)
	... 22 more

1 reply

Stwissel Nov 23, 2024
Author

Building a classic Java container works (It's just 3x bigger). Must be something in the lib that trips mandrel

gsmet · 2024-11-23T09:42:25Z

gsmet
Nov 23, 2024
Maintainer

I had a look and the problem is that you need to have the files in the json-schema.org/ directory around at runtime, and by default native executables will strip down anything they think is useless.

That's why we have Quarkus extensions: we tweak the native image building configuration.

Given we don't have an extension for this component, you need to tweak it yourself. See https://quarkus.io/guides/writing-native-applications-tips#including-resources to know how you can easily include additional resources with a pattern. Just include anything in the json-schema.org/ directory.

Note that it will solve this particular issue, there might be others.

7 replies

gsmet Nov 23, 2024
Maintainer

Yeah, it will work for dependencies too: it's applied to the entire classpath. Just add it to your application.properties.

The path is relative to the root of the classpath so something like quarkus.native.resources.includes=json-schema.org/** should work.

Stwissel Nov 23, 2024
Author

if I use the YAML format would it be:

quarkus:
  native:
    resources:
      includes: json-schema.org/**,someother/**/*.json

or

quarkus:
  native:
    resources:
      includes:
       - json-schema.org/**
       - someother/**/*.json

Btw THX for helping

gsmet Nov 23, 2024
Maintainer

I would think the former.

Stwissel Nov 23, 2024
Author

Something is off in my setup. I tried:

the two yaml versions
application.properties

Verified that the values were picked up:

But they don't get picked up. I also checked with a file in resources - same issue, doesn't get picked up

Stwissel Nov 23, 2024
Author

Created a reproducer.
https://github.com/beyonddemise/code-with-quarkus/

http://localhost:8080/hello/world works in quarkus dev but not in the native executable. Could jib be the issue?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OpenAPI router works with quarkus dev, fails in native image #44664

{{title}}

Replies: 3 comments 8 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

OpenAPI router works with quarkus dev, fails in native image #44664

Stwissel Nov 22, 2024

Replies: 3 comments · 8 replies

quarkus-bot[bot] bot Nov 22, 2024

Stwissel Nov 22, 2024 Author

Stwissel Nov 23, 2024 Author

gsmet Nov 23, 2024 Maintainer

gsmet Nov 23, 2024 Maintainer

Stwissel Nov 23, 2024 Author

gsmet Nov 23, 2024 Maintainer

Stwissel Nov 23, 2024 Author

Stwissel Nov 23, 2024 Author

Stwissel
Nov 22, 2024

Replies: 3 comments 8 replies

quarkus-bot[bot]
bot Nov 22, 2024

Stwissel
Nov 22, 2024
Author

Stwissel Nov 23, 2024
Author

gsmet
Nov 23, 2024
Maintainer

gsmet Nov 23, 2024
Maintainer

Stwissel Nov 23, 2024
Author

gsmet Nov 23, 2024
Maintainer

Stwissel Nov 23, 2024
Author

Stwissel Nov 23, 2024
Author