use entity graph and rework attachment file reference

Author: SirCotare

pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.1.1</version>
+        <version>3.1.4</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
 

src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentDataSource.java

@@ -5,9 +5,9 @@
 import java.io.InputStream;
 
 public interface AttachmentDataSource {
-    InputStream getAttachmentPayload(AttachmentReference reference) throws AttachmentException;
+    InputStream getAttachmentPayload(long fileReference) throws AttachmentException;
 
-    AttachmentReference storeAttachmentPayload(InputStream payload) throws AttachmentException;
+    long storeAttachmentPayload(InputStream payload) throws AttachmentException;
 
-    void releaseAttachment(AttachmentReference reference) throws AttachmentException;
+    void releaseAttachment(long fileReference) throws AttachmentException;
 }

src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentReference.java

@@ -11,6 +11,6 @@ public record EmailAttachmentDto(
 
         String contentType,
 
-        AttachmentReference reference
+        long fileReference
 ) {
 }

src/main/java/it/aboutbits/springboot/emailservice/lib/EmailAttachmentDto.java

@@ -1,6 +1,5 @@
 package it.aboutbits.springboot.emailservice.lib.application;
 
-import it.aboutbits.springboot.emailservice.lib.AttachmentReference;
 import it.aboutbits.springboot.emailservice.lib.EmailAttachmentDto;
 import it.aboutbits.springboot.emailservice.lib.model.EmailAttachment;
 import org.mapstruct.Mapper;
@@ -11,9 +10,5 @@
 public interface EmailAttachmentMapper {
     EmailAttachmentDto toDto(EmailAttachment model);
 
-    default AttachmentReference map(String value) {
-        return new AttachmentReference(value);
-    }
-
     List<EmailAttachmentDto> toDto(List<EmailAttachment> model);
 }

src/main/java/it/aboutbits/springboot/emailservice/lib/application/EmailAttachmentMapper.java

@@ -44,7 +44,7 @@ updated_at           timestamp with time zone default now()           not null,
 
                  create index if not exists email_service_emails_scheduled_at_index
                      on email_service_emails (scheduled_at);
-                     
+
                  create index if not exists email_service_emails_attachments_cleaned_index
                      on email_service_emails (attachments_cleaned);
 
@@ -57,7 +57,7 @@ updated_at           timestamp with time zone default now()           not null,
                              references email_service_emails,
                      file_name    text   not null,
                      content_type text   not null,
-                     reference    text   not null
+                     file_reference    bigint   not null
                  );
 
                  create index if not exists email_service_email_attachments_email_id_index

src/main/java/it/aboutbits/springboot/emailservice/lib/application/EmailServiceMigrator.java

@@ -2,7 +2,6 @@
 
 
 import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource;
-import it.aboutbits.springboot.emailservice.lib.AttachmentReference;
 import it.aboutbits.springboot.emailservice.lib.EmailDto;
 import it.aboutbits.springboot.emailservice.lib.EmailState;
 import it.aboutbits.springboot.emailservice.lib.exception.AttachmentException;
@@ -98,7 +97,7 @@ Email send(Email email) {
 
     void cleanupAttachments(final Email email) throws AttachmentException {
         for (var attachment : email.getAttachments()) {
-            attachmentDataSource.releaseAttachment(new AttachmentReference(attachment.getReference()));
+            attachmentDataSource.releaseAttachment(attachment.getFileReference());
         }
         email.setAttachmentsCleaned(true);
         emailRepository.save(email);
@@ -123,9 +122,9 @@ private Email fromParameter(EmailParameter parameter) throws AttachmentException
 
             var emailAttachment = new EmailAttachment();
             emailAttachment.setEmail(email);
-            emailAttachment.setReference(reference.value());
             emailAttachment.setContentType(attachment.contentType());
             emailAttachment.setFileName(attachment.fileName());
+            emailAttachment.setFileReference(reference);
 
             attachments.add(emailAttachment);
         }
@@ -162,7 +161,7 @@ private void sendMail(String fromAddress, String fromName, List<String> recipien
         }
 
         for (var attachment : attachments) {
-            var payload = attachmentDataSource.getAttachmentPayload(new AttachmentReference(attachment.getReference()));
+            var payload = attachmentDataSource.getAttachmentPayload(attachment.getFileReference());
             helper.addAttachment(attachment.getFileName(), new ByteArrayResource(payload.readAllBytes()));
             payload.close();
         }

src/main/java/it/aboutbits/springboot/emailservice/lib/application/ManageEmail.java

@@ -1,24 +1,23 @@
 package it.aboutbits.springboot.emailservice.lib.application;
 
 import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource;
-import it.aboutbits.springboot.emailservice.lib.AttachmentReference;
 import it.aboutbits.springboot.emailservice.lib.exception.AttachmentException;
 
 import java.io.InputStream;
 
 public final class UnavailableAttachmentDataSource implements AttachmentDataSource {
     @Override
-    public InputStream getAttachmentPayload(AttachmentReference reference) throws AttachmentException {
+    public InputStream getAttachmentPayload(long fileReference) throws AttachmentException {
         throw new AttachmentException("attachments not available");
     }
 
     @Override
-    public AttachmentReference storeAttachmentPayload(InputStream payload) throws AttachmentException {
+    public long storeAttachmentPayload(InputStream payload) throws AttachmentException {
         throw new AttachmentException("attachments not available");
     }
 
     @Override
-    public void releaseAttachment(AttachmentReference reference) throws AttachmentException {
+    public void releaseAttachment(long fileReference) throws AttachmentException {
         throw new AttachmentException("attachments not available");
     }
 }

src/main/java/it/aboutbits/springboot/emailservice/lib/application/UnavailableAttachmentDataSource.java

@@ -5,13 +5,33 @@
 import it.aboutbits.springboot.emailservice.lib.model.Email;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
+import org.springframework.data.jpa.repository.EntityGraph;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.lang.NonNull;
 
 import java.util.Collection;
 import java.util.List;
+import java.util.Optional;
 
 public interface EmailRepository extends JpaRepository<Email, Long> {
+    @Override
+    @NonNull
+    @EntityGraph(value = Email.DEFAULT_ENTITY_GRAPH)
+    Optional<Email> findById(@NonNull Long id);
+
+    @Override
+    @NonNull
+    @EntityGraph(value = Email.DEFAULT_ENTITY_GRAPH)
+    List<Email> findAllById(@NonNull Iterable<Long> ids);
+
+    @Override
+    @NonNull
+    @EntityGraph(value = Email.DEFAULT_ENTITY_GRAPH)
+    List<Email> findAll();
+
+    @EntityGraph(value = Email.DEFAULT_ENTITY_GRAPH)
     Page<Email> findByState(EmailState state, PageRequest pageRequest);
 
+    @EntityGraph(value = Email.DEFAULT_ENTITY_GRAPH)
     List<Email> findByIdIn(Collection<Long> ids);
 }

src/main/java/it/aboutbits/springboot/emailservice/lib/jpa/EmailRepository.java

@@ -5,7 +5,6 @@
 import jakarta.persistence.Entity;
 import jakarta.persistence.EnumType;
 import jakarta.persistence.Enumerated;
-import jakarta.persistence.FetchType;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
@@ -27,6 +26,8 @@
 import java.util.List;
 import java.util.Set;
 
+import static it.aboutbits.springboot.emailservice.lib.model.Email.DEFAULT_ENTITY_GRAPH;
+
 @NamedEntityGraph(
         name = "email_service_emails-entity-graph",
         attributeNodes = {
@@ -40,7 +41,10 @@
 @AllArgsConstructor
 @NoArgsConstructor
 @Table(name = "email_service_emails")
+@NamedEntityGraph(name = DEFAULT_ENTITY_GRAPH, attributeNodes = @NamedAttributeNode("attachments"))
 public class Email {
+    public static final String DEFAULT_ENTITY_GRAPH = "graph.EmailServiceEmail.default";
+
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
@@ -59,7 +63,7 @@ public class Email {
     private String textBody;
     private String htmlBody;
 
-    @OneToMany(cascade = CascadeType.PERSIST, mappedBy = "email", orphanRemoval = true, fetch = FetchType.EAGER)
+    @OneToMany(cascade = CascadeType.PERSIST, mappedBy = "email", orphanRemoval = true)
     private Set<EmailAttachment> attachments;
 
     @Builder.Default