Configuring API gateway

- All test cases runs for the whole system.
- test-em-all runs successfully.
- More reduction application.yml properties

Author: mohamed-taman

docker-compose-kafka.yml

@@ -94,8 +94,6 @@ services:
   ## Start - Store service definition
   store:
     build: store-services/store-service
-    ports:
-      - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
       - MANAGEMENT_HEALTH_RABBIT_ENABLED=false
@@ -115,9 +113,7 @@ services:
   ## Start - Eureka Service Discovery definition
   eureka:
     build: store-cloud-infra/eureka-server
-    ports:
-      - "8761:8761"
-    restart: always
+    restart: on-failure
   ## End - Eureka Service Discovery definition
 
   ## Start - Edge Server definition
@@ -127,6 +123,8 @@ services:
       - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
+    depends_on:
+      - eureka
     restart: on-failure
   ## End - Edge Server definition
   # End - Cloud Infrastructure

docker-compose-partitions.yml

@@ -82,8 +82,6 @@ services:
   ## Start - Store service definition
   store:
     build: store-services/store-service
-    ports:
-      - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
       - SPRING_CLOUD_STREAM_BINDINGS_OUTPUT-PRODUCTS_PRODUCER_PARTITION-KEY-EXPRESSION=payload.key
@@ -101,8 +99,6 @@ services:
   ## Start - Eureka Service Discovery definition
   eureka:
     build: store-cloud-infra/eureka-server
-    ports:
-      - "8761:8761"
     restart: always
   ## End - Eureka Service Discovery definition
 
@@ -113,6 +109,8 @@ services:
       - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
+    depends_on:
+      - eureka
     restart: on-failure
   ## End - Edge Server definition
   # End - Cloud Infrastructure

docker-compose.yml

@@ -36,8 +36,6 @@ services:
   ## Start - Store service definition
   store:
     build: store-services/store-service
-    ports:
-      - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
     depends_on:
@@ -49,8 +47,6 @@ services:
   ## Start - Eureka Service Discovery definition
   eureka:
     build: store-cloud-infra/eureka-server
-    ports:
-      - "8761:8761"
     restart: on-failure
   ## End - Eureka Service Discovery definition
 
@@ -61,6 +57,8 @@ services:
       - "8080:8080"
     environment:
       - SPRING_PROFILES_ACTIVE=docker
+    depends_on:
+      - eureka
     restart: on-failure
   ## End - Edge Server definition
   # End - Cloud Infrastructure

store-cloud-infra/edge-server/src/main/resources/application.yml

@@ -5,41 +5,46 @@ spring:
   # It is recommended switching to BlockingLoadBalancerClient instead.
   cloud:
     loadbalancer.ribbon.enabled: false
+    # Route definitions of the system
     gateway.routes:
-      - id: host_route_200
-        uri: http://httpstat.us
+      - id: store-products
+        # lb:// is used to direct Spring Cloud Gateway to use the client-side load balancer
+        # to look up the destination in the discovery service.
+        uri: lb://store
         predicates:
-          - Host=i.feel.lucky:8080
-          - Path=/headerrouting/**
-        filters:
-          - SetPath=/200
+          - Path=/store/**
 
-      - id: host_route_418
-        uri: http://httpstat.us
+      - id: eureka-api
+        uri: http://${app.eureka-server}:8761
         predicates:
-          - Host=im.a.teapot:8080
-          - Path=/headerrouting/**
+          - Path=/eureka/api/{segment}
         filters:
-          - SetPath=/418
+          - SetPath=/eureka/{segment}
 
-      - id: host_route_501
-        uri: http://httpstat.us
+      - id: eureka-web-start
+        uri: http://${app.eureka-server}:8761
         predicates:
-          - Path=/headerrouting/**
+          - Path=/eureka/web
         filters:
-          - SetPath=/501
+          - SetPath=/
+
+      - id: eureka-web-other
+        uri: http://${app.eureka-server}:8761
+        predicates:
+          - Path=/eureka/**
 
 app.eureka-server: localhost
 
 eureka:
+  instance:
+    lease-renewal-interval-in-seconds: 5
+    lease-expiration-duration-in-seconds: 5
+    prefer-ip-address: true
   client:
     healthcheck.enabled: true
     service-Url.defaultZone: http://${app.eureka-server}:8761/eureka/
     initial-instance-info-replication-interval-seconds: 5
     registry-fetch-interval-seconds: 5
-  instance:
-    lease-renewal-interval-in-seconds: 5
-    lease-expiration-duration-in-seconds: 5
 
 ribbon:
   server-list-refresh-interval: 5000
@@ -60,4 +65,8 @@ logging.level:
 ---
 spring.profiles: docker
 
-app.eureka-server: eureka
+eureka:
+  instance:
+    prefer-ip-address: false
+
+app.eureka-server: eureka

store-cloud-infra/edge-server/src/test/java/com/siriusxi/cloud/infra/gateway/EdgeServerApplicationTests.java

@@ -3,15 +3,17 @@
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;
 
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
 
 @SpringBootTest(
     webEnvironment = RANDOM_PORT,
     properties = {"eureka.client.enabled: false"})
+// TODO add test cases https://spring.io/guides/gs/gateway/
 class EdgeServerApplicationTests {
 
   @Test
   void contextLoads() {
-    assert true;
+    assertTrue(true);
   }
 }

store-cloud-infra/eureka-server/src/main/resources/application.yml

@@ -9,8 +9,8 @@ server.port: 8761
 
 logging.level:
     com.netflix:
-        eureka: OFF
-        discovery: OFF
+        eureka: debug
+        discovery: debug
 
 eureka:
   environment: Development

store-services/product-service/src/main/resources/application.yml

@@ -73,14 +73,15 @@ app:
 
 # Service discovery configs
 eureka:
+  instance:
+    lease-renewal-interval-in-seconds: 5
+    lease-expiration-duration-in-seconds: 5
+    prefer-ip-address: true
   client:
     healthcheck.enabled: true
     service-url.defaultZone: http://${app.eureka-server}:8761/eureka/
     initial-instance-info-replication-interval-seconds: 5
     registry-fetch-interval-seconds: 5
-  instance:
-    lease-renewal-interval-in-seconds: 5
-    lease-expiration-duration-in-seconds: 5
 
 # This is a docker specific profile properties
 # Also profiles could be separated in its owen file
@@ -92,6 +93,10 @@ spring:
 
 server.port: 8080
 
+eureka:
+  instance:
+    prefer-ip-address: false
+
 app:
   eureka-server: eureka
   database:

store-services/recommendation-service/src/main/resources/application.yml

@@ -72,14 +72,15 @@ app:
 
 # Service discovery configs
 eureka:
+  instance:
+    lease-renewal-interval-in-seconds: 5
+    lease-expiration-duration-in-seconds: 5
+    prefer-ip-address: true
   client:
     healthcheck.enabled: true
     service-url.defaultZone: http://${app.eureka-server}:8761/eureka/
     initial-instance-info-replication-interval-seconds: 5
     registry-fetch-interval-seconds: 5
-  instance:
-    lease-renewal-interval-in-seconds: 5
-    lease-expiration-duration-in-seconds: 5
 
 # This is a docker specific profile properties
 # Also profiles could be separated in its owen file
@@ -92,6 +93,10 @@ spring:
 server:
   port: 8080
 
+eureka:
+  instance:
+    prefer-ip-address: false
+
 app:
   eureka-server: eureka
   database:

store-services/review-service/src/main/resources/application.yaml

@@ -88,14 +88,15 @@ management:
 
 # Service discovery configs
 eureka:
+  instance:
+    lease-renewal-interval-in-seconds: 5
+    lease-expiration-duration-in-seconds: 5
+    prefer-ip-address: true
   client:
     healthcheck.enabled: true
     service-url.defaultZone: http://${app.eureka-server}:8761/eureka/
     initial-instance-info-replication-interval-seconds: 5
     registry-fetch-interval-seconds: 5
-  instance:
-    lease-renewal-interval-in-seconds: 5
-    lease-expiration-duration-in-seconds: 5
 
 # This is a docker specific profile properties
 # Also profiles could be separated in its owen file
@@ -109,6 +110,10 @@ spring:
 
 server.port: 8080
 
+eureka:
+  instance:
+    prefer-ip-address: false
+
 app:
   eureka-server: eureka
   database:

store-services/store-service/src/main/java/com/siriusxi/ms/store/pcs/StoreServiceApplication.java

@@ -15,10 +15,4 @@ public class StoreServiceApplication {
   public static void main(String[] args) {
     SpringApplication.run(StoreServiceApplication.class, args);
   }
-
-  @Bean
-  @LoadBalanced
-  public WebClient.Builder loadBalancedWebClientBuilder() {
-    return WebClient.builder();
-  }
 }

store-services/store-service/src/main/java/com/siriusxi/ms/store/pcs/config/StoreServiceConfiguration.java

@@ -1,20 +1,15 @@
 package com.siriusxi.ms.store.pcs.config;
 
-import com.siriusxi.ms.store.pcs.integration.StoreIntegration;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.actuate.health.CompositeReactiveHealthContributor;
-import org.springframework.boot.actuate.health.ReactiveHealthContributor;
-import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
+import org.springframework.cloud.client.loadbalancer.LoadBalanced;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.web.reactive.function.client.WebClient;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
 import springfox.documentation.spring.web.plugins.Docket;
 
-import java.util.Map;
-
 import static java.util.Collections.emptyList;
 import static org.springframework.web.bind.annotation.RequestMethod.*;
 import static springfox.documentation.builders.RequestHandlerSelectors.basePackage;
@@ -23,8 +18,6 @@
 @Configuration
 public class StoreServiceConfiguration {
 
-  private final StoreIntegration integration;
-
   @Value("${api.common.version}")
   private String apiVersion;
 
@@ -52,33 +45,6 @@ public class StoreServiceConfiguration {
   @Value("${api.common.contact.email}")
   private String apiContactEmail;
 
-  @Autowired
-  public StoreServiceConfiguration(StoreIntegration integration) {
-    this.integration = integration;
-  }
-
-  /**
-   * This method is to check all the services health status, and store service health will be only
-   * in up health state if and only if all of the core services and dependencies are up and running.
-   *
-   * @return ReactiveHealthContributor information about all the core microservices.
-   */
-  @Bean(name = "Core Microservices")
-  ReactiveHealthContributor coreServices() {
-
-    ReactiveHealthIndicator productHealthIndicator = integration::getProductHealth;
-    ReactiveHealthIndicator recommendationHealthIndicator = integration::getRecommendationHealth;
-    ReactiveHealthIndicator reviewHealthIndicator = integration::getReviewHealth;
-
-    Map<String, ReactiveHealthContributor> allIndicators =
-        Map.of(
-            "Product Service", productHealthIndicator,
-            "Recommendation Service", recommendationHealthIndicator,
-            "Review Service", reviewHealthIndicator);
-
-    return CompositeReactiveHealthContributor.fromMap(allIndicators);
-  }
-
   /**
    * Will exposed on $HOST:$PORT/swagger-ui.html
    *
@@ -120,4 +86,10 @@ Using the globalResponseMessage() method, we ask SpringFox not to add any defaul
                 apiLicenseUrl,
                 emptyList()));
   }
+
+  @Bean
+  @LoadBalanced
+  public WebClient.Builder loadBalancedWebClientBuilder() {
+    return WebClient.builder();
+  }
 }