Add /books/search endpoint for description-based search #231
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the WalkthroughA new Changes
Sequence DiagramsequenceDiagram
participant Client
participant Controller as BooksController
participant Service as BooksService
participant Repository as BooksRepository
participant Database as Database
Client->>Controller: GET /books/search?description=java
activate Controller
Note over Controller: `@NotBlank` validation
alt Valid (not blank)
Controller->>Service: searchByDescription(keyword)
activate Service
Service->>Repository: findByDescriptionContainingIgnoreCase(keyword)
activate Repository
Repository->>Database: SELECT * WHERE description LIKE (case-insensitive)
activate Database
Database-->>Repository: List<Book>
deactivate Database
deactivate Repository
Service->>Service: Stream & map to List<BookDTO>
Service-->>Controller: List<BookDTO>
deactivate Service
Controller-->>Client: HTTP 200 + JSON response
else Blank or Missing
Note over Controller: Validation fails
Controller-->>Client: HTTP 400 Bad Request
end
deactivate Controller
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.java (1)
69-74: Consider adding cache annotation for search results.Other retrieval methods (
retrieveByIsbn,retrieveAll) use@Cacheableto improve performance. Consider adding caching tosearchByDescriptionto avoid redundant database queries for repeated searches.Apply this diff to add caching:
+@Cacheable(value = "books") public List<BookDTO> searchByDescription(String keyword) { return booksRepository.findByDescriptionContainingIgnoreCase(keyword) .stream() .map(this::mapFrom) .toList(); }src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java (1)
57-58: Consider chaining the assertions.The assertions can be combined into a single AssertJ chain for better readability.
Apply this diff:
-assertThat(actual).isNotEmpty(); -assertThat(actual).allMatch(book -> book.getDescription().toLowerCase().contains("java")); +assertThat(actual) + .isNotEmpty() + .allMatch(book -> book.getDescription().toLowerCase().contains("java"));Based on static analysis hints from SonarCloud.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java(3 hunks)src/main/java/ar/com/nanotaboada/java/samples/spring/boot/repositories/BooksRepository.java(2 hunks)src/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.java(1 hunks)src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java(1 hunks)src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java(2 hunks)src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.java(1 hunks)
🧰 Additional context used
📓 Path-based instructions (9)
**/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/*.java: Use JDK 21 (LTS) features where appropriate; do not use JDK 22+ as they cause Mockito/ByteBuddy compatibility issues
Use constructor injection with Lombok@RequiredArgsConstructorfor dependency injection
Prefer Lombok annotations (@Data,@RequiredArgsConstructor,@NoArgsConstructor,@AllArgsConstructor) over manual boilerplate code
Use Java Streams API for collection processing instead of imperative loops
Package naming convention:ar.com.nanotaboada.java.samples.spring.boot.<layer>
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/repositories/BooksRepository.java
**/{controllers,services}/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/{controllers,services}/*.java: UseBookDTOfor API requests/responses;Bookentity is internal and should not be exposed directly
Use section dividers (e.g.,/* HTTP POST */) in controllers and services
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java
**/services/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Apply Spring Cache annotations (
@Cacheable,@CachePut,@CacheEvict) in the service layer
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.java
**/test/**/*Tests.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Name test classes with plural suffix:
<ClassName>Tests(e.g.,BooksControllerTests)
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java
**/test/**/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/test/**/*.java: Use BDD-style test method naming:given<Condition>_when<Action>_then<Expected>
Use AssertJ fluent assertions (assertThat(...).isEqualTo(...)) instead of standard JUnit assertions
Use@DisplayNamefor readable test descriptions in test classes
Use test data factories (BookFakes,BookDTOFakes) for consistent test data across tests
Use@MockBeanfor mocking Spring beans in tests and verify interactions withverify()
Test package naming convention: Insert.testbefore layer name (e.g.,...samples.spring.boot.test.controllers)
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java
**/repositories/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Repository interfaces should extend
CrudRepository<Entity, ID>from Spring Data JPA
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/repositories/BooksRepository.java
**/test/repositories/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use
@DataJpaTestfor repository layer tests
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java
**/controllers/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Annotate REST controller methods with
@Operationand@ApiResponsesfor OpenAPI/Swagger documentation
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java
**/test/controllers/*.java
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Use
@WebMvcTestfor controller layer tests andMockMvcfor HTTP assertions
Files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java
🧠 Learnings (10)
📓 Common learnings
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/{controllers,services}/*.java : Use `BookDTO` for API requests/responses; `Book` entity is internal and should not be exposed directly
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/**/*.java : Use test data factories (`BookFakes`, `BookDTOFakes`) for consistent test data across tests
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/{controllers,services}/*.java : Use `BookDTO` for API requests/responses; `Book` entity is internal and should not be exposed directly
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/services/BooksService.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/**/*Tests.java : Name test classes with plural suffix: `<ClassName>Tests` (e.g., `BooksControllerTests`)
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.javasrc/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/**/*.java : Use `MockBean` for mocking Spring beans in tests and verify interactions with `verify()`
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/repositories/*.java : Use `DataJpaTest` for repository layer tests
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/**/*.java : Use AssertJ fluent assertions (`assertThat(...).isEqualTo(...)`) instead of standard JUnit assertions
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/test/controllers/*.java : Use `WebMvcTest` for controller layer tests and `MockMvc` for HTTP assertions
Applied to files:
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.javasrc/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/models/*DTO.java : Use Jakarta Bean Validation annotations on DTOs (`NotBlank`, `ISBN`, `URL`, etc.)
Applied to files:
src/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java
📚 Learning: 2025-11-25T16:16:19.398Z
Learnt from: CR
Repo: nanotaboada/java.samples.spring.boot PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T16:16:19.398Z
Learning: Applies to **/repositories/*.java : Repository interfaces should extend `CrudRepository<Entity, ID>` from Spring Data JPA
Applied to files:
src/main/java/ar/com/nanotaboada/java/samples/spring/boot/repositories/BooksRepository.java
🧬 Code graph analysis (3)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.java (2)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/BookFakes.java (1)
BookFakes(9-156)src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/BookDTOFakes.java (1)
BookDTOFakes(9-157)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java (1)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/BookFakes.java (1)
BookFakes(9-156)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java (1)
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/BookDTOFakes.java (1)
BookDTOFakes(9-157)
🪛 GitHub Check: SonarCloud Code Analysis
src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/repositories/BooksRepositoryTests.java
[warning] 57-57: Join these multiple assertions subject to one assertion chain.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (4)
src/main/java/ar/com/nanotaboada/java/samples/spring/boot/repositories/BooksRepository.java (1)
23-31: LGTM! Secure parameterized query implementation.The JPQL query correctly uses parameterized binding with
@Param, which prevents SQL injection vulnerabilities. TheCASThandles CLOB fields appropriately for H2, and the case-insensitive search implementation is well-documented.src/main/java/ar/com/nanotaboada/java/samples/spring/boot/controllers/BooksController.java (1)
105-114: LGTM! Well-implemented search endpoint with proper validation.The endpoint correctly applies
@NotBlankvalidation to prevent empty searches and includes comprehensive OpenAPI documentation for 200/400 responses. The implementation properly delegates to the service layer and returnsList<BookDTO>.src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/controllers/BooksControllerTests.java (1)
344-434: LGTM! Comprehensive test coverage for the search endpoint.The test suite thoroughly covers all scenarios: matching results, empty results, blank parameter validation, and missing parameter validation. Tests follow BDD naming conventions, use
MockMvccorrectly, verify service interactions, and employ AssertJ fluent assertions.src/test/java/ar/com/nanotaboada/java/samples/spring/boot/test/services/BooksServiceTests.java (1)
222-264: LGTM! Thorough unit tests with proper mocking and verification.The tests correctly verify repository calls, ModelMapper interactions for each book entity, and result mapping to DTOs. They follow BDD naming conventions and use test data factories appropriately.
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #231 +/- ##
===========================================
Coverage 100.00% 100.00%
- Complexity 20 22 +2
===========================================
Files 2 2
Lines 49 55 +6
Branches 4 4
===========================================
+ Hits 49 55 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
nanotaboada
force-pushed
the
copilot/add-books-search-endpoint
branch
from
14b2470 to
d9b6de0
Compare
- Add GET /books/search endpoint with case-insensitive description search - Implement custom JPQL query with H2 CLOB handling in BooksRepository - Add searchByDescription method to BooksService (no caching for dynamic results) - Add request validation with @notblank annotation - Add comprehensive OpenAPI documentation with detailed response descriptions - Add 10 new unit tests across all layers (4 controller, 2 service, 4 repository) - Add case-insensitivity test to verify LOWER() functions work correctly - Expand BooksDataInitializer with 10 additional free programming books - Update BookFakes test data to use unique ISBNs and avoid conflicts Closes #128
nanotaboada
force-pushed
the
copilot/add-books-search-endpoint
branch
from
d9b6de0 to
52cb909
Compare
|
Implements search functionality allowing users to find books by keyword matching against descriptions.
Changes
Repository
findByDescriptionContainingIgnoreCasewith JPQL query using parameterized bindingCAST(b.description AS string)to handle CLOB field in H2Service
searchByDescription(String keyword)with entity-to-DTO mappingController
GET /books/search?description={keyword}endpoint@NotBlankvalidation on query param returns 400 for empty/missing inputUsage
Tests
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.
This change is
Summary by CodeRabbit
Release Notes
New Features
Tests
✏️ Tip: You can customize this high-level summary in your review settings.