Chat/feature

.gitignore

@@ -2,6 +2,8 @@
 ### Java template
 *.class
 
+db-config.yml
+package-lock.json
 # BlueJ files
 *.ctxt
 
@@ -37,4 +39,5 @@ node_modules
 starter-module/src/main/resources/static/*
 starter-module/build/*
 starter-module/node/*
-base-module/node/*
+base-module/node/*
+db-config.yml

README.md

@@ -1,34 +1,84 @@
-# lamisplus-core-enhancement application
-# Run with java version 8.
-## Setting up the database
-This application uses `postgres` database; create a database on postgres 
-and set up the database credentials in the application.yml in lamisplus module
+# LAMISPlus 2.0
 
-## Maven setup
-Use maven 3 upwards, run **mvn dependency:tree** to resolve java dependencies
+## System Requirements
 
-## Starting the website on your local machine
-Just start `coreApplication` with the command **mvn spring-boot:run**.
-This will start up the website using a local database on port **8080**. or another user defined port.
+### Prerequisites to Install
+- IDE of choice (IntelliJ, Eclipse, etc.)
+- Java 8+
+- PostgreSQL 14+
+- `.m2` folder from Google Drive https://drive.google.com/file/d/17F6wHPADVVaDBabajrM9wABUeB04i6D1/view?usp=sharing
 
-Browsing to http://localhost:8080/login should give you the homepage.
+## Run in Development Environment
 
-## Front-end development
-When starting on your local machine, you should get instant reloading of all static files.
-Simply make a change and refresh the page in your browser.
+### How to Install Dependencies
+1. Install Java 8+
+2. Install PostgreSQL 14+
+3. Download and replace the system `.m2` folder.
+4. Clone the git repository:
+    ```bash
+    git clone https://github.com/lamisplus/Core.git
+    ```
+5. Open the project in your IDE of choice.
 
-All front-end related static files are located in `lamisplus/src/main/resources/static`.
+### Update Configuration File
+1. Update database access details in `db-config.yml` file.
+2. Update other Maven application properties as required.
 
-> WARNING: All files in `src/main/resources` will be packaged and deployed with the website.
-> Do not put any files anywhere in that folder if they are not supposed to be deployed!
+### Run Build and Install Commands
+1. Change the directory to `starter-module`:
+    ```bash
+    cd starter-module
+    ```
+2. Run Frontend Build Command:
+    ```bash
+    npm run build
+    ```
+3. Run Maven clean install:
+    ```bash
+    mvn clean install
+    ```
 
-### LiveReload integration
-The application supports LiveReload.
-If you have the plugin in your browser, just activating it on the site should be enough.
+## How to Package for Production Environment
+1. Run Maven package command:
+    ```bash
+    mvn clean package
+    ```
 
-### Front end system
-The application is built using react native for frontend.
+## Launch Packaged JAR File
+1. Launch the JAR file:
+    ```bash
+    java -jar <path-to-jar-file>
+    ```
+2. Optionally, run with memory allocation:
+    ```bash
+    java -jar -Xms4096M -Xmx6144M <path-to-jar-file>
+    ```
 
-## Troubleshooting
-### Resetting the database
-Create a database property in the application.yml
+## Visit the Application
+- Visit the application on a browser at the configured port:
+    ```
+    http://localhost:8080
+    ```
+
+## Access Swagger Documentation
+- Visit the application at:
+    ```
+    http://localhost:8080/swagger-ui.html#/
+    ```
+
+## Access Application Logs
+- Application logs can be accessed in the `application-debug` folder.
+
+## Authors & Acknowledgments
+### Main contributors
+- Victor Ajor   https://github.com/AJ-DataFI
+- Mathew Adegbite https://github.com/mathewade 
+- Emeka https://github.com/drjavanew
+- Abisayo Peter Abiodun https://github.com/Asquarep
+- John gichangi https://github.com/gichangi
+- Joshua https://github.com/JOSH2019GABRIEL
+- Kennedy Kirui https://github.com/kenkirui
+- Tyav Barnabas https://github.com/tyavbarnabas
+
+### Special mentions
+- Dr Karim Usman https://github.com/drkusman

base-module/pom.xml

@@ -707,6 +707,21 @@
 			<artifactId>zip4j</artifactId>
 			<version>2.11.5</version>
 		</dependency>
+		<!-- Caching Dependencies -->
+		<dependency>
+			<groupId>org.ehcache</groupId>
+			<artifactId>ehcache</artifactId>
+			<version>3.10.8</version>
+		</dependency>
+		<dependency>
+			<groupId>javax.cache</groupId>
+			<artifactId>cache-api</artifactId>
+			<version>1.1.1</version>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-context-support</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>

base-module/src/main/java/org/lamisplus/modules/base/configurer/CacheConfig.java

@@ -0,0 +1,88 @@
+package org.lamisplus.modules.base.configurer;
+
+import org.ehcache.config.CacheConfiguration;
+import org.ehcache.config.builders.CacheConfigurationBuilder;
+import org.ehcache.config.builders.ExpiryPolicyBuilder;
+import org.ehcache.config.builders.ResourcePoolsBuilder;
+import org.ehcache.config.units.MemoryUnit;
+import org.ehcache.core.config.DefaultConfiguration;
+import org.ehcache.expiry.ExpiryPolicy;
+import org.ehcache.jsr107.EhcacheCachingProvider;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.cache.jcache.JCacheCacheManager;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import javax.cache.Caching;
+import java.time.Duration;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+@Configuration
+@EnableCaching
+public class CacheConfig {
+    @Value("${cache.names}")
+    private List<String> cacheNames;
+
+    @Value("${cache.heap.size}")
+    private int heapSize;
+
+    @Value("${cache.offheap.size}")
+    private int offheapSize;
+
+    @Value("${cache.offheap.unit}")
+    private String offheapUnit;
+
+    @Value("${cache.expiry.ttl.minutes}")
+    private int ttlMinutes;
+
+    @Value("${cache.expiry.idle.minutes}")
+    private int idleMinutes;
+
+    @Bean
+    public CacheManager jCacheCacheManager() {
+        Map<String, CacheConfiguration<?, ?>> cacheMap = new HashMap<>();
+
+        // Configure each cache from properties (both explicit configs and names list)
+        cacheNames.forEach(cacheName -> {
+            ResourcePoolsBuilder resourcePoolsBuilder = ResourcePoolsBuilder
+                    .heap(heapSize)
+                    .offheap(offheapSize, MemoryUnit.valueOf(offheapUnit));
+
+            ExpiryPolicy<Object, Object> expiryPolicy = createExpiryPolicy(
+                    Duration.ofMinutes(ttlMinutes),
+                    Duration.ofMinutes(idleMinutes)
+            );
+
+            CacheConfiguration<Object, Object> cacheConfiguration = CacheConfigurationBuilder
+                    .newCacheConfigurationBuilder(Object.class, Object.class, resourcePoolsBuilder)
+                    .withExpiry(expiryPolicy)
+                    .build();
+
+            cacheMap.put(cacheName.trim(), cacheConfiguration);
+        });
+
+        EhcacheCachingProvider ehcacheCachingProvider =
+                (EhcacheCachingProvider) Caching.getCachingProvider(EhcacheCachingProvider.class.getName());
+
+        DefaultConfiguration defaultConfiguration =
+                new DefaultConfiguration(cacheMap, ehcacheCachingProvider.getDefaultClassLoader());
+
+        javax.cache.CacheManager cacheManager =
+                ehcacheCachingProvider.getCacheManager(ehcacheCachingProvider.getDefaultURI(), defaultConfiguration);
+
+        return new JCacheCacheManager(cacheManager);
+    }
+
+    private static ExpiryPolicy<Object, Object> createExpiryPolicy(Duration timeToLive, Duration timeToIdle) {
+        return ExpiryPolicyBuilder
+                .expiry()
+                .create(timeToLive)
+                .access(timeToIdle)
+                .build();
+    }
+}

base-module/src/main/java/org/lamisplus/modules/base/configurer/WebSocketConfig.java

@@ -24,7 +24,7 @@ public void registerStompEndpoints(StompEndpointRegistry registry) {
     @Override
     public void configureMessageBroker(MessageBrokerRegistry config) {
         config.setApplicationDestinationPrefixes("/app");
-        config.enableSimpleBroker("/topic");
+        config.enableSimpleBroker("/topic", "specific");
     }
 }
 

base-module/src/main/java/org/lamisplus/modules/base/configurer/WebSocketEventListener.java

@@ -0,0 +1,38 @@
+package org.lamisplus.modules.base.configurer;
+
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import lombok.var;
+import org.lamisplus.modules.base.domain.entities.ChatMessage;
+import org.lamisplus.modules.base.domain.entities.MessageType;
+import org.springframework.context.event.EventListener;
+import org.springframework.messaging.simp.SimpMessageSendingOperations;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.stereotype.Component;
+import org.springframework.web.socket.messaging.SessionDisconnectEvent;
+
+
+@Component
+@RequiredArgsConstructor
+@Slf4j
+public class WebSocketEventListener {
+
+    private final SimpMessageSendingOperations messagingTemplate;
+
+
+    @EventListener
+    public void handleWebSocketDisconnectListener(SessionDisconnectEvent event) {
+         StompHeaderAccessor accessor = StompHeaderAccessor.wrap(event.getMessage());
+        String username = (String) accessor.getSessionAttributes().get("username");
+        if (username == null) {
+//            log.info("Username is disconnected {}", username);
+            System.out.println("Username is disconnected {}" +  username);
+            var chatMessage = ChatMessage.builder()
+                    .type(MessageType.LEAVE)
+                    .sender(username)
+                    .build();
+            messagingTemplate.convertAndSend("/topic/public", chatMessage);
+        }
+    }
+}