Remove unused UUID utility and clean up entity naming

Author: Sporiff

src/docs/subscriptions.adoc

@@ -18,7 +18,7 @@ POST /api/v1/users
 [[actions-subscriptions-create]]
 === Create subscriptions
 
-When a user adds a subscriptionEntity to the system, a corresponding `subscriptionEntity` object is fetched or created depending on whether a matching subscriptionEntity is present. A link is then created between the user and the subscriptionEntity.
+When a user adds a subscription to the system, a corresponding `subscriptionEntity` object is fetched or created depending on whether a matching subscriptionEntity is present. A link is then created between the user and the subscriptionEntity.
 
 operation::subscriptions-bulk-create-mixed[snippets='request-fields,curl-request,response-fields,http-response']
 

src/main/java/org/openpodcastapi/opa/auth/ApiAuthController.java

@@ -6,7 +6,7 @@
 import lombok.extern.log4j.Log4j2;
 import org.openpodcastapi.opa.config.JwtService;
 import org.openpodcastapi.opa.security.TokenService;
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 import org.openpodcastapi.opa.user.UserRepository;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.authentication.AuthenticationManager;
@@ -38,11 +38,11 @@ public ResponseEntity<AuthDTO.LoginSuccessResponse> login(@RequestBody @NotNull
         SecurityContextHolder.getContext().setAuthentication(authentication);
 
         // Fetch the user record from the database
-        User user = userRepository.findByUsername(loginRequest.username()).orElseThrow(() -> new EntityNotFoundException("No user with username " + loginRequest.username() + " found"));
+        UserEntity userEntity = userRepository.findByUsername(loginRequest.username()).orElseThrow(() -> new EntityNotFoundException("No userEntity with username " + loginRequest.username() + " found"));
 
         // Generate the access and refresh tokens for the user
-        String accessToken = tokenService.generateAccessToken(user);
-        String refreshToken = tokenService.generateRefreshToken(user);
+        String accessToken = tokenService.generateAccessToken(userEntity);
+        String refreshToken = tokenService.generateRefreshToken(userEntity);
 
         // Format the tokens and expiration time into a DTO
         AuthDTO.LoginSuccessResponse response = new AuthDTO.LoginSuccessResponse(accessToken, refreshToken, String.valueOf(jwtService.getExpirationTime()));
@@ -52,13 +52,13 @@ public ResponseEntity<AuthDTO.LoginSuccessResponse> login(@RequestBody @NotNull
 
     @PostMapping("/api/auth/refresh")
     public ResponseEntity<AuthDTO.RefreshTokenResponse> getRefreshToken(@RequestBody @NotNull AuthDTO.RefreshTokenRequest refreshTokenRequest) {
-        User targetUser = userRepository.findByUsername(refreshTokenRequest.username()).orElseThrow(() -> new EntityNotFoundException("No user with username " + refreshTokenRequest.username() + " found"));
+        UserEntity targetUserEntity = userRepository.findByUsername(refreshTokenRequest.username()).orElseThrow(() -> new EntityNotFoundException("No user with username " + refreshTokenRequest.username() + " found"));
 
         // Validate the existing refresh token
-        User user = tokenService.validateRefreshToken(refreshTokenRequest.refreshToken(), targetUser);
+        UserEntity userEntity = tokenService.validateRefreshToken(refreshTokenRequest.refreshToken(), targetUserEntity);
 
         // Generate new access token
-        String newAccessToken = tokenService.generateAccessToken(user);
+        String newAccessToken = tokenService.generateAccessToken(userEntity);
 
         // Format the token and expiration time into a DTO
         AuthDTO.RefreshTokenResponse response = new AuthDTO.RefreshTokenResponse(newAccessToken, String.valueOf(jwtService.getExpirationTime()));

src/main/java/org/openpodcastapi/opa/config/JwtAuthenticationFilter.java

@@ -12,7 +12,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 import org.openpodcastapi.opa.service.CustomUserDetails;
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 import org.openpodcastapi.opa.user.UserRepository;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.HttpHeaders;
@@ -37,17 +37,17 @@ public class JwtAuthenticationFilter extends OncePerRequestFilter {
 
     /// Returns an authentication token for a user
     ///
-    /// @param user the [User] to fetch a token for
+    /// @param userEntity the [UserEntity] to fetch a token for
     /// @return a generated token
     /// @throws EntityNotFoundException if no matching user is found
-    private static UsernamePasswordAuthenticationToken getUsernamePasswordAuthenticationToken(User user) throws EntityNotFoundException {
+    private static UsernamePasswordAuthenticationToken getUsernamePasswordAuthenticationToken(UserEntity userEntity) throws EntityNotFoundException {
         // Create a new CustomUserDetails entity with the fetched user
         CustomUserDetails userDetails =
-                new CustomUserDetails(user.getId(),
-                        user.getUuid(),
-                        user.getUsername(),
-                        user.getPassword(),
-                        user.getUserRoles());
+                new CustomUserDetails(userEntity.getId(),
+                        userEntity.getUuid(),
+                        userEntity.getUsername(),
+                        userEntity.getPassword(),
+                        userEntity.getUserRoles());
 
         // Return a token for the user
         return new UsernamePasswordAuthenticationToken(
@@ -99,10 +99,10 @@ protected void doFilterInternal(HttpServletRequest req, @Nonnull HttpServletResp
             UUID parsedUuid = UUID.fromString(userUuid);
 
             // Fetch the matching user
-            User user = repository.getUserByUuid(parsedUuid).orElseThrow(() -> new EntityNotFoundException("No matching user found"));
+            UserEntity userEntity = repository.getUserByUuid(parsedUuid).orElseThrow(() -> new EntityNotFoundException("No matching user found"));
 
             // Create a user
-            UsernamePasswordAuthenticationToken authentication = getUsernamePasswordAuthenticationToken(user);
+            UsernamePasswordAuthenticationToken authentication = getUsernamePasswordAuthenticationToken(userEntity);
 
             SecurityContextHolder.getContext().setAuthentication(authentication);
         } catch (Exception e) {

…odcastapi/opa/security/RefreshToken.java …api/opa/security/RefreshTokenEntity.javasrc/main/java/org/openpodcastapi/opa/security/RefreshToken.java renamed to src/main/java/org/openpodcastapi/opa/security/RefreshTokenEntity.java src/main/java/org/openpodcastapi/opa/security/RefreshToken.java renamed to src/main/java/org/openpodcastapi/opa/security/RefreshTokenEntity.java

@@ -2,7 +2,7 @@
 
 import jakarta.persistence.*;
 import lombok.*;
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 
 import java.time.Instant;
 
@@ -12,7 +12,7 @@
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
-public class RefreshToken {
+public class RefreshTokenEntity {
     @Id
     @Generated
     @GeneratedValue(strategy = GenerationType.IDENTITY)
@@ -22,7 +22,7 @@ public class RefreshToken {
     private String tokenHash;
 
     @ManyToOne(optional = false, fetch = FetchType.LAZY)
-    private User user;
+    private UserEntity user;
 
     @Column(nullable = false)
     private Instant expiresAt;

src/main/java/org/openpodcastapi/opa/security/RefreshTokenRepository.java

@@ -1,12 +1,12 @@
 package org.openpodcastapi.opa.security;
 
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
 import java.util.List;
 
 @Repository
-public interface RefreshTokenRepository extends JpaRepository<RefreshToken, Long> {
-    List<RefreshToken> findAllByUser(User user);
+public interface RefreshTokenRepository extends JpaRepository<RefreshTokenEntity, Long> {
+    List<RefreshTokenEntity> findAllByUser(UserEntity userEntity);
 }

src/main/java/org/openpodcastapi/opa/security/TokenService.java

@@ -3,7 +3,7 @@
 import io.jsonwebtoken.Jwts;
 import io.jsonwebtoken.security.Keys;
 import lombok.RequiredArgsConstructor;
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
 import org.springframework.stereotype.Service;
@@ -38,32 +38,32 @@ private SecretKey key() {
         return Keys.hmacShaKeyFor(secret.getBytes(StandardCharsets.UTF_8));
     }
 
-    /// Generates an access token for a given user
+    /// Generates an access token for a given userEntity
     ///
-    /// @param user the [User] to generate a token for
+    /// @param userEntity the [UserEntity] to generate a token for
     /// @return the generated token
-    public String generateAccessToken(User user) {
+    public String generateAccessToken(UserEntity userEntity) {
         Instant now = Instant.now();
         return Jwts.builder()
-                .subject(user.getUuid().toString())
-                .claim("username", user.getUsername())
+                .subject(userEntity.getUuid().toString())
+                .claim("username", userEntity.getUsername())
                 .issuedAt(Date.from(now))
                 .expiration(Date.from(now.plusSeconds(accessTokenMinutes * 60)))
                 .signWith(key())
                 .compact();
     }
 
-    /// Generates a refresh token for a given user
+    /// Generates a refresh token for a given userEntity
     ///
-    /// @param user the [User] to generate a refresh token for
+    /// @param userEntity the [UserEntity] to generate a refresh token for
     /// @return the generated refresh token
-    public String generateRefreshToken(User user) {
+    public String generateRefreshToken(UserEntity userEntity) {
         String raw = UUID.randomUUID().toString() + UUID.randomUUID();
         String hash = passwordEncoder.encode(raw);
 
-        RefreshToken token = RefreshToken.builder()
+        RefreshTokenEntity token = RefreshTokenEntity.builder()
                 .tokenHash(hash)
-                .user(user)
+                .user(userEntity)
                 .createdAt(Instant.now())
                 .expiresAt(Instant.now().plusSeconds(refreshTokenDays * 24 * 3600))
                 .build();
@@ -72,22 +72,22 @@ public String generateRefreshToken(User user) {
         return raw;
     }
 
-    /// Validates the refresh token for a user and updates its expiry time
+    /// Validates the refresh token for a userEntity and updates its expiry time
     ///
     /// @param rawToken the raw token to validate
-    /// @param user     the [User] to validate the token for
-    /// @return the validated [User]
-    public User validateRefreshToken(String rawToken, User user) {
-        // Only fetch refresh tokens for the requesting user
-        for (RefreshToken token : repository.findAllByUser(user)) {
+    /// @param userEntity     the [UserEntity] to validate the token for
+    /// @return the validated [UserEntity]
+    public UserEntity validateRefreshToken(String rawToken, UserEntity userEntity) {
+        // Only fetch refresh tokens for the requesting userEntity
+        for (RefreshTokenEntity token : repository.findAllByUser(userEntity)) {
             // Check that the raw token and the token hash match and the token is not expired
             if (passwordEncoder.matches(rawToken, token.getTokenHash()) &&
                     token.getExpiresAt().isAfter(Instant.now())) {
                 // Update the expiry date on the refresh token
                 token.setExpiresAt(Instant.now().plusSeconds(refreshTokenDays * 24 * 3600));
-                RefreshToken updatedToken = repository.save(token);
+                RefreshTokenEntity updatedToken = repository.save(token);
 
-                // Return the user to confirm the token is valid
+                // Return the userEntity to confirm the token is valid
                 return updatedToken.getUser();
             }
         }

src/main/java/org/openpodcastapi/opa/service/CustomUserDetailsService.java

@@ -1,7 +1,7 @@
 package org.openpodcastapi.opa.service;
 
 import lombok.RequiredArgsConstructor;
-import org.openpodcastapi.opa.user.User;
+import org.openpodcastapi.opa.user.UserEntity;
 import org.openpodcastapi.opa.user.UserRepository;
 import org.springframework.security.core.userdetails.UserDetails;
 import org.springframework.security.core.userdetails.UserDetailsService;
@@ -22,19 +22,19 @@ public class CustomUserDetailsService implements UserDetailsService {
     public UserDetails loadUserByUsername(String username) {
         return userRepository.getUserByUsername(username)
                 .map(this::mapToUserDetails)
-                .orElseThrow(() -> new UsernameNotFoundException("User not found"));
+                .orElseThrow(() -> new UsernameNotFoundException("UserEntity not found"));
     }
 
     /// Maps a user to a custom user details model
     ///
-    /// @param user the user model to map
-    private CustomUserDetails mapToUserDetails(User user) {
+    /// @param userEntity the [UserEntity] model to map
+    private CustomUserDetails mapToUserDetails(UserEntity userEntity) {
         return new CustomUserDetails(
-                user.getId(),
-                user.getUuid(),
-                user.getUsername(),
-                user.getPassword(),
-                user.getUserRoles()
+                userEntity.getId(),
+                userEntity.getUuid(),
+                userEntity.getUsername(),
+                userEntity.getPassword(),
+                userEntity.getUserRoles()
         );
     }
 

src/main/java/org/openpodcastapi/opa/subscription/SubscriptionRestController.java

@@ -22,9 +22,9 @@
 public class SubscriptionRestController {
     private final SubscriptionService service;
 
-    /// Returns all subscriptions for a given user
+    /// Returns all subscriptions for a given userEntity
     ///
-    /// @param user                the [CustomUserDetails] of the authenticated user
+    /// @param user                the [CustomUserDetails] of the authenticated userEntity
     /// @param pageable            the [Pageable] pagination object
     /// @param includeUnsubscribed whether to include unsubscribed feeds in the response
     /// @return a paginated list of subscriptions
@@ -67,7 +67,7 @@ public ResponseEntity<SubscriptionDTO.UserSubscriptionDTO> getSubscriptionByUuid
         return new ResponseEntity<>(dto, HttpStatus.OK);
     }
 
-    /// Updates the subscriptionEntity status of a subscriptionEntity for a given user
+    /// Updates the subscriptionEntity status of a subscriptionEntity for a given userEntity
     ///
     /// @param uuid the UUID of the subscriptionEntity to update
     /// @return the updated subscriptionEntity entity
@@ -86,7 +86,7 @@ public ResponseEntity<SubscriptionDTO.UserSubscriptionDTO> unsubscribeUserFromFe
         return new ResponseEntity<>(dto, HttpStatus.OK);
     }
 
-    /// Bulk creates UserSubscriptions for a user. Creates new SubscriptionEntity objects if not already present
+    /// Bulk creates UserSubscriptions for a userEntity. Creates new SubscriptionEntity objects if not already present
     ///
     /// @param request a list of [SubscriptionDTO.SubscriptionCreateDTO] objects
     /// @return a [SubscriptionDTO.BulkSubscriptionResponseDTO] object