Feature: User reviews #48
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implemented updating and deleting reviews.
…here possible. Fixed antMatchers related to reviews in WebSecurityConfig.
…nsible for retrieving users from the DB
- Added a "@Valid" annotation to UpdateReviewDTO parameter in updateReview method in ReviewController. - Added a new constructor to UserNotFoundException to allow for handling situations in which te user is being retrieved by username (so that we don't have to rely on Spring Security exceptions where not necessary). - Moved review content parsing from ReviewService methods to a setter in the Review object
dawciobiel
requested changes
Jul 27, 2022
src/main/java/pl/simpleascoding/tutoringplatform/domain/review/Review.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/common/ReviewDTOMapper.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/common/UserDTOMapper.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/common/UserDTOMapper.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/common/UserDTOMapper.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/exception/UserNotFoundException.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/repository/ReviewRepository.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/repository/UserRepository.java
Outdated
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/service/user/UserServiceImpl.java
Show resolved
Hide resolved
src/main/java/pl/simpleascoding/tutoringplatform/service/user/UserServiceImpl.java
Show resolved
Hide resolved
dawciobiel
requested changes
Jul 27, 2022
src/main/java/pl/simpleascoding/tutoringplatform/api/publicResource/UserController.java
Outdated
Show resolved
Hide resolved
dawciobiel
requested changes
Jul 27, 2022
- Changed id variable type to a primitive type - Added a maximum size of the content variable (400) - Added @NotNull constraints on user objects DTOs: - Modified constraint validation on CreateReviewDTO and UpdateReviewDTO to account for changes related to the Review object Exceptions: - Modified exception message variable names Mappers: - Removed custom entity and dto mappers, to rely on MapStruct instead ReviewServiceImpl: - Modified createReview method to account for changes related to the Review object - Modified methods responsible for retrieving reviews to account for the MapStruct change
# Conflicts: # pom.xml # src/main/java/pl/simpleascoding/tutoringplatform/api/ReviewController.java
dawciobiel
approved these changes
Aug 4, 2022
There was a problem hiding this comment.
Accepted && admitted.
After successfully creating the review, you return HttpStatus.CREATED.
When you delete the review (successful), HttpStatus.OK is returned.
It is true that both statuses are in the range 200-299, I wonder if it is worth standardizing the return. It seems to me that the controller decides what exactly returns to the client. So it would simplify the issues of checking the scope in the controller minimally.
If we would like to extend the returned result then instead of HttpStatus.OK / CREATED we should use encapsulate result (i.e.: DTO).
I wonder if we should not create our own class in which we have defined all the statuses we need, for example:
OK
CREATED
DELETED
MODIFIED
...
However, in that case, the DTO could be used right away.
|
Accepting current state with bad method return types for Controller-Service communication layers due no official convetion picked yet. Further rework will be required. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduced reviewing users
A review consists of a star-based rating (1-5) and an optional description (referred in the code as "content").
Everyone can see what reviews has a user received, as well as all reviews posted by the user.
A review can be edited and deleted by its author.
The input is validated in the controller using Spring validation, and additionally the Review entity is validated by Hibernate.
The reviews are retrieved in pages of 20 elements, to avoid loading a full list of reviews at once.
You can also sort the reviews by stars or creation date.
Endpoints:
api/v1/reviews- POST, used to create a reviewapi/v1/reviews/{id}- PUT, DELETE, used to modify or delete a reviewapi/v1/users/{userId}/reviews/received- GET, used to retrieve reviews that the user has receivedapi/v1/users/{userId}/reviews/posted- GET, used to retrieve reviews posted by the userI'll provide a full documentation in a separate pull request.