Merge pull request #21 from neuefische/20-implement-backend-and-front…

…end-logging

20 implement backend and frontend logging

README.md

@@ -1 +1,76 @@
-# hh-java-24-2-teamproject-2
+# hh-java-24-2-teamproject-2
+
+## Introduction
+RestaurantApp is an application for managing and organizing restaurant details. Users can save their favorite restaurants information.
+
+## Prerequisites
+
+The following technologies should be installed on the system:
+
+- Java SDK version 22
+- Node.js
+- NPM (Node Package Manager)
+- optional: IntelliJ IDEA Ultimate Edition
+
+## Dependencies
+
+### Backend
+- spring-boot-starter-data-mongodb
+- spring-boot-starter-parent Version 3.3.0
+- spring-boot-starter-web
+- spring-boot-starter-validation
+- logback-logtail Version 0.3.4 from com.logtail
+- de.flapdoodle.embed.mongo.spring3x Version 4.13.0 from  de.flapdoodle.embed (only Test-Scope)
+- spring-boot-starter-test (only Test-Scope)
+- spring-boot-starter-actuator
+
+### Frontend
+
+- TypeScript
+- React
+- Jest
+- Babel
+- Axios
+- Test-Library/React
+- Styled-Components
+- ESLint
+
+## Getting Started
+
+Follow these steps to get the project up and running on your local machine:
+
+1. Clone the repository:  
+   `git clone https://github.com/neuefische/hh-java-24-2-teamproject-2.git`
+
+2. Navigate to the project's root directory:  
+   `cd hh-java-24-2-teamproject-2/`
+
+3. Setup all environment variables
+   1. Backend: Copy application-development-properties.sample to application-development-properties and replace with your secrets:  
+      `cp backend/src/main/resources/application-development.properties.sample backend/src/main/resources/application-development.properties`
+   2. Frontend: Copy .env.local.sample to .env.local and replace with your secrets:  
+      `cp frontend/.env.local.sample frontend/.env.local          `
+
+4. Navigate to the frontend's root directory:  
+   `cd frontend/`
+
+5. Install the NPM dependencies:  
+   `npm install`
+
+6. Start the project:  
+   For IntelliJ IDEA the configuration for all runs should be automatically loaded using the files in `.run/` folder.
+    - For the backend, you might want to execute the main Spring Boot Application class.
+    - For the frontend, typically you would use `npm dev`.
+
+## Running Tests
+   For IntelliJ IDEA the configuration for all test runs should be automatically loaded using the files in `.run/` folder.  
+   - For the backend, you might want to execute the test folder.
+   - For the frontend, typically you would use `npm test`.
+
+## Authors / Acknowledgments
+- [Samuel Gesang](https://github.com/gcode-de)
+- [Jonas Honecker](https://github.com/jonashonecker)
+- [Daniel Pohl](https://github.com/daniel-pohl)
+- [Aljoscha Zöller](https://github.com/josch87)
+
+[See all git contributors](https://github.com/neuefische/hh-java-24-2-teamproject-2/graphs/contributors)

backend/pom.xml

@@ -28,6 +28,15 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.logtail</groupId>
+			<artifactId>logback-logtail</artifactId>
+			<version>0.3.4</version>
+		</dependency>
 		<dependency>
 			<groupId>de.flapdoodle.embed</groupId>
 			<artifactId>de.flapdoodle.embed.mongo.spring3x</artifactId>
@@ -36,14 +45,12 @@
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-validation</artifactId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
 		</dependency>
-
-
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-test</artifactId>
-			<scope>test</scope>
+			<artifactId>spring-boot-starter-actuator</artifactId>
 		</dependency>
 	</dependencies>
 

backend/src/main/java/com/neuefische/team2/backend/restaurant/RestaurantController.java

@@ -2,7 +2,6 @@
 
 import com.neuefische.team2.backend.restaurant.domain.NewRestaurantDTO;
 import com.neuefische.team2.backend.exceptions.ResourceNotFoundException;
-import com.neuefische.team2.backend.restaurant.domain.NewRestaurantDTO;
 import com.neuefische.team2.backend.restaurant.domain.Restaurant;
 import jakarta.validation.Valid;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -11,8 +10,6 @@
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.*;
-import jakarta.validation.Valid;
-import org.springframework.web.bind.annotation.*;
 
 import java.util.List;
 

backend/src/main/java/com/neuefische/team2/backend/restaurant/RestaurantService.java

@@ -4,13 +4,15 @@
 import com.neuefische.team2.backend.restaurant.domain.NewRestaurantDTO;
 import com.neuefische.team2.backend.exceptions.NoSuchRestaurantException;
 import com.neuefische.team2.backend.restaurant.domain.Restaurant;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Service;
 
 import java.util.List;
-import java.util.Optional;
 
 @Service
 public class RestaurantService {
+    Logger logger = LoggerFactory.getLogger(RestaurantService.class);
 
     private final RestaurantRepository restaurantRepository;
 
@@ -23,20 +25,37 @@ public List<Restaurant> getRestaurants() {
     }
 
     public Restaurant findRestaurantById(String id) {
-        return restaurantRepository.findById(id).orElseThrow(() -> new NoSuchRestaurantException("Restaurant with id " + id + " not found"));
+        logger.info("Trying to find restaurant with ID {}", id);
+
+        Restaurant restaurant = restaurantRepository.findById(id)
+                .orElseThrow(() -> {
+                    logger.error("Could not find restaurant with ID {}", id);
+                    return new NoSuchRestaurantException("Restaurant with id " + id + " not found");
+                });
+
+        logger.info("Found restaurant with ID {}", id);
+
+        return restaurant;
     }
 
     public Restaurant addRestaurant(Restaurant restaurant) {
         return restaurantRepository.save(restaurant);
     }
 
     public Restaurant updateRestaurant(NewRestaurantDTO updatedRestaurantDTO, String id) throws ResourceNotFoundException {
-        Optional<Restaurant> existingRestaurant = restaurantRepository.findById(id);
-        if (existingRestaurant.isPresent()) {
-            Restaurant updatedRestaurant = new Restaurant(id, updatedRestaurantDTO.title().trim(), updatedRestaurantDTO.city().trim());
-            return restaurantRepository.save(updatedRestaurant);
-        } else {
-            throw new ResourceNotFoundException("Restaurant not found with id " + id);
-        }
+        logger.info("Trying to update restaurant with ID {}", id);
+
+        this.findRestaurantById(id);
+        Restaurant updatedRestaurant = new Restaurant(
+                id,
+                updatedRestaurantDTO.title().trim(),
+                updatedRestaurantDTO.city().trim()
+        );
+        Restaurant savedRestaurant = restaurantRepository.save(updatedRestaurant);
+
+        logger.info("Updated restaurant with ID {}", id);
+        return savedRestaurant;
     }
+
+
 }

backend/src/main/resources/application-development.properties.sample

@@ -1,2 +1,5 @@
 # Database Configuration
-MONGODB_URI=your_db_uri
+MONGODB_URI=your_db_uri
+
+# Logging Configuration
+BETTERSTACK_TOKEN=your_betterstack_token

backend/src/main/resources/application.properties

@@ -1,3 +1,9 @@
 spring.application.name=backend
+
+# Database
 spring.data.mongodb.uri=${MONGODB_URI}
-spring.data.mongodb.database=restaurantApp
+spring.data.mongodb.database=restaurantApp
+
+# Logging
+logging.level.com.neuefische.team2.backend=info
+management.endpoints.web.exposure.include=loggers

backend/src/main/resources/logback-spring.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <springProperty scope="context" name="betterStackToken" source="BETTERSTACK_TOKEN"/>
+    <appender name="Logtail" class="com.logtail.logback.LogtailAppender">
+        <appName>RestaurantApp Backend</appName>
+        <sourceToken>${betterStackToken}</sourceToken>
+        <mdcFields>requestId,requestTime</mdcFields>
+        <mdcTypes>string,int</mdcTypes>
+    </appender>
+    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %msg%n</pattern>
+        </encoder>
+    </appender>
+    <root level="INFO">
+        <appender-ref ref="Logtail" />
+        <appender-ref ref="Console" />
+    </root>
+</configuration>

backend/src/test/java/com/neuefische/team2/backend/restaurant/RestaurantServiceTest.java

@@ -1,6 +1,5 @@
 package com.neuefische.team2.backend.restaurant;
 
-import com.neuefische.team2.backend.exceptions.ResourceNotFoundException;
 import com.neuefische.team2.backend.restaurant.domain.NewRestaurantDTO;
 import com.neuefische.team2.backend.exceptions.NoSuchRestaurantException;
 import com.neuefische.team2.backend.restaurant.domain.Restaurant;
@@ -73,13 +72,13 @@ void updateRestaurant_whenRestaurantDoesNotExist_thenThrowResourceNotFoundExcept
         when(mockRestaurantRepository.findById("1")).thenReturn(Optional.empty());
 
         // WHEN / THEN
-        assertThrows(ResourceNotFoundException.class, () -> {
-            restaurantService.updateRestaurant(updatedRestaurantData, "1");
-        });
+        assertThrows(NoSuchRestaurantException.class, () ->
+                restaurantService.updateRestaurant(updatedRestaurantData, "1"));
 
         verify(mockRestaurantRepository).findById("1");
         verify(mockRestaurantRepository, never()).save(any(Restaurant.class));
     }
+
     @Test
     void findRestaurantById_whenRestaurantExists_thenReturnRestaurant() {
         //GIVEN

frontend/.env.local.sample

@@ -0,0 +1,2 @@
+# Logging
+VITE_BETTERSTACK_TOKEN=your_betterstack_token