Support srv.run(INSERT.into(Attachments).entries(...)) (#305)

The PR:
- cleans up the put implementations
- supports `srv.run(INSERT.into(Attachments).entries(...))` that
developers can insert attachments themselves at runtime using the
regular CAP APIs. To support it the put functions are leveraged.

---------

Co-authored-by: Simon Kobler <32038731+KoblerS@users.noreply.github.com>

Author: schiwekM

jest.config.js

@@ -1,5 +1,5 @@
 const config = {
-    testTimeout: 60000,
+    testTimeout: 120000,
     testMatch: ['**/*.test.js'],
     setupFilesAfterEnv: ['<rootDir>/tests/setup.js'],
     forceExit: true,

lib/aws-s3.js

@@ -164,14 +164,13 @@ module.exports = class AWSAttachmentsService extends require("./object-store.js"
   /**
    * @inheritdoc
    */
-  async put(attachments, data, _content, isDraftEnabled) {
+  async put(attachments, data) {
     const startTime = Date.now()
 
     const tenantID = cds.context.tenant
 
     logConfig.processStep('Starting file upload to S3', {
       attachmentEntity: attachments.name,
-      isDraftEnabled,
       tenant: tenantID
     })
 
@@ -194,11 +193,11 @@ module.exports = class AWSAttachmentsService extends require("./object-store.js"
           filenames: data.map(d => d.filename)
         })
         return Promise.all(
-          data.map((d) => this.put(attachments, d, _content, isDraftEnabled))
+          data.map((d) => this.put(attachments, d))
         )
       }
 
-      const { content = _content, ...metadata } = data
+      const { content, ...metadata } = data
       const Key = metadata.url
 
       if (!Key) {
@@ -235,12 +234,9 @@ module.exports = class AWSAttachmentsService extends require("./object-store.js"
         params: input,
       })
 
-      const stored = super.put(attachments, metadata, null, isDraftEnabled)
-
-      await Promise.all([stored, multipartUpload.done()])
-
-      const hash = await utils.computeHash(await this.get(attachments, { ID: metadata.ID }))
-      await super.update(attachments, { ID: metadata.ID }, { hash })
+      // The file upload has to be done first, so super.put can compute the hash
+      await multipartUpload.done()
+      await super.put(attachments, metadata)
 
       const duration = Date.now() - startTime
       logConfig.debug('File upload to S3 completed successfully', {
@@ -347,55 +343,6 @@ module.exports = class AWSAttachmentsService extends require("./object-store.js"
     }
   }
 
-  /**
-   * Registers attachment handlers for the given service and entity
-   * @param {import('@sap/cds').Request} req - The request object
-   * @param {import('express').NextFunction} next - The next middleware function
-   */
-  async updateContentHandler(req, next) {
-    logConfig.debug(`[AWS S3] Uploading file using updateContentHandler for ${req.target.name}`)
-
-    // Check separate object store instances
-    if (separateObjectStore) {
-      const tenantID = cds.context.tenant
-      await this.createClientS3(tenantID)
-    }
-
-    const targetID = req.data.ID || req.params[1]?.ID || req.params[1]
-    if (!targetID) {
-      req.reject(400, "Missing ID in request")
-    }
-
-    if (req?.data?.content) {
-      const response = await SELECT.from(req.target, { ID: targetID }).columns("url")
-      if (response?.url) {
-        const multipartUpload = new Upload({
-          client: this.client,
-          params: {
-            Bucket: this.bucket,
-            Key: response.url,
-            Body: req.data.content,
-          },
-        })
-        await multipartUpload.done()
-
-        const hash = await utils.computeHash(await this.get(req.target, { ID: targetID }))
-        await super.update(req.target, { ID: targetID }, { hash })
-
-        const MalwareScanner = await cds.connect.to('malwareScanner')
-        await MalwareScanner.emit('ScanFile', { target: req.target.name, keys: { ID: targetID } })
-
-        logConfig.debug(`[AWS S3] Uploaded file using updateContentHandler for ${req.target.name}`)
-      }
-    } else if (req?.data?.note) {
-      const key = { ID: targetID }
-      await super.update(req.target, key, { note: req.data.note })
-      logConfig.debug(`[AWS S3] Updated file upload with note for ${req.target.name}`)
-    } else {
-      next()
-    }
-  }
-
   /**
    * Deletes a file from S3 based on the provided key
    * @param {string} Key - The key of the file to delete

lib/azure-blob-storage.js

@@ -34,11 +34,6 @@ module.exports = class AzureAttachmentsService extends require("./object-store")
       const creds = cds.env.requires?.objectStore?.credentials
 
       if (!creds) {
-        if (Object.keys(creds).includes('access_key_id')) {
-          throw new Error('AWS S3 credentials found where Azure Blob Storage credentials expected, please check your service bindings.')
-        } else if (Object.keys(creds).includes('projectId')) {
-          throw new Error('Google Cloud Platform credentials found where Azure Blob Storage credentials expected, please check your service bindings.')
-        }
         throw new Error("SAP Object Store instance is not bound.")
       }
 
@@ -151,13 +146,12 @@ module.exports = class AzureAttachmentsService extends require("./object-store")
   /**
   * @inheritdoc
   */
-  async put(attachments, data, isDraftEnabled, _content, req) {
+  async put(attachments, data) {
     const startTime = Date.now()
 
     logConfig.processStep('Starting file upload to Azure Blob Storage', {
       attachmentEntity: attachments.name,
-      isDraftEnabled,
-      tenant: req?.tenant
+      tenant: cds.context.tenant
     })
 
     try {
@@ -180,26 +174,26 @@ module.exports = class AzureAttachmentsService extends require("./object-store")
           filenames: data.map(d => d.filename)
         })
         return Promise.all(
-          data.map((d) => this.put(attachments, d, isDraftEnabled, _content, req))
+          data.map((d) => this.put(attachments, d))
         )
       }
 
-      const { content = _content, ...metadata } = data
+      let { content: _content, ...metadata } = data
       const blobName = metadata.url
 
       if (!blobName) {
         logConfig.withSuggestion('error',
           'File key/URL is required for Azure Blob Storage upload', null,
           'Ensure attachment data includes a valid URL/key',
-          { metadata: { ...metadata, content: !!content } })
+          { metadata: { ...metadata, content: !!_content } })
         throw new Error('File key is required for upload')
       }
 
-      if (!content) {
+      if (!_content) {
         logConfig.withSuggestion('error',
           'File content is required for Azure Blob Storage upload', null,
           'Ensure attachment data includes file content',
-          { key: blobName, hasContent: !!content })
+          { key: blobName, hasContent: !!_content })
         throw new Error('File content is required for upload')
       }
 
@@ -209,11 +203,31 @@ module.exports = class AzureAttachmentsService extends require("./object-store")
         containerName: this.containerName,
         blobName,
         filename: metadata.filename,
-        contentSize: content.length || content.size || 'unknown'
+        contentSize: _content.length || _content.size || 'unknown'
       })
 
-      const stored = super.put(attachments, metadata, null, isDraftEnabled)
-      await Promise.all([stored, blobClient.uploadData(content)])
+      // Handle different content types for update
+      let contentLength
+      const content = _content
+      if (Buffer.isBuffer(content)) {
+        contentLength = content.length
+      } else if (content && typeof content.length === 'number') {
+        contentLength = content.length
+      } else if (content && typeof content.size === 'number') {
+        contentLength = content.size
+      } else {
+        // Convert to buffer if needed
+        const chunks = []
+        for await (const chunk of content) {
+          chunks.push(chunk)
+        }
+        _content = Buffer.concat(chunks)
+        contentLength = _content.length
+      }
+
+      // The file upload has to be done first, so super.put can compute the hash
+      await blobClient.upload(_content, contentLength)
+      await super.put(attachments, metadata)
 
       const duration = Date.now() - startTime
       logConfig.debug('File upload to Azure Blob Storage completed successfully', {
@@ -317,68 +331,6 @@ module.exports = class AzureAttachmentsService extends require("./object-store")
     }
   }
 
-  /**
-   * Registers attachment handlers for the given service and entity
-   * @param {import('@sap/cds').Request} req - The request object
-   * @param {import('express').NextFunction} next - The next middleware function
-   */
-  async updateContentHandler(req, next) {
-    logConfig.debug(`[Azure] Uploading file using updateContentHandler for ${req.target.name}`)
-    // Check separate object store instances
-    if (separateObjectStore) {
-      const tenantID = cds.context.tenant
-      await this.createAzureClient(tenantID)
-    }
-
-    const targetID = req.data.ID || req.params[1]?.ID || req.params[1]
-    if (!targetID) {
-      req.reject(400, "Missing ID in request")
-    }
-
-    if (req?.data?.content) {
-      const response = await SELECT.from(req.target, { ID: targetID }).columns("url")
-      if (response?.url) {
-        const blobName = response.url
-        const blobClient = this.containerClient.getBlockBlobClient(blobName)
-
-        // Handle different content types for update
-        let contentLength
-        const content = req.data.content
-        if (Buffer.isBuffer(content)) {
-          contentLength = content.length
-        } else if (content && typeof content.length === 'number') {
-          contentLength = content.length
-        } else if (content && typeof content.size === 'number') {
-          contentLength = content.size
-        } else {
-          // Convert to buffer if needed
-          const chunks = []
-          for await (const chunk of content) {
-            chunks.push(chunk)
-          }
-          req.data.content = Buffer.concat(chunks)
-          contentLength = req.data.content.length
-        }
-
-        await blobClient.upload(req.data.content, contentLength)
-
-        const hash = await utils.computeHash(await this.get(req.target, { ID: targetID }))
-        await super.update(req.target, { ID: targetID }, { hash })
-
-        const MalwareScanner = await cds.connect.to('malwareScanner')
-        await MalwareScanner.emit('ScanFile', { target: req.target.name, keys: { ID: targetID } })
-
-        logConfig.debug(`[Azure] Uploaded file using updateContentHandler for ${req.target.name}`)
-      }
-    } else if (req?.data?.note) {
-      const key = { ID: targetID }
-      await super.update(req.target, key, { note: req.data.note })
-      logConfig.debug(`[Azure] Updated file upload with note for ${req.target.name}`)
-    } else {
-      next()
-    }
-  }
-
   /**
    * Deletes a file from Azure Blob Storage
    * @param {string} Key - The key of the file to delete