Got UnsupportedOperationException if methods of OASFilter return null

[code-d]

Got UnsupportedOperationException if methods of custom org.eclipse.microprofile.openapi.OASFilter impl return null

[error]: Build step io.quarkus.smallrye.openapi.deployment.SmallRyeOpenApiProcessor#build threw an exception: java.lang.UnsupportedOperationException
	at java.base/java.util.Collections$UnmodifiableMap.remove(Collections.java:1460)
	at io.smallrye.openapi.api.util.FilterUtil.filterSchemas(FilterUtil.java:443)
	at io.smallrye.openapi.api.util.FilterUtil.filterComponents(FilterUtil.java:67)
	at io.smallrye.openapi.api.util.FilterUtil.applyFilter(FilterUtil.java:45)
	at io.smallrye.openapi.api.OpenApiDocument.filterModel(OpenApiDocument.java:168)
	at io.smallrye.openapi.api.OpenApiDocument.initialize(OpenApiDocument.java:128)
	at io.quarkus.smallrye.openapi.deployment.SmallRyeOpenApiProcessor.loadDocument(SmallRyeOpenApiProcessor.java:471)
	at io.quarkus.smallrye.openapi.deployment.SmallRyeOpenApiProcessor.build(SmallRyeOpenApiProcessor.java:282)
	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 io.quarkus.deployment.ExtensionLoader$2.execute(ExtensionLoader.java:936)
	at io.quarkus.builder.BuildContext.run(BuildContext.java:277)
	at org.jboss.threads.ContextClassLoaderSavingRunnable.run(ContextClassLoaderSavingRunnable.java:35)
	at org.jboss.threads.EnhancedQueueExecutor.safeRun(EnhancedQueueExecutor.java:2046)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.doRunTask(EnhancedQueueExecutor.java:1578)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1452)
	at java.base/java.lang.Thread.run(Thread.java:834)
	at org.jboss.threads.JBossThread.run(JBossThread.java:479)

io.smallrye.openapi.api.util.FilterUtil class has bug

[phillip-kruger]

Hi @code-d . Thanks for the issue. So are you trying to remove something from the generated Model ? Or why is the filter returning null ? Can you post a small reproducer ?

[MikeEdgar]

I took a quick look at this one and I think it's because some places in FilterUtil are operating directly on the Maps returned from the OpenAPI interfaces. For example, filterCallbacks removes from the map of callbacks, but instead should be using Components#removeCallback (or whatever the other parent model is based on context, since each method may be called from several locations in the utility). Returning null from a filter method is the signal to remove it from the containing model.

smallrye-open-api/core/src/main/java/io/smallrye/openapi/api/util/FilterUtil.java

Lines 78 to 89 in 9045653

	private static void filterCallbacks(OASFilter filter, Map<String, Callback> models) {
	if (models != null) {
	Collection<String> keys = new ArrayList<>(models.keySet());
	for (String key : keys) {
	Callback model = models.get(key);
	filterCallback(filter, model);
	if (filter.filterCallback(model) == null) {
	models.remove(key);
	}
	}
	}
	}

[phillip-kruger]

Thanks @MikeEdgar - that sounds fixable.

[phillip-kruger]

@MikeEdgar - are you looking at this ?

[MikeEdgar]

@MikeEdgar - are you looking at this ?

@phillip-kruger I haven't started anything yet. I might not have time until late this week.