61 32 dont emit empty results in trig (#62)

Author: if0s

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.6.0 (June 09, 2023)
+Added `Don't emit on empty results` checkbox in `Query` trigger
+
 ## 2.5.1 (January 31, 2023)
 * Fixed [issue](https://github.com/elasticio/salesforce-component-v2/issues/59) with 431 and 414 errors in `Get Updated Objects Polling` trigger: new configuration field `Selected Fields` added
 

README.md

@@ -102,6 +102,7 @@ This trigger allows you to interact with your data using SOQL.
 
 * **SOQL Query** - Input field for your SOQL Query
 * **Output method** - dropdown list with options: `Emit all` - all found records will be emitted in one array `records`, and `Emit individually` - each found object will be emitted individual. Optional field, defaults to: `Emit individually`.
+* **Don't emit on empty results** - checkbox, optional. If selected, component will not produce empty messages when result is empty.
 
 ### Subscribe to platform events (REALTIME FLOWS ONLY)
 This trigger will subscribe for any platform Event using Salesforce streaming API.

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.5.1",
+  "version": "2.6.0",
   "authClientTypes": [
     "oauth2"
   ],
@@ -224,6 +224,14 @@
             "emitIndividually": "Emit individually"
           },
           "prompt": "Please select an output method. Defaults to: Emit individually"
+        },
+        "dontEmitOnEmptyResults": {
+          "viewClass": "CheckBoxView",
+          "label": "Don't emit on empty results",
+          "required": false,
+          "help": {
+            "description": "If selected, component will not produce empty messages when result is empty."
+          }
         }
       }
     },

lib/triggers/query.js

@@ -2,10 +2,11 @@ const { messages } = require('elasticio-node');
 const { callJSForceMethod } = require('../helpers/wrapper');
 
 const validEmitMethods = ['emitAll', 'emitIndividually'];
+const isDebugFlow = process.env.ELASTICIO_FLOW_TYPE === 'debug';
 
 exports.process = async function processTrigger(msg, configuration) {
   this.logger.info('Starting Query trigger');
-  const { query, outputMethod = 'emitIndividually' } = configuration;
+  const { query, outputMethod = 'emitIndividually', dontEmitOnEmptyResults } = configuration;
   if (!validEmitMethods.includes(outputMethod)) throw new Error('Unsupported Output method');
   let records;
   try {
@@ -18,7 +19,16 @@ exports.process = async function processTrigger(msg, configuration) {
     throw new Error(error);
   }
   if (records.length === 0) {
-    await this.emit('data', messages.newEmptyMessage());
+    this.logger.info('No records found for provided Query');
+    if (dontEmitOnEmptyResults) {
+      if (isDebugFlow) {
+        throw new Error(`No object found. Execution stopped.
+      This error is only applicable to the Retrieve Sample.
+      In flow executions there will be no error, just an execution skip.`);
+      }
+    } else {
+      await this.emit('data', messages.newEmptyMessage());
+    }
   } else if (outputMethod === 'emitAll') {
     this.logger.debug('Selected Output method Emit all');
     await this.emit('data', messages.newMessageWithBody({ records }));

package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "audit": "better-npm-audit audit --level high --production",
     "pretest": "eslint lib spec spec-integration verifyCredentials.js --fix",
-    "test": "mocha spec NODE_ENV=test --recursive --timeout 50000",
+    "test": "mocha spec NODE_ENV=test --recursive --timeout 50000 --exit",
     "integration-test": "nyc mocha --require spec-integration/mochaHooks.js spec-integration --recursive --timeout 50000"
   },
   "repository": {