Merge pull request #413 from cap-java/attachmentSize

Support Attachment size restriction during upload

Author: rishikunnath2747

.github/workflows/multiTenancyDeployLocal.yml

@@ -121,4 +121,4 @@ jobs:
             ls -lrth
             echo "▶️ Running cf deploy..."
             cf deploy mta_archives/bookshop-mt_1.0.0.mtar -f
-            echo "✅ Deployment complete!"
+            echo "✅ Deployment complete!"

README.md

@@ -15,6 +15,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Display attachments specific to repository: Lists attachments contained in the repository that is configured with the CAP application.
 - Custom properties : Provides the capability to define custom properties for attachments.
 - Maximum allowed uploads: Provides the capability to define the maximum number of uploads allowed for the user.
+- Maximum file size: Provides the capability to specify the maximum file size for attachments.
 - Multiple attachment facets: Provides the capability to define multiple attachment facets/sections in the CAP Entity.
 - Technical user support: Provides the capability to consume the plugin using technical user.
 - Copy attachments: Provides the capability to copy attachments from one entity to another entity.
@@ -34,6 +35,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Multitenancy](#support-for-multitenancy)
 - [Support for Custom Properties](#support-for-custom-properties)
 - [Support for Maximum allowed uploads](#support-for-maximum-allowed-uploads)
+- [Support for Maximum File Size](#support-for-maximum-file-size)
 - [Support for Multiple attachment facets](#support-for-multiple-attachment-facets)
 - [Support for Technical user](#support-for-technical-user)
 - [Support for Copy attachments](#support-for-copy-attachments)
@@ -492,6 +494,35 @@ SDM.maxCountErrorMessage = Maximale Anzahl von Anhängen erreicht
 >
 > Once the maxCount is configured, it is recommended not to alter it. If the maxCount is altered, the previously uploaded documents will still be visible.
 
+## Support for Maximum File Size
+
+This plugin allows you to customize the maximum file size for attachments that a user can upload. Once the defined file size limit is exceeded, the upload is rejected and an error is triggered. The error message displayed to the user is fully customizable. The `@Validation.Maximum` annotation is used to define the maximum allowed file size.
+
+Refer the following example from a sample Bookshop app:
+
+```cds
+
+entity Books {
+  ...
+  attachments: Composition of many Attachments;
+}
+
+annotate Books.attachments with {
+  content @Validation.Maximum : '30MB';
+}
+```
+
+#### Customizing the Maximum File Size Error Message
+
+To customize the error message displayed when the file upload size limit is exceeded, add the following key to your `messages.properties` file under `srv/src/main/resources`:
+
+```properties
+AttachmentSizeExceeded = File size exceeds the limit of {0}.
+```
+
+Supports both decimal (KB, MB, GB, TB) and binary (KiB, MiB, GiB, TiB) units with comprehensive validation and error handling.
+
+
 ## Support for Multiple attachment facets
 The plugin supports creating multiple attachment facets or sections, each allowing various documents to be uploaded. The names of these facets are fully customizable. All existing operations available for the default attachment facet are also supported for any additional facets you create.
 
@@ -1316,4 +1347,4 @@ We as members, contributors, and leaders pledge to make participation in our com
 
 ## Licensing
 
-Copyright 2024 SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-java/sdm).
+Copyright 2024 SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-java/sdm).

pom.xml

@@ -37,7 +37,7 @@
         <test-spring-boot-version>3.2.5</test-spring-boot-version>
         <sdk-bom-version>5.21.0</sdk-bom-version>
         <mockito-bom-version>5.15.2</mockito-bom-version>
-        <assertj-core-version>3.27.3</assertj-core-version>
+        <assertj-core-version>3.27.7</assertj-core-version>
         <mockito-core-version>5.15.2</mockito-core-version>
     </properties>
 

sdm/pom.xml

@@ -34,7 +34,7 @@
         <test-generation-folder>src/test/gen</test-generation-folder>
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
-        <attachments_version>1.2.4</attachments_version>
+        <attachments_version>1.3.0</attachments_version>
         <lombok.version>1.18.36</lombok.version>
         <jacoco.version>0.8.7</jacoco.version>
         <ehcache-version>3.10.8</ehcache-version>

sdm/src/test/java/integration/com/sap/cds/sdm/IntegrationTest_MultipleFacet.java

@@ -7210,4 +7210,63 @@ public void testMoveAttachmentsWithoutSDMRole() throws Exception {
       api.deleteEntity(appUrl, entityName, moveSourceEntity);
     }
   }
+
+  // @Test
+  // @Order(76)
+  // void testUploadAttachmentExceedingMaximumFileSize() throws IOException {
+  //   System.out.println(
+  //       "Test (76) : Upload attachment exceeding maximum file size in references facet");
+
+  //   // Create a new entity
+  //   String response = api.createEntityDraft(appUrl, entityName, entityName2, srvpath);
+  //   if (response.equals("Could not create entity")) {
+  //     fail("Could not create entity");
+  //   }
+  //   String testEntityID = response;
+
+  //   // Load the 150MB sample file
+  //   ClassLoader classLoader = getClass().getClassLoader();
+  //   File file = new File(classLoader.getResource("sample32mb.pdf").getFile());
+
+  //   for (int i = 0; i < facet.length; i++) {
+  //     Map<String, Object> postData = new HashMap<>();
+  //     postData.put("up__ID", testEntityID);
+  //     postData.put("mimeType", "application/pdf");
+  //     postData.put("createdAt", new Date().toString());
+  //     postData.put("createdBy", "test@test.com");
+  //     postData.put("modifiedBy", "test@test.com");
+
+  //     List<String> createResponse =
+  //         api.createAttachment(appUrl, entityName, facet[i], testEntityID, srvpath, postData,
+  // file);
+  //     String check = createResponse.get(0);
+
+  //     // Only 'references' facet has 30MB limit, others should succeed
+  //     if (facet[i].equals("references")) {
+  //       // The upload should fail with AttachmentSizeExceeded error
+  //       if (!check.equals("Attachment created")) {
+  //         try {
+  //           JSONObject json = new JSONObject(check);
+  //           String errorCode = json.getJSONObject("error").getString("code");
+  //           String errorMessage = json.getJSONObject("error").getString("message");
+  //           assertEquals("413", errorCode);
+  //           assertEquals("File size exceeds the limit of 30MB.", errorMessage);
+  //         } catch (Exception e) {
+  //           fail("Failed to parse error response for references facet: " + e.getMessage());
+  //         }
+  //       } else {
+  //         fail("Attachment got created in references facet with file size exceeding maximum
+  // limit");
+  //       }
+  //     } else {
+  //       // For attachments and footnotes, expect success
+  //       if (!check.equals("Attachment created")) {
+  //         fail("Attachment upload failed in " + facet[i] + " facet: " + check);
+  //       }
+  //     }
+  //   }
+
+  //   // delete the draft entity
+  //   api.deleteEntityDraft(appUrl, entityName, testEntityID);
+  // }
 }

sdm/src/test/java/integration/com/sap/cds/sdm/IntegrationTest_SingleFacet.java

@@ -6650,4 +6650,54 @@ public void testMoveAttachmentsWithoutSDMRole() throws Exception {
     api.deleteEntity(appUrl, entityName, moveTargetEntity);
     api.deleteEntity(appUrl, entityName, moveSourceEntity);
   }
+
+  // @Test
+  // @Order(76)
+  // void testUploadAttachmentExceedingMaximumFileSize() throws IOException {
+  //   System.out.println(
+  //       "Test (76) : Upload attachment exceeding maximum file size in references facet");
+
+  //   // Create a new entity
+  //   String response = api.createEntityDraft(appUrl, entityName, entityName2, srvpath);
+  //   if (response.equals("Could not create entity")) {
+  //     fail("Could not create entity");
+  //   }
+  //   String testEntityID = response;
+
+  //   // Load the 150MB sample file
+  //   ClassLoader classLoader = getClass().getClassLoader();
+  //   File file = new File(classLoader.getResource("sample32mb.pdf").getFile());
+
+  //   Map<String, Object> postData = new HashMap<>();
+  //   postData.put("up__ID", testEntityID);
+  //   postData.put("mimeType", "application/pdf");
+  //   postData.put("createdAt", new Date().toString());
+  //   postData.put("createdBy", "test@test.com");
+  //   postData.put("modifiedBy", "test@test.com");
+
+  //   // Try to upload to the 'references' facet which has the 100MB limit
+  //   String referencesFacet = "references";
+  //   List<String> createResponse =
+  //       api.createAttachment(
+  //           appUrl, entityName, referencesFacet, testEntityID, srvpath, postData, file);
+  //   String check = createResponse.get(0);
+
+  //   // The upload should fail with AttachmentSizeExceeded error
+  //   if (!check.equals("Attachment created")) {
+  //     try {
+  //       JSONObject json = new JSONObject(check);
+  //       String errorCode = json.getJSONObject("error").getString("code");
+  //       String errorMessage = json.getJSONObject("error").getString("message");
+  //       assertEquals("413", errorCode);
+  //       assertEquals("File size exceeds the limit of 30MB.", errorMessage);
+  //     } catch (Exception e) {
+  //       fail("Failed to parse error response: " + e.getMessage());
+  //     }
+  //   } else {
+  //     fail("Attachment got created with file size exceeding maximum limit");
+  //   }
+
+  //   // delete the test entity draft
+  //   api.deleteEntityDraft(appUrl, entityName, testEntityID);
+  // }
 }