FISH-1315 Improve loading time for REST application when there are many password aliases #5177

[AngelTG2]

ISSUE 5177 - Load of REST application is very slow (120 seconds) when there are many password aliases created

Description

This is a fix for the issue #5177
Load of REST application is very slow (120 seconds) when there are many password aliases created.

In this situation (800 password aliases), the cause of this slowness is that Microprofile OpenAPI reads the Microprofile Config when register an application in OpenAPI. PasswordAlias is a config source and it's necessary to read the keystore that is a taxing process if there are many password aliases.

One possible solution to resolve this issue is disable OpenAPI, but disabling OpenAPI seems that only affect to publish /openapi url. OpenAPI service is started even if OpenAPI is disabled and always register the application causing the slowness.

In this PR I've changed the registerApp method of OpenService class to prepare the document only if OpenAPI is enabled. With this modification, instead of taking 130 seconds to load an application it only takes less than 6.

Instead of modifying OpenAPIService class, the OpenApiApplicationContainer class could have been modified to avoid calling OpenApiService, but I thought it could have other side effects.

Important Info

Blockers

Testing

New tests

Testing Performed

Testing Environment

Documentation

Notes for Reviewers

[AlanRoth]

jenkins test please

[smillidge]

This is not really a comment on this PR as I understand what it is achieving but the fact that OpenAPI is loading all ConfigProperties at boot is a bug in itself as this could have a big performance impact on many ConfigSources and some people will want both OpenAPI and a slow config source or a source with many keys.

[AngelTG2]

@smillidge, I think you are right.

I was trying to find a solution to my problem, but probably some people need both OpenAPI and slow config sources.

It seems that OpenAPIConfiguration only needs several properties (mp.openapi.model.reader, mp.openapi.filter, mp.openapi.scan.lib, mp.openapi.scan.disable, mp.openapi.scan.packages, mp.openapi.scan.classes, mp.openapi.scan.exclude.packages, mp.openapi.scan.exclude.classes, mp.openapi.servers, mp.openapi.servers.path.* , mp.openapi.servers.operation.* and mp.openapi.schema.*)

I'm newbie in Microprofile and OpenAPI, so I ignore if these properties can be stored in a concrete config source or can be stored anywhere. If it can be stored anywhere, I can't think of any way to extract those properties without first reading all the config sources.

[smillidge]

If OpenAPI is just looking for specific properties. That isn't of itself a bug, if it is loading all properties that would be. The Password Alias config source probably needs a review to ensure it is performant.

[AngelTG2]

I've reviewed the password alias config source:

• The slowest part of password aliases processing is getting the value. Getting the alias name is very fast.

• OpenApiConfiguration constructor calls method getPropertyNames() of PayaraConfig class
  

  Payara/appserver/payara-appserver-modules/microprofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/config/OpenApiConfiguration.java

  Line 101 in f3d70f8

  for (String propertyName : config.getPropertyNames()) {

• getPropertyNames() in PayaraConfig calls configSource.getProperties().keySet() of PasswordAliasConfigSource instead configSource.getPropertyNames() forcing all the properties (property names and values) to be read and slowing the process
  

  Payara/nucleus/payara-modules/nucleus-microprofile/config-service/src/main/java/fish/payara/nucleus/microprofile/config/spi/PayaraConfig.java

  Line 195 in f3d70f8

  result.addAll(configSource.getProperties().keySet());

• PayaraConfigSource implements the method getPropertyNames() as "return getProperties().keySet()", so if instead of calling getProperties().keySet() from PayaraConfig the method getPropertyNames() is called, the result will be same as up to now and it will not break anything
  

  Payara/nucleus/payara-modules/nucleus-microprofile/config-service/src/main/java/fish/payara/nucleus/microprofile/config/source/PayaraConfigSource.java

  Line 77 in f3d70f8

  return getProperties().keySet();

• If method getPropertyNames() is overwritten in PasswordAliasConfigSource with the following code to read only the alias name (not the value), then all run faster.
  I've checked it and the test application is loaded only in 2 seconds with OpenAPI enabled instead of 130 seconds

    @Override
    public Set<String> getPropertyNames() {
        Set<String> propertyNames = new HashSet<>();
        if (store != null) {
            Iterator<String> keys = store.keys();
            while (keys.hasNext()){
                String key = keys.next();
                propertyNames.add(key);
            }
        }
        return propertyNames;
    }

[smillidge]

@AngelTG2 thanks for the detailed analysis. This sounds similar to the problem described here #5187? Do you want to make a PR for the change you mention as it sounds reasonable?

[AngelTG2]

@smillidge, I think the problem is similar to #5187
I've make a new commit (fixes #5177 v2).
I've reverted the changes in OpenApiService.java but I have corrected the indentation problems

[AlanRoth]

jenkins test please

[lprimak]

@AngelTG2 I figured it would be easier to change myself than to explain :) Let me know if you are ok with this.

[lprimak]

jenkins test

[AngelTG2]

@lprimak. Perfect. I also think it will be faster that way. Thank you

[lprimak]

Jenkins test