FISH-7965 OpenAPI endpoint crashes on duplicate types

[ghunteranderson]

Description

This PR addresses GitHub issue #6369 (FISH-7965).

When the MicroProfile OpenAPI implementation is scanning for types, the same type may be discovered multiple times; I assume its class file is found in multiple jars. Payara attempts to store this list of types in a map indexed by type name. However, since the same type name appears more than once in the list, an exception is thrown and no OpenAPI spec is built.

I believe the bug was introduced in #6256 (FISH-6980) when the MicroProfile OpenAPI scanner was modified to scan libraries in the web archive.

I've implemented the solution suggested by issue author marcinpaton. That is, when duplicate types are found, one is discarded. It is not specified which type will be selected; only that exactly one will be used. I don't know if its possible to determine which type should be used. However, with the current behavior (HTTP 500), this feels like a step in the right direction.

Testing

New tests

No new automated tests were added.

Author of issue #6369 provided a reproducer.

Testing Performed

1. Build master branch of Payara with command mvn clean package
2. Deploy application using Payara Micro.
3. Request GET /openapi. Observe error.
4. Build branch with bug fix with command mvn clean package
5. Deploy same application using Payara Micro.
6. Request GET /openapi. Observe correct OpenAPI spec.

Testing Environment

• Zulu JDK 11.0.21
• Maven 3.9.5
• Ubuntu 20.04.6 virtualized with WSL2

[pdurbin]

@ghunteranderson it's exciting that you've come up with a fix! Do you happen to have a build of Payara that we can test? (I've never built it myself.) Thanks!

[aubi]

It looks good! I restarted the failed build (temporal issue).

[aubi]

Hi @pdurbin,
if you want to try it yourself, compiling Payara Community is quite simple:

https://docs.payara.fish/community/docs/General%20Info/Build%20Instructions.html

Short answer:

JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 mvn clean install -T 16 -PQuickBuild -DskipTests

[pdurbin]

@aubi thanks it seems to have built fine. I left some notes but I haven't had a chance to test /openapi yet.

[luiseufrasio]

This fix was already done by @Pandrex247 in this PR: https://github.com/payara/Payara/pull/6546/files#diff-fd6fa43e67a8b0cfea20fe6c5d96814ce749d4fa436d44f9d2d96b2c21df5e4f