Intermediate commit: #65

CoderRamya · 2025-05-23T18:42:39Z

No description provided.

samuelowino · 2025-05-23T19:21:20Z

src/main/java/com/kenyajug/regression/controllers/LogsController.java

 @Controller
 public class LogsController {
    private final RetrievalService retrievalService;
-    public LogsController(RetrievalService retrievalService) {


This is supposed to be a REST controller, you should not be returning a view name like the with the controllers serving thymeleaf html files. The REST controllers will be returning JSON instead of view names (string)

REST Controller vs. Web Controller

It looks like you're using a REST controller, but you're returning a view name (like "home" or "dashboard"), which is meant for HTML templates such as those rendered by Thymeleaf.

🚫 In REST controllers:

You should not return a view name (e.g., "home").

Instead, you should return data (typically in JSON format).

✅ What you should do:

Use @RestController if your endpoint is meant to return data.

Return an object or a collection, not a view name.

✅ Example:

@RestController public class UserController { @GetMapping("/api/users") public List<User> getUsers() { return userService.getAllUsers(); // Spring automatically converts this to JSON } }

🧠 Quick Tip:

Use @Controller when returning HTML views (with Thymeleaf, JSP, etc.).

Use @RestController when returning JSON (typical for APIs).

Here are some resources you can use to better learn about REST controllers

📘 Official & Introductory Resources

Spring Boot Reference Docs (REST Controllers)

📖 https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.spring-web

Focus: @RestController, @ResponseBody, JSON responses

Spring.io: Building a RESTful Web Service

📘 https://spring.io/guides/gs/rest-service/

Hands-on guide: Build a REST API step by step

Spring.io: Serving Web Content with Spring MVC

📘 https://spring.io/guides/gs/serving-web-content/

Covers traditional MVC with @Controller and Thymeleaf

📺 Video Tutorials

Spring Boot REST API Tutorial (Amigoscode)

🎥 https://www.youtube.com/watch?v=9SGDpanrc8U

Great for visual learners and beginners

Java Brains – Spring Boot Quick Start

🎥 https://www.youtube.com/playlist?list=PLqq-6Pq4lTTZSKAFG6aCDVDP86Qx4lNas

Breaks down REST concepts with clear examples

📚 Articles & Blog Posts

Baeldung: Difference Between @controller and @RestController

📄 https://www.baeldung.com/spring-controller-vs-restcontroller

Excellent explanation with code examples

Baeldung: Introduction to Spring REST Controllers

📄 https://www.baeldung.com/building-a-restful-web-service-with-spring-and-java-based-configuration

Covers REST design and configuration in-depth

Tools You Can Test With

Postman – Use this to send HTTP requests to your REST API and inspect JSON responses.

@samuelowino I am trying to access the end point via postman or swagger. but I end up getting 403 forbidden, any pointers to how to get this working will be helpful.

@samuelowino I am trying to access the end point via postman or swagger. but I end up getting 403 forbidden, any pointers to how to get this working will be helpful.

You need to include credentials in your request. Postman allows you to include a user account for your tests. Refer to this guide: https://learning.postman.com/docs/sending-requests/authorization/specifying-authorization-details/

@samuelowino
I did add the basic auth on the Authorization tab and respond back with 403 forbidden. Same with the dummy rest controller
I commented the MockTest as they were failing, will fix it.

Could this be due to the form-login only allowed in the securityconfig?

samuelowino · 2025-05-23T19:22:13Z

src/main/java/com/kenyajug/regression/entities/AppLog.java

        String uuid,
+        @NotNull(message = "timestamp cannot be null")
        LocalDateTime timestamp,
+        @NotNull(message = "severity cannot be null")
+        @NotBlank(message = "severity cannot be blank")
        String severity,
+        @NotNull(message = "applicationId cannot be null")
+        @NotBlank(message = "applicationId cannot be blank")
        String applicationId,
        String logSource,
+        @NotBlank(message = "message cannot be null")
+        @NotNull(message = "message cannot be blank")


This are awesome 🔥

samuelowino · 2025-05-23T19:24:26Z

src/main/java/com/kenyajug/regression/controllers/LogsController.java

    }
+
+
+    @PostMapping("/logs/ingest")
+    @PreAuthorize("hasAnyRole('admin','datasource')")
+    public String createLogs(@Valid @RequestBody AppLog appLog){
+        var optionalLog = retrievalService.findLogsById(appLog.uuid());
+        if (optionalLog.isPresent()) {
+            throw new RuntimeException("Log with id " + appLog.uuid() + " already exists");
+        } else {
+            //ingestionService.saveNewLogs(appLog);
+            return "logs-created";
+        }
+    }
+


After implementing these controller(s), consider adding some mockmvc tests for them

📘 Official Documentation

Spring Docs – Testing the Web Layer

📖 https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.testing.spring-boot-applications.testing-with-mockmvc

Covers how to test controllers using @WebMvcTest and MockMvc.

Spring Framework Testing Docs

📖 https://docs.spring.io/spring-framework/docs/current/reference/html/testing.html#spring-mvc-test-framework

Deeper dive into how MockMvc works under the hood.

🎓 Beginner-Friendly Guides and Tutorials

Baeldung: Introduction to MockMvc

📄 https://www.baeldung.com/spring-mvc-test-examples

The go-to guide: explains setup, common use cases, and assertions.

Spring Boot Guide: Unit Testing with MockMvc

📄 https://www.javaguides.net/2019/06/spring-boot-2-unit-testing-crud-rest-api-using-junit-5-and-mockito.html

Step-by-step testing of CRUD operations with MockMvc.

Amigoscode - Spring Boot REST API Testing (YouTube)

🎥 https://www.youtube.com/watch?v=_yN4b3Jc6C4

Very clear and beginner-friendly walk-through of MockMvc.

📄 Example Code Snippet (Basic Test)

@WebMvcTest(UserController.class) class UserControllerTest { @Autowired private MockMvc mockMvc; @MockBean private UserService userService; @Test void shouldReturnListOfUsers() throws Exception { List<User> users = List.of(new User(1, "Alice")); when(userService.getAllUsers()).thenReturn(users); mockMvc.perform(get("/api/users")) .andExpect(status().isOk()) .andExpect(jsonPath("$[0].name").value("Alice")); } }

🧰 Tools & Concepts to Learn Alongside MockMvc

@WebMvcTest – for testing just the controller layer

@MockBean – for mocking dependencies like services

jsonPath() – for validating JSON content

MockHttpServletRequestBuilder – for customizing request headers, body, etc.

Have added the LogsIngestionController to facilitate the log ingestion.

samuelowino

Code looks good, just need proper tests

samuelowino · 2025-05-28T13:26:00Z

src/test/java/com/kenyajug/regression/web_mvc_tests/LogsIngestionControllerTest.java

+//@WebMvcTest(LogsIngestionController.class)
+class LogsIngestionControllerTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+
+    @Mock
+    IIngestionService ingestionService;
+
+    private AppLog appLog;
+
+    //@BeforeEach
+    void setUp() {
+        appLog = new AppLog(
+                "test-uuid",
+                DateTimeUtils.convertZonedUTCTimeStringToLocalDateTime("2025-08-11 11:09:22 UTC") ,
+                "ERROR",
+                "app-123",
+                "",
+                "Test message"
+                // add other fields as needed
+        );
+    }
+


@CoderRamya Can you enable the tests?

Have added the LogsIngestionController to facilitate the log ingestion.

CoderRamya · 2025-06-02T06:46:34Z

@samuelowino : Please have a look
Have made some changes to security config to facilitate both basic auth and form login

Have tested with swagger and postman.

@samuelowino
This implementation has omitted authentication for the rest controller.
Figured out security chain might, I can work on it if you say so

kiranraoboinapally · 2025-06-06T09:14:23Z

still not resolved? @samuelowino
@RestController

samuelowino · 2025-06-06T09:26:36Z

still not resolved? @samuelowino

@RestController

I'll look at it in a bit

kiranraoboinapally · 2025-06-06T09:27:18Z

still not resolved? @samuelowino
@RestController

I'll look at it in a bit

let me know ! ASAP

samuelowino · 2025-06-08T13:40:25Z

still not resolved? @samuelowino
@RestController

I'll look at it in a bit

let me know ! ASAP

@kiranraoboinapally this is not yet resolved, if you can work on it, please go ahead.

Have added the LogsIngestionController to facilitate the log ingestion with Basic Authentication

CoderRamya · 2025-06-09T00:46:13Z

@samuelowino
Have fixed for form-login and basic authentication. It required some tests to be modified.
Tested http://localhost:8080/regression/ingest and http://localhost:8080/regression/login with postman. It works as expected.
It would be great if you could find some time to review it.

samuelowino · 2025-06-27T12:23:20Z

@samuelowino Have fixed for form-login and basic authentication. It required some tests to be modified. Tested http://localhost:8080/regression/ingest and http://localhost:8080/regression/login with postman. It works as expected. It would be great if you could find some time to review it.

Hey @CoderRamya , I have been held up a bit lately, be rest assured I will take time and review it sometime this week or next. Thanks for you patience. In the meantime feel free to work on another issue as I review this

Intermediate commit:

d4c0e60

CoderRamya mentioned this pull request May 23, 2025

Implement log ingestion endpoint #2

Open

samuelowino reviewed May 23, 2025

View reviewed changes

CoderRamya added 3 commits May 24, 2025 18:40

Intermediate commit:

56eabe3

Have added the LogsIngestionController to facilitate the log ingestion.

Intermediate commit:

7989246

Have added the LogsIngestionController to facilitate the log ingestion.

Intermediate commit:

c515654

Have added the LogsIngestionController to facilitate the log ingestion.

samuelowino requested changes May 28, 2025

View reviewed changes

Intermediate commit:

c2b97fd

Have added the LogsIngestionController to facilitate the log ingestion.

Intermediate commit:

e7f554d

Have added the LogsIngestionController to facilitate the log ingestion with Basic Authentication

Removed the permitAll for the specific endpoint

b2cf426

Intermediate commit: #65

Are you sure you want to change the base?

Intermediate commit: #65

Uh oh!

Conversation

CoderRamya commented May 23, 2025

Uh oh!

samuelowino May 23, 2025

Choose a reason for hiding this comment

REST Controller vs. Web Controller

🚫 In REST controllers:

✅ What you should do:

✅ Example:

🧠 Quick Tip:

Here are some resources you can use to better learn about REST controllers

📘 Official & Introductory Resources

📺 Video Tutorials

📚 Articles & Blog Posts

Tools You Can Test With

Uh oh!

CoderRamya May 27, 2025

Choose a reason for hiding this comment

Uh oh!

samuelowino May 28, 2025

Choose a reason for hiding this comment

Uh oh!

CoderRamya May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samuelowino May 23, 2025

Choose a reason for hiding this comment

Uh oh!

samuelowino May 23, 2025

Choose a reason for hiding this comment

📘 Official Documentation

🎓 Beginner-Friendly Guides and Tutorials

📄 Example Code Snippet (Basic Test)

🧰 Tools & Concepts to Learn Alongside MockMvc

Uh oh!

samuelowino left a comment

Choose a reason for hiding this comment

Uh oh!

samuelowino May 28, 2025

Choose a reason for hiding this comment

Uh oh!

CoderRamya commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kiranraoboinapally commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samuelowino commented Jun 6, 2025

Uh oh!

kiranraoboinapally commented Jun 6, 2025

Uh oh!

samuelowino commented Jun 8, 2025

Uh oh!

CoderRamya commented Jun 9, 2025

Uh oh!

samuelowino commented Jun 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CoderRamya May 28, 2025 •

edited

Loading

🧰 Tools & Concepts to Learn Alongside `MockMvc`

CoderRamya commented Jun 2, 2025 •

edited

Loading

kiranraoboinapally commented Jun 6, 2025 •

edited

Loading