create a new package to store api files

csr · Jul 4, 2024 · 4b13d16 · 4b13d16
1 parent 24e4370
commit 4b13d16
Show file tree

Hide file tree

Showing 55 changed files with 43 additions and 50 deletions.
diff --git a/...ecal.models.$PeopleResponse$Introspection → ...sapi.models.$PeopleResponse$Introspection b/...ecal.models.$PeopleResponse$Introspection → ...sapi.models.$PeopleResponse$Introspection
diff --git a/...dels.$PeopleResponse$Person$Introspection → ...dels.$PeopleResponse$Person$Introspection b/...dels.$PeopleResponse$Person$Introspection → ...dels.$PeopleResponse$Person$Introspection
diff --git a/...cal.models.$PlanetsResponse$Introspection → ...api.models.$PlanetsResponse$Introspection b/...cal.models.$PlanetsResponse$Introspection → ...api.models.$PlanetsResponse$Introspection
diff --git a/...els.$PlanetsResponse$Planet$Introspection → ...els.$PlanetsResponse$Planet$Introspection b/...els.$PlanetsResponse$Planet$Introspection → ...els.$PlanetsResponse$Planet$Introspection
diff --git a/...m.cesaredecal.$JsonFileService$Definition → ...l.starwarsapi.$JsonFileService$Definition b/...m.cesaredecal.$JsonFileService$Definition → ...l.starwarsapi.$JsonFileService$Definition
diff --git a/...al.$StarWarsClient$Intercepted$Definition → ...pi.$StarWarsClient$Intercepted$Definition b/...al.$StarWarsClient$Intercepted$Definition → ...pi.$StarWarsClient$Intercepted$Definition
diff --git a/...ventListener$init1$Intercepted$Definition → ...ventListener$init1$Intercepted$Definition b/...ventListener$init1$Intercepted$Definition → ...ventListener$init1$Intercepted$Definition
diff --git a/...m.cesaredecal.$StarWarsService$Definition → ...l.starwarsapi.$StarWarsService$Definition b/...m.cesaredecal.$StarWarsService$Definition → ...l.starwarsapi.$StarWarsService$Definition
diff --git a/...decal/$DefaultController$ApplicationEventListener$init1$Intercepted$Definition$Exec.class b/...decal/$DefaultController$ApplicationEventListener$init1$Intercepted$Definition$Exec.class
diff --git a/...esaredecal/$DefaultController$ApplicationEventListener$init1$Intercepted$Definition.class b/...esaredecal/$DefaultController$ApplicationEventListener$init1$Intercepted$Definition.class
diff --git a/backend/bin/default/com/cesaredecal/$DefaultController$Definition$Exec.class b/backend/bin/default/com/cesaredecal/$DefaultController$Definition$Exec.class
diff --git a/backend/bin/default/com/cesaredecal/$DefaultController$Definition.class b/backend/bin/default/com/cesaredecal/$DefaultController$Definition.class
diff --git a/backend/bin/default/com/cesaredecal/$DefaultController$ReflectConfig.class b/backend/bin/default/com/cesaredecal/$DefaultController$ReflectConfig.class
diff --git a/backend/bin/default/com/cesaredecal/$StarWarsClient$Intercepted$Definition$Exec.class b/backend/bin/default/com/cesaredecal/$StarWarsClient$Intercepted$Definition$Exec.class
diff --git a/...ecal/$StarWarsController$ApplicationEventListener$init1$Intercepted$Definition$Exec.class b/...ecal/$StarWarsController$ApplicationEventListener$init1$Intercepted$Definition$Exec.class
diff --git a/...saredecal/$StarWarsController$ApplicationEventListener$init1$Intercepted$Definition.class b/...saredecal/$StarWarsController$ApplicationEventListener$init1$Intercepted$Definition.class
diff --git a/backend/bin/default/com/cesaredecal/$StarWarsController$Definition.class b/backend/bin/default/com/cesaredecal/$StarWarsController$Definition.class
diff --git a/backend/bin/default/com/cesaredecal/$StarWarsService$ReflectConfig.class b/backend/bin/default/com/cesaredecal/$StarWarsService$ReflectConfig.class
diff --git a/...efault/com/cesaredecal/DefaultController$ApplicationEventListener$init1$Intercepted.class b/...efault/com/cesaredecal/DefaultController$ApplicationEventListener$init1$Intercepted.class
diff --git a/...fault/com/cesaredecal/StarWarsController$ApplicationEventListener$init1$Intercepted.class b/...fault/com/cesaredecal/StarWarsController$ApplicationEventListener$init1$Intercepted.class
diff --git a/...redecal/$JsonFileService$Definition.class → ...warsapi/$JsonFileService$Definition.class b/...redecal/$JsonFileService$Definition.class → ...warsapi/$JsonFileService$Definition.class
diff --git a/...bin/default/com/cesaredecal/starwarsapi/$StarWarsClient$Intercepted$Definition$Exec.class b/...bin/default/com/cesaredecal/starwarsapi/$StarWarsClient$Intercepted$Definition$Exec.class
diff --git a/...arWarsClient$Intercepted$Definition.class → ...arWarsClient$Intercepted$Definition.class b/...arWarsClient$Intercepted$Definition.class → ...arWarsClient$Intercepted$Definition.class
diff --git a/...r$init1$Intercepted$Definition$Exec.class → ...r$init1$Intercepted$Definition$Exec.class b/...r$init1$Intercepted$Definition$Exec.class → ...r$init1$Intercepted$Definition$Exec.class
diff --git a/...stener$init1$Intercepted$Definition.class → ...stener$init1$Intercepted$Definition.class b/...stener$init1$Intercepted$Definition.class → ...stener$init1$Intercepted$Definition.class
diff --git a/...al/$StarWarsService$Definition$Exec.class → ...pi/$StarWarsService$Definition$Exec.class b/...al/$StarWarsService$Definition$Exec.class → ...pi/$StarWarsService$Definition$Exec.class
diff --git a/...redecal/$StarWarsService$Definition.class → ...warsapi/$StarWarsService$Definition.class b/...redecal/$StarWarsService$Definition.class → ...warsapi/$StarWarsService$Definition.class
diff --git a/...aredecal/StarWarsClient$Intercepted.class → ...rwarsapi/StarWarsClient$Intercepted.class b/...aredecal/StarWarsClient$Intercepted.class → ...rwarsapi/StarWarsClient$Intercepted.class
diff --git a/...tionEventListener$init1$Intercepted.class → ...tionEventListener$init1$Intercepted.class b/...tionEventListener$init1$Intercepted.class → ...tionEventListener$init1$Intercepted.class
diff --git a/...odels/$PeopleResponse$Introspection.class → ...odels/$PeopleResponse$Introspection.class b/...odels/$PeopleResponse$Introspection.class → ...odels/$PeopleResponse$Introspection.class
diff --git a/...PeopleResponse$Person$Introspection.class → ...PeopleResponse$Person$Introspection.class b/...PeopleResponse$Person$Introspection.class → ...PeopleResponse$Person$Introspection.class
diff --git a/...dels/$PlanetsResponse$Introspection.class → ...dels/$PlanetsResponse$Introspection.class b/...dels/$PlanetsResponse$Introspection.class → ...dels/$PlanetsResponse$Introspection.class
diff --git a/...lanetsResponse$Planet$Introspection.class → ...lanetsResponse$Planet$Introspection.class b/...lanetsResponse$Planet$Introspection.class → ...lanetsResponse$Planet$Introspection.class
diff --git a/backend/bin/main/com/cesaredecal/Application.class b/backend/bin/main/com/cesaredecal/Application.class
diff --git a/backend/bin/main/com/cesaredecal/StarWarsClient.class b/backend/bin/main/com/cesaredecal/StarWarsClient.class
diff --git a/backend/bin/main/com/cesaredecal/StarWarsController.class b/backend/bin/main/com/cesaredecal/StarWarsController.class
diff --git a/backend/bin/main/com/cesaredecal/StarWarsService.class b/backend/bin/main/com/cesaredecal/StarWarsService.class
diff --git a/backend/bin/main/com/cesaredecal/models/PeopleResponse.class b/backend/bin/main/com/cesaredecal/models/PeopleResponse.class
diff --git a/backend/bin/main/com/cesaredecal/models/PlanetsResponse.class b/backend/bin/main/com/cesaredecal/models/PlanetsResponse.class
diff --git a/...ain/com/cesaredecal/JsonFileService.class → ...redecal/starwarsapi/JsonFileService.class b/...ain/com/cesaredecal/JsonFileService.class → ...redecal/starwarsapi/JsonFileService.class
diff --git a/backend/bin/main/com/cesaredecal/starwarsapi/StarWarsClient.class b/backend/bin/main/com/cesaredecal/starwarsapi/StarWarsClient.class
diff --git a/backend/bin/main/com/cesaredecal/starwarsapi/StarWarsService.class b/backend/bin/main/com/cesaredecal/starwarsapi/StarWarsService.class
diff --git a/...ain/com/cesaredecal/models/DataType.class → ...redecal/starwarsapi/models/DataType.class b/...ain/com/cesaredecal/models/DataType.class → ...redecal/starwarsapi/models/DataType.class
diff --git a/...edecal/models/PeopleResponse$Person.class → ...arsapi/models/PeopleResponse$Person.class b/...edecal/models/PeopleResponse$Person.class → ...arsapi/models/PeopleResponse$Person.class
diff --git a/backend/bin/main/com/cesaredecal/starwarsapi/models/PeopleResponse.class b/backend/bin/main/com/cesaredecal/starwarsapi/models/PeopleResponse.class
diff --git a/...decal/models/PlanetsResponse$Planet.class → ...rsapi/models/PlanetsResponse$Planet.class b/...decal/models/PlanetsResponse$Planet.class → ...rsapi/models/PlanetsResponse$Planet.class
diff --git a/backend/bin/main/com/cesaredecal/starwarsapi/models/PlanetsResponse.class b/backend/bin/main/com/cesaredecal/starwarsapi/models/PlanetsResponse.class
diff --git a/backend/src/main/java/com/cesaredecal/Application.java b/backend/src/main/java/com/cesaredecal/Application.java
@@ -1,16 +1,10 @@
 package com.cesaredecal;
 
 import io.micronaut.runtime.Micronaut;
-import io.micronaut.runtime.event.ApplicationStartupEvent;
-import io.micronaut.runtime.event.annotation.EventListener;
 
 public class Application {
 
     public static void main(String[] args) {
         Micronaut.run(Application.class, args);
     }
-
-    @EventListener
-    void onStartup(ApplicationStartupEvent event) {
-    }
 }
diff --git a/backend/src/main/java/com/cesaredecal/StarWarsController.java b/backend/src/main/java/com/cesaredecal/StarWarsController.java
@@ -1,5 +1,6 @@
 package com.cesaredecal;
 
+import com.cesaredecal.starwarsapi.StarWarsService;
 import io.micronaut.core.annotation.Nullable;
 import io.micronaut.http.MediaType;
 import io.micronaut.http.annotation.Controller;
@@ -11,7 +12,7 @@
 
 import reactor.core.publisher.Mono;
 
-import com.cesaredecal.models.DataType;
+import com.cesaredecal.starwarsapi.models.DataType;
 
 @Controller("/api/v1")
 public class StarWarsController {
@@ -26,31 +27,24 @@ public StarWarsController(StarWarsService starWarsService) {
     // People endpoints
 
     @Get(value = "/people/columns", produces = MediaType.APPLICATION_JSON)
-    public Mono<String> getPeopleTableColumns() throws IOException {
+    public Mono<String> getPeopleTableColumns() {
         return starWarsService.fetchColumns(DataType.PEOPLE);
     }
 
     @Get(value = "/people/data", produces = MediaType.APPLICATION_JSON)
-    public Mono<String> getPeople(@Nullable @QueryValue String sortBy, @Nullable @QueryValue String sortOrder) throws IOException {
+    public Mono<String> getPeople(@Nullable @QueryValue String sortBy, @Nullable @QueryValue String sortOrder) {
         return starWarsService.fetchTableDataFromStorage(DataType.PEOPLE, sortBy, sortOrder);
     }
 
     // Planets endpoints
 
     @Get(value = "/planets/columns", produces = MediaType.APPLICATION_JSON)
-    public Mono<String> getPlanetsTableColumns() throws IOException {
+    public Mono<String> getPlanetsTableColumns() {
         return starWarsService.fetchColumns(DataType.PLANETS);
     }
 
     @Get(value = "/planets/data", produces = MediaType.APPLICATION_JSON)
-    public Mono<String> getPlanetsTableData(@Nullable @QueryValue String sortBy, @Nullable @QueryValue String sortOrder) throws IOException {
+    public Mono<String> getPlanetsTableData(@Nullable @QueryValue String sortBy, @Nullable @QueryValue String sortOrder) {
         return starWarsService.fetchTableDataFromStorage(DataType.PLANETS, sortBy, sortOrder);
     }
-
-    // Possible future improvement:
-    // Add a /ready or /health endpoint so that the platform solution (e.g. Kubernetes) knows when the application can
-    // be considered to be "ready". In the /ready endpoint we would check if the people_data and planets_data JSON files
-    // are already available. If yes, we're good to go and the application is ready to start receiving requests.
-    // This is to avoid the state of the backend app being up but it still hasn't finished download the data from the
-    // backend. Kubernetes makes this easy to do.
 }
diff --git a/...java/com/cesaredecal/JsonFileService.java → ...aredecal/starwarsapi/JsonFileService.java b/...java/com/cesaredecal/JsonFileService.java → ...aredecal/starwarsapi/JsonFileService.java
@@ -1,6 +1,5 @@
-package com.cesaredecal;
+package com.cesaredecal.starwarsapi;
 
-import com.cesaredecal.models.PeopleResponse;
 import io.micronaut.serde.ObjectMapper;
 
 import javax.inject.Inject;
@@ -11,7 +10,6 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
-import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 

diff --git a/.../java/com/cesaredecal/StarWarsClient.java → ...saredecal/starwarsapi/StarWarsClient.java b/.../java/com/cesaredecal/StarWarsClient.java → ...saredecal/starwarsapi/StarWarsClient.java
@@ -1,7 +1,7 @@
-package com.cesaredecal;
+package com.cesaredecal.starwarsapi;
 
-import com.cesaredecal.models.PeopleResponse;
-import com.cesaredecal.models.PlanetsResponse;
+import com.cesaredecal.starwarsapi.models.PeopleResponse;
+import com.cesaredecal.starwarsapi.models.PlanetsResponse;
 import io.micronaut.http.annotation.Get;
 import io.micronaut.http.annotation.QueryValue;
 import io.micronaut.http.client.annotation.Client;

diff --git a/...java/com/cesaredecal/StarWarsService.java → ...aredecal/starwarsapi/StarWarsService.java b/...java/com/cesaredecal/StarWarsService.java → ...aredecal/starwarsapi/StarWarsService.java
@@ -1,8 +1,8 @@
-package com.cesaredecal;
+package com.cesaredecal.starwarsapi;
 
-import com.cesaredecal.models.DataType;
-import com.cesaredecal.models.PeopleResponse;
-import com.cesaredecal.models.PlanetsResponse;
+import com.cesaredecal.starwarsapi.models.DataType;
+import com.cesaredecal.starwarsapi.models.PeopleResponse;
+import com.cesaredecal.starwarsapi.models.PlanetsResponse;
 import io.micronaut.context.event.StartupEvent;
 import io.micronaut.core.type.Argument;
 import io.micronaut.runtime.event.annotation.EventListener;
@@ -96,31 +96,39 @@ public void fetchTableDataAndSaveJson(DataType dataType) {
 
     // Read operations
 
-    public Mono<String> fetchColumns(DataType dataType) throws IOException {
-        String fileName = dataType.getColumnsFileName();
-        return Mono.just(jsonFileService.readJsonFile(fileName));
+    public Mono<String> fetchColumns(DataType dataType) {
+        try {
+            String fileName = dataType.getColumnsFileName();
+            return Mono.just(jsonFileService.readJsonFile(fileName));
+        } catch (IOException e) {
+            return Mono.error(new RuntimeException("Error fetching columns data for " + dataType, e));
+        }
     }
 
-    public <T> Mono<String> fetchTableDataFromStorage(DataType dataType, String sortBy, String sortOrder) throws IOException {
-        String fileName = dataType.getDataFileName();
-        String jsonContent = jsonFileService.readJsonFile(fileName);
+    public <T> Mono<String> fetchTableDataFromStorage(DataType dataType, String sortBy, String sortOrder) {
+        try {
+            String fileName = dataType.getDataFileName();
+            String jsonContent = jsonFileService.readJsonFile(fileName);
 
-        // Exit early if no sorting is needed
-        if ((sortBy == null || sortBy.isEmpty()) || (sortOrder == null || sortOrder.isEmpty())) {
-            return Mono.just(jsonContent);
-        }
+            // Exit early if no sorting is needed
+            if ((sortBy == null || sortBy.isEmpty()) || (sortOrder == null || sortOrder.isEmpty())) {
+                return Mono.just(jsonContent);
+            }
 
-        Class<T> type = (Class<T>) dataType.getType();
-        List<T> data = objectMapper.readValue(jsonContent, Argument.listOf(type));
-        Comparator<T> comparator = getComparator(dataType, sortBy);
+            Class<T> type = (Class<T>) dataType.getType();
+            List<T> data = objectMapper.readValue(jsonContent, Argument.listOf(type));
+            Comparator<T> comparator = getComparator(dataType, sortBy);
 
-        if ("desc".equalsIgnoreCase(sortOrder)) {
-            comparator = comparator.reversed();
-        }
+            if ("desc".equalsIgnoreCase(sortOrder)) {
+                comparator = comparator.reversed();
+            }
 
-        Collections.sort(data, comparator);
+            Collections.sort(data, comparator);
 
-        return Mono.just(objectMapper.writeValueAsString(data));
+            return Mono.just(objectMapper.writeValueAsString(data));
+        } catch (IOException e) {
+            return Mono.error(new RuntimeException("Error fetching table data for " + dataType, e));
+        }
     }
 
     private <T> Comparator<T> getComparator(DataType dataType, String sortBy) {
@@ -151,5 +159,4 @@ private Comparator<PlanetsResponse.Planet> getPlanetsComparator(String sortBy) {
                 return Comparator.comparing(PlanetsResponse.Planet::getName);
         }
     }
-
 }
diff --git a/...java/com/cesaredecal/models/DataType.java → ...aredecal/starwarsapi/models/DataType.java b/...java/com/cesaredecal/models/DataType.java → ...aredecal/starwarsapi/models/DataType.java
@@ -1,4 +1,4 @@
-package com.cesaredecal.models;
+package com.cesaredecal.starwarsapi.models;
 
 public enum DataType {
     PEOPLE("people_data.json", "people_metadata.json", PeopleResponse.Person.class),

diff --git a/...om/cesaredecal/models/PeopleResponse.java → ...al/starwarsapi/models/PeopleResponse.java b/...om/cesaredecal/models/PeopleResponse.java → ...al/starwarsapi/models/PeopleResponse.java
@@ -1,4 +1,4 @@
-package com.cesaredecal.models;
+package com.cesaredecal.starwarsapi.models;
 
 import io.micronaut.core.annotation.Introspected;
 import com.fasterxml.jackson.annotation.JsonProperty;

diff --git a/...m/cesaredecal/models/PlanetsResponse.java → ...l/starwarsapi/models/PlanetsResponse.java b/...m/cesaredecal/models/PlanetsResponse.java → ...l/starwarsapi/models/PlanetsResponse.java
@@ -1,4 +1,4 @@
-package com.cesaredecal.models;
+package com.cesaredecal.starwarsapi.models;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.micronaut.serde.annotation.Serdeable;