Merge pull request #170 from amosproj/sprint-10

Sprint 10

Author: jnsrnhld

.gitattributes

@@ -1,2 +1,4 @@
 # force line ending to lf on windows since this will be executed in a linux container
 demodata/setup-topology/setup-topology.sh eol=lf
+demodata/setup-topology/setup-topology-local.sh eol=lf
+demodata/setup-topology/setup-topology-aws.sh eol=lf

.gitignore

@@ -1,3 +1,5 @@
+.env
+
 # Node
 logs
 npm-debug.log*

README.md

@@ -16,24 +16,28 @@ We want to achieve this by structuring our UI according to the topology of Apach
 
 First, build the application JAR from the `backend` directory with:
 
-```./mvnw package -DskipTests```
-
+`./mvnw package -DskipTests`
 
 Then, start Docker Desktop and create the pulsar setup from the root-directory with:
 
-```docker-compose --profile demodata --profile backend up --build```
+```bash
+echo BACKEND_IP=localhost >> .env
+docker-compose --profile demodata --profile backend --profile frontend up --build -d
+```
 
 Notes: 
 * `--build` is needed for the first startup, or when the demodata docker images are changed
+* `-d` runs the container in the background, so u can close the terminal without terminating the app itself.
 * `--profile demodata` is needed when you want to create the demo topology and start the demo producers & consumers, that will continuously send and receive messages
 * `--profile backend` is needed when you want to start the backend via the docker-compose setup. See below for starting it manually.
+* `--profile frontend` is needed when you want to start the frontend via the docker-compose setup. 
 
 ### Starting the backend separately
 
 If you want to start the backend individually (e.g. during development), simply omit the `--profile backend` from the docker-compose command.
 Instead, start the application from the `backend` directory with:
 
-```./mvnw spring-boot:run```
+`./mvnw spring-boot:run`
 
 ### Tests
 
@@ -42,10 +46,23 @@ but instead use testcontainers. Therefore, docker needs to be running.
 
 To start the tests use:
 
-```./mvnw test```
+`./mvnw test`
 
 ### REST API
 
 The backend is running on Port 8081 and the prefix of the REST endpoint is `/api`. A complete documentation can
 be found here:
 http://localhost:8081/api/swagger-ui/index.html
+
+
+### Running on AWS
+
+For testing the scalability of our project, we want to test it on AWS with a bigger topology.
+We created a separate setup-topology for that - To start the backend using this, you need to run the following command.
+Each time the EC2 instance is started again, it will be assigned a new IP address,
+so you need to pass it to the `docker-compose` via `-e` flag.
+
+```bash
+echo BACKEND_IP=${EC2_IP_ADDRESS} >> .env
+docker-compose --profile demodata-aws --profile backend --profile frontend up --build -d
+```

backend/src/main/java/de/amos/apachepulsarui/config/CaffeineCacheConfig.java

@@ -14,9 +14,9 @@ public class CaffeineCacheConfig {
     @Bean
     public Caffeine<Object, Object> caffeineConfig() {
         return Caffeine.newBuilder()
-                .initialCapacity(10)
-                .maximumSize(100)
-                .expireAfterWrite(10, TimeUnit.MINUTES)
+                .initialCapacity(10_000)
+                .maximumSize(10_000)
+                .expireAfterWrite(1, TimeUnit.DAYS)
                 .recordStats();
     }
 

backend/src/main/java/de/amos/apachepulsarui/controller/ClusterController.java

@@ -1,6 +1,6 @@
 package de.amos.apachepulsarui.controller;
 
-import de.amos.apachepulsarui.dto.ClusterDto;
+import de.amos.apachepulsarui.dto.ClusterDetailDto;
 import de.amos.apachepulsarui.dto.ClustersDto;
 import de.amos.apachepulsarui.service.ClusterService;
 import lombok.RequiredArgsConstructor;
@@ -19,7 +19,7 @@ public class ClusterController {
     private final ClusterService clusterService;
 
     @GetMapping()
-    public ResponseEntity<ClusterDto> getClusterDetails(@RequestParam String clusterName) {
+    public ResponseEntity<ClusterDetailDto> getClusterDetails(@RequestParam String clusterName) {
         return new ResponseEntity<>(clusterService.getClusterDetails(clusterName), HttpStatus.OK);
     }
 

backend/src/main/java/de/amos/apachepulsarui/controller/MessageController.java

@@ -28,8 +28,10 @@ public class MessageController {
 
     @GetMapping
     public ResponseEntity<MessagesDto> getMessages(@RequestParam String topic,
-                                                   @RequestParam(required = false, defaultValue = "10") Integer numMessages) {
-        List<MessageDto> messageDtos = messageService.getLatestMessagesOfTopic(topic, numMessages);
+                                                   @RequestParam(required = false, defaultValue = "10") Integer numMessages,
+                                                   @RequestParam(required = false, defaultValue = "") List<String> producers,
+                                                   @RequestParam(required = false, defaultValue = "") List<String> subscriptions) {
+        List<MessageDto> messageDtos = messageService.getLatestMessagesFiltered(topic, numMessages, producers, subscriptions);
         return new ResponseEntity<>(new MessagesDto(messageDtos), HttpStatus.OK);
     }
 }

backend/src/main/java/de/amos/apachepulsarui/controller/TopicController.java

@@ -6,16 +6,23 @@
 
 package de.amos.apachepulsarui.controller;
 
-import de.amos.apachepulsarui.dto.*;
-import de.amos.apachepulsarui.exception.BadRequestException;
+import de.amos.apachepulsarui.dto.ConsumerDto;
+import de.amos.apachepulsarui.dto.ProducerDto;
+import de.amos.apachepulsarui.dto.SubscriptionDto;
+import de.amos.apachepulsarui.dto.TopicDetailDto;
+import de.amos.apachepulsarui.dto.TopicDto;
+import de.amos.apachepulsarui.dto.TopicsDto;
 import de.amos.apachepulsarui.service.NamespaceService;
 import de.amos.apachepulsarui.service.TenantService;
 import de.amos.apachepulsarui.service.TopicService;
 import lombok.RequiredArgsConstructor;
-import org.apache.pulsar.common.naming.TopicName;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
 
@@ -77,15 +84,6 @@ public ResponseEntity<ConsumerDto> getConsumerByNameAndTopic(@RequestParam Strin
         return new ResponseEntity<>(topicService.getConsumerByTopic(topic, consumer), HttpStatus.OK);
     }
 
-    @PostMapping("/new")
-    public ResponseEntity<Void> newTopic(@RequestParam String topic) {
-        if (!TopicName.isValid(topic)) {
-            throw new BadRequestException.InvalidTopicName();
-        }
-        topicService.createNewTopic(topic);
-        return new ResponseEntity<>(HttpStatus.CREATED);
-    }
-
     private ResponseEntity<TopicsDto> wrapInEntity(List<TopicDto> topicDtos) {
         return new ResponseEntity<>(new TopicsDto(topicDtos), HttpStatus.OK);
     }

backend/src/main/java/de/amos/apachepulsarui/dto/ClusterDetailDto.java

@@ -0,0 +1,35 @@
+/*
+ * SPDX-License-Identifier: MIT
+ * SPDX-FileCopyrightText: 2023 Niklas Teschner <niklas.teschner@web.de>
+ */
+
+package de.amos.apachepulsarui.dto;
+
+import lombok.AccessLevel;
+import lombok.Builder;
+import lombok.Data;
+import lombok.Setter;
+
+import java.util.List;
+
+@Data
+@Builder
+public class ClusterDetailDto {
+
+    private String name;
+
+    private List<String> tenants;
+
+	private List<String> brokers;
+
+	@Setter(AccessLevel.PRIVATE)
+	private int amountOfTenants;
+
+	@Setter(AccessLevel.PRIVATE)
+	private int amountOfBrokers;
+
+	private String brokerServiceUrl;
+
+	private String serviceUrl;
+
+}

backend/src/main/java/de/amos/apachepulsarui/dto/ClusterDto.java

@@ -5,31 +5,19 @@
 
 package de.amos.apachepulsarui.dto;
 
-import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.Data;
-import lombok.Setter;
-
-import java.util.List;
 
 @Data
 @Builder
 public class ClusterDto {
 
     private String name;
 
-    private List<String> tenants;
-
-	private List<String> brokers;
-
-	@Setter(AccessLevel.PRIVATE)
-	private int amountOfTenants;
-
-	@Setter(AccessLevel.PRIVATE)
-	private int amountOfBrokers;
-
-	private String brokerServiceUrl;
-
-	private String serviceUrl;
+    private long numberOfTenants;
 
+    private long numberOfNamespces;
+    public static ClusterDto create(String name) {
+        return ClusterDto.builder().name(name).build();
+    }
 }

backend/src/main/java/de/amos/apachepulsarui/dto/ClustersDto.java

@@ -14,6 +14,6 @@
 @AllArgsConstructor
 public class ClustersDto {
 
-    private List<String> clusters;
+    private List<ClusterDto> clusters;
 
 }