Upsert Object v2 and Get New and Updated Objects Polling updates (#31)

* New `Upsert Object` action
* Old `Upsert Object` action is deprecated
* `Get New and Updated Objects Polling` trigger updated:
 - Default size of pages to be fetched changed from `1000` to `10000`
 - Restriction `maxFetch should be maximum 10000 objects` is removed

Author: if0s

.env.example

@@ -0,0 +1,14 @@
+# unit tests
+OAUTH_CLIENT_ID=
+OAUTH_CLIENT_SECRET=
+INSTANCE_URL=https://{instanse-name}.salesforce.com
+
+# integration tests (your private data)
+ELASTICIO_API_URI=
+ELASTICIO_WORKSPACE_ID=
+AUTH_SECRET_ID=
+ELASTICIO_API_USERNAME=name.surname@mail.com
+ELASTICIO_API_KEY= get it by pressing "Profile Information" on ui
+Also includes:
+  1: ACCESS_TOKEN - which will be set by run of /spec-integration/getAccessToken.js in before hook for mocha
+  2: unit tests envs

.gitignore

@@ -1,6 +1,7 @@
 # Logs
 logs
 *.log
+.nyc_output
 
 # Runtime data
 pids

CHANGELOG.md

@@ -1,6 +1,14 @@
+## 2.2.0 (August 20, 2021)
+
+* New `Upsert Object` action
+* Old `Upsert Object` action is deprecated
+* `Get New and Updated Objects Polling` trigger updated:
+ - Default size of pages to be fetched changed from `1000` to `10000`
+ - Restriction `maxFetch should be maximum 10000 objects` is removed
+
 ## 2.1.0 (August 10, 2021)
 
-* New `Raw Request` Action
+* New `Raw Request` action
 
 ## 2.0.4 (February 12, 2021)
 

README.md

@@ -317,20 +317,18 @@ Action creates a single object.
 
 #### List of Expected Config fields
 * **Object** - Input field where you should choose the object type, which you want to find. E.g. `Account`
-* **Optional Upsert field** - Input field where you should specify the ExternalID name field. E.g. `ExtId__c`.
-* **Utilize data attachment from previous step (for objects with a binary field)** - a checkbox, if it is checked and an input message contains an attachment and specified object has a binary field (type of base64) then the input data is put into object's binary field. In this case any data specified for the binary field in the data mapper is discarded.
-
-You should specify **external** or **internal Id** for making some updates in salesforce object.
-If you want to create new Object you should always specify **Optional Upsert field** and value of ExternalId in input body structure.
+* **Type Of Search** - Dropdown list with two values: `Unique Fields` and `All Fields`.
+* **Lookup by field** - Dropdown list with all fields on the selected object if the *Type Of Search* is `All Fields`. If the *Type Of Search* is `Unique Fields`, the dropdown lists instead all fields on the selected object where `type` is `id` or `unique` is `true`.
 
 #### Expected input metadata
-Input metadata is fetched dynamically from your Salesforce account. 
+* lookup by - *name of filed selected in 'Lookup by field'*
+* other fields, that used by selected **Object**
 
 #### Expected output metadata
-Output metadata is the same as input metadata, so you may expect all fields that you mapped as input to be returned as output.
-
-#### Limitations
-When **Utilize data attachment from previous step (for objects with a binary field)** is checked and this action is used with Local Agent error would be thrown: 'getaddrinfo ENOTFOUND steward-service.platform.svc.cluster.local steward-service.platform.svc.cluster.local:8200'
+The result of creating or updating an object
+* **id** - Unic identificator from salesforce
+* **success** - Boolean result of creation/update object
+* **errors** - Arrey of errors if they exist
 
 ## Known limitations
 Attachments mechanism does not work with [Local Agent Installation](https://docs.elastic.io/getting-started/local-agent.html)

component.json

@@ -1,6 +1,6 @@
 {
   "title": "Salesforce v2",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "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/",
@@ -74,8 +74,8 @@
           "label": "Size of Polling Page",
           "viewClass": "TextFieldView",
           "required": false,
-          "placeholder": "1000",
-          "note": "Please set the size of pages to be fetched (defaults to 1000). Please enter positive integer only, max 10000 objects"
+          "placeholder": "10000",
+          "note": "Please set the size of pages to be fetched (defaults to 10000). Please enter positive integer only, max 10000 objects"
         },
         "singlePagePerInterval": {
           "label": "Process single page per execution",
@@ -450,12 +450,12 @@
       }
     },
     "upsert": {
+      "deprecated": true,
       "title": "Upsert Object",
       "main": "./lib/actions/upsert.js",
-      "order": 92,
+      "order": 50,
       "help" : {
-        "description": "Create or Update Selected Object",
-        "link": "/components/salesforce/actions#upsert-object-action"
+        "description": "Create or Update Selected Object"
       },
       "dynamicMetadata": true,
       "fields": {
@@ -478,6 +478,47 @@
           "label": "Utilize data attachment from previous step (for objects with a binary field)"
         }
       }
+    },
+    "upsert_v2": {
+      "title": "Upsert Object",
+      "main": "./lib/actions/upsert_v2.js",
+      "order": 90,
+      "help" : {
+        "description": "Create or Update seleced Object",
+        "link": "/components/salesforce/actions#upsert-object-action"
+      },
+      "dynamicMetadata": true,
+      "fields": {
+        "sobject": {
+          "viewClass": "SelectView",
+          "label": "Object",
+          "required": true,
+          "model": "getObjectTypes",
+          "prompt": "Please select a Salesforce Object",
+          "order": 8
+        },
+        "typeOfSearch": {
+          "viewClass": "SelectView",
+          "label": "Type Of Search",
+          "required": true,
+          "require": ["sobject"],
+          "model": {
+            "uniqueFields": "Unique Fields",
+            "allFields": "All Fields"
+          },
+          "prompt": "Please select a type of search",
+          "order": 7
+        },
+        "lookupField": {
+          "viewClass": "SelectView",
+          "label": "Lookup by field",
+          "required": true,
+          "require": ["sobject", "typeOfSearch"],
+          "model": "getLookupFieldsModel",
+          "prompt": "Please select the field which you want to use for lookup",
+          "order": 6
+        }
+      }
     }
   }
 }

lib/actions/deleteObject.js

@@ -62,7 +62,7 @@ module.exports.process = async function process(message, configuration) {
   this.logger.info('Starting Delete Object (at most 1) Action');
   const { lookupField } = configuration;
   const lookupValue = message.body[lookupField];
-  let Id;
+  let objectToDeleteId;
 
   if (!lookupValue) {
     this.logger.debug('No unique criteria provided, run previous functionality');
@@ -71,7 +71,7 @@ module.exports.process = async function process(message, configuration) {
       this.logger.error('Salesforce error. Empty ID');
       return messages.newEmptyMessage();
     }
-    Id = message.body.id;
+    objectToDeleteId = message.body.id;
   } else {
     this.logger.debug(`Preparing to delete a ${configuration.sobject} object...`);
 
@@ -86,7 +86,7 @@ module.exports.process = async function process(message, configuration) {
     const results = await callJSForceMethod.call(this, configuration, 'selectQuery', { condition });
     if (results.length === 1) {
       // eslint-disable-next-line prefer-destructuring
-      Id = results[0].Id;
+      objectToDeleteId = results[0].Id;
     } else {
       if (results.length === 0) {
         this.logger.info('No objects are found');
@@ -101,7 +101,7 @@ module.exports.process = async function process(message, configuration) {
 
   let response;
   try {
-    response = await callJSForceMethod.call(this, configuration, 'sobjectDelete', { id: Id });
+    response = await callJSForceMethod.call(this, configuration, 'sobjectDelete', { id: objectToDeleteId });
   } catch (err) {
     this.logger.error('Salesforce error occurred');
     return messages.newEmptyMessage();

lib/actions/upsert_v2.js

@@ -0,0 +1,117 @@
+/* eslint-disable no-param-reassign, no-unused-vars, class-methods-use-this */
+const { messages } = require('elasticio-node');
+const { Upsert } = require('@elastic.io/oih-standard-library/lib/actions/upsert');
+const { AttachmentProcessor } = require('@elastic.io/component-commons-library');
+const { callJSForceMethod } = require('../helpers/wrapper');
+const { createProperty, getLookupFieldsModelWithTypeOfSearch } = require('../helpers/utils');
+
+module.exports.getObjectTypes = async function getObjectTypes(configuration) {
+  return callJSForceMethod.call(this, configuration, 'getObjectTypes');
+};
+
+module.exports.getLookupFieldsModel = async function getLookupFieldsModel(configuration) {
+  const meta = await callJSForceMethod.call(this, configuration, 'describe');
+  return getLookupFieldsModelWithTypeOfSearch(meta, configuration.typeOfSearch);
+};
+
+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 result = {
+    in: {
+      type: 'object',
+      properties: {},
+    },
+    out: {
+      type: 'object',
+      properties: {
+        id: {
+          type: 'string',
+          required: true,
+          title: 'Unique identifier from CRM',
+        },
+        success: {
+          type: 'boolean',
+          required: true,
+          title: 'Request result',
+        },
+        errors: {
+          type: 'array',
+          required: true,
+          title: 'Founded errors',
+        },
+      },
+    },
+  };
+
+  result.in.properties[configuration.lookupField] = {
+    type: 'string',
+    title: `lookup by - ${configuration.lookupField}`,
+    required: configuration.lookupField !== 'Id',
+  };
+
+  fields.forEach((field) => {
+    result.in.properties[field.name] = createProperty(field);
+    if (field.type === 'base64') result.in.properties[field.name].title += ' - use URL to file';
+  });
+  return result;
+};
+
+class UpsertObject extends Upsert {
+  constructor(context) {
+    super(context);
+    this.logger = context.logger;
+  }
+
+  getCriteria(_msg, _cfg) {
+    return true;
+  }
+
+  async lookupObject(_criteria, _type, cfg, msg) {
+    let existingObj;
+    if (cfg.lookupField === 'Id' && (!msg.body.Id)) {
+      existingObj = undefined;
+    } else {
+      existingObj = await callJSForceMethod.call(this, cfg, 'sobjectLookup', msg);
+      if (existingObj.length > 1) {
+        throw new Error('Found more than 1 Object');
+      } else if (existingObj.length === 0) {
+        existingObj = undefined;
+      }
+    }
+    return existingObj;
+  }
+
+  async getObjectFromMessage(msg, cfg) {
+    const meta = await callJSForceMethod.call(this, cfg, 'describe');
+    await meta.fields.forEach(async (field) => {
+      if (field.type === 'base64') {
+        if (msg.body[field.name]) {
+          const attachmentProcessor = new AttachmentProcessor();
+          const attachment = await attachmentProcessor.getAttachment(msg.body[field.name], 'arraybuffer');
+          msg.body[field.name] = attachment.data.toString('base64');
+        }
+      }
+    });
+    return msg;
+  }
+
+  async updateObject(_criteria, _type, object, cfg, _msg, existingObject) {
+    object.body.Id = existingObject[0].Id;
+    const result = await callJSForceMethod.call(this, cfg, 'sobjectUpdate', object);
+    return result;
+  }
+
+  async createObject(object, cfg, _msg) {
+    const result = callJSForceMethod.call(this, cfg, 'sobjectCreate', object);
+    return result;
+  }
+}
+
+module.exports.process = async function upsertObject(msg, cfg) {
+  const upsert = new UpsertObject(this);
+  return upsert.process(msg, cfg, {});
+};