Project upgrade

- Upgrade to Spring Boot 3.4.1;
- Upgrade to Mapstruct 1.6.3;
- Upgrade to Apache Maven 3.9.9;
- Upgrade to Elasticsearch docker image 8.15.4;
- Rename docker-build.sh to build-docker-images.sh;
- Refactor the way docker images are built;
- Refactor docker-compose.yml file;
- Add SpringDataWebSupportConfig to fix warning;
- Update README.

Author: Ivan Franchin

.mvn/wrapper/maven-wrapper.properties

@@ -6,7 +6,7 @@
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
-#   https://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -16,4 +16,4 @@
 # under the License.
 wrapperVersion=3.3.2
 distributionType=only-script
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

README.adoc

@@ -23,11 +23,11 @@ image::documentation/project-diagram.jpeg[]
 == Prerequisites
 
 * https://www.oracle.com/java/technologies/downloads/#java21[`Java 21+`]
-* https://www.docker.com/[`Docker`]
+* Some containerization tool https://www.docker.com[`Docker`], https://podman.io[`Podman`], etc.
 
 == Start Environment
 
-* Open a terminal and navigate to `springboot-elasticsearch-thymeleaf` root folder run:
+* Open a terminal and navigate to the `springboot-elasticsearch-thymeleaf` root folder run:
 +
 [source]
 ----
@@ -38,14 +38,14 @@ docker compose up -d
 +
 [source]
 ----
-docker compose ps
+docker ps -a
 ----
 
 == Initialize Elasticsearch
 
 NOTE: In the following steps, we will create an index, an alias and do a reindex using pre-defined scripts. In case you prefer to do it step-by-step calling `Elasticsearch` API, refer to link:create-index-alias-reindex.adoc[Creating indexes, alias and reindexing using Elasticsearch API].
 
-* In a terminal, make sure you are in `springboot-elasticsearch-thymeleaf` root folder;
+* In a terminal, make sure you are in the `springboot-elasticsearch-thymeleaf` root folder;
 
 * Run the following script to create the index `ecommerce.products.v1` with the alias `ecommerce.products` (you can use the default values by just pressing `Enter` on every user input):
 +
@@ -76,7 +76,7 @@ So, the script `./reindex.sh` aims to fix it, setting the type `keyword` to the
 
 == Running applications using Maven
 
-Below are the steps to start and run the applications using `Maven`. We will need to open a terminal for each one. Make sure you are in `springboot-elasticsearch-thymeleaf` root folder while running the commands.
+Below are the steps to start and run the applications using `Maven`. We will need to open a terminal for each one. Make sure you are in the `springboot-elasticsearch-thymeleaf` root folder while running the commands.
 
 * **product-api**
 +
@@ -95,12 +95,12 @@ Below are the steps to start and run the applications using `Maven`. We will nee
 == Running applications as Docker containers
 
 * Build Docker Images
-** In a terminal, make sure you are in `springboot-elasticsearch-thymeleaf` root folder;
+** In a terminal, make sure you are in the `springboot-elasticsearch-thymeleaf` root folder;
 ** Run the following script:
 +
 [source]
 ----
-./docker-build.sh
+./build-docker-images.sh
 ----
 
 * Environment Variables
@@ -126,7 +126,7 @@ Below are the steps to start and run the applications using `Maven`. We will nee
 |===
 
 * Run Docker containers
-** In a terminal, make sure you are in `springboot-elasticsearch-thymeleaf` root folder;
+** In a terminal, make sure you are in the `springboot-elasticsearch-thymeleaf` root folder;
 ** Run the following script:
 +
 [source]
@@ -156,13 +156,13 @@ image::documentation/demo-user-interaction.gif[]
 
 * To stop applications:
 ** If they were started with `Maven`, go to `product-api` and `product-ui` terminals and press `Ctrl+C`;
-** If they were started as Docker containers, go to a terminal and, inside `springboot-elasticsearch-thymeleaf` root folder, run the script below:
+** If they were started as Docker containers, go to a terminal and, inside the `springboot-elasticsearch-thymeleaf` root folder, run the script below:
 +
 [source]
 ----
 ./stop-apps.sh
 ----
-* To stop and remove docker compose containers, network and volumes, go to a terminal and, inside `springboot-elasticsearch-thymeleaf` root folder, run the following command:
+* To stop and remove docker compose containers, network and volumes, go to a terminal and, inside the `springboot-elasticsearch-thymeleaf` root folder, run the following command:
 +
 [source]
 ----
@@ -171,7 +171,7 @@ docker compose down -v
 
 == Cleanup
 
-To remove the Docker images created by this project, go to a terminal and, inside `springboot-elasticsearch-thymeleaf` root folder, run the script below:
+To remove the Docker images created by this project, go to a terminal and, inside the `springboot-elasticsearch-thymeleaf` root folder, run the script below:
 [source]
 ----
 ./remove-docker-images.sh

build-docker-images.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+DOCKER_IMAGE_PREFIX="ivanfranchin"
+APP_VERSION="1.0.0"
+
+PRODUCT_API_APP_NAME="product-api"
+PRODUCT_UI_APP_NAME="product-ui"
+
+PRODUCT_API_DOCKER_IMAGE_NAME="${DOCKER_IMAGE_PREFIX}/${PRODUCT_API_APP_NAME}:${APP_VERSION}"
+PRODUCT_UI_DOCKER_IMAGE_NAME="${DOCKER_IMAGE_PREFIX}/${PRODUCT_UI_APP_NAME}:${APP_VERSION}"
+
+SKIP_TESTS="true"
+
+./mvnw clean compile jib:dockerBuild \
+  --projects "$PRODUCT_API_APP_NAME" \
+  -DskipTests="$SKIP_TESTS" \
+  -Dimage="$PRODUCT_API_DOCKER_IMAGE_NAME"
+
+./mvnw clean compile jib:dockerBuild \
+  --projects "$PRODUCT_UI_APP_NAME" \
+  -DskipTests="$SKIP_TESTS" \
+  -Dimage="$PRODUCT_UI_DOCKER_IMAGE_NAME"

docker-build.sh

@@ -1,15 +1,14 @@
 services:
 
   elasticsearch:
-    image: docker.elastic.co/elasticsearch/elasticsearch:8.13.4
-    container_name: elasticsearch
-    restart: unless-stopped
+    image: 'docker.elastic.co/elasticsearch/elasticsearch:8.15.4'
+    container_name: 'elasticsearch'
     ports:
-    - "9200:9200"
-    - "9300:9300"
+    - '9200:9200'
+    - '9300:9300'
     environment:
-      discovery.type: single-node
-      xpack.security.enabled: false
-      ES_JAVA_OPTS: "-Xms512m -Xmx512m"
+      - 'discovery.type=single-node'
+      - 'xpack.security.enabled=false'
+      - 'ES_JAVA_OPTS=-Xms512m -Xmx512m'
     healthcheck:
-      test: "curl -f http://localhost:9200 || exit 1"
+      test: 'curl -f http://localhost:9200 || exit 1'

docker-compose.yml

@@ -8,7 +8,7 @@
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
-#    https://www.apache.org/licenses/LICENSE-2.0
+#    http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an

mvnw

@@ -8,7 +8,7 @@
 @REM "License"); you may not use this file except in compliance
 @REM with the License.  You may obtain a copy of the License at
 @REM
-@REM    https://www.apache.org/licenses/LICENSE-2.0
+@REM    http://www.apache.org/licenses/LICENSE-2.0
 @REM
 @REM Unless required by applicable law or agreed to in writing,
 @REM software distributed under the License is distributed on an

mvnw.cmd

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.3.2</version>
+        <version>3.4.1</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
 
@@ -18,9 +18,7 @@
 
     <properties>
         <java.version>21</java.version>
-        <jib-maven-plugin.version>3.4.3</jib-maven-plugin.version>
-        <jdk-image.version>21.0.4</jdk-image.version>
-        <docker-image.prefix>ivanfranchin</docker-image.prefix>
+        <jib-maven-plugin.version>3.4.4</jib-maven-plugin.version>
     </properties>
 
     <modules>
@@ -34,14 +32,6 @@
                 <groupId>com.google.cloud.tools</groupId>
                 <artifactId>jib-maven-plugin</artifactId>
                 <version>${jib-maven-plugin.version}</version>
-                <configuration>
-                    <from>
-                        <image>amazoncorretto:${jdk-image.version}</image>
-                    </from>
-                    <to>
-                        <image>${docker-image.prefix}/${project.artifactId}:${project.version}</image>
-                    </to>
-                </configuration>
             </plugin>
         </plugins>
     </build>

pom.xml

@@ -14,8 +14,8 @@
     <description>Demo project for Spring Boot</description>
 
     <properties>
-        <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
-        <springdoc-openapi.version>2.6.0</springdoc-openapi.version>
+        <org.mapstruct.version>1.6.3</org.mapstruct.version>
+        <springdoc-openapi.version>2.7.0</springdoc-openapi.version>
         <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
     </properties>
 

product-api/pom.xml

@@ -0,0 +1,18 @@
+package com.ivanfranchin.productapi.config;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.web.config.EnableSpringDataWebSupport;
+
+import static org.springframework.data.web.config.EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO;
+
+/*
+The reason this configuration class was added is to prevent the following WARN message from occurring.
+
+WARN Serializing PageImpl instances as-is is not supported, meaning that there is no guarantee about the stability of the resulting JSON structure!
+	For a stable JSON structure, please use Spring Data's PagedModel (globally via @EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO))
+	or Spring HATEOAS and Spring Data's PagedResourcesAssembler as documented in https://docs.spring.io/spring-data/commons/reference/repositories/core-extensions.html#core.web.pageables.
+*/
+@Configuration
+@EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO)
+public class SpringDataWebSupportConfig {
+}

product-api/src/main/java/com/ivanfranchin/productapi/config/SpringDataWebSupportConfig.java

@@ -9,7 +9,7 @@ docker run -d --rm --name product-api \
   -p 8080:8080 \
   -e ELASTICSEARCH_URIS=elasticsearch:9200 \
   --network springboot-elasticsearch-thymeleaf_default \
-  --health-cmd="curl -f http://localhost:8080/actuator/health || exit 1" \
+  --health-cmd='[ -z "$(echo "" > /dev/tcp/localhost/8080)" ] || exit 1' \
   ivanfranchin/product-api:1.0.0
 
 wait_for_container_log "product-api" "Started"
@@ -21,7 +21,7 @@ docker run -d --rm --name product-ui \
   -p 9080:8080 \
   -e PRODUCT_API_URL=http://product-api:8080 \
   --network springboot-elasticsearch-thymeleaf_default \
-  --health-cmd="curl -f http://localhost:8080/actuator/health || exit 1" \
+  --health-cmd='[ -z "$(echo "" > /dev/tcp/localhost/9080)" ] || exit 1' \
   ivanfranchin/product-ui:1.0.0
 
 wait_for_container_log "product-ui" "Started"