EI-11 GET batches/{id} endpoint #46

dcarello · 2025-11-10T04:22:16Z

Connected the batches/{id} endpoint to the database. Tested that it works using Postman. Updated Unit Tests also

Summary by CodeRabbit

New Features
- Batch management API now uses UUID identifiers instead of numeric IDs.
- Batch response data includes schedule ID, start time, last run time, and active status.
- Enhanced error handling with dedicated batch not found exception.
Tests
- Updated test coverage for new batch API structure and exception scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Connected the batches/{id} endpoint to the database. Tested that it works using Postman. Updated Unit Tests also

codecov · 2025-11-10T04:23:08Z

Codecov Report

❌ Patch coverage is 98.00000% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
.../vsp/endpointinsightsapi/service/BatchService.java	93.75%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

...int-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/BatchesController.java

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/service/BatchService.java

Put DTO in its own class and used mapStruct so it can auto generated the mapping.

coderabbitai · 2025-11-19T07:14:38Z

Walkthrough

Added MapStruct integration with Lombok binding and refactored Batch API to use UUID identifiers, DTOs, repository patterns, and a dedicated mapper. Updated controller, service, and tests to use new BatchResponseDTO with revised fields and explicit exception handling.

Changes

Cohort / File(s)	Summary
Build Configuration `endpoint-insights-api/pom.xml`	Added MapStruct (1.5.5.Final), mapstruct-processor (1.5.5.Final), and lombok-mapstruct-binding (0.2.0) dependencies; registered annotation processors for compile-time code generation.
Exception Handling `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/exception/BatchNotFoundException.java`	Introduced new BatchNotFoundException extending CustomException with NOT_FOUND status and "BATCH_NOT_FOUND" error code.
Data Transfer Object `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchResponseDTO.java`	Refactored fields: id (Long → UUID), name → batchName, status → scheduleId (Long); added startTime, lastTimeRun (LocalDate), active (Boolean); added `@Builder` annotation for fluent construction.
Mapper `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/mapper/BatchMapper.java`	Introduced MapStruct mapper interface with toDto(TestBatch) → BatchResponseDTO method; includes `@Mapping` to convert batch\_id field to id.
Repository `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/repository/TestBatchRepository.java`	Added Spring Data JPA repository extending JpaRepository<TestBatch, UUID> for CRUD and query operations.
Controller `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/BatchesController.java`	Changed all path variable types from Long to UUID; refactored listBatches to build DTOs dynamically; delegated get/update/delete operations to BatchService; updated to use BatchResponseDTO in responses.
Service `endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/service/BatchService.java`	Updated constructor to inject TestBatchRepository and BatchMapper; added getBatchById(UUID) → BatchResponseDTO and deleteBatchById(UUID) methods with exception handling; migrated internal repository references from batchRepository to testBatchRepository.
Unit Tests `endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/controller/BatchesControllerUnitTest.java`, `endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/service/BatchServiceTest.java`	Updated controller tests to verify DTO fields (batchName, scheduleId, active, id) and use BatchNotFoundException mocks; refactored service tests to Mockito annotation-driven pattern (`@Mock`, `@InjectMocks`) with explicit exception and mapper interaction verification.

Sequence Diagram

sequenceDiagram
    autonumber
    actor Client
    participant Controller as BatchesController
    participant Service as BatchService
    participant Repository as TestBatchRepository
    participant Mapper as BatchMapper
    participant DB as Database

    rect rgb(200, 220, 240)
    Note over Client,DB: GET /api/batches/{id} - Fetch Single Batch
    Client->>Controller: getBatch(UUID id)
    Controller->>Service: getBatchById(id)
    Service->>Repository: findById(id)
    Repository->>DB: SELECT * FROM test_batch WHERE id=?
    DB-->>Repository: TestBatch entity
    alt Found
        Repository-->>Service: Optional<TestBatch>
        Service->>Mapper: toDto(entity)
        Mapper-->>Service: BatchResponseDTO
        Service-->>Controller: BatchResponseDTO
        Controller-->>Client: 200 OK + DTO
    else Not Found
        Service->>Service: throw BatchNotFoundException
        Service-->>Controller: BatchNotFoundException
        Controller-->>Client: 404 NOT_FOUND
    end
    end

    rect rgb(240, 220, 200)
    Note over Client,DB: DELETE /api/batches/{id} - Delete Batch
    Client->>Controller: deleteBatch(UUID id)
    Controller->>Service: deleteBatchById(id)
    Service->>Repository: existsById(id)
    Repository->>DB: SELECT EXISTS(*)
    DB-->>Repository: boolean
    alt Exists
        Repository-->>Service: true
        Service->>Repository: deleteById(id)
        Repository->>DB: DELETE FROM test_batch WHERE id=?
        Service-->>Controller: void
        Controller-->>Client: 204 NO_CONTENT
    else Not Found
        Repository-->>Service: false
        Service->>Service: throw BatchNotFoundException
        Service-->>Controller: BatchNotFoundException
        Controller-->>Client: 404 NOT_FOUND
    end
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Type migration: UUID/Long identifier change across controller, service, and repository layers requires verification of consistency and null handling.
DTO field mapping: Verify MapStruct mapper correctly handles batch\_id → id conversion and all required field transformations in BatchResponseDTO.
Exception handling: New BatchNotFoundException usage in service and controller; ensure proper propagation and HTTP status code mapping.
Test coverage: Confirm unit tests adequately cover new exception scenarios (getBatchById\_notFound, delete non-existent batch) and DTO field validations.

Possibly related PRs

EI-12 GET endpoint /batch #52: Modifies the same Batch controller, service, and repository integration for UUID-based getBatch/getBatchById operations using TestBatchRepository, suggesting overlapping architectural changes or dependencies.

Poem

🐰 With MapStruct's spell and UUIDs bright,
The Batch API dances with elegant might,
DTOs bloom where old fields once lay,
Repositories spring forth—hip-hip-hooray!
Our refactor hops forward, clean and lightweight. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 38.10% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the primary change: implementing the GET batches/{id} endpoint. It is concise, specific, and directly reflects the main objective described in the PR.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feature/EI-11

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 3

♻️ Duplicate comments (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/BatchesController.java (1)

25-48: Stubbed list/create/update endpoints should eventually use the service/DB

listBatches, createBatch, and updateBatch still construct BatchResponseDTO instances in memory with hard‑coded or calculated values and UUID.randomUUID() instead of going through BatchService / the database. Prior reviewers have already called this out, and you’ve noted it’s out of scope for this sprint.

Once the backing persistence is ready, it would be good to:

Have listBatches query via a service/repository instead of returning literals.

Route createBatch and updateBatch through BatchService, letting the DB assign the UUID and persist startTime / lastTimeRun consistently.

Remove now‑unused imports like Collections and commented jobs fields when that work is done.

Also applies to: 56-84

🧹 Nitpick comments (4)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchRequestDTO.java (1)

16-19: DTO shape looks consistent; consider name vs batchName alignment

The added fields (scheduleId, startTime, active) look consistent with BatchResponseDTO and the new service layer usage. One optional cleanup is to consider aligning name here with batchName in BatchResponseDTO (or vice versa), or ensure the mapper/service explicitly handles the difference so you don’t get silent mapping issues later.

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/mapper/BatchMapper.java (1)

7-11: Verify MapStruct field mappings, especially ID and name fields

The mapper definition is fine, but with a bare toDto(TestBatch entity) MapStruct will only map by matching property names. In the tests you’re calling entity.setBatch_id(id) while BatchResponseDTO exposes id, and you also have batchName/name differences elsewhere. If the entity’s property names don’t exactly match the DTO, you’ll get nulls or warnings at build time.

Consider adding explicit mappings, e.g. @Mapping(source = "batch_id", target = "id"), and any others that differ, to make the mapping contract explicit and future‑proof.
endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/service/BatchServiceTest.java (1)
29-49: Strengthen assertions and interaction checks in service tests (optional)

A couple of small improvements would make these tests more robust:

In getBatchById_returnsDto, you already set startTime and lastTimeRun on the entity; consider also asserting them on the returned DTO to detect future mapping regressions.

In deleteBatchById_NotFound, you can optionally verify that deleteById is never called when existsById is false, to pin down the intended behavior.

For example:
@@     void getBatchById_returnsDto() {
-        assertThat(dto.getId()).isEqualTo(id);
-        assertThat(dto.getBatchName()).isEqualTo("Example");
-        assertThat(dto.getScheduleId()).isEqualTo(1001L);
-        assertThat(dto.getActive()).isTrue();
+        assertThat(dto.getId()).isEqualTo(id);
+        assertThat(dto.getBatchName()).isEqualTo("Example");
+        assertThat(dto.getScheduleId()).isEqualTo(1001L);
+        assertThat(dto.getStartTime()).isEqualTo(LocalDate.parse("2025-11-08"));
+        assertThat(dto.getLastTimeRun()).isEqualTo(LocalDate.parse("2025-11-09"));
+        assertThat(dto.getActive()).isTrue();
@@     void deleteBatchById_NotFound() {
-        assertThrows(BatchNotFoundException.class, () -> batchService.deleteBatchById(id));
+        assertThrows(BatchNotFoundException.class, () -> batchService.deleteBatchById(id));
+        verify(testBatchRepository, org.mockito.Mockito.never()).deleteById(id);
These are optional but help lock in the intended contract of BatchService.

Also applies to: 59-75
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchResponseDTO.java (1)

11-22: DTO shape matches usage; consider naming consistency with BatchRequestDTO

BatchResponseDTO’s fields (id, batchName, scheduleId, startTime, lastTimeRun, active) line up with how the controller and tests are using the response. The only minor inconsistency is that the request DTO uses name while the response uses batchName, which can be slightly confusing for API consumers.

If you don’t have external clients depending on these names yet, you might consider aligning them (either name everywhere or batchName everywhere) in a follow‑up change.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df5d3ee and c572d43.

📒 Files selected for processing (10)

endpoint-insights-api/pom.xml (2 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/BatchesController.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchRequestDTO.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchResponseDTO.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/exception/BatchNotFoundException.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/mapper/BatchMapper.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/repository/TestBatchRepository.java (1 hunks)
endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/service/BatchService.java (1 hunks)
endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/controller/BatchesControllerUnitTest.java (2 hunks)
endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/service/BatchServiceTest.java (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (6)

endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/service/BatchServiceTest.java (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/exception/BatchNotFoundException.java (1)

BatchNotFoundException (8-14)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/BatchesController.java (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/controller/JobsController.java (1)

RestController (25-157)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchResponseDTO.java (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchRequestDTO.java (1)

Getter (11-20)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/service/BatchService.java (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/exception/BatchNotFoundException.java (1)

BatchNotFoundException (8-14)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchRequestDTO.java (1)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/dto/BatchResponseDTO.java (1)

Getter (11-23)

endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/controller/BatchesControllerUnitTest.java (3)

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/exception/BatchNotFoundException.java (1)

BatchNotFoundException (8-14)

endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/controller/JobControllerUnitTest.java (1)

TestPropertySource (29-103)

endpoint-insights-api/src/test/java/com/vsp/endpointinsightsapi/EndpointInsightsApiApplicationTests.java (1)

ActiveProfiles (8-18)

🪛 GitHub Actions: Codecov Backend

endpoint-insights-api/src/main/java/com/vsp/endpointinsightsapi/repository/TestBatchRepository.java