28857 openapi include exclude

dev/fattest.simplicity/src/componenttest/topology/impl/LibertyServer.java

@@ -1094,7 +1094,7 @@ public void refreshServerXMLFromPublish() throws Exception {
     /**
      * Swaps in a different server.xml file from the server directory.
      *
-     * @param  fileName
+     * @param  fileName  the name of a server.xml file found in the wlp/usr/[server]/ directory
      * @throws Exception
      */
     public void swapInServerXMLFromPublish(String fileName) throws Exception {

dev/io.openliberty.microprofile.openapi.2.0.internal/bnd.bnd

@@ -1,5 +1,5 @@
 #*******************************************************************************
-# Copyright (c) 2020, 2024 IBM Corporation and others.
+# Copyright (c) 2020, 2022 IBM Corporation and others.
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License 2.0
 # which accompanies this distribution, and is available at
@@ -55,7 +55,8 @@ IBM-Default-Config: OSGI-INF/wlp/defaultInstances.xml
     io.openliberty.microprofile.openapi20.internal.css.CustomCSSProcessor,\
     io.openliberty.microprofile.openapi20.internal.DefaultHostListenerImpl,\
     io.openliberty.microprofile.openapi20.internal.cache.ConfigSerializer,\
-    io.openliberty.microprofile.openapi20.internal.validation.OASValidator30Impl
+    io.openliberty.microprofile.openapi20.internal.validation.OASValidator30Impl,\
+    io.openliberty.microprofile.openapi20.internal.ModuleSelectionConfigImpl
 
 WS-TraceGroup: MPOPENAPI
 

dev/io.openliberty.microprofile.openapi.2.0.internal/src/io/openliberty/microprofile/openapi20/internal/ApplicationProcessor.java

@@ -48,6 +48,7 @@
 import io.openliberty.microprofile.openapi20.internal.cache.ConfigSerializer;
 import io.openliberty.microprofile.openapi20.internal.services.ConfigFieldProvider;
 import io.openliberty.microprofile.openapi20.internal.services.ModelGenerator;
+import io.openliberty.microprofile.openapi20.internal.services.ModuleSelectionConfig;
 import io.openliberty.microprofile.openapi20.internal.services.OpenAPIProvider;
 import io.openliberty.microprofile.openapi20.internal.utils.Constants;
 import io.openliberty.microprofile.openapi20.internal.utils.IndexUtils;

dev/io.openliberty.microprofile.openapi.2.0.internal/src/io/openliberty/microprofile/openapi20/internal/ApplicationRegistryImpl.java

@@ -19,7 +19,6 @@
 import java.util.Map.Entry;
 import java.util.Objects;
 
-import org.eclipse.microprofile.config.ConfigProvider;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.ConfigurationPolicy;
 import org.osgi.service.component.annotations.Reference;
@@ -36,10 +35,12 @@
 import com.ibm.ws.kernel.feature.ServerStartedPhase2;
 import com.ibm.wsspi.kernel.service.utils.FrameworkState;
 
+import io.openliberty.microprofile.openapi.internal.common.services.OpenAPIAppConfigProvider;
+import io.openliberty.microprofile.openapi.internal.common.services.OpenAPIAppConfigProvider.OpenAPIAppConfigListener;
 import io.openliberty.microprofile.openapi20.internal.services.ApplicationRegistry;
 import io.openliberty.microprofile.openapi20.internal.services.MergeProcessor;
+import io.openliberty.microprofile.openapi20.internal.services.ModuleSelectionConfig;
 import io.openliberty.microprofile.openapi20.internal.services.OpenAPIProvider;
-import io.openliberty.microprofile.openapi20.internal.utils.Constants;
 import io.openliberty.microprofile.openapi20.internal.utils.LoggingUtils;
 import io.openliberty.microprofile.openapi20.internal.utils.MessageConstants;
 import io.openliberty.microprofile.openapi20.internal.utils.ModuleUtils;
@@ -52,8 +53,8 @@
  * OpenAPI documentation is generated for each web module and then merged together if merging is enabled. If merging is not enabled,
  * then documentation is only generated for the first web module found.
  */
-@Component(configurationPolicy = ConfigurationPolicy.IGNORE, service = ApplicationRegistry.class)
-public class ApplicationRegistryImpl implements ApplicationRegistry {
+@Component(configurationPolicy = ConfigurationPolicy.IGNORE)
+public class ApplicationRegistryImpl implements ApplicationRegistry, OpenAPIAppConfigProvider.OpenAPIAppConfigListener {
 
     private static final TraceComponent tc = Tr.register(ApplicationRegistryImpl.class);
 
@@ -66,13 +67,33 @@ public class ApplicationRegistryImpl implements ApplicationRegistry {
     @Reference
     private MergeProcessor mergeProcessor;
 
+    @SuppressWarnings("unused")
+    private OpenAPIAppConfigProvider openAPIAppConfigProvider;
+
+    @Reference(cardinality = ReferenceCardinality.MANDATORY, policy = ReferencePolicy.STATIC, unbind = "unbindAppConfigListener")
+    public void bindAppConfigListener(OpenAPIAppConfigProvider openAPIAppConfigProvider) {
+        this.openAPIAppConfigProvider = openAPIAppConfigProvider;
+        openAPIAppConfigProvider.registerAppConfigListener(this);
+    }
+
+    public void unbindAppConfigListener(OpenAPIAppConfigProvider openAPIAppConfigProvider) {
+        openAPIAppConfigProvider.unregisterAppConfigListener(this);
+        this.openAPIAppConfigProvider = null;
+    }
+
+    @Reference
+    public void bindOpenAPIAppConfigProvider(OpenAPIAppConfigProvider openAPIAppConfigProvider) {
+        this.openAPIAppConfigProvider = null;
+        openAPIAppConfigProvider.registerAppConfigListener(this);
+    }
+
     // Thread safety: access to these fields must be synchronized on this
-    private final Map<String, ApplicationRecord> applications = new LinkedHashMap<>(); // Linked map retains order in which applications were added
+    private Map<String, ApplicationRecord> applications = new LinkedHashMap<>(); // Linked map retains order in which applications were added
 
     private OpenAPIProvider cachedProvider = null;
 
-    // Lazily initialized, use getModuleSelectionConfig() instead
-    private ModuleSelectionConfig moduleSelectionConfig = null;
+    @Reference
+    private ModuleSelectionConfig moduleSelectionConfig;
 
     /**
      * The addApplication method is invoked by the {@link ApplicationListener} when it is notified that an application
@@ -95,13 +116,13 @@ public void addApplication(ApplicationInfo newAppInfo) {
 
             OpenAPIProvider firstProvider = getFirstProvider();
 
-            if (getModuleSelectionConfig().useFirstModuleOnly() && firstProvider != null) {
+            if (moduleSelectionConfig.useFirstModuleOnly() && firstProvider != null) {
                 if (LoggingUtils.isEventEnabled(tc)) {
                     Tr.event(this, tc, "Application Processor: useFirstModuleOnly is configured and we already have a module. Not processing. appInfo=" + newAppInfo);
                 }
                 mergeDisabledAlerter.setUsingMultiModulesWithoutConfig(firstProvider);
             } else {
-                Collection<OpenAPIProvider> openApiProviders = applicationProcessor.processApplication(newAppInfo, getModuleSelectionConfig());
+                Collection<OpenAPIProvider> openApiProviders = applicationProcessor.processApplication(newAppInfo, moduleSelectionConfig);
 
                 if (!openApiProviders.isEmpty()) {
                     // If the new application has any providers, invalidate the model cache
@@ -139,15 +160,15 @@ public void removeApplication(ApplicationInfo removedAppInfo) {
                 // If the removed application had any providers, invalidate the provider cache
                 cachedProvider = null;
 
-                if (getModuleSelectionConfig().useFirstModuleOnly() && !FrameworkState.isStopping()) {
+                if (moduleSelectionConfig.useFirstModuleOnly() && !FrameworkState.isStopping()) {
                     if (LoggingUtils.isEventEnabled(tc)) {
                         Tr.event(this, tc, "Application Processor: Current OpenAPI application removed, looking for another application to document.");
                     }
 
                     // We just removed the module used for the OpenAPI document and the server is not shutting down.
                     // We need to find a new module to use if there is one
                     for (ApplicationRecord app : applications.values()) {
-                        Collection<OpenAPIProvider> providers = applicationProcessor.processApplication(app.info, getModuleSelectionConfig());
+                        Collection<OpenAPIProvider> providers = applicationProcessor.processApplication(app.info, moduleSelectionConfig);
                         if (!providers.isEmpty()) {
                             app.providers.addAll(providers);
                             break;
@@ -192,9 +213,7 @@ protected void setServerStartPhase2(ServerStartedPhase2 event) {
                     // Couldn't read this application for some reason, but that means we can't have been able to include modules from it anyway.
                 }
             }
-            for (String unmatchedInclude : getModuleSelectionConfig().findIncludesNotMatchingAnything(modules)) {
-                Tr.warning(tc, MessageConstants.OPENAPI_MERGE_UNUSED_INCLUDE_CWWKO1667W, Constants.MERGE_INCLUDE_CONFIG, unmatchedInclude);
-            }
+            moduleSelectionConfig.sendWarningsForIncludesNotMatchingAnything(modules);
         }
     }
 
@@ -254,19 +273,6 @@ private List<OpenAPIProvider> getProvidersToMerge() {
         }
     }
 
-    /**
-     * Thread safety: Caller must hold lock on {@code this}
-     *
-     * @return the module selection config
-     */
-    private ModuleSelectionConfig getModuleSelectionConfig() {
-        if (moduleSelectionConfig == null) {
-            // Lazy initialization to avoid calling getConfig() before Config is ready
-            moduleSelectionConfig = ModuleSelectionConfig.fromConfig(ConfigProvider.getConfig(ApplicationRegistryImpl.class.getClassLoader()));
-        }
-        return moduleSelectionConfig;
-    }
-
     /**
      * Thread safety: Caller must hold lock on {@code this}
      *
@@ -282,6 +288,18 @@ private OpenAPIProvider getFirstProvider() {
         return null;
     }
 
+    @Override
+    public synchronized void processConfigUpdate() {
+        Map<String, ApplicationRecord> oldApps = applications;
+        applications = new LinkedHashMap<>();
+        for (ApplicationRecord record : oldApps.values()) {
+            //Add application uses config to decide if it creates and registers any providers in ApplicationInfo
+            //Rather than map from the old state to the new state when the config changes, KISS and start again.
+            addApplication(record.info);
+        }
+        cachedProvider = null;
+    }
+
     private static class ApplicationRecord {
         public ApplicationRecord(ApplicationInfo info) {
             this.info = info;
@@ -291,4 +309,18 @@ public ApplicationRecord(ApplicationInfo info) {
         private final List<OpenAPIProvider> providers = new ArrayList<>();
     }
 
+    @Override
+    public int compareTo(OpenAPIAppConfigListener o) {
+        if (this == o || this.equals(o)) {
+            return 0;
+        } else {
+            return this.getConfigListenerPriority() - o.getConfigListenerPriority();
+        }
+    }
+
+    @Override
+    public int getConfigListenerPriority() {
+        return 2;
+    }
+
 }