OpenAPI Filter force its order to prevent flickering

[melloware]

Because this just uses the default priority = 1 and so does the Health API they can flicker back and forth in the generated OpenAPI docs.

cc @phillip-kruger

[melloware]

@MikeEdgar @phillip-kruger i wonder if I should open a quarkus ticket? It would be great if the OpenApiFilter annotation was in the SPI so i don't have to do what I am doing in this PR.

I think we need to give the SmallRye Health the same treatment. If all filters are 1 we get "flickering" OpenAPI generation so it looks like it changes on every build with no code changes.

[MikeEdgar]

I think we need to give the SmallRye Health the same treatment. If all filters are 1 we get "flickering" OpenAPI generation so it looks like it changes on every build with no code changes.

Do you mean that they are running in random order because they have the same priority?

[MikeEdgar]

Why deployment? @OpenApiFilter is in the runtime library.

Suggested change

	<artifactId>quarkus-smallrye-openapi-deployment</artifactId>
	<artifactId>quarkus-smallrye-openapi</artifactId>

[gastaldi]

Deployment modules usually depend on other extension's deployment modules

[melloware]

Correct so I use both this extension and SmallRye Health which both add OASFilter with no annotation. So they get priority=1 and it looks like the Quarkus Extension just processes then in priority order which seems to "flicker" when they are all the same priority. Maybe it could secondarily by name?

private List<String> getUserDefinedFilters(IndexView index, OpenApiFilter.RunStage stage) {
        EnumSet<OpenApiFilter.RunStage> stages = EnumSet.of(OpenApiFilter.RunStage.BOTH, stage);
        Comparator<Object> comparator = Comparator
                .comparing(x -> ((AnnotationInstance) x).valueWithDefault(index, "priority").asInt())
                .reversed();
        return index
                .getAnnotations(OpenApiFilter.class)
                .stream()
                .filter(ai -> stages.contains(OpenApiFilter.RunStage.valueOf(ai.valueWithDefault(index).asEnum())))
                .sorted(comparator)
                .map(ai -> ai.target().asClass())
                .filter(c -> c.interfaceNames().contains(DotName.createSimple(OASFilter.class.getName())))
                .map(c -> c.name().toString())
                .collect(Collectors.toCollection(ArrayList::new));
    }

[MikeEdgar]

Maybe it could secondarily by name?

Yeah, adding the fully-qualified class name to that comparator seems reasonable to me.

[melloware]

OK that would be better than me hacking around! Let me submit a PR to Quarkus

[melloware]

PR submitted: quarkusio/quarkus#47779