Merge pull request #460 from cap-java/createAttachmentInActiveEntity

Create attachment in active entity

Author: yashmeet29

.github/workflows/singleTenant_deploy_and_Integration_test.yml

@@ -235,4 +235,4 @@ jobs:
     
 
 
-      
+      

README.md

@@ -25,6 +25,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Attachment changelog: Provides the capability to view complete audit trail of attachments.
 - Localization of error messages and UI fields: Provides the capability to have the UI fields and error messages translated to the local language of the leading application.
 - Attachment Upload Status: Upload Status is the new field which displays the upload status of attachment when being uploaded.
+- Active entity attachment creation: Provides the capability to create attachments directly on active (non-draft) entities.
 
 ## Table of Contents
 
@@ -45,6 +46,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Edit of Link type attachments](#support-for-edit-of-link-type-attachments)
 - [Support for Localization](#support-for-localization)
 - [Support for Attachment Upload Status](#support-for-attachment-upload-status)
+- [Support for Attachment creation in Active Entities](#support-for-attachment-creation-in-active-entities)
 - [Known Restrictions](#known-restrictions)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
@@ -1332,6 +1334,64 @@ Success;Success;3
 Failed;Scan Failed;2
  ```
 
+### Support for Attachment Creation in Active Entities
+
+By default, the SDM CAP plugin handles attachment creation through the **draft flow** — attachments are first created on a draft entity and later activated. This feature adds support for creating attachments **directly on active entities**, which is useful in scenarios where the parent entity bypasses the draft lifecycle (e.g., programmatic entity creation, background jobs, or APIs that operate on active records).
+
+### How It Works
+
+When an attachment is created, the plugin automatically determines whether the parent entity is in a **draft** or **active** context:
+
+1. **Draft detection:** The plugin queries the parent entity's draft table to check if the parent record exists there. If it does, the standard draft flow is used.
+2. **Active entity flow:** If the parent record is **not** found in the draft table, the plugin treats it as an active entity context. In this case:
+   - The attachment content is uploaded to the SAP Document Management repository.
+   - The SDM metadata (`objectId`, `folderId`, `repositoryId`, etc.) is temporarily stored in-memory.
+   - After the framework completes the database INSERT, an `@After` handler updates the active entity record with the SDM metadata.
+3. **Backwards compatibility:** If the context cannot be determined (e.g., the model has no draft table), the plugin defaults to the draft flow to ensure existing applications continue to work without changes.
+
+### Key Behavior
+
+- **Automatic detection:** No configuration is required. The plugin automatically detects whether to use the draft or active entity flow based on the parent entity's presence in the draft table.
+- **Duplicate handling:** If an attachment with the same filename already exists on the active entity, the plugin gracefully handles the duplicate by reusing the existing attachment record.
+
+### Usage in Leading Applications
+
+To create attachments on active entities, the leading application needs to trigger an `INSERT` on the attachment entity through the `ApplicationService` (or `DraftService`, which extends it). The plugin intercepts the content automatically and routes it through the active entity flow.
+
+#### Steps
+
+1. **Build the attachment data** with the required fields:
+
+   | Field      | Type          | Description                                      |
+   |------------|---------------|--------------------------------------------------|
+   | `ID`       | `String`      | Unique identifier (e.g., `UUID.randomUUID()`)    |
+   | `up__ID`   | `String`      | The parent entity's ID                           |
+   | `fileName` | `String`      | The attachment filename                          |
+   | `mimeType` | `String`      | The MIME type of the content                     |
+   | `content`  | `InputStream` | An `InputStream` containing the file content     |
+
+2. **Execute the INSERT** using the `ApplicationService`. See this [example](https://github.com/cap-java/sdm/blob/e89c3c4f9fee6a18b20dfec2650b1d05ff244bc3/cap-notebook/demoapp/srv/src/main/java/customer/demoapp/handlers/AdminServiceHandler.java#L142)
+
+   ```java
+   import com.sap.cds.ql.Insert;
+   import java.io.InputStream;
+   import java.util.HashMap;
+   import java.util.Map;
+   import java.util.UUID;
+
+   // Build attachment data
+   Map<String, Object> attachmentData = new HashMap<>();
+   attachmentData.put("ID", UUID.randomUUID().toString());
+   attachmentData.put("up__ID", parentEntityId);
+   attachmentData.put("fileName", "report.pdf");
+   attachmentData.put("mimeType", "application/pdf");
+   attachmentData.put("content", inputStream);
+
+   // Insert into the attachment entity via ApplicationService
+   applicationService.run(
+       Insert.into("MyService.MyEntity.attachments").entry(attachmentData)
+   );
+
 ## Known Restrictions
 
 - UI5 Version 1.135.0: This version causes error in upload of attachments.

sdm/src/main/java/com/sap/cds/sdm/handler/applicationservice/SDMCreateAttachmentsHandler.java

@@ -14,6 +14,7 @@
 import com.sap.cds.sdm.model.SDMCredentials;
 import com.sap.cds.sdm.persistence.DBQuery;
 import com.sap.cds.sdm.service.SDMService;
+import com.sap.cds.sdm.service.handler.SDMAttachmentsServiceHandler;
 import com.sap.cds.sdm.utilities.SDMUtils;
 import com.sap.cds.services.ServiceException;
 import com.sap.cds.services.cds.ApplicationService;
@@ -56,6 +57,52 @@ public SDMCreateAttachmentsHandler(
     this.dbQuery = dbQuery;
   }
 
+  /**
+   * After handler for ApplicationService CREATE to update active entity attachments with SDM
+   * metadata (objectId, folderId, repositoryId, etc.) after the record has been INSERTed.
+   *
+   * <p>During active entity attachment creation, the AttachmentService @On handler uploads to SDM
+   * and stores metadata in a ThreadLocal. The framework then INSERTs the record with contentId (set
+   * via finalizeContext). This @After handler runs AFTER the INSERT, so the record exists and can
+   * be UPDATEd with the remaining SDM metadata.
+   */
+  @After
+  @HandlerOrder(HandlerOrder.LATE)
+  public void updateActiveEntitySdmMetadata(CdsCreateEventContext _context) {
+    handleUpdateActiveEntitySdmMetadata();
+  }
+
+  private void handleUpdateActiveEntitySdmMetadata() {
+    Map<String, Object> metadata = SDMAttachmentsServiceHandler.SDM_METADATA_THREADLOCAL.get();
+    if (metadata == null) {
+      return;
+    }
+    try {
+      SDMAttachmentsServiceHandler.SDM_METADATA_THREADLOCAL.remove();
+      com.sap.cds.reflect.CdsEntity attachmentEntity =
+          (com.sap.cds.reflect.CdsEntity) metadata.get("attachmentEntity");
+      if (attachmentEntity == null) {
+        logger.warn("No attachmentEntity in ThreadLocal metadata, skipping post-INSERT update");
+        return;
+      }
+      CmisDocument cmisDocument = new CmisDocument();
+      cmisDocument.setAttachmentId((String) metadata.get("attachmentId"));
+      cmisDocument.setObjectId((String) metadata.get("objectId"));
+      cmisDocument.setFolderId((String) metadata.get("folderId"));
+      cmisDocument.setMimeType((String) metadata.get("mimeType"));
+      cmisDocument.setUploadStatus((String) metadata.get("uploadStatus"));
+      logger.info(
+          "Post-INSERT: Updating active entity attachment {} with objectId {}",
+          cmisDocument.getAttachmentId(),
+          cmisDocument.getObjectId());
+      dbQuery.addAttachmentToDraft(attachmentEntity, persistenceService, cmisDocument);
+      logger.info("Post-INSERT: Successfully updated active entity attachment with SDM metadata");
+    } catch (Exception e) {
+      logger.error(
+          "Failed to update active entity SDM metadata after INSERT: {}", e.getMessage(), e);
+    }
+  }
+
   @Before
   @HandlerOrder(HandlerOrder.DEFAULT)
   public void processBefore(CdsCreateEventContext context, List<CdsData> data) throws IOException {
@@ -140,6 +187,9 @@ public void processAfter(CdsCreateEventContext context, List<CdsData> data) {
   @HandlerOrder(OrderConstants.Before.CHECK_CAPABILITIES - 500)
   public void preserveUploadStatus(CdsCreateEventContext context, List<CdsData> data) {
     // Preserve uploadStatus before CDS removes readonly fields
+    logger.debug(
+        "Preserving readonly fields (uploadStatus) for entity: {} before CDS capability check",
+        context.getTarget().getQualifiedName());
     SDMUtils.preserveReadonlyFields(context.getTarget(), data);
   }