Attachment fixes (#63)

Author: if0s

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.7.0 (June 29, 2023)
+Added support for  files attachment by providing a URL in the body for all actions where it is used
+
 ## 2.6.0 (June 09, 2023)
 Added `Don't emit on empty results` checkbox in `Query` trigger
 

README.md

@@ -242,7 +242,7 @@ Action creates a single object.
 * **Include referenced objects** - Multiselect dropdown list with all the related child and parent objects of the selected object type. List entries are given as `Object Name/Reference To (Relationship Name)`. Select one or more related objects, which will be join queried and included in the response from your Salesforce Organization. Please see the **Limitations** section below for use case advisories.
 * **Allow criteria to be omitted** - Checkbox. If checked and nothing is specified in criteria, an empty object will be returned. If not checked and nothing is found, the action will throw an error.
 * **Allow zero results** - Checkbox. If checked and nothing is found in your Salesforce Organization, an empty object will be returned. If not checked and nothing is found, the action will throw an error.
-* **Pass binary data to the next component (if found object has it)** - Checkbox. If it is checked and the found object record has a binary field (primitive type `base64`), then its data will be passed to the next component as a binary attachment.
+* **Pass binary data to the next component (if found object has it)** - Checkbox. If it is checked and the found object record has a binary field (primitive type `base64`), then its data will be passed to the next component as a binary attachment and link to it will be replaced to link on the platform
 * **Enable Cache Usage** - Flag to enable cache usage.
 
 #### Expected input metadata
@@ -321,7 +321,7 @@ Empty object will be returned, if query doesn't find any data.
 
 #### List of Expected Config fields
 * **Optional batch size** - A positive integer specifying batch size. If no batch size is specified then results of the query will be emitted one-by-one, otherwise, query results will be emitted in an array of maximum batch size.
-* **Allow all results to be returned in a set (overwrites 'Optional batch size feature')** - checkbox which allows emitting query results in a single array. `Optional batch size` option is ignored in this case.
+* **Allow all results to be returned in a set** - checkbox which allows emitting query results in a single array. `Optional batch size` and `Max Fetch Count` options are ignored in this case.
 * **Include deleted** - checkbox, if checked - deleted records will be included into the result list.
 * **Max Fetch Count** - limit for a number of messages that can be fetched. 1,000 is the default value when the variable is not set.
 

component.json

@@ -3,7 +3,7 @@
   "description": "Customer relationship management (CRM) software & cloud computing from the leader in CRM solutions for businesses large & small.",
   "docsUrl": "https://github.com/elasticio/salesforce-component-v2",
   "url": "http://www.salesforce.com/",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "authClientTypes": [
     "oauth2"
   ],
@@ -329,7 +329,7 @@
         },
         "utilizeAttachment": {
           "viewClass": "CheckBoxView",
-          "label": "Utilize data attachment from previous step (for objects with a binary field)"
+          "label": "Utilize data attachment from previous step (for objects with a binary field) or by URL inside this field (instead of data)"
         }
       }
     },
@@ -514,8 +514,11 @@
           "placeholder": "0"
         },
         "allowResultAsSet": {
-          "label": "Allow all results to be returned in a set (overwrites 'Optional batch size feature')",
-          "viewClass": "CheckBoxView"
+          "label": "Allow all results to be returned in a set",
+          "viewClass": "CheckBoxView",
+          "help": {
+            "description": "`Optional batch size` and `Max Fetch Count` options are ignored in this case"
+          }
         },
         "includeDeleted": {
           "viewClass": "CheckBoxView",

lib/actions/bulk_q.js

@@ -1,30 +1,23 @@
 const { messages } = require('elasticio-node');
-const client = require('elasticio-rest-node')();
-const request = require('request');
+const { AttachmentProcessor } = require('@elastic.io/component-commons-library');
 const { callJSForceMethod } = require('../helpers/wrapper');
+const { getUserAgent } = require('../util');
 
 exports.process = async function bulkQuery(message, configuration) {
   this.logger.info('Starting Bulk Query action');
-  const signedUrl = await client.resources.storage.createSignedUrl();
-  const out = messages.newEmptyMessage();
+
+  const getSfAttachment = async () => callJSForceMethod.call(this, configuration, 'bulkQuery', message.body.query);
+
+  const attachmentProcessor = new AttachmentProcessor(getUserAgent(), message.id);
+  const createdAttachmentId = await attachmentProcessor.uploadAttachment(getSfAttachment);
+  const attachmentUrl = attachmentProcessor.getMaesterAttachmentUrlById(createdAttachmentId);
+
+  const out = messages.newMessageWithBody({ url: attachmentUrl });
   out.attachments = {
     'bulk_query.csv': {
       'content-type': 'text/csv',
-      url: signedUrl.get_url,
+      url: attachmentUrl,
     },
   };
-  out.body = {};
-  const stream = await callJSForceMethod.call(this, configuration, 'bulkQuery', message.body.query);
-  return new Promise((resolve, reject) => {
-    stream.pipe(request.put(signedUrl.put_url, (err, resp, body) => {
-      if (err) {
-        this.logger.error('Error upload query results');
-        reject(err);
-      } else {
-        this.logger.info('Action successfully processed');
-        out.body = { result: body };
-        resolve(out);
-      }
-    }));
-  });
+  return out;
 };

lib/actions/deleteObject.js

@@ -2,7 +2,12 @@
 
 const { messages } = require('elasticio-node');
 const { callJSForceMethod } = require('../helpers/wrapper');
-const { processMeta, getLookupFieldsModelWithTypeOfSearch, TYPES_MAP } = require('../helpers/utils');
+const {
+  processMeta,
+  getLookupFieldsModelWithTypeOfSearch,
+  formatWhereCondition,
+  logAndThrowError,
+} = require('../helpers/utils');
 
 module.exports.objectTypes = async function objectTypes(configuration) {
   return callJSForceMethod.call(this, configuration, 'getObjectTypes');
@@ -77,11 +82,7 @@ module.exports.process = async function process(message, configuration) {
 
     const meta = await callJSForceMethod.call(this, configuration, 'describe');
     const field = meta.fields.find((fld) => fld.name === lookupField);
-    const condition = (['date', 'datetime'].includes(field.type)
-        || TYPES_MAP[field.type] === 'number'
-        || TYPES_MAP[field.type] === 'boolean')
-      ? `${lookupField} = ${lookupValue}`
-      : `${lookupField} = '${lookupValue}'`;
+    const condition = formatWhereCondition(field.type, lookupField, lookupValue);
 
     const results = await callJSForceMethod.call(this, configuration, 'selectQuery', { condition });
     if (results.length === 1) {
@@ -92,9 +93,7 @@ module.exports.process = async function process(message, configuration) {
         this.logger.info('No objects are found');
         return messages.newEmptyMessage();
       }
-      const err = new Error('More than one object found, can only delete 1');
-      this.logger.error(err);
-      throw err;
+      logAndThrowError('More than one object found, can only delete 1', this.logger);
     }
   }
   this.logger.debug(`Preparing to delete a ${configuration.sobject} object...`);

lib/actions/lookupObject.js

@@ -2,7 +2,11 @@ const { messages } = require('elasticio-node');
 const attachmentTools = require('../helpers/attachment.js');
 const { lookupCache } = require('../helpers/lookupCache.js');
 const {
-  processMeta, getLookupFieldsModelWithTypeOfSearch, getLinkedObjectTypes, TYPES_MAP,
+  processMeta,
+  getLookupFieldsModelWithTypeOfSearch,
+  getLinkedObjectTypes,
+  formatWhereCondition,
+  logAndThrowError,
 } = require('../helpers/utils');
 const { callJSForceMethod } = require('../helpers/wrapper');
 
@@ -77,9 +81,7 @@ module.exports.process = async function processAction(message, configuration) {
 
   const meta = await callJSForceMethod.call(this, configuration, 'describe');
   const field = meta.fields.find((fld) => fld.name === lookupField);
-  const whereCondition = (['date', 'datetime'].includes(field.type) || TYPES_MAP[field.type] === 'number')
-    ? `${lookupField} = ${lookupValue}`
-    : `${lookupField} = '${lookupValue}'`;
+  const whereCondition = formatWhereCondition(field.type, lookupField, lookupValue);
 
   lookupCache.useCache(configuration.enableCacheUsage);
   const queryKey = lookupCache.generateKeyFromDataArray(configuration.sobject, whereCondition);
@@ -103,35 +105,29 @@ module.exports.process = async function processAction(message, configuration) {
   const records = await callJSForceMethod.call(this, configuration, 'pollingSelectQuery', queryOptions);
 
   if (records.length === 0) {
-    if (allowZeroResults) {
-      lookupCache.addRequestResponsePair(queryKey, {});
-      await this.emit('data', messages.newMessageWithBody({}));
-    } else {
-      const err = new Error('No objects found');
-      this.logger.error(err);
-      throw (err);
-    }
-  } else if (records.length === 1) {
-    try {
-      const outputMessage = messages.newMessageWithBody(records[0]);
+    if (!allowZeroResults) logAndThrowError('No objects found', this.logger);
+    lookupCache.addRequestResponsePair(queryKey, {});
+    await this.emit('data', messages.newMessageWithBody({}));
+    return;
+  }
 
-      if (configuration.passBinaryData) {
-        const attachment = await attachmentTools.getAttachment(configuration, records[0], this);
-        if (attachment) {
-          outputMessage.attachments = attachment;
-        }
-      }
+  if (records.length > 1) logAndThrowError('More than one object found', this.logger);
 
-      lookupCache.addRequestResponsePair(queryKey, records[0]);
-      this.logger.debug('Emitting record');
-      await this.emit('data', outputMessage);
-    } catch (err) {
-      this.logger.error('Lookup Object error occurred');
-      throw (err);
+  try {
+    const outputMessage = messages.newMessageWithBody(records[0]);
+
+    if (configuration.passBinaryData) {
+      const attachment = await attachmentTools.getAttachment(configuration, records[0], this, message.id);
+      if (attachment) {
+        outputMessage.attachments = attachment;
+      }
     }
-  } else {
-    const err = new Error('More than one object found');
-    this.logger.error(err);
+
+    lookupCache.addRequestResponsePair(queryKey, records[0]);
+    this.logger.debug('Emitting record');
+    await this.emit('data', outputMessage);
+  } catch (err) {
+    this.logger.error('Lookup Object error occurred');
     throw (err);
   }
 };

lib/actions/query.js

@@ -26,7 +26,6 @@ exports.process = async function processAction(message, configuration) {
     if (results.length === 0) {
       await this.emit('data', messages.newEmptyMessage());
     } else {
-      // eslint-disable-next-line no-restricted-syntax
       for (const result of results) {
         await this.emit('data', messages.newMessageWithBody({ result }));
       }
@@ -37,7 +36,6 @@ exports.process = async function processAction(message, configuration) {
     if (results.length === 0) {
       await this.emit('data', messages.newEmptyMessage());
     } else {
-      // eslint-disable-next-line no-restricted-syntax
       for (const result of results) {
         await this.emit('data', messages.newMessageWithBody(result));
       }

lib/actions/upsert_v2.js

@@ -18,9 +18,7 @@ module.exports.getLookupFieldsModel = async function getLookupFieldsModel(config
 
 module.exports.getMetaModel = async function getMetaModel(configuration) {
   const meta = await callJSForceMethod.call(this, configuration, 'describe');
-  const fields = meta.fields.filter((field) => !field.deprecatedAndHidden
-    && field.updateable
-    && field.createable);
+  const fields = meta.fields.filter((field) => !field.deprecatedAndHidden && (field.updateable || field.createable));
 
   const result = {
     in: {
@@ -58,6 +56,7 @@ module.exports.getMetaModel = async function getMetaModel(configuration) {
   fields.forEach((field) => {
     result.in.properties[field.name] = createProperty(field);
     if (field.type === 'base64') result.in.properties[field.name].title += ' - use URL to file';
+    if (!field.updateable || !field.createable) result.in.properties[field.name].required = false;
   });
 
   result.in.properties[configuration.lookupField].title = `lookup by - ${result.in.properties[configuration.lookupField].title}`;