Added Caching for findByEmail and fixed the bug with email uniquness (#102)

* Base code for caching and improvign login at user.

* Added Caching using redis and fix bug with email uniquness

* Added log messages

* Added REDIS_URL in env

---------

Co-authored-by: Ahmed Elwasefi <a.m.elwasefi@gmail.com>

Author: ShimaaBetah

services/users/.env

@@ -5,4 +5,6 @@ USERS_SECRET_KEY=j4#BbFGfoc^2k*Bz
 
 ADMIN_EMAIL=admin@workup.com
 ADMIN_PASSWORD=admin
-ADMIN_ID=admin
+ADMIN_ID=admin
+
+REDIS_URL=service_redis

services/users/src/main/java/com/workup/users/RedisConfig.java

@@ -0,0 +1,8 @@
+package com.workup.users;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+@Configuration
+@Import(com.workup.shared.redis.RedisConfig.class)
+public class RedisConfig {}

services/users/src/main/java/com/workup/users/UsersApplication.java

@@ -11,12 +11,14 @@
 import org.springframework.amqp.support.converter.MessageConverter;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.context.annotation.Bean;
 import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 
 @SpringBootApplication
 @EnableAsync
+@EnableCaching
 // @EnableMongoRepositories(basePackageClasses = ClientRepository.class)
 public class UsersApplication {
 

services/users/src/main/java/com/workup/users/commands/ClientRegisterCommand.java

@@ -27,6 +27,16 @@ public SignUpAndInResponse Run(ClientRegisterRequest request) {
           .build();
     }
     try {
+      // check if registered already as freelancer
+      if (freelancerRepository.findByEmail(request.getEmail()).isPresent()) {
+        logger.error(
+            "[x] User with email" + request.getEmail() + " already registered as freelancer");
+        return SignUpAndInResponse.builder()
+            .withStatusCode(HttpStatusCode.BAD_REQUEST)
+            .withSuccess(false)
+            .withErrorMessage("User already registered as freelancer")
+            .build();
+      }
       Client client =
           Client.builder()
               .withEmail(request.getEmail())

services/users/src/main/java/com/workup/users/commands/FreelancerRegisterCommand.java

@@ -30,6 +30,15 @@ public SignUpAndInResponse Run(FreelancerRegisterRequest request) {
           .build();
     }
     try {
+      // check if registered already as client
+      if (clientRepository.findByEmail(request.getEmail()).isPresent()) {
+        logger.error("[x] User with email" + request.getEmail() + " already registered as client");
+        return SignUpAndInResponse.builder()
+            .withStatusCode(HttpStatusCode.BAD_REQUEST)
+            .withSuccess(false)
+            .withErrorMessage("User already registered as client")
+            .build();
+      }
       Freelancer freelancer =
           Freelancer.builder()
               .withEmail(request.getEmail())
@@ -58,6 +67,7 @@ public SignUpAndInResponse Run(FreelancerRegisterRequest request) {
       logger.error("[x] Error Registering Freelancer: " + e.getMessage());
       return SignUpAndInResponse.builder()
           .withStatusCode(HttpStatusCode.INTERNAL_SERVER_ERROR)
+          .withErrorMessage(e.getMessage())
           .withSuccess(false)
           .build();
     }

services/users/src/main/java/com/workup/users/db/Client.java

@@ -1,5 +1,6 @@
 package com.workup.users.db;
 
+import java.io.Serializable;
 import java.util.Date;
 import lombok.Builder;
 import lombok.Getter;
@@ -13,7 +14,7 @@
 @Getter
 @Setter
 @Document
-public class Client {
+public class Client implements Serializable {
   @Id private ObjectId id;
 
   @Indexed(unique = true)

services/users/src/main/java/com/workup/users/db/Freelancer.java

@@ -1,5 +1,6 @@
 package com.workup.users.db;
 
+import java.io.Serializable;
 import java.util.Date;
 import java.util.List;
 import lombok.Builder;
@@ -15,7 +16,7 @@
 @Getter
 @Setter
 @Document(collection = "Freelancer")
-public class Freelancer {
+public class Freelancer implements Serializable {
   @Id private ObjectId id;
 
   @Indexed(unique = true)

services/users/src/main/java/com/workup/users/repositories/ClientRepository.java

@@ -2,9 +2,15 @@
 
 import com.workup.users.db.Client;
 import java.util.Optional;
+import org.springframework.cache.annotation.CacheEvict;
+import org.springframework.cache.annotation.Cacheable;
 import org.springframework.data.mongodb.repository.MongoRepository;
 
 public interface ClientRepository extends MongoRepository<Client, String> {
   // find by clientEmail
+  @Cacheable(value = "clients", key = "#email")
   Optional<Client> findByEmail(String email);
+
+  @CacheEvict(value = "clients", key = "#entity.email")
+  <S extends Client> S save(S entity);
 }

services/users/src/main/java/com/workup/users/repositories/FreelancerRepository.java

@@ -2,9 +2,15 @@
 
 import com.workup.users.db.Freelancer;
 import java.util.Optional;
+import org.springframework.cache.annotation.CacheEvict;
+import org.springframework.cache.annotation.Cacheable;
 import org.springframework.data.mongodb.repository.MongoRepository;
 
 public interface FreelancerRepository extends MongoRepository<Freelancer, String> {
   // find by freelancerEmail
+  @Cacheable(value = "freelancers", key = "#email")
   Optional<Freelancer> findByEmail(String email);
+
+  @CacheEvict(value = "freelancers", key = "#entity.email")
+  <S extends Freelancer> S save(S entity);
 }

services/users/src/main/resources/application.properties

@@ -1,8 +1,14 @@
 spring.data.mongodb.uri=${USERS_DB_URI}
 spring.data.mongodb.database=mydatabase
+spring.data.mongodb.auto-index-creation=true
 
 spring.rabbitmq.host=${USERS_MQ_HOST}
 spring.rabbitmq.port=5672
 spring.rabbitmq.username=guest
 spring.rabbitmq.password=guest
 SECRET_KEY=${USERS_SECRET_KEY}
+
+spring.cache.type=redis
+spring.cache.host=${REDIS_URL}
+spring.cache.port=6379
+spring.cache.redis.time-to-live=60000

services/users/src/test/java/com/workup/users/UsersApplicationTests.java

@@ -27,6 +27,7 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.test.context.DynamicPropertyRegistry;
 import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.MongoDBContainer;
 import org.testcontainers.containers.RabbitMQContainer;
 import org.testcontainers.junit.jupiter.Container;
@@ -45,6 +46,11 @@ class UsersApplicationTests {
   static final MongoDBContainer mongoDBContainer =
       new MongoDBContainer("mongo:7.0").withExposedPorts(27017);
 
+  // redis container
+  @Container
+  static final GenericContainer redisContainer =
+      new GenericContainer("redis:7.2.4").withExposedPorts(6379);
+
   @Autowired private AmqpTemplate template;
   @Autowired private ClientRepository paymentRequestRepository;
   @Autowired private ExperienceRepository experienceRepository;
@@ -78,6 +84,9 @@ static void setDatasourceProperties(DynamicPropertyRegistry registry) {
     registry.add("spring.rabbitmq.port", rabbitMQContainer::getFirstMappedPort);
     registry.add("spring.rabbitmq.username", rabbitMQContainer::getAdminUsername);
     registry.add("spring.rabbitmq.password", rabbitMQContainer::getAdminPassword);
+    // add redis properties
+    registry.add("spring.cache.host", redisContainer::getHost);
+    registry.add("spring.cache.port", redisContainer::getFirstMappedPort);
   }
 
   @Test