fix: periodically update GW url (#1817)

* periodically update GW url

Signed-off-by: achmelo <a.chmelo@gmail.com>

* copy pluginDefinition.json

Signed-off-by: achmelo <a.chmelo@gmail.com>

* listen on spring cloud heartbeat

Signed-off-by: achmelo <a.chmelo@gmail.com>

* revert scheduling

Signed-off-by: achmelo <a.chmelo@gmail.com>

* fully initialize apicatalog only once

Signed-off-by: achmelo <a.chmelo@gmail.com>

Author: achmelo

api-catalog-package/build.gradle

@@ -19,6 +19,7 @@ task packageApiCatalog(type: Zip) {
 
     into('/') {
         from "$resourceDir/manifest.yaml"
+        from "$resourceDir/pluginDefinition.json"
     }
 
     into('plugin/') {

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/services/status/listeners/GatewayLookupEventListener.java

@@ -9,14 +9,16 @@
  */
 package org.zowe.apiml.apicatalog.services.status.listeners;
 
-import org.zowe.apiml.apicatalog.instance.InstanceInitializeService;
-import org.zowe.apiml.product.gateway.GatewayLookupCompleteEvent;
-import org.zowe.apiml.product.registry.CannotRegisterServiceException;
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.event.EventListener;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
 import org.springframework.stereotype.Component;
+import org.zowe.apiml.apicatalog.instance.InstanceInitializeService;
+import org.zowe.apiml.product.gateway.GatewayLookupCompleteEvent;
+import org.zowe.apiml.product.registry.CannotRegisterServiceException;
+
+import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
  * This class fires on GatewayLookupCompleteEvent event
@@ -28,14 +30,13 @@
 public class GatewayLookupEventListener {
 
     private final InstanceInitializeService instanceInitializeService;
+    private final AtomicBoolean hasRun = new AtomicBoolean(false);
 
-    /**
-     * Retrieves and registers all instances known to Eureka
-     *
-     * @param event Spring event
-     */
-    @EventListener
-    public void onApplicationEvent(GatewayLookupCompleteEvent event) throws CannotRegisterServiceException {
-        instanceInitializeService.retrieveAndRegisterAllInstancesWithCatalog();
+    @EventListener(GatewayLookupCompleteEvent.class)
+    public void onApplicationEvent() throws CannotRegisterServiceException {
+        if (!hasRun.get()) {
+            hasRun.set(true);
+            instanceInitializeService.retrieveAndRegisterAllInstancesWithCatalog();
+        }
     }
 }

api-catalog-services/src/test/java/org/zowe/apiml/apicatalog/services/status/listeners/GatewayLookupEventListenerTest.java

@@ -0,0 +1,30 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+package org.zowe.apiml.apicatalog.services.status.listeners;
+
+import org.junit.jupiter.api.Test;
+import org.zowe.apiml.apicatalog.instance.InstanceInitializeService;
+
+import static org.mockito.Mockito.*;
+
+class GatewayLookupEventListenerTest {
+
+    @Test
+    void retrieveAndRegisterAllInstancesWithCatalog_onlyOnce() throws Exception {
+        InstanceInitializeService instanceInitializeService = mock(InstanceInitializeService.class);
+        GatewayLookupEventListener gatewayLookupEventListener = new GatewayLookupEventListener(instanceInitializeService);
+        for (int i = 0; i < 10; i++) {
+            gatewayLookupEventListener.onApplicationEvent();
+        }
+        verify(instanceInitializeService, times(1)).retrieveAndRegisterAllInstancesWithCatalog();
+    }
+
+
+}

apiml-common/build.gradle

@@ -10,6 +10,7 @@ dependencies {
     compile libraries.janino
     compile libraries.xstream
 
+    implementation libraries.spring_cloud_commons
 
     compileOnly libraries.spring_boot_configuration_processor
     compileOnly libraries.lombok

apiml-common/src/main/java/org/zowe/apiml/product/gateway/GatewayInstanceInitializer.java

@@ -9,16 +9,16 @@
  */
 package org.zowe.apiml.product.gateway;
 
-import org.zowe.apiml.product.constants.CoreService;
-import org.zowe.apiml.product.instance.InstanceInitializationException;
-import org.zowe.apiml.product.instance.lookup.InstanceLookupExecutor;
 import com.netflix.appinfo.InstanceInfo;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.cloud.client.discovery.event.HeartbeatEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.event.EventListener;
 import org.zowe.apiml.message.log.ApimlLogger;
+import org.zowe.apiml.product.constants.CoreService;
+import org.zowe.apiml.product.instance.InstanceInitializationException;
+import org.zowe.apiml.product.instance.lookup.InstanceLookupExecutor;
 import org.zowe.apiml.product.logging.annotations.InjectApimlLogger;
 
 import java.net.URI;
@@ -36,7 +36,7 @@ public class GatewayInstanceInitializer {
     private final GatewayClient gatewayClient;
 
     @InjectApimlLogger
-    private ApimlLogger apimlLog = ApimlLogger.empty();
+    private final ApimlLogger apimlLog = ApimlLogger.empty();
 
     private GatewayConfigProperties process(InstanceInfo instanceInfo) {
         try {
@@ -53,15 +53,8 @@ private GatewayConfigProperties process(InstanceInfo instanceInfo) {
 
     }
 
-    /**
-     * EventListener method that starts the lookup for Gateway
-     * Listens for {@link ApplicationReadyEvent} to start the {@link InstanceLookupExecutor} and provides the processing logic for the executor
-     */
-    @EventListener(ApplicationReadyEvent.class)
+    @EventListener(HeartbeatEvent.class)
     public void init() {
-        if (gatewayClient.isInitialized()) {
-            return;
-        }
 
         log.info("GatewayInstanceInitializer starting asynchronous initialization of Gateway configuration");
 

apiml-common/src/main/java/org/zowe/apiml/product/instance/lookup/InstanceLookupExecutor.java

@@ -9,17 +9,14 @@
  */
 package org.zowe.apiml.product.instance.lookup;
 
-import org.zowe.apiml.product.instance.InstanceNotFoundException;
 import com.netflix.appinfo.InstanceInfo;
 import com.netflix.discovery.EurekaClient;
 import com.netflix.discovery.shared.Application;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.zowe.apiml.product.instance.InstanceNotFoundException;
 
 import java.util.List;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.TimeUnit;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 
@@ -31,19 +28,6 @@
 public class InstanceLookupExecutor {
 
     private final EurekaClient eurekaClient;
-    private final ScheduledExecutorService executorService =
-        Executors.newSingleThreadScheduledExecutor(r -> new Thread(r, "InstanceLookupExecutor-Thread"));
-    private final int initialDelay;
-    private final int period;
-
-    /**
-     * Constructor with predefined initial delay of 100ms and retry frequency of 5000ms
-     *
-     * @param eurekaClient EurekaClient to use for search
-     */
-    public InstanceLookupExecutor(EurekaClient eurekaClient) {
-        this(eurekaClient, 100, 5000);
-    }
 
     private InstanceInfo findEurekaInstance(String serviceId) {
         Application application = eurekaClient.getApplication(serviceId);
@@ -71,25 +55,19 @@ public void run(String serviceId,
                     BiConsumer<Exception, Boolean> handleFailureConsumer) {
         log.debug("Started instance finder");
 
-        executorService.scheduleAtFixedRate(
-            () -> {
-                try {
-                    InstanceInfo instanceInfo = findEurekaInstance(serviceId);
-                    log.debug("App found {}", instanceInfo.getAppName());
+        try {
+            InstanceInfo instanceInfo = findEurekaInstance(serviceId);
+            log.debug("App found {}", instanceInfo.getAppName());
 
-                    action.accept(instanceInfo);
-                    executorService.shutdownNow();
-                } catch (InstanceNotFoundException | RetryException e) {
-                    log.debug(e.getMessage());
-                    handleFailureConsumer.accept(e, false);
-                } catch (Exception e) {
-                    executorService.shutdownNow();
-                    handleFailureConsumer.accept(e, true);
-                    log.debug("Unexpected exception while retrieving '{}' service from Eureka", serviceId);
-                }
+            action.accept(instanceInfo);
+        } catch (InstanceNotFoundException | RetryException e) {
+            log.debug(e.getMessage());
+            handleFailureConsumer.accept(e, false);
+        } catch (Exception e) {
+            handleFailureConsumer.accept(e, true);
+            log.debug("Unexpected exception while retrieving '{}' service from Eureka", serviceId);
+        }
 
-            },
-            initialDelay, period, TimeUnit.MILLISECONDS
-        );
     }
+
 }

apiml-common/src/test/java/org/zowe/apiml/product/gateway/GatewayInstanceInitializerTest.java

@@ -9,8 +9,6 @@
  */
 package org.zowe.apiml.product.gateway;
 
-import org.zowe.apiml.product.constants.CoreService;
-import org.zowe.apiml.product.instance.lookup.InstanceLookupExecutor;
 import com.netflix.appinfo.InstanceInfo;
 import com.netflix.discovery.EurekaClient;
 import com.netflix.discovery.shared.Application;
@@ -23,14 +21,14 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
+import org.zowe.apiml.product.constants.CoreService;
+import org.zowe.apiml.product.instance.lookup.InstanceLookupExecutor;
 
 import java.util.Collections;
 
 import static java.time.Duration.ofMillis;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertTimeout;
-import static org.mockito.Mockito.*;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.when;
 
 @ExtendWith(SpringExtension.class)
 class GatewayInstanceInitializerTest {
@@ -62,9 +60,9 @@ void testInit() {
             when(
                 eurekaClient.getApplication(SERVICE_ID)
             ).thenReturn(application);
-    
+
             gatewayInstanceInitializer.init();
-    
+
             while (!gatewayClient.isInitialized()) ;
         });
 
@@ -77,9 +75,6 @@ void testInit() {
     @Configuration
     static class TestConfig {
 
-        private static final int INITIAL_DELAY = 1;
-        private static final int PERIOD = 10;
-
         @MockBean
         private EurekaClient eurekaClient;
 
@@ -91,9 +86,7 @@ public GatewayClient gatewayClient() {
         @Bean
         public InstanceLookupExecutor instanceLookupExecutor() {
             return new InstanceLookupExecutor(
-                eurekaClient,
-                INITIAL_DELAY,
-                PERIOD
+                eurekaClient
             );
         }
 

apiml-common/src/test/java/org/zowe/apiml/product/instance/lookup/InstanceLookupExecutorTest.java

@@ -9,9 +9,6 @@
  */
 package org.zowe.apiml.product.instance.lookup;
 
-import org.zowe.apiml.product.constants.CoreService;
-import org.zowe.apiml.product.instance.InstanceInitializationException;
-import org.zowe.apiml.product.instance.InstanceNotFoundException;
 import com.netflix.appinfo.InstanceInfo;
 import com.netflix.discovery.EurekaClient;
 import com.netflix.discovery.shared.Application;
@@ -20,6 +17,9 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import org.zowe.apiml.product.constants.CoreService;
+import org.zowe.apiml.product.instance.InstanceInitializationException;
+import org.zowe.apiml.product.instance.InstanceNotFoundException;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -33,8 +33,6 @@
 @ExtendWith(MockitoExtension.class)
 class InstanceLookupExecutorTest {
 
-    private static final int INITIAL_DELAY = 1;
-    private static final int PERIOD = 10;
     private static final String SERVICE_ID = CoreService.API_CATALOG.getServiceId();
 
     @Mock
@@ -49,7 +47,7 @@ class InstanceLookupExecutorTest {
 
     @BeforeEach
     void setUp() {
-        instanceLookupExecutor = new InstanceLookupExecutor(eurekaClient, INITIAL_DELAY, PERIOD);
+        instanceLookupExecutor = new InstanceLookupExecutor(eurekaClient);
         instances = Collections.singletonList(
             getInstance(SERVICE_ID));
         latch = new CountDownLatch(1);
@@ -154,9 +152,9 @@ private InstanceInfo getInstance(String serviceId) {
     }
 
     InstanceInfo createInstance(String serviceId, String instanceId,
-                                       InstanceInfo.InstanceStatus status,
-                                       InstanceInfo.ActionType actionType,
-                                       HashMap<String, String> metadata) {
+                                InstanceInfo.InstanceStatus status,
+                                InstanceInfo.ActionType actionType,
+                                HashMap<String, String> metadata) {
         return new InstanceInfo(
             instanceId,
             serviceId.toUpperCase(),

gradle/versions.gradle

@@ -76,6 +76,7 @@ ext {
         spring_cloud_starter_eureka        : "org.springframework.cloud:spring-cloud-starter-netflix-eureka-client:${springCloudVersion}",
         spring_cloud_starter_ribbon        : "org.springframework.cloud:spring-cloud-starter-netflix-ribbon:${springCloudVersion}",
         spring_cloud_starter_hystrix       : "org.springframework.cloud:spring-cloud-starter-netflix-hystrix:${springCloudVersion}",
+        spring_cloud_commons               : "org.springframework.cloud:spring-cloud-commons:${springCloudVersion}",
 
         spring_security_config             : "org.springframework.security:spring-security-config:${springSecurityVersion}",
         spring_security_core               : "org.springframework.security:spring-security-core:${springSecurityVersion}",