System enhancements

1. Reformat all records and Event class to use same datetime.
1. Create a GlobalConfiguration class.
1. Removed custom Jakson properties from HttpErrorInfo.

Author: mohamed-taman

docs/stage1/springy_store_project_structure.png

@@ -1,7 +1,19 @@
 package com.siriusxi.ms.store.api.composite.dto;
 
 import java.util.List;
-
+/**
+ * Record <code>ProductAggregate</code> that hold all the product aggregate information.
+ *
+ * @implNote Since it is a record and not normal POJO, so it needs some customizations
+ * to be serialized to JSON and this is done with method
+ * <code>GlobalConfiguration.jacksonCustomizer()</code>.
+ *
+ * @see java.lang.Record
+ * @see com.siriusxi.ms.store.util.config.GlobalConfiguration
+ * @author mohamed.taman
+ * @version v4.6
+ * @since v0.1
+ */
 public record ProductAggregate (int productId,
                                 String name,
                                 int weight,

store-common/store-api/src/main/java/com/siriusxi/ms/store/api/composite/dto/ProductAggregate.java

@@ -1,5 +1,18 @@
 package com.siriusxi.ms.store.api.composite.dto;
 
+/**
+ * Record <code>RecommendationSummary</code> that hold all the product recommendations.
+ *
+ * @implNote Since it is a record and not normal POJO, so it needs some customizations
+ * to be serialized to JSON and this is done with method
+ * <code>GlobalConfiguration.jacksonCustomizer()</code>.
+ *
+ * @see java.lang.Record
+ * @see com.siriusxi.ms.store.util.config.GlobalConfiguration
+ * @author mohamed.taman
+ * @version v4.6
+ * @since v0.1
+ */
 public record RecommendationSummary(int recommendationId,
                                     String author,
                                     int rate,

store-common/store-api/src/main/java/com/siriusxi/ms/store/api/composite/dto/RecommendationSummary.java

@@ -1,5 +1,18 @@
 package com.siriusxi.ms.store.api.composite.dto;
 
+/**
+ * Record <code>ReviewSummary</code> that hold all product reviews.
+ *
+ * @implNote Since it is a record and not normal POJO, so it needs some customizations
+ * to be serialized to JSON and this is done with method
+ * <code>GlobalConfiguration.jacksonCustomizer()</code>.
+ *
+ * @see java.lang.Record
+ * @see com.siriusxi.ms.store.util.config.GlobalConfiguration
+ * @author mohamed.taman
+ * @version v4.6
+ * @since v0.1
+ */
 public record ReviewSummary(int reviewId,
                             String author,
                             String subject,

store-common/store-api/src/main/java/com/siriusxi/ms/store/api/composite/dto/ReviewSummary.java

@@ -1,5 +1,19 @@
 package com.siriusxi.ms.store.api.composite.dto;
 
+/**
+ * Record <code>ServiceAddresses</code> that hold all services addresses involved in the product
+ * call.
+ *
+ * @implNote Since it is a record and not normal POJO, so it needs some customizations
+ * to be serialized to JSON and this is done with method
+ * <code>GlobalConfiguration.jacksonCustomizer()</code>.
+ *
+ * @see java.lang.Record
+ * @see com.siriusxi.ms.store.util.config.GlobalConfiguration
+ * @author mohamed.taman
+ * @version v4.6
+ * @since v0.1
+ */
 public record ServiceAddresses( String storeService,
                                 String productService,
                                 String reviewService,

store-common/store-api/src/main/java/com/siriusxi/ms/store/api/composite/dto/ServiceAddresses.java

@@ -1,6 +1,12 @@
 package com.siriusxi.ms.store.api.event;
 
-import lombok.*;
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
 
 import java.time.LocalDateTime;
 
@@ -13,17 +19,22 @@
 @Setter(NONE)
 public class Event<K, T> {
 
-    public enum Type {CREATE, DELETE}
+  private Event.Type eventType;
+  private K key;
+  private T data;
+  @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd@HH:mm:ss.SSS")
+  @JsonSerialize(using = LocalDateTimeSerializer.class)
+  private LocalDateTime eventCreatedAt;
 
-    private Event.Type eventType;
-    private K key;
-    private T data;
-    private LocalDateTime eventCreatedAt;
+  public Event(Type eventType, K key, T data) {
+    this.eventType = eventType;
+    this.key = key;
+    this.data = data;
+    this.eventCreatedAt = now();
+  }
 
-    public Event(Type eventType, K key, T data) {
-        this.eventType = eventType;
-        this.key = key;
-        this.data = data;
-        this.eventCreatedAt = now();
-    }
-}
+  public enum Type {
+    CREATE,
+    DELETE
+  }
+}

store-common/store-api/src/main/java/com/siriusxi/ms/store/api/event/Event.java

@@ -0,0 +1,32 @@
+package com.siriusxi.ms.store.util.config;
+
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.PropertyAccessor;
+import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+/**
+ * Class <code>GlobalConfiguration</code> holds all configurations that used by all the system
+ * services.
+ *
+ * @author mohamed.taman
+ * @version v4.6
+ * @since v0.1
+ */
+@Configuration
+public class GlobalConfiguration {
+
+  /**
+   * This bean is for Java 14 record to be serialized as JSON
+   *
+   * @return Jackson2ObjectMapperBuilderCustomizer builder
+   */
+  @Bean
+  public Jackson2ObjectMapperBuilderCustomizer jacksonCustomizer() {
+    return builder ->
+        builder
+            .visibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
+            // human readable
+            .indentOutput(true);
+  }
+}

store-common/store-utils/src/main/java/com/siriusxi/ms/store/util/config/GlobalConfiguration.java

@@ -1,9 +1,6 @@
 package com.siriusxi.ms.store.util.http;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.datatype.jsr310.ser.ZonedDateTimeSerializer;
 import org.springframework.http.HttpStatus;
@@ -14,21 +11,22 @@
  * Record <code>HttpErrorInfo</code> which encapsulate all HTTP errors sent to client.
  *
  * @implNote Since it is a record and not normal POJO, so it needs some customizations
- * to be serialized to JSON.
- * @see  java.lang.Record
+ * to be serialized to JSON and this is done with method
+ * <code>GlobalConfiguration.jacksonCustomizer()</code>.
+ *
+ * @see java.lang.Record
+ * @see com.siriusxi.ms.store.util.config.GlobalConfiguration
  * @author mohamed.taman
- * @version v0.4
+ * @version v4.6
  * @since v0.1
  */
 public record HttpErrorInfo(
-        @JsonProperty("httpStatus")HttpStatus httpStatus,
-        @JsonProperty("message")String message,
-        @JsonProperty("path")String path,
-        @JsonProperty("time")
+        HttpStatus httpStatus,
+        String message,
+        String path,
         @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd@HH:mm:ss.SSSZ")
         @JsonSerialize(using = ZonedDateTimeSerializer.class)
-        ZonedDateTime timestamp
-) {
+        ZonedDateTime timestamp) {
 
     /**
      * Instantiates a new Http error info.
@@ -40,14 +38,4 @@ public record HttpErrorInfo(
 public HttpErrorInfo(HttpStatus httpStatus, String path, String message) {
         this(httpStatus, message, path, ZonedDateTime.now());
     }
-
-
-public static void main(String[] args) throws JsonProcessingException {
-        HttpErrorInfo err = new HttpErrorInfo(HttpStatus.BAD_REQUEST, "/path", "Error man");
-        HttpErrorInfo err1 = new HttpErrorInfo(HttpStatus.UNPROCESSABLE_ENTITY, "Error message man",
-                "/path1234", ZonedDateTime.now());
-        ObjectMapper mapper = new ObjectMapper();
-        System.out.println(mapper.writeValueAsString(err));
-        System.out.println(mapper.writeValueAsString(err1));
-    }
 }

store-common/store-utils/src/main/java/com/siriusxi/ms/store/util/http/HttpErrorInfo.java

@@ -1,14 +1,11 @@
 package com.siriusxi.ms.store.pcs;
 
-import com.fasterxml.jackson.annotation.JsonAutoDetect;
-import com.fasterxml.jackson.annotation.PropertyAccessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.client.loadbalancer.LoadBalanced;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.web.reactive.function.client.WebClient;
-import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
 import springfox.documentation.swagger2.annotations.EnableSwagger2WebFlux;
 
 @SpringBootApplication
@@ -24,10 +21,4 @@ public static void main(String[] args) {
   public WebClient.Builder loadBalancedWebClientBuilder() {
     return WebClient.builder();
   }
-
-  @Bean
-  public Jackson2ObjectMapperBuilderCustomizer jacksonCustomizer() {
-    return builder -> builder.visibility( PropertyAccessor.FIELD,
-                                          JsonAutoDetect.Visibility.ANY);
-  }
 }

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

@@ -57,7 +57,13 @@ public StoreServiceConfiguration(StoreIntegration integration) {
     this.integration = integration;
   }
 
-  @Bean(name = "Core System Microservices")
+  /**
+   * 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;