New action: Raw Request (#23)

Author: olegosh

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0 (August 10, 2021)
+
+* New `Raw Request` Action
+
 ## 2.0.4 (February 12, 2021)
 
 * Update sailor version to 2.6.24

README.md

@@ -20,6 +20,7 @@
    * [Lookup Object (at most 1)](#lookup-object-at-most-1)
    * [Lookup Objects](#lookup-objects)
    * [Query Action](#query-action)
+   * [Raw Request](#raw-request)
    * [Upsert Object](#upsert-object)
 * [Known Limitations](#known-limitations)
 
@@ -291,6 +292,25 @@ Empty object will be returned, if query doesn't find any data.
 #### Expected input metadata
 * **SOQL Query** - Input field where you should type the SOQL query. E.g. `"SELECT ID, Name from Contact where Name like 'John Smi%'"`
 
+### Raw Request
+
+#### Input Metadata
+* HTTP Verb - Allowed values GET, POST, PUT, PATCH, DELETE, HEAD, Required. HTTP verb to use in the request.
+* Path - String, Required. Path to make request to (without `/services/data/v{SALESFORCE_API_VERSION}`, e.g. to list sobjects - type here not `https://{INSTANCE_NAME}.salesforce.com/services/data/v{SALESFORCE_API_VERSION}/sobjects` but just type `sobjects` instead)
+* Request Body - Object, Optional. Body to attach to the HTTP Request
+
+#### Output Metadata
+* Response Object (Object, optional): HTTP response body
+
+#### Resources List
+* More information about available resources you can find [here](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_list.htm)
+
+#### Request Examples
+* Examples of using REST API resources can be found [here](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_user_tasks.htm)
+
+#### Known limitations
+For the methods PUT and HEAD you need to specify the whole path (e.g. `services/OpportunityLineItem/00kR0000001WJJAIA4/OpportunityLineItemSchedules`) which have conflicts with `/services/data/v{SALESFORCE_API_VERSION}/{RESOURCE}` path, so Raw Request does not work for these two methods (PUT and HEAD) just for now.
+
 ### Upsert Object
 Creates or Updates Selected Object.
 Action creates a single object. 

component.json

@@ -1,5 +1,6 @@
 {
   "title": "Salesforce v2",
+  "version": "2.1.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/",
@@ -435,6 +436,19 @@
         "out": {}
       }
     },
+    "rawRequest": {
+      "title": "Raw Request",
+      "main": "./lib/actions/rawRequest.js",
+      "order": 91,
+      "help": {
+        "description": "Make Raw Request",
+        "link": "/components/salesforce/actions#make-raw-request"
+      },
+      "metadata": {
+        "in": "./lib/schemas/rawRequest.in.json",
+        "out": "./lib/schemas/rawRequest.out.json"
+      }
+    },
     "upsert": {
       "title": "Upsert Object",
       "main": "./lib/actions/upsert.js",

lib/actions/rawRequest.js

@@ -0,0 +1,86 @@
+const axios = require('axios');
+const fs = require('fs');
+const { messages } = require('elasticio-node');
+const { Logger } = require('@elastic.io/component-commons-library');
+const common = require('../common.js');
+const { getSecret, refreshToken } = require('../util');
+
+if (fs.existsSync('.env')) {
+  // eslint-disable-next-line global-require
+  require('dotenv').config();
+}
+
+const logger = Logger.getLogger();
+
+const SALESFORCE_VERSION = common.globalConsts.SALESFORCE_API_VERSION;
+const { REFRESH_TOKEN_RETRIES } = common.globalConsts;
+
+async function processAction(msg, cfg) {
+  const { method, path, body } = msg.body;
+  const { secretId } = cfg;
+  let accessToken;
+  let instanceUrl;
+  if (secretId) {
+    logger.debug('Trying to get access token');
+    try {
+      this.logger.debug('Fetching credentials by secretId');
+      const { credentials } = await getSecret(this, secretId);
+      accessToken = credentials.access_token;
+      instanceUrl = credentials.undefined_params.instance_url;
+      logger.debug('Access token has been received');
+    } catch (e) {
+      logger.error('Got error %s while request token', e.name || '');
+    }
+  }
+  let result;
+  let isSuccess = false;
+  let iteration = REFRESH_TOKEN_RETRIES;
+
+  do {
+    iteration -= 1;
+    try {
+      logger.debug('Iteration: %s', REFRESH_TOKEN_RETRIES - iteration);
+      logger.info('Trying to call method %s', method);
+      const basePath = `/services/data/v${SALESFORCE_VERSION}/`;
+      const resourcePath = (path.trim().charAt(0) === '/') ? path.trim().slice(1) : path.trim();
+      const rawRequestPath = `${instanceUrl}${basePath}${resourcePath}`;
+      const lowerCasedMethod = method.toLowerCase();
+      const rawRequestConfig = {
+        method: lowerCasedMethod,
+        url: rawRequestPath,
+        headers: {
+          Authorization: `Bearer ${accessToken && accessToken.replace(/"|'/g, '')}`,
+          'Content-Type': 'application/json',
+        },
+        data: body || '',
+      };
+      logger.info('Raw request started');
+      const rawRequest = await axios(rawRequestConfig);
+      logger.info('Raw request complete');
+      result = messages.newMessageWithBody(rawRequest.data);
+      isSuccess = true;
+      logger.info('Method %s was successfully executed', method);
+      break;
+    } catch (e) {
+      logger.error('Got error %s', e.name || '');
+      if (e.name === 'INVALID_SESSION_ID') {
+        try {
+          logger.debug('Session is expired, trying to refresh token...');
+          accessToken = await refreshToken(this, secretId);
+          this.logger.debug('Token is successfully refreshed');
+        } catch (err) {
+          logger.error('Failed to refresh token');
+        }
+      } else {
+        throw e;
+      }
+    }
+  } while (iteration > 0);
+
+  if (!isSuccess) {
+    throw new Error('Failed to fetch and/or refresh token, retries exceeded');
+  }
+  return result;
+}
+
+module.exports.process = processAction;

lib/schemas/rawRequest.in.json

@@ -0,0 +1,28 @@
+{
+  "type": "object",
+  "properties": {
+    "method": {
+      "type": "string",
+      "required": true,
+      "title": "HTTP Verb",
+      "enum": [
+        "GET",
+        "POST",
+        "PUT",
+        "PATCH",
+        "DELETE",
+        "HEAD"
+      ]
+    },
+    "path": {
+      "type": "string",
+      "required": true,
+      "title": "Path"
+    },
+    "body": {
+      "type": "object",
+      "title": "Body to attach to the HTTP Request",
+      "properties": {}
+    }
+  }
+}

lib/schemas/rawRequest.out.json

@@ -0,0 +1,9 @@
+{
+  "type": "object",
+  "properties": {
+    "response": {
+      "type": "string",
+      "description": "Response object"
+    }
+  }
+}