timeOut (#43)

* Added timeout for `Upsert Object` action

Author: if0s

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.2.4 (June 03, 2022)
+* Added timeout for `Upsert Object` action
+
 ## 2.2.3 (April 14, 2022)
 * Bump dependencies
 

README.md

@@ -43,6 +43,7 @@ Name|Mandatory|Description|Values|
 |REFRESH_TOKEN_RETRIES| false | Determines how many retries to refresh token should be done before throwing an error | Default: `10` |
 |HASH_LIMIT_TIME| false | Hash expiration time in ms  | Default: `600000` |
 |HASH_LIMIT_ELEMENTS| false | Hash size number limit  | Default: `10` |
+|UPSERT_TIME_OUT| false | Time out for `Upsert Object` action in ms | Default: `120000` (2min) |
 
 ## Credentials
 Authentication occurs via OAuth 2.0.

component.json

@@ -4,7 +4,7 @@
   "docsUrl": "https://github.com/elasticio/salesforce-component-v2",
   "url": "http://www.salesforce.com/",
   "buildType": "docker",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "authClientTypes": [
     "oauth2"
   ],

lib/actions/upsert_v2.js

@@ -5,6 +5,8 @@ const { AttachmentProcessor } = require('@elastic.io/component-commons-library')
 const { callJSForceMethod } = require('../helpers/wrapper');
 const { createProperty, getLookupFieldsModelWithTypeOfSearch } = require('../helpers/utils');
 
+const timeOut = process.env.UPSERT_TIME_OUT ? Number(process.env.UPSERT_TIME_OUT) : 120000;
+
 module.exports.getObjectTypes = async function getObjectTypes(configuration) {
   return callJSForceMethod.call(this, configuration, 'getObjectTypes');
 };
@@ -75,7 +77,7 @@ class UpsertObject extends Upsert {
     if (cfg.lookupField === 'Id' && (!msg.body.Id)) {
       existingObj = undefined;
     } else {
-      existingObj = await callJSForceMethod.call(this, cfg, 'sobjectLookup', msg);
+      existingObj = await callJSForceMethod.call(this, { ...cfg, timeOut }, 'sobjectLookup', msg);
       if (existingObj.length > 1) {
         throw new Error('Found more than 1 Object');
       } else if (existingObj.length === 0) {
@@ -101,12 +103,12 @@ class UpsertObject extends Upsert {
 
   async updateObject(_criteria, _type, object, cfg, _msg, existingObject) {
     object.body.Id = existingObject[0].Id;
-    const result = await callJSForceMethod.call(this, cfg, 'sobjectUpdate', object);
+    const result = await callJSForceMethod.call(this, { ...cfg, timeOut }, 'sobjectUpdate', object);
     return result;
   }
 
   async createObject(object, cfg, _msg) {
-    const result = callJSForceMethod.call(this, cfg, 'sobjectCreate', object);
+    const result = callJSForceMethod.call(this, { ...cfg, timeOut }, 'sobjectCreate', object);
     return result;
   }
 }

lib/helpers/wrapper.js

@@ -4,6 +4,11 @@ const { getSecret, refreshToken } = require('../util');
 const { REFRESH_TOKEN_RETRIES } = require('../common.js').globalConsts;
 
 let client;
+const timeOut = async (t) => {
+  const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
+  await sleep(t);
+  throw new Error(`UPSERT_TIME_OUT ${t}ms limit reached`);
+};
 
 exports.callJSForceMethod = async function callJSForceMethod(configuration, method, options) {
   this.logger.debug('Preparing SalesForce Client...');
@@ -39,7 +44,7 @@ exports.callJSForceMethod = async function callJSForceMethod(configuration, meth
         this.logger.debug('SalesForce Client is created');
       }
       this.logger.debug('Trying to call method %s', method);
-      result = await client[method](options);
+      result = configuration.timeOut ? await Promise.race([client[method](options), timeOut(configuration.timeOut)]) : await client[method](options);
       isSuccess = true;
       this.logger.debug('Method %s was successfully executed', method);
       break;

spec/actions/upsert_v2.spec.js

@@ -8,7 +8,7 @@ const metaModelDocumentFields = require('../testData/sfDocumentFields.json')
 const sfDocumentMetamodel = require('../testData/sfDocumentMetamodel.json')
 const { globalConsts } = require('../../lib/common.js');
 const {
-  getContext, fetchToken, defaultCfg, testsCommon,
+  getContext, fetchToken, describeDocReq, defaultCfg, testsCommon,
 } = require('../common.js');
 
 describe('Upsert v2 Object test', () => {
@@ -90,49 +90,43 @@ describe('Upsert v2 Object test', () => {
 
   describe('Main process', () => {
     const configuration = {
+      ...defaultCfg,
       secretId: 'secretId',
       sobject: 'Document',
       typeOfSearch: 'allFields',
       updateFields: ['Url', 'Body'],
       lookupField: 'Id'
     }
 
-    it.skip('Object found, going to update', async () => {
+    it('Object found, going to update', async () => {
       const testCfg = {
         ...configuration
       }
       const msg = {
         body: {
           Id: 1,
           Url: '😂',
-          Body: 'http://test.env.mock/somedata.txt'
+          Body: 'YXNkYXNkYXNkcXdlcXdlcXdl'
         }
       }
-
       fetchToken()
-      const describeReq = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document/describe`)
-        .reply(200, metaModelDocumentReply)
+      describeDocReq(globalConsts.SALESFORCE_API_VERSION, metaModelDocumentReply)
+      fetchToken()
+      describeDocReq(globalConsts.SALESFORCE_API_VERSION, metaModelDocumentReply)
       fetchToken()
       const queryReq = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${
-          testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
+        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
         }`)
         .reply(200, { done: true, totalSize: 1, records: [{ Id: 1, Url: '😂' }] })
       fetchToken();
       const patchDocReq = nock(testsCommon.instanceUrl)
         .patch(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document/1`, { Url: '😂', Body: 'YXNkYXNkYXNkcXdlcXdlcXdl' })
         .reply(204)
-      const getTxtReq = nock('http://test.env.mock')
-        .get('/somedata.txt')
-        .replyWithFile(200, `${__dirname}/../testData/somedata.txt`);
 
       const result = await upsert.process.call(getContext(), msg, testCfg)
       expect(result.body.success).to.eql(true);
-      describeReq.done()
       queryReq.done()
       patchDocReq.done()
-      getTxtReq.done()
     })
 
     it('Object not found, going to create', async () => {
@@ -147,13 +141,12 @@ describe('Upsert v2 Object test', () => {
       }
 
       fetchToken()
-      const describeReq = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document/describe`)
-        .reply(200, metaModelDocumentReply)
+      describeDocReq(globalConsts.SALESFORCE_API_VERSION, metaModelDocumentReply)
+      fetchToken()
+      describeDocReq(globalConsts.SALESFORCE_API_VERSION, metaModelDocumentReply)
       fetchToken()
       const queryReq = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${
-          testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
+        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
         }`)
         .reply(200, { done: true, totalSize: 1, records: [] })
       fetchToken()
@@ -163,7 +156,6 @@ describe('Upsert v2 Object test', () => {
 
       const result = await upsert.process.call(getContext(), msg, testCfg)
       expect(result.body.success).to.eql(true);
-      describeReq.done()
       queryReq.done()
       postDocReq.done()
     })
@@ -179,17 +171,14 @@ describe('Upsert v2 Object test', () => {
       }
 
       fetchToken()
-      const describeReq = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document/describe`)
-        .reply(200, metaModelDocumentReply)
+      describeDocReq(globalConsts.SALESFORCE_API_VERSION, metaModelDocumentReply)
       fetchToken()
       const createDocReq = nock(testsCommon.instanceUrl)
         .post(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document`, msg.body)
         .reply(200, { id: 2, success: true, })
 
       const result = await upsert.process.call(getContext(), msg, testCfg)
       expect(result.body.success).to.eql(true);
-      describeReq.done()
       createDocReq.done()
     })
 
@@ -204,10 +193,13 @@ describe('Upsert v2 Object test', () => {
         }
       }
 
+      fetchToken()
+      const describeReq = nock(testsCommon.instanceUrl)
+        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/sobjects/Document/describe`)
+        .reply(200, metaModelDocumentReply)
       fetchToken()
       const scope = nock(testsCommon.instanceUrl)
-        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${
-          testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
+        .get(`/services/data/v${globalConsts.SALESFORCE_API_VERSION}/query?q=${testsCommon.buildSOQL(metaModelDocumentReply, { Id: 1 })
         }`)
         .reply(200, { done: true, totalSize: 1, records: [1, 2] })
 
@@ -217,6 +209,7 @@ describe('Upsert v2 Object test', () => {
         expect(err.message).to.eql('Found more than 1 Object');
       }
       scope.done()
+      describeReq.done()
     })
   })
 })

spec/common.js

@@ -76,7 +76,7 @@ module.exports = {
       if (typeof (where) === 'string') {
         soql += where;
       } else {
-      // eslint-disable-next-line guard-for-in,no-restricted-syntax
+        // eslint-disable-next-line guard-for-in,no-restricted-syntax
         for (const key in where) {
           soql += `${key}%20%3D%20`;
           const field = objectMeta.fields.find((f) => f.name === key);
@@ -106,6 +106,11 @@ module.exports = {
       .get(`/v2/workspaces/${process.env.ELASTICIO_WORKSPACE_ID}/secrets/${secretId}`)
       .reply(200, secret);
   },
+  describeDocReq: (api, meta) => {
+    nock(instanceUrl)
+      .get(`/services/data/v${api}/sobjects/Document/describe`)
+      .reply(200, meta);
+  },
   validateEmitEqualsToData: (emit, data) => {
     expect(emit.callCount).to.be.equal(1);
     expect(emit.getCall(0).args[0]).to.be.equal('data');